From 3b89ff2d7e86dd3b9c2656cde5628ef087884b43 Mon Sep 17 00:00:00 2001 From: Casey Occhialini <1508707+littlespex@users.noreply.github.com> Date: Mon, 28 Oct 2024 12:09:05 -0700 Subject: [PATCH] no message Signed-off-by: Casey Occhialini <1508707+littlespex@users.noreply.github.com> --- lib/config/common-media-library.api.md | 18 ++++++++++++------ lib/src/cmcd.ts | 4 ++++ lib/src/cmcd/CMCD_HEADERS.ts | 7 +++++++ lib/src/cmcd/CMCD_JSON.ts | 7 +++++++ lib/src/cmcd/CMCD_QUERY.ts | 7 +++++++ 5 files changed, 37 insertions(+), 6 deletions(-) diff --git a/lib/config/common-media-library.api.md b/lib/config/common-media-library.api.md index 004d05ac..8a1c507e 100644 --- a/lib/config/common-media-library.api.md +++ b/lib/config/common-media-library.api.md @@ -100,12 +100,21 @@ export type Cmcd = { rtp?: number; }; +// @beta +export const CMCD_HEADERS = "headers"; + +// @beta +export const CMCD_JSON = "json"; + // @beta export const CMCD_OBJECT = "CMCD-Object"; // @beta export const CMCD_PARAM = "CMCD"; +// @beta +export const CMCD_QUERY = "query"; + // @beta export const CMCD_REQUEST = "CMCD-Request"; @@ -115,6 +124,9 @@ export const CMCD_SESSION = "CMCD-Session"; // @beta export const CMCD_STATUS = "CMCD-Status"; +// @beta +export const CMCD_V1 = 1; + // @beta export type CmcdCustomKey = `${string}-${string}`; @@ -793,10 +805,4 @@ export type VideoTrack = Track & { scanType: string; }; -// Warnings were encountered during analysis: -// -// src/cmcd/CmcdEncoding.ts:19:2 - (ae-forgotten-export) The symbol "CMCD_JSON" needs to be exported by the entry point index.d.ts -// src/cmcd/CmcdEncoding.ts:24:2 - (ae-forgotten-export) The symbol "CMCD_QUERY" needs to be exported by the entry point index.d.ts -// src/cmcd/CmcdEncoding.ts:29:2 - (ae-forgotten-export) The symbol "CMCD_HEADERS" needs to be exported by the entry point index.d.ts - ``` diff --git a/lib/src/cmcd.ts b/lib/src/cmcd.ts index d7fa23ce..2acb1cfa 100644 --- a/lib/src/cmcd.ts +++ b/lib/src/cmcd.ts @@ -8,11 +8,15 @@ export { appendCmcdHeaders } from './cmcd/appendCmcdHeaders.js'; export { appendCmcdQuery } from './cmcd/appendCmcdQuery.js'; export type { Cmcd } from './cmcd/Cmcd.js'; +export { CMCD_HEADERS } from './cmcd/CMCD_HEADERS.js'; +export { CMCD_JSON } from './cmcd/CMCD_JSON.js'; export { CMCD_OBJECT } from './cmcd/CMCD_OBJECT.js'; export { CMCD_PARAM } from './cmcd/CMCD_PARAM.js'; +export { CMCD_QUERY } from './cmcd/CMCD_QUERY.js'; export { CMCD_REQUEST } from './cmcd/CMCD_REQUEST.js'; export { CMCD_SESSION } from './cmcd/CMCD_SESSION.js'; export { CMCD_STATUS } from './cmcd/CMCD_STATUS.js'; +export { CMCD_V1 } from './cmcd/CMCD_V1.js'; export type { CmcdCustomKey } from './cmcd/CmcdCustomKey.js'; export type { CmcdEncodeOptions } from './cmcd/CmcdEncodeOptions.js'; export { CmcdEncoding } from './cmcd/CmcdEncoding.js'; diff --git a/lib/src/cmcd/CMCD_HEADERS.ts b/lib/src/cmcd/CMCD_HEADERS.ts index 6b018bc1..1a9ac28c 100644 --- a/lib/src/cmcd/CMCD_HEADERS.ts +++ b/lib/src/cmcd/CMCD_HEADERS.ts @@ -1 +1,8 @@ +/** + * CMCD `headers` transmission mode. + * + * @group CMCD + * + * @beta + */ export const CMCD_HEADERS = 'headers'; diff --git a/lib/src/cmcd/CMCD_JSON.ts b/lib/src/cmcd/CMCD_JSON.ts index f1b61d96..1342e7df 100644 --- a/lib/src/cmcd/CMCD_JSON.ts +++ b/lib/src/cmcd/CMCD_JSON.ts @@ -1 +1,8 @@ +/** + * CMCD `json` transmission mode. + * + * @group CMCD + * + * @beta + */ export const CMCD_JSON = 'json'; diff --git a/lib/src/cmcd/CMCD_QUERY.ts b/lib/src/cmcd/CMCD_QUERY.ts index ea65a050..e228ee39 100644 --- a/lib/src/cmcd/CMCD_QUERY.ts +++ b/lib/src/cmcd/CMCD_QUERY.ts @@ -1 +1,8 @@ +/** + * CMCD `query` transmission mode. + * + * @group CMCD + * + * @beta + */ export const CMCD_QUERY = 'query';