@acrool/rtk-query-codegen-openapi 0.0.2-test.5 → 0.0.2-test.6

package/src/generate.ts

@@ -117,6 +117,7 @@ export async function generateApi(
     useEnumType = false,
     mergeReadWriteOnly = false,
     httpResolverOptions,
+    sharedTypesFile,
   }: GenerationOptions
 ) {
   const v3Doc = (v3DocCache[spec] ??= await getV3Doc(spec, httpResolverOptions));
@@ -127,6 +128,48 @@ export async function generateApi(
     mergeReadWriteOnly,
   });
 
+  // 如果提供了 sharedTypesFile，則將 components 輸出到該文件
+  if (sharedTypesFile) {
+    const components = v3Doc.components;
+    if (components) {
+      const resultFile = ts.createSourceFile(
+        'sharedTypes.ts',
+        '',
+        ts.ScriptTarget.Latest,
+        /*setParentNodes*/ false,
+        ts.ScriptKind.TS
+      );
+      const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
+
+      // 將 components 轉換為 TypeScript 類型定義
+      const typeDefinitions = Object.entries(components).flatMap(([_, componentDefs]) => {
+        return Object.entries(componentDefs as Record<string, unknown>).map(([name, def]) => {
+          const typeNode = apiGen.getTypeFromSchema(def as OpenAPIV3.SchemaObject);
+          return factory.createTypeAliasDeclaration(
+            [factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+            factory.createIdentifier(name),
+            undefined,
+            typeNode
+          );
+        });
+      });
+
+      const output = printer.printNode(
+        ts.EmitHint.Unspecified,
+        factory.createSourceFile(
+          typeDefinitions,
+          factory.createToken(ts.SyntaxKind.EndOfFileToken),
+          ts.NodeFlags.None
+        ),
+        resultFile
+      );
+
+      // 寫入文件
+      const fs = await import('node:fs/promises');
+      await fs.writeFile(sharedTypesFile, output, 'utf-8');
+    }
+  }
+
   // temporary workaround for https://github.com/oazapfts/oazapfts/issues/491
   if (apiGen.spec.components?.schemas) {
     apiGen.preprocessComponents(apiGen.spec.components.schemas);
@@ -160,8 +203,17 @@ export async function generateApi(
       apiFile = apiFile.replace(/\\/g, '/');
       if (!apiFile.startsWith('.')) apiFile = `./${apiFile}`;
     }
+    // 處理 sharedTypesFile 的路徑
+    if (sharedTypesFile && sharedTypesFile.startsWith('.')) {
+      sharedTypesFile = path.relative(path.dirname(outputFile), sharedTypesFile);
+      sharedTypesFile = sharedTypesFile.replace(/\\/g, '/');
+      if (!sharedTypesFile.startsWith('.')) sharedTypesFile = `./${sharedTypesFile}`;
+    }
   }
   apiFile = apiFile.replace(/\.[jt]sx?$/, '');
+  if (sharedTypesFile) {
+    sharedTypesFile = sharedTypesFile.replace(/\.[jt]sx?$/, '');
+  }
 
   return printer.printNode(
     ts.EmitHint.Unspecified,
@@ -169,6 +221,18 @@ export async function generateApi(
       [
         generateImportNode(apiFile, { [apiImport]: 'api' }),
         generateImportNode('@acrool/react-fetcher', { IRestFulEndpointsQueryReturn: 'IRestFulEndpointsQueryReturn' }),
+        ...(sharedTypesFile ? [
+          factory.createImportDeclaration(
+            undefined,
+            factory.createImportClause(
+              false,
+              undefined,
+              factory.createNamespaceImport(factory.createIdentifier('SharedTypes'))
+            ),
+            factory.createStringLiteral(sharedTypesFile),
+            undefined
+          )
+        ] : []),
         ...(tag ? [generateTagTypes({ addTagTypes: extractAllTagTypes({ operationDefinitions }) })] : []),
         generateCreateApiCall({
           tag,
@@ -188,8 +252,7 @@ export async function generateApi(
           factory.createIdentifier(generatedApiName)
         ),
         ...Object.values(interfaces),
-        ...apiGen.aliases,
-        ...apiGen.enumAliases,
+        ...(sharedTypesFile ? [] : [...apiGen.aliases, ...apiGen.enumAliases]),
         ...(hooks
           ? [
               generateReactHooks({
@@ -239,16 +302,54 @@ export async function generateApi(
 
     const returnsJson = apiGen.getResponseType(responses) === 'json';
     let ResponseType: ts.TypeNode = factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword);
+
+    function replaceReferences(schema: any): ts.TypeNode {
+      if (!schema) return factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword);
+      
+      const refName = getReferenceName(schema);
+      if (refName && sharedTypesFile) {
+        return factory.createTypeReferenceNode(
+          factory.createQualifiedName(
+            factory.createIdentifier('SharedTypes'),
+            factory.createIdentifier(refName)
+          ),
+          undefined
+        );
+      }
+
+      if (schema.type === 'object' && schema.properties) {
+        const members = Object.entries(schema.properties).map(([key, value]: [string, any]) => {
+          return factory.createPropertySignature(
+            undefined,
+            factory.createIdentifier(key),
+            schema.required?.includes(key) ? undefined : factory.createToken(ts.SyntaxKind.QuestionToken),
+            replaceReferences(value)
+          );
+        });
+        return factory.createTypeLiteralNode(members);
+      }
+
+      if (schema.type === 'array' && schema.items) {
+        return factory.createArrayTypeNode(replaceReferences(schema.items));
+      }
+
+      return apiGen.getTypeFromSchema(schema);
+    }
+
     if (returnsJson) {
       const returnTypes = Object.entries(responses || {})
         .map(
-          ([code, response]) =>
-            [
-              code,
-              apiGen.resolve(response),
-              apiGen.getTypeFromResponse(response, 'readOnly') ||
-                factory.createKeywordTypeNode(ts.SyntaxKind.UndefinedKeyword),
-            ] as const
+          ([code, response]) => {
+            const resolvedResponse = apiGen.resolve(response);
+            if (!resolvedResponse.content?.['application/json']?.schema) {
+              return [code, resolvedResponse, factory.createKeywordTypeNode(ts.SyntaxKind.UndefinedKeyword)] as const;
+            }
+            
+            const schema = resolvedResponse.content['application/json'].schema;
+            const type = replaceReferences(schema);
+            
+            return [code, resolvedResponse, type] as const;
+          }
         )
         .filter(([status, response]) =>
           isDataResponse(status, includeDefault, apiGen.resolve(response), responses || {})
@@ -308,22 +409,11 @@ export async function generateApi(
       return name;
     }
 
-    for (const param of parameters) {
-      const name = generateName(param.name, param.in);
-      queryArg[name] = {
-        origin: 'param',
-        name,
-        originalName: param.name,
-        type: apiGen.getTypeFromSchema(isReference(param) ? param : param.schema, undefined, 'writeOnly'),
-        required: param.required,
-        param,
-      };
-    }
-
     if (requestBody) {
       const body = apiGen.resolve(requestBody);
       const schema = apiGen.getSchemaFromContent(body.content);
-      const type = apiGen.getTypeFromSchema(schema);
+      const type = replaceReferences(schema);
+
       const schemaName = camelCase(
         (type as any).name ||
           getReferenceName(schema) ||
@@ -336,12 +426,27 @@ export async function generateApi(
         origin: 'body',
         name,
         originalName: schemaName,
-        type: apiGen.getTypeFromSchema(schema, undefined, 'writeOnly'),
+        type,
         required: true,
         body,
       };
     }
 
+    for (const param of parameters) {
+      const name = generateName(param.name, param.in);
+      const paramSchema = isReference(param) ? param : param.schema;
+      const type = replaceReferences(paramSchema);
+
+      queryArg[name] = {
+        origin: 'param',
+        name,
+        originalName: param.name,
+        type,
+        required: param.required,
+        param,
+      };
+    }
+
     const propertyName = (name: string | ts.PropertyName): ts.PropertyName => {
       if (typeof name === 'string') {
         return isValidIdentifier(name) ? factory.createIdentifier(name) : factory.createStringLiteral(name);

package/src/types.ts

@@ -132,6 +132,7 @@ export interface OutputFileOptions extends Partial<CommonOptions> {
    * If passed as true it will generate TS enums instead of union of strings
    */
   useEnumType?: boolean;
+  sharedTypesFile?: string;
 }
 
 export type EndpointOverrides = {