@readme/api-core 7.0.0-beta.1 → 7.0.0-beta.10

package/dist/index.d.cts

@@ -1,40 +1,41 @@
-import Operation from 'oas/operation';
-import { OASDocument, HttpMethods } from 'oas/rmoas.types';
+import * as har_format from 'har-format';
+import { ConfigOptions } from './types.cjs';
+import { DataForHAR, AuthForHAR } from '@readme/oas-to-har/lib/types';
+import { Operation } from 'oas/operation';
+import { OASDocument, HttpMethods } from 'oas/types';
 import Oas from 'oas';
+import 'json-schema-to-ts';
 
-interface ConfigOptions {
-    /**
-     * Override the default `fetch` request timeout of 30 seconds. This number should be represented
-     * in milliseconds.
-     */
-    timeout?: number;
-}
-interface FetchResponse<HTTPStatus, Data> {
-    data: Data;
-    headers: Headers;
-    res: Response;
-    status: HTTPStatus;
-}
-type Enumerate<N extends number, Acc extends number[] = []> = Acc['length'] extends N ? Acc[number] : Enumerate<N, [...Acc, Acc['length']]>;
-type HTTPMethodRange<F extends number, T extends number> = Exclude<Enumerate<T>, Enumerate<F>>;
 declare class APICore {
     spec: Oas;
     private auth;
     private server;
     private config;
     private userAgent;
-    constructor(definition?: Record<string, unknown> | OASDocument, userAgent?: string);
+    constructor(definition?: OASDocument | Record<string, unknown>, userAgent?: string);
     setSpec(spec: Oas): void;
     setConfig(config: ConfigOptions): this;
     setUserAgent(userAgent: string): this;
-    setAuth(...values: string[] | number[]): this;
-    setServer(url: string, variables?: Record<string, string | number>): this;
+    setAuth(...values: number[] | string[]): this;
+    setServer(url: string, variables?: Record<string, number | string>): this;
     fetch<HTTPStatus extends number = number>(path: string, method: HttpMethods, body?: unknown, metadata?: Record<string, unknown>): Promise<{
         data: any;
         status: HTTPStatus;
         headers: Headers;
         res: Response;
     }>;
+    /**
+     * Retrieve a HAR for a given HTTP request.
+     *
+     * @internal
+     */
+    getHARForRequest(operation: Operation, data: DataForHAR, auth: AuthForHAR): {
+        log: {
+            entries: {
+                request: har_format.Request;
+            }[];
+        };
+    };
     fetchOperation<HTTPStatus extends number = number>(operation: Operation, body?: unknown, metadata?: Record<string, unknown>): Promise<{
         data: any;
         status: HTTPStatus;
@@ -43,4 +44,4 @@ declare class APICore {
     }>;
 }
 
-export { ConfigOptions, FetchResponse, HTTPMethodRange, APICore as default };
+export = APICore;

package/dist/index.d.ts

@@ -1,40 +1,41 @@
-import Operation from 'oas/operation';
-import { OASDocument, HttpMethods } from 'oas/rmoas.types';
+import * as har_format from 'har-format';
+import { ConfigOptions } from './types.js';
+import { DataForHAR, AuthForHAR } from '@readme/oas-to-har/lib/types';
+import { Operation } from 'oas/operation';
+import { OASDocument, HttpMethods } from 'oas/types';
 import Oas from 'oas';
+import 'json-schema-to-ts';
 
-interface ConfigOptions {
-    /**
-     * Override the default `fetch` request timeout of 30 seconds. This number should be represented
-     * in milliseconds.
-     */
-    timeout?: number;
-}
-interface FetchResponse<HTTPStatus, Data> {
-    data: Data;
-    headers: Headers;
-    res: Response;
-    status: HTTPStatus;
-}
-type Enumerate<N extends number, Acc extends number[] = []> = Acc['length'] extends N ? Acc[number] : Enumerate<N, [...Acc, Acc['length']]>;
-type HTTPMethodRange<F extends number, T extends number> = Exclude<Enumerate<T>, Enumerate<F>>;
 declare class APICore {
     spec: Oas;
     private auth;
     private server;
     private config;
     private userAgent;
-    constructor(definition?: Record<string, unknown> | OASDocument, userAgent?: string);
+    constructor(definition?: OASDocument | Record<string, unknown>, userAgent?: string);
     setSpec(spec: Oas): void;
     setConfig(config: ConfigOptions): this;
     setUserAgent(userAgent: string): this;
-    setAuth(...values: string[] | number[]): this;
-    setServer(url: string, variables?: Record<string, string | number>): this;
+    setAuth(...values: number[] | string[]): this;
+    setServer(url: string, variables?: Record<string, number | string>): this;
     fetch<HTTPStatus extends number = number>(path: string, method: HttpMethods, body?: unknown, metadata?: Record<string, unknown>): Promise<{
         data: any;
         status: HTTPStatus;
         headers: Headers;
         res: Response;
     }>;
+    /**
+     * Retrieve a HAR for a given HTTP request.
+     *
+     * @internal
+     */
+    getHARForRequest(operation: Operation, data: DataForHAR, auth: AuthForHAR): {
+        log: {
+            entries: {
+                request: har_format.Request;
+            }[];
+        };
+    };
     fetchOperation<HTTPStatus extends number = number>(operation: Operation, body?: unknown, metadata?: Record<string, unknown>): Promise<{
         data: any;
         status: HTTPStatus;
@@ -43,4 +44,4 @@ declare class APICore {
     }>;
 }
 
-export { ConfigOptions, FetchResponse, HTTPMethodRange, APICore as default };
+export { APICore as default };

package/dist/index.js

@@ -6,7 +6,7 @@ import {
   prepareAuth,
   prepareParams,
   prepareServer
-} from "./chunk-ASE5F2OQ.js";
+} from "./chunk-J3R5ZB7L.js";
 
 // src/index.ts
 import oasToHar from "@readme/oas-to-har";
@@ -19,10 +19,8 @@ var APICore = class {
   config = {};
   userAgent;
   constructor(definition, userAgent) {
-    if (definition)
-      this.spec = Oas.init(definition);
-    if (userAgent)
-      this.userAgent = userAgent;
+    if (definition) this.spec = Oas.init(definition);
+    if (userAgent) this.userAgent = userAgent;
   }
   setSpec(spec) {
     this.spec = spec;
@@ -47,6 +45,14 @@ var APICore = class {
     const operation = this.spec.operation(path, method);
     return this.fetchOperation(operation, body, metadata);
   }
+  /**
+   * Retrieve a HAR for a given HTTP request.
+   *
+   * @internal
+   */
+  getHARForRequest(operation, data, auth) {
+    return oasToHar(this.spec, operation, data, auth);
+  }
   async fetchOperation(operation, body, metadata) {
     return prepareParams(operation, body, metadata).then((params) => {
       const data = { ...params };
@@ -56,7 +62,7 @@ var APICore = class {
           data.server = preparedServer;
         }
       }
-      const har = oasToHar(this.spec, operation, data, prepareAuth(this.auth, operation));
+      const har = this.getHARForRequest(operation, data, prepareAuth(this.auth, operation));
       let timeoutSignal;
       const init = {};
       if (this.config.timeout) {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Har } from 'har-format';\nimport type Operation from 'oas/operation';\nimport type { HttpMethods, OASDocument } from 'oas/rmoas.types';\n\nimport oasToHar from '@readme/oas-to-har';\nimport fetchHar from 'fetch-har';\nimport Oas from 'oas';\n\nimport FetchError from './errors/fetchError.js';\nimport { parseResponse, prepareAuth, prepareParams, prepareServer } from './lib/index.js';\n\nexport interface ConfigOptions {\n  /**\n   * Override the default `fetch` request timeout of 30 seconds. This number should be represented\n   * in milliseconds.\n   */\n  timeout?: number;\n}\n\nexport interface FetchResponse<HTTPStatus, Data> {\n  data: Data;\n  headers: Headers;\n  res: Response;\n  status: HTTPStatus;\n}\n\n// https://stackoverflow.com/a/39495173\ntype Enumerate<N extends number, Acc extends number[] = []> = Acc['length'] extends N\n  ? Acc[number]\n  : Enumerate<N, [...Acc, Acc['length']]>;\n\nexport type HTTPMethodRange<F extends number, T extends number> = Exclude<Enumerate<T>, Enumerate<F>>;\n\nexport default class APICore {\n  spec!: Oas;\n\n  private auth: (number | string)[] = [];\n\n  private server:\n    | false\n    | {\n        url: string;\n        variables?: Record<string, string | number>;\n      } = false;\n\n  private config: ConfigOptions = {};\n\n  private userAgent!: string;\n\n  constructor(definition?: Record<string, unknown> | OASDocument, userAgent?: string) {\n    if (definition) this.spec = Oas.init(definition);\n    if (userAgent) this.userAgent = userAgent;\n  }\n\n  setSpec(spec: Oas) {\n    this.spec = spec;\n  }\n\n  setConfig(config: ConfigOptions) {\n    this.config = config;\n    return this;\n  }\n\n  setUserAgent(userAgent: string) {\n    this.userAgent = userAgent;\n    return this;\n  }\n\n  setAuth(...values: string[] | number[]) {\n    this.auth = values;\n    return this;\n  }\n\n  setServer(url: string, variables: Record<string, string | number> = {}) {\n    this.server = { url, variables };\n    return this;\n  }\n\n  async fetch<HTTPStatus extends number = number>(\n    path: string,\n    method: HttpMethods,\n    body?: unknown,\n    metadata?: Record<string, unknown>,\n  ) {\n    const operation = this.spec.operation(path, method);\n\n    return this.fetchOperation<HTTPStatus>(operation, body, metadata);\n  }\n\n  async fetchOperation<HTTPStatus extends number = number>(\n    operation: Operation,\n    body?: unknown,\n    metadata?: Record<string, unknown>,\n  ) {\n    return prepareParams(operation, body, metadata).then(params => {\n      const data = { ...params };\n\n      // If `sdk.server()` has been issued data then we need to do some extra work to figure out\n      // how to use that supplied server, and also handle any server variables that were sent\n      // alongside it.\n      if (this.server) {\n        const preparedServer = prepareServer(this.spec, this.server.url, this.server.variables);\n        if (preparedServer) {\n          data.server = preparedServer;\n        }\n      }\n\n      // @ts-expect-error `this.auth` typing is off. FIXME\n      const har = oasToHar(this.spec, operation, data, prepareAuth(this.auth, operation));\n\n      let timeoutSignal: NodeJS.Timeout;\n      const init: RequestInit = {};\n      if (this.config.timeout) {\n        const controller = new AbortController();\n        timeoutSignal = setTimeout(() => controller.abort(), this.config.timeout);\n        init.signal = controller.signal;\n      }\n\n      return fetchHar(har as Har, {\n        files: data.files || {},\n        init,\n        userAgent: this.userAgent,\n      })\n        .then(async (res: Response) => {\n          const parsed = await parseResponse<HTTPStatus>(res);\n\n          if (res.status >= 400 && res.status <= 599) {\n            throw new FetchError<typeof parsed.status, typeof parsed.data>(\n              parsed.status,\n              parsed.data,\n              parsed.headers,\n              parsed.res,\n            );\n          }\n\n          return parsed;\n        })\n        .finally(() => {\n          if (this.config.timeout) {\n            clearTimeout(timeoutSignal);\n          }\n        });\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;AAIA,OAAO,cAAc;AACrB,OAAO,cAAc;AACrB,OAAO,SAAS;AA2BhB,IAAqB,UAArB,MAA6B;AAAA,EAC3B;AAAA,EAEQ,OAA4B,CAAC;AAAA,EAE7B,SAKA;AAAA,EAEA,SAAwB,CAAC;AAAA,EAEzB;AAAA,EAER,YAAY,YAAoD,WAAoB;AAClF,QAAI;AAAY,WAAK,OAAO,IAAI,KAAK,UAAU;AAC/C,QAAI;AAAW,WAAK,YAAY;AAAA,EAClC;AAAA,EAEA,QAAQ,MAAW;AACjB,SAAK,OAAO;AAAA,EACd;AAAA,EAEA,UAAU,QAAuB;AAC/B,SAAK,SAAS;AACd,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,WAAmB;AAC9B,SAAK,YAAY;AACjB,WAAO;AAAA,EACT;AAAA,EAEA,WAAW,QAA6B;AACtC,SAAK,OAAO;AACZ,WAAO;AAAA,EACT;AAAA,EAEA,UAAU,KAAa,YAA6C,CAAC,GAAG;AACtE,SAAK,SAAS,EAAE,KAAK,UAAU;AAC/B,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,MACJ,MACA,QACA,MACA,UACA;AACA,UAAM,YAAY,KAAK,KAAK,UAAU,MAAM,MAAM;AAElD,WAAO,KAAK,eAA2B,WAAW,MAAM,QAAQ;AAAA,EAClE;AAAA,EAEA,MAAM,eACJ,WACA,MACA,UACA;AACA,WAAO,cAAc,WAAW,MAAM,QAAQ,EAAE,KAAK,YAAU;AAC7D,YAAM,OAAO,EAAE,GAAG,OAAO;AAKzB,UAAI,KAAK,QAAQ;AACf,cAAM,iBAAiB,cAAc,KAAK,MAAM,KAAK,OAAO,KAAK,KAAK,OAAO,SAAS;AACtF,YAAI,gBAAgB;AAClB,eAAK,SAAS;AAAA,QAChB;AAAA,MACF;AAGA,YAAM,MAAM,SAAS,KAAK,MAAM,WAAW,MAAM,YAAY,KAAK,MAAM,SAAS,CAAC;AAElF,UAAI;AACJ,YAAM,OAAoB,CAAC;AAC3B,UAAI,KAAK,OAAO,SAAS;AACvB,cAAM,aAAa,IAAI,gBAAgB;AACvC,wBAAgB,WAAW,MAAM,WAAW,MAAM,GAAG,KAAK,OAAO,OAAO;AACxE,aAAK,SAAS,WAAW;AAAA,MAC3B;AAEA,aAAO,SAAS,KAAY;AAAA,QAC1B,OAAO,KAAK,SAAS,CAAC;AAAA,QACtB;AAAA,QACA,WAAW,KAAK;AAAA,MAClB,CAAC,EACE,KAAK,OAAO,QAAkB;AAC7B,cAAM,SAAS,MAAM,cAA0B,GAAG;AAElD,YAAI,IAAI,UAAU,OAAO,IAAI,UAAU,KAAK;AAC1C,gBAAM,IAAI;AAAA,YACR,OAAO;AAAA,YACP,OAAO;AAAA,YACP,OAAO;AAAA,YACP,OAAO;AAAA,UACT;AAAA,QACF;AAEA,eAAO;AAAA,MACT,CAAC,EACA,QAAQ,MAAM;AACb,YAAI,KAAK,OAAO,SAAS;AACvB,uBAAa,aAAa;AAAA,QAC5B;AAAA,MACF,CAAC;AAAA,IACL,CAAC;AAAA,EACH;AACF;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { ConfigOptions } from './types.js';\nimport type { AuthForHAR, DataForHAR } from '@readme/oas-to-har/lib/types';\nimport type { Har } from 'har-format';\nimport type { Operation } from 'oas/operation';\nimport type { HttpMethods, OASDocument } from 'oas/types';\n\nimport oasToHar from '@readme/oas-to-har';\nimport fetchHar from 'fetch-har';\nimport Oas from 'oas';\n\nimport FetchError from './errors/fetchError.js';\nimport { parseResponse, prepareAuth, prepareParams, prepareServer } from './lib/index.js';\n\nexport default class APICore {\n  spec!: Oas;\n\n  private auth: (number | string)[] = [];\n\n  private server:\n    | false\n    | {\n        url: string;\n        variables?: Record<string, number | string>;\n      } = false;\n\n  private config: ConfigOptions = {};\n\n  private userAgent!: string;\n\n  constructor(definition?: OASDocument | Record<string, unknown>, userAgent?: string) {\n    if (definition) this.spec = Oas.init(definition);\n    if (userAgent) this.userAgent = userAgent;\n  }\n\n  setSpec(spec: Oas) {\n    this.spec = spec;\n  }\n\n  setConfig(config: ConfigOptions) {\n    this.config = config;\n    return this;\n  }\n\n  setUserAgent(userAgent: string) {\n    this.userAgent = userAgent;\n    return this;\n  }\n\n  setAuth(...values: number[] | string[]) {\n    this.auth = values;\n    return this;\n  }\n\n  setServer(url: string, variables: Record<string, number | string> = {}) {\n    this.server = { url, variables };\n    return this;\n  }\n\n  async fetch<HTTPStatus extends number = number>(\n    path: string,\n    method: HttpMethods,\n    body?: unknown,\n    metadata?: Record<string, unknown>,\n  ) {\n    const operation = this.spec.operation(path, method);\n\n    return this.fetchOperation<HTTPStatus>(operation, body, metadata);\n  }\n\n  /**\n   * Retrieve a HAR for a given HTTP request.\n   *\n   * @internal\n   */\n  getHARForRequest(operation: Operation, data: DataForHAR, auth: AuthForHAR) {\n    return oasToHar(this.spec, operation, data, auth);\n  }\n\n  async fetchOperation<HTTPStatus extends number = number>(\n    operation: Operation,\n    body?: unknown,\n    metadata?: Record<string, unknown>,\n  ) {\n    return prepareParams(operation, body, metadata).then(params => {\n      const data = { ...params };\n\n      // If `sdk.server()` has been issued data then we need to do some extra work to figure out\n      // how to use that supplied server, and also handle any server variables that were sent\n      // alongside it.\n      if (this.server) {\n        const preparedServer = prepareServer(this.spec, this.server.url, this.server.variables);\n        if (preparedServer) {\n          data.server = preparedServer;\n        }\n      }\n\n      const har = this.getHARForRequest(operation, data, prepareAuth(this.auth, operation));\n\n      let timeoutSignal: NodeJS.Timeout;\n      const init: RequestInit = {};\n      if (this.config.timeout) {\n        const controller = new AbortController();\n        timeoutSignal = setTimeout(() => controller.abort(), this.config.timeout);\n        init.signal = controller.signal;\n      }\n\n      return fetchHar(har as Har, {\n        files: data.files || {},\n        init,\n        userAgent: this.userAgent,\n      })\n        .then(async (res: Response) => {\n          const parsed = await parseResponse<HTTPStatus>(res);\n\n          if (res.status >= 400 && res.status <= 599) {\n            throw new FetchError<typeof parsed.status, typeof parsed.data>(\n              parsed.status,\n              parsed.data,\n              parsed.headers,\n              parsed.res,\n            );\n          }\n\n          return parsed;\n        })\n        .finally(() => {\n          if (this.config.timeout) {\n            clearTimeout(timeoutSignal);\n          }\n        });\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;AAMA,OAAO,cAAc;AACrB,OAAO,cAAc;AACrB,OAAO,SAAS;AAKhB,IAAqB,UAArB,MAA6B;AAAA,EAC3B;AAAA,EAEQ,OAA4B,CAAC;AAAA,EAE7B,SAKA;AAAA,EAEA,SAAwB,CAAC;AAAA,EAEzB;AAAA,EAER,YAAY,YAAoD,WAAoB;AAClF,QAAI,WAAY,MAAK,OAAO,IAAI,KAAK,UAAU;AAC/C,QAAI,UAAW,MAAK,YAAY;AAAA,EAClC;AAAA,EAEA,QAAQ,MAAW;AACjB,SAAK,OAAO;AAAA,EACd;AAAA,EAEA,UAAU,QAAuB;AAC/B,SAAK,SAAS;AACd,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,WAAmB;AAC9B,SAAK,YAAY;AACjB,WAAO;AAAA,EACT;AAAA,EAEA,WAAW,QAA6B;AACtC,SAAK,OAAO;AACZ,WAAO;AAAA,EACT;AAAA,EAEA,UAAU,KAAa,YAA6C,CAAC,GAAG;AACtE,SAAK,SAAS,EAAE,KAAK,UAAU;AAC/B,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,MACJ,MACA,QACA,MACA,UACA;AACA,UAAM,YAAY,KAAK,KAAK,UAAU,MAAM,MAAM;AAElD,WAAO,KAAK,eAA2B,WAAW,MAAM,QAAQ;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,iBAAiB,WAAsB,MAAkB,MAAkB;AACzE,WAAO,SAAS,KAAK,MAAM,WAAW,MAAM,IAAI;AAAA,EAClD;AAAA,EAEA,MAAM,eACJ,WACA,MACA,UACA;AACA,WAAO,cAAc,WAAW,MAAM,QAAQ,EAAE,KAAK,YAAU;AAC7D,YAAM,OAAO,EAAE,GAAG,OAAO;AAKzB,UAAI,KAAK,QAAQ;AACf,cAAM,iBAAiB,cAAc,KAAK,MAAM,KAAK,OAAO,KAAK,KAAK,OAAO,SAAS;AACtF,YAAI,gBAAgB;AAClB,eAAK,SAAS;AAAA,QAChB;AAAA,MACF;AAEA,YAAM,MAAM,KAAK,iBAAiB,WAAW,MAAM,YAAY,KAAK,MAAM,SAAS,CAAC;AAEpF,UAAI;AACJ,YAAM,OAAoB,CAAC;AAC3B,UAAI,KAAK,OAAO,SAAS;AACvB,cAAM,aAAa,IAAI,gBAAgB;AACvC,wBAAgB,WAAW,MAAM,WAAW,MAAM,GAAG,KAAK,OAAO,OAAO;AACxE,aAAK,SAAS,WAAW;AAAA,MAC3B;AAEA,aAAO,SAAS,KAAY;AAAA,QAC1B,OAAO,KAAK,SAAS,CAAC;AAAA,QACtB;AAAA,QACA,WAAW,KAAK;AAAA,MAClB,CAAC,EACE,KAAK,OAAO,QAAkB;AAC7B,cAAM,SAAS,MAAM,cAA0B,GAAG;AAElD,YAAI,IAAI,UAAU,OAAO,IAAI,UAAU,KAAK;AAC1C,gBAAM,IAAI;AAAA,YACR,OAAO;AAAA,YACP,OAAO;AAAA,YACP,OAAO;AAAA,YACP,OAAO;AAAA,UACT;AAAA,QACF;AAEA,eAAO;AAAA,MACT,CAAC,EACA,QAAQ,MAAM;AACb,YAAI,KAAK,OAAO,SAAS;AACvB,uBAAa,aAAa;AAAA,QAC5B;AAAA,MACF,CAAC;AAAA,IACL,CAAC;AAAA,EACH;AACF;","names":[]}

package/dist/lib/index.cjs

@@ -4,12 +4,12 @@
 
 
 
-var _chunkHGLVXDVZcjs = require('../chunk-HGLVXDVZ.cjs');
+var _chunkHA453OBWcjs = require('../chunk-HA453OBW.cjs');
 
 
 
 
 
 
-exports.getJSONSchemaDefaults = _chunkHGLVXDVZcjs.getJSONSchemaDefaults; exports.parseResponse = _chunkHGLVXDVZcjs.parseResponse; exports.prepareAuth = _chunkHGLVXDVZcjs.prepareAuth; exports.prepareParams = _chunkHGLVXDVZcjs.prepareParams; exports.prepareServer = _chunkHGLVXDVZcjs.prepareServer;
+exports.getJSONSchemaDefaults = _chunkHA453OBWcjs.getJSONSchemaDefaults; exports.parseResponse = _chunkHA453OBWcjs.parseResponse; exports.prepareAuth = _chunkHA453OBWcjs.prepareAuth; exports.prepareParams = _chunkHA453OBWcjs.prepareParams; exports.prepareServer = _chunkHA453OBWcjs.prepareServer;
 //# sourceMappingURL=index.cjs.map

package/dist/lib/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":""}
+{"version":3,"sources":["/Users/kanadg/Code/readmeio/api/packages/core/dist/lib/index.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACF,yDAA8B;AAC9B;AACE;AACA;AACA;AACA;AACA;AACF,wSAAC","file":"/Users/kanadg/Code/readmeio/api/packages/core/dist/lib/index.cjs"}

package/dist/lib/index.d.cts

@@ -1,6 +1,6 @@
-export { FromSchema } from 'json-schema-to-ts';
 import { SchemaWrapper } from 'oas/operation/get-parameters-as-json-schema';
-import Operation from 'oas/operation';
+import { AuthForHAR } from '@readme/oas-to-har/lib/types';
+import { Operation } from 'oas/operation';
 import Oas from 'oas';
 
 /**
@@ -24,10 +24,7 @@ declare function parseResponse<HTTPStatus extends number = number>(response: Res
     res: Response;
 }>;
 
-declare function prepareAuth(authKey: (number | string)[], operation: Operation): Record<string, string | number | {
-    pass: string | number;
-    user: string | number;
-}>;
+declare function prepareAuth(authKey: (number | string)[], operation: Operation): AuthForHAR;
 
 /**
  * With potentially supplied body and/or metadata we need to run through them against a given API
@@ -37,16 +34,16 @@ declare function prepareAuth(authKey: (number | string)[], operation: Operation)
  */
 declare function prepareParams(operation: Operation, body?: unknown, metadata?: Record<string, unknown>): Promise<{
     body?: any;
-    cookie?: Record<string, string | number | boolean> | undefined;
-    files?: Record<string, Buffer> | undefined;
+    cookie?: Record<string, boolean | number | string>;
+    files?: Record<string, Buffer>;
     formData?: any;
-    header?: Record<string, string | number | boolean> | undefined;
-    path?: Record<string, string | number | boolean> | undefined;
-    query?: Record<string, string | number | boolean> | undefined;
+    header?: Record<string, boolean | number | string>;
+    path?: Record<string, boolean | number | string>;
+    query?: Record<string, boolean | number | string>;
     server?: {
         selected: number;
-        variables: Record<string, string | number>;
-    } | undefined;
+        variables: Record<string, number | string>;
+    };
 }>;
 
 /**
@@ -54,7 +51,7 @@ declare function prepareParams(operation: Operation, body?: unknown, metadata?:
  * any server variables to be supplied to `@readme/oas-to-har`.
  *
  */
-declare function prepareServer(spec: Oas, url: string, variables?: Record<string, string | number>): false | {
+declare function prepareServer(spec: Oas, url: string, variables?: Record<string, number | string>): false | {
     selected: number;
     variables: Record<string, string | number>;
 };

package/dist/lib/index.d.ts

@@ -1,6 +1,6 @@
-export { FromSchema } from 'json-schema-to-ts';
 import { SchemaWrapper } from 'oas/operation/get-parameters-as-json-schema';
-import Operation from 'oas/operation';
+import { AuthForHAR } from '@readme/oas-to-har/lib/types';
+import { Operation } from 'oas/operation';
 import Oas from 'oas';
 
 /**
@@ -24,10 +24,7 @@ declare function parseResponse<HTTPStatus extends number = number>(response: Res
     res: Response;
 }>;
 
-declare function prepareAuth(authKey: (number | string)[], operation: Operation): Record<string, string | number | {
-    pass: string | number;
-    user: string | number;
-}>;
+declare function prepareAuth(authKey: (number | string)[], operation: Operation): AuthForHAR;
 
 /**
  * With potentially supplied body and/or metadata we need to run through them against a given API
@@ -37,16 +34,16 @@ declare function prepareAuth(authKey: (number | string)[], operation: Operation)
  */
 declare function prepareParams(operation: Operation, body?: unknown, metadata?: Record<string, unknown>): Promise<{
     body?: any;
-    cookie?: Record<string, string | number | boolean> | undefined;
-    files?: Record<string, Buffer> | undefined;
+    cookie?: Record<string, boolean | number | string>;
+    files?: Record<string, Buffer>;
     formData?: any;
-    header?: Record<string, string | number | boolean> | undefined;
-    path?: Record<string, string | number | boolean> | undefined;
-    query?: Record<string, string | number | boolean> | undefined;
+    header?: Record<string, boolean | number | string>;
+    path?: Record<string, boolean | number | string>;
+    query?: Record<string, boolean | number | string>;
     server?: {
         selected: number;
-        variables: Record<string, string | number>;
-    } | undefined;
+        variables: Record<string, number | string>;
+    };
 }>;
 
 /**
@@ -54,7 +51,7 @@ declare function prepareParams(operation: Operation, body?: unknown, metadata?:
  * any server variables to be supplied to `@readme/oas-to-har`.
  *
  */
-declare function prepareServer(spec: Oas, url: string, variables?: Record<string, string | number>): false | {
+declare function prepareServer(spec: Oas, url: string, variables?: Record<string, number | string>): false | {
     selected: number;
     variables: Record<string, string | number>;
 };

package/dist/lib/index.js

@@ -4,7 +4,7 @@ import {
   prepareAuth,
   prepareParams,
   prepareServer
-} from "../chunk-ASE5F2OQ.js";
+} from "../chunk-J3R5ZB7L.js";
 export {
   getJSONSchemaDefaults,
   parseResponse,

package/dist/types.cjs

@@ -0,0 +1,6 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/types.ts
+var _jsonschematots = require('json-schema-to-ts');
+
+
+exports.FromSchema = _jsonschematots.FromSchema;
+//# sourceMappingURL=types.cjs.map

package/dist/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/Users/kanadg/Code/readmeio/api/packages/core/dist/types.cjs","../src/types.ts"],"names":[],"mappings":"AAAA;ACAA,mDAA2B;ADE3B;AACE;AACF,gDAAC","file":"/Users/kanadg/Code/readmeio/api/packages/core/dist/types.cjs","sourcesContent":[null,"export { FromSchema } from 'json-schema-to-ts';\n\nexport interface ConfigOptions {\n  /**\n   * Override the default `fetch` request timeout of 30 seconds. This number should be represented\n   * in milliseconds.\n   */\n  timeout?: number;\n}\n\n/**\n * @see {@link https://stackoverflow.com/a/39495173}\n */\ntype Enumerate<N extends number, Acc extends number[] = []> = Acc['length'] extends N\n  ? Acc[number]\n  : Enumerate<N, [...Acc, Acc['length']]>;\n\nexport type HTTPMethodRange<F extends number, T extends number> = Exclude<Enumerate<T>, Enumerate<F>>;\n\nexport interface FetchResponse<HTTPStatus, Data> {\n  data: Data;\n  headers: Headers;\n  res: Response;\n  status: HTTPStatus;\n}\n"]}

package/dist/types.d.cts

@@ -0,0 +1,22 @@
+export { FromSchema } from 'json-schema-to-ts';
+
+interface ConfigOptions {
+    /**
+     * Override the default `fetch` request timeout of 30 seconds. This number should be represented
+     * in milliseconds.
+     */
+    timeout?: number;
+}
+/**
+ * @see {@link https://stackoverflow.com/a/39495173}
+ */
+type Enumerate<N extends number, Acc extends number[] = []> = Acc['length'] extends N ? Acc[number] : Enumerate<N, [...Acc, Acc['length']]>;
+type HTTPMethodRange<F extends number, T extends number> = Exclude<Enumerate<T>, Enumerate<F>>;
+interface FetchResponse<HTTPStatus, Data> {
+    data: Data;
+    headers: Headers;
+    res: Response;
+    status: HTTPStatus;
+}
+
+export type { ConfigOptions, FetchResponse, HTTPMethodRange };

package/dist/types.d.ts

@@ -0,0 +1,22 @@
+export { FromSchema } from 'json-schema-to-ts';
+
+interface ConfigOptions {
+    /**
+     * Override the default `fetch` request timeout of 30 seconds. This number should be represented
+     * in milliseconds.
+     */
+    timeout?: number;
+}
+/**
+ * @see {@link https://stackoverflow.com/a/39495173}
+ */
+type Enumerate<N extends number, Acc extends number[] = []> = Acc['length'] extends N ? Acc[number] : Enumerate<N, [...Acc, Acc['length']]>;
+type HTTPMethodRange<F extends number, T extends number> = Exclude<Enumerate<T>, Enumerate<F>>;
+interface FetchResponse<HTTPStatus, Data> {
+    data: Data;
+    headers: Headers;
+    res: Response;
+    status: HTTPStatus;
+}
+
+export type { ConfigOptions, FetchResponse, HTTPMethodRange };

package/dist/types.js

@@ -0,0 +1,6 @@
+// src/types.ts
+import { FromSchema } from "json-schema-to-ts";
+export {
+  FromSchema
+};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["export { FromSchema } from 'json-schema-to-ts';\n\nexport interface ConfigOptions {\n  /**\n   * Override the default `fetch` request timeout of 30 seconds. This number should be represented\n   * in milliseconds.\n   */\n  timeout?: number;\n}\n\n/**\n * @see {@link https://stackoverflow.com/a/39495173}\n */\ntype Enumerate<N extends number, Acc extends number[] = []> = Acc['length'] extends N\n  ? Acc[number]\n  : Enumerate<N, [...Acc, Acc['length']]>;\n\nexport type HTTPMethodRange<F extends number, T extends number> = Exclude<Enumerate<T>, Enumerate<F>>;\n\nexport interface FetchResponse<HTTPStatus, Data> {\n  data: Data;\n  headers: Headers;\n  res: Response;\n  status: HTTPStatus;\n}\n"],"mappings":";AAAA,SAAS,kBAAkB;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readme/api-core",
-  "version": "7.0.0-beta.1",
+  "version": "7.0.0-beta.10",
   "description": "The magic behind `api` 🧙",
   "sideEffects": false,
   "type": "module",
@@ -17,6 +17,10 @@
       "require": "./dist/lib/index.cjs",
       "import": "./dist/lib/index.js"
     },
+    "./types": {
+      "require": "./dist/types.d.cjs",
+      "import": "./dist/types.d.js"
+    },
     "./package.json": "./package.json"
   },
   "main": "dist/index.cjs",
@@ -45,27 +49,27 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@readme/oas-to-har": "^23.0.12",
+    "@readme/oas-to-har": "^24.0.0",
     "caseless": "^0.12.0",
     "datauri": "^4.1.0",
     "fetch-har": "^11.0.1",
-    "json-schema-to-ts": "^2.9.2",
+    "json-schema-to-ts": "^3.0.0",
     "json-schema-traverse": "^1.0.0",
     "lodash.merge": "^4.6.2",
-    "oas": "^23.0.0",
+    "oas": "^25.0.1",
     "remove-undefined-objects": "^5.0.0"
   },
   "devDependencies": {
-    "@api/test-utils": "^7.0.0-beta.1",
+    "@api/test-utils": "^7.0.0-beta.10",
     "@readme/oas-examples": "^5.12.0",
-    "@types/caseless": "^0.12.3",
-    "@types/lodash.merge": "^4.6.7",
-    "@vitest/coverage-v8": "^0.34.4",
-    "fetch-mock": "^9.11.0",
-    "get-stream": "^8.0.1",
+    "@types/caseless": "^0.12.5",
+    "@types/lodash.merge": "^4.6.9",
+    "@vitest/coverage-v8": "^2.1.3",
+    "fetch-mock": "^11.1.3",
+    "get-stream": "^9.0.1",
     "typescript": "^5.2.2",
-    "vitest": "^0.34.5"
+    "vitest": "^2.1.3"
   },
   "prettier": "@readme/eslint-config/prettier",
-  "gitHead": "e31539d88b5af53ed7be05495329de1c2a70c93f"
+  "gitHead": "4a34d5d4642a94928bd4c299d8c45c6b64ee6f20"
 }

package/src/index.ts

@@ -1,6 +1,8 @@
+import type { ConfigOptions } from './types.js';
+import type { AuthForHAR, DataForHAR } from '@readme/oas-to-har/lib/types';
 import type { Har } from 'har-format';
-import type Operation from 'oas/operation';
-import type { HttpMethods, OASDocument } from 'oas/rmoas.types';
+import type { Operation } from 'oas/operation';
+import type { HttpMethods, OASDocument } from 'oas/types';
 
 import oasToHar from '@readme/oas-to-har';
 import fetchHar from 'fetch-har';
@@ -9,28 +11,6 @@ import Oas from 'oas';
 import FetchError from './errors/fetchError.js';
 import { parseResponse, prepareAuth, prepareParams, prepareServer } from './lib/index.js';
 
-export interface ConfigOptions {
-  /**
-   * Override the default `fetch` request timeout of 30 seconds. This number should be represented
-   * in milliseconds.
-   */
-  timeout?: number;
-}
-
-export interface FetchResponse<HTTPStatus, Data> {
-  data: Data;
-  headers: Headers;
-  res: Response;
-  status: HTTPStatus;
-}
-
-// https://stackoverflow.com/a/39495173
-type Enumerate<N extends number, Acc extends number[] = []> = Acc['length'] extends N
-  ? Acc[number]
-  : Enumerate<N, [...Acc, Acc['length']]>;
-
-export type HTTPMethodRange<F extends number, T extends number> = Exclude<Enumerate<T>, Enumerate<F>>;
-
 export default class APICore {
   spec!: Oas;
 
@@ -40,14 +20,14 @@ export default class APICore {
     | false
     | {
         url: string;
-        variables?: Record<string, string | number>;
+        variables?: Record<string, number | string>;
       } = false;
 
   private config: ConfigOptions = {};
 
   private userAgent!: string;
 
-  constructor(definition?: Record<string, unknown> | OASDocument, userAgent?: string) {
+  constructor(definition?: OASDocument | Record<string, unknown>, userAgent?: string) {
     if (definition) this.spec = Oas.init(definition);
     if (userAgent) this.userAgent = userAgent;
   }
@@ -66,12 +46,12 @@ export default class APICore {
     return this;
   }
 
-  setAuth(...values: string[] | number[]) {
+  setAuth(...values: number[] | string[]) {
     this.auth = values;
     return this;
   }
 
-  setServer(url: string, variables: Record<string, string | number> = {}) {
+  setServer(url: string, variables: Record<string, number | string> = {}) {
     this.server = { url, variables };
     return this;
   }
@@ -87,6 +67,15 @@ export default class APICore {
     return this.fetchOperation<HTTPStatus>(operation, body, metadata);
   }
 
+  /**
+   * Retrieve a HAR for a given HTTP request.
+   *
+   * @internal
+   */
+  getHARForRequest(operation: Operation, data: DataForHAR, auth: AuthForHAR) {
+    return oasToHar(this.spec, operation, data, auth);
+  }
+
   async fetchOperation<HTTPStatus extends number = number>(
     operation: Operation,
     body?: unknown,
@@ -105,8 +94,7 @@ export default class APICore {
         }
       }
 
-      // @ts-expect-error `this.auth` typing is off. FIXME
-      const har = oasToHar(this.spec, operation, data, prepareAuth(this.auth, operation));
+      const har = this.getHARForRequest(operation, data, prepareAuth(this.auth, operation));
 
       let timeoutSignal: NodeJS.Timeout;
       const init: RequestInit = {};

package/src/lib/getJSONSchemaDefaults.ts

@@ -1,5 +1,5 @@
 import type { SchemaWrapper } from 'oas/operation/get-parameters-as-json-schema';
-import type { SchemaObject } from 'oas/rmoas.types';
+import type { SchemaObject } from 'oas/types';
 
 import traverse from 'json-schema-traverse';
 
@@ -26,7 +26,7 @@ export default function getJSONSchemaDefaults(jsonSchemas: SchemaWrapper[]) {
           parentPointer?: string,
           parentKeyword?: string,
           parentSchema?: SchemaObject,
-          indexProperty?: string | number,
+          indexProperty?: number | string,
         ) => {
           if (!pointer.startsWith('/properties/')) {
             return;

package/src/lib/index.ts

@@ -1,9 +1,7 @@
-import type { FromSchema } from 'json-schema-to-ts';
-
 import getJSONSchemaDefaults from './getJSONSchemaDefaults.js';
 import parseResponse from './parseResponse.js';
 import prepareAuth from './prepareAuth.js';
 import prepareParams from './prepareParams.js';
 import prepareServer from './prepareServer.js';
 
-export { FromSchema, getJSONSchemaDefaults, parseResponse, prepareAuth, prepareParams, prepareServer };
+export { getJSONSchemaDefaults, parseResponse, prepareAuth, prepareParams, prepareServer };

package/src/lib/parseResponse.ts

@@ -4,13 +4,14 @@ export default async function parseResponse<HTTPStatus extends number = number>(
   const contentType = response.headers.get('Content-Type');
   const isJSON = contentType && (matchesMimeType.json(contentType) || matchesMimeType.wildcard(contentType));
 
-  const responseBody = await response.text();
+  const responseBody = await response.clone().text();
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   let data: any = responseBody;
   if (isJSON) {
     try {
       data = JSON.parse(responseBody);
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
     } catch (e) {
       // If our JSON parsing failed then we can just return plaintext instead.
     }