api 5.0.0-beta.2 → 5.0.0

package/src/index.ts

@@ -1,12 +1,11 @@
-import type { Operation } from 'oas';
-import type { HttpMethods, OASDocument } from 'oas/@types/rmoas.types';
 import type { ConfigOptions } from './core';
+import type { Operation } from 'oas';
+import type { OASDocument } from 'oas/dist/rmoas.types';
 
 import Oas from 'oas';
-import APICore from './core';
 
 import Cache from './cache';
-
+import APICore from './core';
 import { PACKAGE_NAME, PACKAGE_VERSION } from './packageInfo';
 
 interface SDKOptions {
@@ -38,24 +37,6 @@ class Sdk {
     let isCached = cache.isCached();
     let sdk = {};
 
-    /**
-     * Create dynamic accessors for every HTTP method that the OpenAPI specification supports.
-     *
-     * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-7}
-     * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-7}
-     */
-    function loadMethods() {
-      return ['get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace']
-        .map(httpVerb => {
-          return {
-            [httpVerb]: ((method: string, path: string, ...args: unknown[]) => {
-              return core.fetch(path, method as HttpMethods, ...args);
-            }).bind(null, httpVerb),
-          };
-        })
-        .reduce((prev, next) => Object.assign(prev, next));
-    }
-
     /**
      * Create dynamic accessors for every operation with a defined operation ID. If an operation
      * does not have an operation ID it can be accessed by its `.method('/path')` accessor instead.
@@ -66,19 +47,34 @@ class Sdk {
       return Object.entries(spec.getPaths())
         .map(([, operations]) => Object.values(operations))
         .reduce((prev, next) => prev.concat(next), [])
-        .filter(operation => operation.hasOperationId())
         .reduce((prev, next) => {
           // `getOperationId()` creates dynamic operation IDs when one isn't available but we need
           // to know here if we actually have one present or not. The `camelCase` option here also
           // cleans up any `operationId` that we might have into something that can be used as a
           // valid JS method.
+          const originalOperationId = next.getOperationId();
           const operationId = next.getOperationId({ camelCase: true });
 
-          return Object.assign(prev, {
+          const op = {
             [operationId]: ((operation: Operation, ...args: unknown[]) => {
               return core.fetchOperation(operation, ...args);
             }).bind(null, next),
-          });
+          };
+
+          if (operationId !== originalOperationId) {
+            // If we cleaned up their operation ID into a friendly method accessor (`findPetById`
+            // versus `find pet by id`) we should still let them use the non-friendly version if
+            // they want.
+            //
+            // This work is to maintain backwards compatibility with `api@4` and does not exist
+            // within our code generated SDKs -- those only allow the cleaner camelCase
+            // `operationId` to be used.
+            op[originalOperationId] = ((operation: Operation, ...args: unknown[]) => {
+              return core.fetchOperation(operation, ...args);
+            }).bind(null, next);
+          }
+
+          return Object.assign(prev, op);
         }, {});
     }
 
@@ -95,11 +91,7 @@ class Sdk {
 
       core.setSpec(spec);
 
-      sdk = Object.assign(sdk, {
-        ...loadMethods(),
-        ...loadOperations(spec),
-      });
-
+      sdk = Object.assign(sdk, loadOperations(spec));
       isLoaded = true;
     }
 
@@ -167,10 +159,10 @@ class Sdk {
       },
 
       /**
-       * Optionally configure various options, such as response parsing, that the SDK allows.
+       * Optionally configure various options that the SDK allows.
        *
        * @param config Object of supported SDK options and toggles.
-       * @param config.parseResponse If responses are parsed according to its `Content-Type` header.
+       * @param config.timeout Override the default `fetch` request timeout of 30 seconds (30000ms).
        */
       config: (config: ConfigOptions) => {
         core.setConfig(config);

package/src/packageInfo.ts

@@ -1,3 +1,3 @@
 // This file is automatically updated by the build script.
 export const PACKAGE_NAME = 'api';
-export const PACKAGE_VERSION = '5.0.0-beta.2';
+export const PACKAGE_VERSION = '5.0.0';

package/src/typings.d.ts

@@ -1,3 +1,2 @@
 // These libraries don't have any types so we need to let TS know so we can use them.
 declare module 'fetch-har';
-declare module '@readme/oas-to-har';

package/tsconfig.json

@@ -4,7 +4,7 @@
     "baseUrl": "./src",
     "declaration": true,
     "esModuleInterop": true,
-    "lib": ["dom", "es2020"],
+    "lib": ["dom", "dom.iterable", "es2020"],
     "noImplicitAny": true,
     "outDir": "dist/",
     "paths": {