@blimu/codegen 0.4.1 → 0.5.0

package/README.md

@@ -55,19 +55,19 @@ Create `chunkflow-codegen.config.mjs` in your project root:
 
 ```javascript
 // @ts-check
-import { defineConfig } from "@blimu/codegen";
+import { defineConfig } from '@blimu/codegen';
 
 export default defineConfig({
-  spec: "http://localhost:3020/docs/backend-api/json",
+  spec: 'http://localhost:3020/docs/backend-api/json',
   clients: [
     {
-      type: "typescript",
-      outDir: "./my-sdk",
-      packageName: "my-sdk",
-      name: "MyClient",
+      type: 'typescript',
+      outDir: './my-sdk',
+      packageName: 'my-sdk',
+      name: 'MyClient',
       operationIdParser: (operationId, method, path) => {
         // Custom transform logic
-        return operationId.replace(/Controller/g, "");
+        return operationId.replace(/Controller/g, '');
       },
     },
   ],
@@ -83,32 +83,32 @@ See `examples/chunkflow-codegen.config.mjs.example` for a complete example with
 Use the codegen library programmatically in your TypeScript code:
 
 ```typescript
-import { generate, loadConfig, defineConfig } from "@blimu/codegen";
+import { generate, loadConfig, defineConfig } from '@blimu/codegen';
 
 // Generate from config object
 await generate({
-  spec: "http://localhost:3020/docs/backend-api/json",
+  spec: 'http://localhost:3020/docs/backend-api/json',
   clients: [
     {
-      type: "typescript",
-      outDir: "./my-sdk",
-      packageName: "my-sdk",
-      name: "MyClient",
+      type: 'typescript',
+      outDir: './my-sdk',
+      packageName: 'my-sdk',
+      name: 'MyClient',
       operationIdParser: (operationId, method, path) => {
-        return operationId.replace(/Controller/g, "");
+        return operationId.replace(/Controller/g, '');
       },
     },
   ],
 });
 
 // Generate from config file path
-await generate("./chunkflow-codegen.config.mjs");
+await generate('./chunkflow-codegen.config.mjs');
 
 // Generate only a specific client
-await generate("./chunkflow-codegen.config.mjs", { client: "MyClient" });
+await generate('./chunkflow-codegen.config.mjs', { client: 'MyClient' });
 
 // Load config programmatically
-const config = await loadConfig("./chunkflow-codegen.config.mjs");
+const config = await loadConfig('./chunkflow-codegen.config.mjs');
 ```
 
 ## Configuration Options

package/dist/generator/typescript/templates/auth-strategies.ts.hbs

@@ -2,7 +2,7 @@ import type { AuthStrategy } from '@blimu/fetch';
 import type { ClientOption } from './client';
 
 export function buildAuthStrategies(cfg: ClientOption): AuthStrategy[] {
-  const authStrategies: AuthStrategy[] = [...(cfg?.authStrategies || [])];
+  const authStrategies: AuthStrategy[] = [...(cfg?.authStrategies ?? [])];
 
   {{#each IR.securitySchemes~}}
   {{~#if (eq this.type "http")~}}

package/dist/generator/typescript/templates/client.ts.hbs

@@ -52,12 +52,12 @@ export class {{Client.name}} {
   {{/each}}
 
   constructor(options?: ClientOption) {
-    const restCfg = { ...(options || {}) };
+    const restCfg = { ...(options ?? {}) };
     {{#each IR.securitySchemes}}
     delete restCfg.{{camel this.key}};
     {{/each}}
 
-    const authStrategies = buildAuthStrategies(options || {});
+    const authStrategies = buildAuthStrategies(options ?? {});
     
     const core = new FetchClient({
       ...restCfg,

package/dist/generator/typescript/templates/package.json.hbs

@@ -2,7 +2,8 @@
   "name": "{{Client.packageName}}",
   "version": "0.1.0",
   "description": "TypeScript SDK for {{Client.name}} API (auto-generated)",
-  "main": "dist/index.js",
+  "main": "dist/index.cjs",
+  "type": "module",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "files": ["dist/**"],
@@ -10,32 +11,32 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "default": "./dist/index.js"
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.cjs"
     },
     "./services/*": {
       "types": "./dist/services/*.d.ts",
       "import": "./dist/services/*.mjs",
-      "require": "./dist/services/*.js",
-      "default": "./dist/services/*.js"
+      "require": "./dist/services/*.cjs",
+      "default": "./dist/services/*.cjs"
     },
     "./schema": {
       "types": "./dist/schema.d.ts",
       "import": "./dist/schema.mjs",
-      "require": "./dist/schema.js",
-      "default": "./dist/schema.js"
+      "require": "./dist/schema.cjs",
+      "default": "./dist/schema.cjs"
     },
     "./client": {
       "types": "./dist/client.d.ts",
       "import": "./dist/client.mjs",
-      "require": "./dist/client.js",
-      "default": "./dist/client.js"
+      "require": "./dist/client.cjs",
+      "default": "./dist/client.cjs"
     },
     "./utils": {
       "types": "./dist/utils.d.ts",
       "import": "./dist/utils.mjs",
-      "require": "./dist/utils.js",
-      "default": "./dist/utils.js"
+      "require": "./dist/utils.cjs",
+      "default": "./dist/utils.cjs"
     }
   },
   "scripts": {
@@ -43,7 +44,7 @@
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "lint": "eslint .",
     "format": "eslint --fix . && prettier --write .",
-    "prepublishOnly": "npm run build && npm run typecheck || true"
+    "prepublishOnly": "npm run build && npm run typecheck"
   },
   "dependencies": {
 {{#each (getAllDependencies Client)}}

package/dist/generator/typescript/templates/service.ts.hbs

@@ -3,8 +3,10 @@ import { FetchClient } from '@blimu/fetch';
 import * as Schema from "../schema";
 {{/if}}
 {{#if Client.includeQueryKeys}}
+{{#if (hasAnyOptionalQueryKeyParams Service)}}
 import { isNotUndefined } from "../utils";
 {{/if}}
+{{/if}}
 {{! Generate import statements for predefined types used in this specific service }}
 {{#if (getServicePredefinedTypes Service)}}
 {{#each (groupByPackage (getServicePredefinedTypes Service))}}
@@ -47,7 +49,7 @@ export class {{serviceName Service.tag}} {
       {{/if}}
       contentType: "{{response.contentType}}",
       streamingFormat: "{{response.streamingFormat}}",
-      ...(init || {}),
+      ...(init ?? {}),
     });
   }
   {{else}}
@@ -65,7 +67,7 @@ export class {{serviceName Service.tag}} {
       {{#if requestBody}}
       body,
       {{/if}}
-      ...(init || {}),
+      ...(init ?? {}),
     });
   }
   {{/if}}
@@ -78,9 +80,13 @@ export class {{serviceName Service.tag}} {
     {{~#each (methodSignatureNoInit this) as |param|~}}
     {{param}}{{#unless @last}},{{/unless}}
     {{~/each~}}
-  ) {
+  ): {{#if (hasOptionalQueryKeyParams this)}}readonly string[]{{else}}{{queryKeyReturnType this}}{{/if}} {
+    {{#if (hasOptionalQueryKeyParams this)}}
     const keys = [{{queryKeyBase this}}{{#each (queryKeyArgs this)}}, {{this}}{{/each}}] as const;
-    return isNotUndefined(keys);
+    return isNotUndefined(keys) as readonly string[];
+    {{else}}
+    return [{{queryKeyBase this}}{{#each (queryKeyArgs this)}}, {{this}}{{/each}}] as const;
+    {{/if}}
   }
   {{/if}}
   {{/each}}

package/dist/generator/typescript/templates/tsconfig.json.hbs

@@ -21,7 +21,8 @@
     "noFallthroughCasesInSwitch": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
-    "useDefineForClassFields": true
+    "useDefineForClassFields": true,
+    "verbatimModuleSyntax": true
   },
   "include": ["{{Client.srcDir}}/**/*"],
   "exclude": ["node_modules", "dist"]

package/dist/generator/typescript/templates/tsup.config.ts.hbs

@@ -9,6 +9,9 @@ export default defineConfig({
   clean: true,
   outDir: "dist",
   tsconfig: "./tsconfig.json",
+  outExtension({ format }) {
+    return format === 'esm' ? { js: '.mjs' } : { js: '.cjs' };
+  },
   // External dependencies should not be bundled
   // This ensures proper type resolution and smaller bundle sizes
   external: [],

package/dist/generator/typescript/templates/utils.ts.hbs

@@ -3,19 +3,19 @@ import { parseSSEStream, parseNDJSONStream } from "@blimu/fetch";
 export type PaginableQuery = { limit?: number; offset?: number } & Record<string, unknown>;
 
 export async function* paginate<T>(
-  fetchPage: (query?: any, init?: Omit<RequestInit, 'method' | 'body'>) => Promise<{ data?: T[]; hasMore?: boolean; limit?: number; offset?: number }>,
+  fetchPage: (query?: PaginableQuery, init?: Omit<RequestInit, 'method' | 'body'>) => Promise<{ data?: T[]; hasMore?: boolean; limit?: number; offset?: number }>,
   initialQuery: PaginableQuery = {},
   pageSize = 100,
 ): AsyncGenerator<T, void, unknown> {
   let offset = Number(initialQuery.offset ?? 0);
   const limit = Number(initialQuery.limit ?? pageSize);
   // shallow copy to avoid mutating caller
-  const baseQuery: any = { ...initialQuery };
+  const baseQuery: PaginableQuery = { ...initialQuery };
   while (true) {
     const page = await fetchPage({ ...baseQuery, limit, offset });
     const items = page.data ?? [];
     for (const item of items) {
-      yield item as T;
+      yield item;
     }
     if (!page.hasMore || items.length < limit) break;
     offset += limit;
@@ -23,7 +23,7 @@ export async function* paginate<T>(
 }
 
 export async function listAll<T>(
-  fetchPage: (query?: any, init?: Omit<RequestInit, 'method' | 'body'>) => Promise<{ data?: T[]; hasMore?: boolean; limit?: number; offset?: number }>,
+  fetchPage: (query?: PaginableQuery, init?: Omit<RequestInit, 'method' | 'body'>) => Promise<{ data?: T[]; hasMore?: boolean; limit?: number; offset?: number }>,
   query: PaginableQuery = {},
   pageSize = 100,
 ): Promise<T[]> {
@@ -35,9 +35,14 @@ export async function listAll<T>(
 /**
  * Filters out undefined values from an array while preserving type safety
  * Useful for query keys where optional parameters might be undefined
+ * Preserves tuple types when no undefined values are present
  */
-export function isNotUndefined<T>(arr: readonly (T | undefined)[]): T[] {
-  return arr.filter((item): item is T => item !== undefined);
+export function isNotUndefined<T extends readonly unknown[]>(arr: T): T {
+  // Type assertion: when no undefined values exist, tuple is preserved
+  // When undefined values exist, they are filtered but type system can't infer exact tuple shape
+  return arr.filter(
+    (item): item is Exclude<T[number], undefined> => item !== undefined
+  ) as unknown as T;
 }
 
 // Re-export streaming parsers from @blimu/fetch

package/dist/index.d.mts

@@ -151,7 +151,7 @@ interface IR {
     models: IRModel[];
     securitySchemes: IRSecurityScheme[];
     modelDefs: IRModelDef[];
-    openApiDocument?: any;
+    openApiDocument?: unknown;
 }
 interface IRParam {
     name: string;
@@ -171,7 +171,7 @@ interface IRResponse {
     description: string;
     isStreaming: boolean;
     contentType: string;
-    streamingFormat?: "sse" | "ndjson" | "chunked";
+    streamingFormat?: 'sse' | 'ndjson' | 'chunked' | undefined;
 }
 interface IRModel {
     name: string;
@@ -183,30 +183,30 @@ interface IRModelDef {
     annotations: IRAnnotations;
 }
 interface IRAnnotations {
-    title?: string;
-    description?: string;
-    deprecated?: boolean;
-    readOnly?: boolean;
-    writeOnly?: boolean;
-    default?: any;
-    examples?: any[];
+    title?: string | undefined;
+    description?: string | undefined;
+    deprecated?: boolean | undefined;
+    readOnly?: boolean | undefined;
+    writeOnly?: boolean | undefined;
+    default?: unknown | undefined;
+    examples?: unknown[] | undefined;
 }
 interface IRSchema {
     kind: IRSchemaKind;
     nullable: boolean;
-    format?: string;
-    properties?: IRField[];
-    additionalProperties?: IRSchema;
-    items?: IRSchema;
-    enumValues?: string[];
-    enumRaw?: any[];
-    enumBase?: IRSchemaKind;
+    format?: string | undefined;
+    properties?: IRField[] | undefined;
+    additionalProperties?: IRSchema | undefined;
+    items?: IRSchema | undefined;
+    enumValues?: string[] | undefined;
+    enumRaw?: unknown[] | undefined;
+    enumBase?: IRSchemaKind | undefined;
     ref?: string;
-    oneOf?: IRSchema[];
-    anyOf?: IRSchema[];
-    allOf?: IRSchema[];
-    not?: IRSchema;
-    discriminator?: IRDiscriminator;
+    oneOf?: IRSchema[] | undefined;
+    anyOf?: IRSchema[] | undefined;
+    allOf?: IRSchema[] | undefined;
+    not?: IRSchema | undefined;
+    discriminator?: IRDiscriminator | undefined;
 }
 interface IRField {
     name: string;
@@ -216,15 +216,15 @@ interface IRField {
 }
 interface IRDiscriminator {
     propertyName: string;
-    mapping?: Record<string, string>;
+    mapping?: Record<string, string> | undefined;
 }
 interface IRSecurityScheme {
     key: string;
     type: string;
     scheme?: string;
-    in?: string;
-    name?: string;
-    bearerFormat?: string;
+    in?: string | undefined;
+    name?: string | undefined;
+    bearerFormat?: string | undefined;
 }
 
 interface Generator<TClient extends Client = Client> {

package/dist/index.d.ts

@@ -151,7 +151,7 @@ interface IR {
     models: IRModel[];
     securitySchemes: IRSecurityScheme[];
     modelDefs: IRModelDef[];
-    openApiDocument?: any;
+    openApiDocument?: unknown;
 }
 interface IRParam {
     name: string;
@@ -171,7 +171,7 @@ interface IRResponse {
     description: string;
     isStreaming: boolean;
     contentType: string;
-    streamingFormat?: "sse" | "ndjson" | "chunked";
+    streamingFormat?: 'sse' | 'ndjson' | 'chunked' | undefined;
 }
 interface IRModel {
     name: string;
@@ -183,30 +183,30 @@ interface IRModelDef {
     annotations: IRAnnotations;
 }
 interface IRAnnotations {
-    title?: string;
-    description?: string;
-    deprecated?: boolean;
-    readOnly?: boolean;
-    writeOnly?: boolean;
-    default?: any;
-    examples?: any[];
+    title?: string | undefined;
+    description?: string | undefined;
+    deprecated?: boolean | undefined;
+    readOnly?: boolean | undefined;
+    writeOnly?: boolean | undefined;
+    default?: unknown | undefined;
+    examples?: unknown[] | undefined;
 }
 interface IRSchema {
     kind: IRSchemaKind;
     nullable: boolean;
-    format?: string;
-    properties?: IRField[];
-    additionalProperties?: IRSchema;
-    items?: IRSchema;
-    enumValues?: string[];
-    enumRaw?: any[];
-    enumBase?: IRSchemaKind;
+    format?: string | undefined;
+    properties?: IRField[] | undefined;
+    additionalProperties?: IRSchema | undefined;
+    items?: IRSchema | undefined;
+    enumValues?: string[] | undefined;
+    enumRaw?: unknown[] | undefined;
+    enumBase?: IRSchemaKind | undefined;
     ref?: string;
-    oneOf?: IRSchema[];
-    anyOf?: IRSchema[];
-    allOf?: IRSchema[];
-    not?: IRSchema;
-    discriminator?: IRDiscriminator;
+    oneOf?: IRSchema[] | undefined;
+    anyOf?: IRSchema[] | undefined;
+    allOf?: IRSchema[] | undefined;
+    not?: IRSchema | undefined;
+    discriminator?: IRDiscriminator | undefined;
 }
 interface IRField {
     name: string;
@@ -216,15 +216,15 @@ interface IRField {
 }
 interface IRDiscriminator {
     propertyName: string;
-    mapping?: Record<string, string>;
+    mapping?: Record<string, string> | undefined;
 }
 interface IRSecurityScheme {
     key: string;
     type: string;
     scheme?: string;
-    in?: string;
-    name?: string;
-    bearerFormat?: string;
+    in?: string | undefined;
+    name?: string | undefined;
+    bearerFormat?: string | undefined;
 }
 
 interface Generator<TClient extends Client = Client> {