Merge pull request #1368 from hey-api/fix/plugin-api-namespace

fix: export Plugin API namespace
hey-api · Dec 1, 2024 · 13808da · 13808da
2 parents 84efb27 + cca2290
commit 13808da
Show file tree

Hide file tree

Showing 40 changed files with 229 additions and 197 deletions.
diff --git a/.changeset/sharp-dogs-sin.md b/.changeset/sharp-dogs-sin.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: export Plugin API namespace
diff --git a/docs/openapi-ts/plugins.md b/docs/openapi-ts/plugins.md
@@ -37,7 +37,7 @@ Featured community plugins.
 ## Custom
 
 ::: warning
-Plugins API is in development. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
+Plugin API is in development. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
 :::
 
 If the existing plugins do not handle your use case or you're working with proprietary packages, you might want to create your own plugin.
@@ -79,17 +79,17 @@ export interface Config {
 
 :::
 
-`config.ts` contains the runtime configuration for your plugin. It must implement the `Config` interface from `types.d.ts` and additional plugin metadata defined in the `PluginConfig` interface.
+`config.ts` contains the runtime configuration for your plugin. It must implement the `Config` interface from `types.d.ts` and additional plugin metadata defined in the `Plugin.Config` interface.
 
 ::: code-group
 
 ```ts [config.ts]
-import type { Plugins } from '@hey-api/openapi-ts';
+import type { Plugin } from '@hey-api/openapi-ts';
 
 import { handler } from './plugin';
 import type { Config } from './types';
 
-export const defaultConfig: Plugins.PluginConfig<Config> = {
+export const defaultConfig: Plugin.Config<Config> = {
   _dependencies: ['@hey-api/typescript'],
   _handler: handler,
   _handlerLegacy: () => {},
@@ -98,9 +98,9 @@ export const defaultConfig: Plugins.PluginConfig<Config> = {
 };
 
 /**
- * Type helper for `my-plugin` plugin, returns {@link Plugins.PluginConfig} object
+ * Type helper for `my-plugin` plugin, returns {@link Plugin.Config} object
  */
-export const defineConfig: Plugins.DefineConfig<Config> = (config) => ({
+export const defineConfig: Plugin.DefineConfig<Config> = (config) => ({
   ...defaultConfig,
   ...config,
 });
@@ -115,11 +115,11 @@ Lastly, we define the `_handler` method which will be responsible for generating
 ::: code-group
 
 ```ts [plugin.ts]
-import type { Plugins } from '@hey-api/openapi-ts';
+import type { Plugin } from '@hey-api/openapi-ts';
 
 import type { Config } from './types';
 
-export const handler: Plugins.PluginHandler<Config> = ({ context, plugin }) => {
+export const handler: Plugin.Handler<Config> = ({ context, plugin }) => {
   // create a file for our output
   const file = context.createFile({
     id: plugin.name,

diff --git a/packages/openapi-ts/src/index.ts b/packages/openapi-ts/src/index.ts
@@ -10,7 +10,7 @@ import type { IRContext } from './ir/context';
 import { parseExperimental, parseLegacy } from './openApi';
 import type { ClientPlugins } from './plugins';
 import { defaultPluginConfigs } from './plugins';
-import type { DefaultPluginConfigsMap, PluginNames } from './plugins/types';
+import type { DefaultPluginConfigs, PluginNames } from './plugins/types';
 import type { Client } from './types/client';
 import type {
   ClientConfig,
@@ -167,7 +167,7 @@ const getPluginOrder = ({
   pluginConfigs,
   userPlugins,
 }: {
-  pluginConfigs: DefaultPluginConfigsMap<ClientPlugins>;
+  pluginConfigs: DefaultPluginConfigs<ClientPlugins>;
   userPlugins: ReadonlyArray<PluginNames>;
 }): Config['pluginOrder'] => {
   const circularReferenceTracker = new Set<PluginNames>();
@@ -486,5 +486,5 @@ export default {
 
 export type { OpenApiV3_0_X } from './openApi/3.0.x';
 export type { OpenApiV3_1_X } from './openApi/3.1.x';
-export type * as Plugins from './plugins/types';
+export type { Plugin } from './plugins/types';
 export type { UserConfig } from './types/config';
diff --git a/packages/openapi-ts/src/plugins/@hey-api/schemas/config.ts b/packages/openapi-ts/src/plugins/@hey-api/schemas/config.ts
@@ -1,9 +1,9 @@
-import type { DefineConfig, PluginConfig } from '../../types';
+import type { Plugin } from '../../types';
 import { handler } from './plugin';
 import { handlerLegacy } from './plugin-legacy';
 import type { Config } from './types';
 
-export const defaultConfig: PluginConfig<Config> = {
+export const defaultConfig: Plugin.Config<Config> = {
   _handler: handler,
   _handlerLegacy: handlerLegacy,
   name: '@hey-api/schemas',
@@ -13,9 +13,9 @@ export const defaultConfig: PluginConfig<Config> = {
 };
 
 /**
- * Type helper for `@hey-api/schemas` plugin, returns {@link PluginConfig} object
+ * Type helper for `@hey-api/schemas` plugin, returns {@link Plugin.Config} object
  */
-export const defineConfig: DefineConfig<Config> = (config) => ({
+export const defineConfig: Plugin.DefineConfig<Config> = (config) => ({
   ...defaultConfig,
   ...config,
 });
diff --git a/packages/openapi-ts/src/plugins/@hey-api/schemas/plugin-legacy.ts b/packages/openapi-ts/src/plugins/@hey-api/schemas/plugin-legacy.ts
@@ -3,7 +3,7 @@ import { TypeScriptFile } from '../../../generate/files';
 import type { OpenApiV2Schema, OpenApiV3Schema } from '../../../openApi';
 import { ensureValidTypeScriptJavaScriptIdentifier } from '../../../openApi';
 import { getConfig } from '../../../utils/config';
-import type { PluginLegacyHandler } from '../../types';
+import type { Plugin } from '../../types';
 import type { Config } from './types';
 
 const ensureValidSchemaOutput = (
@@ -69,7 +69,7 @@ const toSchemaName = (
   return `${validName}Schema`;
 };
 
-export const handlerLegacy: PluginLegacyHandler<Config> = ({
+export const handlerLegacy: Plugin.LegacyHandler<Config> = ({
   files,
   openApi,
 }) => {

diff --git a/packages/openapi-ts/src/plugins/@hey-api/schemas/plugin.ts b/packages/openapi-ts/src/plugins/@hey-api/schemas/plugin.ts
@@ -8,7 +8,7 @@ import type {
 } from '../../../openApi/3.0.x/types/spec';
 import type { OpenApiV3_1_X } from '../../../openApi/3.1.x';
 import type { SchemaObject as OpenApiV3_1_XSchemaObject } from '../../../openApi/3.1.x/types/spec';
-import type { Plugin, PluginHandler } from '../../types';
+import type { Plugin } from '../../types';
 import type { Config } from './types';
 
 const schemasId = 'schemas';
@@ -17,7 +17,7 @@ const stripSchema = ({
   plugin,
   schema,
 }: {
-  plugin: Plugin<Config>;
+  plugin: Plugin.Instance<Config>;
   schema: OpenApiV3_0_XSchemaObject | OpenApiV3_1_XSchemaObject;
 }) => {
   if (plugin.type === 'form') {
@@ -49,7 +49,7 @@ const schemaToJsonSchemaDraft_05 = ({
   schema: _schema,
 }: {
   context: IRContext;
-  plugin: Plugin<Config>;
+  plugin: Plugin.Instance<Config>;
   schema: OpenApiV3_0_XSchemaObject | OpenApiV3_0_XReferenceObject;
 }): object => {
   if (Array.isArray(_schema)) {
@@ -145,7 +145,7 @@ const schemaToJsonSchema2020_12 = ({
   schema: _schema,
 }: {
   context: IRContext;
-  plugin: Plugin<Config>;
+  plugin: Plugin.Instance<Config>;
   schema: OpenApiV3_1_XSchemaObject;
 }): object => {
   if (Array.isArray(_schema)) {
@@ -250,7 +250,7 @@ const schemaName = ({
   schema,
 }: {
   name: string;
-  plugin: Plugin<Config>;
+  plugin: Plugin.Instance<Config>;
   schema:
     | OpenApiV3_0_XReferenceObject
     | OpenApiV3_0_XSchemaObject
@@ -270,7 +270,7 @@ const schemasV3_0_X = ({
   plugin,
 }: {
   context: IRContext<OpenApiV3_0_X>;
-  plugin: Plugin<Config>;
+  plugin: Plugin.Instance<Config>;
 }) => {
   if (!context.spec.components) {
     return;
@@ -298,7 +298,7 @@ const schemasV3_1_X = ({
   plugin,
 }: {
   context: IRContext<OpenApiV3_1_X>;
-  plugin: Plugin<Config>;
+  plugin: Plugin.Instance<Config>;
 }) => {
   if (!context.spec.components) {
     return;
@@ -321,7 +321,7 @@ const schemasV3_1_X = ({
   }
 };
 
-export const handler: PluginHandler<Config> = ({ context, plugin }) => {
+export const handler: Plugin.Handler<Config> = ({ context, plugin }) => {
   context.createFile({
     id: schemasId,
     path: plugin.output,

diff --git a/packages/openapi-ts/src/plugins/@hey-api/schemas/types.d.ts b/packages/openapi-ts/src/plugins/@hey-api/schemas/types.d.ts
@@ -4,9 +4,9 @@ import type {
   SchemaObject as OpenApiV3_0_XSchemaObject,
 } from '../../../openApi/3.0.x/types/spec';
 import type { SchemaObject as OpenApiV3_1_XSchemaObject } from '../../../openApi/3.1.x/types/spec';
-import type { PluginName } from '../../types';
+import type { Plugin } from '../../types';
 
-export interface Config extends PluginName<'@hey-api/schemas'> {
+export interface Config extends Plugin.Name<'@hey-api/schemas'> {
   /**
    * Customise the schema name. By default, `{{name}}Schema` is used. `name` is a
    * valid JavaScript/TypeScript identifier, e.g. if your schema name is

diff --git a/packages/openapi-ts/src/plugins/@hey-api/sdk/config.ts b/packages/openapi-ts/src/plugins/@hey-api/sdk/config.ts
@@ -1,9 +1,9 @@
-import type { DefineConfig, PluginConfig } from '../../types';
+import type { Plugin } from '../../types';
 import { handler } from './plugin';
 import { handlerLegacy } from './plugin-legacy';
 import type { Config } from './types';
 
-export const defaultConfig: PluginConfig<Config> = {
+export const defaultConfig: Plugin.Config<Config> = {
   _dependencies: ['@hey-api/typescript'],
   _handler: handler,
   _handlerLegacy: handlerLegacy,
@@ -17,9 +17,9 @@ export const defaultConfig: PluginConfig<Config> = {
 };
 
 /**
- * Type helper for `@hey-api/sdk` plugin, returns {@link PluginConfig} object
+ * Type helper for `@hey-api/sdk` plugin, returns {@link Plugin.Config} object
  */
-export const defineConfig: DefineConfig<Config> = (config) => ({
+export const defineConfig: Plugin.DefineConfig<Config> = (config) => ({
   ...defaultConfig,
   ...config,
 });
diff --git a/packages/openapi-ts/src/plugins/@hey-api/sdk/plugin-legacy.ts b/packages/openapi-ts/src/plugins/@hey-api/sdk/plugin-legacy.ts
@@ -32,7 +32,7 @@ import { stringCase } from '../../../utils/stringCase';
 import { transformServiceName } from '../../../utils/transform';
 import { setUniqueTypeName } from '../../../utils/type';
 import { unique } from '../../../utils/unique';
-import type { PluginLegacyHandler } from '../../types';
+import type { Plugin } from '../../types';
 
 type OnNode = (node: Node) => void;
 type OnImport = (name: string) => void;
@@ -768,7 +768,7 @@ const processService = ({
   onNode(statement);
 };
 
-export const handlerLegacy: PluginLegacyHandler<any> = ({ client, files }) => {
+export const handlerLegacy: Plugin.LegacyHandler<any> = ({ client, files }) => {
   const config = getConfig();
 
   if (!config.client.name) {

diff --git a/packages/openapi-ts/src/plugins/@hey-api/sdk/plugin.ts b/packages/openapi-ts/src/plugins/@hey-api/sdk/plugin.ts
@@ -11,7 +11,7 @@ import { getServiceName } from '../../../utils/postprocess';
 import { irRef } from '../../../utils/ref';
 import { stringCase } from '../../../utils/stringCase';
 import { transformServiceName } from '../../../utils/transform';
-import type { PluginHandler } from '../../types';
+import type { Plugin } from '../../types';
 import { operationTransformerIrRef } from '../transformers/plugin';
 import { serviceFunctionIdentifier } from './plugin-legacy';
 import type { Config } from './types';
@@ -386,7 +386,7 @@ const generateFlatSdk = ({ context }: { context: IRContext }) => {
   });
 };
 
-export const handler: PluginHandler<Config> = ({ context, plugin }) => {
+export const handler: Plugin.Handler<Config> = ({ context, plugin }) => {
   if (!context.config.client.name) {
     throw new Error(
       '🚫 client needs to be set to generate SDKs - which HTTP client do you want to use?',

diff --git a/packages/openapi-ts/src/plugins/@hey-api/sdk/types.d.ts b/packages/openapi-ts/src/plugins/@hey-api/sdk/types.d.ts
@@ -1,8 +1,8 @@
 import type { IROperationObject } from '../../../ir/ir';
 import type { Operation } from '../../../types/client';
-import type { PluginName } from '../../types';
+import type { Plugin } from '../../types';
 
-export interface Config extends PluginName<'@hey-api/sdk'> {
+export interface Config extends Plugin.Name<'@hey-api/sdk'> {
   /**
    * Group operation methods into classes? When enabled, you can
    * select which classes to export with `sdk.include` and/or

diff --git a/packages/openapi-ts/src/plugins/@hey-api/transformers/config.ts b/packages/openapi-ts/src/plugins/@hey-api/transformers/config.ts
@@ -1,9 +1,9 @@
-import type { DefineConfig, PluginConfig } from '../../types';
+import type { Plugin } from '../../types';
 import { handler } from './plugin';
 import { handlerLegacy } from './plugin-legacy';
 import type { Config } from './types';
 
-export const defaultConfig: PluginConfig<Config> = {
+export const defaultConfig: Plugin.Config<Config> = {
   _dependencies: ['@hey-api/typescript'],
   _handler: handler,
   _handlerLegacy: handlerLegacy,
@@ -13,9 +13,9 @@ export const defaultConfig: PluginConfig<Config> = {
 };
 
 /**
- * Type helper for `@hey-api/transformers`, returns {@link PluginConfig} object
+ * Type helper for `@hey-api/transformers`, returns {@link Plugin.Config} object
  */
-export const defineConfig: DefineConfig<Config> = (config) => ({
+export const defineConfig: Plugin.DefineConfig<Config> = (config) => ({
   ...defaultConfig,
   ...config,
 });
diff --git a/packages/openapi-ts/src/plugins/@hey-api/transformers/plugin-legacy.ts b/packages/openapi-ts/src/plugins/@hey-api/transformers/plugin-legacy.ts
@@ -5,7 +5,7 @@ import { getOperationKey } from '../../../openApi/common/parser/operation';
 import type { ModelMeta, OperationResponse } from '../../../types/client';
 import { getConfig } from '../../../utils/config';
 import { isModelDate, unsetUniqueTypeName } from '../../../utils/type';
-import type { PluginLegacyHandler } from '../../types';
+import type { Plugin } from '../../types';
 import {
   modelResponseTransformerTypeName,
   operationResponseTransformerTypeName,
@@ -246,7 +246,7 @@ const generateResponseTransformer = ({
 };
 
 // handles only response transformers for now
-export const handlerLegacy: PluginLegacyHandler<Config> = ({
+export const handlerLegacy: Plugin.LegacyHandler<Config> = ({
   client,
   files,
 }) => {

diff --git a/packages/openapi-ts/src/plugins/@hey-api/transformers/plugin.ts b/packages/openapi-ts/src/plugins/@hey-api/transformers/plugin.ts
@@ -6,7 +6,7 @@ import type { IRSchemaObject } from '../../../ir/ir';
 import { operationResponsesMap } from '../../../ir/operation';
 import { irRef } from '../../../utils/ref';
 import { stringCase } from '../../../utils/stringCase';
-import type { PluginHandler } from '../../types';
+import type { Plugin } from '../../types';
 import { operationIrRef } from '../sdk/plugin';
 import type { Config } from './types';
 
@@ -365,7 +365,7 @@ const processSchemaType = ({
 };
 
 // handles only response transformers for now
-export const handler: PluginHandler<Config> = ({ context, plugin }) => {
+export const handler: Plugin.Handler<Config> = ({ context, plugin }) => {
   const file = context.createFile({
     id: transformersId,
     path: plugin.output,

diff --git a/packages/openapi-ts/src/plugins/@hey-api/transformers/types.d.ts b/packages/openapi-ts/src/plugins/@hey-api/transformers/types.d.ts
@@ -1,6 +1,6 @@
-import type { PluginName } from '../../types';
+import type { Plugin } from '../../types';
 
-export interface Config extends PluginName<'@hey-api/transformers'> {
+export interface Config extends Plugin.Name<'@hey-api/transformers'> {
   /**
    * Convert date strings into Date objects?
    * @default false

diff --git a/packages/openapi-ts/src/plugins/@hey-api/typescript/config.ts b/packages/openapi-ts/src/plugins/@hey-api/typescript/config.ts
@@ -1,9 +1,9 @@
-import type { DefineConfig, PluginConfig } from '../../types';
+import type { Plugin } from '../../types';
 import { handler } from './plugin';
 import { handlerLegacy } from './plugin-legacy';
 import type { Config } from './types';
 
-export const defaultConfig: PluginConfig<Config> = {
+export const defaultConfig: Plugin.Config<Config> = {
   _handler: handler,
   _handlerLegacy: handlerLegacy,
   enums: false,
@@ -17,9 +17,9 @@ export const defaultConfig: PluginConfig<Config> = {
 };
 
 /**
- * Type helper for `@hey-api/typescript` plugin, returns {@link PluginConfig} object
+ * Type helper for `@hey-api/typescript` plugin, returns {@link Plugin.Config} object
  */
-export const defineConfig: DefineConfig<Config> = (config) => ({
+export const defineConfig: Plugin.DefineConfig<Config> = (config) => ({
   ...defaultConfig,
   ...config,
 });
diff --git a/packages/openapi-ts/src/plugins/@hey-api/typescript/plugin-legacy.ts b/packages/openapi-ts/src/plugins/@hey-api/typescript/plugin-legacy.ts
@@ -18,7 +18,7 @@ import {
   type SetUniqueTypeNameResult,
   toType,
 } from '../../../utils/type';
-import type { PluginLegacyHandler } from '../../types';
+import type { Plugin } from '../../types';
 import {
   operationDataTypeName,
   operationErrorTypeName,
@@ -606,7 +606,7 @@ const processServiceTypes = ({
   }
 };
 
-export const handlerLegacy: PluginLegacyHandler<Config> = ({
+export const handlerLegacy: Plugin.LegacyHandler<Config> = ({
   client,
   files,
 }) => {