@svta/cml-cmcd 0.19.0

package/dist/index.d.ts

@@ -0,0 +1,74 @@
+/**
+ * A collection of tools for working with Common Media Client Data (CMCD).
+ *
+ * @packageDocumentation
+ *
+ * @beta
+ */
+export * from './appendCmcdHeaders.js';
+export * from './appendCmcdQuery.js';
+export type * from './Cmcd.js';
+export * from './CMCD_COMMON_KEYS.js';
+export * from './CMCD_DEFAULT_TIME_INTERVAL.js';
+export * from './CMCD_EVENT_KEYS.js';
+export * from './CMCD_EVENT_MODE.js';
+export * from './CMCD_FORMATTER_MAP.js';
+export * from './CMCD_HEADERS.js';
+export * from './CMCD_JSON.js';
+export * from './CMCD_KEYS.js';
+export * from './CMCD_OBJECT.js';
+export * from './CMCD_PARAM.js';
+export * from './CMCD_QUERY.js';
+export * from './CMCD_REQUEST.js';
+export * from './CMCD_REQUEST_KEYS.js';
+export * from './CMCD_REQUEST_MODE.js';
+export * from './CMCD_RESPONSE_KEYS.js';
+export * from './CMCD_RESPONSE_MODE.js';
+export * from './CMCD_SESSION.js';
+export * from './CMCD_STATUS.js';
+export * from './CMCD_V1.js';
+export * from './CMCD_V1_KEYS.js';
+export * from './CMCD_V2.js';
+export type * from './CmcdCustomKey.js';
+export type * from './CmcdData.js';
+export type * from './CmcdEncodeOptions.js';
+export * from './CmcdEncoding.js';
+export type * from './CmcdEvent.js';
+export type * from './CmcdEventExcludedKeys.js';
+export * from './CmcdEventType.js';
+export type * from './CmcdFormatter.js';
+export type * from './CmcdFormatterMap.js';
+export type * from './CmcdFormatterOptions.js';
+export * from './CmcdFormatters.js';
+export * from './CmcdHeaderField.js';
+export type * from './CmcdHeaderMap.js';
+export type * from './CmcdHeadersMap.js';
+export type * from './CmcdKey.js';
+export * from './CmcdObjectType.js';
+export * from './CmcdPlayerState.js';
+export * from './CmcdReportingMode.js';
+export type * from './CmcdReportTarget.js';
+export type * from './CmcdRequest.js';
+export type * from './CmcdResponse.js';
+export * from './CmcdStreamingFormat.js';
+export * from './CmcdStreamType.js';
+export * from './CmcdTransmissionMode.js';
+export type * from './CmcdValue.js';
+export * from './decodeCmcd.js';
+export * from './encodeCmcd.js';
+export * from './fromCmcdHeaders.js';
+export * from './fromCmcdQuery.js';
+export * from './fromCmcdUrl.js';
+export * from './groupCmcdHeaders.js';
+export * from './isCmcdCustomKey.js';
+export * from './isCmcdEventKey.js';
+export * from './isCmcdRequestKey.js';
+export * from './isCmcdResponseKey.js';
+export * from './isCmcdV1Key.js';
+export * from './prepareCmcdData.js';
+export * from './toCmcdHeaders.js';
+export * from './toCmcdJson.js';
+export * from './toCmcdQuery.js';
+export * from './toCmcdReport.js';
+export * from './toCmcdUrl.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,mBAAmB,WAAW,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,iCAAiC,CAAC;AAChD,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,mBAAmB,oBAAoB,CAAC;AACxC,mBAAmB,eAAe,CAAC;AACnC,mBAAmB,wBAAwB,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,mBAAmB,gBAAgB,CAAC;AACpC,mBAAmB,4BAA4B,CAAC;AAChD,cAAc,oBAAoB,CAAC;AACnC,mBAAmB,oBAAoB,CAAC;AACxC,mBAAmB,uBAAuB,CAAC;AAC3C,mBAAmB,2BAA2B,CAAC;AAC/C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,mBAAmB,oBAAoB,CAAC;AACxC,mBAAmB,qBAAqB,CAAC;AACzC,mBAAmB,cAAc,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,mBAAmB,uBAAuB,CAAC;AAC3C,mBAAmB,kBAAkB,CAAC;AACtC,mBAAmB,mBAAmB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,mBAAmB,gBAAgB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,58 @@
+/**
+ * A collection of tools for working with Common Media Client Data (CMCD).
+ *
+ * @packageDocumentation
+ *
+ * @beta
+ */
+export * from './appendCmcdHeaders.js';
+export * from './appendCmcdQuery.js';
+export * from './CMCD_COMMON_KEYS.js';
+export * from './CMCD_DEFAULT_TIME_INTERVAL.js';
+export * from './CMCD_EVENT_KEYS.js';
+export * from './CMCD_EVENT_MODE.js';
+export * from './CMCD_FORMATTER_MAP.js';
+export * from './CMCD_HEADERS.js';
+export * from './CMCD_JSON.js';
+export * from './CMCD_KEYS.js';
+export * from './CMCD_OBJECT.js';
+export * from './CMCD_PARAM.js';
+export * from './CMCD_QUERY.js';
+export * from './CMCD_REQUEST.js';
+export * from './CMCD_REQUEST_KEYS.js';
+export * from './CMCD_REQUEST_MODE.js';
+export * from './CMCD_RESPONSE_KEYS.js';
+export * from './CMCD_RESPONSE_MODE.js';
+export * from './CMCD_SESSION.js';
+export * from './CMCD_STATUS.js';
+export * from './CMCD_V1.js';
+export * from './CMCD_V1_KEYS.js';
+export * from './CMCD_V2.js';
+export * from './CmcdEncoding.js';
+export * from './CmcdEventType.js';
+export * from './CmcdFormatters.js';
+export * from './CmcdHeaderField.js';
+export * from './CmcdObjectType.js';
+export * from './CmcdPlayerState.js';
+export * from './CmcdReportingMode.js';
+export * from './CmcdStreamingFormat.js';
+export * from './CmcdStreamType.js';
+export * from './CmcdTransmissionMode.js';
+export * from './decodeCmcd.js';
+export * from './encodeCmcd.js';
+export * from './fromCmcdHeaders.js';
+export * from './fromCmcdQuery.js';
+export * from './fromCmcdUrl.js';
+export * from './groupCmcdHeaders.js';
+export * from './isCmcdCustomKey.js';
+export * from './isCmcdEventKey.js';
+export * from './isCmcdRequestKey.js';
+export * from './isCmcdResponseKey.js';
+export * from './isCmcdV1Key.js';
+export * from './prepareCmcdData.js';
+export * from './toCmcdHeaders.js';
+export * from './toCmcdJson.js';
+export * from './toCmcdQuery.js';
+export * from './toCmcdReport.js';
+export * from './toCmcdUrl.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AAErC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iCAAiC,CAAC;AAChD,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAI7B,cAAc,mBAAmB,CAAC;AAGlC,cAAc,oBAAoB,CAAC;AAInC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AAIrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AAIvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAE1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC","sourcesContent":["/**\n * A collection of tools for working with Common Media Client Data (CMCD).\n *\n * @packageDocumentation\n *\n * @beta\n */\nexport * from './appendCmcdHeaders.js';\nexport * from './appendCmcdQuery.js';\nexport type * from './Cmcd.js';\nexport * from './CMCD_COMMON_KEYS.js';\nexport * from './CMCD_DEFAULT_TIME_INTERVAL.js';\nexport * from './CMCD_EVENT_KEYS.js';\nexport * from './CMCD_EVENT_MODE.js';\nexport * from './CMCD_FORMATTER_MAP.js';\nexport * from './CMCD_HEADERS.js';\nexport * from './CMCD_JSON.js';\nexport * from './CMCD_KEYS.js';\nexport * from './CMCD_OBJECT.js';\nexport * from './CMCD_PARAM.js';\nexport * from './CMCD_QUERY.js';\nexport * from './CMCD_REQUEST.js';\nexport * from './CMCD_REQUEST_KEYS.js';\nexport * from './CMCD_REQUEST_MODE.js';\nexport * from './CMCD_RESPONSE_KEYS.js';\nexport * from './CMCD_RESPONSE_MODE.js';\nexport * from './CMCD_SESSION.js';\nexport * from './CMCD_STATUS.js';\nexport * from './CMCD_V1.js';\nexport * from './CMCD_V1_KEYS.js';\nexport * from './CMCD_V2.js';\nexport type * from './CmcdCustomKey.js';\nexport type * from './CmcdData.js';\nexport type * from './CmcdEncodeOptions.js';\nexport * from './CmcdEncoding.js';\nexport type * from './CmcdEvent.js';\nexport type * from './CmcdEventExcludedKeys.js';\nexport * from './CmcdEventType.js';\nexport type * from './CmcdFormatter.js';\nexport type * from './CmcdFormatterMap.js';\nexport type * from './CmcdFormatterOptions.js';\nexport * from './CmcdFormatters.js';\nexport * from './CmcdHeaderField.js';\nexport type * from './CmcdHeaderMap.js';\nexport type * from './CmcdHeadersMap.js';\nexport type * from './CmcdKey.js';\nexport * from './CmcdObjectType.js';\nexport * from './CmcdPlayerState.js';\nexport * from './CmcdReportingMode.js';\nexport type * from './CmcdReportTarget.js';\nexport type * from './CmcdRequest.js';\nexport type * from './CmcdResponse.js';\nexport * from './CmcdStreamingFormat.js';\nexport * from './CmcdStreamType.js';\nexport * from './CmcdTransmissionMode.js';\nexport type * from './CmcdValue.js';\nexport * from './decodeCmcd.js';\nexport * from './encodeCmcd.js';\nexport * from './fromCmcdHeaders.js';\nexport * from './fromCmcdQuery.js';\nexport * from './fromCmcdUrl.js';\nexport * from './groupCmcdHeaders.js';\nexport * from './isCmcdCustomKey.js';\nexport * from './isCmcdEventKey.js';\nexport * from './isCmcdRequestKey.js';\nexport * from './isCmcdResponseKey.js';\nexport * from './isCmcdV1Key.js';\nexport * from './prepareCmcdData.js';\nexport * from './toCmcdHeaders.js';\nexport * from './toCmcdJson.js';\nexport * from './toCmcdQuery.js';\nexport * from './toCmcdReport.js';\nexport * from './toCmcdUrl.js';\n"]}

package/dist/isCmcdCustomKey.d.ts

@@ -0,0 +1,13 @@
+import type { CmcdKey } from './CmcdKey.js';
+/**
+ * Check if a key is a custom key.
+ *
+ * @param key - The key to check.
+ *
+ * @returns `true` if the key is a custom key, `false` otherwise.
+ *
+ *
+ * @beta
+ */
+export declare function isCmcdCustomKey(key: CmcdKey): boolean;
+//# sourceMappingURL=isCmcdCustomKey.d.ts.map

package/dist/isCmcdCustomKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isCmcdCustomKey.d.ts","sourceRoot":"","sources":["../src/isCmcdCustomKey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAI5C;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAErD"}

package/dist/isCmcdCustomKey.js

@@ -0,0 +1,15 @@
+const CUSTOM_KEY_REGEX = /^[a-zA-Z0-9-.]+-[a-zA-Z0-9-.]+$/;
+/**
+ * Check if a key is a custom key.
+ *
+ * @param key - The key to check.
+ *
+ * @returns `true` if the key is a custom key, `false` otherwise.
+ *
+ *
+ * @beta
+ */
+export function isCmcdCustomKey(key) {
+    return CUSTOM_KEY_REGEX.test(key);
+}
+//# sourceMappingURL=isCmcdCustomKey.js.map

package/dist/isCmcdCustomKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isCmcdCustomKey.js","sourceRoot":"","sources":["../src/isCmcdCustomKey.ts"],"names":[],"mappings":"AAEA,MAAM,gBAAgB,GAAG,iCAAiC,CAAC;AAE3D;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAAC,GAAY;IAC3C,OAAO,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnC,CAAC","sourcesContent":["import type { CmcdKey } from './CmcdKey.js';\n\nconst CUSTOM_KEY_REGEX = /^[a-zA-Z0-9-.]+-[a-zA-Z0-9-.]+$/;\n\n/**\n * Check if a key is a custom key.\n *\n * @param key - The key to check.\n *\n * @returns `true` if the key is a custom key, `false` otherwise.\n *\n *\n * @beta\n */\nexport function isCmcdCustomKey(key: CmcdKey): boolean {\n\treturn CUSTOM_KEY_REGEX.test(key);\n}\n"]}

package/dist/isCmcdEventKey.d.ts

@@ -0,0 +1,16 @@
+import type { CmcdEvent } from './CmcdEvent.js';
+/**
+ * Check if a key is a valid CMCD event key.
+ *
+ * @param key - The key to check.
+ *
+ * @returns `true` if the key is a valid CMCD event key, `false` otherwise.
+ *
+ *
+ * @beta
+ *
+ * @example
+ * {@includeCode ../test/isCmcdEventKey.test.ts#example}
+ */
+export declare function isCmcdEventKey(key: string): key is keyof CmcdEvent;
+//# sourceMappingURL=isCmcdEventKey.d.ts.map

package/dist/isCmcdEventKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isCmcdEventKey.d.ts","sourceRoot":"","sources":["../src/isCmcdEventKey.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGhD;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,MAAM,SAAS,CAIlE"}

package/dist/isCmcdEventKey.js

@@ -0,0 +1,22 @@
+import { CMCD_COMMON_KEYS } from './CMCD_COMMON_KEYS.js';
+import { CMCD_EVENT_KEYS } from './CMCD_EVENT_KEYS.js';
+import { isCmcdCustomKey } from './isCmcdCustomKey.js';
+/**
+ * Check if a key is a valid CMCD event key.
+ *
+ * @param key - The key to check.
+ *
+ * @returns `true` if the key is a valid CMCD event key, `false` otherwise.
+ *
+ *
+ * @beta
+ *
+ * @example
+ * {@includeCode ../test/isCmcdEventKey.test.ts#example}
+ */
+export function isCmcdEventKey(key) {
+    return CMCD_COMMON_KEYS.includes(key) ||
+        CMCD_EVENT_KEYS.includes(key) ||
+        isCmcdCustomKey(key);
+}
+//# sourceMappingURL=isCmcdEventKey.js.map

package/dist/isCmcdEventKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isCmcdEventKey.js","sourceRoot":"","sources":["../src/isCmcdEventKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,cAAc,CAAC,GAAW;IACzC,OAAO,gBAAgB,CAAC,QAAQ,CAAC,GAAU,CAAC;QAC3C,eAAe,CAAC,QAAQ,CAAC,GAAU,CAAC;QACpC,eAAe,CAAC,GAAU,CAAC,CAAC;AAC9B,CAAC","sourcesContent":["import { CMCD_COMMON_KEYS } from './CMCD_COMMON_KEYS.js';\nimport { CMCD_EVENT_KEYS } from './CMCD_EVENT_KEYS.js';\nimport type { CmcdEvent } from './CmcdEvent.js';\nimport { isCmcdCustomKey } from './isCmcdCustomKey.js';\n\n/**\n * Check if a key is a valid CMCD event key.\n *\n * @param key - The key to check.\n *\n * @returns `true` if the key is a valid CMCD event key, `false` otherwise.\n *\n *\n * @beta\n *\n * @example\n * {@includeCode ../test/isCmcdEventKey.test.ts#example}\n */\nexport function isCmcdEventKey(key: string): key is keyof CmcdEvent {\n\treturn CMCD_COMMON_KEYS.includes(key as any) ||\n\t\tCMCD_EVENT_KEYS.includes(key as any) ||\n\t\tisCmcdCustomKey(key as any);\n}\n"]}

package/dist/isCmcdRequestKey.d.ts

@@ -0,0 +1,16 @@
+import type { CmcdRequest } from './CmcdRequest.js';
+/**
+ * Check if a key is a valid CMCD request key.
+ *
+ * @param key - The key to check.
+ *
+ * @returns `true` if the key is a valid CMCD request key, `false` otherwise.
+ *
+ *
+ * @beta
+ *
+ * @example
+ * {@includeCode ../test/isCmcdRequestKey.test.ts#example}
+ */
+export declare function isCmcdRequestKey(key: string): key is keyof CmcdRequest;
+//# sourceMappingURL=isCmcdRequestKey.d.ts.map

package/dist/isCmcdRequestKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isCmcdRequestKey.d.ts","sourceRoot":"","sources":["../src/isCmcdRequestKey.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAGpD;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,MAAM,WAAW,CAItE"}

package/dist/isCmcdRequestKey.js

@@ -0,0 +1,22 @@
+import { CMCD_COMMON_KEYS } from './CMCD_COMMON_KEYS.js';
+import { CMCD_REQUEST_KEYS } from './CMCD_REQUEST_KEYS.js';
+import { isCmcdCustomKey } from './isCmcdCustomKey.js';
+/**
+ * Check if a key is a valid CMCD request key.
+ *
+ * @param key - The key to check.
+ *
+ * @returns `true` if the key is a valid CMCD request key, `false` otherwise.
+ *
+ *
+ * @beta
+ *
+ * @example
+ * {@includeCode ../test/isCmcdRequestKey.test.ts#example}
+ */
+export function isCmcdRequestKey(key) {
+    return CMCD_COMMON_KEYS.includes(key) ||
+        CMCD_REQUEST_KEYS.includes(key) ||
+        isCmcdCustomKey(key);
+}
+//# sourceMappingURL=isCmcdRequestKey.js.map

package/dist/isCmcdRequestKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isCmcdRequestKey.js","sourceRoot":"","sources":["../src/isCmcdRequestKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW;IAC3C,OAAO,gBAAgB,CAAC,QAAQ,CAAC,GAAU,CAAC;QAC3C,iBAAiB,CAAC,QAAQ,CAAC,GAAU,CAAC;QACtC,eAAe,CAAC,GAAU,CAAC,CAAC;AAC9B,CAAC","sourcesContent":["import { CMCD_COMMON_KEYS } from './CMCD_COMMON_KEYS.js';\nimport { CMCD_REQUEST_KEYS } from './CMCD_REQUEST_KEYS.js';\nimport type { CmcdRequest } from './CmcdRequest.js';\nimport { isCmcdCustomKey } from './isCmcdCustomKey.js';\n\n/**\n * Check if a key is a valid CMCD request key.\n *\n * @param key - The key to check.\n *\n * @returns `true` if the key is a valid CMCD request key, `false` otherwise.\n *\n *\n * @beta\n *\n * @example\n * {@includeCode ../test/isCmcdRequestKey.test.ts#example}\n */\nexport function isCmcdRequestKey(key: string): key is keyof CmcdRequest {\n\treturn CMCD_COMMON_KEYS.includes(key as any) ||\n\t\tCMCD_REQUEST_KEYS.includes(key as any) ||\n\t\tisCmcdCustomKey(key as any);\n}\n"]}

package/dist/isCmcdResponseKey.d.ts

@@ -0,0 +1,16 @@
+import type { CmcdResponse } from './CmcdResponse.js';
+/**
+ * Check if a key is a valid CMCD response key.
+ *
+ * @param key - The key to check.
+ *
+ * @returns `true` if the key is a valid CMCD request key, `false` otherwise.
+ *
+ *
+ * @beta
+ *
+ * @example
+ * {@includeCode ../test/isCmcdResponseKey.test.ts#example}
+ */
+export declare function isCmcdResponseKey(key: string): key is keyof CmcdResponse;
+//# sourceMappingURL=isCmcdResponseKey.d.ts.map

package/dist/isCmcdResponseKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isCmcdResponseKey.d.ts","sourceRoot":"","sources":["../src/isCmcdResponseKey.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGtD;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,MAAM,YAAY,CAKxE"}

package/dist/isCmcdResponseKey.js

@@ -0,0 +1,24 @@
+import { CMCD_COMMON_KEYS } from './CMCD_COMMON_KEYS.js';
+import { CMCD_REQUEST_KEYS } from './CMCD_REQUEST_KEYS.js';
+import { CMCD_RESPONSE_KEYS } from './CMCD_RESPONSE_KEYS.js';
+import { isCmcdCustomKey } from './isCmcdCustomKey.js';
+/**
+ * Check if a key is a valid CMCD response key.
+ *
+ * @param key - The key to check.
+ *
+ * @returns `true` if the key is a valid CMCD request key, `false` otherwise.
+ *
+ *
+ * @beta
+ *
+ * @example
+ * {@includeCode ../test/isCmcdResponseKey.test.ts#example}
+ */
+export function isCmcdResponseKey(key) {
+    return CMCD_COMMON_KEYS.includes(key) ||
+        CMCD_REQUEST_KEYS.includes(key) ||
+        CMCD_RESPONSE_KEYS.includes(key) ||
+        isCmcdCustomKey(key);
+}
+//# sourceMappingURL=isCmcdResponseKey.js.map

package/dist/isCmcdResponseKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isCmcdResponseKey.js","sourceRoot":"","sources":["../src/isCmcdResponseKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAW;IAC5C,OAAO,gBAAgB,CAAC,QAAQ,CAAC,GAAU,CAAC;QAC3C,iBAAiB,CAAC,QAAQ,CAAC,GAAU,CAAC;QACtC,kBAAkB,CAAC,QAAQ,CAAC,GAAU,CAAC;QACvC,eAAe,CAAC,GAAU,CAAC,CAAC;AAC9B,CAAC","sourcesContent":["import { CMCD_COMMON_KEYS } from './CMCD_COMMON_KEYS.js';\nimport { CMCD_REQUEST_KEYS } from './CMCD_REQUEST_KEYS.js';\nimport { CMCD_RESPONSE_KEYS } from './CMCD_RESPONSE_KEYS.js';\nimport type { CmcdResponse } from './CmcdResponse.js';\nimport { isCmcdCustomKey } from './isCmcdCustomKey.js';\n\n/**\n * Check if a key is a valid CMCD response key.\n *\n * @param key - The key to check.\n *\n * @returns `true` if the key is a valid CMCD request key, `false` otherwise.\n *\n *\n * @beta\n *\n * @example\n * {@includeCode ../test/isCmcdResponseKey.test.ts#example}\n */\nexport function isCmcdResponseKey(key: string): key is keyof CmcdResponse {\n\treturn CMCD_COMMON_KEYS.includes(key as any) ||\n\t\tCMCD_REQUEST_KEYS.includes(key as any) ||\n\t\tCMCD_RESPONSE_KEYS.includes(key as any) ||\n\t\tisCmcdCustomKey(key as any);\n}\n"]}

package/dist/isCmcdV1Key.d.ts

@@ -0,0 +1,16 @@
+import type { Cmcd } from './Cmcd.js';
+/**
+ * Filter function for CMCD v1 keys.
+ *
+ * @param key - The CMCD key to filter.
+ *
+ * @returns `true` if the key should be included, `false` otherwise.
+ *
+ *
+ * @beta
+ *
+ * @example
+ * {@includeCode ../test/isCmcdV1Key.test.ts#example}
+ */
+export declare function isCmcdV1Key(key: string): key is keyof Cmcd;
+//# sourceMappingURL=isCmcdV1Key.d.ts.map

package/dist/isCmcdV1Key.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isCmcdV1Key.d.ts","sourceRoot":"","sources":["../src/isCmcdV1Key.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGtC;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,MAAM,IAAI,CAE1D"}

package/dist/isCmcdV1Key.js

@@ -0,0 +1,19 @@
+import { CMCD_V1_KEYS } from './CMCD_V1_KEYS.js';
+import { isCmcdCustomKey } from './isCmcdCustomKey.js';
+/**
+ * Filter function for CMCD v1 keys.
+ *
+ * @param key - The CMCD key to filter.
+ *
+ * @returns `true` if the key should be included, `false` otherwise.
+ *
+ *
+ * @beta
+ *
+ * @example
+ * {@includeCode ../test/isCmcdV1Key.test.ts#example}
+ */
+export function isCmcdV1Key(key) {
+    return CMCD_V1_KEYS.includes(key) || isCmcdCustomKey(key);
+}
+//# sourceMappingURL=isCmcdV1Key.js.map

package/dist/isCmcdV1Key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isCmcdV1Key.js","sourceRoot":"","sources":["../src/isCmcdV1Key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW;IACtC,OAAO,YAAY,CAAC,QAAQ,CAAC,GAAU,CAAC,IAAI,eAAe,CAAC,GAAU,CAAC,CAAC;AACzE,CAAC","sourcesContent":["import { CMCD_V1_KEYS } from './CMCD_V1_KEYS.js';\nimport type { Cmcd } from './Cmcd.js';\nimport { isCmcdCustomKey } from './isCmcdCustomKey.js';\n\n/**\n * Filter function for CMCD v1 keys.\n *\n * @param key - The CMCD key to filter.\n *\n * @returns `true` if the key should be included, `false` otherwise.\n *\n *\n * @beta\n *\n * @example\n * {@includeCode ../test/isCmcdV1Key.test.ts#example}\n */\nexport function isCmcdV1Key(key: string): key is keyof Cmcd {\n\treturn CMCD_V1_KEYS.includes(key as any) || isCmcdCustomKey(key as any);\n}\n"]}

package/dist/prepareCmcdData.d.ts

@@ -0,0 +1,13 @@
+import type { CmcdData } from './CmcdData.js';
+import type { CmcdEncodeOptions } from './CmcdEncodeOptions.js';
+/**
+ * Convert a generic object to CMCD data.
+ *
+ * @param obj - The CMCD object to process.
+ * @param options - Options for encoding.
+ *
+ *
+ * @beta
+ */
+export declare function prepareCmcdData(obj: Record<string, any>, options?: CmcdEncodeOptions): CmcdData;
+//# sourceMappingURL=prepareCmcdData.d.ts.map

package/dist/prepareCmcdData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prepareCmcdData.d.ts","sourceRoot":"","sources":["../src/prepareCmcdData.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAchE;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,GAAE,iBAAsB,GAAG,QAAQ,CA6EnG"}

package/dist/prepareCmcdData.js

@@ -0,0 +1,88 @@
+import { isTokenField } from '@svta/cml-cta/isTokenField.js';
+import { isValid } from '@svta/cml-cta/isValid.js';
+import { SfToken } from '@svta/cml-structured-field-values/SfToken.js';
+import { CMCD_EVENT_MODE } from './CMCD_EVENT_MODE.js';
+import { CMCD_FORMATTER_MAP } from './CMCD_FORMATTER_MAP.js';
+import { CMCD_REQUEST_MODE } from './CMCD_REQUEST_MODE.js';
+import { CMCD_RESPONSE_MODE } from './CMCD_RESPONSE_MODE.js';
+import { isCmcdEventKey } from './isCmcdEventKey.js';
+import { isCmcdRequestKey } from './isCmcdRequestKey.js';
+import { isCmcdResponseKey } from './isCmcdResponseKey.js';
+import { isCmcdV1Key } from './isCmcdV1Key.js';
+const filterMap = {
+    [CMCD_RESPONSE_MODE]: isCmcdResponseKey,
+    [CMCD_EVENT_MODE]: isCmcdEventKey,
+    [CMCD_REQUEST_MODE]: isCmcdRequestKey,
+};
+/**
+ * Convert a generic object to CMCD data.
+ *
+ * @param obj - The CMCD object to process.
+ * @param options - Options for encoding.
+ *
+ *
+ * @beta
+ */
+export function prepareCmcdData(obj, options = {}) {
+    const results = {};
+    if (obj == null || typeof obj !== 'object') {
+        return results;
+    }
+    const version = options.version || obj['v'] || 1;
+    const reportingMode = options.reportingMode || CMCD_REQUEST_MODE;
+    const keyFilter = version === 1 ? isCmcdV1Key : filterMap[reportingMode];
+    // Filter keys based on the version, reporting mode and options
+    let keys = Object.keys(obj).filter(keyFilter);
+    const filter = options.filter;
+    if (typeof filter === 'function') {
+        keys = keys.filter(filter);
+    }
+    // Ensure all required keys are present before sorting
+    const needsTimestamp = reportingMode === CMCD_RESPONSE_MODE || reportingMode === CMCD_EVENT_MODE;
+    if (needsTimestamp && !keys.includes('ts')) {
+        keys.push('ts');
+    }
+    if (version > 1 && !keys.includes('v')) {
+        keys.push('v');
+    }
+    const formatters = Object.assign({}, CMCD_FORMATTER_MAP, options.formatters);
+    const formatterOptions = {
+        version,
+        reportingMode,
+        baseUrl: options.baseUrl,
+    };
+    keys.sort().forEach(key => {
+        let value = obj[key];
+        const formatter = formatters[key];
+        if (typeof formatter === 'function') {
+            value = formatter(value, formatterOptions);
+        }
+        // Version should only be reported if not equal to 1.
+        if (key === 'v') {
+            if (version === 1) {
+                return;
+            }
+            else {
+                value = version;
+            }
+        }
+        // Playback rate should only be sent if not equal to 1.
+        if (key == 'pr' && value === 1) {
+            return;
+        }
+        // Ensure a timestamp is set for response and event modes
+        if (needsTimestamp && key === 'ts' && !Number.isFinite(value)) {
+            value = Date.now();
+        }
+        // ignore invalid values
+        if (!isValid(value)) {
+            return;
+        }
+        if (isTokenField(key) && typeof value === 'string') {
+            value = new SfToken(value);
+        }
+        results[key] = value;
+    });
+    return results;
+}
+//# sourceMappingURL=prepareCmcdData.js.map

package/dist/prepareCmcdData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prepareCmcdData.js","sourceRoot":"","sources":["../src/prepareCmcdData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,8CAA8C,CAAC;AACvE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAK7D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,SAAS,GAAG;IACjB,CAAC,kBAAkB,CAAC,EAAE,iBAAiB;IACvC,CAAC,eAAe,CAAC,EAAE,cAAc;IACjC,CAAC,iBAAiB,CAAC,EAAE,gBAAgB;CACrC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAC,GAAwB,EAAE,UAA6B,EAAE;IACxF,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,IAAI,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5C,OAAO,OAAO,CAAC;IAChB,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAK,GAAG,CAAC,GAAG,CAAY,IAAI,CAAC,CAAC;IAC7D,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,iBAAiB,CAAC;IACjE,MAAM,SAAS,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAEzE,+DAA+D;IAC/D,IAAI,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAE9C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC9B,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;QAClC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IAED,sDAAsD;IACtD,MAAM,cAAc,GAAG,aAAa,KAAK,kBAAkB,IAAI,aAAa,KAAK,eAAe,CAAC;IACjG,IAAI,cAAc,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,kBAAkB,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7E,MAAM,gBAAgB,GAAyB;QAC9C,OAAO;QACP,aAAa;QACb,OAAO,EAAE,OAAO,CAAC,OAAO;KACxB,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACzB,IAAI,KAAK,GAAG,GAAG,CAAC,GAAG,CAAc,CAAC;QAElC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;YACrC,KAAK,GAAG,SAAS,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;QAC5C,CAAC;QAED,qDAAqD;QACrD,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;YACjB,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;gBACnB,OAAO;YACR,CAAC;iBACI,CAAC;gBACL,KAAK,GAAG,OAAO,CAAC;YACjB,CAAC;QACF,CAAC;QAED,uDAAuD;QACvD,IAAI,GAAG,IAAI,IAAI,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO;QACR,CAAC;QAED,yDAAyD;QACzD,IAAI,cAAc,IAAI,GAAG,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/D,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACpB,CAAC;QAED,wBAAwB;QACxB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO;QACR,CAAC;QAED,IAAI,YAAY,CAAC,GAAG,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACpD,KAAK,GAAG,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QAEA,OAAe,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC;AAChB,CAAC","sourcesContent":["import { isTokenField } from '@svta/cml-cta/isTokenField.js';\nimport { isValid } from '@svta/cml-cta/isValid.js';\nimport { SfToken } from '@svta/cml-structured-field-values/SfToken.js';\nimport { CMCD_EVENT_MODE } from './CMCD_EVENT_MODE.js';\nimport { CMCD_FORMATTER_MAP } from './CMCD_FORMATTER_MAP.js';\nimport { CMCD_REQUEST_MODE } from './CMCD_REQUEST_MODE.js';\nimport { CMCD_RESPONSE_MODE } from './CMCD_RESPONSE_MODE.js';\nimport type { CmcdData } from './CmcdData.js';\nimport type { CmcdEncodeOptions } from './CmcdEncodeOptions.js';\nimport type { CmcdFormatterOptions } from './CmcdFormatterOptions.js';\nimport type { CmcdValue } from './CmcdValue.js';\nimport { isCmcdEventKey } from './isCmcdEventKey.js';\nimport { isCmcdRequestKey } from './isCmcdRequestKey.js';\nimport { isCmcdResponseKey } from './isCmcdResponseKey.js';\nimport { isCmcdV1Key } from './isCmcdV1Key.js';\n\nconst filterMap = {\n\t[CMCD_RESPONSE_MODE]: isCmcdResponseKey,\n\t[CMCD_EVENT_MODE]: isCmcdEventKey,\n\t[CMCD_REQUEST_MODE]: isCmcdRequestKey,\n};\n\n/**\n * Convert a generic object to CMCD data.\n *\n * @param obj - The CMCD object to process.\n * @param options - Options for encoding.\n *\n *\n * @beta\n */\nexport function prepareCmcdData(obj: Record<string, any>, options: CmcdEncodeOptions = {}): CmcdData {\n\tconst results: CmcdData = {};\n\n\tif (obj == null || typeof obj !== 'object') {\n\t\treturn results;\n\t}\n\n\tconst version = options.version || (obj['v'] as number) || 1;\n\tconst reportingMode = options.reportingMode || CMCD_REQUEST_MODE;\n\tconst keyFilter = version === 1 ? isCmcdV1Key : filterMap[reportingMode];\n\n\t// Filter keys based on the version, reporting mode and options\n\tlet keys = Object.keys(obj).filter(keyFilter);\n\n\tconst filter = options.filter;\n\tif (typeof filter === 'function') {\n\t\tkeys = keys.filter(filter);\n\t}\n\n\t// Ensure all required keys are present before sorting\n\tconst needsTimestamp = reportingMode === CMCD_RESPONSE_MODE || reportingMode === CMCD_EVENT_MODE;\n\tif (needsTimestamp && !keys.includes('ts')) {\n\t\tkeys.push('ts');\n\t}\n\n\tif (version > 1 && !keys.includes('v')) {\n\t\tkeys.push('v');\n\t}\n\n\tconst formatters = Object.assign({}, CMCD_FORMATTER_MAP, options.formatters);\n\tconst formatterOptions: CmcdFormatterOptions = {\n\t\tversion,\n\t\treportingMode,\n\t\tbaseUrl: options.baseUrl,\n\t};\n\n\tkeys.sort().forEach(key => {\n\t\tlet value = obj[key] as CmcdValue;\n\n\t\tconst formatter = formatters[key];\n\t\tif (typeof formatter === 'function') {\n\t\t\tvalue = formatter(value, formatterOptions);\n\t\t}\n\n\t\t// Version should only be reported if not equal to 1.\n\t\tif (key === 'v') {\n\t\t\tif (version === 1) {\n\t\t\t\treturn;\n\t\t\t}\n\t\t\telse {\n\t\t\t\tvalue = version;\n\t\t\t}\n\t\t}\n\n\t\t// Playback rate should only be sent if not equal to 1.\n\t\tif (key == 'pr' && value === 1) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Ensure a timestamp is set for response and event modes\n\t\tif (needsTimestamp && key === 'ts' && !Number.isFinite(value)) {\n\t\t\tvalue = Date.now();\n\t\t}\n\n\t\t// ignore invalid values\n\t\tif (!isValid(value)) {\n\t\t\treturn;\n\t\t}\n\n\t\tif (isTokenField(key) && typeof value === 'string') {\n\t\t\tvalue = new SfToken(value);\n\t\t}\n\n\t\t(results as any)[key] = value;\n\t});\n\n\treturn results;\n}\n"]}

package/dist/toCmcdHeaders.d.ts

@@ -0,0 +1,19 @@
+import type { CmcdData } from './CmcdData.js';
+import type { CmcdEncodeOptions } from './CmcdEncodeOptions.js';
+import type { CmcdHeaderField } from './CmcdHeaderField.js';
+/**
+ * Convert a CMCD data object to request headers
+ *
+ * @param cmcd - The CMCD data object to convert.
+ * @param options - Options for encoding the CMCD object.
+ *
+ * @returns The CMCD header shards.
+ *
+ *
+ * @beta
+ *
+ * @example
+ * {@includeCode ../test/toCmcdHeaders.test.ts#example}
+ */
+export declare function toCmcdHeaders(cmcd: CmcdData, options?: CmcdEncodeOptions): Record<CmcdHeaderField, string>;
+//# sourceMappingURL=toCmcdHeaders.d.ts.map

package/dist/toCmcdHeaders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toCmcdHeaders.d.ts","sourceRoot":"","sources":["../src/toCmcdHeaders.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAI5D;;;;;;;;;;;;;GAaG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,GAAE,iBAAsB,GAAG,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,CAkB9G"}

package/dist/toCmcdHeaders.js

@@ -0,0 +1,34 @@
+import { encodeSfDict } from '@svta/cml-structured-field-values/encodeSfDict.js';
+import { groupCmcdHeaders } from './groupCmcdHeaders.js';
+import { prepareCmcdData } from './prepareCmcdData.js';
+/**
+ * Convert a CMCD data object to request headers
+ *
+ * @param cmcd - The CMCD data object to convert.
+ * @param options - Options for encoding the CMCD object.
+ *
+ * @returns The CMCD header shards.
+ *
+ *
+ * @beta
+ *
+ * @example
+ * {@includeCode ../test/toCmcdHeaders.test.ts#example}
+ */
+export function toCmcdHeaders(cmcd, options = {}) {
+    const result = {};
+    if (!cmcd) {
+        return result;
+    }
+    const data = prepareCmcdData(cmcd, options);
+    const shards = groupCmcdHeaders(data, options === null || options === void 0 ? void 0 : options.customHeaderMap);
+    return Object.entries(shards)
+        .reduce((acc, [field, value]) => {
+        const shard = encodeSfDict(value, { whitespace: false });
+        if (shard) {
+            acc[field] = shard;
+        }
+        return acc;
+    }, result);
+}
+//# sourceMappingURL=toCmcdHeaders.js.map

package/dist/toCmcdHeaders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toCmcdHeaders.js","sourceRoot":"","sources":["../src/toCmcdHeaders.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mDAAmD,CAAC;AAIjF,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,aAAa,CAAC,IAAc,EAAE,UAA6B,EAAE;IAC5E,MAAM,MAAM,GAAG,EAAqC,CAAC;IAErD,IAAI,CAAC,IAAI,EAAE,CAAC;QACX,OAAO,MAAM,CAAC;IACf,CAAC;IAED,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,gBAAgB,CAAC,IAAI,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,CAAC,CAAC;IAEhE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;SAC3B,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE;QAC/B,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QACzD,IAAI,KAAK,EAAE,CAAC;YACX,GAAG,CAAC,KAAwB,CAAC,GAAG,KAAK,CAAC;QACvC,CAAC;QACD,OAAO,GAAG,CAAC;IACZ,CAAC,EAAE,MAAM,CAAC,CAAC;AACb,CAAC","sourcesContent":["import { encodeSfDict } from '@svta/cml-structured-field-values/encodeSfDict.js';\nimport type { CmcdData } from './CmcdData.js';\nimport type { CmcdEncodeOptions } from './CmcdEncodeOptions.js';\nimport type { CmcdHeaderField } from './CmcdHeaderField.js';\nimport { groupCmcdHeaders } from './groupCmcdHeaders.js';\nimport { prepareCmcdData } from './prepareCmcdData.js';\n\n/**\n * Convert a CMCD data object to request headers\n *\n * @param cmcd - The CMCD data object to convert.\n * @param options - Options for encoding the CMCD object.\n *\n * @returns The CMCD header shards.\n *\n *\n * @beta\n *\n * @example\n * {@includeCode ../test/toCmcdHeaders.test.ts#example}\n */\nexport function toCmcdHeaders(cmcd: CmcdData, options: CmcdEncodeOptions = {}): Record<CmcdHeaderField, string> {\n\tconst result = {} as Record<CmcdHeaderField, string>;\n\n\tif (!cmcd) {\n\t\treturn result;\n\t}\n\n\tconst data = prepareCmcdData(cmcd, options);\n\tconst shards = groupCmcdHeaders(data, options?.customHeaderMap);\n\n\treturn Object.entries(shards)\n\t\t.reduce((acc, [field, value]) => {\n\t\t\tconst shard = encodeSfDict(value, { whitespace: false });\n\t\t\tif (shard) {\n\t\t\t\tacc[field as CmcdHeaderField] = shard;\n\t\t\t}\n\t\t\treturn acc;\n\t\t}, result);\n}\n"]}

package/dist/toCmcdJson.d.ts

@@ -0,0 +1,17 @@
+import type { Cmcd } from './Cmcd.js';
+import type { CmcdEncodeOptions } from './CmcdEncodeOptions.js';
+/**
+ * Convert a CMCD data object to JSON.
+ *
+ * @param cmcd - The CMCD object to convert.
+ * @param options - Options for encoding the CMCD object.
+ *
+ * @returns The CMCD JSON.
+ *
+ *
+ * @beta
+ *
+ * @deprecated Sending CMCD as JSON objects is deprecated. Use `toCmcdUrl` to create an array of url strings instead.
+ */
+export declare function toCmcdJson(cmcd: Cmcd, options?: CmcdEncodeOptions): string;
+//# sourceMappingURL=toCmcdJson.d.ts.map

package/dist/toCmcdJson.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toCmcdJson.d.ts","sourceRoot":"","sources":["../src/toCmcdJson.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAGhE;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,MAAM,CAI1E"}

package/dist/toCmcdJson.js

@@ -0,0 +1,21 @@
+import { SfToken } from '@svta/cml-structured-field-values/SfToken.js';
+import { symbolToStr } from '@svta/cml-structured-field-values/utils/symbolToStr.js';
+import { prepareCmcdData } from './prepareCmcdData.js';
+/**
+ * Convert a CMCD data object to JSON.
+ *
+ * @param cmcd - The CMCD object to convert.
+ * @param options - Options for encoding the CMCD object.
+ *
+ * @returns The CMCD JSON.
+ *
+ *
+ * @beta
+ *
+ * @deprecated Sending CMCD as JSON objects is deprecated. Use `toCmcdUrl` to create an array of url strings instead.
+ */
+export function toCmcdJson(cmcd, options) {
+    const data = prepareCmcdData(cmcd, options);
+    return JSON.stringify(data, (_, value) => typeof value === 'symbol' || value instanceof SfToken ? symbolToStr(value) : value);
+}
+//# sourceMappingURL=toCmcdJson.js.map

package/dist/toCmcdJson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toCmcdJson.js","sourceRoot":"","sources":["../src/toCmcdJson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,8CAA8C,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,wDAAwD,CAAC;AAGrF,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,UAAU,CAAC,IAAU,EAAE,OAA2B;IACjE,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAE5C,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAC/H,CAAC","sourcesContent":["import { SfToken } from '@svta/cml-structured-field-values/SfToken.js';\nimport { symbolToStr } from '@svta/cml-structured-field-values/utils/symbolToStr.js';\nimport type { Cmcd } from './Cmcd.js';\nimport type { CmcdEncodeOptions } from './CmcdEncodeOptions.js';\nimport { prepareCmcdData } from './prepareCmcdData.js';\n\n/**\n * Convert a CMCD data object to JSON.\n *\n * @param cmcd - The CMCD object to convert.\n * @param options - Options for encoding the CMCD object.\n *\n * @returns The CMCD JSON.\n *\n *\n * @beta\n *\n * @deprecated Sending CMCD as JSON objects is deprecated. Use `toCmcdUrl` to create an array of url strings instead.\n */\nexport function toCmcdJson(cmcd: Cmcd, options?: CmcdEncodeOptions): string {\n\tconst data = prepareCmcdData(cmcd, options);\n\n\treturn JSON.stringify(data, (_, value) => typeof value === 'symbol' || value instanceof SfToken ? symbolToStr(value) : value);\n}\n"]}