@amazon/vinyl 1.0.0

package/dist/types/current/drm/DrmOptions.d.ts

@@ -0,0 +1,92 @@
+import type { ReadonlyRecord, ValueProvider } from '@amazon/vinyl-util';
+import type { DrmInitDataType } from '../streaming/DrmInitDataType';
+import type { MediaFormatMetadata } from '../streaming/MediaQualityMetadata';
+import { type ObjectSchema, type ValueSchema } from '@amazon/vinyl-validation';
+import { DrmKeySystem } from './DrmKeySystem';
+import { type LicenseProvider, type LicenseServerOptions } from '../drm/licenseProvider/LicenseProvider';
+/**
+ * DrmRobustness is the requested security level for audio or video decryption.
+ */
+export declare enum DrmRobustness {
+    SW_SECURE_CRYPTO = "SW_SECURE_CRYPTO",
+    SW_SECURE_DECODE = "SW_SECURE_DECODE",
+    HW_SECURE_CRYPTO = "HW_SECURE_CRYPTO",
+    HW_SECURE_DECODE = "HW_SECURE_DECODE",
+    HW_SECURE_ALL = "HW_SECURE_ALL"
+}
+/**
+ * DrmConfig configures DrmController and LicenseProvider.
+ */
+export interface DrmOptions {
+    readonly keySystems: {
+        readonly [p in DrmKeySystem]?: DrmKeySystemOptions;
+    } & {
+        readonly [DrmKeySystem.CLEAR_KEY]?: DrmClearKeySystemOptions;
+    } & {
+        /**
+         * A wildcard to match any key system when there wasn't a match.
+         */
+        readonly ['*']?: DrmKeySystemOptions;
+    };
+    /**
+     *
+     * If not set, the license provider from the player dependencies will
+     * be used.
+     */
+    readonly licenseProvider?: LicenseProvider;
+}
+/**
+ * Clear key system options that extend base DRM key system options with clear
+ * key mappings. Used for unencrypted content or testing scenarios where keys
+ * are provided in plain text.
+ */
+export type DrmClearKeySystemOptions = DrmKeySystemOptions & {
+    readonly keys: ReadonlyRecord<string, string>;
+};
+export interface DrmKeySystemOptions {
+    /**
+     * License server configuration used to make license requests.
+     */
+    readonly licenseServer?: ValueProvider<LicenseServerOptions>;
+    /**
+     * Audio-specific DRM configuration.
+     */
+    readonly audio?: DrmMediaKeySystemOptions;
+    /**
+     * Video-specific DRM configuration.
+     */
+    readonly video?: DrmMediaKeySystemOptions;
+    /**
+     * Key systems with a higher priority take precedence.
+     * If two key systems have equal priority, the order will be as it appears
+     * in DrmInfo (provided by the manifest).
+     */
+    readonly priority?: number;
+    /**
+     * Transform applied to init data before session creation.
+     * Always invoked for every key system. The default implementation
+     * handles {@link DrmKeySystem.FAIR_PLAY_1_0} by packing the init data,
+     * content ID, and server certificate into the format expected by
+     * WebKit-prefixed EME. For all other key systems, returns init data
+     * unchanged.
+     */
+    readonly initDataTransformer?: InitDataTransformer;
+}
+/**
+ * Transforms raw init data before it is passed to the CDM for session creation.
+ *
+ * @param initData - The raw initialization data.
+ * @param initDataType - The initialization data type (e.g. 'cenc', 'skd').
+ * @param drmInfo - The media format metadata for the current content.
+ * @returns The transformed init data to pass to the CDM.
+ */
+export type InitDataTransformer = (initData: Uint8Array<ArrayBuffer>, initDataType: DrmInitDataType, drmInfo: MediaFormatMetadata) => Uint8Array<ArrayBuffer>;
+export interface DrmMediaKeySystemOptions {
+    readonly robustness?: DrmRobustness;
+}
+export declare const drmRobustnessValidator: ValueSchema<DrmRobustness>;
+export declare const drmMediaKeySystemOptionsValidator: ObjectSchema<DrmMediaKeySystemOptions>;
+export declare const drmKeySystemOptionsValidator: ObjectSchema<DrmKeySystemOptions>;
+export declare const drmClearKeySystemOptionsValidator: ObjectSchema<DrmClearKeySystemOptions>;
+export declare const drmOptionsValidator: ObjectSchema<DrmOptions>;
+//# sourceMappingURL=DrmOptions.d.ts.map

package/dist/types/current/drm/DrmOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DrmOptions.d.ts","sourceRoot":"","sources":["../../../../src/drm/DrmOptions.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAA;AAClE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAA;AAC3E,OAAO,EAMH,KAAK,YAAY,EAIjB,KAAK,WAAW,EACnB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,YAAY,EAAyB,MAAM,gBAAgB,CAAA;AACpE,OAAO,EACH,KAAK,eAAe,EACpB,KAAK,oBAAoB,EAE5B,MAAM,uCAAuC,CAAA;AAE9C;;GAEG;AACH,oBAAY,aAAa;IACrB,gBAAgB,qBAAqB;IACrC,gBAAgB,qBAAqB;IACrC,gBAAgB,qBAAqB;IACrC,gBAAgB,qBAAqB;IACrC,aAAa,kBAAkB;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB,QAAQ,CAAC,UAAU,EAAE;QACjB,QAAQ,EAAE,CAAC,IAAI,YAAY,CAAC,CAAC,EAAE,mBAAmB;KACrD,GAAG;QACA,QAAQ,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,wBAAwB,CAAA;KAC/D,GAAG;QACA;;WAEG;QACH,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,mBAAmB,CAAA;KACvC,CAAA;IAED;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAA;CAC7C;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,mBAAmB,GAAG;IACzD,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAChD,CAAA;AAED,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;IAE5D;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,wBAAwB,CAAA;IAEzC;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,wBAAwB,CAAA;IAEzC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAE1B;;;;;;;OAOG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,mBAAmB,CAAA;CACrD;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAC9B,QAAQ,EAAE,UAAU,CAAC,WAAW,CAAC,EACjC,YAAY,EAAE,eAAe,EAC7B,OAAO,EAAE,mBAAmB,KAC3B,UAAU,CAAC,WAAW,CAAC,CAAA;AAE5B,MAAM,WAAW,wBAAwB;IACrC,QAAQ,CAAC,UAAU,CAAC,EAAE,aAAa,CAAA;CACtC;AAED,eAAO,MAAM,sBAAsB,EAAE,WAAW,CAAC,aAAa,CACrC,CAAA;AAEzB,eAAO,MAAM,iCAAiC,EAAE,YAAY,CAAC,wBAAwB,CAG/E,CAAA;AAEN,eAAO,MAAM,4BAA4B,EAAE,YAAY,CAAC,mBAAmB,CAOrE,CAAA;AAEN,eAAO,MAAM,iCAAiC,EAAE,YAAY,CAAC,wBAAwB,CAG/E,CAAA;AAEN,eAAO,MAAM,mBAAmB,EAAE,YAAY,CAAC,UAAU,CAcvD,CAAA"}

package/dist/types/current/drm/DrmOptions.js

@@ -0,0 +1,38 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { enumOf, func, isOneOf, number, object, record, recordValues, string, } from '@amazon/vinyl-validation';
+import { DrmKeySystem, drmKeySystemValidator } from './DrmKeySystem';
+import { licenseServerOptionsValidator, } from '../drm/licenseProvider/LicenseProvider';
+/**
+ * DrmRobustness is the requested security level for audio or video decryption.
+ */
+export var DrmRobustness;
+(function (DrmRobustness) {
+    DrmRobustness["SW_SECURE_CRYPTO"] = "SW_SECURE_CRYPTO";
+    DrmRobustness["SW_SECURE_DECODE"] = "SW_SECURE_DECODE";
+    DrmRobustness["HW_SECURE_CRYPTO"] = "HW_SECURE_CRYPTO";
+    DrmRobustness["HW_SECURE_DECODE"] = "HW_SECURE_DECODE";
+    DrmRobustness["HW_SECURE_ALL"] = "HW_SECURE_ALL";
+})(DrmRobustness || (DrmRobustness = {}));
+export const drmRobustnessValidator = enumOf(DrmRobustness);
+export const drmMediaKeySystemOptionsValidator = object({
+    robustness: drmRobustnessValidator.optional(),
+});
+export const drmKeySystemOptionsValidator = object({
+    licenseServer: func().or(licenseServerOptionsValidator).optional(),
+    audio: drmMediaKeySystemOptionsValidator.optional(),
+    video: drmMediaKeySystemOptionsValidator.optional(),
+    priority: number().optional(),
+    initDataTransformer: func().optional(),
+});
+export const drmClearKeySystemOptionsValidator = drmKeySystemOptionsValidator.extend({
+    keys: recordValues(string()),
+});
+export const drmOptionsValidator = object({
+    keySystems: record(drmKeySystemValidator.or(isOneOf('*')), drmKeySystemOptionsValidator.optional()).and(object({
+        [DrmKeySystem.CLEAR_KEY]: drmClearKeySystemOptionsValidator.optional(),
+    })),
+    licenseProvider: func().optional(),
+});

package/dist/types/current/drm/commonEme/CommonEme.d.ts

@@ -0,0 +1,150 @@
+/**
+ * An common interface to unify multiple EME implementations.
+ * @module
+ */
+import type { DrmKeySystem } from '../../drm/DrmKeySystem';
+import type { Json, ReadonlyEventHost, Unsubscribe } from '@amazon/vinyl-util';
+import { ReportableError } from '@amazon/vinyl-util';
+import type { EncryptedInitData } from '../../drm/commonEme/EncryptedInitData';
+import type { DrmInitDataType } from '../../streaming/DrmInitDataType';
+import type { BasicErrorEvent } from '../../event/BasicErrorEvent';
+/**
+ * Top-level Common EME methods for initiating encrypted audio session.
+ *
+ * Created to unify standard and non-standard EME interfaces.
+ */
+export interface CommonEme {
+    requestMediaKeySystemAccess(keySystem: DrmKeySystem, supportedConfigurations: readonly MediaKeySystemConfiguration[]): Promise<CommonMediaKeySystemAccess>;
+    addEncryptedListener(element: HTMLMediaElement, handler: (event: CommonMediaEncryptedEvent) => void): Unsubscribe;
+}
+export interface CommonMediaEncryptedEvent {
+    /**
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MediaEncryptedEvent/initData)
+     */
+    readonly initData: EncryptedInitData | null;
+    /**
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MediaEncryptedEvent/initDataType)
+     */
+    readonly initDataType: string;
+}
+/**
+ * This provides a common interface for MediaKeySystemAccess EME implementations.
+ */
+export interface CommonMediaKeySystemAccess {
+    readonly keySystem: DrmKeySystem;
+    createMediaKeys(): Promise<CommonMediaKeys>;
+}
+/**
+ * This provides a common interface for MediaKeys EME implementations.
+ */
+export interface CommonMediaKeys {
+    readonly keySystem: DrmKeySystem;
+    /**
+     * Sets the media keys on the given element.
+     * @param element
+     */
+    setOnElement(element: HTMLMediaElement): Promise<void>;
+    /**
+     * Clears the media keys from the given element.
+     * This is only allowed if the element's src isn't set.
+     *   https://bugs.chromium.org/p/chromium/issues/detail?id=462365#c7
+     * @param element
+     */
+    clearFromElement(element: HTMLMediaElement): Promise<void>;
+    /**
+     * Sets the server certificate on the media keys.
+     *
+     * A Promise that resolves to a boolean. If the Key System implementation
+     * represented by this object's content decryption module's implementation
+     * value does not support server certificates, return a promise resolved
+     * with false.
+     *
+     * @param certificate The server certificate data.
+     */
+    setServerCertificate(certificate: BufferSource): Promise<boolean>;
+    /**
+     * Creates the key session.
+     *
+     * @param mimeType
+     * @param initDataType
+     * @param initData The initialization data from the 'encrypted' event.
+     */
+    createSession(mimeType: string, initDataType: DrmInitDataType, initData: EncryptedInitData): CommonMediaKeySession;
+}
+/**
+ * Common media key session events
+ */
+export interface CommonMediaKeySessionEventMap {
+    /**
+     * Dispatched when a message is generated by the content decryption module.
+     */
+    readonly message: CommonMediaKeyMessageEvent;
+    /**
+     * Dispatched when an error occurs.
+     */
+    readonly error: BasicErrorEvent;
+    /**
+     * Dispatched when the session is forcibly closed by the CDM.
+     */
+    readonly closed: CommonMediaKeySessionClosedEvent;
+}
+/**
+ * This provides a common interface for MediaKeySession EME implementations.
+ */
+export interface CommonMediaKeySession extends ReadonlyEventHost<CommonMediaKeySessionEventMap> {
+    readonly mimeType: string;
+    readonly initDataType: DrmInitDataType;
+    readonly initData: EncryptedInitData;
+    /**
+     * Updates the session with the license data.
+     * @param key
+     */
+    update(key: ArrayBuffer): Promise<void>;
+    /**
+     * Returns true if the session has been disposed.
+     */
+    get disposed(): boolean;
+    /**
+     * Closes the session, and removes session handling and event listeners, freeing this session
+     * handler for GC.
+     *
+     * Note: The audio source should be cleared first.
+     */
+    dispose(): void;
+}
+/**
+ * A media key session error, translated from the specific media key session implementation.
+ */
+export declare class CommonMediaKeySessionError extends ReportableError {
+    readonly code: number;
+    readonly codeStr: MediaKeySessionErrorType;
+    readonly systemCode: number;
+    readonly systemCodeStr: MediaKeySessionErrorType;
+    get [Symbol.toStringTag](): string;
+    constructor(code: number, codeStr: MediaKeySessionErrorType, systemCode: number, systemCodeStr: MediaKeySessionErrorType);
+    toJSON(): Json;
+}
+/**
+ * Common media key message event body.
+ */
+export interface CommonMediaKeyMessageEvent {
+    readonly message: ArrayBuffer;
+}
+export interface CommonMediaKeySessionClosedEvent {
+    /**
+     * The reason the session was closed.
+     */
+    readonly reason: MediaKeySessionClosedReason;
+}
+/**
+ * String representations of session error codes.
+ */
+export declare enum MediaKeySessionErrorType {
+    CLIENT = "CLIENT",
+    DOMAIN = "DOMAIN",
+    HARDWARECHANGE = "HARDWARECHANGE",
+    OUTPUT = "OUTPUT",
+    SERVICE = "SERVICE",
+    UNKNOWN = "UNKNOWN"
+}
+//# sourceMappingURL=CommonEme.d.ts.map

package/dist/types/current/drm/commonEme/CommonEme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommonEme.d.ts","sourceRoot":"","sources":["../../../../../src/drm/commonEme/CommonEme.ts"],"names":[],"mappings":"AAKA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAC9E,OAAO,EAA2B,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAC7E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAA;AAC1E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAA;AAClE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAE9D;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACtB,2BAA2B,CACvB,SAAS,EAAE,YAAY,EACvB,uBAAuB,EAAE,SAAS,2BAA2B,EAAE,GAChE,OAAO,CAAC,0BAA0B,CAAC,CAAA;IAEtC,oBAAoB,CAChB,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,CAAC,KAAK,EAAE,yBAAyB,KAAK,IAAI,GACpD,WAAW,CAAA;CACjB;AAED,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAE3C;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAA;IAChC,eAAe,IAAI,OAAO,CAAC,eAAe,CAAC,CAAA;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAA;IAEhC;;;OAGG;IACH,YAAY,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtD;;;;;OAKG;IACH,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1D;;;;;;;;;OASG;IACH,oBAAoB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEjE;;;;;;OAMG;IACH,aAAa,CACT,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,eAAe,EAC7B,QAAQ,EAAE,iBAAiB,GAC5B,qBAAqB,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC1C;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,0BAA0B,CAAA;IAE5C;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAA;IAE/B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,gCAAgC,CAAA;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB,CAAC,6BAA6B,CAAC;IAC3F,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,YAAY,EAAE,eAAe,CAAA;IACtC,QAAQ,CAAC,QAAQ,EAAE,iBAAiB,CAAA;IAEpC;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvC;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAAA;IAEvB;;;;;OAKG;IACH,OAAO,IAAI,IAAI,CAAA;CAClB;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,eAAe;IAMvD,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,QAAQ,CAAC,OAAO,EAAE,wBAAwB;IAC1C,QAAQ,CAAC,UAAU,EAAE,MAAM;IAC3B,QAAQ,CAAC,aAAa,EAAE,wBAAwB;IARpD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;gBAGY,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,wBAAwB,EACjC,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,wBAAwB;IAMpD,MAAM,IAAI,IAAI;CASjB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAA;CAChC;AAED,MAAM,WAAW,gCAAgC;IAC7C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,2BAA2B,CAAA;CAC/C;AAED;;GAEG;AACH,oBAAY,wBAAwB;IAChC,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,cAAc,mBAAmB;IACjC,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;CACtB"}

package/dist/types/current/drm/commonEme/CommonEme.js

@@ -0,0 +1,46 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ErrorLevel, ErrorOrigin, ReportableError } from '@amazon/vinyl-util';
+/**
+ * A media key session error, translated from the specific media key session implementation.
+ */
+export class CommonMediaKeySessionError extends ReportableError {
+    code;
+    codeStr;
+    systemCode;
+    systemCodeStr;
+    get [Symbol.toStringTag]() {
+        return 'CommonMediaKeySessionError';
+    }
+    constructor(code, codeStr, systemCode, systemCodeStr) {
+        super(codeStr, ErrorOrigin.DRM, ErrorLevel.WARN);
+        this.code = code;
+        this.codeStr = codeStr;
+        this.systemCode = systemCode;
+        this.systemCodeStr = systemCodeStr;
+        Object.setPrototypeOf(this, CommonMediaKeySessionError.prototype);
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            code: this.code,
+            codeStr: this.codeStr,
+            systemCode: this.systemCode,
+            systemCodeStr: this.systemCodeStr,
+        };
+    }
+}
+/**
+ * String representations of session error codes.
+ */
+export var MediaKeySessionErrorType;
+(function (MediaKeySessionErrorType) {
+    MediaKeySessionErrorType["CLIENT"] = "CLIENT";
+    MediaKeySessionErrorType["DOMAIN"] = "DOMAIN";
+    MediaKeySessionErrorType["HARDWARECHANGE"] = "HARDWARECHANGE";
+    MediaKeySessionErrorType["OUTPUT"] = "OUTPUT";
+    MediaKeySessionErrorType["SERVICE"] = "SERVICE";
+    MediaKeySessionErrorType["UNKNOWN"] = "UNKNOWN";
+})(MediaKeySessionErrorType || (MediaKeySessionErrorType = {}));

package/dist/types/current/drm/commonEme/CommonEmeFactory.d.ts

@@ -0,0 +1,28 @@
+import type { CommonEme } from '../../drm/commonEme/CommonEme';
+/**
+ * Common EME Factory provides the first supported implementation of CommonEme.
+ * The priority is WebKit, Standard, then MS.
+ *
+ * Note: WebKit if present is currently prioritized over standard for legacy reasons. This may be an obsolete
+ * requirement. https://jira.music.amazon.dev/browse/PLAYBACK-6072 ticket to investigate.
+ */
+export declare function commonEmeFactory(): CommonEme | null;
+/**
+ * Tests for Standard Eme support.
+ */
+export declare function supportsStandardEme(): boolean;
+/**
+ * Tests for WebKitEme support.
+ */
+export declare function supportsWebKitEme(): boolean;
+/**
+ * Tests for MsEme support.
+ */
+export declare function supportsMsEme(): boolean;
+export type MediaKeySupport = {
+    readonly standardEme: boolean;
+    readonly webkitEme: boolean;
+    readonly msEme: boolean;
+};
+export declare const mediaKeySupportRef: import("@amazon/vinyl-util").GlobalRef<MediaKeySupport>;
+//# sourceMappingURL=CommonEmeFactory.d.ts.map

package/dist/types/current/drm/commonEme/CommonEmeFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommonEmeFactory.d.ts","sourceRoot":"","sources":["../../../../../src/drm/commonEme/CommonEmeFactory.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAG1D;;;;;;GAMG;AACH,wBAAgB,gBAAgB,IAAI,SAAS,GAAG,IAAI,CAKnD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,OAAO,CAE7C;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAE3C;AAED;;GAEG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAEvC;AAED,MAAM,MAAM,eAAe,GAAG;IAC1B,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAA;IAC7B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAA;IAC3B,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;CAC1B,CAAA;AAED,eAAO,MAAM,kBAAkB,yDAM7B,CAAA"}

package/dist/types/current/drm/commonEme/CommonEmeFactory.js

@@ -0,0 +1,49 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { MsCommonEme } from './MsCommonEme';
+import { StandardCommonEme } from './StandardCommonEme';
+import { WebKitCommonEme } from './WebKitCommonEme';
+import { globalRef } from '@amazon/vinyl-util';
+/**
+ * Common EME Factory provides the first supported implementation of CommonEme.
+ * The priority is WebKit, Standard, then MS.
+ *
+ * Note: WebKit if present is currently prioritized over standard for legacy reasons. This may be an obsolete
+ * requirement. https://jira.music.amazon.dev/browse/PLAYBACK-6072 ticket to investigate.
+ */
+export function commonEmeFactory() {
+    if (supportsWebKitEme())
+        return new WebKitCommonEme();
+    if (supportsStandardEme())
+        return new StandardCommonEme();
+    if (supportsMsEme())
+        return new MsCommonEme();
+    return null;
+}
+/**
+ * Tests for Standard Eme support.
+ */
+export function supportsStandardEme() {
+    return mediaKeySupportRef.value.standardEme;
+}
+/**
+ * Tests for WebKitEme support.
+ */
+export function supportsWebKitEme() {
+    return mediaKeySupportRef.value.webkitEme;
+}
+/**
+ * Tests for MsEme support.
+ */
+export function supportsMsEme() {
+    return mediaKeySupportRef.value.msEme;
+}
+export const mediaKeySupportRef = globalRef(() => {
+    return {
+        standardEme: typeof MediaKeys !== 'undefined',
+        webkitEme: typeof WebKitMediaKeys !== 'undefined',
+        msEme: typeof global.MSMediaKeys !== 'undefined',
+    };
+});

package/dist/types/current/drm/commonEme/EncryptedInitData.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This represents the initialization data from the encrypted event.
+ *
+ * - msneedkey: Uint8Array
+ * - webkitneedkey: ArrayBuffer
+ * - encrypted: ArrayBuffer
+ */
+export type EncryptedInitData = ArrayBuffer | Uint8Array<ArrayBuffer>;
+//# sourceMappingURL=EncryptedInitData.d.ts.map

package/dist/types/current/drm/commonEme/EncryptedInitData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EncryptedInitData.d.ts","sourceRoot":"","sources":["../../../../../src/drm/commonEme/EncryptedInitData.ts"],"names":[],"mappings":"AAKA;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC,CAAA"}

package/dist/types/current/drm/commonEme/EncryptedInitData.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/drm/commonEme/MsCommonEme.d.ts

@@ -0,0 +1,68 @@
+import { type Disposable, EventHostImpl, type Unsubscribe } from '@amazon/vinyl-util';
+import { type CommonEme, type CommonMediaKeys, type CommonMediaKeySession, type CommonMediaKeySessionEventMap, type CommonMediaKeySystemAccess, MediaKeySessionErrorType } from './CommonEme';
+import type { DrmKeySystem } from '../../drm/DrmKeySystem';
+import { type EncryptedInitData } from './EncryptedInitData';
+import type { DrmInitDataType } from '../../streaming/DrmInitDataType';
+declare global {
+    interface HTMLMediaElementEventMap extends HTMLElementEventMap {
+        readonly msneedkey: MSMediaKeyNeededEvent;
+    }
+    interface MSMediaKeyNeededEvent extends Event {
+        readonly initDataType: string;
+        readonly initData: Uint8Array<ArrayBuffer> | null;
+    }
+}
+/**
+ * A CommonEme implementation of MS prefixed Encrypted Media Extensions as supported by IE11/Edge.
+ */
+export declare class MsCommonEme implements CommonEme {
+    requestMediaKeySystemAccess(keySystem: DrmKeySystem, supportedConfigurations: readonly MediaKeySystemConfiguration[]): Promise<CommonMediaKeySystemAccess>;
+    /**
+     * Listens to the element for an encrypted event, returning a disposable handle.
+     */
+    addEncryptedListener(element: HTMLMediaElement, handler: (event: MediaEncryptedEvent) => void): Unsubscribe;
+}
+export declare class MsCommonMediaKeySystemAccess implements CommonMediaKeySystemAccess {
+    readonly keySystem: DrmKeySystem;
+    constructor(keySystem: DrmKeySystem);
+    createMediaKeys(): Promise<CommonMediaKeys>;
+}
+/**
+ * @private
+ */
+export declare class MsCommonMediaKeys implements CommonMediaKeys {
+    readonly keySystem: DrmKeySystem;
+    readonly mediaKeys: MSMediaKeys;
+    constructor(keySystem: DrmKeySystem, mediaKeys: MSMediaKeys);
+    /**
+     * Sets the media keys on the given element.
+     */
+    setOnElement(element: HTMLMediaElement): Promise<void>;
+    /**
+     * Clears the media keys from the given element.
+     */
+    clearFromElement(element: HTMLMediaElement): Promise<void>;
+    setServerCertificate(_certificate: BufferSource): Promise<boolean>;
+    createSession(mimeType: string, initDataType: DrmInitDataType, initData: EncryptedInitData): CommonMediaKeySession;
+}
+/**
+ * @private
+ */
+export declare class MsCommonMediaKeySession extends EventHostImpl<CommonMediaKeySessionEventMap> implements CommonMediaKeySession, Disposable {
+    private readonly session;
+    readonly mimeType: string;
+    readonly initDataType: DrmInitDataType;
+    readonly initData: EncryptedInitData;
+    private _disposed;
+    constructor(session: MSMediaKeySession, mimeType: string, initDataType: DrmInitDataType, initData: EncryptedInitData);
+    private readonly messageHandler;
+    private readonly errorHandler;
+    update(key: ArrayBuffer): Promise<void>;
+    get disposed(): boolean;
+    dispose(): void;
+}
+/**
+ * Returns a string for the WebKit media key error.
+ */
+export declare function msErrorCodeToStr(code: number): MediaKeySessionErrorType;
+//# sourceMappingURL=MsCommonEme.d.ts.map

package/dist/types/current/drm/commonEme/MsCommonEme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MsCommonEme.d.ts","sourceRoot":"","sources":["../../../../../src/drm/commonEme/MsCommonEme.ts"],"names":[],"mappings":"AAKA,OAAO,EAEH,KAAK,UAAU,EAGf,aAAa,EACb,KAAK,WAAW,EACnB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EACH,KAAK,SAAS,EACd,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAE1B,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,EAC/B,wBAAwB,EAC3B,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAG5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAA;AAElE,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,wBAAyB,SAAQ,mBAAmB;QAC1D,QAAQ,CAAC,SAAS,EAAE,qBAAqB,CAAA;KAC5C;IAED,UAAU,qBAAsB,SAAQ,KAAK;QACzC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;QAC7B,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,IAAI,CAAA;KACpD;CACJ;AAED;;GAEG;AACH,qBAAa,WAAY,YAAW,SAAS;IACzC,2BAA2B,CACvB,SAAS,EAAE,YAAY,EACvB,uBAAuB,EAAE,SAAS,2BAA2B,EAAE,GAChE,OAAO,CAAC,0BAA0B,CAAC;IA4BtC;;OAEG;IACH,oBAAoB,CAChB,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,GAC9C,WAAW;CAMjB;AAED,qBAAa,4BAA6B,YAAW,0BAA0B;IAC/D,QAAQ,CAAC,SAAS,EAAE,YAAY;gBAAvB,SAAS,EAAE,YAAY;IAE5C,eAAe,IAAI,OAAO,CAAC,eAAe,CAAC;CAM9C;AAED;;GAEG;AACH,qBAAa,iBAAkB,YAAW,eAAe;aAEjC,SAAS,EAAE,YAAY;aACvB,SAAS,EAAE,WAAW;gBADtB,SAAS,EAAE,YAAY,EACvB,SAAS,EAAE,WAAW;IAG1C;;OAEG;IACH,YAAY,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAKtD;;OAEG;IACH,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAK1D,oBAAoB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlE,aAAa,CACT,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,eAAe,EAC7B,QAAQ,EAAE,iBAAiB,GAC5B,qBAAqB;CAY3B;AAED;;GAEG;AACH,qBAAa,uBACT,SAAQ,aAAa,CAAC,6BAA6B,CACnD,YAAW,qBAAqB,EAAE,UAAU;IAKxC,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACzB,QAAQ,CAAC,YAAY,EAAE,eAAe;IACtC,QAAQ,CAAC,QAAQ,EAAE,iBAAiB;IANxC,OAAO,CAAC,SAAS,CAAiB;gBAGb,OAAO,EAAE,iBAAiB,EAClC,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,eAAe,EAC7B,QAAQ,EAAE,iBAAiB;IAOxC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAI9B;IAED,OAAO,CAAC,QAAQ,CAAC,YAAY,CAW5B;IAED,MAAM,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAMvC,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,OAAO,IAAI,IAAI;CAOlB;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,wBAAwB,CAgBvE"}

package/dist/types/current/drm/commonEme/MsCommonEme.js

@@ -0,0 +1,143 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { bufferToByteArray, DisposedError, ErrorOrigin, EventHostImpl, } from '@amazon/vinyl-util';
+import { CommonMediaKeySessionError, MediaKeySessionErrorType, } from './CommonEme';
+import { DrmError } from '../../drm/error/DrmError';
+/**
+ * A CommonEme implementation of MS prefixed Encrypted Media Extensions as supported by IE11/Edge.
+ */
+export class MsCommonEme {
+    requestMediaKeySystemAccess(keySystem, supportedConfigurations) {
+        for (const config of supportedConfigurations) {
+            const capabilities = [
+                ...(config.audioCapabilities ?? []),
+                ...(config.videoCapabilities ?? []),
+            ];
+            for (const capability of capabilities) {
+                if (MSMediaKeys.isTypeSupported(keySystem, capability.contentType)) {
+                    return Promise.resolve(new MsCommonMediaKeySystemAccess(keySystem));
+                }
+            }
+        }
+        return Promise.reject(new DrmError(`keySystem not supported: ${keySystem}`, { keySystem }, ErrorOrigin.DRM));
+    }
+    /**
+     * Listens to the element for an encrypted event, returning a disposable handle.
+     */
+    addEncryptedListener(element, handler) {
+        const event = 'msneedkey';
+        element.addEventListener(event, handler);
+        return () => element.removeEventListener(event, handler);
+    }
+}
+export class MsCommonMediaKeySystemAccess {
+    keySystem;
+    constructor(keySystem) {
+        this.keySystem = keySystem;
+    }
+    createMediaKeys() {
+        const msMediaKeys = new MSMediaKeys(this.keySystem);
+        return Promise.resolve(new MsCommonMediaKeys(this.keySystem, msMediaKeys));
+    }
+}
+/**
+ * @private
+ */
+export class MsCommonMediaKeys {
+    keySystem;
+    mediaKeys;
+    constructor(keySystem, mediaKeys) {
+        this.keySystem = keySystem;
+        this.mediaKeys = mediaKeys;
+    }
+    /**
+     * Sets the media keys on the given element.
+     */
+    setOnElement(element) {
+        element.msSetMediaKeys(this.mediaKeys);
+        return Promise.resolve();
+    }
+    /**
+     * Clears the media keys from the given element.
+     */
+    clearFromElement(element) {
+        element.msSetMediaKeys(null);
+        return Promise.resolve();
+    }
+    setServerCertificate(_certificate) {
+        return Promise.resolve(false);
+    }
+    createSession(mimeType, initDataType, initData) {
+        const session = this.mediaKeys.createSession(mimeType, bufferToByteArray(initData));
+        return new MsCommonMediaKeySession(session, mimeType, initDataType, initData);
+    }
+}
+/**
+ * @private
+ */
+export class MsCommonMediaKeySession extends EventHostImpl {
+    session;
+    mimeType;
+    initDataType;
+    initData;
+    _disposed = false;
+    constructor(session, mimeType, initDataType, initData) {
+        super();
+        this.session = session;
+        this.mimeType = mimeType;
+        this.initDataType = initDataType;
+        this.initData = initData;
+        session.addEventListener('mskeymessage', this.messageHandler);
+        session.addEventListener('mskeyerror', this.errorHandler);
+    }
+    messageHandler = (event) => {
+        this.dispatch('message', {
+            message: event.message.buffer,
+        });
+    };
+    errorHandler = () => {
+        if (this.session.error) {
+            const e = this.session.error;
+            const error = new CommonMediaKeySessionError(e.code, msErrorCodeToStr(e.code), e.systemCode, msErrorCodeToStr(e.systemCode));
+            this.dispatch('error', { error, target: this });
+        }
+    };
+    update(key) {
+        if (this.disposed)
+            return Promise.reject(new DisposedError());
+        this.session.update(new Uint8Array(key));
+        return Promise.resolve();
+    }
+    get disposed() {
+        return this._disposed;
+    }
+    dispose() {
+        super.dispose();
+        this._disposed = true;
+        this.session.close();
+        this.session.removeEventListener('mskeymessage', this.messageHandler);
+        this.session.removeEventListener('mskeyerror', this.errorHandler);
+    }
+}
+/**
+ * Returns a string for the WebKit media key error.
+ */
+export function msErrorCodeToStr(code) {
+    switch (code) {
+        case MSMediaKeyError.MS_MEDIA_KEYERR_CLIENT:
+            return MediaKeySessionErrorType.CLIENT;
+        case MSMediaKeyError.MS_MEDIA_KEYERR_DOMAIN:
+            return MediaKeySessionErrorType.DOMAIN;
+        case MSMediaKeyError.MS_MEDIA_KEYERR_HARDWARECHANGE:
+            return MediaKeySessionErrorType.HARDWARECHANGE;
+        case MSMediaKeyError.MS_MEDIA_KEYERR_OUTPUT:
+            return MediaKeySessionErrorType.OUTPUT;
+        case MSMediaKeyError.MS_MEDIA_KEYERR_SERVICE:
+            return MediaKeySessionErrorType.SERVICE;
+        case MSMediaKeyError.MS_MEDIA_KEYERR_UNKNOWN:
+        default:
+            return MediaKeySessionErrorType.UNKNOWN;
+    }
+}