beer-swagger 1.0.2 → 1.0.4

package/generate-apis.js

@@ -105,8 +105,19 @@ function toParamSuffix(params, nameMap) {
     .join('');
 }
 
-// Add a verb for single-segment paths when needed.
-function addVerbForSingleSegment(name, method) {
+// Avoid duplicate "By" when the base method name already ends with it.
+function appendParamSuffix(baseName, paramSuffix) {
+  if (!paramSuffix) {
+    return baseName;
+  }
+  if (baseName.endsWith('By') && paramSuffix.startsWith('By')) {
+    return baseName + paramSuffix.slice(2);
+  }
+  return `${baseName}${paramSuffix}`;
+}
+
+// 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;
@@ -115,6 +126,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',
@@ -227,9 +241,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.
@@ -270,9 +284,9 @@ function mapParamSchemaToType(schema, schemas, useTypes) {
     return '[]';
   }
   if (type === 'object') {
-    return '{}';
+    return 'object';
   }
-  return '{}';
+  return 'object';
 }
 
 // Resolve default response type from Swagger responses.
@@ -433,12 +447,17 @@ function generateForSpec(spec, serviceName, fileBase, clientType) {
       if (name === 'unnamed') {
         name = toCamel(opId);
       }
+      const pathParams = getParams(op).filter((p) => p.in === 'path');
+      if (method === 'delete' && pathParams.length === 1) {
+        name = 'removeBy';
+      }
       if (!KEEP_METHOD_NAMES.has(name.toLowerCase()) && isAllLowerWord(name)) {
         const inferred = pathToName(p);
         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);
@@ -509,7 +528,7 @@ function generateForSpec(spec, serviceName, fileBase, clientType) {
       if (seen.has(name)) {
         const paramSuffix = toParamSuffix(entryParams, paramNameMap);
         if (paramSuffix) {
-          name = `${entryName}${paramSuffix}`;
+          name = appendParamSuffix(entryName, paramSuffix);
         }
       }
       if (seen.has(name)) {
@@ -600,7 +619,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;
@@ -609,12 +628,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('');
         }
@@ -624,12 +643,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('');
         }
@@ -639,12 +658,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('');
         }
@@ -652,7 +671,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('');
     }
@@ -676,7 +695,7 @@ function generateForSpec(spec, serviceName, fileBase, clientType) {
 
   const baseName = toServiceBaseName(serviceName);
   const apiClassName = `${toPascal(baseName)}Api`;
-  const factoryName = `get${apiClassName}`;
+  const factoryName = apiClassName === 'ApiApi' ? 'getApi' : `get${apiClassName}`;
   const cacheName = `${baseName}ApiCache`;
   const lines = [];
   lines.push('/*');
@@ -684,7 +703,8 @@ function generateForSpec(spec, serviceName, fileBase, clientType) {
   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}';`);
+  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';`);
   }
@@ -694,7 +714,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('}');
@@ -704,7 +724,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('');
 

package/package.json

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