@warp-drive/utilities 5.6.0-alpha.15 → 5.6.0-alpha.17

package/declarations/-private/handlers/auto-compress.d.ts

@@ -1,153 +1,152 @@
-import type { Future, Handler, NextFn } from '@warp-drive/core/request';
-import type { RequestContext } from '@warp-drive/core/types/request';
+import type { Future, Handler, NextFn } from "@warp-drive/core/request";
+import type { RequestContext } from "@warp-drive/core/types/request";
 export declare const SupportsRequestStreams: boolean;
 interface Constraints {
-    /**
-     * The minimum size at which to compress blobs
-     *
-     * @default 1000
-     */
-    Blob?: number;
-    /**
-     * The minimum size at which to compress array buffers
-     *
-     * @default 1000
-     */
-    ArrayBuffer?: number;
-    /**
-     * The minimum size at which to compress typed arrays
-     *
-     * @default 1000
-     */
-    TypedArray?: number;
-    /**
-     * The minimum size at which to compress data views
-     *
-     * @default 1000
-     */
-    DataView?: number;
-    /**
-     * The minimum size at which to compress strings
-     *
-     * @default 1000
-     */
-    String?: number;
+	/**
+	* The minimum size at which to compress blobs
+	*
+	* @default 1000
+	*/
+	Blob?: number;
+	/**
+	* The minimum size at which to compress array buffers
+	*
+	* @default 1000
+	*/
+	ArrayBuffer?: number;
+	/**
+	* The minimum size at which to compress typed arrays
+	*
+	* @default 1000
+	*/
+	TypedArray?: number;
+	/**
+	* The minimum size at which to compress data views
+	*
+	* @default 1000
+	*/
+	DataView?: number;
+	/**
+	* The minimum size at which to compress strings
+	*
+	* @default 1000
+	*/
+	String?: number;
 }
 /**
- * Options for configuring the AutoCompress handler.
- *
- */
+* Options for configuring the AutoCompress handler.
+*
+*/
 interface CompressionOptions {
-    /**
-     * The compression format to use. Must be a valid
-     * compression format supported by [CompressionStream](https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream)
-     *
-     * The default is `gzip`.
-     *
-     */
-    format?: CompressionFormat;
-    /**
-     * Some browsers support `ReadableStream` as a request body. This option
-     * enables passing the compression stream as the request body instead of
-     * the final compressed body when the browser supports doing so.
-     *
-     * This comes with several caveats:
-     *
-     * - the request will be put into `duplex: 'half'` mode. This should be
-     *   transparent to you, but it is worth noting.
-     * - the request mode cannot be `no-cors` as requests with a `ReadableStream`
-     *   have no content length and thus are a new form of request that triggers
-     *   cors requirements and a preflight request.
-     * - http/1.x is not supported.
-     *
-     * For additional reading about the restrictions of using `ReadableStream`
-     * as a request body, see the [Chromium Documentation](https://developer.chrome.com/docs/capabilities/web-apis/fetch-streaming-requests#restrictions)
-     *
-     * Streaming can be enabled per-request in browsers which support it by
-     * setting `request.options.allowStreaming` to `true`.
-     *
-     * Streaming can be forced even when the browser does not support it by setting
-     * `request.options.forceStreaming` to `true`. This is useful if later handlers
-     * in the chain can handle the request body as a stream.
-     *
-     * @default false
-     */
-    allowStreaming?: boolean;
-    /**
-     * If `true`, the request will be forced into streaming mode even
-     * if the browser does not support it. This is useful if later handlers
-     * in the chain can handle the request body as a stream.
-     *
-     * @default false
-     */
-    forceStreaming?: boolean;
-    /**
-     * The constraints for the request body. This is used to determine
-     * whether to compress the request body or not.
-     *
-     * The defaults are:
-     *
-     * ```ts
-     * {
-     *   Blob: 1000, // blob.size
-     *   ArrayBuffer: 1000, // buffer.byteLength
-     *   TypedArray: 1000, // array.byteLength
-     *   DataView: 1000, // view.byteLength
-     *   String: 1000, // string.length
-     * }
-     * ```
-     *
-     * The following body types are never compressed unless explicitly
-     * configured by the request:
-     * - `FormData`
-     * - `URLSearchParams`
-     * - `ReadableStream`
-     *
-     * A request.options.compress value of `false` will disable
-     * compression for a request body of any type. While a value of
-     * `true` will enable compression for the request.
-     *
-     * An undefined value will use the default, a value of `0` will
-     * enable compression for all values, and a value of `-1` will
-     * disable compression.
-     *
-     */
-    constraints?: Constraints;
+	/**
+	* The compression format to use. Must be a valid
+	* compression format supported by [CompressionStream](https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream)
+	*
+	* The default is `gzip`.
+	*
+	*/
+	format?: CompressionFormat;
+	/**
+	* Some browsers support `ReadableStream` as a request body. This option
+	* enables passing the compression stream as the request body instead of
+	* the final compressed body when the browser supports doing so.
+	*
+	* This comes with several caveats:
+	*
+	* - the request will be put into `duplex: 'half'` mode. This should be
+	*   transparent to you, but it is worth noting.
+	* - the request mode cannot be `no-cors` as requests with a `ReadableStream`
+	*   have no content length and thus are a new form of request that triggers
+	*   cors requirements and a preflight request.
+	* - http/1.x is not supported.
+	*
+	* For additional reading about the restrictions of using `ReadableStream`
+	* as a request body, see the [Chromium Documentation](https://developer.chrome.com/docs/capabilities/web-apis/fetch-streaming-requests#restrictions)
+	*
+	* Streaming can be enabled per-request in browsers which support it by
+	* setting `request.options.allowStreaming` to `true`.
+	*
+	* Streaming can be forced even when the browser does not support it by setting
+	* `request.options.forceStreaming` to `true`. This is useful if later handlers
+	* in the chain can handle the request body as a stream.
+	*
+	* @default false
+	*/
+	allowStreaming?: boolean;
+	/**
+	* If `true`, the request will be forced into streaming mode even
+	* if the browser does not support it. This is useful if later handlers
+	* in the chain can handle the request body as a stream.
+	*
+	* @default false
+	*/
+	forceStreaming?: boolean;
+	/**
+	* The constraints for the request body. This is used to determine
+	* whether to compress the request body or not.
+	*
+	* The defaults are:
+	*
+	* ```ts
+	* {
+	*   Blob: 1000, // blob.size
+	*   ArrayBuffer: 1000, // buffer.byteLength
+	*   TypedArray: 1000, // array.byteLength
+	*   DataView: 1000, // view.byteLength
+	*   String: 1000, // string.length
+	* }
+	* ```
+	*
+	* The following body types are never compressed unless explicitly
+	* configured by the request:
+	* - `FormData`
+	* - `URLSearchParams`
+	* - `ReadableStream`
+	*
+	* A request.options.compress value of `false` will disable
+	* compression for a request body of any type. While a value of
+	* `true` will enable compression for the request.
+	*
+	* An undefined value will use the default, a value of `0` will
+	* enable compression for all values, and a value of `-1` will
+	* disable compression.
+	*
+	*/
+	constraints?: Constraints;
 }
 /**
- * A request handler that automatically compresses the request body
- * if the request body is a string, array buffer, blob, or form data.
- *
- * This uses the [CompressionStream API](https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream)
- *
- * The compression format as well as the kinds of data to compress can be
- * configured using the `format` and `constraints` options.
- *
- * ```diff
- * +import { AutoCompress } from '@ember-data/request-utils/handlers';
- * import Fetch from '@ember-data/request/fetch';
- * import RequestManager from '@ember-data/request';
- * import Store from '@ember-data/store';
- *
- * class AppStore extends Store {
- *   requestManager = new RequestManager()
- *     .use([
- * +       new AutoCompress(),
- *        Fetch
- *     ]);
- * }
- * ```
- *
- * @class AutoCompress
- * @public
- * @since 5.5.0
- */
+* A request handler that automatically compresses the request body
+* if the request body is a string, array buffer, blob, or form data.
+*
+* This uses the [CompressionStream API](https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream)
+*
+* The compression format as well as the kinds of data to compress can be
+* configured using the `format` and `constraints` options.
+*
+* ```diff
+* +import { AutoCompress } from '@ember-data/request-utils/handlers';
+* import Fetch from '@ember-data/request/fetch';
+* import RequestManager from '@ember-data/request';
+* import Store from '@ember-data/store';
+*
+* class AppStore extends Store {
+*   requestManager = new RequestManager()
+*     .use([
+* +       new AutoCompress(),
+*        Fetch
+*     ]);
+* }
+* ```
+*
+* @class AutoCompress
+* @public
+* @since 5.5.0
+*/
 export declare class AutoCompress implements Handler {
-    options: Required<CompressionOptions> & {
-        constraints: Required<Constraints>;
-    };
-    constructor(options?: CompressionOptions);
-    request<T>({ request }: RequestContext, next: NextFn<T>): Promise<T> | Future<T>;
+	options: Required<CompressionOptions> & {
+		constraints: Required<Constraints>;
+	};
+	constructor(options?: CompressionOptions);
+	request<T>({ request }: RequestContext, next: NextFn<T>): Promise<T> | Future<T>;
 }
 export {};
-//# sourceMappingURL=auto-compress.d.ts.map

package/declarations/-private/handlers/gated.d.ts

@@ -1,19 +1,18 @@
-import type { Future, Handler, NextFn } from '@warp-drive/core/request';
-import type { RequestContext, StructuredDataDocument } from '@warp-drive/core/types/request';
+import type { Future, Handler, NextFn } from "@warp-drive/core/request";
+import type { RequestContext, StructuredDataDocument } from "@warp-drive/core/types/request";
 /**
- * If CheckFn returns true, the wrapped handler will be used.
- * If CheckFn returns false, the wrapped handler will be skipped.
- */
+* If CheckFn returns true, the wrapped handler will be used.
+* If CheckFn returns false, the wrapped handler will be skipped.
+*/
 type CheckFn = (context: RequestContext) => boolean;
 /**
- *
- * @public
- */
+*
+* @public
+*/
 export declare class Gate implements Handler {
-    handler: Handler;
-    checkFn: CheckFn;
-    constructor(handler: Handler, checkFn: CheckFn);
-    request<T = unknown>(context: RequestContext, next: NextFn<T>): Promise<T | StructuredDataDocument<T>> | Future<T>;
+	handler: Handler;
+	checkFn: CheckFn;
+	constructor(handler: Handler, checkFn: CheckFn);
+	request<T = unknown>(context: RequestContext, next: NextFn<T>): Promise<T | StructuredDataDocument<T>> | Future<T>;
 }
 export {};
-//# sourceMappingURL=gated.d.ts.map

package/declarations/-private/handlers/utils.d.ts

@@ -1,33 +1,32 @@
 /**
- * A unique identifier for the current browser tab
- * useful for observability/tracing and deduping
- * across multiple tabs.
- */
+* A unique identifier for the current browser tab
+* useful for observability/tracing and deduping
+* across multiple tabs.
+*/
 export declare const TAB_ID: string;
 /**
- * The epoch seconds at which the tab id was generated
- */
+* The epoch seconds at which the tab id was generated
+*/
 export declare const TAB_ASSIGNED: number;
 /**
- * Adds the `X-Amzn-Trace-Id` header to support observability
- * tooling around request routing.
- *
- * This makes use of the {@link TAB_ID} and {@link TAB_ASSIGNED}
- * to enable tracking the browser tab of origin across multiple requests.
- *
- * Follows the template: `Root=1-${now}-${uuidv4};TabId=1-${epochSeconds}-${tab-uuid}`
- */
+* Adds the `X-Amzn-Trace-Id` header to support observability
+* tooling around request routing.
+*
+* This makes use of the {@link TAB_ID} and {@link TAB_ASSIGNED}
+* to enable tracking the browser tab of origin across multiple requests.
+*
+* Follows the template: `Root=1-${now}-${uuidv4};TabId=1-${epochSeconds}-${tab-uuid}`
+*/
 export declare function addTraceHeader(headers: Headers): Headers;
 /**
- * Source: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html
- * As of 2024-12-05 the maximum URL length is 8192 bytes.
- *
- */
+* Source: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html
+* As of 2024-12-05 the maximum URL length is 8192 bytes.
+*
+*/
 export declare const MAX_URL_LENGTH = 8192;
 /**
- * This assertion takes a URL and throws an error if the URL is longer than the maximum URL length.
- *
- * See also {@link MAX_URL_LENGTH}
- */
+* This assertion takes a URL and throws an error if the URL is longer than the maximum URL length.
+*
+* See also {@link MAX_URL_LENGTH}
+*/
 export declare function assertInvalidUrlLength(url: string | undefined): void;
-//# sourceMappingURL=utils.d.ts.map

package/declarations/-private/json-api/-utils.d.ts

@@ -1,110 +1,109 @@
-import type { QueryParamsSource } from '@warp-drive/core/types/params';
-import type { BuildURLConfig } from '../../index.ts';
+import type { QueryParamsSource } from "@warp-drive/core/types/params";
+import type { BuildURLConfig } from "../../index.js";
 export interface JSONAPIConfig extends BuildURLConfig {
-    profiles?: {
-        pagination?: string;
-        [key: string]: string | undefined;
-    };
-    extensions?: {
-        atomic?: string;
-        [key: string]: string | undefined;
-    };
+	profiles?: {
+		pagination?: string;
+		[key: string]: string | undefined;
+	};
+	extensions?: {
+		atomic?: string;
+		[key: string]: string | undefined;
+	};
 }
 export declare let CONFIG: JSONAPIConfig;
 export declare let ACCEPT_HEADER_VALUE: string;
 /**
- * Allows setting extensions and profiles to be used in the `Accept` header.
- *
- * Extensions and profiles are keyed by their namespace with the value being
- * their URI.
- *
- * Example:
- *
- * ```ts
- * setBuildURLConfig({
- *   extensions: {
- *     atomic: 'https://jsonapi.org/ext/atomic'
- *   },
- *   profiles: {
- *     pagination: 'https://jsonapi.org/profiles/ethanresnick/cursor-pagination'
- *   }
- * });
- * ```
- *
- * This also sets the global configuration for `buildBaseURL`
- * for host and namespace values for the global coniguration
- * done via `import { setBuildURLConfig } from '@warp-drive/utilities';`
- *
- * These values may still be overridden by passing
- * them to buildBaseURL directly.
- *
- * This method may be called as many times as needed
- *
- * ```ts
- * type BuildURLConfig = {
- *   host: string;
- *   namespace: string'
- * }
- * ```
- *
- * @public
- * @param {BuildURLConfig} config
- * @return {void}
- */
+* Allows setting extensions and profiles to be used in the `Accept` header.
+*
+* Extensions and profiles are keyed by their namespace with the value being
+* their URI.
+*
+* Example:
+*
+* ```ts
+* setBuildURLConfig({
+*   extensions: {
+*     atomic: 'https://jsonapi.org/ext/atomic'
+*   },
+*   profiles: {
+*     pagination: 'https://jsonapi.org/profiles/ethanresnick/cursor-pagination'
+*   }
+* });
+* ```
+*
+* This also sets the global configuration for `buildBaseURL`
+* for host and namespace values for the global coniguration
+* done via `import { setBuildURLConfig } from '@warp-drive/utilities';`
+*
+* These values may still be overridden by passing
+* them to buildBaseURL directly.
+*
+* This method may be called as many times as needed
+*
+* ```ts
+* type BuildURLConfig = {
+*   host: string;
+*   namespace: string'
+* }
+* ```
+*
+* @public
+* @param {BuildURLConfig} config
+* @return {void}
+*/
 export declare function setBuildURLConfig(config: JSONAPIConfig): void;
 interface RelatedObject {
-    [key: string]: string | string[] | RelatedObject;
+	[key: string]: string | string[] | RelatedObject;
 }
 export type JsonApiQuery = {
-    include?: string | string[] | RelatedObject;
-    fields?: Record<string, string | string[]>;
-    page?: {
-        size?: number;
-        after?: string;
-        before?: string;
-    };
+	include?: string | string[] | RelatedObject;
+	fields?: Record<string, string | string[]>;
+	page?: {
+		size?: number;
+		after?: string;
+		before?: string;
+	};
 };
 /**
- * Sorts query params by both key and value, returning a query params string
- *
- * Treats `included` specially, splicing it into an array if it is a string and sorting the array.
- *   - If `included` is an object we build paths dynamically for you
- * Treats `fields` specially, building JSON:API partial fields params from an object
- * Treats `page` specially, building cursor-pagination profile page params from an object
- *
- * ```ts
- * const params = buildQueryParams({
- *  include: {
- *    company: {
- *      locations: 'address'
- *    }
- *  },
- *   fields: {
- *     company: ['name', 'ticker'],
- *     person: 'name'
- *   },
- *   page: {
- *     size: 10,
- *     after: 'abc',
- *   }
- * });
- *
- * // => 'fields[company]=name,ticker&fields[person]=name&include=company.locations,company.locations.address&page[after]=abc&page[size]=10'
- * ```
- *
- * Options:
- * - arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'
- *
- * 'bracket': appends [] to the key for every value e.g. `ids[]=1&ids[]=2`
- * 'indices': appends [i] to the key for every value e.g. `ids[0]=1&ids[1]=2`
- * 'repeat': appends the key for every value e.g. `ids=1&ids=2`
- * 'comma' (default): appends the key once with a comma separated list of values e.g. `ids=1,2`
- *
- * @public
- * @param {URLSearchParams | Object} params
- * @param {Object} [options]
- * @return {String} A sorted query params string without the leading `?`
- */
+* Sorts query params by both key and value, returning a query params string
+*
+* Treats `included` specially, splicing it into an array if it is a string and sorting the array.
+*   - If `included` is an object we build paths dynamically for you
+* Treats `fields` specially, building JSON:API partial fields params from an object
+* Treats `page` specially, building cursor-pagination profile page params from an object
+*
+* ```ts
+* const params = buildQueryParams({
+*  include: {
+*    company: {
+*      locations: 'address'
+*    }
+*  },
+*   fields: {
+*     company: ['name', 'ticker'],
+*     person: 'name'
+*   },
+*   page: {
+*     size: 10,
+*     after: 'abc',
+*   }
+* });
+*
+* // => 'fields[company]=name,ticker&fields[person]=name&include=company.locations,company.locations.address&page[after]=abc&page[size]=10'
+* ```
+*
+* Options:
+* - arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'
+*
+* 'bracket': appends [] to the key for every value e.g. `ids[]=1&ids[]=2`
+* 'indices': appends [i] to the key for every value e.g. `ids[0]=1&ids[1]=2`
+* 'repeat': appends the key for every value e.g. `ids=1&ids=2`
+* 'comma' (default): appends the key once with a comma separated list of values e.g. `ids=1,2`
+*
+* @public
+* @param {URLSearchParams | Object} params
+* @param {Object} [options]
+* @return {String} A sorted query params string without the leading `?`
+*/
 export declare function buildQueryParams(query: JsonApiQuery | QueryParamsSource): string;
 export {};
-//# sourceMappingURL=-utils.d.ts.map