@svta/cml-cmcd 0.19.0

package/dist/CmcdData.d.ts

@@ -0,0 +1,12 @@
+import type { Cmcd } from './Cmcd.js';
+import type { CmcdEvent } from './CmcdEvent.js';
+import type { CmcdRequest } from './CmcdRequest.js';
+import type { CmcdResponse } from './CmcdResponse.js';
+/**
+ * All CMCD data types combined.
+ *
+ *
+ * @beta
+ */
+export type CmcdData = Cmcd & CmcdRequest & CmcdEvent & CmcdResponse;
+//# sourceMappingURL=CmcdData.d.ts.map

package/dist/CmcdData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdData.d.ts","sourceRoot":"","sources":["../src/CmcdData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,IAAI,GAAG,WAAW,GAAG,SAAS,GAAG,YAAY,CAAC"}

package/dist/CmcdData.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CmcdData.js.map

package/dist/CmcdData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdData.js","sourceRoot":"","sources":["../src/CmcdData.ts"],"names":[],"mappings":"","sourcesContent":["import type { Cmcd } from './Cmcd.js';\nimport type { CmcdEvent } from './CmcdEvent.js';\nimport type { CmcdRequest } from './CmcdRequest.js';\nimport type { CmcdResponse } from './CmcdResponse.js';\n\n/**\n * All CMCD data types combined.\n *\n *\n * @beta\n */\nexport type CmcdData = Cmcd & CmcdRequest & CmcdEvent & CmcdResponse;\n"]}

package/dist/CmcdEncodeOptions.d.ts

@@ -0,0 +1,45 @@
+import type { CmcdFormatterMap } from './CmcdFormatterMap.js';
+import type { CmcdHeaderMap } from './CmcdHeaderMap.js';
+import type { CmcdKey } from './CmcdKey.js';
+import type { CmcdReportingMode } from './CmcdReportingMode.js';
+/**
+ * Options for encoding CMCD values.
+ *
+ *
+ * @beta
+ */
+export type CmcdEncodeOptions = {
+    /**
+     * The version of the CMCD specification to use.
+     *
+     * @defaultValue `1`
+     */
+    version?: number;
+    /**
+     * The reporting mode to use.
+     *
+     * @defaultValue `CmcdReportingMode.REQUEST`
+     */
+    reportingMode?: CmcdReportingMode;
+    /**
+     * A map of CMCD keys to custom formatters.
+     */
+    formatters?: Partial<CmcdFormatterMap>;
+    /**
+     * A map of CMCD header fields to custom CMCD keys.
+     */
+    customHeaderMap?: Partial<CmcdHeaderMap>;
+    /**
+     * A filter function for CMCD keys.
+     *
+     * @param key - The CMCD key to filter.
+     *
+     * @returns `true` if the key should be included, `false` otherwise.
+     */
+    filter?: (key: CmcdKey) => boolean;
+    /**
+     * The base URL to use for relative URLs.
+     */
+    baseUrl?: string;
+};
+//# sourceMappingURL=CmcdEncodeOptions.d.ts.map

package/dist/CmcdEncodeOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdEncodeOptions.d.ts","sourceRoot":"","sources":["../src/CmcdEncodeOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC/B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEvC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/CmcdEncodeOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CmcdEncodeOptions.js.map

package/dist/CmcdEncodeOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdEncodeOptions.js","sourceRoot":"","sources":["../src/CmcdEncodeOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { CmcdFormatterMap } from './CmcdFormatterMap.js';\nimport type { CmcdHeaderMap } from './CmcdHeaderMap.js';\nimport type { CmcdKey } from './CmcdKey.js';\nimport type { CmcdReportingMode } from './CmcdReportingMode.js';\n\n/**\n * Options for encoding CMCD values.\n *\n *\n * @beta\n */\nexport type CmcdEncodeOptions = {\n\t/**\n\t * The version of the CMCD specification to use.\n\t *\n\t * @defaultValue `1`\n\t */\n\tversion?: number;\n\n\t/**\n\t * The reporting mode to use.\n\t *\n\t * @defaultValue `CmcdReportingMode.REQUEST`\n\t */\n\treportingMode?: CmcdReportingMode;\n\n\t/**\n\t * A map of CMCD keys to custom formatters.\n\t */\n\tformatters?: Partial<CmcdFormatterMap>;\n\n\t/**\n\t * A map of CMCD header fields to custom CMCD keys.\n\t */\n\tcustomHeaderMap?: Partial<CmcdHeaderMap>;\n\n\t/**\n\t * A filter function for CMCD keys.\n\t *\n\t * @param key - The CMCD key to filter.\n\t *\n\t * @returns `true` if the key should be included, `false` otherwise.\n\t */\n\tfilter?: (key: CmcdKey) => boolean;\n\n\t/**\n\t * The base URL to use for relative URLs.\n\t */\n\tbaseUrl?: string;\n};\n"]}

package/dist/CmcdEncoding.d.ts

@@ -0,0 +1,20 @@
+import type { ValueOf } from '@svta/cml-utils/ValueOf.js';
+import { CmcdTransmissionMode } from './CmcdTransmissionMode.js';
+/**
+ * CMCD encoding types.
+ *
+ *
+ * @enum
+ *
+ * @beta
+ *
+ * @deprecated Use {@link CmcdTransmissionMode} instead.
+ *
+ * @see {@link CmcdTransmissionMode}
+ */
+export declare const CmcdEncoding: typeof CmcdTransmissionMode;
+/**
+ * @beta
+ */
+export type CmcdEncoding = ValueOf<typeof CmcdEncoding>;
+//# sourceMappingURL=CmcdEncoding.d.ts.map

package/dist/CmcdEncoding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdEncoding.d.ts","sourceRoot":"","sources":["../src/CmcdEncoding.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,EAAE,OAAO,oBAA2C,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,YAAY,CAAC,CAAC"}

package/dist/CmcdEncoding.js

@@ -0,0 +1,15 @@
+import { CmcdTransmissionMode } from './CmcdTransmissionMode.js';
+/**
+ * CMCD encoding types.
+ *
+ *
+ * @enum
+ *
+ * @beta
+ *
+ * @deprecated Use {@link CmcdTransmissionMode} instead.
+ *
+ * @see {@link CmcdTransmissionMode}
+ */
+export const CmcdEncoding = CmcdTransmissionMode;
+//# sourceMappingURL=CmcdEncoding.js.map

package/dist/CmcdEncoding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdEncoding.js","sourceRoot":"","sources":["../src/CmcdEncoding.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,YAAY,GAAgC,oBAAoB,CAAC","sourcesContent":["import type { ValueOf } from '@svta/cml-utils/ValueOf.js';\nimport { CmcdTransmissionMode } from './CmcdTransmissionMode.js';\n\n/**\n * CMCD encoding types.\n *\n *\n * @enum\n *\n * @beta\n *\n * @deprecated Use {@link CmcdTransmissionMode} instead.\n *\n * @see {@link CmcdTransmissionMode}\n */\nexport const CmcdEncoding: typeof CmcdTransmissionMode = CmcdTransmissionMode;\n\n/**\n * @beta\n */\nexport type CmcdEncoding = ValueOf<typeof CmcdEncoding>;\n"]}

package/dist/CmcdEvent.d.ts

@@ -0,0 +1,49 @@
+import type { CmcdEventExcludedKeys } from './CmcdEventExcludedKeys.js';
+import type { CmcdEventType } from './CmcdEventType.js';
+import type { CmcdRequest } from './CmcdRequest.js';
+/**
+ * CMCD v2 - Event Mode.
+ *
+ * Represents the event and keys for CMCD v2.
+ *
+ * This type is used to structure the data for reporting events according to the
+ * Common Media Client Data (CMCD) version 2 specification. It encapsulates
+ * the reporting event token.
+ *
+ *
+ * @beta
+ */
+export type CmcdEvent = Omit<CmcdRequest, CmcdEventExcludedKeys> & {
+    /**
+     * Event (event mode; e.g. "e", "t", "ps")
+     *
+     * This key MUST only be used in Event mode.
+     *
+     * ps - play state change. This token MUST be accompanied by a 'sta' key carrying the new state.
+     *
+     * e - the player has experienced an error. This token MUST be accompanied by a 'ec' key defining the player error code.
+     *
+     * t - time interval. The interval at which these reports are made is application-defined. A default interval of 30 seconds SHOULD
+     * be used if no explicit application interval is provided. Short form content may wish to use a shorter interval.
+     * An application-defined interval of zero should be interpreted as turning off interval event reporting.
+     * This event MUST be supported by all players that support Event mode.
+     *
+     * c - content ID has changed. This token MUST be accompanied by a 'cid' key defining the new content ID.
+     *
+     * b - the player has entered backgrounded mode if this event is accompanied by the ‘bg’ key and exited backgrounded mode if not.
+     *
+     * m - mute. The user activated the mute control or set the volume to zero.
+     *
+     * um - unmute. The user deactivated the mute control or raised the volume above zero if it was previously set to zero.
+     *
+     * pe - playerExpand. The user activated a control to extend the player to a larger size. The definition of this event is intended to be
+     * compliant with the VAST [VAST] Player Operation Metrics.
+     *
+     * c - playerCollapse: the user activated a control to reduce the player to a smaller size. The definition of this event is intended to be
+     * compliant with the VAST [VAST] Player Operation Metrics.
+     *
+     * Token - one of [ps,e,t,c,b,m,u m, abs, abe, as, ae]
+     */
+    e?: CmcdEventType;
+};
+//# sourceMappingURL=CmcdEvent.d.ts.map

package/dist/CmcdEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdEvent.d.ts","sourceRoot":"","sources":["../src/CmcdEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,qBAAqB,CAAC,GAAG;IAClE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,CAAC,CAAC,EAAE,aAAa,CAAC;CAClB,CAAC"}

package/dist/CmcdEvent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CmcdEvent.js.map

package/dist/CmcdEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdEvent.js","sourceRoot":"","sources":["../src/CmcdEvent.ts"],"names":[],"mappings":"","sourcesContent":["import type { CmcdEventExcludedKeys } from './CmcdEventExcludedKeys.js';\nimport type { CmcdEventType } from './CmcdEventType.js';\nimport type { CmcdRequest } from './CmcdRequest.js';\n\n/**\n * CMCD v2 - Event Mode.\n *\n * Represents the event and keys for CMCD v2.\n *\n * This type is used to structure the data for reporting events according to the\n * Common Media Client Data (CMCD) version 2 specification. It encapsulates\n * the reporting event token.\n *\n *\n * @beta\n */\nexport type CmcdEvent = Omit<CmcdRequest, CmcdEventExcludedKeys> & {\n\t/**\n\t * Event (event mode; e.g. \"e\", \"t\", \"ps\")\n\t *\n\t * This key MUST only be used in Event mode.\n\t *\n\t * ps - play state change. This token MUST be accompanied by a 'sta' key carrying the new state.\n\t *\n\t * e - the player has experienced an error. This token MUST be accompanied by a 'ec' key defining the player error code.\n\t *\n\t * t - time interval. The interval at which these reports are made is application-defined. A default interval of 30 seconds SHOULD\n\t * be used if no explicit application interval is provided. Short form content may wish to use a shorter interval.\n\t * An application-defined interval of zero should be interpreted as turning off interval event reporting.\n\t * This event MUST be supported by all players that support Event mode.\n\t *\n\t * c - content ID has changed. This token MUST be accompanied by a 'cid' key defining the new content ID.\n\t *\n\t * b - the player has entered backgrounded mode if this event is accompanied by the ‘bg’ key and exited backgrounded mode if not.\n\t *\n\t * m - mute. The user activated the mute control or set the volume to zero.\n\t *\n\t * um - unmute. The user deactivated the mute control or raised the volume above zero if it was previously set to zero.\n\t *\n\t * pe - playerExpand. The user activated a control to extend the player to a larger size. The definition of this event is intended to be\n\t * compliant with the VAST [VAST] Player Operation Metrics.\n\t *\n\t * c - playerCollapse: the user activated a control to reduce the player to a smaller size. The definition of this event is intended to be\n\t * compliant with the VAST [VAST] Player Operation Metrics.\n\t *\n\t * Token - one of [ps,e,t,c,b,m,u m, abs, abe, as, ae]\n\t */\n\te?: CmcdEventType;\n};\n"]}

package/dist/CmcdEventExcludedKeys.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Keys that are excluded from CMCD event mode.
+ *
+ *
+ * @beta
+ */
+export type CmcdEventExcludedKeys = 'bs' | 'bsd' | 'cmsdd' | 'cmsds' | 'd' | 'dl' | 'nor' | 'ot' | 'rc' | 'rtp' | 'smrt' | 'su' | 'ttfbb' | 'ttlb' | 'url';
+//# sourceMappingURL=CmcdEventExcludedKeys.d.ts.map

package/dist/CmcdEventExcludedKeys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdEventExcludedKeys.d.ts","sourceRoot":"","sources":["../src/CmcdEventExcludedKeys.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAC9B,IAAI,GACJ,KAAK,GACL,OAAO,GACP,OAAO,GACP,GAAG,GACH,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,MAAM,GACN,IAAI,GACJ,OAAO,GACP,MAAM,GACN,KAAK,CAAC"}

package/dist/CmcdEventExcludedKeys.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CmcdEventExcludedKeys.js.map

package/dist/CmcdEventExcludedKeys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdEventExcludedKeys.js","sourceRoot":"","sources":["../src/CmcdEventExcludedKeys.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Keys that are excluded from CMCD event mode.\n *\n *\n * @beta\n */\nexport type CmcdEventExcludedKeys =\n\t| 'bs'\n\t| 'bsd'\n\t| 'cmsdd'\n\t| 'cmsds'\n\t| 'd'\n\t| 'dl'\n\t| 'nor'\n\t| 'ot'\n\t| 'rc'\n\t| 'rtp'\n\t| 'smrt'\n\t| 'su'\n\t| 'ttfbb'\n\t| 'ttlb'\n\t| 'url';\n"]}

package/dist/CmcdEventType.d.ts

@@ -0,0 +1,52 @@
+import type { ValueOf } from '@svta/cml-utils/ValueOf.js';
+/**
+ * CMCD event types for the 'e' key (event mode).
+ *
+ *
+ * @enum
+ *
+ * @beta
+ */
+export declare const CmcdEventType: {
+    /**
+     * A change in the player state.
+     */
+    readonly PLAY_STATE: "ps";
+    /**
+     * An error event.
+     */
+    readonly ERROR: "e";
+    /**
+     * A periodic report sent on a time interval.
+     */
+    readonly TIME_INTERVAL: "t";
+    /**
+     * A change of the content ID.
+     */
+    readonly CONTENT_ID: "c";
+    /**
+     * A change in the application's backgrounded state.
+     */
+    readonly BACKGROUNDED_MODE: "b";
+    /**
+     * The player was muted.
+     */
+    readonly MUTE: "m";
+    /**
+     * Player unmuted.
+     */
+    readonly UNMUTE: "um";
+    /**
+     * The player view was expanded.
+     */
+    readonly PLAYER_EXPAND: "pe";
+    /**
+     * The player view was collapsed.
+     */
+    readonly PLAYER_COLLAPSE: "pc";
+};
+/**
+ * @beta
+ */
+export type CmcdEventType = ValueOf<typeof CmcdEventType>;
+//# sourceMappingURL=CmcdEventType.d.ts.map

package/dist/CmcdEventType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdEventType.d.ts","sourceRoot":"","sources":["../src/CmcdEventType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAE1D;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa;IACzB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;CAEM,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,aAAa,CAAC,CAAC"}

package/dist/CmcdEventType.js

@@ -0,0 +1,47 @@
+/**
+ * CMCD event types for the 'e' key (event mode).
+ *
+ *
+ * @enum
+ *
+ * @beta
+ */
+export const CmcdEventType = {
+    /**
+     * A change in the player state.
+     */
+    PLAY_STATE: 'ps',
+    /**
+     * An error event.
+     */
+    ERROR: 'e',
+    /**
+     * A periodic report sent on a time interval.
+     */
+    TIME_INTERVAL: 't',
+    /**
+     * A change of the content ID.
+     */
+    CONTENT_ID: 'c',
+    /**
+     * A change in the application's backgrounded state.
+     */
+    BACKGROUNDED_MODE: 'b',
+    /**
+     * The player was muted.
+     */
+    MUTE: 'm',
+    /**
+     * Player unmuted.
+     */
+    UNMUTE: 'um',
+    /**
+     * The player view was expanded.
+     */
+    PLAYER_EXPAND: 'pe',
+    /**
+     * The player view was collapsed.
+     */
+    PLAYER_COLLAPSE: 'pc',
+};
+//# sourceMappingURL=CmcdEventType.js.map

package/dist/CmcdEventType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdEventType.js","sourceRoot":"","sources":["../src/CmcdEventType.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC5B;;OAEG;IACH,UAAU,EAAE,IAAI;IAEhB;;OAEG;IACH,KAAK,EAAE,GAAG;IAEV;;OAEG;IACH,aAAa,EAAE,GAAG;IAElB;;OAEG;IACH,UAAU,EAAE,GAAG;IAEf;;OAEG;IACH,iBAAiB,EAAE,GAAG;IAEtB;;OAEG;IACH,IAAI,EAAE,GAAG;IAET;;OAEG;IACH,MAAM,EAAE,IAAI;IAEZ;;OAEG;IACH,aAAa,EAAE,IAAI;IAEnB;;OAEG;IACH,eAAe,EAAE,IAAI;CACZ,CAAC","sourcesContent":["import type { ValueOf } from '@svta/cml-utils/ValueOf.js';\n\n/**\n * CMCD event types for the 'e' key (event mode).\n *\n *\n * @enum\n *\n * @beta\n */\nexport const CmcdEventType = {\n\t/**\n\t * A change in the player state.\n\t */\n\tPLAY_STATE: 'ps',\n\n\t/**\n\t * An error event.\n\t */\n\tERROR: 'e',\n\n\t/**\n\t * A periodic report sent on a time interval.\n\t */\n\tTIME_INTERVAL: 't',\n\n\t/**\n\t * A change of the content ID.\n\t */\n\tCONTENT_ID: 'c',\n\n\t/**\n\t * A change in the application's backgrounded state.\n\t */\n\tBACKGROUNDED_MODE: 'b',\n\n\t/**\n\t * The player was muted.\n\t */\n\tMUTE: 'm',\n\n\t/**\n\t * Player unmuted.\n\t */\n\tUNMUTE: 'um',\n\n\t/**\n\t * The player view was expanded.\n\t */\n\tPLAYER_EXPAND: 'pe',\n\n\t/**\n\t * The player view was collapsed.\n\t */\n\tPLAYER_COLLAPSE: 'pc',\n} as const;\n\n/**\n * @beta\n */\nexport type CmcdEventType = ValueOf<typeof CmcdEventType>;\n"]}

package/dist/CmcdFormatter.d.ts

@@ -0,0 +1,16 @@
+import type { SfItem } from '@svta/cml-structured-field-values/SfItem.js';
+import type { ValueOrArray } from '@svta/cml-utils/ValueOrArray.js';
+import type { CmcdFormatterOptions } from './CmcdFormatterOptions.js';
+import type { CmcdValue } from './CmcdValue.js';
+/**
+ * A formatter for CMCD values.
+ *
+ * @param value - The value to format.
+ *
+ * @returns The formatted value.
+ *
+ *
+ * @beta
+ */
+export type CmcdFormatter = (value: CmcdValue, options: CmcdFormatterOptions) => number | ValueOrArray<string> | ValueOrArray<SfItem>;
+//# sourceMappingURL=CmcdFormatter.d.ts.map

package/dist/CmcdFormatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdFormatter.d.ts","sourceRoot":"","sources":["../src/CmcdFormatter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,6CAA6C,CAAC;AAC1E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,oBAAoB,KAAK,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC"}

package/dist/CmcdFormatter.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CmcdFormatter.js.map

package/dist/CmcdFormatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdFormatter.js","sourceRoot":"","sources":["../src/CmcdFormatter.ts"],"names":[],"mappings":"","sourcesContent":["import type { SfItem } from '@svta/cml-structured-field-values/SfItem.js';\nimport type { ValueOrArray } from '@svta/cml-utils/ValueOrArray.js';\nimport type { CmcdFormatterOptions } from './CmcdFormatterOptions.js';\nimport type { CmcdValue } from './CmcdValue.js';\n\n/**\n * A formatter for CMCD values.\n *\n * @param value - The value to format.\n *\n * @returns The formatted value.\n *\n *\n * @beta\n */\nexport type CmcdFormatter = (value: CmcdValue, options: CmcdFormatterOptions) => number | ValueOrArray<string> | ValueOrArray<SfItem>;\n"]}

package/dist/CmcdFormatterMap.d.ts

@@ -0,0 +1,10 @@
+import type { CmcdFormatter } from './CmcdFormatter.js';
+import type { CmcdKey } from './CmcdKey.js';
+/**
+ * A map of CMCD keys to format functions.
+ *
+ *
+ * @beta
+ */
+export type CmcdFormatterMap = Record<CmcdKey, CmcdFormatter>;
+//# sourceMappingURL=CmcdFormatterMap.d.ts.map

package/dist/CmcdFormatterMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdFormatterMap.d.ts","sourceRoot":"","sources":["../src/CmcdFormatterMap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC"}

package/dist/CmcdFormatterMap.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CmcdFormatterMap.js.map

package/dist/CmcdFormatterMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdFormatterMap.js","sourceRoot":"","sources":["../src/CmcdFormatterMap.ts"],"names":[],"mappings":"","sourcesContent":["import type { CmcdFormatter } from './CmcdFormatter.js';\nimport type { CmcdKey } from './CmcdKey.js';\n\n/**\n * A map of CMCD keys to format functions.\n *\n *\n * @beta\n */\nexport type CmcdFormatterMap = Record<CmcdKey, CmcdFormatter>;\n"]}

package/dist/CmcdFormatterOptions.d.ts

@@ -0,0 +1,22 @@
+import type { CmcdReportingMode } from './CmcdReportingMode.js';
+/**
+ * Options for formatting CMCD data values.
+ *
+ *
+ * @beta
+ */
+export type CmcdFormatterOptions = {
+    /**
+     * The version of the CMCD specification to use.
+     */
+    version: number;
+    /**
+     * The reporting mode to use.
+     */
+    reportingMode: CmcdReportingMode;
+    /**
+     * The base URL to use for relative URLs.
+     */
+    baseUrl?: string;
+};
+//# sourceMappingURL=CmcdFormatterOptions.d.ts.map

package/dist/CmcdFormatterOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdFormatterOptions.d.ts","sourceRoot":"","sources":["../src/CmcdFormatterOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/CmcdFormatterOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CmcdFormatterOptions.js.map

package/dist/CmcdFormatterOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdFormatterOptions.js","sourceRoot":"","sources":["../src/CmcdFormatterOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { CmcdReportingMode } from './CmcdReportingMode.js';\n\n/**\n * Options for formatting CMCD data values.\n *\n *\n * @beta\n */\nexport type CmcdFormatterOptions = {\n\t/**\n\t * The version of the CMCD specification to use.\n\t */\n\tversion: number;\n\n\t/**\n\t * The reporting mode to use.\n\t */\n\treportingMode: CmcdReportingMode;\n\n\t/**\n\t * The base URL to use for relative URLs.\n\t */\n\tbaseUrl?: string;\n};\n"]}

package/dist/CmcdFormatters.d.ts

@@ -0,0 +1,11 @@
+import type { CmcdFormatter } from './CmcdFormatter.js';
+/**
+ * The default formatters for CMCD values.
+ *
+ *
+ * @beta
+ *
+ * @deprecated Use `CMCD_FORMATTER_MAP` instead.
+ */
+export declare const CmcdFormatters: Record<string, CmcdFormatter>;
+//# sourceMappingURL=CmcdFormatters.d.ts.map

package/dist/CmcdFormatters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdFormatters.d.ts","sourceRoot":"","sources":["../src/CmcdFormatters.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAsB,CAAC"}

package/dist/CmcdFormatters.js

@@ -0,0 +1,11 @@
+import { CMCD_FORMATTER_MAP } from './CMCD_FORMATTER_MAP.js';
+/**
+ * The default formatters for CMCD values.
+ *
+ *
+ * @beta
+ *
+ * @deprecated Use `CMCD_FORMATTER_MAP` instead.
+ */
+export const CmcdFormatters = CMCD_FORMATTER_MAP;
+//# sourceMappingURL=CmcdFormatters.js.map

package/dist/CmcdFormatters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdFormatters.js","sourceRoot":"","sources":["../src/CmcdFormatters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAG7D;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,cAAc,GAAkC,kBAAkB,CAAC","sourcesContent":["import { CMCD_FORMATTER_MAP } from './CMCD_FORMATTER_MAP.js';\nimport type { CmcdFormatter } from './CmcdFormatter.js';\n\n/**\n * The default formatters for CMCD values.\n *\n *\n * @beta\n *\n * @deprecated Use `CMCD_FORMATTER_MAP` instead.\n */\nexport const CmcdFormatters: Record<string, CmcdFormatter> = CMCD_FORMATTER_MAP;\n"]}

package/dist/CmcdHeaderField.d.ts

@@ -0,0 +1,36 @@
+import type { ValueOf } from '@svta/cml-utils/ValueOf.js';
+import { CMCD_OBJECT } from './CMCD_OBJECT.js';
+import { CMCD_REQUEST } from './CMCD_REQUEST.js';
+import { CMCD_SESSION } from './CMCD_SESSION.js';
+import { CMCD_STATUS } from './CMCD_STATUS.js';
+/**
+ * CMCD header fields.
+ *
+ *
+ * @enum
+ *
+ * @beta
+ */
+export declare const CmcdHeaderField: {
+    /**
+     * keys whose values vary with the object being requested.
+     */
+    readonly OBJECT: typeof CMCD_OBJECT;
+    /**
+     * keys whose values vary with each request.
+     */
+    readonly REQUEST: typeof CMCD_REQUEST;
+    /**
+     * keys whose values are expected to be invariant over the life of the session.
+     */
+    readonly SESSION: typeof CMCD_SESSION;
+    /**
+     * keys whose values do not vary with every request or object.
+     */
+    readonly STATUS: typeof CMCD_STATUS;
+};
+/**
+ * @beta
+ */
+export type CmcdHeaderField = ValueOf<typeof CmcdHeaderField>;
+//# sourceMappingURL=CmcdHeaderField.d.ts.map

package/dist/CmcdHeaderField.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdHeaderField.d.ts","sourceRoot":"","sources":["../src/CmcdHeaderField.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe;IAC3B;;OAEG;qBACoB,OAAO,WAAW;IAEzC;;OAEG;sBACsB,OAAO,YAAY;IAE5C;;OAEG;sBACsB,OAAO,YAAY;IAE5C;;OAEG;qBACoB,OAAO,WAAW;CAChC,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/dist/CmcdHeaderField.js

@@ -0,0 +1,31 @@
+import { CMCD_OBJECT } from './CMCD_OBJECT.js';
+import { CMCD_REQUEST } from './CMCD_REQUEST.js';
+import { CMCD_SESSION } from './CMCD_SESSION.js';
+import { CMCD_STATUS } from './CMCD_STATUS.js';
+/**
+ * CMCD header fields.
+ *
+ *
+ * @enum
+ *
+ * @beta
+ */
+export const CmcdHeaderField = {
+    /**
+     * keys whose values vary with the object being requested.
+     */
+    OBJECT: CMCD_OBJECT,
+    /**
+     * keys whose values vary with each request.
+     */
+    REQUEST: CMCD_REQUEST,
+    /**
+     * keys whose values are expected to be invariant over the life of the session.
+     */
+    SESSION: CMCD_SESSION,
+    /**
+     * keys whose values do not vary with every request or object.
+     */
+    STATUS: CMCD_STATUS,
+};
+//# sourceMappingURL=CmcdHeaderField.js.map

package/dist/CmcdHeaderField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdHeaderField.js","sourceRoot":"","sources":["../src/CmcdHeaderField.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,WAAiC;IAEzC;;OAEG;IACH,OAAO,EAAE,YAAmC;IAE5C;;OAEG;IACH,OAAO,EAAE,YAAmC;IAE5C;;OAEG;IACH,MAAM,EAAE,WAAiC;CAChC,CAAC","sourcesContent":["import type { ValueOf } from '@svta/cml-utils/ValueOf.js';\nimport { CMCD_OBJECT } from './CMCD_OBJECT.js';\nimport { CMCD_REQUEST } from './CMCD_REQUEST.js';\nimport { CMCD_SESSION } from './CMCD_SESSION.js';\nimport { CMCD_STATUS } from './CMCD_STATUS.js';\n\n/**\n * CMCD header fields.\n *\n *\n * @enum\n *\n * @beta\n */\nexport const CmcdHeaderField = {\n\t/**\n\t * keys whose values vary with the object being requested.\n\t */\n\tOBJECT: CMCD_OBJECT as typeof CMCD_OBJECT,\n\n\t/**\n\t * keys whose values vary with each request.\n\t */\n\tREQUEST: CMCD_REQUEST as typeof CMCD_REQUEST,\n\n\t/**\n\t * keys whose values are expected to be invariant over the life of the session.\n\t */\n\tSESSION: CMCD_SESSION as typeof CMCD_SESSION,\n\n\t/**\n\t * keys whose values do not vary with every request or object.\n\t */\n\tSTATUS: CMCD_STATUS as typeof CMCD_STATUS,\n} as const;\n\n/**\n * @beta\n */\nexport type CmcdHeaderField = ValueOf<typeof CmcdHeaderField>;\n"]}

package/dist/CmcdHeaderMap.d.ts

@@ -0,0 +1,10 @@
+import type { CmcdHeaderField } from './CmcdHeaderField.js';
+import type { CmcdKey } from './CmcdKey.js';
+/**
+ * A map of CMCD header fields to CMCD keys.
+ *
+ *
+ * @beta
+ */
+export type CmcdHeaderMap = Record<CmcdHeaderField, CmcdKey[]>;
+//# sourceMappingURL=CmcdHeaderMap.d.ts.map

package/dist/CmcdHeaderMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdHeaderMap.d.ts","sourceRoot":"","sources":["../src/CmcdHeaderMap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,eAAe,EAAE,OAAO,EAAE,CAAC,CAAC"}

package/dist/CmcdHeaderMap.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CmcdHeaderMap.js.map

package/dist/CmcdHeaderMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdHeaderMap.js","sourceRoot":"","sources":["../src/CmcdHeaderMap.ts"],"names":[],"mappings":"","sourcesContent":["import type { CmcdHeaderField } from './CmcdHeaderField.js';\nimport type { CmcdKey } from './CmcdKey.js';\n\n/**\n * A map of CMCD header fields to CMCD keys.\n *\n *\n * @beta\n */\nexport type CmcdHeaderMap = Record<CmcdHeaderField, CmcdKey[]>;\n"]}

package/dist/CmcdHeadersMap.d.ts

@@ -0,0 +1,12 @@
+import type { CmcdHeaderField } from './CmcdHeaderField.js';
+import type { CmcdKey } from './CmcdKey.js';
+/**
+ * A map of CMCD header fields to CMCD keys.
+ *
+ *
+ * @beta
+ *
+ * @deprecated Use `CmcdHeaderMap` instead.
+ */
+export type CmcdHeadersMap = Record<CmcdHeaderField, CmcdKey[]>;
+//# sourceMappingURL=CmcdHeadersMap.d.ts.map

package/dist/CmcdHeadersMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdHeadersMap.d.ts","sourceRoot":"","sources":["../src/CmcdHeadersMap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,eAAe,EAAE,OAAO,EAAE,CAAC,CAAC"}

package/dist/CmcdHeadersMap.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CmcdHeadersMap.js.map

package/dist/CmcdHeadersMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdHeadersMap.js","sourceRoot":"","sources":["../src/CmcdHeadersMap.ts"],"names":[],"mappings":"","sourcesContent":["import type { CmcdHeaderField } from './CmcdHeaderField.js';\nimport type { CmcdKey } from './CmcdKey.js';\n\n/**\n * A map of CMCD header fields to CMCD keys.\n *\n *\n * @beta\n *\n * @deprecated Use `CmcdHeaderMap` instead.\n */\nexport type CmcdHeadersMap = Record<CmcdHeaderField, CmcdKey[]>;\n"]}

package/dist/CmcdKey.d.ts

@@ -0,0 +1,9 @@
+import type { CmcdData } from './CmcdData.js';
+/**
+ * A CMCD key.
+ *
+ *
+ * @beta
+ */
+export type CmcdKey = keyof CmcdData;
+//# sourceMappingURL=CmcdKey.d.ts.map

package/dist/CmcdKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdKey.d.ts","sourceRoot":"","sources":["../src/CmcdKey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC"}

package/dist/CmcdKey.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CmcdKey.js.map

package/dist/CmcdKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdKey.js","sourceRoot":"","sources":["../src/CmcdKey.ts"],"names":[],"mappings":"","sourcesContent":["import type { CmcdData } from './CmcdData.js';\n\n/**\n * A CMCD key.\n *\n *\n * @beta\n */\nexport type CmcdKey = keyof CmcdData;\n"]}

package/dist/CmcdObjectType.d.ts

@@ -0,0 +1,15 @@
+import { CmObjectType } from '@svta/cml-cta/CmObjectType.js';
+/**
+ * Common Media Client Data Object Type
+ *
+ *
+ * @beta
+ *
+ * @enum
+ */
+export declare const CmcdObjectType: typeof CmObjectType;
+/**
+ * @beta
+ */
+export type CmcdObjectType = CmObjectType;
+//# sourceMappingURL=CmcdObjectType.d.ts.map

package/dist/CmcdObjectType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CmcdObjectType.d.ts","sourceRoot":"","sources":["../src/CmcdObjectType.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAE7D;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,EAAmB,OAAO,YAAY,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,YAAY,CAAC"}