@bitstack/ng-query-codegen-openapi 0.0.31-alpha.0 → 0.0.31-alpha.3

package/lib/index.d.mts

@@ -127,6 +127,11 @@ interface CommonOptions {
      * File path for importing IRestFulEndpointsQueryReturn type
      */
     endpointsQueryReturnTypeFile?: string;
+    /**
+     * defaults to 60 (seconds)
+     * Number of seconds to wait before refetching data when component mounts or args change
+     */
+    refetchOnMountOrArgChange?: number;
 }
 type TextMatcher = string | RegExp | (string | RegExp)[];
 type EndpointMatcherFunction = (operationName: string, operationDefinition: OperationDefinition) => boolean;

package/lib/index.d.ts

@@ -127,6 +127,11 @@ interface CommonOptions {
      * File path for importing IRestFulEndpointsQueryReturn type
      */
     endpointsQueryReturnTypeFile?: string;
+    /**
+     * defaults to 60 (seconds)
+     * Number of seconds to wait before refetching data when component mounts or args change
+     */
+    refetchOnMountOrArgChange?: number;
 }
 type TextMatcher = string | RegExp | (string | RegExp)[];
 type EndpointMatcherFunction = (operationName: string, operationDefinition: OperationDefinition) => boolean;

package/lib/index.js

@@ -390,6 +390,9 @@ var FileWriterService = class {
     if (sharedFiles.commonTypes) {
       filesToWrite[import_node_path3.default.join(outputDir, "common-types.ts")] = sharedFiles.commonTypes;
     }
+    if (sharedFiles.tagTypes) {
+      filesToWrite[import_node_path3.default.join(outputDir, "tagTypes.ts")] = sharedFiles.tagTypes;
+    }
     if (sharedFiles.doNotModify) {
       filesToWrite[import_node_path3.default.join(outputDir, "DO_NOT_MODIFY.md")] = sharedFiles.doNotModify;
     }
@@ -491,12 +494,12 @@ export interface QueryConfig {
     keepUnusedDataFor?: number,
 }
 
-export interface IRequestConfig extends RequestOptions { {
+export interface IRequestConfig extends RequestOptions {
   timeout?: number;
 }
 
 export type IRestFulEndpointsQueryReturn<TVariables> = TVariables extends void ? 
-  void | {fetchOptions?: IRequestConfig;}: 
+  (void | {fetchOptions?: IRequestConfig;}): 
   {
       variables: TVariables;
       fetchOptions?: IRequestConfig;
@@ -926,7 +929,7 @@ function generateRtkQueryFile(endpointInfos, options) {
    */
   ${info.operationName}Query(${info.argTypeName !== "VoidApiArg" ? `args: IRestFulEndpointsQueryReturn<${info.argTypeName}>` : ""}): Observable<QueryState<${info.responseTypeName}>> {
     return this.ntkQuery.query<${info.responseTypeName}, ${info.argTypeName !== "VoidApiArg" ? `IRestFulEndpointsQueryReturn<${info.argTypeName}>` : "void"}>({
-      queryKey: [ECacheKeys.${info.queryKeyName}${info.argTypeName !== "VoidApiArg" ? ", args.variables" : ""}],
+      queryKey: [ECacheTagTypes.${info.queryKeyName}${info.argTypeName !== "VoidApiArg" ? ", args.variables" : ""}],
       queryFn: () => {
         return this.apiService.${info.operationName}(${info.argTypeName !== "VoidApiArg" ? "args" : ""});
       },
@@ -964,7 +967,7 @@ function generateRtkQueryFile(endpointInfos, options) {
       trigger: (${info.argTypeName !== "VoidApiArg" ? "args, " : ""}options = {}) => {
         const { skipCache = true } = options;
         if (!skipCache) {
-          const cachedResult = this.ntkQuery.getQueryCache<${info.responseTypeName}>([ECacheKeys.${info.queryKeyName}${info.argTypeName !== "VoidApiArg" ? ", args.variables" : ""}]);
+          const cachedResult = this.ntkQuery.getQueryCache<${info.responseTypeName}>([ECacheTagTypes.${info.queryKeyName}${info.argTypeName !== "VoidApiArg" ? ", args.variables" : ""}]);
           if (cachedResult) {
             return cachedResult;
           }
@@ -981,8 +984,8 @@ import {Injectable, inject} from '@angular/core';
 import {Observable} from 'rxjs';
 import {HttpErrorResponse} from '@angular/common/http';
 import {NtkQueryService, MutationState, QueryState, MutationResponse} from '@core/ntk-query';
-import {ECacheKeys} from '../cache-keys';
-import {${apiServiceName}} from './api.service';
+import {ECacheTagTypes} from '../tagTypes';
+import {${apiServiceName}} from './enhanceEndpoints';
 import {IRestFulEndpointsQueryReturn, RequestOptions} from '../common-types';
 import {${endpointInfos.map((info) => ` ${info.argTypeName}, ${info.responseTypeName}`).join(",")}} from './types';
 
@@ -1005,7 +1008,7 @@ function generateRtkEnhanceEndpointsFile(endpointInfos, options) {
   return `/* eslint-disable */
 // [Warning] Generated automatically - do not edit manually 
   
-import { ${httpClient.importName} } from '${httpClient.file}';
+import { ${httpClient.importReturnTypeName} } from '${httpClient.file}';
 import { Injectable, inject } from '@angular/core';
 import { Observable } from 'rxjs';
 import { ${apiConfiguration.importName} } from '${apiConfiguration.file}';
@@ -1018,7 +1021,7 @@ import {${endpointInfos.map((info) => ` ${info.argTypeName}, ${info.responseType
 })
 export class ${apiServiceClassName} {
   private config = inject(${apiConfiguration.importName});
-  private http = inject(${httpClient.importName});
+  private http = inject(${httpClient.importReturnTypeName});
 
 ${endpointInfos.map((info) => {
     const isGet = info.verb.toUpperCase() === "GET";
@@ -1036,17 +1039,16 @@ ${endpointInfos.map((info) => {
     const hasQueryParams = info.queryParams.length > 0;
     const hasBody = !isGet && hasArgs;
     const generateRequestOptions = () => {
-      const options2 = ["...args.fetchOptions"];
-      if (hasRequestBody || !isGet) {
-        options2.push(`headers: { 'Content-Type': 'application/json', ...args.fetchOptions?.headers }`);
-      }
-      if (hasQueryParams && hasArgs) {
-        options2.push(generateQueryParams(info.queryParams));
+      let paramsSection = "";
+      if (info.queryParams && info.queryParams.length > 0) {
+        const paramsLines = info.queryParams.map((param) => `${param.name}: args.variables.${param.name},`).join("\n");
+        paramsSection = `params: {${paramsLines}},`;
       }
-      if (hasRequestBody) {
-        options2.push("body: args.variables.body");
-      }
-      return options2.length > 0 ? `{ ${options2.join(", ")} }` : "{}";
+      return `{
+        ...args.fetchOptions,
+        headers: { 'Content-Type': '${info.contentType}', ...args.fetchOptions?.headers },
+        ${paramsSection}${info.hasRequestBody ? `body: args.variables.body,` : ""}
+      }`;
     };
     return `
   /**
@@ -1062,12 +1064,6 @@ ${endpointInfos.map((info) => {
 }
 `;
 }
-function generateQueryParams(queryParams) {
-  const paramEntries = queryParams.map(
-    (param) => `${param.name}: args.variables.${param.name}`
-  ).join(", ");
-  return `params: withoutUndefined({ ${paramEntries} })`;
-}
 
 // src/services/api-code-generator.ts
 var ApiCodeGenerator = class {
@@ -1093,6 +1089,11 @@ var ApiCodeGenerator = class {
     const rtkQueryContent = generateRtkQueryFile(endpointInfos, this.options);
     const enhanceEndpointsContent = generateRtkEnhanceEndpointsFile(endpointInfos, this.options);
     const indexContent = this.generateIndex();
+    const allEndpointCacheKeys = endpointInfos.filter((info) => info.isQuery).map((info) => ({
+      operationName: info.operationName,
+      queryKeyName: info.queryKeyName,
+      groupKey: this.options.groupKey || "_common"
+    }));
     const operationNames = endpointInfos.map((info) => info.operationName);
     const allTags = /* @__PURE__ */ new Set();
     endpointInfos.forEach((info) => {
@@ -1108,8 +1109,9 @@ var ApiCodeGenerator = class {
         queryService: rtkQueryContent,
         // RTK Query 檔案
         index: indexContent,
-        enhanceEndpoints: enhanceEndpointsContent
+        enhanceEndpoints: enhanceEndpointsContent,
         // 新增的 enhance endpoints 檔案
+        allEndpointCacheKeys
       }
     };
   }
@@ -1188,25 +1190,42 @@ export function withoutUndefined(obj?: Record<string, any>) {
 
 `;
 }
+function toCamelCase(str) {
+  return str.toLowerCase().replace(/_([a-z])/g, (_, letter) => letter.toUpperCase());
+}
 
 // src/generators/tag-types-generator.ts
 init_cjs_shims();
-function generateTagTypesFile(tags) {
-  if (tags.length === 0) {
-    return `/* eslint-disable */
-// [Warning] Generated automatically - do not edit manually
-
-export enum ECacheTagTypes {
-}
-`;
-  }
-  const enumEntries = tags.sort().map((tag) => `    ${tag} = '${tag}',`).join("\n");
-  return `/* eslint-disable */
-// [Warning] Generated automatically - do not edit manually
-
+function generateTagTypesFile(allEndpointInfos) {
+  const groupedKeys = allEndpointInfos.reduce(
+    (acc, info) => {
+      if (!acc[info.groupKey]) {
+        acc[info.groupKey] = [];
+      }
+      acc[info.groupKey].push({
+        operationName: info.operationName,
+        queryKeyName: info.queryKeyName
+      });
+      return acc;
+    },
+    {}
+  );
+  const enumEntries = Object.entries(groupedKeys).map(([groupKey, keys]) => {
+    const groupComment = `  // ${groupKey.charAt(0).toUpperCase() + groupKey.slice(1)} related cache keys`;
+    const keyEntries = keys.map((key) => `  ${key.queryKeyName} = '${toCamelCase(key.queryKeyName)}',`).join("\n");
+    return `${groupComment}
+${keyEntries}`;
+  }).join("\n\n");
+  return `// [Warning] Generated automatically - do not edit manually 
+  
+/**
+ * Cache keys enum for all API queries
+ */
 export enum ECacheTagTypes {
 ${enumEntries}
 }
+
+export default ECacheTagTypes;
 `;
 }
 
@@ -1216,6 +1235,7 @@ var UnifiedCodeGenerator = class {
   openApiService = new OpenApiService();
   groupService = new GroupService();
   fileWriterService = new FileWriterService();
+  allEndpointCacheKeys = [];
   // 內部狀態存儲
   openApiDoc = null;
   parserService = null;
@@ -1245,7 +1265,7 @@ var UnifiedCodeGenerator = class {
     this.generateSchemaContent();
     this.generateUtilsContent();
     this.generateDoNotModifyContent();
-    this.generateTagTypesContent();
+    this.generatECacheTagTypesContent();
     return await this.release();
   }
   /**
@@ -1259,23 +1279,23 @@ var UnifiedCodeGenerator = class {
         this._options.schemaFile
       );
     }
-    this.openApiDoc = await this.openApiService.getDocument(
-      this.actualSchemaFile,
-      this._options.httpResolverOptions
-    );
+    this.openApiDoc = await this.openApiService.getDocument(this.actualSchemaFile, this._options.httpResolverOptions);
     this.parserService = new OpenApiParserService(this.openApiDoc, this._options);
     this.parserService.initialize();
     const apiGen = this.parserService.getApiGenerator();
-    this.schemaInterfaces = apiGen.aliases.reduce((curr, alias) => {
-      if (import_typescript3.default.isInterfaceDeclaration(alias) || import_typescript3.default.isTypeAliasDeclaration(alias)) {
-        const name = alias.name.text;
-        return {
-          ...curr,
-          [name]: alias
-        };
-      }
-      return curr;
-    }, {});
+    this.schemaInterfaces = apiGen.aliases.reduce(
+      (curr, alias) => {
+        if (import_typescript3.default.isInterfaceDeclaration(alias) || import_typescript3.default.isTypeAliasDeclaration(alias)) {
+          const name = alias.name.text;
+          return {
+            ...curr,
+            [name]: alias
+          };
+        }
+        return curr;
+      },
+      {}
+    );
   }
   /**
    * 生成階段：產生所有內容但不寫檔
@@ -1288,10 +1308,7 @@ var UnifiedCodeGenerator = class {
     const groupInfos = this.groupService.groupPaths(paths, this._options.outputFiles);
     for (const groupInfo of Object.values(groupInfos)) {
       try {
-        const groupContent = await this.generateApiGroupContent(
-          this._options,
-          groupInfo
-        );
+        const groupContent = await this.generateApiGroupContent(this._options, groupInfo);
         if (groupContent.operationNames.length > 0) {
           this.generatedContent.groups.push({
             groupKey: groupInfo.groupKey,
@@ -1307,6 +1324,12 @@ var UnifiedCodeGenerator = class {
       }
     }
   }
+  /**
+   * 生成 cache keys
+   */
+  async generatECacheTagTypesContent() {
+    this.generatedContent.tagTypes = generateTagTypesFile(this.allEndpointCacheKeys);
+  }
   /**
    * 生成 common types
    */
@@ -1334,10 +1357,10 @@ var UnifiedCodeGenerator = class {
   /**
    * 生成 Tag Types
    */
-  async generateTagTypesContent() {
-    const tagsArray = Array.from(this.allTags);
-    this.generatedContent.tagTypes = generateTagTypesFile(tagsArray);
-  }
+  // private async generateTagTypesContent(): Promise<void> {
+  //   const tagsArray = Array.from(this.allTags);
+  //   this.generatedContent.tagTypes = generateTagTypesFile(tagsArray);
+  // }
   /**
    * 發佈階段：統一寫入所有檔案
    */
@@ -1350,15 +1373,12 @@ var UnifiedCodeGenerator = class {
         try {
           if (group.content?.files) {
             const groupOutputDir = import_node_path4.default.dirname(group.outputPath);
-            const groupResults = await this.fileWriterService.writeGroupFiles(
-              groupOutputDir,
-              {
-                types: group.content.files.types,
-                queryService: group.content.files.queryService,
-                enhanceEndpoints: group.content.files.enhanceEndpoints,
-                index: group.content.files.index
-              }
-            );
+            const groupResults = await this.fileWriterService.writeGroupFiles(groupOutputDir, {
+              types: group.content.files.types,
+              queryService: group.content.files.queryService,
+              enhanceEndpoints: group.content.files.enhanceEndpoints,
+              index: group.content.files.index
+            });
             results.push(...groupResults);
             generatedGroups.push(group.groupKey);
           }
@@ -1367,24 +1387,15 @@ var UnifiedCodeGenerator = class {
         }
       }
       const outputDir = this.generatedContent.groups[0] ? import_node_path4.default.dirname(import_node_path4.default.dirname(this.generatedContent.groups[0].outputPath)) : "./generated";
-      if (this.generatedContent.commonTypes || this.generatedContent.doNotModify || this.generatedContent.utils) {
-        const sharedResults = await this.fileWriterService.writeSharedFiles(
-          outputDir,
-          {
-            commonTypes: this.generatedContent.commonTypes || void 0,
-            doNotModify: this.generatedContent.doNotModify || void 0,
-            utils: this.generatedContent.utils || void 0
-          }
-        );
+      if (this.generatedContent.tagTypes || this.generatedContent.commonTypes || this.generatedContent.doNotModify || this.generatedContent.utils) {
+        const sharedResults = await this.fileWriterService.writeSharedFiles(outputDir, {
+          tagTypes: this.generatedContent.tagTypes || void 0,
+          commonTypes: this.generatedContent.commonTypes || void 0,
+          doNotModify: this.generatedContent.doNotModify || void 0,
+          utils: this.generatedContent.utils || void 0
+        });
         results.push(...sharedResults);
       }
-      if (this.generatedContent.tagTypes) {
-        const tagTypesResult = await this.fileWriterService.writeFile(
-          import_node_path4.default.join(outputDir, "tagTypes.ts"),
-          this.generatedContent.tagTypes
-        );
-        results.push(tagTypesResult);
-      }
       if (this.generatedContent.componentSchema) {
         const schemaResults = await this.fileWriterService.writeSchemaFile(
           outputDir,
@@ -1427,6 +1438,10 @@ var UnifiedCodeGenerator = class {
     }
     const apiGenerator = new ApiCodeGenerator(this.parserService, groupOptions);
     const result = await apiGenerator.generate();
+    if (result.files && "allEndpointCacheKeys" in result.files) {
+      const cacheKeys = result.files.allEndpointCacheKeys;
+      this.allEndpointCacheKeys.push(...cacheKeys);
+    }
     return result;
   }
   /**