@kubb/kit 5.8.1 → 5.8.3

package/README.md

@@ -24,7 +24,7 @@
 
 ### Authoring toolkit for Kubb plugins
 
-`@kubb/kit` gathers the helpers you call when you author a plugin, generator, adapter, resolver, or renderer: `definePlugin`, `defineGenerator`, `defineResolver`, `defineParser`, `createAdapter`, `createRenderer`, the `ast` namespace and `factory` node builders, and the option and hook types that go with them. It sits next to the `kubb` package, which is where end users configure and run builds. `kubb/kit` re-exports this package, so most consumers reach it through `kubb/kit` rather than installing `@kubb/kit` directly.
+`@kubb/kit` gathers the helpers you call when you author a plugin, generator, adapter, resolver, parser, or renderer: `defineExtension`, `defineGenerator`, `createResolver`, `createRenderer`, the `ast` namespace and `factory` node builders, and the option and hook types that go with them. It sits next to the `kubb` package, which is where end users configure and run builds. `kubb/kit` re-exports this package, so most consumers reach it through `kubb/kit` rather than installing `@kubb/kit` directly.
 
 ## Installation
 
@@ -41,25 +41,36 @@ npm install kubb
 ## Usage
 
 ```typescript
-import { ast, definePlugin, defineGenerator } from 'kubb/kit'
+import { ast, defineExtension, defineGenerator } from 'kubb/kit'
 
-export const pluginExample = definePlugin(() => {
-  return {
-    name: 'example',
-    generators: [
+export const pluginExample = defineExtension({
+  kind: 'plugin',
+  meta: { name: 'plugin-example' },
+  setup(_options, kubb) {
+    kubb.addGenerator(
       defineGenerator({
-        schema({ schema }) {
-          return ast.factory.createSchema(schema)
+        name: 'example',
+        schema(node) {
+          return [
+            ast.factory.createFile({
+              path: `${node.name}.ts`,
+              baseName: `${node.name}.ts`,
+              sources: [ast.factory.createSource({ nodes: [ast.factory.createText(`// ${node.name}\n`)] })],
+              imports: [],
+              exports: [],
+            }),
+          ]
         },
       }),
-    ],
-  }
+    )
+    return {}
+  },
 })
 ```
 
 ## What is in the box
 
-`definePlugin`, `defineGenerator`, `defineResolver`, and `defineParser` wrap a plugin, a generator, a resolver, or a parser into the shape the build engine expects. `createAdapter`, `createRenderer`, and `createStorage` are the matching factories for a custom spec adapter, output renderer, or storage backend.
+`defineExtension` wraps a plugin, an adapter, or a parser into the shape the build engine expects. Set `kind` to `'plugin'`, `'adapter'`, or `'parser'`. `definePlugin`, `defineParser`, and `createAdapter` still work but are deprecated in favor of it. `defineGenerator` and `createResolver` wrap a generator or a resolver. `createRenderer` and `createStorage` are the matching factories for a custom output renderer or storage backend.
 
 `ast` and `factory` are the node builders a generator calls to construct the file, schema, and operation nodes it returns. `Diagnostics` is the structured error a plugin throws to report a problem with a location and a fix suggestion, and `memoryStorage` and `fsStorage` are the built-in storage backends, useful in tests and custom configs.
 

package/dist/index.cjs

@@ -627,6 +627,12 @@ Object.defineProperty(exports, "createStorage", {
 		return _kubb_core.createStorage;
 	}
 });
+Object.defineProperty(exports, "defineExtension", {
+	enumerable: true,
+	get: function() {
+		return _kubb_core.defineExtension;
+	}
+});
 Object.defineProperty(exports, "defineGenerator", {
 	enumerable: true,
 	get: function() {

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { t as __name } from "./rolldown-runtime-C0LytTxp.js";
 import { SchemaNode, ast, ast as ast$1 } from "@kubb/ast";
-import { Adapter, AdapterDefinition, AdapterFactory, AdapterFactoryOptions, AdapterSource, BannerMeta, Config, Diagnostic, Diagnostics, Exclude, ExtensionDependencies, ExtensionDependency, ExtensionDependencyRecord, ExtensionFactory, ExtensionKind, ExtensionManifest, ExtensionManifestOption, ExtensionMeta, Generator as Generator$1, GeneratorContext, Group, Hookable, Include, KubbHooks, KubbPluginEndContext, KubbPluginSetupContext, KubbPluginStartContext, NodeCache, NormalizedPlugin, Output, OutputOptions, Override, Parser, ParserDefinition, ParserFactory, Plugin, PluginDefinition, PluginFactory, PluginFactoryOptions, PluginType, Renderer, RendererFactory, ResolveFileOptions, ResolveImportsOptions, ResolvePathOptions, Resolver, ResolverFile, ResolverFileParams, ResolverFilePathParams, ResolverPatch, Storage, addGenerator, addMacro, assertPluginOption, createAdapter, createRenderer, createResolver, createStorage, defineGenerator, defineParser, definePlugin, fsStorage, injectFile, isExtensionManifest, kubbContext, manifestProblems, memoryStorage, requirePlugin, setMacros, setOptions, setResolver, tryUseKubb, useConfig, useKubb, useOptions } from "@kubb/core";
+import { Adapter, AdapterDefinition, AdapterFactory, AdapterFactoryOptions, AdapterSource, BannerMeta, Config, Diagnostic, Diagnostics, Exclude, ExtensionDependencies, ExtensionDependency, ExtensionDependencyRecord, ExtensionFactory, ExtensionKind, ExtensionManifest, ExtensionManifestOption, ExtensionMeta, Generator as Generator$1, GeneratorContext, Group, Hookable, Include, KubbHooks, KubbPluginEndContext, KubbPluginSetupContext, KubbPluginStartContext, NodeCache, NormalizedPlugin, Output, OutputOptions, Override, Parser, ParserDefinition, ParserFactory, Plugin, PluginDefinition, PluginFactory, PluginFactoryOptions, PluginType, Renderer, RendererFactory, ResolveFileOptions, ResolveImportsOptions, ResolvePathOptions, Resolver, ResolverFile, ResolverFileParams, ResolverFilePathParams, ResolverPatch, Storage, addGenerator, addMacro, assertPluginOption, createAdapter, createRenderer, createResolver, createStorage, defineExtension, defineGenerator, defineParser, definePlugin, fsStorage, injectFile, isExtensionManifest, kubbContext, manifestProblems, memoryStorage, requirePlugin, setMacros, setOptions, setResolver, tryUseKubb, useConfig, useKubb, useOptions } from "@kubb/core";
 //#region src/Url.d.ts
 type URLObject = {
   /**
@@ -232,5 +232,5 @@ export declare function containsCircularRef(node: SchemaNode | undefined, { circ
   excludeName?: string;
 }): boolean;
 //#endregion
-export { type Adapter, type AdapterDefinition, type AdapterFactory, type AdapterFactoryOptions, type AdapterSource, type BannerMeta, type Config, type Diagnostic, Diagnostics, type Exclude, type ExtensionDependencies, type ExtensionDependency, type ExtensionDependencyRecord, type ExtensionFactory, type ExtensionKind, type ExtensionManifest, type ExtensionManifestOption, type ExtensionMeta, type Generator$1 as Generator, type GeneratorContext, type Group, Hookable, type Include, type KubbHooks, type KubbPluginEndContext, type KubbPluginSetupContext, type KubbPluginStartContext, type NodeCache, type NormalizedPlugin, type Output, type OutputOptions, type Override, type Parser, type ParserDefinition, type ParserFactory, type Plugin, type PluginDefinition, type PluginFactory, type PluginFactoryOptions, type PluginType, type Renderer, type RendererFactory, type ResolveFileOptions, type ResolveImportsOptions, type ResolvePathOptions, Resolver, type ResolverFile, type ResolverFileParams, type ResolverFilePathParams, type ResolverPatch, type Storage, addGenerator, addMacro, assertPluginOption, ast, createAdapter, createRenderer, createResolver, createStorage, defineGenerator, defineParser, definePlugin, fsStorage, injectFile, isExtensionManifest, kubbContext, manifestProblems, memoryStorage, requirePlugin, setMacros, setOptions, setResolver, tryUseKubb, useConfig, useKubb, useOptions };
+export { type Adapter, type AdapterDefinition, type AdapterFactory, type AdapterFactoryOptions, type AdapterSource, type BannerMeta, type Config, type Diagnostic, Diagnostics, type Exclude, type ExtensionDependencies, type ExtensionDependency, type ExtensionDependencyRecord, type ExtensionFactory, type ExtensionKind, type ExtensionManifest, type ExtensionManifestOption, type ExtensionMeta, type Generator$1 as Generator, type GeneratorContext, type Group, Hookable, type Include, type KubbHooks, type KubbPluginEndContext, type KubbPluginSetupContext, type KubbPluginStartContext, type NodeCache, type NormalizedPlugin, type Output, type OutputOptions, type Override, type Parser, type ParserDefinition, type ParserFactory, type Plugin, type PluginDefinition, type PluginFactory, type PluginFactoryOptions, type PluginType, type Renderer, type RendererFactory, type ResolveFileOptions, type ResolveImportsOptions, type ResolvePathOptions, Resolver, type ResolverFile, type ResolverFileParams, type ResolverFilePathParams, type ResolverPatch, type Storage, addGenerator, addMacro, assertPluginOption, ast, createAdapter, createRenderer, createResolver, createStorage, defineExtension, defineGenerator, defineParser, definePlugin, fsStorage, injectFile, isExtensionManifest, kubbContext, manifestProblems, memoryStorage, requirePlugin, setMacros, setOptions, setResolver, tryUseKubb, useConfig, useKubb, useOptions };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,6 +1,6 @@
 import "./rolldown-runtime-C0LytTxp.js";
 import { ast, ast as ast$1 } from "@kubb/ast";
-import { Diagnostics, Hookable, Resolver, addGenerator, addMacro, assertPluginOption, createAdapter, createRenderer, createResolver, createStorage, defineGenerator, defineParser, definePlugin, fsStorage, injectFile, isExtensionManifest, kubbContext, manifestProblems, memoryStorage, requirePlugin, setMacros, setOptions, setResolver, tryUseKubb, useConfig, useKubb, useOptions } from "@kubb/core";
+import { Diagnostics, Hookable, Resolver, addGenerator, addMacro, assertPluginOption, createAdapter, createRenderer, createResolver, createStorage, defineExtension, defineGenerator, defineParser, definePlugin, fsStorage, injectFile, isExtensionManifest, kubbContext, manifestProblems, memoryStorage, requirePlugin, setMacros, setOptions, setResolver, tryUseKubb, useConfig, useKubb, useOptions } from "@kubb/core";
 //#region ../../internals/utils/src/casing.ts
 /**
 * Shared implementation for camelCase and PascalCase conversion.
@@ -557,6 +557,6 @@ function containsCircularRef(node, { circularSchemas, excludeName }) {
 	return false;
 }
 //#endregion
-export { Diagnostics, Hookable, Resolver, Url, addGenerator, addMacro, assertPluginOption, ast, childName, containsCircularRef, createAdapter, createRenderer, createResolver, createStorage, defineGenerator, defineParser, definePlugin, enumPropName, extractRefName, fsStorage, injectFile, isExtensionManifest, isStringType, kubbContext, macroDiscriminatorEnum, macroEnumName, macroRenameSchema, macroSimplifyUnion, manifestProblems, memoryStorage, mergeAdjacentObjectsLazy, requirePlugin, setMacros, setOptions, setResolver, syncSchemaRef, tryUseKubb, useConfig, useKubb, useOptions };
+export { Diagnostics, Hookable, Resolver, Url, addGenerator, addMacro, assertPluginOption, ast, childName, containsCircularRef, createAdapter, createRenderer, createResolver, createStorage, defineExtension, defineGenerator, defineParser, definePlugin, enumPropName, extractRefName, fsStorage, injectFile, isExtensionManifest, isStringType, kubbContext, macroDiscriminatorEnum, macroEnumName, macroRenameSchema, macroSimplifyUnion, manifestProblems, memoryStorage, mergeAdjacentObjectsLazy, requirePlugin, setMacros, setOptions, setResolver, syncSchemaRef, tryUseKubb, useConfig, useKubb, useOptions };
 
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/kit",
-  "version": "5.8.1",
+  "version": "5.8.3",
   "description": "Authoring toolkit for Kubb plugins, generators, adapters, resolvers, and renderers.",
   "keywords": [
     "codegen",
@@ -63,8 +63,8 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/ast": "5.8.1",
-    "@kubb/core": "5.8.1"
+    "@kubb/ast": "5.8.3",
+    "@kubb/core": "5.8.3"
   },
   "devDependencies": {
     "@internals/utils": "0.0.1"