@amazon/vinyl-util 1.2.0 → 2.0.4

package/dist/types/ts4.1/index.d.ts

@@ -1,118 +1,119 @@
 /** Auto-generated from build scripts */
-export * from './util/type';
-export * from './util/url/resolveUrl';
-export * from './util/string/uid';
-export * from './util/string/string';
-export * from './util/string/StringReader';
-export * from './util/set/set';
-export * from './util/serialization/stringifyForPrint';
-export * from './util/serialization/primitives';
-export * from './util/serialization/json';
-export * from './util/serialization/ParseError';
-export * from './util/range/timeRanges';
-export * from './util/range/UnionRanges';
-export * from './util/range/Ranges';
-export * from './util/range/IntersectionRanges';
-export * from './util/object/readonlyType';
-export * from './util/object/object';
-export * from './util/object/mutableType';
-export * from './util/object/mergeDeep';
-export * from './util/object/merge';
-export * from './util/object/lazy';
-export * from './util/object/equalDeep';
-export * from './util/object/clone';
-export * from './util/network/request';
-export * from './util/mpeg/parseSidxBox';
-export * from './util/math/math';
-export * from './util/map/map';
-export * from './util/iteration/iterable';
-export * from './util/fun/throttle';
-export * from './util/fun/memoize';
-export * from './util/fun/function';
-export * from './util/fun/flow';
-export * from './util/fun/debounce';
-export * from './util/error/stack';
-export * from './util/date/date';
-export * from './util/config/ValueProvider';
-export * from './util/comparison/compare';
-export * from './util/collection/typedArray';
-export * from './util/collection/array';
-export * from './util/collection/LruCache';
-export * from './util/collection/LinkedList';
-export * from './util/collection/CacheMap';
-export * from './util/buffer/buffer';
-export * from './util/buffer/BufferWriter';
-export * from './util/buffer/BufferReader';
-export * from './util/buffer/BufferError';
-export * from './util/browser/searchParams';
-export * from './util/async/timeout';
-export * from './util/async/sleep';
-export * from './util/async/promise';
-export * from './util/async/never';
-export * from './util/async/abortUtils';
-export * from './util/async/TimeoutSlot';
-export * from './util/async/TimeoutController';
-export * from './util/async/TaskQueue';
-export * from './util/async/Deferred';
-export * from './util/async/Abort';
-export * from './persistence/persistenceRef';
-export * from './persistence/StoragePersistence';
-export * from './persistence/PersistentItem';
-export * from './persistence/KeyValuePersistence';
-export * from './patch/patchTarget';
-export * from './patch/network/fetch';
-export * from './network/responseUtil';
-export * from './network/requesterUtil';
-export * from './network/requesterGlobal';
-export * from './network/network';
-export * from './network/createRequester';
-export * from './network/RequesterImplEventMap';
-export * from './network/RequesterImpl';
-export * from './network/Requester';
-export * from './network/RequestInterceptor';
-export * from './network/RequestError';
-export * from './network/metrics/networkMetricsModel';
-export * from './network/metrics/networkMetricsGlobal';
-export * from './network/metrics/NetworkMetricsControllerImpl';
-export * from './network/metrics/NetworkMetricsController';
-export * from './network/logging/networkLoggingHandler';
-export * from './network/browser/NetworkInformation';
-export * from './logging/logTimer';
+export * from './client/userAgent/defaultUserAgentRules';
+export * from './client/userAgent/hasBrowser';
+export * from './client/userAgent/parseUserAgent';
+export * from './client/userAgent/tokenizeUserAgent';
+export * from './client/userAgent/UserAgentInfo';
+export * from './client/userAgent/userAgentRuleHelpers';
+export * from './client/Version';
+export * from './core/clearable';
+export * from './core/cloneable';
+export * from './core/disposable';
+export * from './core/Unsubscribe';
+export * from './error/AbortError';
+export * from './error/ErrorOrigin';
+export * from './error/IllegalArgumentError';
+export * from './error/IllegalStateError';
+export * from './error/MediaUnsupportedError';
+export * from './error/ReportableError';
+export * from './error/ServiceResponseError';
+export * from './error/StackOverflowError';
+export * from './error/TimeoutError';
+export * from './error/UnreachableCodeError';
+export * from './error/ValidationError';
+export * from './event/DomEventHost';
+export * from './event/EventHost';
+export * from './event/nextEventAsPromise';
+export * from './event/onAny';
+export * from './event/redispatchEvents';
+export * from './event/Signal';
+export * from './global/environment';
+export * from './global/globalRegistry';
+export * from './global/globalTarget';
+export * from './logging/ConsoleLogHandler';
 export * from './logging/getLogLevelFromSearch';
-export * from './logging/VinylLogging';
+export * from './logging/HistoryLogHandler';
 export * from './logging/Logger';
 export * from './logging/LogTarget';
-export * from './logging/HistoryLogHandler';
-export * from './logging/ConsoleLogHandler';
-export * from './global/globalTarget';
-export * from './global/globalRegistry';
-export * from './global/environment';
-export * from './event/redispatchEvents';
-export * from './event/onAny';
-export * from './event/nextEventAsPromise';
-export * from './event/Signal';
-export * from './event/EventHost';
-export * from './event/DomEventHost';
-export * from './error/ValidationError';
-export * from './error/UnreachableCodeError';
-export * from './error/TimeoutError';
-export * from './error/StackOverflowError';
-export * from './error/ServiceResponseError';
-export * from './error/ReportableError';
-export * from './error/MediaUnsupportedError';
-export * from './error/IllegalStateError';
-export * from './error/IllegalArgumentError';
-export * from './error/ErrorOrigin';
-export * from './error/AbortError';
-export * from './core/disposable';
-export * from './core/cloneable';
-export * from './core/clearable';
-export * from './core/Unsubscribe';
-export * from './client/Version';
-export * from './client/userAgent/userAgentRuleHelpers';
-export * from './client/userAgent/tokenizeUserAgent';
-export * from './client/userAgent/parseUserAgent';
-export * from './client/userAgent/hasBrowser';
-export * from './client/userAgent/defaultUserAgentRules';
-export * from './client/userAgent/UserAgentInfo';
+export * from './logging/logTimer';
+export * from './logging/VinylLogging';
+export * from './network/browser/NetworkInformation';
+export * from './network/createRequester';
+export * from './network/logging/networkLoggingHandler';
+export * from './network/metrics/NetworkMetricsController';
+export * from './network/metrics/NetworkMetricsControllerImpl';
+export * from './network/metrics/networkMetricsGlobal';
+export * from './network/metrics/networkMetricsModel';
+export * from './network/network';
+export * from './network/Requester';
+export * from './network/requesterGlobal';
+export * from './network/RequesterImpl';
+export * from './network/RequesterImplEventMap';
+export * from './network/RequestError';
+export * from './network/requesterUtil';
+export * from './network/RequestInterceptor';
+export * from './network/responseUtil';
+export * from './patch/network/fetch';
+export * from './patch/patchTarget';
+export * from './persistence/KeyValuePersistence';
+export * from './persistence/persistenceRef';
+export * from './persistence/PersistentItem';
+export * from './persistence/StoragePersistence';
+export * from './util/async/Abort';
+export * from './util/async/abortUtils';
+export * from './util/async/Deferred';
+export * from './util/async/never';
+export * from './util/async/poll';
+export * from './util/async/promise';
+export * from './util/async/sleep';
+export * from './util/async/TaskQueue';
+export * from './util/async/timeout';
+export * from './util/async/TimeoutController';
+export * from './util/async/TimeoutSlot';
+export * from './util/browser/searchParams';
+export * from './util/buffer/buffer';
+export * from './util/buffer/BufferError';
+export * from './util/buffer/BufferReader';
+export * from './util/buffer/BufferWriter';
+export * from './util/collection/array';
+export * from './util/collection/CacheMap';
+export * from './util/collection/LinkedList';
+export * from './util/collection/LruCache';
+export * from './util/collection/typedArray';
+export * from './util/comparison/compare';
+export * from './util/config/ValueProvider';
+export * from './util/date/date';
+export * from './util/error/stack';
+export * from './util/fun/debounce';
+export * from './util/fun/flow';
+export * from './util/fun/function';
+export * from './util/fun/memoize';
+export * from './util/fun/throttle';
+export * from './util/iteration/iterable';
+export * from './util/map/map';
+export * from './util/math/math';
+export * from './util/mpeg/parseSidxBox';
+export * from './util/network/request';
+export * from './util/object/clone';
+export * from './util/object/equalDeep';
+export * from './util/object/lazy';
+export * from './util/object/merge';
+export * from './util/object/mergeDeep';
+export * from './util/object/mutableType';
+export * from './util/object/object';
+export * from './util/object/readonlyType';
+export * from './util/range/IntersectionRanges';
+export * from './util/range/Ranges';
+export * from './util/range/timeRanges';
+export * from './util/range/UnionRanges';
+export * from './util/serialization/json';
+export * from './util/serialization/ParseError';
+export * from './util/serialization/primitives';
+export * from './util/serialization/stringifyForPrint';
+export * from './util/set/set';
+export * from './util/string/string';
+export * from './util/string/StringReader';
+export * from './util/string/uid';
+export * from './util/type';
+export * from './util/url/resolveUrl';
 //# sourceMappingURL=index.d.ts.map

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/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/map/map.d.ts

@@ -1,7 +1,7 @@
 /**
  * The minimal `Map`-shaped interface that {@link getOrSet} needs.
  */
-interface GetOrSetMap<K, V> {
+export interface GetOrSetMap<K, V> {
     has(key: K): boolean;
     get(key: K): V | undefined;
     set(key: K, value: V): unknown;
@@ -25,5 +25,4 @@ export declare function flipMap<K, V>(map: Iterable<readonly [
     K,
     V
 ]>): Map<V, K>;
-export {};
 //# sourceMappingURL=map.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/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.