@tryfinch/finch-api 2.0.0 → 3.0.0

package/{dist/cjs/core.js → core.js}

@@ -1,34 +1,43 @@
 'use strict';
-var __awaiter =
-  (this && this.__awaiter) ||
-  function (thisArg, _arguments, P, generator) {
-    function adopt(value) {
-      return value instanceof P ? value : (
-          new P(function (resolve) {
-            resolve(value);
-          })
-        );
-    }
-    return new (P || (P = Promise))(function (resolve, reject) {
-      function fulfilled(value) {
-        try {
-          step(generator.next(value));
-        } catch (e) {
-          reject(e);
-        }
-      }
-      function rejected(value) {
-        try {
-          step(generator['throw'](value));
-        } catch (e) {
-          reject(e);
-        }
-      }
-      function step(result) {
-        result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create ?
+    function (o, m, k, k2) {
+      if (k2 === undefined) k2 = k;
+      var desc = Object.getOwnPropertyDescriptor(m, k);
+      if (!desc || ('get' in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+        desc = {
+          enumerable: true,
+          get: function () {
+            return m[k];
+          },
+        };
       }
-      step((generator = generator.apply(thisArg, _arguments || [])).next());
+      Object.defineProperty(o, k2, desc);
+    }
+  : function (o, m, k, k2) {
+      if (k2 === undefined) k2 = k;
+      o[k2] = m[k];
     });
+var __setModuleDefault =
+  (this && this.__setModuleDefault) ||
+  (Object.create ?
+    function (o, v) {
+      Object.defineProperty(o, 'default', { enumerable: true, value: v });
+    }
+  : function (o, v) {
+      o['default'] = v;
+    });
+var __importStar =
+  (this && this.__importStar) ||
+  function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null)
+      for (var k in mod)
+        if (k !== 'default' && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
   };
 var __classPrivateFieldSet =
   (this && this.__classPrivateFieldSet) ||
@@ -57,104 +66,6 @@ var __classPrivateFieldGet =
       : state.get(receiver)
     );
   };
-var __rest =
-  (this && this.__rest) ||
-  function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0) t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === 'function')
-      for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-        if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i])) t[p[i]] = s[p[i]];
-      }
-    return t;
-  };
-var __await =
-  (this && this.__await) ||
-  function (v) {
-    return this instanceof __await ? ((this.v = v), this) : new __await(v);
-  };
-var __asyncGenerator =
-  (this && this.__asyncGenerator) ||
-  function (thisArg, _arguments, generator) {
-    if (!Symbol.asyncIterator) throw new TypeError('Symbol.asyncIterator is not defined.');
-    var g = generator.apply(thisArg, _arguments || []),
-      i,
-      q = [];
-    return (
-      (i = {}),
-      verb('next'),
-      verb('throw'),
-      verb('return'),
-      (i[Symbol.asyncIterator] = function () {
-        return this;
-      }),
-      i
-    );
-    function verb(n) {
-      if (g[n])
-        i[n] = function (v) {
-          return new Promise(function (a, b) {
-            q.push([n, v, a, b]) > 1 || resume(n, v);
-          });
-        };
-    }
-    function resume(n, v) {
-      try {
-        step(g[n](v));
-      } catch (e) {
-        settle(q[0][3], e);
-      }
-    }
-    function step(r) {
-      r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r);
-    }
-    function fulfill(value) {
-      resume('next', value);
-    }
-    function reject(value) {
-      resume('throw', value);
-    }
-    function settle(f, v) {
-      if ((f(v), q.shift(), q.length)) resume(q[0][0], q[0][1]);
-    }
-  };
-var __asyncValues =
-  (this && this.__asyncValues) ||
-  function (o) {
-    if (!Symbol.asyncIterator) throw new TypeError('Symbol.asyncIterator is not defined.');
-    var m = o[Symbol.asyncIterator],
-      i;
-    return m ?
-        m.call(o)
-      : ((o = typeof __values === 'function' ? __values(o) : o[Symbol.iterator]()),
-        (i = {}),
-        verb('next'),
-        verb('throw'),
-        verb('return'),
-        (i[Symbol.asyncIterator] = function () {
-          return this;
-        }),
-        i);
-    function verb(n) {
-      i[n] =
-        o[n] &&
-        function (v) {
-          return new Promise(function (resolve, reject) {
-            (v = o[n](v)), settle(resolve, reject, v.done, v.value);
-          });
-        };
-    }
-    function settle(resolve, reject, d, v) {
-      Promise.resolve(v).then(function (v) {
-        resolve({ value: v, done: d });
-      }, reject);
-    }
-  };
-var __importDefault =
-  (this && this.__importDefault) ||
-  function (mod) {
-    return mod && mod.__esModule ? mod : { default: mod };
-  };
 var _AbstractPage_client;
 Object.defineProperty(exports, '__esModule', { value: true });
 exports.getHeader =
@@ -177,14 +88,14 @@ exports.getHeader =
   exports.multipartFormRequestOptions =
   exports.maybeMultipartFormRequestOptions =
     void 0;
-const qs_1 = __importDefault(require('qs'));
-const version_1 = require('./version');
-const streaming_1 = require('./streaming');
-const error_1 = require('./error');
+const qs = __importStar(require('qs'));
+const version_1 = require('./version.js');
+const streaming_1 = require('./streaming.js');
+const error_1 = require('./error.js');
 const agent_1 = require('@tryfinch/finch-api/_shims/agent');
 const fetch_1 = require('@tryfinch/finch-api/_shims/fetch');
-const uploads_1 = require('./uploads');
-var uploads_2 = require('./uploads');
+const uploads_1 = require('./uploads.js');
+var uploads_2 = require('./uploads.js');
 Object.defineProperty(exports, 'maybeMultipartFormRequestOptions', {
   enumerable: true,
   get: function () {
@@ -232,13 +143,13 @@ class APIClient {
    *  }
    */
   defaultHeaders() {
-    return Object.assign(
-      Object.assign(
-        { Accept: 'application/json', 'Content-Type': 'application/json', 'User-Agent': this.getUserAgent() },
-        getPlatformHeaders(),
-      ),
-      this.authHeaders(),
-    );
+    return {
+      Accept: 'application/json',
+      'Content-Type': 'application/json',
+      'User-Agent': this.getUserAgent(),
+      ...getPlatformHeaders(),
+      ...this.authHeaders(),
+    };
   }
   /**
    * Override this to add your own headers validation:
@@ -259,28 +170,28 @@ class APIClient {
     return `stainless-node-retry-${uuid4()}`;
   }
   get(path, opts) {
-    return this.request(Object.assign({ method: 'get', path }, opts));
+    return this.request({ method: 'get', path, ...opts });
   }
   post(path, opts) {
-    return this.request(Object.assign({ method: 'post', path }, opts));
+    return this.request({ method: 'post', path, ...opts });
   }
   patch(path, opts) {
-    return this.request(Object.assign({ method: 'patch', path }, opts));
+    return this.request({ method: 'patch', path, ...opts });
   }
   put(path, opts) {
-    return this.request(Object.assign({ method: 'put', path }, opts));
+    return this.request({ method: 'put', path, ...opts });
   }
   delete(path, opts) {
-    return this.request(Object.assign({ method: 'delete', path }, opts));
+    return this.request({ method: 'delete', path, ...opts });
   }
   getAPIList(path, Page, opts) {
-    return this.requestAPIList(Page, Object.assign({ method: 'get', path }, opts));
+    return this.requestAPIList(Page, { method: 'get', path, ...opts });
   }
   buildRequest(options) {
     var _a, _b, _c;
     const { method, path, query, headers: headers = {} } = options;
     const body =
-      (0, uploads_1.isMultipartBody)(options.body) ? options.body.__multipartBody__
+      (0, uploads_1.isMultipartBody)(options.body) ? options.body.body
       : options.body ? JSON.stringify(options.body, null, 2)
       : null;
     const contentLength = typeof body === 'string' ? body.length.toString() : null;
@@ -298,23 +209,23 @@ class APIClient {
       if (!options.idempotencyKey) options.idempotencyKey = this.defaultIdempotencyKey();
       headers[this.idempotencyHeader] = options.idempotencyKey;
     }
-    const reqHeaders = Object.assign(
-      Object.assign(
-        Object.assign({}, contentLength && { 'Content-Length': contentLength }),
-        this.defaultHeaders(),
-      ),
-      headers,
-    );
+    const reqHeaders = {
+      ...(contentLength && { 'Content-Length': contentLength }),
+      ...this.defaultHeaders(),
+      ...headers,
+    };
     // let builtin fetch set the Content-Type for multipart bodies
     if ((0, uploads_1.isMultipartBody)(options.body) && !fetch_1.isPolyfilled) {
       delete reqHeaders['Content-Type'];
     }
     // Strip any headers being explicitly omitted with null
     Object.keys(reqHeaders).forEach((key) => reqHeaders[key] === null && delete reqHeaders[key]);
-    const req = Object.assign(
-      Object.assign(Object.assign({ method }, body && { body }), { headers: reqHeaders }),
-      httpAgent && { agent: httpAgent },
-    );
+    const req = {
+      method,
+      ...(body && { body: body }),
+      headers: reqHeaders,
+      ...(httpAgent && { agent: httpAgent }),
+    };
     this.validateHeaders(reqHeaders, headers);
     return { req, url, timeout };
   }
@@ -324,66 +235,60 @@ class APIClient {
    * This is useful for cases where you want to add certain headers based off of
    * the request properties, e.g. `method` or `url`.
    */
-  prepareRequest(request, { url }) {
-    return __awaiter(this, void 0, void 0, function* () {});
-  }
+  async prepareRequest(request, { url }) {}
   makeStatusError(status, error, message, headers) {
     return error_1.APIError.generate(status, error, message, headers);
   }
-  request(options, retriesRemaining) {
+  async request(options, retriesRemaining) {
     var _a;
     if (retriesRemaining === void 0) {
       retriesRemaining = (_a = options.maxRetries) !== null && _a !== void 0 ? _a : this.maxRetries;
     }
-    return __awaiter(this, void 0, void 0, function* () {
-      const { req, url, timeout } = this.buildRequest(options);
-      yield this.prepareRequest(req, { url });
-      this.debug('request', url, options, req.headers);
-      const controller = new AbortController();
-      const response = yield this.fetchWithTimeout(url, req, timeout, controller).catch(exports.castToError);
-      if (response instanceof Error) {
-        if (retriesRemaining) return this.retryRequest(options, retriesRemaining);
-        if (response.name === 'AbortError') throw new error_1.APIConnectionTimeoutError();
-        throw new error_1.APIConnectionError({ cause: response });
-      }
-      const responseHeaders = (0, exports.createResponseHeaders)(response.headers);
-      if (!response.ok) {
-        if (retriesRemaining && this.shouldRetry(response)) {
-          return this.retryRequest(options, retriesRemaining, responseHeaders);
-        }
-        const errText = yield response.text().catch(() => 'Unknown');
-        const errJSON = (0, exports.safeJSON)(errText);
-        const errMessage = errJSON ? undefined : errText;
-        this.debug('response', response.status, url, responseHeaders, errMessage);
-        const err = this.makeStatusError(response.status, errJSON, errMessage, responseHeaders);
-        throw err;
-      }
-      if (options.stream) {
-        // Note: there is an invariant here that isn't represented in the type system
-        // that if you set `stream: true` the response type must also be `Stream<T>`
-        return new streaming_1.Stream(response, controller);
+    const { req, url, timeout } = this.buildRequest(options);
+    await this.prepareRequest(req, { url });
+    this.debug('request', url, options, req.headers);
+    const controller = new AbortController();
+    const response = await this.fetchWithTimeout(url, req, timeout, controller).catch(exports.castToError);
+    if (response instanceof Error) {
+      if (retriesRemaining) return this.retryRequest(options, retriesRemaining);
+      if (response.name === 'AbortError') throw new error_1.APIConnectionTimeoutError();
+      throw new error_1.APIConnectionError({ cause: response });
+    }
+    const responseHeaders = (0, exports.createResponseHeaders)(response.headers);
+    if (!response.ok) {
+      if (retriesRemaining && this.shouldRetry(response)) {
+        return this.retryRequest(options, retriesRemaining, responseHeaders);
       }
-      const contentType = response.headers.get('content-type');
-      if (
-        contentType === null || contentType === void 0 ? void 0 : contentType.includes('application/json')
-      ) {
-        const json = yield response.json();
-        if (typeof json === 'object' && json != null) {
-          /** @deprecated – we expect to change this interface in the near future. */
-          Object.defineProperty(json, 'responseHeaders', {
-            enumerable: false,
-            writable: false,
-            value: responseHeaders,
-          });
-        }
-        this.debug('response', response.status, url, responseHeaders, json);
-        return json;
+      const errText = await response.text().catch(() => 'Unknown');
+      const errJSON = (0, exports.safeJSON)(errText);
+      const errMessage = errJSON ? undefined : errText;
+      this.debug('response', response.status, url, responseHeaders, errMessage);
+      const err = this.makeStatusError(response.status, errJSON, errMessage, responseHeaders);
+      throw err;
+    }
+    if (options.stream) {
+      // Note: there is an invariant here that isn't represented in the type system
+      // that if you set `stream: true` the response type must also be `Stream<T>`
+      return new streaming_1.Stream(response, controller);
+    }
+    const contentType = response.headers.get('content-type');
+    if (contentType === null || contentType === void 0 ? void 0 : contentType.includes('application/json')) {
+      const json = await response.json();
+      if (typeof json === 'object' && json != null) {
+        /** @deprecated – we expect to change this interface in the near future. */
+        Object.defineProperty(json, 'responseHeaders', {
+          enumerable: false,
+          writable: false,
+          value: responseHeaders,
+        });
       }
-      // TODO handle blob, arraybuffer, other content types, etc.
-      const text = response.text();
-      this.debug('response', response.status, url, responseHeaders, text);
-      return text;
-    });
+      this.debug('response', response.status, url, responseHeaders, json);
+      return json;
+    }
+    // TODO handle blob, arraybuffer, other content types, etc.
+    const text = response.text();
+    this.debug('response', response.status, url, responseHeaders, text);
+    return text;
   }
   requestAPIList(Page, options) {
     const requestPromise = this.request(options);
@@ -394,23 +299,24 @@ class APIClient {
       isAbsoluteURL(path) ?
         new URL(path)
       : new URL(this.baseURL + (this.baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
+    const defaultQuery = this.defaultQuery();
+    if (!isEmptyObj(defaultQuery)) {
+      query = { ...defaultQuery, ...query };
+    }
     if (query) {
-      url.search = qs_1.default.stringify(query, this.qsOptions());
+      url.search = qs.stringify(query, this.qsOptions());
     }
     return url.toString();
   }
-  fetchWithTimeout(url, _a = {}, ms, controller) {
-    var { signal } = _a,
-      options = __rest(_a, ['signal']);
-    return __awaiter(this, void 0, void 0, function* () {
-      if (signal) signal.addEventListener('abort', controller.abort);
-      const timeout = setTimeout(() => controller.abort(), ms);
-      return this.getRequestClient()
-        .fetch(url, Object.assign({ signal: controller.signal }, options))
-        .finally(() => {
-          clearTimeout(timeout);
-        });
-    });
+  async fetchWithTimeout(url, init, ms, controller) {
+    const { signal, ...options } = init || {};
+    if (signal) signal.addEventListener('abort', () => controller.abort());
+    const timeout = setTimeout(() => controller.abort(), ms);
+    return this.getRequestClient()
+      .fetch(url, { signal: controller.signal, ...options })
+      .finally(() => {
+        clearTimeout(timeout);
+      });
   }
   getRequestClient() {
     return { fetch: this.fetch };
@@ -429,23 +335,21 @@ class APIClient {
     if (response.status >= 500) return true;
     return false;
   }
-  retryRequest(options, retriesRemaining, responseHeaders) {
+  async retryRequest(options, retriesRemaining, responseHeaders) {
     var _a;
-    return __awaiter(this, void 0, void 0, function* () {
-      retriesRemaining -= 1;
-      // About the Retry-After header: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
-      //
-      // TODO: we may want to handle the case where the header is using the http-date syntax: "Retry-After: <http-date>".
-      // See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After#syntax for details.
-      const retryAfter = parseInt(
-        (responseHeaders === null || responseHeaders === void 0 ? void 0 : responseHeaders['retry-after']) ||
-          '',
-      );
-      const maxRetries = (_a = options.maxRetries) !== null && _a !== void 0 ? _a : this.maxRetries;
-      const timeout = this.calculateRetryTimeoutSeconds(retriesRemaining, retryAfter, maxRetries) * 1000;
-      yield sleep(timeout);
-      return this.request(options, retriesRemaining);
-    });
+    retriesRemaining -= 1;
+    // About the Retry-After header: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
+    //
+    // TODO: we may want to handle the case where the header is using the http-date syntax: "Retry-After: <http-date>".
+    // See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After#syntax for details.
+    const retryAfter = parseInt(
+      (responseHeaders === null || responseHeaders === void 0 ? void 0 : responseHeaders['retry-after']) ||
+        '',
+    );
+    const maxRetries = (_a = options.maxRetries) !== null && _a !== void 0 ? _a : this.maxRetries;
+    const timeout = this.calculateRetryTimeoutSeconds(retriesRemaining, retryAfter, maxRetries) * 1000;
+    await sleep(timeout);
+    return this.request(options, retriesRemaining);
   }
   calculateRetryTimeoutSeconds(retriesRemaining, retryAfter, maxRetries) {
     const initialRetryDelay = 0.5;
@@ -495,72 +399,44 @@ class AbstractPage {
     if (!items.length) return false;
     return this.nextPageInfo() != null;
   }
-  getNextPage() {
-    return __awaiter(this, void 0, void 0, function* () {
-      const nextInfo = this.nextPageInfo();
-      if (!nextInfo) {
-        throw new Error(
-          'No next page expected; please check `.hasNextPage()` before calling `.getNextPage()`.',
-        );
-      }
-      const nextOptions = Object.assign({}, this.options);
-      if ('params' in nextInfo) {
-        nextOptions.query = Object.assign(Object.assign({}, nextOptions.query), nextInfo.params);
-      } else if ('url' in nextInfo) {
-        const params = [...Object.entries(nextOptions.query || {}), ...nextInfo.url.searchParams.entries()];
-        for (const [key, value] of params) {
-          nextInfo.url.searchParams.set(key, value);
-        }
-        nextOptions.query = undefined;
-        nextOptions.path = nextInfo.url.toString();
-      }
-      return yield __classPrivateFieldGet(this, _AbstractPage_client, 'f').requestAPIList(
-        this.constructor,
-        nextOptions,
+  async getNextPage() {
+    const nextInfo = this.nextPageInfo();
+    if (!nextInfo) {
+      throw new Error(
+        'No next page expected; please check `.hasNextPage()` before calling `.getNextPage()`.',
       );
-    });
-  }
-  iterPages() {
-    return __asyncGenerator(this, arguments, function* iterPages_1() {
-      // eslint-disable-next-line @typescript-eslint/no-this-alias
-      let page = this;
-      yield yield __await(page);
-      while (page.hasNextPage()) {
-        page = yield __await(page.getNextPage());
-        yield yield __await(page);
+    }
+    const nextOptions = { ...this.options };
+    if ('params' in nextInfo) {
+      nextOptions.query = { ...nextOptions.query, ...nextInfo.params };
+    } else if ('url' in nextInfo) {
+      const params = [...Object.entries(nextOptions.query || {}), ...nextInfo.url.searchParams.entries()];
+      for (const [key, value] of params) {
+        nextInfo.url.searchParams.set(key, value);
       }
-    });
+      nextOptions.query = undefined;
+      nextOptions.path = nextInfo.url.toString();
+    }
+    return await __classPrivateFieldGet(this, _AbstractPage_client, 'f').requestAPIList(
+      this.constructor,
+      nextOptions,
+    );
+  }
+  async *iterPages() {
+    // eslint-disable-next-line @typescript-eslint/no-this-alias
+    let page = this;
+    yield page;
+    while (page.hasNextPage()) {
+      page = await page.getNextPage();
+      yield page;
+    }
   }
-  [((_AbstractPage_client = new WeakMap()), Symbol.asyncIterator)]() {
-    return __asyncGenerator(this, arguments, function* _a() {
-      var _b, e_1, _c, _d;
-      try {
-        for (
-          var _e = true, _f = __asyncValues(this.iterPages()), _g;
-          (_g = yield __await(_f.next())), (_b = _g.done), !_b;
-
-        ) {
-          _d = _g.value;
-          _e = false;
-          try {
-            const page = _d;
-            for (const item of page.getPaginatedItems()) {
-              yield yield __await(item);
-            }
-          } finally {
-            _e = true;
-          }
-        }
-      } catch (e_1_1) {
-        e_1 = { error: e_1_1 };
-      } finally {
-        try {
-          if (!_e && !_b && (_c = _f.return)) yield __await(_c.call(_f));
-        } finally {
-          if (e_1) throw e_1.error;
-        }
+  async *[((_AbstractPage_client = new WeakMap()), Symbol.asyncIterator)]() {
+    for await (const page of this.iterPages()) {
+      for (const item of page.getPaginatedItems()) {
+        yield item;
       }
-    });
+    }
   }
 }
 exports.AbstractPage = AbstractPage;
@@ -587,45 +463,27 @@ class PagePromise extends Promise {
    *      console.log(item)
    *    }
    */
-  [Symbol.asyncIterator]() {
-    return __asyncGenerator(this, arguments, function* _a() {
-      var _b, e_2, _c, _d;
-      const page = yield __await(this);
-      try {
-        for (
-          var _e = true, page_1 = __asyncValues(page), page_1_1;
-          (page_1_1 = yield __await(page_1.next())), (_b = page_1_1.done), !_b;
-
-        ) {
-          _d = page_1_1.value;
-          _e = false;
-          try {
-            const item = _d;
-            yield yield __await(item);
-          } finally {
-            _e = true;
-          }
-        }
-      } catch (e_2_1) {
-        e_2 = { error: e_2_1 };
-      } finally {
-        try {
-          if (!_e && !_b && (_c = page_1.return)) yield __await(_c.call(page_1));
-        } finally {
-          if (e_2) throw e_2.error;
-        }
-      }
-    });
+  async *[Symbol.asyncIterator]() {
+    const page = await this;
+    for await (const item of page) {
+      yield item;
+    }
   }
 }
 exports.PagePromise = PagePromise;
 const createResponseHeaders = (headers) => {
-  return new Proxy(Object.fromEntries(headers.entries()), {
-    get(target, name) {
-      const key = name.toString();
-      return target[key.toLowerCase()] || target[key];
+  return new Proxy(
+    Object.fromEntries(
+      // @ts-ignore
+      headers.entries(),
+    ),
+    {
+      get(target, name) {
+        const key = name.toString();
+        return target[key.toLowerCase()] || target[key];
+      },
     },
-  });
+  );
 };
 exports.createResponseHeaders = createResponseHeaders;
 // This is required so that we can determine if a given object matches the RequestOptions