@amazon/vinyl-util 1.0.0

package/dist/types/current/network/metrics/networkMetricsModel.d.ts

@@ -0,0 +1,147 @@
+import type { Timestamp } from '../../util/date/date';
+import type { ReadonlyRecord } from '../../util/object/readonlyType';
+import type { Maybe } from '../../util/type';
+/**
+ * Statistics for service calls and content transfers.
+ * Immutable
+ */
+export interface NetworkMetrics {
+    /**
+     * Totals for all service metrics, including requests without service ids.
+     */
+    readonly totals: ServiceMetrics;
+    /**
+     * Requests that were made with a service id will have their statistics tracked in this map.
+     * key - The serviceId provided to fetch options.
+     * value - cumulative metrics for that service.
+     */
+    readonly serviceMetrics: ReadonlyRecord<string, ServiceMetrics>;
+    /**
+     * The estimated client bandwidth. Uses data points from totals, network information downlink changes,
+     * and the fallback P90 downlink estimate.
+     */
+    readonly estimatedDownlinkBandwidth: StatMetrics;
+}
+export interface ServiceMetrics {
+    /**
+     * Metrics for OK responses.
+     */
+    readonly successTotals: ServiceTotals;
+    /**
+     * Metrics for !OK responses.
+     */
+    readonly failureTotals: ServiceTotals;
+    /**
+     * If the last request was !ok and there was a retry-after header, this will be set.
+     */
+    readonly retryAfter: Timestamp | null;
+    /**
+     * Metrics describing the response timing for this service, in seconds.
+     */
+    readonly responseTime: StatMetrics;
+}
+/**
+ * Basic statistical values describing the distribution of a datapoint.
+ */
+export interface StatMetrics {
+    /**
+     * The lowest value this stat has recorded.
+     */
+    readonly min: number;
+    /**
+     * The highest value this stat has recorded.
+     */
+    readonly max: number;
+    /**
+     * The simple average.
+     */
+    readonly average: number;
+    /**
+     * The last value recorded.
+     */
+    readonly latest: number;
+    /**
+     * The Exponentially Weighted Moving Average, weighing lower values more than high.
+     */
+    readonly ewmaLow: number;
+    /**
+     * The Exponentially Weighted Moving Average, weighing higher values more than low.
+     */
+    readonly ewmaHigh: number;
+    /**
+     * The Exponentially Weighted Moving Average.
+     */
+    readonly ewma: number;
+    /**
+     * The number of data points these averages represent.
+     */
+    readonly dataPoints: number;
+}
+export interface ServiceTotals {
+    /**
+     * The number of consecutive results with this result.
+     */
+    readonly consecutiveCount: number;
+    /**
+     * The total count with this result.
+     */
+    readonly totalCount: number;
+}
+/**
+ * Information about a completed request attempt.
+ */
+export interface NetworkMetricsEntry {
+    /**
+     * True if the request was successful.
+     */
+    readonly ok: boolean;
+    /**
+     * The id of the service, or null.
+     */
+    readonly serviceId: string | null;
+    /**
+     * If the request was !ok and there was a retry-after header, this will be set.
+     */
+    readonly retryAfter: Timestamp | null;
+    /**
+     * The number of seconds the response took or null for no response.
+     */
+    readonly responseTime: number | null;
+}
+/**
+ * Information about a completed content transfer.
+ */
+export interface NetworkTransferEntry {
+    /**
+     * The id of the service, or null.
+     */
+    readonly serviceId: string | null;
+    /**
+     * Timestamp when the request was initiated.
+     */
+    readonly requestStart: Timestamp;
+    /**
+     * Timestamp when the first byte of the response was transferred.
+     * This should only be provided if performance resource timing
+     * is available.
+     */
+    readonly responseStart?: Maybe<Timestamp>;
+    /**
+     * Timestamp when the response was received.
+     */
+    readonly responseEnd: Timestamp;
+    /**
+     * Timestamp when the full response body was received.
+     */
+    readonly contentEnd: Timestamp;
+    /**
+     * The content-length of the transfer.
+     */
+    readonly bytes: number;
+}
+export declare const EMPTY_SERVICE_TOTALS: ServiceTotals;
+export declare const EMPTY_STAT_METRICS: StatMetrics;
+export declare const EMPTY_SERVICE_METRICS: ServiceMetrics;
+export declare const EMPTY_NETWORK_METRICS: NetworkMetrics;
+export declare const EMPTY_NETWORK_METRICS_ENTRY: NetworkMetricsEntry;
+//# sourceMappingURL=networkMetricsModel.d.ts.map

package/dist/types/current/network/metrics/networkMetricsModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"networkMetricsModel.d.ts","sourceRoot":"","sources":["../../../../../src/network/metrics/networkMetricsModel.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAExC;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAA;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAE/D;;;OAGG;IACH,QAAQ,CAAC,0BAA0B,EAAE,WAAW,CAAA;CACnD;AAED,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAA;IAErC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAA;IAErC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,SAAS,GAAG,IAAI,CAAA;IAErC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,WAAW,CAAA;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC9B;AAED,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAA;IAEjC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAEjC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,SAAS,GAAG,IAAI,CAAA;IAErC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAEjC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,SAAS,CAAA;IAEhC;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAA;IAEzC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAA;IAE/B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAA;IAE9B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACzB;AAED,eAAO,MAAM,oBAAoB,EAAE,aAGzB,CAAA;AAEV,eAAO,MAAM,kBAAkB,EAAE,WASvB,CAAA;AAEV,eAAO,MAAM,qBAAqB,EAAE,cAK1B,CAAA;AAEV,eAAO,MAAM,qBAAqB,EAAE,cAI1B,CAAA;AAEV,eAAO,MAAM,2BAA2B,EAAE,mBAKzC,CAAA"}

package/dist/types/current/network/metrics/networkMetricsModel.js

@@ -0,0 +1,35 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export const EMPTY_SERVICE_TOTALS = {
+    consecutiveCount: 0,
+    totalCount: 0,
+};
+export const EMPTY_STAT_METRICS = {
+    average: 0,
+    dataPoints: 0,
+    ewma: 0,
+    ewmaHigh: 0,
+    ewmaLow: 0,
+    latest: 0,
+    max: 0,
+    min: 0,
+};
+export const EMPTY_SERVICE_METRICS = {
+    failureTotals: EMPTY_SERVICE_TOTALS,
+    successTotals: EMPTY_SERVICE_TOTALS,
+    retryAfter: null,
+    responseTime: EMPTY_STAT_METRICS,
+};
+export const EMPTY_NETWORK_METRICS = {
+    serviceMetrics: {},
+    totals: EMPTY_SERVICE_METRICS,
+    estimatedDownlinkBandwidth: EMPTY_STAT_METRICS,
+};
+export const EMPTY_NETWORK_METRICS_ENTRY = {
+    ok: false,
+    retryAfter: null,
+    serviceId: null,
+    responseTime: null,
+};

package/dist/types/current/network/network.d.ts

@@ -0,0 +1,47 @@
+import { DomEventHost } from '../event/DomEventHost';
+import type { ReadonlyEventHost } from '../event/EventHost';
+import type { ReadonlyAbort } from '../util/async/Abort';
+import type { Maybe } from '../util/type';
+export type DomEventTarget = EventTarget;
+export interface NetworkStateEventMap {
+    readonly offline: Event;
+    readonly online: Event;
+}
+/**
+ * Online status.
+ */
+export interface NetworkState extends ReadonlyEventHost<NetworkStateEventMap> {
+    /**
+     * Returns the online status of the browser.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/Navigator/onLine
+     */
+    readonly onLine: boolean;
+    /**
+     * Returns a promise that resolves when the network state is next online.
+     * Rejects immediately if the given `abortSignal` is in an aborted state.
+     * Resolves immediately if the navigator is currently online.
+     * @param abort If provided, rejects the returned promise when aborted.
+     */
+    nextOnLine(abort?: Maybe<ReadonlyAbort>): Promise<void>;
+}
+export interface NetworkStateImplDeps {
+    readonly eventTarget: DomEventTarget;
+    readonly navigator: {
+        readonly onLine: boolean;
+    };
+}
+export declare class NetworkStateImpl extends DomEventHost<NetworkStateEventMap> implements NetworkState {
+    protected readonly deps: NetworkStateImplDeps;
+    static createDefaultDeps(): NetworkStateImplDeps;
+    constructor(deps?: NetworkStateImplDeps);
+    get onLine(): boolean;
+    nextOnLine(abort?: Maybe<ReadonlyAbort>): Promise<void>;
+}
+/**
+ * A global reference to the network state.
+ */
+export declare const networkState: import("../global/globalRegistry").GlobalRef<NetworkState>;
+export declare function getNetworkState(): NetworkState;
+export declare function onLine(): boolean;
+//# sourceMappingURL=network.d.ts.map

package/dist/types/current/network/network.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../../../../src/network/network.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAG1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AACvD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAExC,MAAM,MAAM,cAAc,GAAG,WAAW,CAAA;AAExC,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAA;IACvB,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,iBAAiB,CAAC,oBAAoB,CAAC;IACzE;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IAExB;;;;;OAKG;IACH,UAAU,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1D;AAED,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAA;IACpC,QAAQ,CAAC,SAAS,EAAE;QAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAA;CACnD;AAED,qBAAa,gBACT,SAAQ,YAAY,CAAC,oBAAoB,CACzC,YAAW,YAAY;IAwBnB,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,oBAAoB;IAtBjD,MAAM,CAAC,iBAAiB,IAAI,oBAAoB;gBAsBzB,IAAI,GAAE,oBAA2D;IAKxF,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,UAAU,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAS1D;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,2DAExB,CAAA;AAED,wBAAgB,eAAe,IAAI,YAAY,CAE9C;AAED,wBAAgB,MAAM,IAAI,OAAO,CAEhC"}

package/dist/types/current/network/network.js

@@ -0,0 +1,54 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { DomEventHost } from '../event/DomEventHost';
+import { nextEventAsPromise } from '../event/nextEventAsPromise';
+import { globalRef } from '../global/globalRegistry';
+export class NetworkStateImpl extends DomEventHost {
+    deps;
+    static createDefaultDeps() {
+        if (typeof window === 'undefined') {
+            return {
+                eventTarget: {
+                    addEventListener() { },
+                    removeEventListener() { },
+                    dispatchEvent() {
+                        return true;
+                    },
+                },
+                navigator: {
+                    onLine: true,
+                },
+            };
+        }
+        return {
+            eventTarget: window,
+            navigator: window.navigator,
+        };
+    }
+    constructor(deps = NetworkStateImpl.createDefaultDeps()) {
+        super(deps.eventTarget);
+        this.deps = deps;
+    }
+    get onLine() {
+        return this.deps.navigator.onLine;
+    }
+    nextOnLine(abort) {
+        if (abort?.aborted())
+            return Promise.reject(abort.reason);
+        if (this.onLine)
+            return Promise.resolve();
+        return nextEventAsPromise(this, 'online', { abort }).then(() => void 0);
+    }
+}
+/**
+ * A global reference to the network state.
+ */
+export const networkState = globalRef(() => new NetworkStateImpl());
+export function getNetworkState() {
+    return networkState.value;
+}
+export function onLine() {
+    return networkState.value.onLine;
+}

package/dist/types/current/network/requesterGlobal.d.ts

@@ -0,0 +1,19 @@
+import type { Maybe } from '../util/type';
+import type { Requester, RequestInitOptions, RequestOptions } from './Requester';
+/**
+ * @private
+ */
+export declare const requesterWithRetryRef: import("../global/globalRegistry").GlobalRef<Requester>;
+/**
+ * Requests a resource.
+ *
+ * Note: Unlike `window.fetch`, the returned promise is expected to reject if the
+ * response is !ok.
+ *
+ * @param input A url string, URL Object, or RequestInfo object.
+ * @param init A RequestInit object.
+ * @param options Additional configuration such as an abort reference or service id for metrics
+ * and retries.
+ */
+export declare function requestWithRetry(input: RequestInfo | URL, init?: Maybe<RequestInitOptions>, options?: Partial<RequestOptions>): Promise<Response>;
+//# sourceMappingURL=requesterGlobal.d.ts.map

package/dist/types/current/network/requesterGlobal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requesterGlobal.d.ts","sourceRoot":"","sources":["../../../../src/network/requesterGlobal.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAExC,OAAO,KAAK,EAAE,SAAS,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAGhF;;GAEG;AACH,eAAO,MAAM,qBAAqB,wDAIhC,CAAA;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAC5B,KAAK,EAAE,WAAW,GAAG,GAAG,EACxB,IAAI,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,EAChC,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAClC,OAAO,CAAC,QAAQ,CAAC,CAEnB"}

package/dist/types/current/network/requesterGlobal.js

@@ -0,0 +1,29 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { globalRef } from '../global/globalRegistry';
+import { createRequester } from './createRequester';
+import { RetryStrategy } from './RequesterImpl';
+/**
+ * @private
+ */
+export const requesterWithRetryRef = globalRef(() => {
+    return createRequester({
+        retryOptions: RetryStrategy.ONE_RETRY,
+    });
+});
+/**
+ * Requests a resource.
+ *
+ * Note: Unlike `window.fetch`, the returned promise is expected to reject if the
+ * response is !ok.
+ *
+ * @param input A url string, URL Object, or RequestInfo object.
+ * @param init A RequestInit object.
+ * @param options Additional configuration such as an abort reference or service id for metrics
+ * and retries.
+ */
+export function requestWithRetry(input, init, options) {
+    return requesterWithRetryRef.value.request(input, init, options);
+}

package/dist/types/current/network/requesterUtil.d.ts

@@ -0,0 +1,28 @@
+import type { ResponseInfo } from './RequesterImplEventMap';
+import type { Timestamp } from '../util/date/date';
+import type { Maybe } from '../util/type';
+/**
+ * Returns true if the failed request should be retried.
+ * @private
+ */
+export declare function shouldRetry(status: number): boolean;
+/**
+ * The default jitter amount after waiting for a retry-after timestamp.
+ */
+export declare function retryAfterJitter(): number;
+/**
+ * Retry-After  = "Retry-After" ":" ( HTTP-date | delta-seconds )
+ * https://www.rfc-editor.org/rfc/rfc2616#page-141
+ *
+ * @param retryAfter The string to parse into a timestamp. If nullish, null is returned.
+ * @returns The unix timestamp to wait until before retrying. If the Retry-After header
+ * could not be found, or provided a date that cannot be parsed, returns null.
+ */
+export declare function parseRetryAfter(retryAfter: Maybe<string>): Timestamp | null;
+/**
+ * Returns serializable response information.
+ *
+ * @param response The Response object. The body will not be read, this does not need to be cloned.
+ */
+export declare function getResponseInfo(response: Response): ResponseInfo;
+//# sourceMappingURL=requesterUtil.d.ts.map

package/dist/types/current/network/requesterUtil.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requesterUtil.d.ts","sourceRoot":"","sources":["../../../../src/network/requesterUtil.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AASxC;;;GAGG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,CAEzC;AAID;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,GAAG,IAAI,CAY3E;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,YAAY,CAWhE"}

package/dist/types/current/network/requesterUtil.js

@@ -0,0 +1,71 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/*
+ * Network utility methods to support RequesterImpl.
+ *
+ * @brief
+ */
+import { globalTarget } from '../global/globalTarget';
+import { logWarn } from '../logging/Logger';
+import { parseIntSafe } from '../util/serialization/primitives';
+const retryableStatusCodes = new Set([
+    429, // Too many requests
+    503, // Service unavailable
+    504, // Gateway timeout
+]);
+/**
+ * Returns true if the failed request should be retried.
+ * @private
+ */
+export function shouldRetry(status) {
+    return retryableStatusCodes.has(status);
+}
+/**
+ * The default jitter amount after waiting for a retry-after timestamp.
+ */
+export function retryAfterJitter() {
+    return 90 * Math.random();
+}
+const NUMBER_REGEXP = /^\s*\d+\s*$/;
+/**
+ * Retry-After  = "Retry-After" ":" ( HTTP-date | delta-seconds )
+ * https://www.rfc-editor.org/rfc/rfc2616#page-141
+ *
+ * @param retryAfter The string to parse into a timestamp. If nullish, null is returned.
+ * @returns The unix timestamp to wait until before retrying. If the Retry-After header
+ * could not be found, or provided a date that cannot be parsed, returns null.
+ */
+export function parseRetryAfter(retryAfter) {
+    if (retryAfter == null)
+        return null;
+    if (NUMBER_REGEXP.test(retryAfter)) {
+        return Date.now() + parseInt(retryAfter) * 1000;
+    }
+    if (!retryAfter.toLowerCase().includes('gmt'))
+        retryAfter += ' GMT';
+    const timestamp = Date.parse(retryAfter);
+    if (Number.isNaN(timestamp)) {
+        logWarn(globalTarget, `Invalid retry-after header: ${retryAfter}`);
+        return null;
+    }
+    return timestamp;
+}
+/**
+ * Returns serializable response information.
+ *
+ * @param response The Response object. The body will not be read, this does not need to be cloned.
+ */
+export function getResponseInfo(response) {
+    const contentLength = parseIntSafe(response.headers.get('content-length'));
+    return {
+        ok: response.ok,
+        redirected: response.redirected,
+        status: response.status,
+        statusText: response.statusText,
+        type: response.type,
+        url: response.url,
+        contentLength,
+    };
+}

package/dist/types/current/network/responseUtil.d.ts

@@ -0,0 +1,10 @@
+import type { RequestResponseErrorEvent } from './RequesterImplEventMap';
+import { RequestError } from './RequestError';
+/**
+ * Returns true if the given object is a RequestError with type RESPONSE.
+ * @param error
+ */
+export declare function isResponseError(error: any): error is RequestError & {
+    readonly info: RequestResponseErrorEvent;
+};
+//# sourceMappingURL=responseUtil.d.ts.map

package/dist/types/current/network/responseUtil.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responseUtil.d.ts","sourceRoot":"","sources":["../../../../src/network/responseUtil.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AAExE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C;;;GAGG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,YAAY,GAAG;IACjE,QAAQ,CAAC,IAAI,EAAE,yBAAyB,CAAA;CAC3C,CAKA"}

package/dist/types/current/network/responseUtil.js

@@ -0,0 +1,14 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { RequestFailureType } from './RequesterImplEventMap';
+import { RequestError } from './RequestError';
+/**
+ * Returns true if the given object is a RequestError with type RESPONSE.
+ * @param error
+ */
+export function isResponseError(error) {
+    return (error instanceof RequestError &&
+        error.info.type === RequestFailureType.RESPONSE);
+}

package/dist/types/current/patch/network/fetch.d.ts

@@ -0,0 +1,11 @@
+import type { Fetch } from '../../network/Requester';
+export declare function requiresPreventCacheRangeRequestsPatch(): boolean;
+/**
+ * On affected UAs, Range requests from cache can fail with a TypeError.
+ *
+ * A message will display in the browser such as net::ERR_CONNECTION_FAILED, which isn't accessible from the Error.
+ * @param original
+ */
+export declare function preventCacheRangeRequestsPatch(original: Fetch): Fetch;
+export declare function patchFetch(original: Fetch): Fetch;
+//# sourceMappingURL=fetch.d.ts.map

package/dist/types/current/patch/network/fetch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../../../../src/patch/network/fetch.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAShD,wBAAgB,sCAAsC,IAAI,OAAO,CAEhE;AAED;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAAC,QAAQ,EAAE,KAAK,GAAG,KAAK,CAkBrE;AAED,wBAAgB,UAAU,CAAC,QAAQ,EAAE,KAAK,GAAG,KAAK,CAMjD"}

package/dist/types/current/patch/network/fetch.js

@@ -0,0 +1,43 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { hasBrowser } from '../../client/userAgent/hasBrowser';
+import { Browser } from '../../client/userAgent/defaultUserAgentRules';
+import { changeRequestInputUrl, getHeaderFromRequestParams, } from '../../util/network/request';
+import { createShortUid } from '../../util/string/uid';
+export function requiresPreventCacheRangeRequestsPatch() {
+    return hasBrowser(Browser.CHROMIUM, null, '64');
+}
+/**
+ * On affected UAs, Range requests from cache can fail with a TypeError.
+ *
+ * A message will display in the browser such as net::ERR_CONNECTION_FAILED, which isn't accessible from the Error.
+ * @param original
+ */
+export function preventCacheRangeRequestsPatch(original) {
+    return async (input, init) => {
+        try {
+            return await original(input, init);
+        }
+        catch (error) {
+            if (error instanceof TypeError &&
+                getHeaderFromRequestParams(input, init, 'range')) {
+                input = changeRequestInputUrl(input, (url) => {
+                    // Note - the browsers affected do not support the cache: no-cache init parameter.
+                    url.searchParams.append('__cache', createShortUid());
+                });
+                return original(input, init);
+            }
+            throw error;
+        }
+    };
+}
+export function patchFetch(original) {
+    if (requiresPreventCacheRangeRequestsPatch()) {
+        return preventCacheRangeRequestsPatch(original);
+    }
+    else {
+        return original;
+    }
+}

package/dist/types/current/patch/patchTarget.d.ts

@@ -0,0 +1,114 @@
+import { type Disposable } from '../core/disposable';
+import type { Unsubscribe } from '../core/Unsubscribe';
+import { type Signal } from '../event/Signal';
+import type { AnyRecord } from '../util/type';
+import { type LogTarget } from '../logging/LogTarget';
+export interface Patch<in T, in EventMap = AnyRecord> extends Disposable {
+    /**
+     * A signal that emits synthetic events.
+     * These events will be dispatched on the proxy, not on the original event target.
+     * If undefined, no events are fabricated.
+     */
+    readonly eventFabricated?: Signal<Event>;
+    /**
+     * Overridden properties.
+     */
+    readonly properties?: PropertyPatches<T>;
+    /**
+     * Overridden events.
+     * Event patches may provide an alternate event to emit, or null to prevent an event from
+     * dispatching on the proxy.
+     *
+     * Note:
+     * Patched events have divergent behavior when using Event.stopImmediatePropagation.
+     * All handlers added to the patched Proxy will still be called after stopImmediatePropagation.
+     * It is the author's opinion that using stopImmediatePropagation is an anti-pattern, and one
+     * handler should not be allowed to influence the behavior of neighboring handlers.
+     */
+    readonly events?: EventPatches<EventMap>;
+}
+/**
+ * A record of property key to property patch.
+ */
+export type PropertyPatches<in T> = {
+    readonly [P in keyof T]?: PropertyPatch<T, P>;
+};
+/**
+ * An override to a patched property.
+ */
+export interface PropertyPatch<T, K extends keyof T> {
+    /**
+     * @return Returns the value to return on the proxy.
+     */
+    get?(): T[K];
+    /**
+     * @param newValue The property value attempting to be set.
+     */
+    set?(newValue: T[K]): void;
+}
+/**
+ * Handles an event emitted from the event target. The returned event will be emitted in its
+ * place on the proxy.
+ *
+ * Fabricated events from `eventFabricated` will not be passed to this handler and cannot be
+ * squelched.
+ *
+ * @param event The original event from the event target. This should not be modified
+ * directly, but may be cloned and a modified clone may be returned.
+ *
+ * @return Returns the event to emit on the proxy or null to squelch the event.
+ */
+export type EventPatch<T> = (event: T) => T | null;
+/**
+ * A record of event type to an event patch.
+ */
+export type EventPatches<in EventMap> = {
+    readonly [P in keyof EventMap]?: EventPatch<EventMap[P]>;
+};
+export type PatchFactory<T, EventMap> = (target: T) => Patch<T, EventMap>;
+export interface PatchedRef<T> extends Disposable {
+    /**
+     * The patched target.
+     */
+    readonly patched: T;
+    /**
+     * A signal for when a synthetic event was fabricated.
+     */
+    eventFabricated: Signal<Event>;
+    /**
+     * A signal for when an event was squelched.
+     */
+    eventSquelched: Signal<Event>;
+}
+/**
+ * Creates a Proxy for patched event and properties on the target. All patches from the provided
+ * factory list will be used in creating a proxy chain. Each patch is applied in order, and
+ * patches can rely on their target having been patched with all previous patches.
+ *
+ * @param target
+ * @param patchFactories A list of factories that each produce a new patch for the target.
+ * @return Returns a disposable object with a Proxy reference with overridden event and property
+ * behavior. When disposed, the event listeners are removed.
+ */
+export declare function patchTarget<T extends object, EventMap = AnyRecord>(target: T, ...patchFactories: PatchFactory<T, EventMap>[]): PatchedRef<T>;
+/**
+ * Logs debug messages when an event was squelched or fabricated.
+ *
+ * @param pathTarget
+ * @param patched
+ * @return Returns a function that when invoked, removes the logging.
+ */
+export declare function logPatchedEvents(pathTarget: LogTarget, patched: PatchedRef<any>): Unsubscribe;
+/**
+ * A tuple of `[flag, factory]`.
+ * Patches will be applied when flag is true.
+ */
+export type FlagAndPatchEntry<T extends object, EventMap, Key> = readonly [
+    flagKey: Key,
+    factory: PatchFactory<T, EventMap>
+];
+/**
+ * Given a list of [flagKey, patchFactory] tuples, patches the target with patches where flag is true.
+ */
+export declare function patchTargetFromFlags<T extends object, EventMap, Flags>(target: T, flags: Flags, ...patchEntries: readonly FlagAndPatchEntry<T, EventMap, keyof Flags>[]): PatchedRef<T>;
+//# sourceMappingURL=patchTarget.d.ts.map

package/dist/types/current/patch/patchTarget.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"patchTarget.d.ts","sourceRoot":"","sources":["../../../../src/patch/patchTarget.ts"],"names":[],"mappings":"AAKA,OAAO,EAEH,KAAK,UAAU,EAElB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAGrD,OAAO,EAAe,KAAK,MAAM,EAAc,MAAM,gBAAgB,CAAA;AAErE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAmB,KAAK,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAErE,MAAM,WAAW,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,GAAG,SAAS,CAAE,SAAQ,UAAU;IACpE;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;IAExC;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;IAExC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAA;CAC3C;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,EAAE,CAAC,CAAC,IAAI;IAChC,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;CAChD,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC;IAC/C;;OAEG;IACH,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;IAEZ;;OAEG;IACH,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;CAC7B;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;AAElD;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,EAAE,CAAC,QAAQ,IAAI;IACpC,QAAQ,EAAE,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;CAC3D,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;AAEzE,MAAM,WAAW,UAAU,CAAC,CAAC,CAAE,SAAQ,UAAU;IAC7C;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;IAE9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;CAChC;AAED;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,QAAQ,GAAG,SAAS,EAC9D,MAAM,EAAE,CAAC,EACT,GAAG,cAAc,EAAE,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,GAC/C,UAAU,CAAC,CAAC,CAAC,CA6Cf;AAgJD;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC5B,UAAU,EAAE,SAAS,EACrB,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC,GACzB,WAAW,CAWb;AAMD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,SAAS;IACtE,OAAO,EAAE,GAAG;IACZ,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC;CACrC,CAAA;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,MAAM,EAAE,QAAQ,EAAE,KAAK,EAClE,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,KAAK,EACZ,GAAG,YAAY,EAAE,SAAS,iBAAiB,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAC,EAAE,GACxE,UAAU,CAAC,CAAC,CAAC,CAgBf"}