@amazon/vinyl-util 1.0.0

package/dist/types/current/error/ErrorOrigin.js

@@ -0,0 +1,48 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export const ErrorOrigin = {
+    /**
+     * The error originated from Vinyl and was reported from the uncaught exception or promise
+     * rejection handlers.
+     */
+    UNCAUGHT: 'uncaught',
+    /**
+     * The error originated from Vinyl and was caught.
+     */
+    INTERNAL: 'internal',
+    /**
+     * A Vinyl interface was used incorrectly by a consumer.
+     */
+    API: 'api',
+    /**
+     * The error originated from a failed service call (500 errors).
+     */
+    SERVICE_EXTERNAL: 'serviceExternal',
+    /**
+     * The error originated from a failed service call (400 errors).
+     */
+    SERVICE_INTERNAL: 'serviceInternal',
+    /**
+     * The error originated from a problem playing provided media.
+     * The reporter is from a component such as the element, source buffer, media source, etc.
+     */
+    MEDIA: 'media',
+    /**
+     * The error originated from a problem parsing input data.
+     * Such as a malformed Dash or HLS manifest.
+     */
+    PARSING: 'parsing',
+    /**
+     * The error originated from an incompatibility with browser APIs,
+     * such as EME.
+     */
+    COMPATIBILITY: 'compatibility',
+    /**
+     * The error originated from DRM.
+     * This does not include internal or service errors, only errors from the creation of media keys or media key
+     * sessions.
+     */
+    DRM: 'drm',
+};

package/dist/types/current/error/IllegalArgumentError.d.ts

@@ -0,0 +1,10 @@
+import { ReportableError } from './ReportableError';
+/**
+ * An error indicating that a method was called with illegal arguments.
+ */
+export declare class IllegalArgumentError extends ReportableError {
+    readonly isInternal: boolean;
+    get [Symbol.toStringTag](): string;
+    constructor(message: string, isInternal?: boolean);
+}
+//# sourceMappingURL=IllegalArgumentError.d.ts.map

package/dist/types/current/error/IllegalArgumentError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IllegalArgumentError.d.ts","sourceRoot":"","sources":["../../../../src/error/IllegalArgumentError.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,eAAe;IAOjD,QAAQ,CAAC,UAAU;IANvB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;gBAGG,OAAO,EAAE,MAAM,EACN,UAAU,UAAO;CAKjC"}

package/dist/types/current/error/IllegalArgumentError.js

@@ -0,0 +1,20 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ErrorOrigin } from './ErrorOrigin';
+import { ReportableError } from './ReportableError';
+/**
+ * An error indicating that a method was called with illegal arguments.
+ */
+export class IllegalArgumentError extends ReportableError {
+    isInternal;
+    get [Symbol.toStringTag]() {
+        return 'IllegalArgumentError';
+    }
+    constructor(message, isInternal = true) {
+        super(message, isInternal ? ErrorOrigin.INTERNAL : ErrorOrigin.API);
+        this.isInternal = isInternal;
+        Object.setPrototypeOf(this, IllegalArgumentError.prototype);
+    }
+}

package/dist/types/current/error/IllegalStateError.d.ts

@@ -0,0 +1,9 @@
+import { ReportableError } from './ReportableError';
+/**
+ * An error indicating an unexpected state.
+ */
+export declare class IllegalStateError extends ReportableError {
+    get [Symbol.toStringTag](): string;
+    constructor(message: string);
+}
+//# sourceMappingURL=IllegalStateError.d.ts.map

package/dist/types/current/error/IllegalStateError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IllegalStateError.d.ts","sourceRoot":"","sources":["../../../../src/error/IllegalStateError.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,eAAe;IAClD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;gBAEW,OAAO,EAAE,MAAM;CAI9B"}

package/dist/types/current/error/IllegalStateError.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ReportableError } from './ReportableError';
+/**
+ * An error indicating an unexpected state.
+ */
+export class IllegalStateError extends ReportableError {
+    get [Symbol.toStringTag]() {
+        return 'IllegalStateError';
+    }
+    constructor(message) {
+        super(message);
+        Object.setPrototypeOf(this, IllegalStateError.prototype);
+    }
+}

package/dist/types/current/error/MediaUnsupportedError.d.ts

@@ -0,0 +1,9 @@
+import { ReportableError } from '../error/ReportableError';
+import type { Json } from '../util/serialization/json';
+export declare class MediaUnsupportedError extends ReportableError {
+    readonly code: string;
+    constructor(message: string, code: string);
+    toJSON(): Json;
+    get [Symbol.toStringTag](): string;
+}
+//# sourceMappingURL=MediaUnsupportedError.d.ts.map

package/dist/types/current/error/MediaUnsupportedError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MediaUnsupportedError.d.ts","sourceRoot":"","sources":["../../../../src/error/MediaUnsupportedError.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAA;AAErD,qBAAa,qBAAsB,SAAQ,eAAe;IAGlD,QAAQ,CAAC,IAAI,EAAE,MAAM;gBADrB,OAAO,EAAE,MAAM,EACN,IAAI,EAAE,MAAM;IAMzB,MAAM,IAAI,IAAI;IAId,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;CACJ"}

package/dist/types/current/error/MediaUnsupportedError.js

@@ -0,0 +1,20 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ErrorOrigin } from '../error/ErrorOrigin';
+import { ReportableError } from '../error/ReportableError';
+export class MediaUnsupportedError extends ReportableError {
+    code;
+    constructor(message, code) {
+        super(message, ErrorOrigin.MEDIA);
+        this.code = code;
+        Object.setPrototypeOf(this, MediaUnsupportedError.prototype);
+    }
+    toJSON() {
+        return { ...super.toJSON(), code: this.code };
+    }
+    get [Symbol.toStringTag]() {
+        return 'MediaUnsupportedError';
+    }
+}

package/dist/types/current/error/ReportableError.d.ts

@@ -0,0 +1,39 @@
+import type { Json } from '../util/serialization/json';
+export declare enum ErrorLevel {
+    /**
+     * Fatal errors are not recoverable.
+     */
+    FATAL = "fatal",
+    /**
+     * Warn level errors should be reported, but are recoverable.
+     */
+    WARN = "warn",
+    /**
+     * Silent errors should not be reported. For example aborting a play operation due to a new track loading.
+     */
+    SILENT = "silent"
+}
+/**
+ * A Serializable Error that contains an error origin.
+ */
+export declare class ReportableError extends Error {
+    readonly origin: string;
+    readonly level: ErrorLevel;
+    get [Symbol.toStringTag](): string;
+    constructor(message?: string, origin?: string, level?: ErrorLevel);
+    get name(): string;
+    /**
+     * All ReportableError instances must be serializable.
+     */
+    toJSON(): Json;
+}
+/**
+ * Returns true if the given object is a ReportableError.
+ */
+export declare function isReportableError(error: any): error is ReportableError;
+/**
+ * Returns true if the error is a ReportableError and is level SILENT.
+ * @param error
+ */
+export declare function isSilentError(error: any): boolean;
+//# sourceMappingURL=ReportableError.d.ts.map

package/dist/types/current/error/ReportableError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReportableError.d.ts","sourceRoot":"","sources":["../../../../src/error/ReportableError.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAA;AAErD,oBAAY,UAAU;IAClB;;OAEG;IACH,KAAK,UAAU;IAEf;;OAEG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,MAAM,WAAW;CACpB;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,KAAK;IAOlC,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,KAAK,EAAE,UAAU;IAP9B,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;gBAGG,OAAO,CAAC,EAAE,MAAM,EACP,MAAM,GAAE,MAA6B,EACrC,KAAK,GAAE,UAA6B;IAMjD,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,MAAM,IAAI,IAAI;CASjB;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,eAAe,CAItE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAEjD"}

package/dist/types/current/error/ReportableError.js

@@ -0,0 +1,66 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ErrorOrigin } from './ErrorOrigin';
+export var ErrorLevel;
+(function (ErrorLevel) {
+    /**
+     * Fatal errors are not recoverable.
+     */
+    ErrorLevel["FATAL"] = "fatal";
+    /**
+     * Warn level errors should be reported, but are recoverable.
+     */
+    ErrorLevel["WARN"] = "warn";
+    /**
+     * Silent errors should not be reported. For example aborting a play operation due to a new track loading.
+     */
+    ErrorLevel["SILENT"] = "silent";
+})(ErrorLevel || (ErrorLevel = {}));
+/**
+ * A Serializable Error that contains an error origin.
+ */
+export class ReportableError extends Error {
+    origin;
+    level;
+    get [Symbol.toStringTag]() {
+        return 'ReportableError';
+    }
+    constructor(message, origin = ErrorOrigin.INTERNAL, level = ErrorLevel.FATAL) {
+        super(message);
+        this.origin = origin;
+        this.level = level;
+        Object.setPrototypeOf(this, ReportableError.prototype);
+    }
+    get name() {
+        return this[Symbol.toStringTag];
+    }
+    /**
+     * All ReportableError instances must be serializable.
+     */
+    toJSON() {
+        return {
+            level: this.level,
+            message: this.message,
+            name: this.name,
+            origin: this.origin,
+            stack: this.stack,
+        };
+    }
+}
+/**
+ * Returns true if the given object is a ReportableError.
+ */
+export function isReportableError(error) {
+    // This does not use instanceof ReportableError to avoid ambiguity in the case where this module
+    // is loaded multiple times due to version conflicts or code splitting.
+    return error instanceof Error && 'origin' in error && 'level' in error;
+}
+/**
+ * Returns true if the error is a ReportableError and is level SILENT.
+ * @param error
+ */
+export function isSilentError(error) {
+    return isReportableError(error) && error.level === ErrorLevel.SILENT;
+}

package/dist/types/current/error/ServiceResponseError.d.ts

@@ -0,0 +1,14 @@
+import { ReportableError } from './ReportableError';
+import { type Json } from '../util/serialization/json';
+export declare const SERVICE_RESPONSE_ERROR_MESSAGE = "Unexpected service response";
+export declare class ServiceResponseError extends ReportableError {
+    readonly reason: any;
+    constructor(reason: any);
+    get [Symbol.toStringTag](): string;
+    toJSON(): Json;
+}
+/**
+ * When used in a catch clause of a promise, wraps the reason in a {@link ServiceResponseError}.
+ */
+export declare function throwServiceResponse(reason: any): never;
+//# sourceMappingURL=ServiceResponseError.d.ts.map

package/dist/types/current/error/ServiceResponseError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServiceResponseError.d.ts","sourceRoot":"","sources":["../../../../src/error/ServiceResponseError.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,KAAK,IAAI,EAAU,MAAM,2BAA2B,CAAA;AAE7D,eAAO,MAAM,8BAA8B,gCAAgC,CAAA;AAE3E,qBAAa,oBAAqB,SAAQ,eAAe;IACzC,QAAQ,CAAC,MAAM,EAAE,GAAG;gBAAX,MAAM,EAAE,GAAG;IAQhC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED,MAAM,IAAI,IAAI;CAMjB;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,GAAG,GAAG,KAAK,CAEvD"}

package/dist/types/current/error/ServiceResponseError.js

@@ -0,0 +1,31 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ErrorOrigin } from './ErrorOrigin';
+import { ReportableError } from './ReportableError';
+import { toJson } from '../util/serialization/json';
+export const SERVICE_RESPONSE_ERROR_MESSAGE = 'Unexpected service response';
+export class ServiceResponseError extends ReportableError {
+    reason;
+    constructor(reason) {
+        super(reason?.message ?? SERVICE_RESPONSE_ERROR_MESSAGE, ErrorOrigin.SERVICE_EXTERNAL);
+        this.reason = reason;
+        Object.setPrototypeOf(this, ServiceResponseError.prototype);
+    }
+    get [Symbol.toStringTag]() {
+        return 'ServiceResponseError';
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            reason: toJson(this.reason),
+        };
+    }
+}
+/**
+ * When used in a catch clause of a promise, wraps the reason in a {@link ServiceResponseError}.
+ */
+export function throwServiceResponse(reason) {
+    throw new ServiceResponseError(reason);
+}

package/dist/types/current/error/StackOverflowError.d.ts

@@ -0,0 +1,9 @@
+import { ReportableError } from './ReportableError';
+/**
+ * An error indicating a stack overflow has occurred.
+ */
+export declare class StackOverflowError extends ReportableError {
+    get [Symbol.toStringTag](): string;
+    constructor(message: string);
+}
+//# sourceMappingURL=StackOverflowError.d.ts.map

package/dist/types/current/error/StackOverflowError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StackOverflowError.d.ts","sourceRoot":"","sources":["../../../../src/error/StackOverflowError.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,eAAe;IACnD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;gBAEW,OAAO,EAAE,MAAM;CAI9B"}

package/dist/types/current/error/StackOverflowError.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ReportableError } from './ReportableError';
+/**
+ * An error indicating a stack overflow has occurred.
+ */
+export class StackOverflowError extends ReportableError {
+    get [Symbol.toStringTag]() {
+        return 'StackOverflowError';
+    }
+    constructor(message) {
+        super(message);
+        Object.setPrototypeOf(this, StackOverflowError.prototype);
+    }
+}

package/dist/types/current/error/TimeoutError.d.ts

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

package/dist/types/current/error/TimeoutError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimeoutError.d.ts","sourceRoot":"","sources":["../../../../src/error/TimeoutError.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAG/D,qBAAa,YAAa,SAAQ,eAAe;IAC7C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;gBAGG,OAAO,EAAE,MAAM,EACf,MAAM,GAAE,MAA6B,EACrC,KAAK,GAAE,UAA6B;CAK3C"}

package/dist/types/current/error/TimeoutError.js

@@ -0,0 +1,15 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ErrorLevel, ReportableError } from './ReportableError';
+import { ErrorOrigin } from '../error/ErrorOrigin';
+export class TimeoutError extends ReportableError {
+    get [Symbol.toStringTag]() {
+        return 'TimeoutError';
+    }
+    constructor(message, origin = ErrorOrigin.INTERNAL, level = ErrorLevel.FATAL) {
+        super(message, origin, level);
+        Object.setPrototypeOf(this, TimeoutError.prototype);
+    }
+}

package/dist/types/current/error/UnreachableCodeError.d.ts

@@ -0,0 +1,9 @@
+import { ReportableError } from './ReportableError';
+/**
+ * An error indicating that a line of code was hit that should not be possible.
+ */
+export declare class UnreachableCodeError extends ReportableError {
+    get [Symbol.toStringTag](): string;
+    constructor();
+}
+//# sourceMappingURL=UnreachableCodeError.d.ts.map

package/dist/types/current/error/UnreachableCodeError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UnreachableCodeError.d.ts","sourceRoot":"","sources":["../../../../src/error/UnreachableCodeError.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,eAAe;IACrD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;;CAMJ"}

package/dist/types/current/error/UnreachableCodeError.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ReportableError } from './ReportableError';
+/**
+ * An error indicating that a line of code was hit that should not be possible.
+ */
+export class UnreachableCodeError extends ReportableError {
+    get [Symbol.toStringTag]() {
+        return 'UnreachableCodeError';
+    }
+    constructor() {
+        super('Code location expected to be unreachable');
+        Object.setPrototypeOf(this, UnreachableCodeError.prototype);
+    }
+}

package/dist/types/current/error/ValidationError.d.ts

@@ -0,0 +1,17 @@
+import { ReportableError } from '../error/ReportableError';
+import type { Json } from '../util/serialization/json';
+/**
+ * An error indicating that input had an invalid shape.
+ */
+export declare class ValidationError extends ReportableError {
+    readonly path: readonly string[];
+    get [Symbol.toStringTag](): string;
+    /**
+     * @param message The validation error message.
+     * @param origin The error origin, typically API (default) or SERVICE_EXTERNAL
+     * @param path The property path to the invalid field.
+     */
+    constructor(message: string, origin?: string, path?: readonly string[]);
+    toJSON(): Json;
+}
+//# sourceMappingURL=ValidationError.d.ts.map

package/dist/types/current/error/ValidationError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidationError.d.ts","sourceRoot":"","sources":["../../../../src/error/ValidationError.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAEzD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAA;AAErD;;GAEG;AACH,qBAAa,eAAgB,SAAQ,eAAe;IAa5C,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE;IAZpC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED;;;;OAIG;gBAEC,OAAO,EAAE,MAAM,EACf,MAAM,GAAE,MAAwB,EACvB,IAAI,GAAE,SAAS,MAAM,EAAO;IAMzC,MAAM,IAAI,IAAI;CAOjB"}

package/dist/types/current/error/ValidationError.js

@@ -0,0 +1,32 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ReportableError } from '../error/ReportableError';
+import { ErrorOrigin } from '../error/ErrorOrigin';
+/**
+ * An error indicating that input had an invalid shape.
+ */
+export class ValidationError extends ReportableError {
+    path;
+    get [Symbol.toStringTag]() {
+        return 'ValidationError';
+    }
+    /**
+     * @param message The validation error message.
+     * @param origin The error origin, typically API (default) or SERVICE_EXTERNAL
+     * @param path The property path to the invalid field.
+     */
+    constructor(message, origin = ErrorOrigin.API, path = []) {
+        super(message, origin);
+        this.path = path;
+        Object.setPrototypeOf(this, ValidationError.prototype);
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            origin: this.origin,
+            path: this.path,
+        };
+    }
+}

package/dist/types/current/event/DomEventHost.d.ts

@@ -0,0 +1,45 @@
+import type { Disposable } from '../core/disposable';
+import type { ReadonlyEventHost } from './EventHost';
+import type { EventHandler, SignalOptions } from './Signal';
+import type { Unsubscribe } from '../core/Unsubscribe';
+import type { ExtractValues } from '../util/type';
+/**
+ * Picks the keys from T that satisfy: `[keyof T extends string]: Event`
+ */
+export type DomEventMap<T> = ExtractValues<Pick<T, keyof T & string>, Event>;
+export interface DomReadonlyEventHost<EventMap> extends ReadonlyEventHost<DomEventMap<EventMap>> {
+    /**
+     * Adds an event handler for the given typed event.
+     *
+     * @param type A case-sensitive string representing the event type to listen for.
+     * @param handler A callback to invoke when the event with the given type is dispatched.
+     * @param options An options object specifies characteristics about the event listener.
+     * @return Returns a method, when invoked, removes the handler.
+     */
+    on<K extends keyof DomEventMap<EventMap>>(type: K, handler: EventHandler<DomEventMap<EventMap>[K]>, options?: DomEventListenerOptions): Unsubscribe;
+}
+/**
+ * Event listener options for DOM events.
+ *
+ * Note: signal not supported, use abort utilities.
+ */
+export interface DomEventListenerOptions extends SignalOptions, Omit<AddEventListenerOptions, 'signal'> {
+}
+/**
+ * Wraps a js `EventTarget` with a {@link ReadonlyEventHost} interface.
+ */
+export declare class DomEventHost<EventMap> implements DomReadonlyEventHost<EventMap>, Disposable {
+    protected readonly eventTarget: EventTarget;
+    private activeSubs;
+    private listenerCounts;
+    constructor(eventTarget: EventTarget);
+    hasAnyListeners(): boolean;
+    hasListeners(type: keyof DomEventMap<EventMap>): boolean;
+    on<K extends keyof DomEventMap<EventMap>>(type: K, handler: EventHandler<DomEventMap<EventMap>[K]>, options?: DomEventListenerOptions): Unsubscribe;
+    /**
+     * Disposal of a DomEventHost removes all listeners.
+     */
+    dispose(): void;
+    __eventMapType: import("../util/type").Covariant<EventMap>;
+}
+//# sourceMappingURL=DomEventHost.d.ts.map

package/dist/types/current/event/DomEventHost.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DomEventHost.d.ts","sourceRoot":"","sources":["../../../../src/event/DomEventHost.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAC3D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAErD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAGhD;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,KAAK,CAAC,CAAA;AAE5E,MAAM,WAAW,oBAAoB,CAAC,QAAQ,CAAE,SAAQ,iBAAiB,CACrE,WAAW,CAAC,QAAQ,CAAC,CACxB;IACG;;;;;;;OAOG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,WAAW,CAAC,QAAQ,CAAC,EACpC,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,YAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAC/C,OAAO,CAAC,EAAE,uBAAuB,GAClC,WAAW,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,uBACb,SAAQ,aAAa,EAAE,IAAI,CAAC,uBAAuB,EAAE,QAAQ,CAAC;CAAG;AAErE;;GAEG;AACH,qBAAa,YAAY,CAAC,QAAQ,CAC9B,YAAW,oBAAoB,CAAC,QAAQ,CAAC,EAAE,UAAU;IAOzC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,WAAW;IALvD,OAAO,CAAC,UAAU,CAAoB;IACtC,OAAO,CAAC,cAAc,CAEhB;gBAEyB,WAAW,EAAE,WAAW;IAEvD,eAAe,IAAI,OAAO;IAI1B,YAAY,CAAC,IAAI,EAAE,MAAM,WAAW,CAAC,QAAQ,CAAC,GAAG,OAAO;IAIxD,EAAE,CAAC,CAAC,SAAS,MAAM,WAAW,CAAC,QAAQ,CAAC,EACpC,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,YAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAC/C,OAAO,CAAC,EAAE,uBAAuB,GAClC,WAAW;IAoBd;;OAEG;IACH,OAAO;IAQP,cAAc,4CAAwB;CACzC"}

package/dist/types/current/event/DomEventHost.js

@@ -0,0 +1,53 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { remove } from '../util/collection/array';
+import { covariant } from '../util/type';
+/**
+ * Wraps a js `EventTarget` with a {@link ReadonlyEventHost} interface.
+ */
+export class DomEventHost {
+    eventTarget;
+    activeSubs = [];
+    listenerCounts = {};
+    constructor(eventTarget) {
+        this.eventTarget = eventTarget;
+    }
+    hasAnyListeners() {
+        return this.activeSubs.length > 0;
+    }
+    hasListeners(type) {
+        return (this.listenerCounts[type] ?? 0) > 0;
+    }
+    on(type, handler, options) {
+        this.listenerCounts[type] = (this.listenerCounts[type] ?? 0) + 1;
+        // If options.once is true, wrap the callback in order to decrement listener counts and
+        // remove the tracked subscription. Otherwise, the callback can be used directly.
+        const eventListener = options?.once
+            ? (event) => {
+                handler(event);
+                unsub();
+            }
+            : handler;
+        const unsub = () => {
+            remove(this.activeSubs, unsub);
+            this.listenerCounts[type]--;
+            this.eventTarget.removeEventListener(type, eventListener, options);
+        };
+        this.eventTarget.addEventListener(type, eventListener, options);
+        this.activeSubs.push(unsub);
+        return unsub;
+    }
+    /**
+     * Disposal of a DomEventHost removes all listeners.
+     */
+    dispose() {
+        for (let i = this.activeSubs.length - 1; i >= 0; i--) {
+            // unsubscribing will remove the element from activeSubs, iterating in reverse
+            // keeps the cursor correct.
+            this.activeSubs[i]();
+        }
+    }
+    __eventMapType = covariant();
+}

package/dist/types/current/event/EventHost.d.ts

@@ -0,0 +1,69 @@
+import type { Disposable } from '../core/disposable';
+import type { EventHandler, SignalOptions } from './Signal';
+import type { Unsubscribe } from '../core/Unsubscribe';
+import type { Covariant } from '../util/type';
+import { type LogTarget } from '../logging/LogTarget';
+export interface EventDispatcher<in EventMap> extends LogTarget {
+    /**
+     * Dispatches an event.
+     *
+     * @param type The key of the event within `EventMap`
+     * @param event If the passed event is read-only, then it may be re-used/cached. Otherwise,
+     * it should be a new event object every dispatch. If no target property is set on the event,
+     * the target will be set to this host.
+     */
+    dispatch<K extends keyof EventMap>(type: K, event: EventMap[K]): void;
+}
+export interface ReadonlyEventHost<out EventMap> {
+    /**
+     * Adds an event handler for the given typed event.
+     *
+     * @param type The key representing the event type to listen for.
+     * @param handler A callback to invoke when the event with the given type is dispatched.
+     * @param options Options for changing listening behavior.
+     * @return Returns a method, when invoked, removes the handler.
+     */
+    on<K extends keyof EventMap>(type: K, handler: EventHandler<EventMap[K]>, options?: SignalOptions): Unsubscribe;
+    /**
+     * Returns true if the event host has any listeners.
+     */
+    hasAnyListeners(): boolean;
+    /**
+     * Returns true if the event host has any listeners for the given type.
+     */
+    hasListeners(type: keyof EventMap): boolean;
+    /**
+     * Exists for EventMap type inference.
+     *
+     * @private
+     */
+    __eventMapType: Covariant<EventMap>;
+}
+/**
+ * An object that may dispatch events and have handlers for those events.
+ * Similar to the DOM's `EventTarget`, this is a basic event system based on event naming.
+ *
+ * Some of the advantages of EventHost over EventTarget:
+ * - Not all supported platforms support EventTarget construction or extension.
+ * - EventTarget is designed for the DOM, with bubble and capture phases not necessary in Vinyl.
+ * - Event types are strict.
+ * - Events can be plain objects, no need to extend CustomEvent.
+ * - Easier unsubscription and disposal; reduces the risk of memory leaks.
+ *
+ * EventHost supports concurrent modification, that is, handlers may be added or removed during
+ * the execution of another handler.
+ */
+export interface EventHost<EventMap> extends ReadonlyEventHost<EventMap>, EventDispatcher<EventMap> {
+}
+export declare class EventHostImpl<EventMap> implements EventHost<EventMap>, Disposable {
+    get [Symbol.toStringTag](): string;
+    readonly logPrefix: string;
+    private readonly signals;
+    hasAnyListeners(): boolean;
+    hasListeners(type: keyof EventMap): boolean;
+    on<K extends keyof EventMap>(type: K, handler: EventHandler<EventMap[K]>, options?: SignalOptions): Unsubscribe;
+    dispatch<K extends keyof EventMap>(type: K, event: EventMap[K]): void;
+    dispose(): void;
+    __eventMapType: Covariant<EventMap>;
+}
+//# sourceMappingURL=EventHost.d.ts.map

package/dist/types/current/event/EventHost.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventHost.d.ts","sourceRoot":"","sources":["../../../../src/event/EventHost.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,KAAK,EAAE,YAAY,EAAc,aAAa,EAAE,MAAM,UAAU,CAAA;AAEvE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAErD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE5C,OAAO,EAAmB,KAAK,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAErE,MAAM,WAAW,eAAe,CAAC,EAAE,CAAC,QAAQ,CAAE,SAAQ,SAAS;IAC3D;;;;;;;OAOG;IACH,QAAQ,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;CACxE;AAED,MAAM,WAAW,iBAAiB,CAAC,GAAG,CAAC,QAAQ;IAC3C;;;;;;;OAOG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,QAAQ,EACvB,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAClC,OAAO,CAAC,EAAE,aAAa,GACxB,WAAW,CAAA;IAEd;;OAEG;IACH,eAAe,IAAI,OAAO,CAAA;IAE1B;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,QAAQ,GAAG,OAAO,CAAA;IAE3C;;;;OAIG;IACH,cAAc,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAA;CACtC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,SAAS,CAAC,QAAQ,CAC/B,SAAQ,iBAAiB,CAAC,QAAQ,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC;CAAG;AAErE,qBAAa,aAAa,CAAC,QAAQ,CAC/B,YAAW,SAAS,CAAC,QAAQ,CAAC,EAAE,UAAU;IAE1C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED,QAAQ,CAAC,SAAS,SAAwB;IAE1C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA6C;IAErE,eAAe,IAAI,OAAO;IAO1B,YAAY,CAAC,IAAI,EAAE,MAAM,QAAQ,GAAG,OAAO;IAI3C,EAAE,CAAC,CAAC,SAAS,MAAM,QAAQ,EACvB,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAClC,OAAO,CAAC,EAAE,aAAa,GACxB,WAAW;IAKd,QAAQ,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI;IAIrE,OAAO,IAAI,IAAI;IAKf,cAAc,sBAAwB;CACzC"}