@stigg/typescript 0.1.0-alpha.1 → 0.1.0-alpha.11

package/src/client.ts

@@ -11,6 +11,7 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
+import * as qs from './internal/qs';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Pagination from './core/pagination';
@@ -18,13 +19,7 @@ import { AbstractPage, type MyCursorIDPageParams, MyCursorIDPageResponse } from
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
-import {
-  V1,
-  V1CreateEventParams,
-  V1CreateEventResponse,
-  V1CreateUsageParams,
-  V1CreateUsageResponse,
-} from './resources/v1/v1';
+import { V1 } from './resources/v1/v1';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -135,7 +130,7 @@ export class Stigg {
    * API Client for interfacing with the Stigg API.
    *
    * @param {string | undefined} [opts.apiKey=process.env['STIGG_API_KEY'] ?? undefined]
-   * @param {string} [opts.baseURL=process.env['STIGG_BASE_URL'] ?? https://api.example.com] - Override the default base URL for the API.
+   * @param {string} [opts.baseURL=process.env['STIGG_BASE_URL'] ?? https://api.stigg.io] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
    * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
@@ -157,7 +152,7 @@ export class Stigg {
     const options: ClientOptions = {
       apiKey,
       ...opts,
-      baseURL: baseURL || `https://api.example.com`,
+      baseURL: baseURL || `https://api.stigg.io`,
     };
 
     this.baseURL = options.baseURL!;
@@ -203,7 +198,7 @@ export class Stigg {
    * Check whether the base URL is set to its default.
    */
   #baseURLOverridden(): boolean {
-    return this.baseURL !== 'https://api.example.com';
+    return this.baseURL !== 'https://api.stigg.io';
   }
 
   protected defaultQuery(): Record<string, string | undefined> | undefined {
@@ -218,24 +213,8 @@ export class Stigg {
     return buildHeaders([{ 'X-API-KEY': this.apiKey }]);
   }
 
-  /**
-   * Basic re-implementation of `qs.stringify` for primitive types.
-   */
   protected stringifyQuery(query: Record<string, unknown>): string {
-    return Object.entries(query)
-      .filter(([_, value]) => typeof value !== 'undefined')
-      .map(([key, value]) => {
-        if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-          return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-        }
-        if (value === null) {
-          return `${encodeURIComponent(key)}=`;
-        }
-        throw new Errors.StiggError(
-          `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
-        );
-      })
-      .join('&');
+    return qs.stringify(query, { arrayFormat: 'comma' });
   }
 
   private getUserAgent(): string {
@@ -456,7 +435,7 @@ export class Stigg {
       loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
 
       const errText = await response.text().catch((err: any) => castToError(err).message);
-      const errJSON = safeJSON(errText);
+      const errJSON = safeJSON(errText) as any;
       const errMessage = errJSON ? undefined : errText;
 
       loggerFor(this).debug(
@@ -493,9 +472,14 @@ export class Stigg {
   getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(
     path: string,
     Page: new (...args: any[]) => PageClass,
-    opts?: RequestOptions,
+    opts?: PromiseOrValue<RequestOptions>,
   ): Pagination.PagePromise<PageClass, Item> {
-    return this.requestAPIList(Page, { method: 'get', path, ...opts });
+    return this.requestAPIList(
+      Page,
+      opts && 'then' in opts ?
+        opts.then((opts) => ({ method: 'get', path, ...opts }))
+      : { method: 'get', path, ...opts },
+    );
   }
 
   requestAPIList<
@@ -503,7 +487,7 @@ export class Stigg {
     PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>,
   >(
     Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass,
-    options: FinalRequestOptions,
+    options: PromiseOrValue<FinalRequestOptions>,
   ): Pagination.PagePromise<PageClass, Item> {
     const request = this.makeRequest(options, null, undefined);
     return new Pagination.PagePromise<PageClass, Item>(this as any as Stigg, request, Page);
@@ -516,9 +500,10 @@ export class Stigg {
     controller: AbortController,
   ): Promise<Response> {
     const { signal, method, ...options } = init || {};
-    if (signal) signal.addEventListener('abort', () => controller.abort());
+    const abort = this._makeAbort(controller);
+    if (signal) signal.addEventListener('abort', abort, { once: true });
 
-    const timeout = setTimeout(() => controller.abort(), ms);
+    const timeout = setTimeout(abort, ms);
 
     const isReadableBody =
       ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) ||
@@ -685,6 +670,12 @@ export class Stigg {
     return headers.values;
   }
 
+  private _makeAbort(controller: AbortController) {
+    // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
+    //       would capture all request options, and cause a memory leak.
+    return () => controller.abort();
+  }
+
   private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
     bodyHeaders: HeadersLike;
     body: BodyInit | undefined;
@@ -717,6 +708,14 @@ export class Stigg {
         (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))
     ) {
       return { bodyHeaders: undefined, body: Shims.ReadableStreamFrom(body as AsyncIterable<Uint8Array>) };
+    } else if (
+      typeof body === 'object' &&
+      headers.values.get('content-type') === 'application/x-www-form-urlencoded'
+    ) {
+      return {
+        bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
+        body: this.stringifyQuery(body as Record<string, unknown>),
+      };
     } else {
       return this.#encoder({ body, headers });
     }
@@ -755,11 +754,5 @@ export declare namespace Stigg {
     type MyCursorIDPageResponse as MyCursorIDPageResponse,
   };
 
-  export {
-    V1 as V1,
-    type V1CreateEventResponse as V1CreateEventResponse,
-    type V1CreateUsageResponse as V1CreateUsageResponse,
-    type V1CreateEventParams as V1CreateEventParams,
-    type V1CreateUsageParams as V1CreateUsageParams,
-  };
+  export { V1 as V1 };
 }

package/src/core/pagination.ts

@@ -109,22 +109,31 @@ export class PagePromise<
 
 export interface MyCursorIDPageResponse<Item> {
   data: Array<Item>;
+
+  pagination: MyCursorIDPageResponse.Pagination;
+}
+
+export namespace MyCursorIDPageResponse {
+  export interface Pagination {
+    next?: string;
+
+    prev?: string;
+  }
 }
 
 export interface MyCursorIDPageParams {
-  starting_after?: string;
+  after?: string;
 
-  ending_before?: string;
+  before?: string;
 
   limit?: number;
 }
 
-export class MyCursorIDPage<Item extends { cursor_id: string }>
-  extends AbstractPage<Item>
-  implements MyCursorIDPageResponse<Item>
-{
+export class MyCursorIDPage<Item> extends AbstractPage<Item> implements MyCursorIDPageResponse<Item> {
   data: Array<Item>;
 
+  pagination: MyCursorIDPageResponse.Pagination;
+
   constructor(
     client: Stigg,
     response: Response,
@@ -134,6 +143,7 @@ export class MyCursorIDPage<Item extends { cursor_id: string }>
     super(client, response, body, options);
 
     this.data = body.data || [];
+    this.pagination = body.pagination || {};
   }
 
   getPaginatedItems(): Item[] {
@@ -141,14 +151,10 @@ export class MyCursorIDPage<Item extends { cursor_id: string }>
   }
 
   nextPageRequestOptions(): PageRequestOptions | null {
-    const data = this.getPaginatedItems();
-
-    const isForwards = !(
-      typeof this.options.query === 'object' && 'ending_before' in (this.options.query || {})
-    );
-    if (isForwards) {
-      const cursorID = data[data.length - 1]?.cursor_id;
-      if (!cursorID) {
+    if ((this.options.query as Record<string, unknown>)?.['before']) {
+      // in reverse
+      const prev = this.pagination?.prev;
+      if (!prev) {
         return null;
       }
 
@@ -156,13 +162,13 @@ export class MyCursorIDPage<Item extends { cursor_id: string }>
         ...this.options,
         query: {
           ...maybeObj(this.options.query),
-          starting_after: cursorID,
+          before: prev,
         },
       };
     }
 
-    const cursorID = data[0]?.cursor_id;
-    if (!cursorID) {
+    const cursor = this.pagination?.next;
+    if (!cursor) {
       return null;
     }
 
@@ -170,7 +176,7 @@ export class MyCursorIDPage<Item extends { cursor_id: string }>
       ...this.options,
       query: {
         ...maybeObj(this.options.query),
-        ending_before: cursorID,
+        after: cursor,
       },
     };
   }

package/src/internal/parse.ts

@@ -29,6 +29,12 @@ export async function defaultParseResponse<T>(client: Stigg, props: APIResponseP
     const mediaType = contentType?.split(';')[0]?.trim();
     const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
     if (isJSON) {
+      const contentLength = response.headers.get('content-length');
+      if (contentLength === '0') {
+        // if there is no content we can't do anything
+        return undefined as T;
+      }
+
       const json = await response.json();
       return json as T;
     }

package/src/internal/qs/LICENSE.md

@@ -0,0 +1,13 @@
+BSD 3-Clause License
+
+Copyright (c) 2014, Nathan LaFreniere and other [contributors](https://github.com/puruvj/neoqs/graphs/contributors) All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/src/internal/qs/README.md

@@ -0,0 +1,3 @@
+# qs
+
+This is a vendored version of [neoqs](https://github.com/PuruVJ/neoqs) which is a TypeScript rewrite of [qs](https://github.com/ljharb/qs), a query string library.

package/src/internal/qs/formats.ts

@@ -0,0 +1,10 @@
+import type { Format } from './types';
+
+export const default_format: Format = 'RFC3986';
+export const default_formatter = (v: PropertyKey) => String(v);
+export const formatters: Record<Format, (str: PropertyKey) => string> = {
+  RFC1738: (v: PropertyKey) => String(v).replace(/%20/g, '+'),
+  RFC3986: default_formatter,
+};
+export const RFC1738 = 'RFC1738';
+export const RFC3986 = 'RFC3986';

package/src/internal/qs/index.ts

@@ -0,0 +1,13 @@
+import { default_format, formatters, RFC1738, RFC3986 } from './formats';
+
+const formats = {
+  formatters,
+  RFC1738,
+  RFC3986,
+  default: default_format,
+};
+
+export { stringify } from './stringify';
+export { formats };
+
+export type { DefaultDecoder, DefaultEncoder, Format, ParseOptions, StringifyOptions } from './types';