@amazon/vinyl 1.0.0

package/dist/types/current/drm/licenseProvider/LicenseProvider.js

@@ -0,0 +1,10 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { any, instanceOf, object, string, } from '@amazon/vinyl-validation';
+export const licenseServerOptionsValidator = object({
+    url: string().or(instanceOf(URL)).maybe().optional(),
+    init: object({}).cast().maybe().optional(),
+    serverCertificate: any().optional(),
+});

package/dist/types/current/drm/licenseProvider/defaultLicenseProvider.d.ts

@@ -0,0 +1,15 @@
+import type { LicenseProvider } from './LicenseProvider';
+/**
+ * A basic LicenseProvider which uses the configuration set for the current key system,
+ * transmits a challenge as the body, and returns an array buffer.
+ *
+ * @param keySystem The key system for the current license challenge.
+ * @param serverOptions The resolved configuration. The default DrmController
+ * implementation provides this from the `drm` configuration set when creating
+ * a new player.
+ * @param challenge The license challenge, provided by the CDM (Content Decryption
+ * Module)
+ * @param abort (optional) When aborted, should cancel any active requests.
+ */
+export declare const defaultLicenseProvider: LicenseProvider;
+//# sourceMappingURL=defaultLicenseProvider.d.ts.map

package/dist/types/current/drm/licenseProvider/defaultLicenseProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultLicenseProvider.d.ts","sourceRoot":"","sources":["../../../../../src/drm/licenseProvider/defaultLicenseProvider.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,eAAe,EAAwB,MAAM,mBAAmB,CAAA;AAE9E;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,EAAE,eAqBpC,CAAA"}

package/dist/types/current/drm/licenseProvider/defaultLicenseProvider.js

@@ -0,0 +1,28 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { requestWithRetry, ValidationError } from '@amazon/vinyl-util';
+/**
+ * A basic LicenseProvider which uses the configuration set for the current key system,
+ * transmits a challenge as the body, and returns an array buffer.
+ *
+ * @param keySystem The key system for the current license challenge.
+ * @param serverOptions The resolved configuration. The default DrmController
+ * implementation provides this from the `drm` configuration set when creating
+ * a new player.
+ * @param challenge The license challenge, provided by the CDM (Content Decryption
+ * Module)
+ * @param abort (optional) When aborted, should cancel any active requests.
+ */
+export const defaultLicenseProvider = async (keySystem, serverOptions, challenge, abort) => {
+    if (serverOptions.url == null) {
+        throw new ValidationError(`Missing licenseServer url in DRM configuration for keySystem: ${keySystem}`);
+    }
+    const res = await requestWithRetry(serverOptions.url, {
+        method: 'POST',
+        ...serverOptions.init,
+        body: challenge,
+    }, { abort });
+    return await res.arrayBuffer();
+};

package/dist/types/current/drm/util/createFairPlaySessionInitData.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Create the payload for EME media key session from `encrypted` / `*needkey` event data and DRM
+ * certificate.
+ * Note: This code is taken from the official FairPlay SDK example.
+ *
+ * @param initData
+ * @param contentId
+ * @param certificateData certificate data as a Uint8Array
+ */
+export declare function createFairPlaySessionInitData(initData: Uint8Array, contentId: string, certificateData: Uint8Array): Uint8Array<ArrayBuffer>;
+//# sourceMappingURL=createFairPlaySessionInitData.d.ts.map

package/dist/types/current/drm/util/createFairPlaySessionInitData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createFairPlaySessionInitData.d.ts","sourceRoot":"","sources":["../../../../../src/drm/util/createFairPlaySessionInitData.ts"],"names":[],"mappings":"AAOA;;;;;;;;GAQG;AACH,wBAAgB,6BAA6B,CACzC,QAAQ,EAAE,UAAU,EACpB,SAAS,EAAE,MAAM,EACjB,eAAe,EAAE,UAAU,GAC5B,UAAU,CAAC,WAAW,CAAC,CAoCzB"}

package/dist/types/current/drm/util/createFairPlaySessionInitData.js

@@ -0,0 +1,38 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { utf16ToUint16Array } from '@amazon/vinyl-util';
+/**
+ * Create the payload for EME media key session from `encrypted` / `*needkey` event data and DRM
+ * certificate.
+ * Note: This code is taken from the official FairPlay SDK example.
+ *
+ * @param initData
+ * @param contentId
+ * @param certificateData certificate data as a Uint8Array
+ */
+export function createFairPlaySessionInitData(initData, contentId, certificateData) {
+    const contentIdUint16 = utf16ToUint16Array(contentId);
+    const certificateDataUint8 = certificateData;
+    let offset = 0;
+    const buffer = new ArrayBuffer(initData.byteLength +
+        4 + // contentId length
+        contentIdUint16.byteLength +
+        4 + // certificateDataUint8 length
+        certificateDataUint8.byteLength);
+    const initDataArray = new Uint8Array(buffer, offset, initData.byteLength);
+    initDataArray.set(initData);
+    offset += initData.byteLength;
+    const dataView = new DataView(buffer);
+    dataView.setUint32(offset, contentIdUint16.byteLength, true);
+    offset += 4;
+    const idArray = new Uint16Array(buffer, offset, contentIdUint16.length);
+    idArray.set(contentIdUint16);
+    offset += idArray.byteLength;
+    dataView.setUint32(offset, certificateDataUint8.byteLength, true);
+    offset += 4;
+    const certArray = new Uint8Array(buffer, offset, certificateDataUint8.byteLength);
+    certArray.set(certificateDataUint8);
+    return new Uint8Array(buffer, 0, buffer.byteLength);
+}

package/dist/types/current/drm/util/extractContentId.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Extract contentId from event data encoded as UTF16.
+ *
+ * @param initData Expected byte array representing a UTF-16 string in the form
+ * `skd://0b5689bb-4171-97e5-c280-99f7abe4004f`
+ */
+export declare function extractContentId(initData: Uint8Array<ArrayBuffer>): string;
+//# sourceMappingURL=extractContentId.d.ts.map

package/dist/types/current/drm/util/extractContentId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extractContentId.d.ts","sourceRoot":"","sources":["../../../../../src/drm/util/extractContentId.ts"],"names":[],"mappings":"AASA;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,MAAM,CAO1E"}

package/dist/types/current/drm/util/extractContentId.js

@@ -0,0 +1,21 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ValidationError } from '@amazon/vinyl-util';
+import { ErrorOrigin } from '@amazon/vinyl-util';
+import { bufferToUtf16 } from '@amazon/vinyl-util';
+/**
+ * Extract contentId from event data encoded as UTF16.
+ *
+ * @param initData Expected byte array representing a UTF-16 string in the form
+ * `skd://0b5689bb-4171-97e5-c280-99f7abe4004f`
+ */
+export function extractContentId(initData) {
+    const bufferStr = bufferToUtf16(initData.buffer);
+    const matches = bufferStr.match(/skd:\/\/(.+)$/);
+    if (!matches) {
+        throw new ValidationError('No contentId match', ErrorOrigin.MEDIA);
+    }
+    return matches[1];
+}

package/dist/types/current/drm/util/unpackPlayReadyChallenge.d.ts

@@ -0,0 +1,46 @@
+import { type ReadonlyRecord } from '@amazon/vinyl-util';
+import type { XmlElement } from '@amazon/vinyl-xml';
+/**
+ * The final challenge buffer and headers for a playready license challenge.
+ */
+export interface UnpackedPlayReadyChallenge {
+    readonly challenge: ArrayBuffer;
+    readonly headers: ReadonlyRecord<string, string>;
+}
+/**
+ * IE and Edge wraps playready license challenges in PlayReadyKeyMessage xml.
+ * Not all PlayReady clients do this.
+ * Checks if the challenge is wrapped, and if so, returns the set headers and unwrapped challenge.
+ * Otherwise, returns the challenge as-is with the required content type header.
+ *
+ * @param challenge The array buffer from the 'message' cdm event.
+ */
+export declare function unpackPlayReadyChallenge(challenge: ArrayBuffer): UnpackedPlayReadyChallenge;
+interface PlayReadyMessage {
+    readonly PlayReadyKeyMessage: PlayReadyKeyMessageType;
+}
+interface PlayReadyKeyMessageType {
+    readonly type?: string;
+    readonly LicenseAcquisition: LicenseAcquisitionType;
+}
+interface LicenseAcquisitionType {
+    readonly Version: number;
+    readonly Challenge: ChallengeType;
+    readonly HttpHeaders: HttpHeadersType;
+}
+interface ContentType {
+    readonly _content: string;
+}
+interface ChallengeType extends ContentType {
+    readonly encoding?: string;
+}
+interface HttpHeadersType {
+    readonly HttpHeader: readonly HttpHeaderType[];
+}
+interface HttpHeaderType {
+    readonly name: ContentType;
+    readonly value: ContentType;
+}
+export declare function parsePlayReadyKeyMessage(xmlStr: string): PlayReadyMessage & XmlElement<PlayReadyMessage>;
+export {};
+//# sourceMappingURL=unpackPlayReadyChallenge.d.ts.map

package/dist/types/current/drm/util/unpackPlayReadyChallenge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unpackPlayReadyChallenge.d.ts","sourceRoot":"","sources":["../../../../../src/drm/util/unpackPlayReadyChallenge.ts"],"names":[],"mappings":"AAKA,OAAO,EAKH,KAAK,cAAc,EACtB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAYnD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAA;IAC/B,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACnD;AAMD;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CACpC,SAAS,EAAE,WAAW,GACvB,0BAA0B,CA0B5B;AAED,UAAU,gBAAgB;IACtB,QAAQ,CAAC,mBAAmB,EAAE,uBAAuB,CAAA;CACxD;AAED,UAAU,uBAAuB;IAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,kBAAkB,EAAE,sBAAsB,CAAA;CACtD;AAED,UAAU,sBAAsB;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAA;IACjC,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAA;CACxC;AAED,UAAU,WAAW;IACjB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC5B;AAED,UAAU,aAAc,SAAQ,WAAW;IACvC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED,UAAU,eAAe;IACrB,QAAQ,CAAC,UAAU,EAAE,SAAS,cAAc,EAAE,CAAA;CACjD;AAED,UAAU,cAAc;IACpB,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAA;CAC9B;AA0CD,wBAAgB,wBAAwB,CACpC,MAAM,EAAE,MAAM,GACf,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAEjD"}

package/dist/types/current/drm/util/unpackPlayReadyChallenge.js

@@ -0,0 +1,77 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { base64ToByteArray, bufferToUtf16, logDebug, } from '@amazon/vinyl-util';
+import { attrInt, attrString, charactersString, element, elements, parseXml, parseXmlHandler, } from '@amazon/vinyl-xml';
+const logTarget = {
+    logPrefix: 'unpackPlayReadyChallenge',
+};
+/**
+ * IE and Edge wraps playready license challenges in PlayReadyKeyMessage xml.
+ * Not all PlayReady clients do this.
+ * Checks if the challenge is wrapped, and if so, returns the set headers and unwrapped challenge.
+ * Otherwise, returns the challenge as-is with the required content type header.
+ *
+ * @param challenge The array buffer from the 'message' cdm event.
+ */
+export function unpackPlayReadyChallenge(challenge) {
+    const xml = challenge.byteLength % 2 === 0 ? bufferToUtf16(challenge) : '';
+    if (!xml.includes('PlayReadyKeyMessage')) {
+        logDebug(logTarget, 'not wrapped');
+        // A client that does not wrap the challenge.
+        return {
+            challenge,
+            headers: {
+                'Content-Type': 'text/xml; charset=utf-8',
+            },
+        };
+    }
+    logDebug(logTarget, 'unpacking challenge');
+    const message = parsePlayReadyKeyMessage(xml);
+    const licenseAcquisition = message.PlayReadyKeyMessage.LicenseAcquisition;
+    const unpackedChallenge = base64ToByteArray(licenseAcquisition.Challenge._content).buffer;
+    const headers = {};
+    for (const element of licenseAcquisition.HttpHeaders.HttpHeader) {
+        headers[element.name._content] = element.value._content;
+    }
+    return {
+        challenge: unpackedChallenge,
+        headers,
+    };
+}
+const challengeType = {
+    _content: charactersString,
+    encoding: attrString,
+};
+const contentType = {
+    _content: charactersString,
+};
+const headerType = {
+    name: element(contentType, { required: true }),
+    value: element(contentType, { required: true }),
+};
+const httpHeadersType = {
+    HttpHeader: elements(headerType, { useEmptyArrays: true }),
+};
+const licenseAcquisitionType = {
+    Challenge: element(challengeType, { required: true }),
+    HttpHeaders: element(httpHeadersType, { required: true }),
+    Version: attrInt({ required: true }),
+};
+const playReadyKeyMessageType = {
+    LicenseAcquisition: element(licenseAcquisitionType, { required: true }),
+    type: attrString(),
+};
+const playReadyMessageRules = {
+    PlayReadyKeyMessage: element(playReadyKeyMessageType, {
+        required: true,
+    }),
+};
+/**
+ * A Content handler for a PlayReady SOAP message.
+ */
+const playReadyXmlHandler = parseXmlHandler(playReadyMessageRules);
+export function parsePlayReadyKeyMessage(xmlStr) {
+    return parseXml(xmlStr, playReadyXmlHandler);
+}

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

@@ -0,0 +1,12 @@
+import type { LogTarget } from '@amazon/vinyl-util';
+export interface BasicErrorEvent {
+    /**
+     * The target reporting the error.
+     */
+    readonly target: LogTarget;
+    /**
+     * The error.
+     */
+    readonly error: Error;
+}
+//# sourceMappingURL=BasicErrorEvent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BasicErrorEvent.d.ts","sourceRoot":"","sources":["../../../../src/event/BasicErrorEvent.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAEnD,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;CACxB"}

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

@@ -0,0 +1,5 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export {};

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

@@ -0,0 +1,12 @@
+export interface ChangeEvent<T> {
+    readonly previous: T | null;
+    readonly current: T;
+}
+/**
+ * Creates a function, which when invoked, will call `inner` with a new ChangeEvent.
+ *
+ * @param getter
+ * @param inner
+ */
+export declare function createChangeEventTrigger<T>(getter: () => T, inner: (event: ChangeEvent<T>) => void): () => void;
+//# sourceMappingURL=ChangeEvent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ChangeEvent.d.ts","sourceRoot":"","sources":["../../../../src/event/ChangeEvent.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,WAAW,CAAC,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAA;IAC3B,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;CACtB;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,EACtC,MAAM,EAAE,MAAM,CAAC,EACf,KAAK,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,GACvC,MAAM,IAAI,CAUZ"}

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

@@ -0,0 +1,21 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Creates a function, which when invoked, will call `inner` with a new ChangeEvent.
+ *
+ * @param getter
+ * @param inner
+ */
+export function createChangeEventTrigger(getter, inner) {
+    let current = getter();
+    return () => {
+        const event = {
+            previous: current,
+            current: getter(),
+        };
+        current = event.current;
+        inner(event);
+    };
+}

package/dist/types/current/global/PlayerRegistry.d.ts

@@ -0,0 +1,52 @@
+import type { AnyRecord, Disposable } from '@amazon/vinyl-util';
+/**
+ * A registry of all non-disposed Vinyl players.
+ * Used for debugging and cleanup validation.
+ */
+export interface PlayerRegistry {
+    /**
+     * Returns the non-disposed Vinyl players.
+     */
+    readonly players: readonly AnyRecord[];
+    /**
+     * Adds a player reference. All players must be removed before disposing VinylGlobal.
+     *
+     * @param player
+     */
+    addPlayer(player: AnyRecord): void;
+    /**
+     * Removes a player reference.
+     *
+     * @param player
+     */
+    removePlayer(player: AnyRecord): void;
+}
+export declare const DEFAULT_MAX_PLAYERS = 5;
+/**
+ * A registry of non-disposed players.
+ * Used for leak detection and debugging diagnostics.
+ */
+export declare class PlayerRegistryImpl implements PlayerRegistry, Disposable {
+    /**
+     * The number of concurrent players before a warning is logged.
+     * default: 5
+     */
+    maxPlayersWarning: number;
+    private _players;
+    private gaveMaxPlayersWarning;
+    constructor(
+    /**
+     * The number of concurrent players before a warning is logged.
+     * default: 5
+     */
+    maxPlayersWarning?: number);
+    get players(): readonly AnyRecord[];
+    addPlayer(player: AnyRecord): void;
+    removePlayer(player: AnyRecord): void;
+    /**
+     * @throws An IllegalStateError if all players have not been removed.
+     */
+    dispose(): void;
+}
+export declare const playerRegistryRef: import("@amazon/vinyl-util").GlobalRef<PlayerRegistry>;
+//# sourceMappingURL=PlayerRegistry.d.ts.map

package/dist/types/current/global/PlayerRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlayerRegistry.d.ts","sourceRoot":"","sources":["../../../../src/global/PlayerRegistry.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAiB/D;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,SAAS,EAAE,CAAA;IAEtC;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CAAA;IAElC;;;;OAIG;IACH,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CAAA;CACxC;AAED,eAAO,MAAM,mBAAmB,IAAI,CAAA;AAEpC;;;GAGG;AACH,qBAAa,kBAAmB,YAAW,cAAc,EAAE,UAAU;IAM7D;;;OAGG;IACI,iBAAiB,EAAE,MAAM;IATpC,OAAO,CAAC,QAAQ,CAAkB;IAElC,OAAO,CAAC,qBAAqB,CAAQ;;IAGjC;;;OAGG;IACI,iBAAiB,GAAE,MAA4B;IAG1D,IAAI,OAAO,IAAI,SAAS,SAAS,EAAE,CAElC;IAED,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI;IAYlC,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI;IAIrC;;OAEG;IACH,OAAO;CAMV;AAED,eAAO,MAAM,iBAAiB,wDAE7B,CAAA"}

package/dist/types/current/global/PlayerRegistry.js

@@ -0,0 +1,51 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { globalRef, globalTarget, IllegalStateError, logWarn, remove, substitute, } from '@amazon/vinyl-util';
+/**
+ * @private
+ */
+const locale = {
+    maxPlayersWarning: `{count} Vinyl Players have been constructed without disposal. Check that player.dispose is properly being called, then increase the maxPlayersWarning option if this was intentional.`,
+};
+export const DEFAULT_MAX_PLAYERS = 5;
+/**
+ * A registry of non-disposed players.
+ * Used for leak detection and debugging diagnostics.
+ */
+export class PlayerRegistryImpl {
+    maxPlayersWarning;
+    _players = [];
+    gaveMaxPlayersWarning = false;
+    constructor(
+    /**
+     * The number of concurrent players before a warning is logged.
+     * default: 5
+     */
+    maxPlayersWarning = DEFAULT_MAX_PLAYERS) {
+        this.maxPlayersWarning = maxPlayersWarning;
+    }
+    get players() {
+        return this._players;
+    }
+    addPlayer(player) {
+        this._players.push(player);
+        const n = this._players.length;
+        if (n > this.maxPlayersWarning && !this.gaveMaxPlayersWarning) {
+            this.gaveMaxPlayersWarning = true;
+            logWarn(globalTarget, substitute(locale.maxPlayersWarning, { count: n }));
+        }
+    }
+    removePlayer(player) {
+        remove(this._players, player);
+    }
+    /**
+     * @throws An IllegalStateError if all players have not been removed.
+     */
+    dispose() {
+        if (this._players.length)
+            throw new IllegalStateError('All players must be removed before disposing VinylGlobal');
+    }
+}
+export const playerRegistryRef = globalRef(() => new PlayerRegistryImpl());

package/dist/types/current/global/configureVinylGlobal.d.ts

@@ -0,0 +1,43 @@
+import { LogLevel, type PartialDeep } from '@amazon/vinyl-util';
+/**
+ * Configuration for VinylGlobal.
+ */
+export interface VinylGlobalOptions {
+    /**
+     * The number of concurrent players before a warning is logged.
+     * default: 5
+     */
+    readonly maxPlayersWarning: number;
+    /**
+     * Logging configuration
+     */
+    readonly logging: {
+        readonly history: {
+            /**
+             * Limits the history log level.
+             */
+            readonly logLevel: LogLevel;
+            /**
+             * Sets the logging history size.
+             */
+            readonly maxHistorySize: number;
+        };
+        /**
+         * Gates all log handlers to logs of at least this level.
+         */
+        readonly logLevel: LogLevel;
+        readonly console: {
+            /**
+             * Gates console logs
+             */
+            readonly logLevel: LogLevel;
+        };
+    };
+}
+/**
+ * Applies configuration to the current vinyl global options.
+ *
+ * @param options
+ */
+export declare function configureVinylGlobal(options: PartialDeep<VinylGlobalOptions>): void;
+//# sourceMappingURL=configureVinylGlobal.d.ts.map

package/dist/types/current/global/configureVinylGlobal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configureVinylGlobal.d.ts","sourceRoot":"","sources":["../../../../src/global/configureVinylGlobal.ts"],"names":[],"mappings":"AAKA,OAAO,EAGH,QAAQ,EACR,KAAK,WAAW,EAEnB,MAAM,oBAAoB,CAAA;AAU3B;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAA;IAElC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE;QACd,QAAQ,CAAC,OAAO,EAAE;YACd;;eAEG;YACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;YAE3B;;eAEG;YACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;SAClC,CAAA;QAED;;WAEG;QACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;QAE3B,QAAQ,CAAC,OAAO,EAAE;YACd;;eAEG;YACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;SAC9B,CAAA;KACJ,CAAA;CACJ;AAiCD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,WAAW,CAAC,kBAAkB,CAAC,QA6B5E"}

package/dist/types/current/global/configureVinylGlobal.js

@@ -0,0 +1,58 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { consoleLogHandler, historyLogHandler, LogLevel, setLogLevel, } from '@amazon/vinyl-util';
+import { isOneOf, number, object, } from '@amazon/vinyl-validation';
+import { PlayerRegistryImpl, playerRegistryRef } from './PlayerRegistry';
+const logLevelValidator = (() => isOneOf(LogLevel.VERBOSE, LogLevel.DEBUG, LogLevel.INFO, LogLevel.WARN, LogLevel.ERROR, LogLevel.NONE))();
+/**
+ * A validator for VinylGlobalOptions applications can set for Vinyl.
+ */
+const vinylGlobalOptionsValidator = object({
+    logging: object({
+        console: object({
+            logLevel: logLevelValidator,
+        }),
+        history: object({
+            logLevel: logLevelValidator,
+            maxHistorySize: number(),
+        }),
+        logLevel: logLevelValidator,
+    }),
+    maxPlayersWarning: number(),
+});
+const vinylGlobalOptionsPartialValidator = vinylGlobalOptionsValidator.partialDeep();
+/**
+ * Applies configuration to the current vinyl global options.
+ *
+ * @param options
+ */
+export function configureVinylGlobal(options) {
+    vinylGlobalOptionsPartialValidator.assert(options);
+    // Logging configuration
+    if (options.logging) {
+        const logging = options.logging;
+        if (logging.logLevel != null)
+            setLogLevel(logging.logLevel);
+        if (logging.history) {
+            const history = logging.history;
+            if (historyLogHandler.value) {
+                if (history.maxHistorySize != null)
+                    historyLogHandler.value.maxHistorySize =
+                        history.maxHistorySize;
+                if (history.logLevel != null)
+                    historyLogHandler.value.logLevel = history.logLevel;
+            }
+        }
+        if (logging.console?.logLevel != null) {
+            if (consoleLogHandler.value) {
+                consoleLogHandler.value.logLevel = logging.console.logLevel;
+            }
+        }
+    }
+    if (options.maxPlayersWarning != null &&
+        playerRegistryRef.value instanceof PlayerRegistryImpl) {
+        playerRegistryRef.value.maxPlayersWarning = options.maxPlayersWarning;
+    }
+}

package/dist/types/current/global/environment.d.ts

@@ -0,0 +1,6 @@
+/**
+ * process.env.VINYL_VERSION will be null in node unit tests, but in the built library it is
+ * replaced by the webpack DefinePlugin with the package.version.
+ */
+export declare const vinylVersion: import("@amazon/vinyl-util").Version;
+//# sourceMappingURL=environment.d.ts.map

package/dist/types/current/global/environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../../../src/global/environment.ts"],"names":[],"mappings":"AAOA;;;GAGG;AACH,eAAO,MAAM,YAAY,sCAGxB,CAAA"}

package/dist/types/current/global/environment.js

@@ -0,0 +1,12 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { parseVersion } from '@amazon/vinyl-util';
+/**
+ * process.env.VINYL_VERSION will be null in node unit tests, but in the built library it is
+ * replaced by the webpack DefinePlugin with the package.version.
+ */
+export const vinylVersion = parseVersion(
+/* istanbul ignore next */
+process.env.VINYL_VERSION ?? '0.0.0.0');

package/dist/types/current/global/globalRef.d.ts

@@ -0,0 +1,32 @@
+import { type AnyRecord } from '@amazon/vinyl-util';
+declare global {
+    /**
+     * A reference to Vinyl's global state, easily accessible via console.
+     */
+    var vinylGlobal: any;
+}
+/**
+ * For console debugging, gives access to currently active players, logs, and client information.
+ */
+export declare class VinylGlobal {
+    get players(): readonly AnyRecord[];
+    /**
+     * Returns the first player.
+     */
+    get player(): AnyRecord;
+    get logs(): readonly import("@amazon/vinyl-util").HistoryLogItem[] | undefined;
+    get version(): string;
+    get userAgentInfo(): import("@amazon/vinyl-util").UserAgentInfo;
+    get network(): import("@amazon/vinyl-util").NetworkMetrics;
+    /**
+     * Returns the EWMA low estimate for the client's current bandwidth.
+     */
+    get bandwidth(): number;
+}
+/**
+ * Set the global vinylGlobal reference for easier console debugging.
+ * Intentionally typed as AnyRecord to prevent API usage from code. This is
+ * intended only for console debugging and the API may change at any time.
+ */
+export declare const vinylGlobalRef: import("@amazon/vinyl-util").GlobalRef<AnyRecord>;
+//# sourceMappingURL=globalRef.d.ts.map

package/dist/types/current/global/globalRef.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"globalRef.d.ts","sourceRoot":"","sources":["../../../../src/global/globalRef.ts"],"names":[],"mappings":"AAKA,OAAO,EACH,KAAK,SAAS,EAMjB,MAAM,oBAAoB,CAAA;AAI3B,OAAO,CAAC,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,WAAW,EAAE,GAAG,CAAA;CACvB;AAED;;GAEG;AACH,qBAAa,WAAW;IACpB,IAAI,OAAO,yBAEV;IAED;;OAEG;IACH,IAAI,MAAM,cAET;IAED,IAAI,IAAI,uEAEP;IAED,IAAI,OAAO,WAEV;IAED,IAAI,aAAa,+CAEhB;IAED,IAAI,OAAO,gDAEV;IAED;;OAEG;IACH,IAAI,SAAS,WAEZ;CACJ;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,mDAKzB,CAAA"}