@kubb/swagger-ts 2.0.0-beta.6 → 2.0.0-beta.8

package/dist/components.d.cts

@@ -1,14 +1,24 @@
-import { ResolvePathOptions, Exclude, Include, Override, AppMeta as AppMeta$1, OasBuilder } from '@kubb/swagger';
-import { PluginFactoryOptions, ResolveNameParams, KubbFile } from '@kubb/core';
+import { ResolvePathOptions, Exclude, Include, Override, AppMeta as AppMeta$1, OasBuilder, OasTypes } from '@kubb/swagger';
+import { PluginFactoryOptions, KubbFile, ResolveNameParams } from '@kubb/core';
 import { ReactNode } from 'react';
 
 type Options = {
-    /**
-     * Relative path to save the TypeScript types.
-     * When output is a file it will save all models inside that file else it will create a file per schema item.
-     * @default 'types'
-     */
-    output?: string;
+    output?: {
+        /**
+         * Relative path to save the TypeScript types.
+         * When output is a file it will save all models inside that file else it will create a file per schema item.
+         * @default 'types'
+         */
+        path: string;
+        /**
+         * Name to be used for the `export * as {{exportAs}} from './'`
+         */
+        exportAs?: string;
+        /**
+         * Add an extension to the generated imports and exports, default it will not use an extension
+         */
+        extName?: KubbFile.Extname;
+    };
     /**
      * Group the TypeScript types based on the provided name.
      */
@@ -26,10 +36,6 @@ type Options = {
          */
         output?: string;
     };
-    /**
-     * Name to be used for the `export * as {{exportAs}} from './`
-     */
-    exportAs?: string;
     /**
      * Array containing exclude paramaters to exclude/skip tags/operations/methods/paths.
      */
@@ -66,12 +72,19 @@ type Options = {
          */
         name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
     };
+    /**
+     * Export Oas object as Oas type with import type { Infer } from `@kubb/swagger-ts/infer`
+     * TODO add docs
+     * @beta
+     */
+    oasType?: boolean;
 };
 type ResolvedOptions = {
     enumType: NonNullable<Options['enumType']>;
     dateType: NonNullable<Options['dateType']>;
     optionalType: NonNullable<Options['optionalType']>;
     transformers: NonNullable<Options['transformers']>;
+    oasType: NonNullable<Options['oasType']>;
     usedEnumNames: Record<string, number>;
 };
 type AppMeta = AppMeta$1;
@@ -86,17 +99,53 @@ declare class TypeBuilder extends OasBuilder<PluginOptions['resolvedOptions']> {
     build(name?: string): Required<Pick<KubbFile.File, 'imports' | 'source'>>;
 }
 
-type Props$1 = {
+type Props$2 = {
     builder: TypeBuilder;
 };
-declare function Mutation({ builder, }: Props$1): ReactNode;
+declare function Mutation({ builder, }: Props$2): ReactNode;
 declare namespace Mutation {
-    var File: ({ mode }: FileProps$1) => ReactNode;
+    var File: ({ mode }: FileProps$2) => ReactNode;
 }
-type FileProps$1 = {
+type FileProps$2 = {
     mode: KubbFile.Mode;
 };
 
+type TemplateProps = {
+    /**
+     * Name of the function
+     */
+    name: string;
+    typeName: string;
+    api: OasTypes.OASDocument;
+};
+declare function Template({ name, typeName, api, }: TemplateProps): ReactNode;
+declare const defaultTemplates: {
+    readonly default: typeof Template;
+};
+type Props$1 = {
+    name: string;
+    typeName: string;
+    /**
+     * This will make it possible to override the default behaviour.
+     */
+    Template?: React.ComponentType<React.ComponentProps<typeof Template>>;
+};
+declare function Oas({ name, typeName, Template, }: Props$1): ReactNode;
+declare namespace Oas {
+    var File: ({ name, typeName, templates }: FileProps$1) => ReactNode;
+    var templates: {
+        readonly default: typeof Template;
+    };
+}
+type FileProps$1 = {
+    name: string;
+    typeName: string;
+    /**
+     * This will make it possible to override the default behaviour.
+     */
+    templates?: typeof defaultTemplates;
+};
+
 type Props = {
     builder: TypeBuilder;
 };
@@ -108,4 +157,4 @@ type FileProps = {
     mode: KubbFile.Mode;
 };
 
-export { Mutation, Query };
+export { Mutation, Oas, Query };

package/dist/components.d.ts

@@ -1,14 +1,24 @@
-import { ResolvePathOptions, Exclude, Include, Override, AppMeta as AppMeta$1, OasBuilder } from '@kubb/swagger';
-import { PluginFactoryOptions, ResolveNameParams, KubbFile } from '@kubb/core';
+import { ResolvePathOptions, Exclude, Include, Override, AppMeta as AppMeta$1, OasBuilder, OasTypes } from '@kubb/swagger';
+import { PluginFactoryOptions, KubbFile, ResolveNameParams } from '@kubb/core';
 import { ReactNode } from 'react';
 
 type Options = {
-    /**
-     * Relative path to save the TypeScript types.
-     * When output is a file it will save all models inside that file else it will create a file per schema item.
-     * @default 'types'
-     */
-    output?: string;
+    output?: {
+        /**
+         * Relative path to save the TypeScript types.
+         * When output is a file it will save all models inside that file else it will create a file per schema item.
+         * @default 'types'
+         */
+        path: string;
+        /**
+         * Name to be used for the `export * as {{exportAs}} from './'`
+         */
+        exportAs?: string;
+        /**
+         * Add an extension to the generated imports and exports, default it will not use an extension
+         */
+        extName?: KubbFile.Extname;
+    };
     /**
      * Group the TypeScript types based on the provided name.
      */
@@ -26,10 +36,6 @@ type Options = {
          */
         output?: string;
     };
-    /**
-     * Name to be used for the `export * as {{exportAs}} from './`
-     */
-    exportAs?: string;
     /**
      * Array containing exclude paramaters to exclude/skip tags/operations/methods/paths.
      */
@@ -66,12 +72,19 @@ type Options = {
          */
         name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
     };
+    /**
+     * Export Oas object as Oas type with import type { Infer } from `@kubb/swagger-ts/infer`
+     * TODO add docs
+     * @beta
+     */
+    oasType?: boolean;
 };
 type ResolvedOptions = {
     enumType: NonNullable<Options['enumType']>;
     dateType: NonNullable<Options['dateType']>;
     optionalType: NonNullable<Options['optionalType']>;
     transformers: NonNullable<Options['transformers']>;
+    oasType: NonNullable<Options['oasType']>;
     usedEnumNames: Record<string, number>;
 };
 type AppMeta = AppMeta$1;
@@ -86,17 +99,53 @@ declare class TypeBuilder extends OasBuilder<PluginOptions['resolvedOptions']> {
     build(name?: string): Required<Pick<KubbFile.File, 'imports' | 'source'>>;
 }
 
-type Props$1 = {
+type Props$2 = {
     builder: TypeBuilder;
 };
-declare function Mutation({ builder, }: Props$1): ReactNode;
+declare function Mutation({ builder, }: Props$2): ReactNode;
 declare namespace Mutation {
-    var File: ({ mode }: FileProps$1) => ReactNode;
+    var File: ({ mode }: FileProps$2) => ReactNode;
 }
-type FileProps$1 = {
+type FileProps$2 = {
     mode: KubbFile.Mode;
 };
 
+type TemplateProps = {
+    /**
+     * Name of the function
+     */
+    name: string;
+    typeName: string;
+    api: OasTypes.OASDocument;
+};
+declare function Template({ name, typeName, api, }: TemplateProps): ReactNode;
+declare const defaultTemplates: {
+    readonly default: typeof Template;
+};
+type Props$1 = {
+    name: string;
+    typeName: string;
+    /**
+     * This will make it possible to override the default behaviour.
+     */
+    Template?: React.ComponentType<React.ComponentProps<typeof Template>>;
+};
+declare function Oas({ name, typeName, Template, }: Props$1): ReactNode;
+declare namespace Oas {
+    var File: ({ name, typeName, templates }: FileProps$1) => ReactNode;
+    var templates: {
+        readonly default: typeof Template;
+    };
+}
+type FileProps$1 = {
+    name: string;
+    typeName: string;
+    /**
+     * This will make it possible to override the default behaviour.
+     */
+    templates?: typeof defaultTemplates;
+};
+
 type Props = {
     builder: TypeBuilder;
 };
@@ -108,4 +157,4 @@ type FileProps = {
     mode: KubbFile.Mode;
 };
 
-export { Mutation, Query };
+export { Mutation, Oas, Query };

package/dist/components.js

@@ -1,15 +1,18 @@
+import { createRequire } from 'module';
 import transformers2, { camelCase, pascalCase } from '@kubb/core/transformers';
 import { print } from '@kubb/parser';
 import * as factory2 from '@kubb/parser/factory';
 import { keywordTypeNodes } from '@kubb/parser/factory';
-import { usePlugin, usePluginManager, File, createRoot } from '@kubb/react';
-import { useSchemas, useOas, useOperationFile, useOperationName, useOperation } from '@kubb/swagger/hooks';
+import { usePlugin, useFile, File, usePluginManager, createRoot, Type } from '@kubb/react';
+import { useOas, useSchemas, useOperationFile, useOperationName, useOperation } from '@kubb/swagger/hooks';
 import { pluginName as pluginName$1, OasBuilder, OperationGenerator as OperationGenerator$1 } from '@kubb/swagger';
 import { refsSorter, isReference, getSchemaFactory } from '@kubb/swagger/utils';
 import { createPlugin, FileManager, PluginManager, Generator } from '@kubb/core';
 import { renderTemplate, getUniqueName } from '@kubb/core/utils';
 import path from 'path';
 
+createRequire(import.meta.url);
+  
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -3138,11 +3141,11 @@ var require_react_jsx_runtime_development = __commonJS({
             return jsxWithValidation(type, props, key, false);
           }
         }
-        var jsx4 = jsxWithValidationDynamic;
-        var jsxs3 = jsxWithValidationStatic;
+        var jsx5 = jsxWithValidationDynamic;
+        var jsxs4 = jsxWithValidationStatic;
         exports.Fragment = REACT_FRAGMENT_TYPE;
-        exports.jsx = jsx4;
-        exports.jsxs = jsxs3;
+        exports.jsx = jsx5;
+        exports.jsxs = jsxs4;
       })();
     }
   }
@@ -3178,9 +3181,51 @@ init_esm_shims();
 // src/OperationGenerator.tsx
 init_esm_shims();
 
-// src/components/Query.tsx
+// src/components/Oas.tsx
 init_esm_shims();
 var import_jsx_runtime = __toESM(require_jsx_runtime(), 1);
+function Template({
+  name,
+  typeName,
+  api
+}) {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_jsx_runtime.Fragment, { children: [
+    `export const ${name} = ${JSON.stringify(api, void 0, 2)} as const`,
+    /* @__PURE__ */ (0, import_jsx_runtime.jsx)("br", {}),
+    /* @__PURE__ */ (0, import_jsx_runtime.jsx)(Type, { name: typeName, export: true, children: `Parse<typeof ${name}>` })
+  ] });
+}
+var defaultTemplates = { default: Template };
+function Oas({
+  name,
+  typeName,
+  Template: Template2 = defaultTemplates.default
+}) {
+  const oas = useOas();
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(Template2, { name, typeName, api: oas.api });
+}
+Oas.File = function({ name, typeName, templates = defaultTemplates }) {
+  const { key: pluginKey2 } = usePlugin();
+  const file = useFile({ name, pluginKey: pluginKey2 });
+  const Template2 = templates.default;
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(
+    File,
+    {
+      baseName: file.baseName,
+      path: file.path,
+      meta: file.meta,
+      children: [
+        /* @__PURE__ */ (0, import_jsx_runtime.jsx)(File.Import, { name: ["Parse"], path: "@kubb/swagger-ts/infer", isTypeOnly: true }),
+        /* @__PURE__ */ (0, import_jsx_runtime.jsx)(File.Source, { children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(Oas, { Template: Template2, name, typeName }) })
+      ]
+    }
+  );
+};
+Oas.templates = defaultTemplates;
+
+// src/components/Query.tsx
+init_esm_shims();
+var import_jsx_runtime2 = __toESM(require_jsx_runtime(), 1);
 function printCombinedSchema(name, operation, schemas) {
   const properties = {
     "response": factory2.createTypeReferenceNode(
@@ -3242,7 +3287,7 @@ function Query({
   builder
 }) {
   const { source } = builder.build();
-  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_jsx_runtime.Fragment, { children: source });
+  return /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(import_jsx_runtime2.Fragment, { children: source });
 }
 Query.File = function({ mode }) {
   const { options } = usePlugin();
@@ -3254,7 +3299,7 @@ Query.File = function({ mode }) {
   const operation = useOperation();
   const builder = new TypeBuilder(options, { oas, pluginManager }).add(schemas.pathParams).add(schemas.queryParams).add(schemas.headerParams).add(schemas.response).add(schemas.errors);
   const { source, imports } = builder.build();
-  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_jsx_runtime.Fragment, { children: /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(
+  return /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(import_jsx_runtime2.Fragment, { children: /* @__PURE__ */ (0, import_jsx_runtime2.jsxs)(
     File,
     {
       baseName: file.baseName,
@@ -3262,9 +3307,9 @@ Query.File = function({ mode }) {
       meta: file.meta,
       children: [
         mode === "directory" && imports.map((item, index) => {
-          return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(File.Import, { root: file.path, ...item }, index);
+          return /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(File.Import, { root: file.path, ...item }, index);
         }),
-        /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(File.Source, { children: [
+        /* @__PURE__ */ (0, import_jsx_runtime2.jsxs)(File.Source, { children: [
           source,
           printCombinedSchema(factoryName, operation, schemas)
         ] })
@@ -3274,16 +3319,25 @@ Query.File = function({ mode }) {
 };
 
 // src/OperationGenerator.tsx
-var import_jsx_runtime2 = __toESM(require_jsx_runtime(), 1);
+var import_jsx_runtime3 = __toESM(require_jsx_runtime(), 1);
 var OperationGenerator = class extends OperationGenerator$1 {
   async all() {
-    return null;
+    const { oas, pluginManager, plugin } = this.context;
+    if (!plugin.options.oasType) {
+      return null;
+    }
+    const root = createRoot({ logger: pluginManager.logger });
+    root.render(
+      /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(Oas.File, { name: "oas", typeName: "Oas" }),
+      { meta: { oas, pluginManager, plugin } }
+    );
+    return root.files;
   }
   async get(operation, schemas, options) {
     const { oas, pluginManager, plugin, mode = "directory" } = this.context;
     const root = createRoot({ logger: pluginManager.logger });
     root.render(
-      /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(Query.File, { mode }),
+      /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(Query.File, { mode }),
       { meta: { oas, pluginManager, plugin: { ...plugin, options }, schemas, operation } }
     );
     return root.files;
@@ -3292,7 +3346,7 @@ var OperationGenerator = class extends OperationGenerator$1 {
     const { oas, pluginManager, plugin, mode = "directory" } = this.context;
     const root = createRoot({ logger: pluginManager.logger });
     root.render(
-      /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(Mutation.File, { mode }),
+      /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(Mutation.File, { mode }),
       { meta: { oas, pluginManager, plugin: { ...plugin, options }, schemas, operation } }
     );
     return root.files;
@@ -3313,7 +3367,7 @@ var pluginName = "swagger-ts";
 var pluginKey = [pluginName];
 createPlugin((options) => {
   const {
-    output = "types",
+    output = { path: "types" },
     group,
     exclude = [],
     include,
@@ -3322,9 +3376,9 @@ createPlugin((options) => {
     dateType = "string",
     optionalType = "questionToken",
     transformers: transformers5 = {},
-    exportAs
+    oasType = false
   } = options;
-  const template = group?.output ? group.output : `${output}/{{tag}}Controller`;
+  const template = group?.output ? group.output : `${output.path}/{{tag}}Controller`;
   return {
     name: pluginName,
     options: {
@@ -3332,21 +3386,22 @@ createPlugin((options) => {
       dateType,
       enumType,
       optionalType,
+      oasType,
       // keep the used enumnames between TypeBuilder and OperationGenerator per plugin(pluginKey)
       usedEnumNames: {}
     },
     pre: [pluginName$1],
     resolvePath(baseName, directory, options2) {
       const root = path.resolve(this.config.root, this.config.output.path);
-      const mode = FileManager.getMode(path.resolve(root, output));
+      const mode = FileManager.getMode(path.resolve(root, output.path));
       if (mode === "file") {
-        return path.resolve(root, output);
+        return path.resolve(root, output.path);
       }
       if (options2?.tag && group?.type === "tag") {
         const tag = camelCase(options2.tag);
         return path.resolve(root, renderTemplate(template, { tag }), baseName);
       }
-      return path.resolve(root, output, baseName);
+      return path.resolve(root, output.path, baseName);
     },
     resolveName(name, type) {
       const resolvedName = pascalCase(name);
@@ -3366,7 +3421,7 @@ createPlugin((options) => {
       const oas = await swaggerPlugin.api.getOas();
       const schemas = await swaggerPlugin.api.getSchemas();
       const root = path.resolve(this.config.root, this.config.output.path);
-      const mode = FileManager.getMode(path.resolve(root, output));
+      const mode = FileManager.getMode(path.resolve(root, output.path));
       const builder = new TypeBuilder(this.plugin.options, { oas, pluginManager: this.pluginManager });
       builder.add(
         Object.entries(schemas).map(([name, schema]) => ({ name, schema }))
@@ -3400,7 +3455,7 @@ createPlugin((options) => {
         }
         await this.addFile({
           path: resolvedPath,
-          baseName: output,
+          baseName: output.path,
           source,
           imports: [],
           meta: {
@@ -3431,25 +3486,9 @@ createPlugin((options) => {
       const root = path.resolve(this.config.root, this.config.output.path);
       await this.fileManager.addIndexes({
         root,
-        extName: ".ts",
+        output,
         meta: { pluginKey: this.plugin.key },
         options: {
-          map: (file) => {
-            return {
-              ...file,
-              exports: file.exports?.map((item) => {
-                if (exportAs) {
-                  return {
-                    ...item,
-                    name: exportAs,
-                    asAlias: !!exportAs
-                  };
-                }
-                return item;
-              })
-            };
-          },
-          output,
           isTypeOnly: true
         }
       });
@@ -3783,7 +3822,7 @@ var TypeBuilder = class extends OasBuilder {
 };
 
 // src/components/Mutation.tsx
-var import_jsx_runtime3 = __toESM(require_jsx_runtime(), 1);
+var import_jsx_runtime4 = __toESM(require_jsx_runtime(), 1);
 function printCombinedSchema2(name, operation, schemas) {
   const properties = {
     "response": factory2.createTypeReferenceNode(
@@ -3845,7 +3884,7 @@ function Mutation({
   builder
 }) {
   const { source } = builder.build();
-  return /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(import_jsx_runtime3.Fragment, { children: source });
+  return /* @__PURE__ */ (0, import_jsx_runtime4.jsx)(import_jsx_runtime4.Fragment, { children: source });
 }
 Mutation.File = function({ mode }) {
   const { options } = usePlugin();
@@ -3857,7 +3896,7 @@ Mutation.File = function({ mode }) {
   const operation = useOperation();
   const builder = new TypeBuilder(options, { oas, pluginManager }).add(schemas.pathParams).add(schemas.queryParams).add(schemas.headerParams).add(schemas.response).add(schemas.request).add(schemas.errors);
   const { source, imports } = builder.build();
-  return /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(import_jsx_runtime3.Fragment, { children: /* @__PURE__ */ (0, import_jsx_runtime3.jsxs)(
+  return /* @__PURE__ */ (0, import_jsx_runtime4.jsx)(import_jsx_runtime4.Fragment, { children: /* @__PURE__ */ (0, import_jsx_runtime4.jsxs)(
     File,
     {
       baseName: file.baseName,
@@ -3865,9 +3904,9 @@ Mutation.File = function({ mode }) {
       meta: file.meta,
       children: [
         mode === "directory" && imports.map((item, index) => {
-          return /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(File.Import, { root: file.path, ...item }, index);
+          return /* @__PURE__ */ (0, import_jsx_runtime4.jsx)(File.Import, { root: file.path, ...item }, index);
         }),
-        /* @__PURE__ */ (0, import_jsx_runtime3.jsxs)(File.Source, { children: [
+        /* @__PURE__ */ (0, import_jsx_runtime4.jsxs)(File.Source, { children: [
           source,
           printCombinedSchema2(factoryName, operation, schemas)
         ] })
@@ -3922,6 +3961,6 @@ react/cjs/react-jsx-runtime.development.js:
    *)
 */
 
-export { Mutation, Query };
+export { Mutation, Oas, Query };
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=components.js.map