beer-swagger 1.0.3 → 1.1.1

package/generate-apis.js

@@ -5,7 +5,6 @@ import path from 'path';
 import { createInterface } from 'readline';
 
 const ENV_PATH = path.join(process.cwd(), '.env');
-const CLIENT_TYPES = new Set(['WEB', 'WeChatMiniProgram']);
 const SKIPPED_SERVICES = new Set([
   'billbear-common-web-gateway',
   'billbear-common-data-panel'
@@ -116,8 +115,8 @@ function appendParamSuffix(baseName, paramSuffix) {
   return `${baseName}${paramSuffix}`;
 }
 
-// Add a verb for single-segment paths when needed.
-function addVerbForSingleSegment(name, method) {
+// Add a verb when the HTTP method should be reflected in the name.
+function addVerbForSingleSegment(name, method, hasPathParams = false) {
   const lower = name.toLowerCase();
   if (KEEP_METHOD_NAMES.has(lower)) {
     return name;
@@ -126,6 +125,9 @@ function addVerbForSingleSegment(name, method) {
     const suffix = name[0].toUpperCase() + name.slice(1);
     return `removeBy${suffix}`;
   }
+  if ((method === 'post' || method === 'put') && !hasPathParams) {
+    return name;
+  }
   const verbMap = {
     get: 'get',
     post: 'save',
@@ -238,9 +240,9 @@ function mapSchemaToType(schema, schemas, useTypes) {
     return `${itemType}[]`;
   }
   if (type === 'object') {
-    return '{}';
+    return 'object';
   }
-  return '{}';
+  return 'object';
 }
 
 // Map parameter schema to a type for method signatures.
@@ -281,9 +283,9 @@ function mapParamSchemaToType(schema, schemas, useTypes) {
     return '[]';
   }
   if (type === 'object') {
-    return '{}';
+    return 'object';
   }
-  return '{}';
+  return 'object';
 }
 
 // Resolve default response type from Swagger responses.
@@ -400,7 +402,7 @@ function toPascal(value) {
 }
 
 // Generate API file content for a service.
-function generateForSpec(spec, serviceName, fileBase, clientType) {
+function generateForSpec(spec, serviceName, fileBase, isDefaultFetch) {
   const {
     components = {},
     tags: specTags = [],
@@ -453,7 +455,8 @@ function generateForSpec(spec, serviceName, fileBase, clientType) {
         const pathSegments = p.split('/')
           .filter(Boolean)
           .filter((part) => !part.startsWith('{'));
-        name = pathSegments.length === 1 ? addVerbForSingleSegment(inferred, method) : inferred;
+        const shouldAddVerb = pathSegments.length === 1 || ((method === 'post' || method === 'put') && pathParams.length > 0);
+        name = shouldAddVerb ? addVerbForSingleSegment(inferred, method, pathParams.length > 0) : inferred;
       }
       if (!KEEP_METHOD_NAMES.has(name.toLowerCase())) {
         name = fixVerbCase(name);
@@ -615,7 +618,7 @@ function generateForSpec(spec, serviceName, fileBase, clientType) {
 
       if (entryMethod === 'get') {
         methods.push(`  public async ${name}<T = ${defaultType}>(${sigParts}): Promise<JsonResponse<T>> {`);
-        methods.push(`    return this.get<T>(${pathLiteral}, ${paramsObject});`);
+        methods.push(`    return await this.get<T>(${pathLiteral}, ${paramsObject});`);
         methods.push('  }');
         methods.push('');
         continue;
@@ -624,12 +627,12 @@ function generateForSpec(spec, serviceName, fileBase, clientType) {
       if (entryMethod === 'delete') {
         if (entryHasBody) {
           methods.push(`  public async ${name}<T = ${defaultType}>(${sigParts}): Promise<JsonResponse<T>> {`);
-          methods.push(`    return this.deleteBody<T>(${pathLiteral}, ${paramsObject}, body);`);
+          methods.push(`    return await this.deleteBody<T>(${pathLiteral}, ${paramsObject}, body);`);
           methods.push('  }');
           methods.push('');
         } else {
           methods.push(`  public async ${name}<T = ${defaultType}>(${sigParts}): Promise<JsonResponse<T>> {`);
-          methods.push(`    return this.delete<T>(${pathLiteral}, ${paramsObject});`);
+          methods.push(`    return await this.delete<T>(${pathLiteral}, ${paramsObject});`);
           methods.push('  }');
           methods.push('');
         }
@@ -639,12 +642,12 @@ function generateForSpec(spec, serviceName, fileBase, clientType) {
       if (entryMethod === 'post') {
         if (entryHasBody) {
           methods.push(`  public async ${name}<T = ${defaultType}>(${sigParts}): Promise<JsonResponse<T>> {`);
-          methods.push(`    return this.postBody<T>(${pathLiteral}, ${paramsObject}, body);`);
+          methods.push(`    return await this.postBody<T>(${pathLiteral}, ${paramsObject}, body);`);
           methods.push('  }');
           methods.push('');
         } else {
           methods.push(`  public async ${name}<T = ${defaultType}>(${sigParts}): Promise<JsonResponse<T>> {`);
-          methods.push(`    return this.post<T>(${pathLiteral}, ${paramsObject});`);
+          methods.push(`    return await this.post<T>(${pathLiteral}, ${paramsObject});`);
           methods.push('  }');
           methods.push('');
         }
@@ -654,12 +657,12 @@ function generateForSpec(spec, serviceName, fileBase, clientType) {
       if (entryMethod === 'put') {
         if (entryHasBody) {
           methods.push(`  public async ${name}<T = ${defaultType}>(${sigParts}): Promise<JsonResponse<T>> {`);
-          methods.push(`    return this.putBody<T>(${pathLiteral}, ${paramsObject}, body);`);
+          methods.push(`    return await this.putBody<T>(${pathLiteral}, ${paramsObject}, body);`);
           methods.push('  }');
           methods.push('');
         } else {
           methods.push(`  public async ${name}<T = ${defaultType}>(${sigParts}): Promise<JsonResponse<T>> {`);
-          methods.push(`    return this.put<T>(${pathLiteral}, ${paramsObject});`);
+          methods.push(`    return await this.put<T>(${pathLiteral}, ${paramsObject});`);
           methods.push('  }');
           methods.push('');
         }
@@ -667,7 +670,7 @@ function generateForSpec(spec, serviceName, fileBase, clientType) {
       }
 
       methods.push(`  public async ${name}<T = ${defaultType}>(${sigParts}): Promise<JsonResponse<T>> {`);
-      methods.push(`    return this.postBody<T>(${pathLiteral}, ${paramsObject}, body);`);
+      methods.push(`    return await this.postBody<T>(${pathLiteral}, ${paramsObject}, body);`);
       methods.push('  }');
       methods.push('');
     }
@@ -698,8 +701,9 @@ function generateForSpec(spec, serviceName, fileBase, clientType) {
   lines.push(' * This file is auto-generated. Do not edit manually.');
   lines.push(' * To update, run the generate-apis.js script.');
   lines.push(' */');
-  const fetchImport = clientType === 'WeChatMiniProgram' ? './fetch' : 'beer-network/api';
-  lines.push(`import Fetch, { JsonResponse } from '${fetchImport}';`);
+  const fetchImport = isDefaultFetch ? 'beer-network/api' : './fetch';
+  lines.push(`import type { JsonResponse } from '${fetchImport}';`);
+  lines.push(`import Fetch from '${fetchImport}';`);
   if (fileBase) {
     lines.push(`import type * as Types from './types/${fileBase}-type';`);
   }
@@ -709,7 +713,7 @@ function generateForSpec(spec, serviceName, fileBase, clientType) {
   lines.push('  public readonly pathPrefix: string;');
   lines.push(...apiProps);
   lines.push('  constructor(pathPrefix = \'\') {');
-  lines.push(`    this.pathPrefix = (pathPrefix ?? '') + '${defaultPathPrefix}';`);
+  lines.push(`    this.pathPrefix = \`\${pathPrefix ?? ''}${defaultPathPrefix}\`;`);
   lines.push(...apiInit);
   lines.push('  }');
   lines.push('}');
@@ -719,7 +723,7 @@ function generateForSpec(spec, serviceName, fileBase, clientType) {
   lines.push(`  if (!${cacheName}.has(pathPrefix)) {`);
   lines.push(`    ${cacheName}.set(pathPrefix, new ${apiClassName}(pathPrefix));`);
   lines.push('  }');
-  lines.push(`  return ${cacheName}.get(pathPrefix)!;`);
+  lines.push(`  return ${cacheName}.get(pathPrefix) ?? (() => { throw new Error('API instance not found'); })();`);
   lines.push('}');
   lines.push('');
 
@@ -913,22 +917,23 @@ function writeEnvFile(nextEnv) {
   fs.writeFileSync(ENV_PATH, `${lines.join('\n')}\n`, 'utf8');
 }
 
-function normalizeClientType(value) {
-  if (!value) {
-    return '';
+function normalizeBoolean(value) {
+  if (value === undefined || value === null || value === '') {
+    return undefined;
   }
-  if (CLIENT_TYPES.has(value)) {
+  if (typeof value === 'boolean') {
     return value;
   }
-  if (value.toUpperCase() === 'WEB') {
-    return 'WEB';
-  }
-  const normalized = value.replace(/[-_\s]/g, '')
+  const normalized = String(value)
+    .trim()
     .toLowerCase();
-  if (normalized === 'wechatminiprogram') {
-    return 'WeChatMiniProgram';
+  if (['true', '1', 'yes', 'y'].includes(normalized)) {
+    return true;
   }
-  return '';
+  if (['false', '0', 'no', 'n'].includes(normalized)) {
+    return false;
+  }
+  return undefined;
 }
 
 // Ask user for missing values via CLI.
@@ -948,13 +953,12 @@ async function promptForMissing(env) {
   if (!result.SWAGGER_OUT_DIRECTORY) {
     result.SWAGGER_OUT_DIRECTORY = (await ask('DIRECTORY: ')).trim();
   }
-  if (!result.CLIENT_TYPE || !CLIENT_TYPES.has(result.CLIENT_TYPE)) {
-    let selected = '';
-    while (!CLIENT_TYPES.has(selected)) {
-      selected = normalizeClientType((await ask('CLIENT_TYPE (WEB/WeChatMiniProgram): ')).trim());
-    }
-    result.CLIENT_TYPE = selected;
+  let isDefaultFetch = normalizeBoolean(result.IS_DEFAULT_FETCH);
+  while (isDefaultFetch === undefined) {
+    const selected = (await ask('IS_DEFAULT_FETCH (true/false): ')).trim();
+    isDefaultFetch = normalizeBoolean(selected);
   }
+  result.IS_DEFAULT_FETCH = String(isDefaultFetch);
   rl.close();
   return result;
 }
@@ -965,23 +969,23 @@ async function main() {
   let {
     SWAGGER_BASE_URL: baseUrl,
     SWAGGER_OUT_DIRECTORY: directory,
-    CLIENT_TYPE: clientType
+    IS_DEFAULT_FETCH: isDefaultFetch
   } = { ...process.env, ...envFile };
-  clientType = normalizeClientType(clientType);
+  isDefaultFetch = normalizeBoolean(isDefaultFetch);
 
-  if (!baseUrl || !directory || !clientType) {
+  if (!baseUrl || !directory || isDefaultFetch === undefined) {
     const filled = await promptForMissing({
       SWAGGER_BASE_URL: baseUrl || '',
       SWAGGER_OUT_DIRECTORY: directory || '',
-      CLIENT_TYPE: clientType || ''
+      IS_DEFAULT_FETCH: isDefaultFetch === undefined ? '' : String(isDefaultFetch)
     });
     baseUrl = filled.SWAGGER_BASE_URL;
     directory = filled.SWAGGER_OUT_DIRECTORY;
-    clientType = normalizeClientType(filled.CLIENT_TYPE);
+    isDefaultFetch = normalizeBoolean(filled.IS_DEFAULT_FETCH);
     writeEnvFile({
       SWAGGER_BASE_URL: baseUrl,
       SWAGGER_OUT_DIRECTORY: directory,
-      CLIENT_TYPE: clientType
+      IS_DEFAULT_FETCH: String(isDefaultFetch)
     });
   }
 
@@ -991,10 +995,9 @@ async function main() {
   if (!directory) {
     throw new Error('SWAGGER_OUT_DIRECTORY is required.');
   }
-  if (!clientType) {
-    throw new Error('CLIENT_TYPE is required.');
+  if (isDefaultFetch === undefined) {
+    throw new Error('IS_DEFAULT_FETCH is required.');
   }
-
   const configUrl = `${baseUrl}/v3/api-docs/swagger-config`;
   const outputDirectory = path.isAbsolute(directory) ? directory : path.join(process.cwd(), directory);
   const typesDirectory = path.join(outputDirectory, 'types');
@@ -1032,7 +1035,7 @@ async function main() {
     const specUrl = `${baseUrl}${url}`;
     const spec = await fetchJson(specUrl);
     const fileBase = toFileBase(serviceName);
-    const content = generateForSpec(spec, serviceName, fileBase, clientType);
+    const content = generateForSpec(spec, serviceName, fileBase, isDefaultFetch);
     const typesContent = generateTypes(spec);
 
     const outPath = path.join(outputDirectory, `${fileBase}.ts`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "beer-swagger",
-  "version": "1.0.3",
+  "version": "1.1.1",
   "bin": {
     "beer-swagger": "./generate-apis.js"
   },