feat!: v4 — native renderer by default, typed invalidation maps, Bun 1.4.4

.github/workflows/check.yml

@@ -20,7 +20,7 @@ jobs:
 
       - uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2
         with:
-          bun-version: 1.4.1
+          bun-version: 1.4.4
 
       - uses: dtolnay/rust-toolchain@stable
 

.github/workflows/publish.yml

@@ -6,6 +6,7 @@ on:
       - v1.*
       - v2.*
       - v3.*
+      - v4.*
 
 permissions:
   id-token: write
@@ -21,7 +22,7 @@ jobs:
       - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
       - uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2
         with:
-          bun-version: 1.4.1
+          bun-version: 1.4.4
       - uses: dtolnay/rust-toolchain@stable
       - run: bun install --frozen-lockfile
       - run: bun run build:native
@@ -42,7 +43,7 @@ jobs:
 
       - uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2
         with:
-          bun-version: 1.4.1
+          bun-version: 1.4.4
 
       - run: bun install --frozen-lockfile
       - name: Set package version from tag

.github/workflows/renderer-parity.yml

@@ -23,7 +23,7 @@ jobs:
 
       - uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2
         with:
-          bun-version: "1.4.1"
+          bun-version: 1.4.4
 
       - uses: dtolnay/rust-toolchain@stable
         if: matrix.renderer == 'native'
@@ -63,7 +63,7 @@ jobs:
 
       - uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2
         with:
-          bun-version: "1.4.1"
+          bun-version: 1.4.4
 
       - run: bun install --frozen-lockfile
 

.tool-versions

@@ -1 +1 @@
-bun 1.4.1
+bun 1.4.4

README.md

@@ -119,6 +119,7 @@ bunx openapi-codegen generate --config my-config.ts
   --excludeTags                       Comma-separated list of tags to exclude from generation
   --excludePathRegex                  Exclude operations whose paths match the given regular expression
   --excludeRedundantZodSchemas        Exclude any redundant Zod schemas (default: true)
+  --includeSchemas                    Comma-separated component schemas to generate even when no operation uses them
 
   --tsNamespaces                      Wrap generated files in TypeScript namespaces (default: true)
   --importPath                        Module import style for generated files (default: 'ts'; options: 'ts' | 'relative' | 'absolute')
@@ -148,7 +149,6 @@ bunx openapi-codegen generate --config my-config.ts
   --acl                               Generate ACL related files (default: true)
   --checkAcl                          Add ACL check to queries (default: true)
 
-  --builderConfigs                    Generate configs for builders (default: false)
 
   --baseUrl                           (Requires `--restClientImportPath` to NOT be set) Base URL for the generated REST client; falls back to the OpenAPI spec if not provided
 ```
@@ -167,6 +167,7 @@ bunx openapi-codegen generate --config my-config.ts
   --excludeTags                       Comma-separated list of tags to exclude from generation
   --excludePathRegex                  Exclude operations whose paths match the given regular expression
   --excludeRedundantZodSchemas        Exclude any redundant Zod schemas (default: true)
+  --includeSchemas                    Comma-separated component schemas to generate even when no operation uses them
 ```
 
 ## Development
@@ -309,6 +310,24 @@ import { OpenApiQueryConfig } from "@povio/openapi-codegen-cli/query";
 </OpenApiQueryConfig.Provider>;
 ```
 
+### Typed invalidation maps
+
+With `mutationEffects` (the default), `queryModules.ts` exports `QueryModuleMutations` (for each module, the `data` and `variables` of its mutation hooks) and registers it globally, so `InvalidationMap<QueryModule>` types each module's callback from the spec:
+
+```ts
+import type { InvalidationMap } from "@povio/openapi-codegen-cli/query";
+import { QueryModule } from "@/data/queryModules";
+
+export const invalidationMap: InvalidationMap<QueryModule> = {
+  // `data` is any of the module's mutation responses; variables that only some
+  // of its mutations take (here `id`) are optional.
+  [QueryModule.Items]: (data, { officeId, id }) => [["items", officeId, id]],
+};
+```
+
+The registration is global, so a program with several generated clients should pass the mutations explicitly
+instead: `InvalidationMap<QueryModule, QueryModuleMutations>`.
+
 ### Runtime response validation
 
 Use `OpenApiQueryConfig.Provider` to allow generated GET query hooks to return invalid response data while still logging the response Zod error to the console. Non-GET requests still throw on invalid response data.

native/Cargo.toml

@@ -12,7 +12,8 @@ codegen-units = 1
 lto = "fat"
 opt-level = 3
 panic = "abort"
-strip = "symbols"
+# Stripped dylibs fail to load on recent macOS ("mis-aligned LINKEDIT string pool").
+strip = false
 
 [profile.dev]
 opt-level = 2

native/src/config.rs

@@ -74,6 +74,8 @@ pub struct GenerateOptions {
     pub replace_optional_with_nullish: bool,
     #[serde(default = "default_true")]
     pub exclude_redundant_zod_schemas: bool,
+    #[serde(default)]
+    pub include_schemas: Vec<String>,
     #[serde(default = "default_enum_suffix")]
     pub enum_suffix: String,
     #[serde(default)]
@@ -98,8 +100,6 @@ pub struct GenerateOptions {
     pub parse_request_params: bool,
     #[serde(default)]
     pub inline_endpoints: bool,
-    #[serde(default)]
-    pub builder_configs: bool,
     #[serde(default = "default_true")]
     pub acl: bool,
     #[serde(default)]
@@ -175,6 +175,9 @@ mod runtime_import_tests {
     #[test]
     fn mutation_effects_default_uses_query_subpath() {
         let options: super::GenerateOptions = serde_json::from_str("{}").unwrap();
-        assert_eq!(options.mutation_effects_import_path, "@povio/openapi-codegen-cli/query");
+        assert_eq!(
+            options.mutation_effects_import_path,
+            "@povio/openapi-codegen-cli/query"
+        );
     }
 }