fix(colada): isolate client-nuxt specific options shape (composable)

Author: brolnickij

packages/openapi-ts/src/plugins/@pinia/colada/mutationOptions.ts

@@ -7,7 +7,12 @@ import { createOperationComment } from '../../shared/utils/operation';
 import { handleMeta } from './meta';
 import type { PluginState } from './state';
 import type { PiniaColadaPlugin } from './types';
-import { useTypeData, useTypeError, useTypeResponse } from './utils';
+import {
+  getPublicTypeData,
+  useTypeData,
+  useTypeError,
+  useTypeResponse,
+} from './utils';
 
 const mutationOptionsType = 'UseMutationOptions';
 
@@ -46,6 +51,10 @@ export const createMutationOptions = ({
   const typeData = useTypeData({ file, operation, plugin });
   const typeError = useTypeError({ file, operation, plugin });
   const typeResponse = useTypeResponse({ file, operation, plugin });
+  const { isNuxtClient, strippedTypeData } = getPublicTypeData({
+    plugin,
+    typeData,
+  });
 
   const identifierMutationOptions = file.identifier({
     $ref: `#/pinia-colada-mutation-options/${operation.id}`,
@@ -108,9 +117,12 @@ export const createMutationOptions = ({
         async: true,
         multiLine: true,
         parameters: [
-          {
-            name: fnOptions,
-          },
+          isNuxtClient
+            ? {
+                name: fnOptions,
+                type: `Partial<${strippedTypeData}>`,
+              }
+            : { name: fnOptions },
         ],
         statements,
       }),
@@ -136,11 +148,12 @@ export const createMutationOptions = ({
         {
           isRequired: false,
           name: 'options',
-          type: `Partial<${typeData}>`,
+          type: `Partial<${strippedTypeData}>`,
         },
       ],
-      // TODO: better types syntax
-      returnType: `${mutationOptionsType}<${typeResponse}, ${typeData}, ${typeError.name}>`,
+      returnType: isNuxtClient
+        ? `${mutationOptionsType}<${typeResponse}, ${strippedTypeData}, ${typeError.name}>`
+        : `${mutationOptionsType}<${typeResponse}, ${typeData}, ${typeError.name}>`,
       statements: [
         tsc.returnStatement({
           expression: tsc.objectExpression({

packages/openapi-ts/src/plugins/@pinia/colada/queryKey.ts

@@ -7,7 +7,7 @@ import type { IR } from '../../../ir/types';
 import { type Property, tsc } from '../../../tsc';
 import { getClientBaseUrlKey } from '../../@hey-api/client-core/utils';
 import type { PiniaColadaPlugin } from './types';
-import { useTypeData } from './utils';
+import { getPublicTypeData, useTypeData } from './utils';
 
 const createQueryKeyFn = 'createQueryKey';
 const queryKeyName = 'QueryKey';
@@ -352,6 +352,7 @@ export const queryKeyStatement = ({
   plugin: PiniaColadaPlugin['Instance'];
 }) => {
   const typeData = useTypeData({ file, operation, plugin });
+  const { strippedTypeData } = getPublicTypeData({ plugin, typeData });
   const identifier = file.identifier({
     // TODO: refactor for better cross-plugin compatibility
     $ref: `#/pinia-colada-query-key/${operation.id}`,
@@ -367,7 +368,7 @@ export const queryKeyStatement = ({
         {
           isRequired: hasOperationDataRequired(operation),
           name: 'options',
-          type: typeData,
+          type: strippedTypeData,
         },
       ],
       statements: createQueryKeyLiteral({

packages/openapi-ts/src/plugins/@pinia/colada/queryOptions.ts

@@ -16,7 +16,12 @@ import {
 } from './queryKey';
 import type { PluginState } from './state';
 import type { PiniaColadaPlugin } from './types';
-import { useTypeData, useTypeError, useTypeResponse } from './utils';
+import {
+  getPublicTypeData,
+  useTypeData,
+  useTypeError,
+  useTypeResponse,
+} from './utils';
 
 const queryOptionsType = 'UseQueryOptions';
 const optionsParamName = 'options';
@@ -75,6 +80,10 @@ export const createQueryOptions = ({
   const typeData = useTypeData({ file, operation, plugin });
   const typeError = useTypeError({ file, operation, plugin });
   const typeResponse = useTypeResponse({ file, operation, plugin });
+  const { isNuxtClient, strippedTypeData } = getPublicTypeData({
+    plugin,
+    typeData,
+  });
 
   const identifierQueryOptions = file.identifier({
     $ref: `#/pinia-colada-query-options/${operation.id}`,
@@ -152,9 +161,12 @@ export const createQueryOptions = ({
         async: true,
         multiLine: true,
         parameters: [
-          {
-            name: fnOptions,
-          },
+          isNuxtClient
+            ? {
+                name: fnOptions,
+                type: `Partial<${strippedTypeData}>`,
+              }
+            : { name: fnOptions },
         ],
         statements,
       }),
@@ -180,11 +192,12 @@ export const createQueryOptions = ({
         {
           isRequired: isRequiredOptions,
           name: optionsParamName,
-          type: typeData,
+          type: strippedTypeData,
         },
       ],
-      // TODO: better types syntax
-      returnType: `${queryOptionsType}<${typeResponse}, ${typeError.name}>`,
+      returnType: isNuxtClient
+        ? `${queryOptionsType}<${typeResponse}, ${strippedTypeData}, ${typeError.name}>`
+        : `${queryOptionsType}<${typeResponse}, ${typeError.name}>`,
       statements: [
         tsc.returnStatement({
           expression: tsc.objectExpression({

packages/openapi-ts/src/plugins/@pinia/colada/utils.ts

@@ -49,6 +49,22 @@ export const getFileForOperation = ({
   };
 };
 
+export const getPublicTypeData = ({
+  plugin,
+  typeData,
+}: {
+  plugin: PiniaColadaPlugin['Instance'];
+  typeData: string;
+}) => {
+  const client = getClientPlugin(plugin.context.config);
+  const isNuxtClient = client.name === '@hey-api/client-nuxt';
+  const strippedTypeData = isNuxtClient
+    ? `Omit<${typeData}, 'composable'>`
+    : typeData;
+
+  return { isNuxtClient, strippedTypeData };
+};
+
 export const useTypeData = ({
   file,
   operation,
@@ -59,8 +75,7 @@ export const useTypeData = ({
   plugin: PiniaColadaPlugin['Instance'];
 }) => {
   const pluginSdk = plugin.getPlugin('@hey-api/sdk')!;
-  const typeData = operationOptionsType({ file, operation, plugin: pluginSdk });
-  return typeData;
+  return operationOptionsType({ file, operation, plugin: pluginSdk });
 };
 
 export const useTypeError = ({