@svta/cml-cmcd 1.0.1 → 1.0.2

package/dist/index.d.ts

@@ -10,8 +10,7 @@ import { Request, ValueOf, ValueOrArray } from "@svta/cml-utils";
 * revisions to this specification. Clients SHOULD use a reverse-DNS
 * syntax when defining their own prefix.
 *
-*
-* @beta
+* @public
 */
 type CmcdCustomKey = `${string}-${string}`;
 //#endregion
@@ -19,14 +18,13 @@ type CmcdCustomKey = `${string}-${string}`;
 /**
 * Common Media Client Data Object Type
 *
-*
-* @beta
+* @public
 *
 * @enum
 */
 declare const CmcdObjectType: typeof CmObjectType;
 /**
-* @beta
+* @public
 */
 type CmcdObjectType = CmObjectType;
 //#endregion
@@ -37,11 +35,11 @@ type CmcdObjectType = CmObjectType;
 *
 * @enum
 *
-* @beta
+* @public
 */
 declare const CmcdStreamType: typeof CmStreamType;
 /**
-* @beta
+* @public
 */
 type CmcdStreamType = CmStreamType;
 //#endregion
@@ -52,11 +50,11 @@ type CmcdStreamType = CmStreamType;
 *
 * @enum
 *
-* @beta
+* @public
 */
 declare const CmcdStreamingFormat: typeof CmStreamingFormat;
 /**
-* @beta
+* @public
 */
 type CmcdStreamingFormat = CmStreamingFormat;
 //#endregion
@@ -64,8 +62,7 @@ type CmcdStreamingFormat = CmStreamingFormat;
 /**
 * CMCD Value
 *
-*
-* @beta
+* @public
 */
 type CmcdValue = CmcdObjectType | CmcdStreamingFormat | CmcdStreamType | string | string[] | number | number[] | boolean | symbol | SfToken | SfItem | SfItem[];
 //#endregion
@@ -75,8 +72,7 @@ type CmcdValue = CmcdObjectType | CmcdStreamingFormat | CmcdStreamType | string
 *
 * @see {@link https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf|CMCD Spec}
 *
-*
-* @beta
+* @public
 */
 type Cmcd = {
   /**
@@ -281,8 +277,7 @@ type Cmcd = {
 /**
 * CMCD event mode variable name.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_EVENT_MODE = "event";
 //#endregion
@@ -290,8 +285,7 @@ declare const CMCD_EVENT_MODE = "event";
 /**
 * CMCD request mode variable name.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_REQUEST_MODE = "request";
 //#endregion
@@ -302,7 +296,7 @@ declare const CMCD_REQUEST_MODE = "request";
 *
 * @enum
 *
-* @beta
+* @public
 */
 declare const CmcdReportingMode: {
   /**
@@ -315,7 +309,7 @@ declare const CmcdReportingMode: {
   readonly EVENT: typeof CMCD_EVENT_MODE;
 };
 /**
-* @beta
+* @public
 */
 type CmcdReportingMode = ValueOf<typeof CmcdReportingMode>;
 //#endregion
@@ -323,8 +317,7 @@ type CmcdReportingMode = ValueOf<typeof CmcdReportingMode>;
 /**
 * Options for formatting CMCD data values.
 *
-*
-* @beta
+* @public
 */
 type CmcdFormatterOptions = {
   /**
@@ -349,8 +342,7 @@ type CmcdFormatterOptions = {
 *
 * @returns The formatted value.
 *
-*
-* @beta
+* @public
 */
 type CmcdFormatter = (value: CmcdValue, options: CmcdFormatterOptions) => number | ValueOrArray<string> | ValueOrArray<SfItem>;
 //#endregion
@@ -358,8 +350,7 @@ type CmcdFormatter = (value: CmcdValue, options: CmcdFormatterOptions) => number
 /**
 * Keys that are excluded from CMCD event mode.
 *
-*
-* @beta
+* @public
 */
 type CmcdEventExcludedKeys = "bsd" | "d" | "dl" | "nor" | "ot" | "rtp" | "sid" | "su";
 //#endregion
@@ -370,7 +361,7 @@ type CmcdEventExcludedKeys = "bsd" | "d" | "dl" | "nor" | "ot" | "rtp" | "sid" |
 *
 * @enum
 *
-* @beta
+* @public
 */
 declare const CmcdEventType: {
   /**
@@ -415,7 +406,7 @@ declare const CmcdEventType: {
   readonly RESPONSE_RECEIVED: "rr";
 };
 /**
-* @beta
+* @public
 */
 type CmcdEventType = ValueOf<typeof CmcdEventType>;
 //#endregion
@@ -426,7 +417,7 @@ type CmcdEventType = ValueOf<typeof CmcdEventType>;
 *
 * @enum
 *
-* @beta
+* @public
 */
 declare const CmcdPlayerState: {
   /**
@@ -471,7 +462,7 @@ declare const CmcdPlayerState: {
   readonly PRELOADING: "d";
 };
 /**
-* @beta
+* @public
 */
 type CmcdPlayerState = ValueOf<typeof CmcdPlayerState>;
 //#endregion
@@ -479,8 +470,7 @@ type CmcdPlayerState = ValueOf<typeof CmcdPlayerState>;
 /**
 * Common Media Client Data (CMCD) is a standardized set of HTTP request header fields and query string parameters.
 *
-*
-* @beta
+* @public
 */
 type CmcdRequest = Omit<Cmcd, "nrr"> & {
   /**
@@ -706,8 +696,7 @@ type CmcdRequest = Omit<Cmcd, "nrr"> & {
 * Common Media Client Data (CMCD) version 2 specification. It encapsulates
 * the reporting event token.
 *
-*
-* @beta
+* @public
 */
 type CmcdEvent = Omit<CmcdRequest, CmcdEventExcludedKeys> & {
   /**
@@ -749,8 +738,7 @@ type CmcdEvent = Omit<CmcdRequest, CmcdEventExcludedKeys> & {
 *
 * Defines the keys for the CMCD (Common Media Client Data) v2 Response group.
 *
-*
-* @beta
+* @public
 */
 type CmcdResponse = CmcdRequest & {
   /**
@@ -831,8 +819,7 @@ type CmcdResponse = CmcdRequest & {
 /**
 * All CMCD data types combined.
 *
-*
-* @beta
+* @public
 */
 type CmcdData = Cmcd & CmcdRequest & CmcdEvent & CmcdResponse;
 //#endregion
@@ -840,8 +827,7 @@ type CmcdData = Cmcd & CmcdRequest & CmcdEvent & CmcdResponse;
 /**
 * A CMCD key.
 *
-*
-* @beta
+* @public
 */
 type CmcdKey = keyof CmcdData;
 //#endregion
@@ -849,8 +835,7 @@ type CmcdKey = keyof CmcdData;
 /**
 * A map of CMCD keys to format functions.
 *
-*
-* @beta
+* @public
 */
 type CmcdFormatterMap = Record<CmcdKey, CmcdFormatter>;
 //#endregion
@@ -858,8 +843,7 @@ type CmcdFormatterMap = Record<CmcdKey, CmcdFormatter>;
 /**
 * CMCD object header name.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_OBJECT = "CMCD-Object";
 //#endregion
@@ -867,8 +851,7 @@ declare const CMCD_OBJECT = "CMCD-Object";
 /**
 * CMCD request header name.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_REQUEST = "CMCD-Request";
 //#endregion
@@ -876,8 +859,7 @@ declare const CMCD_REQUEST = "CMCD-Request";
 /**
 * CMCD session header name.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_SESSION = "CMCD-Session";
 //#endregion
@@ -885,8 +867,7 @@ declare const CMCD_SESSION = "CMCD-Session";
 /**
 * CMCD status header name.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_STATUS = "CMCD-Status";
 //#endregion
@@ -897,7 +878,7 @@ declare const CMCD_STATUS = "CMCD-Status";
 *
 * @enum
 *
-* @beta
+* @public
 */
 declare const CmcdHeaderField: {
   /**
@@ -918,7 +899,7 @@ declare const CmcdHeaderField: {
   readonly STATUS: typeof CMCD_STATUS;
 };
 /**
-* @beta
+* @public
 */
 type CmcdHeaderField = ValueOf<typeof CmcdHeaderField>;
 //#endregion
@@ -926,8 +907,7 @@ type CmcdHeaderField = ValueOf<typeof CmcdHeaderField>;
 /**
 * A map of CMCD header fields to CMCD keys.
 *
-*
-* @beta
+* @public
 */
 type CmcdHeaderMap = Record<CmcdHeaderField, CmcdKey[]>;
 //#endregion
@@ -935,8 +915,7 @@ type CmcdHeaderMap = Record<CmcdHeaderField, CmcdKey[]>;
 /**
 * Options for encoding CMCD values.
 *
-*
-* @beta
+* @public
 */
 type CmcdEncodeOptions = {
   /**
@@ -987,8 +966,7 @@ type CmcdEncodeOptions = {
 *
 * @returns The headers with the CMCD header shards appended.
 *
-*
-* @beta
+* @public
 *
 * @example
 * {@includeCode ../test/appendCmcdHeaders.test.ts#example}
@@ -1005,8 +983,7 @@ declare function appendCmcdHeaders(headers: Record<string, string>, cmcd: Cmcd,
 *
 * @returns The URL with the CMCD query args appended.
 *
-*
-* @beta
+* @public
 *
 * @example
 * {@includeCode ../test/appendCmcdQuery.test.ts#example}
@@ -1017,8 +994,7 @@ declare function appendCmcdQuery(url: string, cmcd: Cmcd, options?: CmcdEncodeOp
 /**
 * Defines the common keys for CMCD (Common Media Client Data) version 2.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_COMMON_KEYS: readonly ["ab", "bg", "bl", "br", "bs", "bsd", "cdn", "cid", "cs", "df", "ec", "lab", "lb", "ltc", "msd", "mtp", "pb", "pr", "pt", "sf", "sid", "sn", "st", "sta", "tab", "tb", "tbl", "tpb", "ts", "v"];
 //#endregion
@@ -1026,8 +1002,7 @@ declare const CMCD_COMMON_KEYS: readonly ["ab", "bg", "bl", "br", "bs", "bsd", "
 /**
 * The default time interval in secondswhen using using event mode
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_DEFAULT_TIME_INTERVAL = 30;
 //#endregion
@@ -1035,8 +1010,7 @@ declare const CMCD_DEFAULT_TIME_INTERVAL = 30;
 /**
 * Defines the event-specific keys for CMCD (Common Media Client Data) version 2.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_EVENT_KEYS: readonly ["e"];
 //#endregion
@@ -1044,8 +1018,7 @@ declare const CMCD_EVENT_KEYS: readonly ["e"];
 /**
 * The default formatters for CMCD values.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_FORMATTER_MAP: Record<string, CmcdFormatter>;
 //#endregion
@@ -1053,8 +1026,7 @@ declare const CMCD_FORMATTER_MAP: Record<string, CmcdFormatter>;
 /**
 * CMCD `headers` transmission mode.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_HEADERS = "headers";
 //#endregion
@@ -1062,8 +1034,7 @@ declare const CMCD_HEADERS = "headers";
 /**
 * CMCD `json` transmission mode.
 *
-*
-* @beta
+* @public
 *
 * @deprecated JSON transmission mode is deprecated and will be removed in future versions.
 */
@@ -1073,8 +1044,7 @@ declare const CMCD_JSON = "json";
 /**
 * A list of all CMCD keys.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_KEYS: CmcdKey[];
 //#endregion
@@ -1082,8 +1052,7 @@ declare const CMCD_KEYS: CmcdKey[];
 /**
 * CMCD parameter name.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_PARAM = "CMCD";
 //#endregion
@@ -1091,8 +1060,7 @@ declare const CMCD_PARAM = "CMCD";
 /**
 * CMCD `query` transmission mode.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_QUERY = "query";
 //#endregion
@@ -1100,8 +1068,7 @@ declare const CMCD_QUERY = "query";
 /**
 * Defines the request-specific keys for CMCD (Common Media Client Data) version 2.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_REQUEST_KEYS: readonly ["d", "dl", "nor", "ot", "rtp", "su"];
 //#endregion
@@ -1109,8 +1076,7 @@ declare const CMCD_REQUEST_KEYS: readonly ["d", "dl", "nor", "ot", "rtp", "su"];
 /**
 * CMCD v2 - Response-only and timing keys.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_RESPONSE_KEYS: readonly ["cmsdd", "cmsds", "rc", "smrt", "ttfb", "ttfbb", "ttlb", "url"];
 //#endregion
@@ -1118,8 +1084,7 @@ declare const CMCD_RESPONSE_KEYS: readonly ["cmsdd", "cmsds", "rc", "smrt", "ttf
 /**
 * CMCD response mode variable name.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_RESPONSE_MODE = "response";
 //#endregion
@@ -1127,8 +1092,7 @@ declare const CMCD_RESPONSE_MODE = "response";
 /**
 * CMCD Version 1
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_V1 = 1;
 //#endregion
@@ -1136,8 +1100,7 @@ declare const CMCD_V1 = 1;
 /**
 * Defines the keys for CMCD (Common Media Client Data) version 1.
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_V1_KEYS: readonly ["bl", "br", "bs", "cid", "d", "dl", "mtp", "nor", "nrr", "ot", "pr", "rtp", "sf", "sid", "st", "su", "tb", "v"];
 //#endregion
@@ -1145,8 +1108,7 @@ declare const CMCD_V1_KEYS: readonly ["bl", "br", "bs", "cid", "d", "dl", "mtp",
 /**
 * CMCD Version 2
 *
-*
-* @beta
+* @public
 */
 declare const CMCD_V2 = 2;
 //#endregion
@@ -1157,7 +1119,7 @@ declare const CMCD_V2 = 2;
 *
 * @enum
 *
-* @beta
+* @public
 */
 declare const CmcdTransmissionMode: {
   /**
@@ -1176,7 +1138,7 @@ declare const CmcdTransmissionMode: {
   readonly HEADERS: typeof CMCD_HEADERS;
 };
 /**
-* @beta
+* @public
 */
 type CmcdTransmissionMode = ValueOf<typeof CmcdTransmissionMode>;
 //#endregion
@@ -1187,7 +1149,7 @@ type CmcdTransmissionMode = ValueOf<typeof CmcdTransmissionMode>;
 *
 * @enum
 *
-* @beta
+* @public
 *
 * @deprecated Use {@link CmcdTransmissionMode} instead.
 *
@@ -1195,7 +1157,7 @@ type CmcdTransmissionMode = ValueOf<typeof CmcdTransmissionMode>;
 */
 declare const CmcdEncoding: typeof CmcdTransmissionMode;
 /**
-* @beta
+* @public
 */
 type CmcdEncoding = ValueOf<typeof CmcdEncoding>;
 //#endregion
@@ -1203,8 +1165,7 @@ type CmcdEncoding = ValueOf<typeof CmcdEncoding>;
 /**
 * The default formatters for CMCD values.
 *
-*
-* @beta
+* @public
 *
 * @deprecated Use `CMCD_FORMATTER_MAP` instead.
 */
@@ -1214,8 +1175,7 @@ declare const CmcdFormatters: Record<string, CmcdFormatter>;
 /**
 * A map of CMCD header fields to CMCD keys.
 *
-*
-* @beta
+* @public
 *
 * @deprecated Use `CmcdHeaderMap` instead.
 */
@@ -1225,8 +1185,7 @@ type CmcdHeadersMap = Record<CmcdHeaderField, CmcdKey[]>;
 /**
 * A CMCD report target configuration.
 *
-*
-* @beta
+* @public
 */
 type CmcdReportTarget = {
   /**
@@ -1271,8 +1230,7 @@ type CmcdReportTarget = {
 *
 * @returns The decoded CMCD object.
 *
-*
-* @beta
+* @public
 *
 * @example
 * {@includeCode ../test/decodeCmcd.test.ts#example}
@@ -1288,8 +1246,7 @@ declare function decodeCmcd<T extends CmcdData = CmcdData>(cmcd: string): T;
 *
 * @returns The encoded CMCD string.
 *
-*
-* @beta
+* @public
 *
 * @example
 * {@includeCode ../test/encodeCmcd.test.ts#example}
@@ -1304,8 +1261,7 @@ declare function encodeCmcd(cmcd: CmcdData, options?: CmcdEncodeOptions): string
 *
 * @returns The decoded CMCD data.
 *
-*
-* @beta
+* @public
 *
 * @example
 * {@includeCode ../test/fromCmcdHeaders.test.ts#example}
@@ -1320,8 +1276,7 @@ declare function fromCmcdHeaders(headers: Record<string, string> | Headers): Cmc
 *
 * @returns The decoded CMCD data.
 *
-*
-* @beta
+* @public
 *
 * @example
 * {@includeCode ../test/fromCmcdQuery.test.ts#example}
@@ -1336,8 +1291,7 @@ declare function fromCmcdQuery(query: string | URLSearchParams): Cmcd;
 *
 * @returns The decoded CMCD data.
 *
-*
-* @beta
+* @public
 *
 * @example
 * {@includeCode ../test/fromCmcdUrl.test.ts#example}
@@ -1353,8 +1307,7 @@ declare function fromCmcdUrl(url: string): Cmcd;
 *
 * @returns The CMCD header shards.
 *
-*
-* @beta
+* @public
 */
 declare function groupCmcdHeaders(cmcd: CmcdData, customHeaderMap?: Partial<CmcdHeaderMap>): Record<CmcdHeaderField, CmcdData>;
 //#endregion
@@ -1366,8 +1319,7 @@ declare function groupCmcdHeaders(cmcd: CmcdData, customHeaderMap?: Partial<Cmcd
 *
 * @returns `true` if the key is a custom key, `false` otherwise.
 *
-*
-* @beta
+* @public
 */
 declare function isCmcdCustomKey(key: CmcdKey): boolean;
 //#endregion
@@ -1379,8 +1331,7 @@ declare function isCmcdCustomKey(key: CmcdKey): boolean;
 *
 * @returns `true` if the key is a valid CMCD event key, `false` otherwise.
 *
-*
-* @beta
+* @public
 *
 * @example
 * {@includeCode ../test/isCmcdEventKey.test.ts#example}
@@ -1395,8 +1346,7 @@ declare function isCmcdEventKey(key: string): key is keyof CmcdEvent;
 *
 * @returns `true` if the key is a valid CMCD request key, `false` otherwise.
 *
-*
-* @beta
+* @public
 *
 * @example
 * {@includeCode ../test/isCmcdRequestKey.test.ts#example}
@@ -1413,7 +1363,7 @@ declare function isCmcdRequestKey(key: string): key is keyof CmcdRequest;
 *
 * @group CMCD
 *
-* @beta
+* @public
 *
 * @example
 * {@includeCode ../../test/cmcd/isCmcdResponseReceivedKey.test.ts#example}
@@ -1428,8 +1378,7 @@ declare function isCmcdResponseReceivedKey(key: string): key is keyof CmcdRespon
 *
 * @returns `true` if the key should be included, `false` otherwise.
 *
-*
-* @beta
+* @public
 *
 * @example
 * {@includeCode ../test/isCmcdV1Key.test.ts#example}
@@ -1443,8 +1392,7 @@ declare function isCmcdV1Key(key: string): key is keyof Cmcd;
 * @param obj - The CMCD object to process.
 * @param options - Options for encoding.
 *
-*
-* @beta
+* @public
 */
 declare function prepareCmcdData(obj: Record<string, any>, options?: CmcdEncodeOptions): CmcdData;
 //#endregion
@@ -1457,8 +1405,7 @@ declare function prepareCmcdData(obj: Record<string, any>, options?: CmcdEncodeO
 *
 * @returns The CMCD header shards.
 *
-*
-* @beta
+* @public
 *
 * @example
 * {@includeCode ../test/toCmcdHeaders.test.ts#example}
@@ -1474,8 +1421,7 @@ declare function toCmcdHeaders(cmcd: CmcdData, options?: CmcdEncodeOptions): Rec
 *
 * @returns The CMCD JSON.
 *
-*
-* @beta
+* @public
 *
 * @deprecated Sending CMCD as JSON objects is deprecated. Use `toCmcdUrl` to create an array of url strings instead.
 */
@@ -1490,8 +1436,7 @@ declare function toCmcdJson(cmcd: Cmcd, options?: CmcdEncodeOptions): string;
 *
 * @returns The CMCD query arg.
 *
-*
-* @beta
+* @public
 *
 * @example
 * {@includeCode ../test/toCmcdQuery.test.ts#example}
@@ -1507,8 +1452,7 @@ declare function toCmcdQuery(cmcd: Cmcd, options?: CmcdEncodeOptions): string;
 *
 * @return A CMCD report object
 *
-*
-* @beta
+* @public
 *
 * @example
 * {@includeCode ../test/toCmcdReport.test.ts#example}
@@ -1526,8 +1470,7 @@ declare function toCmcdReport(data: CmcdData, target: CmcdReportTarget): Request
 *
 * @returns The URL encoded CMCD data.
 *
-*
-* @beta
+* @public
 */
 declare function toCmcdUrl(cmcd: Cmcd, options?: CmcdEncodeOptions): string;
 //#endregion