@amazon/vinyl-util 1.0.0

package/dist/types/ts3.7/util/async/Abort.d.ts

@@ -0,0 +1,96 @@
+import { ReadonlyEventHost } from '../../event/EventHost';
+import { EventHostImpl } from '../../event/EventHost';
+import { Unsubscribe } from '../../core/Unsubscribe';
+export interface AbortEvent {
+    readonly reason: Error;
+}
+export interface AbortEventMap {
+    readonly abort: AbortEvent;
+}
+export interface ReadonlyAbort extends ReadonlyEventHost<AbortEventMap> {
+    /**
+     * True if aborted.
+     */
+    aborted(): boolean;
+    /**
+     * The reason passed to `abort`.
+     */
+    readonly reason: Error | null;
+    /**
+     * Throws the signal's abort reason if the signal has been aborted; otherwise it does nothing.
+     */
+    throwIfAborted(): void;
+    /**
+     * Invokes a callback on 'abort', or immediately if already aborted.
+     */
+    onAborted(callback: (event: AbortEvent) => void): Unsubscribe;
+    /**
+     * Returns a native signal on supported platforms.
+     */
+    readonly nativeSignal: AbortSignal | null;
+}
+/**
+ * Returns a new native abort controller, if this environment supports AbortController.abort.
+ *
+ * Supported in Chrome 66+, Edge 16+, Firefox 57+, Opera 53+, Safari 11.3+,
+ */
+export declare function createAbortController(): AbortController | null;
+export interface AbortDeps {
+    readonly abortControllerFactory?: () => AbortController | null;
+}
+/**
+ * An Abort instance emits an 'abort' event when aborted.
+ *
+ * A native `AbortController` is encapsulated if the platform supports it, allowing for fetch
+ * cancellation.
+ */
+export declare class Abort extends EventHostImpl<AbortEventMap> implements ReadonlyAbort {
+    private readonly deps?;
+    get [Symbol.toStringTag](): string;
+    constructor(deps?: AbortDeps | undefined);
+    private _reason;
+    /**
+     * True if this signal is aborted.
+     */
+    aborted(): boolean;
+    get reason(): (Error | null);
+    private _nativeSignal;
+    get nativeSignal(): (AbortSignal | null);
+    /**
+     * Throws this signal's abort reason if the signal has been aborted; otherwise it does nothing.
+     */
+    throwIfAborted(): void;
+    /**
+     * Invokes a callback on 'abort', or immediately if already aborted.
+     */
+    onAborted(callback: (event: AbortEvent) => void): Unsubscribe;
+    /**
+     * Sets to the aborted state with the given reason, and emits an 'abort' event.
+     * If this signal is already aborted, this will do nothing.
+     */
+    abort(reason?: Error): void;
+}
+export interface AbortSlot {
+    readonly value: ReadonlyAbort;
+    abort(reason?: Error): void;
+}
+/**
+ * Creates a reusable abort slot that exposes a read-only `Abort` instance.
+ *
+ * Each call to `abort()` triggers the current `Abort` instance, and then replaces it
+ * with a fresh instance for future use. This is useful in systems where cancelable operations
+ * are repeatedly started and each one needs its own `Abort` signal.
+ *
+ * @returns An object with:
+ * - `value`: A read-only reference to the current `Abort` instance.
+ * - `abort(reason)`: Aborts the current instance with the given reason, then creates a new one.
+ *
+ * Example:
+ * ```ts
+ * const slot = createAbortSlot()
+ * fetch(url, { signal: slot.value.signal })
+ * slot.abort() // aborts current Abort value and prepares a new instance
+ * ```
+ */
+export declare function createAbortSlot(): AbortSlot;
+//# sourceMappingURL=Abort.d.ts.map

package/dist/types/ts3.7/util/async/Deferred.d.ts

@@ -0,0 +1,25 @@
+/**
+ * A Deferred object is a Promise with public methods to resolve and reject.
+ *
+ * Example:
+ *
+ * ```
+ *  const deferred = new Deferred<number>()
+ *  setTimeout(() => {
+ *      deferred.resolve(42)
+ *  }, 1000)
+ *
+ *  deferred.then(value => console.log('Resolved to:', value))
+ * ```
+ */
+export declare class Deferred<T> implements Promise<T> {
+    private readonly promise;
+    resolve: (value: T | PromiseLike<T>) => void;
+    reject: (reason?: any) => void;
+    constructor();
+    catch<TResult = never>(onrejected?: ((reason: any) => PromiseLike<TResult> | TResult) | null): Promise<T | TResult>;
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => PromiseLike<TResult1> | TResult1) | null, onrejected?: ((reason: any) => PromiseLike<TResult2> | TResult2) | null): Promise<TResult1 | TResult2>;
+    finally(onfinally?: (() => void) | null): Promise<T>;
+    get [Symbol.toStringTag](): string;
+}
+//# sourceMappingURL=Deferred.d.ts.map

package/dist/types/ts3.7/util/async/TaskQueue.d.ts

@@ -0,0 +1,71 @@
+import { ReadonlyAbort } from './Abort';
+import { Comparator } from '../../util/comparison/compare';
+import { Maybe, MaybePromise } from '../../util/type';
+export type Task<T = void> = (abort: ReadonlyAbort) => MaybePromise<T>;
+/**
+ * A TaskQueue runs actions in a sequence, with the ability to abort the queued tasks.
+ */
+export declare class TaskQueue<PriorityType = undefined> {
+    /**
+     * A comparator for comparing two task priorities.
+     */
+    readonly comparator: Maybe<Comparator<PriorityType>>;
+    /**
+     * The default priority if not provided.
+     * If comparator is nullish priority values will have no effect.
+     */
+    readonly defaultPriority: PriorityType;
+    private _simultaneous;
+    private _running;
+    /**
+     * Use {@link createTaskQueue} to construct a new TaskQueue.
+     */
+    constructor(
+    /**
+     * A comparator for comparing two task priorities.
+     */
+    comparator: Maybe<Comparator<PriorityType>>, 
+    /**
+     * The default priority if not provided.
+     * If comparator is nullish priority values will have no effect.
+     */
+    defaultPriority: PriorityType);
+    get simultaneous(): number;
+    /**
+     * How many simultaneous tasks may be run at a time.
+     * Reducing this will not abort currently running tasks.
+     */
+    set simultaneous(value: number);
+    private pending;
+    private readonly abortSlot;
+    get running(): number;
+    /**
+     * Enqueues the given task, returning a Promise that settles when the task is complete.
+     *
+     * @param task A function that is optionally asynchronous.
+     * @param priority The priority of the task. If not provided, `defaultPriority()` will be used.
+     */
+    enqueue<T>(task: Task<T>, priority?: PriorityType): Promise<T>;
+    /**
+     * If the queue has any remaining actions and if there is additional capacity to execute, picks the next
+     * task with the highest priority according to this queue's comparator.
+     * @private
+     */
+    private checkQueue;
+    /**
+     * Aborts all enqueued operations.
+     */
+    abort(reason?: Error): void;
+}
+/**
+ * Creates a TaskQueue without task prioritization.
+ */
+export declare function createTaskQueue(): TaskQueue;
+/**
+ * Creates a TaskQueue with a priority comparator.
+ *
+ * @param comparator Compares two priority objects.
+ * @param defaultPriority A default priority.
+ */
+export declare function createTaskQueue<PriorityType>(comparator: Comparator<PriorityType>, defaultPriority: PriorityType): TaskQueue<PriorityType>;
+//# sourceMappingURL=TaskQueue.d.ts.map

package/dist/types/ts3.7/util/async/TimeoutController.d.ts

@@ -0,0 +1,36 @@
+import { Disposable } from '../../core/disposable';
+import { Abort, ReadonlyAbort } from './Abort';
+import { Maybe } from '../../util/type';
+/**
+ * A `TimeoutController` is an {@link ReadonlyAbort} implementation that will abort either after
+ * an elapsed timeout, an explicit abort call, or if the optional external abort signal fires.
+ *
+ * This allows a function (such as the network fetch layer) to abort from an externally provided
+ * abort signal, while maintaining its own timeout and abort logic internally.
+ */
+export declare class TimeoutController extends Abort implements ReadonlyAbort, Disposable {
+    readonly timeout: number;
+    private readonly message;
+    private readonly timeoutId;
+    private readonly abortSub;
+    private readonly startedAt;
+    /**
+     * @param timeout The number of seconds before the returned abort signal will abort with a
+     * {@link TimeoutError}.
+     * @param abort An abort signal to cascade.
+     * @param message The timeout message. Uses one token `{time}` which will be replaced by the
+     * timeout.
+     */
+    constructor(timeout: number, abort?: Maybe<ReadonlyAbort>, message?: string);
+    /**
+     * Aborts with a {@link TimeoutError}
+     */
+    abortWithTimeout(): void;
+    /**
+     * Sleeps the given amount of time, or immediately rejects if the sleep will cause a timeout.
+     * @param time The number of seconds to sleep.
+     */
+    sleep(time: number): Promise<void>;
+    dispose(): void;
+}
+//# sourceMappingURL=TimeoutController.d.ts.map

package/dist/types/ts3.7/util/async/TimeoutSlot.d.ts

@@ -0,0 +1,26 @@
+import { Disposable } from '../../core/disposable';
+/**
+ * A TimeoutSlot provides a way to have a managed window timeout that can be added to a
+ * disposer, and guarantee that there is only one timeout active at a time.
+ */
+export declare class TimeoutSlot implements Disposable {
+    private timeoutId;
+    private disposed;
+    get active(): boolean;
+    /**
+     * Sets a timeout, clearing any existing timeout first.
+     *
+     * @param callback The callback to invoke after the given time has elapsed.
+     * @param time The amount of time to wait, in seconds.
+     */
+    set(callback: () => void, time?: number): void;
+    /**
+     * Clears the existing timeout.
+     */
+    clear(): void;
+    /**
+     * Clears the timeout and throws an error if a new one is attempted to be set.
+     */
+    dispose(): void;
+}
+//# sourceMappingURL=TimeoutSlot.d.ts.map

package/dist/types/ts3.7/util/async/abortUtils.d.ts

@@ -0,0 +1,15 @@
+import { ReadonlyAbort } from './Abort';
+import { Maybe } from '../../util/type';
+/**
+ * Races a promise and an abort signal.
+ * Generally, it is better to write your promises in a way that they reject and cleanup after an
+ * abort event (see `promise`), however, external promises don't always provide this
+ * capability.
+ * Some browsers accept an abort signal for `fetch` and `addEventListener`, but this is not
+ * widely supported enough to be relied upon.
+ *
+ * If both the abort signal is in an aborted state, and the given promise is in a resolved state,
+ * the returned promise will be rejected with the abort reason.
+ */
+export declare function withAbort<T>(promise: Promise<T>, abort?: Maybe<ReadonlyAbort>): Promise<T>;
+//# sourceMappingURL=abortUtils.d.ts.map

package/dist/types/ts3.7/util/async/never.d.ts

@@ -0,0 +1,5 @@
+/**
+ * A promise that never settles.
+ */
+export declare const never: Promise<never>;
+//# sourceMappingURL=never.d.ts.map

package/dist/types/ts3.7/util/async/promise.d.ts

@@ -0,0 +1,53 @@
+import { Unsubscribe } from '../../core/Unsubscribe';
+import { ReadonlyAbort } from './Abort';
+import { Maybe } from '../../util/type';
+import { Disposable } from '../../core/disposable';
+/**
+ * Creates a promise that can be rejected early from an abort signal and can optionally provide
+ * cleanup handling when the promise is settled.
+ *
+ * Common cases that require clean-up would be promises based on event listeners that must be
+ * removed, or timers that need to be cleared.
+ *
+ * Promises are always expected to settle. They cannot be canceled, but they can be rejected.
+ * This promise wrapper can be given an {@link ReadonlyAbort} object which rejects the promise
+ * if abort is emitted before the promise settles.
+ *
+ * @param executor A method that will be invoked at most once immediately with two arguments,
+ * `resolve` and `reject`. `resolve` must be called when the promise should be resolved, reject
+ * may be called if the promise should be rejected. An optional function may be returned that
+ * performs any cleanup necessary when the promise settles. This is called immediately before
+ * resolve or reject. The executor may not be invoked if the abortSignal is already in an
+ * aborted state.
+ * @param abort If provided, will reject the returned promise with the signal's abort
+ * reason when aborted.
+ */
+export declare function promise<T>(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => Unsubscribe | void, abort?: Maybe<ReadonlyAbort>): Promise<T>;
+/**
+ * Determines whether a value implements the `PromiseLike<T>` interface.
+ *
+ * This function checks if the given value is a non-null object with a `then` method,
+ * which is the structural requirement for `PromiseLike` in TypeScript.
+ *
+ * @typeParam T - The type the promise resolves to (optional, used for type narrowing).
+ * @param value - The value to check.
+ * @returns `true` if the value is `PromiseLike<T>`, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * const maybePromise: unknown = Promise.resolve(42)
+ * if (isPromiseLike(maybePromise)) {
+ *   maybePromise.then(value => console.log(value)) // value is type-safe
+ * }
+ * ```
+ */
+export declare function isPromiseLike<T = any>(value: unknown): value is PromiseLike<T>;
+/**
+ * Wraps a `PromiseLike<Disposable>` with a `Disposable` interface.
+ * Disposing will abort the operation and dispose the resolved value (if/when it resolves).
+ *
+ * @param promise - A Promise-like object that resolves to a `Disposable`
+ * @returns An object that implements both `PromiseLike<T>` and `Disposable`
+ */
+export declare function toDisposablePromise<T extends PromiseLike<any>>(promise: T): T & Disposable;
+//# sourceMappingURL=promise.d.ts.map

package/dist/types/ts3.7/util/async/sleep.d.ts

@@ -0,0 +1,27 @@
+import { ReadonlyAbort } from './Abort';
+/**
+ * Returns a promise that resolves after the given amount of time.
+ *
+ * Usage example:
+ * ```
+ * async function doThingsWithAbort(abort) {
+ *   await foo();
+ *   await sleep(2, abort);
+ *   await foo();
+ *   await sleep(5, abort);
+ *   await foo();
+ * }
+ *
+ * const abort = new Abort();
+ * doThingsWithAbort(abort).catch(() => console.log('aborted'))';
+ *
+ * abort.abort();
+ * ```
+ *
+ * @param time The time to sleep, in seconds.
+ * @param abort If provided, will reject the returned promise with the signal's abort
+ * reason when aborted. If the signal is already aborted and time is less than or equal to zero,
+ * the abort signal takes precedence.
+ */
+export declare function sleep(time: number, abort?: ReadonlyAbort | null): Promise<void>;
+//# sourceMappingURL=sleep.d.ts.map

package/dist/types/ts3.7/util/async/timeout.d.ts

@@ -0,0 +1,29 @@
+import { ReadonlyAbort } from './Abort';
+import { ErrorLevel } from '../../error/ReportableError';
+export declare const DEFAULT_TIMEOUT_MESSAGE = "Timed out after {time}s";
+/**
+ * Races a promise with a timeout, rejecting with a {@link TimeoutError} if the timeout is
+ * reached before the provided promise.
+ *
+ * @param promise The promise to race against a timeout.
+ * @param time The number of seconds to wait. If undefined, the promise is returned without
+ * wrapping.
+ * @param message The message to set in the {@link TimeoutError}. Uses `{time}` token.
+ * @param origin The error origin. (default: `ErrorOrigin.INTERNAL`)
+ * @param level The error level (default: `ErrorLevel.FATAL`)
+ */
+export declare function withTimeout<T>(promise: PromiseLike<T>, time?: number, message?: string, origin?: string, level?: ErrorLevel): Promise<T>;
+/**
+ * Returns a promise that will reject after the provided number of seconds.
+ * If the optional abort signal is aborted, the timer will be canceled and the promise resolved.
+ * This is the inverse of {@link sleep}
+ *
+ * @param time The number of seconds to wait.
+ * @param abort If provided, when aborted (regardless of reason) will resolve the returned
+ * promise.
+ * @param message The message to be used in the TimeoutError in case of timeout. Uses `{time}` token.
+ * @param origin The error origin. (default: `ErrorOrigin.INTERNAL`)
+ * @param level The error level (default: `ErrorLevel.FATAL`)
+ */
+export declare function timeout(time: number, abort?: ReadonlyAbort, message?: string, origin?: string, level?: ErrorLevel): Promise<void>;
+//# sourceMappingURL=timeout.d.ts.map

package/dist/types/ts3.7/util/browser/searchParams.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Returns a `URLSearchParams` object for the given search substring. This is memoized for the
+ * last search provided.
+ * @param search (Optional) The window's search substring. Defaults to `location.search`, overridden
+ * only for unit tests.
+ */
+export declare const getSearchParams: import("../../util/fun/memoize").MemoizedFunction & ((search?: string) => URLSearchParams);
+/**
+ * If the environment has a `location` object, returns the location's search. Otherwise,
+ * an empty string.
+ */
+export declare function getLocationSearch(): string;
+//# sourceMappingURL=searchParams.d.ts.map

package/dist/types/ts3.7/util/buffer/BufferError.d.ts

@@ -0,0 +1,6 @@
+import { ErrorLevel, ReportableError } from '../../error/ReportableError';
+export declare class BufferError extends ReportableError {
+    get [Symbol.toStringTag](): string;
+    constructor(message: string, origin?: string, level?: ErrorLevel);
+}
+//# sourceMappingURL=BufferError.d.ts.map

package/dist/types/ts3.7/util/buffer/BufferReader.d.ts

@@ -0,0 +1,77 @@
+export declare class BufferReader {
+    position: number;
+    private dataView;
+    constructor(buffer: ArrayBuffer);
+    /**
+     * Asserts that at least `size` bytes are remaining.
+     * @param size
+     */
+    assertRemaining(size: number): void;
+    hasNext(): boolean;
+    get remaining(): number;
+    skip(bytes: number): void;
+    /**
+     * Reads the next Float32 value.
+     * @param littleEndian If false or undefined, a big-endian value should be read.
+     */
+    readFloat32(littleEndian?: boolean): number;
+    /**
+     * Reads the next Float64 value.
+     * @param littleEndian If false or undefined, a big-endian value should be read.
+     */
+    readFloat64(littleEndian?: boolean): number;
+    /**
+     * Reads the next Int8 value.
+     */
+    readInt8(): number;
+    /**
+     * Reads the next Int16 value.
+     * @param littleEndian If false or undefined, a big-endian value should be read.
+     */
+    readInt16(littleEndian?: boolean): number;
+    /**
+     * Reads the next Int32 value.
+     * @param littleEndian If false or undefined, a big-endian value should be read.
+     */
+    readInt32(littleEndian?: boolean): number;
+    /**
+     * Reads the next Int64 value.
+     * @param littleEndian If false or undefined, a big-endian value should be read.
+     */
+    readInt64(littleEndian?: boolean): bigint;
+    /**
+     * Reads the next Uint8 value.
+     */
+    readUint8(): number;
+    /**
+     * Reads the next Uint16 value.
+     * @param littleEndian If false or undefined, a big-endian value should be read.
+     */
+    readUint16(littleEndian?: boolean): number;
+    /**
+     * Reads the next Uint32 value.
+     * @param littleEndian If false or undefined, a big-endian value should be read.
+     */
+    readUint32(littleEndian?: boolean): number;
+    /**
+     * Reads the next Uint64 value.
+     * @param littleEndian If false or undefined, a big-endian value should be read.
+     */
+    readUint64(littleEndian?: boolean): bigint;
+    /**
+     * Reads from the current position into a sliced array buffer of the given size.
+     * @param count
+     */
+    readBytes(count: number): ArrayBuffer;
+    /**
+     * Reads the given number of characters into a byte string.
+     * @param length
+     */
+    readString(length: number): string;
+    /**
+     * Reads the given number of characters into a UTF-16 string.
+     * @param length
+     */
+    readUtf16String(length: number): string;
+}
+//# sourceMappingURL=BufferReader.d.ts.map

package/dist/types/ts3.7/util/buffer/BufferWriter.d.ts

@@ -0,0 +1,30 @@
+/**
+ * A growable binary buffer writer. Writes big-endian by default, matching
+ * network byte order used by MP4 and MPEG-TS.
+ */
+export declare class BufferWriter {
+    private buffer;
+    private dataView;
+    position: number;
+    constructor(initialCapacity?: number);
+    private ensureCapacity;
+    writeUint8(value: number): void;
+    writeUint16(value: number, littleEndian?: boolean): void;
+    writeUint32(value: number, littleEndian?: boolean): void;
+    writeInt16(value: number, littleEndian?: boolean): void;
+    writeInt32(value: number, littleEndian?: boolean): void;
+    writeBytes(data: ArrayBuffer | Uint8Array): void;
+    /**
+     * Writes a fixed-length ASCII string.
+     */
+    writeString(str: string): void;
+    /**
+     * Returns the written data as a trimmed ArrayBuffer.
+     */
+    toArrayBuffer(): ArrayBuffer;
+    /**
+     * Returns the written data as a Uint8Array view.
+     */
+    toUint8Array(): Uint8Array;
+}
+//# sourceMappingURL=BufferWriter.d.ts.map

package/dist/types/ts3.7/util/buffer/buffer.d.ts

@@ -0,0 +1,55 @@
+import { Maybe } from '../../util/type';
+/**
+ * Converts a byte buffer to an 8-bit width string.
+ *
+ * @return Returns a single-byte string.
+ * @param buffer
+ */
+export declare function bufferToByteStr(buffer: ArrayLike<number> | ArrayBuffer): string;
+/**
+ * Converts a byte string to a byte array.
+ *
+ * @param byteStr The 8 bit-width string to convert to a byte array.
+ * @return Returns a byte array representing the byte string.
+ */
+export declare function byteStrToByteArray(byteStr: string): Uint8Array;
+/**
+ * Converts an array buffer of binary data to a Base64 encoded string.
+ *
+ * @param buffer a buffer of binary data.
+ * @return Returns a Base64 encoded string representing the provided binary data.
+ */
+export declare function bufferToBase64(buffer: ArrayLike<number> | ArrayBuffer): string;
+/**
+ * Converts a Base64 encoded string into a byte array.
+ * The 6-bit width Base64 data is converted to a binary string then written to a byte array.
+ *
+ * @param base64 A Base64 encoded string.
+ */
+export declare function base64ToByteArray(base64: string): Uint8Array;
+/**
+ * Converts a 16-bit buffer of any length to a utf-16 string.
+ *
+ * @see https://developer.chrome.com/blog/how-to-convert-arraybuffer-to-and-from-string
+ *
+ * @param buffer An iterable of double-byte code points.
+ * @return Returns a UTF-16 string.
+ */
+export declare function bufferToUtf16(buffer: ArrayLike<number> | ArrayBuffer): string;
+/**
+ * Converts a UTF-16 string to a Uint16Array.
+ *
+ * @see https://developer.chrome.com/blog/how-to-convert-arraybuffer-to-and-from-string
+ * @param str A UTF-16 string.
+ */
+export declare function utf16ToUint16Array(str: string): Uint16Array;
+/**
+ * If a byte array is provided, returns as is, otherwise creates a Uint8Array from an array buffer like.
+ * @param buffer
+ */
+export declare function bufferToByteArray(buffer: Uint8Array | ArrayLike<number> | ArrayBuffer): Uint8Array;
+/**
+ * Returns true if the two buffers are equal.
+ */
+export declare function buffersEqual(bufferA: Maybe<Uint8Array | ArrayLike<number> | ArrayBuffer>, bufferB: Maybe<Uint8Array | ArrayLike<number> | ArrayBuffer>): boolean;
+//# sourceMappingURL=buffer.d.ts.map

package/dist/types/ts3.7/util/collection/CacheMap.d.ts

@@ -0,0 +1,12 @@
+/**
+ * A CacheMap is a Map that notifies when an entry is evicted.
+ */
+export interface CacheMap<K, V> extends Map<K, V> {
+    /**
+     * When an entry is added when at capacity, the least recently used entry will be removed.
+     * This callback can be set to be notified with the element and key being evicted, which may be
+     * used for disposal.
+     */
+    onEvict: ((element: V, key: K, list: CacheMap<K, V>) => void) | null;
+}
+//# sourceMappingURL=CacheMap.d.ts.map