chore: cleanup

Author: mrlubos

.changeset/modern-colts-hang.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+feat(plugin): add `@pinia/colada` plugin

packages/openapi-ts-tests/main/test/openapi-ts.config.ts

@@ -36,9 +36,9 @@ export default defineConfig(() => {
         '3.1.x',
         // 'invalid',
         // 'openai.yaml',
-        // 'full.yaml',
+        'full.yaml',
         // 'opencode.yaml',
-        'zoom-video-sdk.json',
+        // 'zoom-video-sdk.json',
       ),
       // https://registry.scalar.com/@lubos-heyapi-dev-team/apis/demo-api-scalar-galaxy/latest?format=json
       // path: 'scalar:@lubos-heyapi-dev-team/demo-api-scalar-galaxy',
@@ -81,7 +81,7 @@ export default defineConfig(() => {
         // deprecated: false,
         operations: {
           include: [
-            'GET /event',
+            // 'GET /event',
             // '/^[A-Z]+ /v1//',
           ],
         },
@@ -94,6 +94,11 @@ export default defineConfig(() => {
         //   exclude: ['bar'],
         // },
       },
+      hooks: {
+        operations: {
+          // isMutation: () => true,
+        },
+      },
       pagination: {
         // keywords: ['aa'],
       },
@@ -171,7 +176,7 @@ export default defineConfig(() => {
         // responseStyle: 'data',
         // transformer: '@hey-api/transformers',
         // transformer: true,
-        validator: 'valibot',
+        // validator: 'valibot',
         // validator: {
         //   request: 'zod',
         //   response: 'zod',
@@ -198,7 +203,7 @@ export default defineConfig(() => {
         // mutationOptions: {
         //   name: '{{name}}MO',
         // },
-        name: '@tanstack/react-query',
+        // name: '@tanstack/react-query',
         // queryKeys: {
         //   name: '{{name}}QK',
         // },
@@ -212,7 +217,7 @@ export default defineConfig(() => {
         definitions: 'z{{name}}Definition',
         exportFromIndex: true,
         metadata: true,
-        name: 'valibot',
+        // name: 'valibot',
         requests: {
           // case: 'SCREAMING_SNAKE_CASE',
           name: 'z{{name}}TestData',
@@ -241,7 +246,7 @@ export default defineConfig(() => {
         },
         exportFromIndex: true,
         metadata: true,
-        name: 'zod',
+        // name: 'zod',
         // requests: {
         //   // case: 'SCREAMING_SNAKE_CASE',
         //   // name: 'z{{name}}TestData',
@@ -273,6 +278,14 @@ export default defineConfig(() => {
         exportFromIndex: true,
         // name: '@angular/common',
       },
+      {
+        name: '@pinia/colada',
+        '~hooks': {
+          operations: {
+            // isQuery: () => true,
+          },
+        },
+      },
     ],
     // useOptions: false,
     // watch: 3_000,

packages/openapi-ts-tests/main/test/plugins/@pinia/colada-functional.test.ts

@@ -5,7 +5,7 @@ import { fileURLToPath } from 'node:url';
 import { createClient } from '@hey-api/openapi-ts';
 import { describe, expect, it, vi } from 'vitest';
 
-import { getSpecsPath } from '../../../utils';
+import { getSpecsPath } from '../../../../utils';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -71,25 +71,6 @@ describe('@pinia/colada functional tests', () => {
     expect(typeof mutationOptions.mutation).toBe('function');
   });
 
-  it('should respect autoDetectHttpMethod setting', async () => {
-    const piniaColadaDefault = await setupPiniaColadaTest({
-      autoDetectHttpMethod: true,
-    });
-
-    // With auto-detection, GET should be query, POST should be mutation
-    expect(piniaColadaDefault.getPetByIdQuery).toBeDefined(); // GET -> query
-    expect(piniaColadaDefault.addPetMutation).toBeDefined(); // POST -> mutation
-    expect(piniaColadaDefault.addPetQuery).toBeUndefined(); // POST should not generate query
-
-    const piniaColadaDisabled = await setupPiniaColadaTest({
-      autoDetectHttpMethod: false,
-    });
-
-    // With auto-detection disabled, both GET and POST should generate queries (legacy behavior)
-    expect(piniaColadaDisabled.getPetByIdQuery).toBeDefined();
-    // Note: The legacy behavior test might need adjustment based on actual implementation
-  });
-
   it('should respect operation type overrides', async () => {
     const piniaColada = await setupPiniaColadaTest({
       operationTypes: {

packages/openapi-ts-tests/main/test/plugins/@pinia/colada-integration.test.ts

@@ -5,7 +5,7 @@ import { fileURLToPath } from 'node:url';
 import { createClient, type UserConfig } from '@hey-api/openapi-ts';
 import { describe, expect, it } from 'vitest';
 
-import { getFilePaths, getSpecsPath } from '../../../utils';
+import { getFilePaths, getSpecsPath } from '../../../../utils';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -14,16 +14,22 @@ const version = '3.1.x';
 const outputDir = path.join(__dirname, 'generated', version, 'integration');
 
 describe('@pinia/colada integration tests', () => {
-  const createConfig = (userConfig: UserConfig): UserConfig => {
+  const createConfig = (
+    userConfig: Omit<UserConfig, 'input'> & Pick<Partial<UserConfig>, 'input'>,
+  ): UserConfig => {
     const inputPath = path.join(getSpecsPath(), version, 'petstore.yaml');
     return {
-      input: inputPath,
-      logs: { level: 'silent' },
-      output: path.join(
-        outputDir,
-        typeof userConfig.output === 'string' ? userConfig.output : '',
-      ),
+      logs: {
+        level: 'silent',
+      },
       ...userConfig,
+      input: userConfig.input ?? inputPath,
+      output:
+        userConfig.output ??
+        path.join(
+          outputDir,
+          typeof userConfig.output === 'string' ? userConfig.output : '',
+        ),
     };
   };
 
@@ -70,6 +76,7 @@ describe('@pinia/colada integration tests', () => {
           '@hey-api/client-fetch',
           {
             name: '@hey-api/sdk',
+            // @ts-expect-error
             transformer: {
               name: 'custom',
             },
@@ -113,6 +120,7 @@ describe('@pinia/colada integration tests', () => {
         plugins: [
           '@hey-api/client-fetch',
           {
+            // @ts-expect-error
             case: 'PascalCase',
             name: '@hey-api/sdk',
           },

packages/openapi-ts-tests/main/test/plugins/@pinia/colada-meta-functions.test.ts

@@ -5,7 +5,7 @@ import { fileURLToPath } from 'node:url';
 import { createClient, type UserConfig } from '@hey-api/openapi-ts';
 import { describe, expect, it } from 'vitest';
 
-import { getFilePaths, getSpecsPath } from '../../../utils';
+import { getFilePaths, getSpecsPath } from '../../../../utils';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);

packages/openapi-ts/src/config/parser.ts

@@ -13,6 +13,7 @@ export const defaultPaginationKeywords = [
 export const getParser = (userConfig: UserConfig): Config['parser'] => {
   const parser: Config['parser'] = {
     ...userConfig.parser,
+    hooks: {},
     pagination: {
       keywords: defaultPaginationKeywords,
     },

packages/openapi-ts/src/ir/context.ts

@@ -6,35 +6,12 @@ import { GeneratedFile } from '../generate/file';
 import type { PluginConfigMap } from '../plugins/config';
 import { PluginInstance } from '../plugins/shared/utils/instance';
 import type { PluginNames } from '../plugins/types';
-import type { StringCase } from '../types/case';
 import type { Config } from '../types/config';
 import type { Files } from '../types/utils';
 import type { Logger } from '../utils/logger';
 import { resolveRef } from '../utils/ref';
 import type { IR } from './types';
 
-export interface ContextFile {
-  /**
-   * Define casing for identifiers in this file.
-   */
-  case?: StringCase;
-  /**
-   * Should the exports from this file be re-exported in the index barrel file?
-   */
-  exportFromIndex?: boolean;
-  /**
-   * Unique file identifier.
-   */
-  id: string;
-  /**
-   * Relative file path to the output path.
-   *
-   * @example
-   * 'bar/foo.ts'
-   */
-  path: string;
-}
-
 export class IRContext<Spec extends Record<string, any> = any> {
   /**
    * Configuration for parsing and generating the output. This
@@ -92,7 +69,7 @@ export class IRContext<Spec extends Record<string, any> = any> {
    * Create and return a new TypeScript file. Also set the current file context
    * to the newly created file.
    */
-  public createFile(file: ContextFile): GeneratedFile {
+  public createFile(file: IR.ContextFile): GeneratedFile {
     // TODO: parser - handle attempt to create duplicate
     const outputParts = file.path.split('/');
     const outputDir = path.resolve(
@@ -127,7 +104,7 @@ export class IRContext<Spec extends Record<string, any> = any> {
   /**
    * Returns a specific file by ID from `files`.
    */
-  public file({ id }: Pick<ContextFile, 'id'>): GeneratedFile | undefined {
+  public file({ id }: Pick<IR.ContextFile, 'id'>): GeneratedFile | undefined {
     return this.files[id];
   }
 

packages/openapi-ts/src/ir/types.d.ts

@@ -3,7 +3,8 @@ import type {
   SecuritySchemeObject,
   ServerObject,
 } from '../openApi/3.1.x/types/spec';
-import type { ContextFile as CtxFile, IRContext } from './context';
+import type { StringCase } from '../types/case';
+import type { IRContext } from './context';
 import type { IRMediaType } from './mediaType';
 
 interface IRBodyObject {
@@ -24,6 +25,86 @@ interface IRComponentsObject {
   schemas?: Record<string, IRSchemaObject>;
 }
 
+interface IRContextFile {
+  /**
+   * Define casing for identifiers in this file.
+   */
+  case?: StringCase;
+  /**
+   * Should the exports from this file be re-exported in the index barrel file?
+   */
+  exportFromIndex?: boolean;
+  /**
+   * Unique file identifier.
+   */
+  id: string;
+  /**
+   * Relative file path to the output path.
+   *
+   * @example
+   * 'bar/foo.ts'
+   */
+  path: string;
+}
+
+interface IRHooks {
+  /**
+   * Hooks specifically for overriding operations behavior.
+   *
+   * Use these to classify operations, decide which outputs to generate,
+   * or apply custom behavior to individual operations.
+   */
+  operations?: {
+    /**
+     * Classify the given operation into one or more kinds.
+     *
+     * Each kind determines how we treat the operation (e.g., generating queries or mutations).
+     *
+     * **Default behavior:**
+     * - GET → 'query'
+     * - DELETE, PATCH, POST, PUT → 'mutation'
+     *
+     * **Resolution order:**
+     * 1. If `isQuery` or `isMutation` returns `true` or `false`, that overrides `getKind`.
+     * 2. If `isQuery` or `isMutation` returns `undefined`, the result of `getKind` is used.
+     *
+     * @param operation - The operation object to classify.
+     * @returns An array containing one or more of 'query' or 'mutation'.
+     */
+    getKind?: (
+      operation: IROperationObject,
+    ) => ReadonlyArray<'mutation' | 'query'>;
+    /**
+     * Check if the given operation should be treated as a mutation.
+     *
+     * This affects which outputs are generated for the operation.
+     *
+     * **Default behavior:** DELETE, PATCH, POST, and PUT operations are treated as mutations.
+     *
+     * **Resolution order:** If this returns `true` or `false`, it overrides `getKind`.
+     * If it returns `undefined`, `getKind` is used instead.
+     *
+     * @param operation - The operation object to check.
+     * @returns true if the operation is a mutation, false otherwise, or undefined to fallback to `getKind`.
+     */
+    isMutation?: (operation: IROperationObject) => boolean | undefined;
+    /**
+     * Check if the given operation should be treated as a query.
+     *
+     * This affects which outputs are generated for the operation.
+     *
+     * **Default behavior:** GET operations are treated as queries.
+     *
+     * **Resolution order:** If this returns `true` or `false`, it overrides `getKind`.
+     * If it returns `undefined`, `getKind` is used instead.
+     *
+     * @param operation - The operation object to check.
+     * @returns true if the operation is a query, false otherwise, or undefined to fallback to `getKind`.
+     */
+    isQuery?: (operation: IROperationObject) => boolean | undefined;
+  };
+}
+
 interface IROperationObject {
   body?: IRBodyObject;
   deprecated?: boolean;
@@ -221,7 +302,8 @@ export namespace IR {
   export type BodyObject = IRBodyObject;
   export type ComponentsObject = IRComponentsObject;
   export type Context<Spec extends Record<string, any> = any> = IRContext<Spec>;
-  export type ContextFile = CtxFile;
+  export type ContextFile = IRContextFile;
+  export type Hooks = IRHooks;
   export type Model = IRModel;
   export type OperationObject = IROperationObject;
   export type ParameterObject = IRParameterObject;