Merge pull request #1125 from hey-api/chore/clean-up

chore: rename isStandaloneClient function to isLegacyClient
hey-api · Oct 5, 2024 · e908593 · e908593
2 parents 4afe9bd + 7615fd9
commit e908593
Show file tree

Hide file tree

Showing 25 changed files with 176 additions and 122 deletions.
diff --git a/packages/openapi-ts/src/generate/client.ts b/packages/openapi-ts/src/generate/client.ts
@@ -1,7 +1,7 @@
 import { copyFileSync } from 'node:fs';
 import path from 'node:path';
 
-import { getConfig, isStandaloneClient } from '../utils/config';
+import { getConfig, isLegacyClient } from '../utils/config';
 import { ensureDirSync, relativeModulePath } from './utils';
 
 export const clientModulePath = ({
@@ -35,7 +35,7 @@ export const generateClient = async (
 ) => {
   const config = getConfig();
 
-  if (!isStandaloneClient(config) || !config.client.bundle) {
+  if (isLegacyClient(config) || !config.client.bundle) {
     return;
   }
 

diff --git a/packages/openapi-ts/src/generate/plugins.ts b/packages/openapi-ts/src/generate/plugins.ts
@@ -3,7 +3,7 @@ import path from 'node:path';
 import { TypeScriptFile } from '../compiler';
 import type { Client } from '../types/client';
 import type { Files } from '../types/utils';
-import { getConfig, isStandaloneClient } from '../utils/config';
+import { getConfig, isLegacyClient } from '../utils/config';
 
 export const generatePlugins = async ({
   client,
@@ -14,10 +14,8 @@ export const generatePlugins = async ({
 }) => {
   const config = getConfig();
 
-  const isStandalone = isStandaloneClient(config);
-
-  if (!isStandalone) {
-    // plugins work only with standalone clients
+  if (isLegacyClient(config)) {
+    // plugins do not work with legacy clients
     return;
   }
 
@@ -34,7 +32,7 @@ export const generatePlugins = async ({
     plugin.handler({
       client,
       files,
-      plugin,
+      plugin: plugin as never,
     });
   }
 };
diff --git a/packages/openapi-ts/src/generate/services.ts b/packages/openapi-ts/src/generate/services.ts
@@ -16,7 +16,7 @@ import type {
 } from '../types/client';
 import type { Files } from '../types/utils';
 import { camelCase } from '../utils/camelCase';
-import { getConfig, isStandaloneClient } from '../utils/config';
+import { getConfig, isLegacyClient } from '../utils/config';
 import { escapeComment, escapeName } from '../utils/escape';
 import { reservedWordsRegExp } from '../utils/regexp';
 import { transformServiceName } from '../utils/transform';
@@ -115,7 +115,7 @@ const toOperationParamType = (
 
   const isRequired = isOperationParameterRequired(operation.parameters);
 
-  if (isStandaloneClient(config)) {
+  if (!isLegacyClient(config)) {
     return [
       {
         isRequired,
@@ -205,7 +205,7 @@ const toOperationReturnType = (client: Client, operation: Operation) => {
 const toOperationComment = (operation: Operation): Comments => {
   const config = getConfig();
 
-  if (isStandaloneClient(config)) {
+  if (!isLegacyClient(config)) {
     const comment = [
       operation.deprecated && '@deprecated',
       operation.summary && escapeComment(operation.summary),
@@ -273,7 +273,7 @@ const toRequestOptions = (
     onImport(responseTransformerName);
   }
 
-  if (isStandaloneClient(config)) {
+  if (!isLegacyClient(config)) {
     let obj: ObjectValue[] = [
       {
         spread: 'options',
@@ -490,7 +490,7 @@ const toOperationStatements = (
 
   const options = toRequestOptions(client, operation, onImport, onClientImport);
 
-  if (isStandaloneClient(config)) {
+  if (!isLegacyClient(config)) {
     const errorType = setUniqueTypeName({
       client,
       meta: {
@@ -573,7 +573,7 @@ const processService = ({
 }) => {
   const config = getConfig();
 
-  const isStandalone = isStandaloneClient(config);
+  const isLegacy = isLegacyClient(config);
 
   for (const operation of service.operations) {
     if (operation.parameters.length) {
@@ -590,7 +590,7 @@ const processService = ({
       });
     }
 
-    if (isStandalone) {
+    if (!isLegacy) {
       generateImport({
         client,
         meta: {
@@ -632,7 +632,7 @@ const processService = ({
     for (const operation of service.operations) {
       const compileFunctionParams = {
         parameters: toOperationParamType(client, operation),
-        returnType: isStandalone
+        returnType: !isLegacy
           ? undefined
           : toOperationReturnType(client, operation),
         statements: toOperationStatements(
@@ -641,7 +641,7 @@ const processService = ({
           onImport,
           onClientImport,
         ),
-        types: isStandalone ? [throwOnErrorTypeGeneric] : undefined,
+        types: !isLegacy ? [throwOnErrorTypeGeneric] : undefined,
       };
       const expression =
         config.client.name === 'legacy/angular'
@@ -666,7 +666,7 @@ const processService = ({
         config.name === undefined && config.client.name !== 'legacy/angular',
       name: toOperationName(operation, false),
       parameters: toOperationParamType(client, operation),
-      returnType: isStandalone
+      returnType: !isLegacy
         ? undefined
         : toOperationReturnType(client, operation),
       statements: toOperationStatements(
@@ -675,7 +675,7 @@ const processService = ({
         onImport,
         onClientImport,
       ),
-      types: isStandalone ? [throwOnErrorTypeGeneric] : undefined,
+      types: !isLegacy ? [throwOnErrorTypeGeneric] : undefined,
     });
     return node;
   });
@@ -759,7 +759,7 @@ export const generateServices = async ({
 
   checkPrerequisites({ files });
 
-  const isStandalone = isStandaloneClient(config);
+  const isLegacy = isLegacyClient(config);
 
   const servicesOutput = 'services';
 
@@ -769,7 +769,7 @@ export const generateServices = async ({
   });
 
   // Import required packages and core files.
-  if (isStandalone) {
+  if (!isLegacy) {
     files.services.import({
       module: clientModulePath({ sourceOutput: servicesOutput }),
       name: 'createClient',
@@ -838,7 +838,7 @@ export const generateServices = async ({
   }
 
   // define client first
-  if (isStandalone) {
+  if (!isLegacy) {
     const statement = compiler.constVariable({
       exportConst: true,
       expression: compiler.callExpression({

diff --git a/packages/openapi-ts/src/generate/types.ts b/packages/openapi-ts/src/generate/types.ts
@@ -10,7 +10,7 @@ import { isOperationParameterRequired } from '../openApi';
 import type { Method, Model, OperationParameter } from '../types/client';
 import type { Client } from '../types/client';
 import type { Files } from '../types/utils';
-import { getConfig, isStandaloneClient } from '../utils/config';
+import { getConfig, isLegacyClient } from '../utils/config';
 import { enumEntry, enumUnionType } from '../utils/enum';
 import { escapeComment } from '../utils/escape';
 import { sortByName, sorterByName } from '../utils/sort';
@@ -301,7 +301,7 @@ const processServiceTypes = ({
     return;
   }
 
-  const isStandalone = isStandaloneClient(config);
+  const isLegacy = isLegacyClient(config);
 
   for (const service of client.services) {
     for (const operation of service.operations) {
@@ -382,8 +382,8 @@ const processServiceTypes = ({
             ),
           ),
           mediaType: null,
-          name: isStandalone ? 'headers' : 'header',
-          prop: isStandalone ? 'headers' : 'header',
+          name: isLegacy ? 'header' : 'headers',
+          prop: isLegacy ? 'header' : 'headers',
           properties: operation.parameters
             .filter((parameter) => parameter.in === 'header')
             .sort(sorterByName),
@@ -416,7 +416,7 @@ const processServiceTypes = ({
             .filter((parameter) => parameter.in === 'query')
             .sort(sorterByName),
         };
-        const operationProperties = isStandalone
+        const operationProperties = !isLegacy
           ? [
               bodyParameters,
               headerParameters,
@@ -479,7 +479,7 @@ const processServiceTypes = ({
           response.responseTypes.includes('error'),
         );
 
-        if (isStandalone) {
+        if (!isLegacy) {
           // create type export for operation error
           generateType({
             client,

diff --git a/packages/openapi-ts/src/index.ts b/packages/openapi-ts/src/index.ts
@@ -9,7 +9,7 @@ import { defaultPluginConfigs } from './plugins';
 import type { Client } from './types/client';
 import type { ClientConfig, Config, UserConfig } from './types/config';
 import { CLIENTS } from './types/config';
-import { getConfig, isStandaloneClient, setConfig } from './utils/config';
+import { getConfig, isLegacyClient, setConfig } from './utils/config';
 import { getOpenApiSpec } from './utils/getOpenApiSpec';
 import { registerHandlebarTemplates } from './utils/handlebars';
 import {
@@ -146,7 +146,7 @@ const getPlugins = (userConfig: ClientConfig): Config['plugins'] => {
           ...defaultPluginConfigs[plugin.name],
           ...(plugin as (typeof defaultPluginConfigs)[(typeof plugin)['name']]),
         },
-  );
+  ) as unknown as Config['plugins'];
   return plugins;
 };
 
@@ -293,8 +293,7 @@ const initConfigs = async (userConfig: UserConfig): Promise<Config[]> => {
       debug,
       dryRun,
       experimental_parser,
-      exportCore:
-        isStandaloneClient(client) || !client.name ? false : exportCore,
+      exportCore: isLegacyClient(client) ? exportCore : false,
       input,
       name,
       output,

diff --git a/packages/openapi-ts/src/openApi/common/parser/__tests__/type.spec.ts b/packages/openapi-ts/src/openApi/common/parser/__tests__/type.spec.ts
@@ -9,7 +9,7 @@ vi.mock('../../../../utils/config', () => {
   };
   return {
     getConfig: () => config,
-    isStandaloneClient: vi.fn().mockReturnValue(false),
+    isLegacyClient: vi.fn().mockReturnValue(true),
   };
 });
 

diff --git a/packages/openapi-ts/src/plugins/@hey-api/schemas/types.ts b/packages/openapi-ts/src/plugins/@hey-api/schemas/types.ts
@@ -1,6 +1,6 @@
-import type { PluginDefinition } from '../../types';
+import type { PluginHandler } from '../../types';
 
-export interface PluginConfig extends PluginDefinition {
+interface Config {
   /**
    * Generate Hey API schemas from the provided input.
    */
@@ -12,4 +12,8 @@ export interface PluginConfig extends PluginDefinition {
   output?: string;
 }
 
-export interface UserConfig extends Pick<PluginConfig, 'name'> {}
+export interface PluginConfig extends Config {
+  handler: PluginHandler<Config>;
+}
+
+export interface UserConfig extends Omit<Config, 'output'> {}
diff --git a/packages/openapi-ts/src/plugins/@hey-api/services/types.ts b/packages/openapi-ts/src/plugins/@hey-api/services/types.ts
@@ -1,6 +1,6 @@
-import type { PluginDefinition } from '../../types';
+import type { PluginHandler } from '../../types';
 
-export interface PluginConfig extends PluginDefinition {
+interface Config {
   /**
    * Generate Hey API services from the provided input.
    */
@@ -12,4 +12,8 @@ export interface PluginConfig extends PluginDefinition {
   output?: string;
 }
 
-export interface UserConfig extends Pick<PluginConfig, 'name'> {}
+export interface PluginConfig extends Config {
+  handler: PluginHandler<Config>;
+}
+
+export interface UserConfig extends Omit<Config, 'output'> {}
diff --git a/packages/openapi-ts/src/plugins/@hey-api/types/types.ts b/packages/openapi-ts/src/plugins/@hey-api/types/types.ts
@@ -1,6 +1,6 @@
-import type { PluginDefinition } from '../../types';
+import type { PluginHandler } from '../../types';
 
-export interface PluginConfig extends PluginDefinition {
+interface Config {
   /**
    * Generate Hey API types from the provided input.
    */
@@ -12,4 +12,8 @@ export interface PluginConfig extends PluginDefinition {
   output?: string;
 }
 
-export interface UserConfig extends Pick<PluginConfig, 'name'> {}
+export interface PluginConfig extends Config {
+  handler: PluginHandler<Config>;
+}
+
+export interface UserConfig extends Omit<Config, 'output'> {}
diff --git a/packages/openapi-ts/src/plugins/@tanstack/query-core/plugin.ts b/packages/openapi-ts/src/plugins/@tanstack/query-core/plugin.ts
@@ -28,7 +28,11 @@ import type {
 import type { Files } from '../../../types/utils';
 import { getConfig } from '../../../utils/config';
 import { transformServiceName } from '../../../utils/transform';
-import type { PluginDefinition } from '../../types';
+import type { PluginHandler } from '../../types';
+import type { PluginConfig as ReactQueryPluginConfig } from '../react-query';
+import type { PluginConfig as SolidQueryPluginConfig } from '../solid-query';
+import type { PluginConfig as SvelteQueryPluginConfig } from '../svelte-query';
+import type { PluginConfig as VueQueryPluginConfig } from '../vue-query';
 
 const toInfiniteQueryOptionsName = (operation: Operation) =>
   `${toOperationName(operation, false)}InfiniteOptions`;
@@ -641,20 +645,12 @@ const createQueryKeyLiteral = ({
   return queryKeyLiteral;
 };
 
-export const handler: PluginDefinition['handler'] = ({
-  client,
-  files,
-  plugin,
-}) => {
-  if (
-    plugin.name !== '@tanstack/react-query' &&
-    plugin.name !== '@tanstack/solid-query' &&
-    plugin.name !== '@tanstack/svelte-query' &&
-    plugin.name !== '@tanstack/vue-query'
-  ) {
-    return;
-  }
-
+export const handler: PluginHandler<
+  | ReactQueryPluginConfig
+  | SolidQueryPluginConfig
+  | SvelteQueryPluginConfig
+  | VueQueryPluginConfig
+> = ({ client, files, plugin }) => {
   checkPrerequisites({ files });
 
   const config = getConfig();

diff --git a/packages/openapi-ts/src/plugins/@tanstack/react-query/types.ts b/packages/openapi-ts/src/plugins/@tanstack/react-query/types.ts
@@ -1,6 +1,6 @@
-import type { PluginDefinition } from '../../types';
+import type { PluginHandler } from '../../types';
 
-export interface PluginConfig extends PluginDefinition {
+interface Config {
   /**
    * Generate {@link https://tanstack.com/query/v5/docs/framework/react/reference/infiniteQueryOptions `infiniteQueryOptions()`} helpers? These will be generated from GET and POST requests where a pagination parameter is detected.
    * @default true
@@ -28,8 +28,8 @@ export interface PluginConfig extends PluginDefinition {
   queryOptions?: boolean;
 }
 
-export interface UserConfig
-  extends Pick<
-    PluginConfig,
-    'infiniteQueryOptions' | 'mutationOptions' | 'name' | 'queryOptions'
-  > {}
+export interface PluginConfig extends Config {
+  handler: PluginHandler<Config>;
+}
+
+export interface UserConfig extends Omit<Config, 'output'> {}