typed-openapi 1.3.0 → 1.3.2

package/dist/{chunk-EYTM4P4S.js → chunk-YLPQQ24J.js}

@@ -952,20 +952,28 @@ var generateTanstackQueryFile = async (ctx) => {
          * Generic mutation method with full type-safety for any endpoint that doesnt require parameters to be passed initially
          */
         mutation<
-        TMethod extends keyof EndpointByMethod,
-        TPath extends keyof EndpointByMethod[TMethod],
-        TEndpoint extends EndpointByMethod[TMethod][TPath]
-        >(
-          method: TMethod,
-          path: TPath) {
+            TMethod extends keyof EndpointByMethod,
+            TPath extends keyof EndpointByMethod[TMethod],
+            TEndpoint extends EndpointByMethod[TMethod][TPath],
+            TSelection,
+        >(method: TMethod, path: TPath, selectFn?: (res: Omit<Response, "json"> & {
+            /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/json) */
+            json: () => Promise<TEndpoint extends { response: infer Res } ? Res : never>;
+        }) => TSelection) {
             const mutationKey = [{ method, path }] as const;
             return {
+            /** type-only property if you need easy access to the endpoint params */
+            "~endpoint": {} as TEndpoint,
+            mutationKey: mutationKey,
+            mutationOptions: {
                 mutationKey: mutationKey,
-                mutationOptions: {
-                    mutationKey: mutationKey,
-                    mutationFn: async (params: TEndpoint extends { parameters: infer Parameters} ? Parameters: never) => this.client.request(method, path, params)
-                }
-            }
+                mutationFn: async (params: TEndpoint extends { parameters: infer Parameters } ? Parameters : never) => {
+                const response = await this.client.request(method, path, params);
+                const res = selectFn ? selectFn(response) : response
+                return res as unknown extends TSelection ? typeof response : Awaited<TSelection>
+                },
+            },
+            };
         }
         // </ApiClient.request>
   }

package/dist/chunk-YRJ7W5RY.js

@@ -0,0 +1,46 @@
+import {
+  allowedRuntimes,
+  generateFile,
+  generateTanstackQueryFile,
+  mapOpenApiEndpoints,
+  prettify
+} from "./chunk-YLPQQ24J.js";
+
+// src/generate-client-files.ts
+import SwaggerParser from "@apidevtools/swagger-parser";
+import { basename, join, dirname } from "pathe";
+import { type } from "arktype";
+import { writeFile } from "fs/promises";
+var cwd = process.cwd();
+var now = /* @__PURE__ */ new Date();
+var optionsSchema = type({
+  "output?": "string",
+  runtime: allowedRuntimes,
+  tanstack: "boolean | string"
+});
+async function generateClientFiles(input, options) {
+  const openApiDoc = await SwaggerParser.bundle(input);
+  const ctx = mapOpenApiEndpoints(openApiDoc);
+  console.log(`Found ${ctx.endpointList.length} endpoints`);
+  const content = await prettify(generateFile({ ...ctx, runtime: options.runtime }));
+  const outputPath = join(
+    cwd,
+    options.output ?? input + `.${options.runtime === "none" ? "client" : options.runtime}.ts`
+  );
+  console.log("Generating client...", outputPath);
+  await writeFile(outputPath, content);
+  if (options.tanstack) {
+    const tanstackContent = await generateTanstackQueryFile({
+      ...ctx,
+      relativeApiClientPath: "./" + basename(outputPath)
+    });
+    const tanstackOutputPath = join(dirname(outputPath), typeof options.tanstack === "string" ? options.tanstack : `tanstack.client.ts`);
+    console.log("Generating tanstack client...", tanstackOutputPath);
+    await writeFile(tanstackOutputPath, tanstackContent);
+  }
+  console.log(`Done in ${(/* @__PURE__ */ new Date()).getTime() - now.getTime()}ms !`);
+}
+
+export {
+  generateClientFiles
+};

package/dist/cli.js

@@ -1,50 +1,21 @@
 import {
-  allowedRuntimes,
-  generateFile,
-  generateTanstackQueryFile,
-  mapOpenApiEndpoints,
-  prettify
-} from "./chunk-EYTM4P4S.js";
+  generateClientFiles
+} from "./chunk-YRJ7W5RY.js";
+import {
+  allowedRuntimes
+} from "./chunk-YLPQQ24J.js";
 
 // src/cli.ts
-import SwaggerParser from "@apidevtools/swagger-parser";
 import { cac } from "cac";
-import { basename, join } from "pathe";
-import { type } from "arktype";
-import { writeFile } from "fs/promises";
 import { readFileSync } from "fs";
-import { dirname } from "path";
 var { name, version } = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
-var cwd = process.cwd();
 var cli = cac(name);
-var now = /* @__PURE__ */ new Date();
-var optionsSchema = type({ "output?": "string", runtime: allowedRuntimes, tanstack: "boolean | string" });
 cli.command("<input>", "Generate").option("-o, --output <path>", "Output path for the api client ts file (defaults to `<input>.<runtime>.ts`)").option(
   "-r, --runtime <name>",
   `Runtime to use for validation; defaults to \`none\`; available: ${allowedRuntimes.toString()}`,
   { default: "none" }
 ).option("--tanstack [name]", "Generate tanstack client, defaults to false, can optionally specify a name for the generated file").action(async (input, _options) => {
-  const options = optionsSchema.assert(_options);
-  const openApiDoc = await SwaggerParser.bundle(input);
-  const ctx = mapOpenApiEndpoints(openApiDoc);
-  console.log(`Found ${ctx.endpointList.length} endpoints`);
-  const content = await prettify(generateFile({ ...ctx, runtime: options.runtime }));
-  const outputPath = join(
-    cwd,
-    options.output ?? input + `.${options.runtime === "none" ? "client" : options.runtime}.ts`
-  );
-  console.log("Generating client...", outputPath);
-  await writeFile(outputPath, content);
-  if (options.tanstack) {
-    const tanstackContent = await generateTanstackQueryFile({
-      ...ctx,
-      relativeApiClientPath: "./" + basename(outputPath)
-    });
-    const tanstackOutputPath = join(dirname(outputPath), typeof options.tanstack === "string" ? options.tanstack : `tanstack.client.ts`);
-    console.log("Generating tanstack client...", tanstackOutputPath);
-    await writeFile(tanstackOutputPath, tanstackContent);
-  }
-  console.log(`Done in ${(/* @__PURE__ */ new Date()).getTime() - now.getTime()}ms !`);
+  return generateClientFiles(input, _options);
 });
 cli.help();
 cli.version(version);

package/dist/index.js

@@ -8,7 +8,7 @@ import {
   openApiSchemaToTs,
   tsFactory,
   unwrap
-} from "./chunk-EYTM4P4S.js";
+} from "./chunk-YLPQQ24J.js";
 export {
   createBoxFactory,
   createFactory,

package/dist/node.export.d.ts

@@ -0,0 +1,13 @@
+import { Options } from 'prettier';
+import * as arktype_internal_methods_object_ts from 'arktype/internal/methods/object.ts';
+
+declare const prettify: (str: string, options?: Options | null) => string | Promise<string>;
+
+declare const optionsSchema: arktype_internal_methods_object_ts.ObjectType<{
+    runtime: "none" | "arktype" | "io-ts" | "typebox" | "valibot" | "yup" | "zod";
+    tanstack: string | boolean;
+    output?: string;
+}, {}>;
+declare function generateClientFiles(input: string, options: typeof optionsSchema.infer): Promise<void>;
+
+export { generateClientFiles, prettify };

package/dist/node.export.js

@@ -0,0 +1,10 @@
+import {
+  generateClientFiles
+} from "./chunk-YRJ7W5RY.js";
+import {
+  prettify
+} from "./chunk-YLPQQ24J.js";
+export {
+  generateClientFiles,
+  prettify
+};

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "typed-openapi",
   "type": "module",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "exports": {
-    ".": "./dist/index.js"
+    ".": "./dist/index.js",
+    "./node": "./dist/node.export.js"
   },
   "bin": {
     "typed-openapi": "bin.js"

package/src/cli.ts

@@ -1,23 +1,11 @@
-import SwaggerParser from "@apidevtools/swagger-parser";
 import { cac } from "cac";
-import type { OpenAPIObject } from "openapi3-ts/oas31";
-import { basename, join } from "pathe";
-import { type } from "arktype";
 
-import { writeFile } from "fs/promises";
-import { allowedRuntimes, generateFile } from "./generator.ts";
-import { mapOpenApiEndpoints } from "./map-openapi-endpoints.ts";
-import { generateTanstackQueryFile } from "./tanstack-query.generator.ts";
 import { readFileSync } from "fs";
-import { prettify } from "./format.ts";
-import { dirname } from "path";
+import { generateClientFiles } from "./generate-client-files.ts";
+import { allowedRuntimes } from "./generator.ts";
 
 const { name, version } = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
-const cwd = process.cwd();
 const cli = cac(name);
-const now = new Date();
-
-const optionsSchema = type({ "output?": "string", runtime: allowedRuntimes, tanstack: "boolean | string" });
 
 cli
   .command("<input>", "Generate")
@@ -29,32 +17,7 @@ cli
   )
   .option("--tanstack [name]", "Generate tanstack client, defaults to false, can optionally specify a name for the generated file")
   .action(async (input, _options) => {
-    const options = optionsSchema.assert(_options);
-    const openApiDoc = (await SwaggerParser.bundle(input)) as OpenAPIObject;
-
-    const ctx = mapOpenApiEndpoints(openApiDoc);
-    console.log(`Found ${ctx.endpointList.length} endpoints`);
-
-    const content = await prettify(generateFile({ ...ctx, runtime: options.runtime }));
-    const outputPath = join(
-      cwd,
-      options.output ?? input + `.${options.runtime === "none" ? "client" : options.runtime}.ts`,
-    );
-
-    console.log("Generating client...", outputPath);
-    await writeFile(outputPath, content);
-
-    if (options.tanstack) {
-      const tanstackContent = await generateTanstackQueryFile({
-        ...ctx,
-        relativeApiClientPath: './' + basename(outputPath),
-      });
-      const tanstackOutputPath = join(dirname(outputPath), typeof options.tanstack === "string" ? options.tanstack : `tanstack.client.ts`);
-      console.log("Generating tanstack client...", tanstackOutputPath);
-      await writeFile(tanstackOutputPath, tanstackContent);
-    }
-
-    console.log(`Done in ${new Date().getTime() - now.getTime()}ms !`);
+    return generateClientFiles(input, _options);
   });
 
 cli.help();

package/src/generate-client-files.ts

@@ -0,0 +1,46 @@
+import SwaggerParser from "@apidevtools/swagger-parser";
+import type { OpenAPIObject } from "openapi3-ts/oas31";
+import { basename, join, dirname } from "pathe";
+import { type } from "arktype";
+import { writeFile } from "fs/promises";
+import { allowedRuntimes, generateFile } from "./generator.ts";
+import { mapOpenApiEndpoints } from "./map-openapi-endpoints.ts";
+import { generateTanstackQueryFile } from "./tanstack-query.generator.ts";
+import { prettify } from "./format.ts";
+
+const cwd = process.cwd();
+const now = new Date();
+
+export const optionsSchema = type({
+    "output?": "string",
+    runtime: allowedRuntimes,
+    tanstack: "boolean | string"
+});
+
+export async function generateClientFiles(input: string, options: typeof optionsSchema.infer) {
+    const openApiDoc = (await SwaggerParser.bundle(input)) as OpenAPIObject;
+
+    const ctx = mapOpenApiEndpoints(openApiDoc);
+    console.log(`Found ${ctx.endpointList.length} endpoints`);
+
+    const content = await prettify(generateFile({ ...ctx, runtime: options.runtime }));
+    const outputPath = join(
+        cwd,
+        options.output ?? input + `.${options.runtime === "none" ? "client" : options.runtime}.ts`,
+    );
+
+    console.log("Generating client...", outputPath);
+    await writeFile(outputPath, content);
+
+    if (options.tanstack) {
+        const tanstackContent = await generateTanstackQueryFile({
+            ...ctx,
+            relativeApiClientPath: './' + basename(outputPath),
+        });
+        const tanstackOutputPath = join(dirname(outputPath), typeof options.tanstack === "string" ? options.tanstack : `tanstack.client.ts`);
+        console.log("Generating tanstack client...", tanstackOutputPath);
+        await writeFile(tanstackOutputPath, tanstackContent);
+    }
+
+    console.log(`Done in ${new Date().getTime() - now.getTime()}ms !`);
+}

package/src/node.export.ts

@@ -0,0 +1,2 @@
+export { prettify } from "./format.ts";
+export { generateClientFiles } from "./generate-client-files.ts"

package/src/tanstack-query.generator.ts

@@ -112,20 +112,28 @@ export const generateTanstackQueryFile = async (ctx: GeneratorContext & { relati
          * Generic mutation method with full type-safety for any endpoint that doesnt require parameters to be passed initially
          */
         mutation<
-        TMethod extends keyof EndpointByMethod,
-        TPath extends keyof EndpointByMethod[TMethod],
-        TEndpoint extends EndpointByMethod[TMethod][TPath]
-        >(
-          method: TMethod,
-          path: TPath) {
+            TMethod extends keyof EndpointByMethod,
+            TPath extends keyof EndpointByMethod[TMethod],
+            TEndpoint extends EndpointByMethod[TMethod][TPath],
+            TSelection,
+        >(method: TMethod, path: TPath, selectFn?: (res: Omit<Response, "json"> & {
+            /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/json) */
+            json: () => Promise<TEndpoint extends { response: infer Res } ? Res : never>;
+        }) => TSelection) {
             const mutationKey = [{ method, path }] as const;
             return {
+            /** type-only property if you need easy access to the endpoint params */
+            "~endpoint": {} as TEndpoint,
+            mutationKey: mutationKey,
+            mutationOptions: {
                 mutationKey: mutationKey,
-                mutationOptions: {
-                    mutationKey: mutationKey,
-                    mutationFn: async (params: TEndpoint extends { parameters: infer Parameters} ? Parameters: never) => this.client.request(method, path, params)
-                }
-            }
+                mutationFn: async (params: TEndpoint extends { parameters: infer Parameters } ? Parameters : never) => {
+                const response = await this.client.request(method, path, params);
+                const res = selectFn ? selectFn(response) : response
+                return res as unknown extends TSelection ? typeof response : Awaited<TSelection>
+                },
+            },
+            };
         }
         // </ApiClient.request>
   }