@amazon/vinyl-util 1.1.1 → 2.0.0

package/dist/types/ts4.1/persistence/persistenceRef.d.ts

@@ -1,7 +1,7 @@
-import type { KeyValuePersistence } from '../persistence/KeyValuePersistence';
+import type { KeyValuePersistence } from './KeyValuePersistence';
 /**
  * The default storage persistence for simple key / value pairs.
  * This may be overridden, and by default resolves to local storage persistence.
  */
-export declare const persistenceRef: import("../global/globalRegistry").GlobalRef<KeyValuePersistence<string>>;
+export declare const persistenceRef: import("..").GlobalRef<KeyValuePersistence<string>>;
 //# sourceMappingURL=persistenceRef.d.ts.map

package/dist/types/ts4.1/util/async/TaskQueue.d.ts

@@ -1,6 +1,6 @@
 import type { ReadonlyAbort } from './Abort';
-import type { Comparator } from '../../util/comparison/compare';
-import type { Maybe, MaybePromise } from '../../util/type';
+import type { Comparator } from '../comparison/compare';
+import type { Maybe, MaybePromise } from '../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.

package/dist/types/ts4.1/util/async/TimeoutController.d.ts

@@ -1,7 +1,7 @@
 import type { Disposable } from '../../core/disposable';
 import type { ReadonlyAbort } from './Abort';
 import { Abort } from './Abort';
-import type { Maybe } from '../../util/type';
+import type { Maybe } from '../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.

package/dist/types/ts4.1/util/async/abortUtils.d.ts

@@ -1,5 +1,5 @@
 import type { ReadonlyAbort } from './Abort';
-import type { Maybe } from '../../util/type';
+import type { Maybe } from '../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

package/dist/types/ts4.1/util/async/poll.d.ts

@@ -0,0 +1,34 @@
+import type { ReadonlyAbort } from './Abort';
+import type { Maybe } from '../type';
+export interface PollOptions {
+    /**
+     * How long to keep polling before giving up, in seconds. If omitted,
+     * polling continues indefinitely until the predicate returns `true` (or the
+     * signal aborts).
+     */
+    readonly timeout?: number;
+    /**
+     * If provided, aborting rejects the returned promise with the signal's
+     * abort reason, cancelling the poll.
+     */
+    readonly abort?: Maybe<ReadonlyAbort>;
+    /**
+     * How often to re-evaluate the predicate, in seconds. Defaults to `0.05`
+     * (50ms).
+     */
+    readonly pollInterval?: number;
+}
+/**
+ * Repeatedly evaluates `predicate` until it returns `true` or the timeout
+ * elapses, resolving to the predicate's final value. Useful for waiting on
+ * asynchronous state to settle without wiring up an event subscription.
+ *
+ * @param predicate Evaluated immediately and then every `pollInterval` seconds.
+ * Polling stops as soon as it returns `true`.
+ * @param options Optional {@link PollOptions}. With no `timeout`, polling
+ * continues indefinitely until the predicate is `true` or `abort` fires.
+ * @returns `true` if the predicate became true within the timeout, otherwise
+ * `false`.
+ */
+export declare function poll(predicate: () => boolean, options?: PollOptions): Promise<boolean>;
+//# sourceMappingURL=poll.d.ts.map

package/dist/types/ts4.1/util/async/promise.d.ts

@@ -1,6 +1,6 @@
 import type { Unsubscribe } from '../../core/Unsubscribe';
 import type { ReadonlyAbort } from './Abort';
-import type { Maybe } from '../../util/type';
+import type { Maybe } from '../type';
 import type { Disposable } from '../../core/disposable';
 /**
  * Creates a promise that can be rejected early from an abort signal and can optionally provide

package/dist/types/ts4.1/util/async/sleep.d.ts

@@ -1,4 +1,5 @@
 import type { ReadonlyAbort } from './Abort';
+import type { Maybe } from '../type';
 /**
  * Returns a promise that resolves after the given amount of time.
  *
@@ -23,5 +24,5 @@ import type { ReadonlyAbort } from './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>;
+export declare function sleep(time: number, abort?: Maybe<ReadonlyAbort>): Promise<void>;
 //# sourceMappingURL=sleep.d.ts.map

package/dist/types/ts4.1/util/async/timeout.d.ts

@@ -1,6 +1,24 @@
 import type { ReadonlyAbort } from './Abort';
 import { ErrorLevel } from '../../error/ReportableError';
 export declare const DEFAULT_TIMEOUT_MESSAGE = "Timed out after {time}s";
+/**
+ * Options for {@link withTimeout}.
+ */
+export interface WithTimeoutOptions {
+    /**
+     * The message to set in the {@link TimeoutError}. Uses `{time}` token.
+     * (default: {@link DEFAULT_TIMEOUT_MESSAGE})
+     */
+    readonly message?: string | undefined;
+    /**
+     * The error origin. (default: `ErrorOrigin.INTERNAL`)
+     */
+    readonly origin?: string | undefined;
+    /**
+     * The error level. (default: `ErrorLevel.FATAL`)
+     */
+    readonly level?: ErrorLevel | undefined;
+}
 /**
  * Races a promise with a timeout, rejecting with a {@link TimeoutError} if the timeout is
  * reached before the provided promise.
@@ -8,22 +26,26 @@ export declare const DEFAULT_TIMEOUT_MESSAGE = "Timed out after {time}s";
  * @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`)
+ * @param options Timeout error options (message, origin, level).
+ */
+export declare function withTimeout<T>(promise: PromiseLike<T>, time?: number, options?: WithTimeoutOptions): Promise<T>;
+/**
+ * Options for {@link timeout}.
  */
-export declare function withTimeout<T>(promise: PromiseLike<T>, time?: number, message?: string, origin?: string, level?: ErrorLevel): Promise<T>;
+export interface TimeoutOptions extends WithTimeoutOptions {
+    /**
+     * If provided, when aborted (regardless of reason) will resolve the
+     * returned promise rather than rejecting.
+     */
+    readonly abort?: ReadonlyAbort | undefined;
+}
 /**
  * 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`)
+ * @param options Timeout options (abort, message, origin, level).
  */
-export declare function timeout(time: number, abort?: ReadonlyAbort, message?: string, origin?: string, level?: ErrorLevel): Promise<void>;
+export declare function timeout(time: number, options?: TimeoutOptions): Promise<void>;
 //# sourceMappingURL=timeout.d.ts.map

package/dist/types/ts4.1/util/browser/searchParams.d.ts

@@ -4,7 +4,7 @@
  * @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);
+export declare const getSearchParams: import("../..").MemoizedFunction & ((search?: string) => URLSearchParams);
 /**
  * If the environment has a `location` object, returns the location's search. Otherwise,
  * an empty string.

package/dist/types/ts4.1/util/buffer/buffer.d.ts

@@ -1,4 +1,4 @@
-import type { Maybe } from '../../util/type';
+import type { Maybe } from '../type';
 /**
  * Converts a byte buffer to an 8-bit width string.
  *

package/dist/types/ts4.1/util/collection/CacheMap.d.ts

@@ -1,7 +1,17 @@
 /**
- * A CacheMap is a Map that notifies when an entry is evicted.
+ * A map that notifies when an entry is evicted.
+ *
+ * Mirrors the ES2015 `Map<K, V>` interface (no iteration methods) so implementers
+ * are not coupled to the evolving `MapIterator` shape in newer lib types.
  */
-export interface CacheMap<K, V> extends Map<K, V> {
+export interface CacheMap<K, V> {
+    readonly size: number;
+    has(key: K): boolean;
+    get(key: K): V | undefined;
+    set(key: K, value: V): this;
+    delete(key: K): boolean;
+    clear(): void;
+    forEach(callbackfn: (value: V, key: K, map: CacheMap<K, V>) => void, thisArg?: any): void;
     /**
      * 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

package/dist/types/ts4.1/util/collection/LinkedList.d.ts

@@ -148,9 +148,6 @@ export declare class LinkedList<T> implements Iterable<T> {
      * @param end The ending node (exclusive).
      * @param next A method that is given the current node, and returns the next node.
      */
-    createIterator(start: LinkedNode<T> | null, end: LinkedNode<T> | null, next: (current: LinkedNode<T>) => LinkedNode<T> | null): {
-        [Symbol.iterator](): IterableIterator<T>;
-        next: () => IteratorResult<T>;
-    };
+    createIterator(start: LinkedNode<T> | null, end: LinkedNode<T> | null, next: (current: LinkedNode<T>) => LinkedNode<T> | null): IterableIterator<T>;
 }
 //# sourceMappingURL=LinkedList.d.ts.map

package/dist/types/ts4.1/util/collection/array.d.ts

@@ -1,5 +1,5 @@
-import type { Comparator } from '../../util/comparison/compare';
-import type { Maybe, MaybePromise, Primitive } from '../../util/type';
+import type { Comparator } from '../comparison/compare';
+import type { Maybe, MaybePromise, Primitive } from '../type';
 export type FilterPredicateAsync<T> = (value: T, index: number, array: ArrayLike<T>) => Promise<boolean>;
 export type FilterPredicate<T> = (value: T, index: number, array: ArrayLike<T>) => boolean;
 /**

package/dist/types/ts4.1/util/comparison/compare.d.ts

@@ -1,4 +1,4 @@
-import type { Maybe, Primitive } from '../../util/type';
+import type { Maybe, Primitive } from '../type';
 /**
  * A function that can be used as a comparator for sorting.
  * Return > 0 if `a` is greater than `b`

package/dist/types/ts4.1/util/config/ValueProvider.d.ts

@@ -1,4 +1,4 @@
-import type { MaybePromise } from '../../util/type';
+import type { MaybePromise } from '../type';
 /**
  * A value of type T, a function returning T, or an async function returning a Promise<T>.
  * To be used with `resolveValueProvider`.

package/dist/types/ts4.1/util/date/date.d.ts

@@ -1,4 +1,4 @@
-import type { ReadonlyDate } from '../../util/object/readonlyType';
+import type { ReadonlyDate } from '../object/readonlyType';
 /**
  * Returns the signed time difference of end - start, in seconds.
  *

package/dist/types/ts4.1/util/error/stack.d.ts

@@ -1,4 +1,4 @@
-import type { Maybe } from '../../util/type';
+import type { Maybe } from '../type';
 /**
  * A location in code.
  */
@@ -26,7 +26,7 @@ export interface CodeLocation {
  *
  * @private
  */
-export declare const codeLocationComparator: import("../../util/comparison/compare").Comparator<Maybe<CodeLocation>, Maybe<CodeLocation>>;
+export declare const codeLocationComparator: import("../..").Comparator<Maybe<CodeLocation>, Maybe<CodeLocation>>;
 /**
  * Boundary code locations, used to determine if an error is within a certain range of code.
  * The start and end boundaries must be the same path and file to be a valid range.
@@ -75,5 +75,5 @@ export declare const stackNoiseError2: Error;
  * When corejs polyfills Error with clearErrorStack, the stack may begin with the polyfill
  * location. Trim the beginning of stacks with the leading lines common to all errors.
  */
-export declare const stackNoise: import("../../util/object/lazy").Lazy<string>;
+export declare const stackNoise: import("../..").Lazy<string>;
 //# sourceMappingURL=stack.d.ts.map

package/dist/types/ts4.1/util/fun/memoize.d.ts

@@ -1,4 +1,4 @@
-import type { Fun } from '../../util/type';
+import type { Fun } from '../type';
 export interface MemoizedFunction {
     clear(): void;
 }

package/dist/types/ts4.1/util/map/map.d.ts

@@ -1,3 +1,11 @@
+/**
+ * The minimal `Map`-shaped interface that {@link getOrSet} needs.
+ */
+export interface GetOrSetMap<K, V> {
+    has(key: K): boolean;
+    get(key: K): V | undefined;
+    set(key: K, value: V): unknown;
+}
 /**
  * Gets the value on map for the given key if it exists, otherwise sets [key] to `defaultValue`,
  * returning the newly set value.
@@ -6,12 +14,15 @@
  * @param key
  * @param defaultValue
  */
-export declare function getOrSet<K, V>(map: Map<K, V>, key: K, defaultValue: (key: K) => V): V;
+export declare function getOrSet<K, V>(map: GetOrSetMap<K, V>, key: K, defaultValue: (key: K) => V): V;
 /**
  * Flips a map so that the keys become the values and the values become the keys.
  *
  * @param map
  * @return Returns a new map.
  */
-export declare function flipMap<K, V>(map: ReadonlyMap<K, V>): Map<V, K>;
+export declare function flipMap<K, V>(map: Iterable<readonly [
+    K,
+    V
+]>): Map<V, K>;
 //# sourceMappingURL=map.d.ts.map

package/dist/types/ts4.1/util/network/request.d.ts

@@ -1,4 +1,4 @@
-import type { Maybe } from '../../util/type';
+import type { Maybe } from '../type';
 /**
  * Given request parameters, returns the header for the given key, or null.
  */

package/dist/types/ts4.1/util/object/equalDeep.d.ts

@@ -1,4 +1,4 @@
-import type { TypedArray } from '../../util/collection/typedArray';
+import type { TypedArray } from '../collection/typedArray';
 /**
  * Recursively compares the values of all the enumerable own properties from two source objects.
  *

package/dist/types/ts4.1/util/object/mergeDeep.d.ts

@@ -1,4 +1,4 @@
-import type { TypedArray } from '../../util/collection/typedArray';
+import type { TypedArray } from '../collection/typedArray';
 import { ReportableError } from '../../error/ReportableError';
 import type { Cloneable } from '../../core/cloneable';
 /**

package/dist/types/ts4.1/util/object/mutableType.d.ts

@@ -1,4 +1,4 @@
-import type { Fun } from '../../util/type';
+import type { Fun } from '../type';
 import type { ReadonlyDate, ReadonlyMap, ReadonlySet } from './readonlyType';
 /**
  * Recursively removes read only modifiers.

package/dist/types/ts4.1/util/object/readonlyType.d.ts

@@ -1,4 +1,4 @@
-import type { Fun } from '../../util/type';
+import type { Fun } from '../type';
 /**
  * Recursively marks Objects, Arrays, Maps, Sets, or Dates as read only.
  * Other non-primitive types will retain their method signatures, potentially exposing mutation

package/dist/types/ts4.1/util/range/IntersectionRanges.d.ts

@@ -1,6 +1,6 @@
 import type { Range, ReadonlyRanges } from './Ranges';
 import { ReadonlyRangesImpl } from './Ranges';
-import type { Maybe } from '../../util/type';
+import type { Maybe } from '../type';
 export interface IntersectionRangesOptions {
     /**
      * If true, only recomputes ranges after a call to `invalidate`.

package/dist/types/ts4.1/util/range/UnionRanges.d.ts

@@ -1,6 +1,6 @@
 import type { Range, ReadonlyRanges } from './Ranges';
 import { ReadonlyRangesImpl } from './Ranges';
-import type { Maybe } from '../../util/type';
+import type { Maybe } from '../type';
 export interface UnionRangesOptions {
     /**
      * If true, only recomputes ranges after a call to `invalidate`.

package/dist/types/ts4.1/util/serialization/json.d.ts

@@ -1,4 +1,4 @@
-import type { AnyRecord, Fun, IsAny } from '../../util/type';
+import type { AnyRecord, Fun, IsAny } from '../type';
 /**
  * A representation of the conversion the toJson function will apply to make an input JSON compatible.
  */

package/dist/types/ts4.1/util/serialization/primitives.d.ts

@@ -1,4 +1,4 @@
-import type { Maybe } from '../../util/type';
+import type { Maybe } from '../type';
 /**
  * Returns true if the given string is 'true' or '1'
  *

package/dist/types/ts4.1/util/string/StringReader.d.ts

@@ -1,6 +1,6 @@
 import { ReportableError } from '../../error/ReportableError';
-import type { ParseError } from '../../util/serialization/ParseError';
-import type { Json } from '../../util/serialization/json';
+import type { ParseError } from '../serialization/ParseError';
+import type { Json } from '../serialization/json';
 /**
  * A cursor on a string that allows for fast, naive parsing.
  */

package/dist/types/ts4.1/util/string/string.d.ts

@@ -1,5 +1,5 @@
-import type { Maybe } from '../../util/type';
-import type { ReadonlyRecord } from '../../util/object/readonlyType';
+import type { Maybe } from '../type';
+import type { ReadonlyRecord } from '../object/readonlyType';
 /**
  * Substitutes named variable references in a string.
  *

package/dist/types/ts4.1/util/type.d.ts

@@ -170,4 +170,25 @@ export type IsAny<T> = 0 extends 1 & T ? true : false;
  * @returns `true` if `P` is an optional property, otherwise `false`.
  */
 export type IsPropertyOptional<U, P extends keyof U> = AnyRecord extends Pick<U, P> ? true : false;
+/**
+ * A type that equals true if Left and Right are loosely equal, that is, that Left extends Right
+ * and Right extends Left.
+ * This will always equal true or false, and never the union `true | false`
+ */
+export type Equal<Left, Right> = [
+    Left
+] extends [
+    Right
+] ? [
+    Right
+] extends [
+    Left
+] ? true : false : false;
+/**
+ * A type that equals true if Left and Right are strictly equal.
+ * Works with complex objects, readonly, and optional modifiers.
+ * Works with method input arguments.
+ * This will always equal true or false, and never the union `true | false`
+ */
+export type StrictEqual<Left, Right> = (<T>() => T extends Left ? 0 : 1) extends <T>() => T extends Right ? 0 : 1 ? Equal<Left, Right> : false;
 //# sourceMappingURL=type.d.ts.map

package/dist/types/ts4.1/util/url/resolveUrl.d.ts

@@ -3,7 +3,8 @@
  * avoiding the overhead of constructing `URL` objects.
  *
  * Handles the same cases as `new URL(relative, base)`:
- * - Absolute URIs (with scheme) are returned as-is.
+ * - Absolute URIs (with any scheme, including `data:` / `blob:`) are returned
+ *   as-is.
  * - Protocol-relative URIs (`//host/path`) inherit the base scheme.
  * - Absolute paths (`/path`) replace the base path.
  * - Relative paths are resolved against the base directory.

package/dist/types/ts4.7/client/userAgent/UserAgentInfo.d.ts

@@ -1,4 +1,4 @@
-import type { Version } from '../../client/Version';
+import type { Version } from '../Version';
 /**
  * A parsed user agent.
  */

package/dist/types/ts4.7/client/userAgent/parseUserAgent.d.ts

@@ -8,7 +8,7 @@ import type { UserAgentInfo } from './UserAgentInfo';
  * @param rules The user agent rules.
  */
 export declare function parseUserAgent(userAgent?: Maybe<string>, rules?: UserAgentRules): UserAgentInfo;
-export declare const userAgentInfoRef: import("../../global/globalRegistry").GlobalRef<UserAgentInfo>;
+export declare const userAgentInfoRef: import("../..").GlobalRef<UserAgentInfo>;
 export declare function getUserAgentInfo(): UserAgentInfo;
 export declare function setUserAgent(value: string): void;
 //# sourceMappingURL=parseUserAgent.d.ts.map

package/dist/types/ts4.7/client/userAgent/tokenizeUserAgent.d.ts

@@ -1,5 +1,5 @@
 import type { Maybe } from '../../util/type';
-import type { Version } from '../../client/Version';
+import type { Version } from '../Version';
 import type { UaDeviceInfo, UaSystemInfo } from './UserAgentInfo';
 /**
  * Builds a tokenized user agent for faster queries.

package/dist/types/ts4.7/core/disposable.d.ts

@@ -1,5 +1,5 @@
 import { IllegalStateError } from '../error/IllegalStateError';
-import type { Unsubscribe } from '../core/Unsubscribe';
+import type { Unsubscribe } from './Unsubscribe';
 import type { Maybe } from '../util/type';
 /**
  * Any object that may be disposed.

package/dist/types/ts4.7/error/MediaUnsupportedError.d.ts

@@ -1,4 +1,4 @@
-import { ReportableError } from '../error/ReportableError';
+import { ReportableError } from './ReportableError';
 import type { Json } from '../util/serialization/json';
 export declare class MediaUnsupportedError extends ReportableError {
     readonly code: string;

package/dist/types/ts4.7/error/ValidationError.d.ts

@@ -1,4 +1,4 @@
-import { ReportableError } from '../error/ReportableError';
+import { ReportableError } from './ReportableError';
 import type { Json } from '../util/serialization/json';
 /**
  * An error indicating that input had an invalid shape.

package/dist/types/ts4.7/event/DomEventHost.d.ts

@@ -40,6 +40,6 @@ export declare class DomEventHost<EventMap> implements DomReadonlyEventHost<Even
      * Disposal of a DomEventHost removes all listeners.
      */
     dispose(): void;
-    __eventMapType: import("../util/type").Covariant<EventMap>;
+    __eventMapType: import("..").Covariant<EventMap>;
 }
 //# sourceMappingURL=DomEventHost.d.ts.map

package/dist/types/ts4.7/event/nextEventAsPromise.d.ts

@@ -1,23 +1,33 @@
 import type { ReadonlyEventHost } from './EventHost';
 import type { ReadonlyAbort } from '../util/async/Abort';
 import type { Maybe } from '../util/type';
+import { ErrorLevel } from '../error/ReportableError';
 export interface NextEventAsPromiseOptions<EventMap, K extends keyof EventMap> {
     /**
      * (Optional) If provided, will only resolve if the event passes this predicate.
      */
-    filter?: ((event: EventMap[K]) => boolean) | undefined | null;
+    readonly filter?: ((event: EventMap[K]) => boolean) | undefined | null;
     /**
      * (Optional) If provided, will reject the promise if the signal is aborted.
      */
-    abort?: Maybe<ReadonlyAbort>;
+    readonly abort?: Maybe<ReadonlyAbort>;
     /**
      * If provided, the promise will reject after this duration, in seconds, if not resolved.
      */
-    timeout?: number;
+    readonly timeout?: number;
     /**
      * The timeout message. If not provided will use `DEFAULT_TIMEOUT_MESSAGE`.
      */
-    timeoutMessage?: string;
+    readonly timeoutMessage?: string;
+    /**
+     * The error origin if the next event times out.
+     * Default: `ErrorOrigin.INTERNAL`
+     */
+    readonly timeoutOrigin?: string;
+    /**
+     * The error level on a timeout.
+     */
+    readonly timeoutLevel?: ErrorLevel;
 }
 /**
  * Promisifies the next event.