@hyper-fetch/cli 7.2.6 → 7.4.0

package/README.md

@@ -13,9 +13,6 @@
   <a href="https://www.npmjs.com/package/hyper-fetch">
     <img src="https://custom-icon-badges.demolab.com/npm/v/hyper-fetch.svg?logo=npm&color=e76f51" />
   </a>
-  <a href="https://api.codeclimate.com/v1/badges/eade9435e75ecea0c004/test_coverage">
-    <img src="https://api.codeclimate.com/v1/badges/eade9435e75ecea0c004/test_coverage" />
-  </a>
   <a href="https://github.com/BetterTyped/hyper-fetch">
     <img src="https://custom-icon-badges.demolab.com/badge/typescript-%23007ACC.svg?logo=typescript&logoColor=white" />
   </a>

package/dist/index.d.ts

@@ -59,14 +59,16 @@ declare class OpenapiRequestGenerator {
         sdkSchema: string;
         createSdkFn: string;
     }>;
-    static generateRequestInstanceType({ id, path: endpoint }: {
+    static generateRequestInstanceType({ id, path: endpoint, queryParamsRequired }: {
         id: string;
         path: string;
+        queryParamsRequired?: boolean;
     }, types: Record<string, string>): string;
-    static generateHyperFetchRequest({ id, path: relPath, method }: {
+    static generateHyperFetchRequest({ id, path: relPath, method, queryParamsRequired, }: {
         id: string;
         path: string;
         method: string;
+        queryParamsRequired?: boolean;
     }, types: Record<string, string>): string;
     static generateTypes({ id, pathParametersType, queryParametersType, requestBodyType, errorType, responseType, }: {
         id: string;
@@ -89,6 +91,7 @@ declare class OpenapiRequestGenerator {
         responseType: string;
         path: string;
         method: string;
+        queryParamsRequired: boolean;
     };
     static validateSchema(openapiDocument: Document): void;
     static prepareSchema(openapiDocument: Document): Promise<{

package/dist/index.js

@@ -2236,7 +2236,7 @@ function handleError(error) {
   logger.break();
   logger.error(`Something went wrong. Please check the error below for more details.`);
   logger.error(`If the problem persists, please open an issue on GitHub.`);
-  logger.error("");
+  logger.break();
   if (typeof error === "string") {
     logger.error(error);
     logger.break();
@@ -2255,6 +2255,7 @@ function handleError(error) {
     logger.break();
     process.exit(1);
   }
+  logger.error(JSON.stringify({ error }));
   logger.break();
   process.exit(1);
 }
@@ -2532,20 +2533,30 @@ var _OpenapiRequestGenerator = class _OpenapiRequestGenerator {
         const segments = relPath.split("/").filter(Boolean);
         let currentLevel = schemaTree;
         for (const segment of segments) {
-          const key = segment.startsWith(":") ? `$${segment.slice(1)}` : segment;
+          let key;
+          if (segment.startsWith(":")) {
+            key = `$${segment.slice(1)}`;
+          } else if (segment.includes("-")) {
+            key = segment.replace(/-([a-z])/g, (_, letter) => letter.toUpperCase());
+          } else {
+            key = segment;
+          }
           if (!currentLevel[key]) {
             currentLevel[key] = {};
           }
           currentLevel = currentLevel[key];
         }
-        currentLevel[method.toLowerCase()] = requestInstanceType;
+        currentLevel[`$${method.toLowerCase()}`] = requestInstanceType;
       });
       const sdkSchema = `export type SdkSchema<Client extends ClientInstance> = {
 ${formatSchema(schemaTree)}
 }`;
       const createSdkFn = `
-export const createSdk = <Client extends ClientInstance>(client: Client) => {
-  return coreCreateSdk<Client, SdkSchema<Client>>(client);
+
+export type { Components };
+
+export const createSdk = <Client extends ClientInstance>(client: Client, options?: Parameters<typeof coreCreateSdk>[1] | undefined) => {
+  return coreCreateSdk<Client, SdkSchema<Client>>(client, options);
 };
 `;
       return { schemaTypes, generatedTypes, sdkSchema, createSdkFn };
@@ -2591,14 +2602,20 @@ export const createSdk = <Client extends ClientInstance>(client: Client) => {
       return generatedPath;
     });
   }
-  static generateRequestInstanceType({ id, path: endpoint }, types) {
+  static generateRequestInstanceType({ id, path: endpoint, queryParamsRequired }, types) {
     const Response = types[`${createTypeBaseName(id)}ResponseType`] ? `${createTypeBaseName(id)}ResponseType` : void 0;
     const Payload = types[`${createTypeBaseName(id)}RequestBody`] ? `${createTypeBaseName(id)}RequestBody` : void 0;
     const LocalError = types[`${createTypeBaseName(id)}ErrorType`] ? `${createTypeBaseName(id)}ErrorType` : void 0;
     const QueryParams = types[`${createTypeBaseName(id)}QueryParams`] ? `${createTypeBaseName(id)}QueryParams` : void 0;
-    return `Request<${Response}, ${Payload}, ${QueryParams}, ${LocalError}, "${endpoint}", Client>`;
+    const QueryParamsGeneric = QueryParams && !queryParamsRequired ? `${QueryParams} | undefined` : QueryParams;
+    return `Request<${Response}, ${Payload}, ${QueryParamsGeneric}, ${LocalError}, "${endpoint}", Client>`;
   }
-  static generateHyperFetchRequest({ id, path: relPath, method }, types) {
+  static generateHyperFetchRequest({
+    id,
+    path: relPath,
+    method,
+    queryParamsRequired
+  }, types) {
     const Response = types[`${createTypeBaseName(id)}ResponseType`] ? `${createTypeBaseName(id)}ResponseType` : void 0;
     const Payload = types[`${createTypeBaseName(id)}RequestBody`] ? `${createTypeBaseName(id)}RequestBody` : void 0;
     const LocalError = types[`${createTypeBaseName(id)}ErrorType`] ? `${createTypeBaseName(id)}ErrorType` : void 0;
@@ -2621,7 +2638,8 @@ export const createSdk = <Client extends ClientInstance>(client: Client) => {
       addToGenericType("error", LocalError);
     }
     if (QueryParams) {
-      addToGenericType("query", QueryParams);
+      const key = !queryParamsRequired ? "queryParams?" : "queryParams";
+      addToGenericType(key, QueryParams);
     }
     if (genericType) {
       genericType = `<{${genericType}}>`;
@@ -2676,6 +2694,9 @@ export const createSdk = <Client extends ClientInstance>(client: Client) => {
     ).map(({ path: errorPath }) => errorPath).value();
     const responseType = !lodash.isEmpty(responseTypePaths) ? responseTypePaths.join(" | ") : "any";
     const errorType = !lodash.isEmpty(errorTypePaths) ? errorTypePaths.join(" | ") : "undefined";
+    const queryParamsRequired = Array.isArray(operation.parameters) ? operation.parameters.some((p) => {
+      return "in" in p && p.in === "query" && p.required === true;
+    }) : false;
     return {
       id: normalizedOperationId,
       pathParametersType,
@@ -2684,7 +2705,8 @@ export const createSdk = <Client extends ClientInstance>(client: Client) => {
       errorType,
       responseType,
       path: adjustPathParamsFormat(relPath),
-      method: method ? method.toUpperCase() : "get" /* GET */
+      method: method ? method.toUpperCase() : "get" /* GET */,
+      queryParamsRequired
     };
   }
   static validateSchema(openapiDocument) {
@@ -3048,9 +3070,12 @@ var main = () => __async(null, null, function* () {
           description: cmd.description()
         }))
       });
+      yield program.parseAsync([process.argv[0], process.argv[1], chosenCommand]);
+    } else {
+      yield program.parseAsync(process.argv);
     }
-    yield program.parseAsync([process.argv[0], process.argv[1], chosenCommand]);
   } catch (e) {
+    handleError(e);
     if (e instanceof Error) {
       if (e.message.includes("User force closed the prompt")) {
         process.exit(0);