fix: refactor enums to const (#108)

Signed-off-by: Casey Occhialini <[email protected]>
streaming-video-technology-alliance · Oct 29, 2024 · 98649c7 · 98649c7
1 parent 552338e
commit 98649c7
Show file tree

Hide file tree

Showing 29 changed files with 347 additions and 284 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+- Replace Typescript enums with constants [#103](https://github.com/streaming-video-technology-alliance/common-media-library/issues/103)
+
 
 ## [0.7.3] - 2024-08-30
 

diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -3,6 +3,7 @@ import js from '@eslint/js';
 import typescriptEslint from '@typescript-eslint/eslint-plugin';
 import tsParser from '@typescript-eslint/parser';
 import tsdoc from 'eslint-plugin-tsdoc';
+import typescriptEnum from 'eslint-plugin-typescript-enum';
 import globals from 'globals';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
@@ -20,10 +21,12 @@ export default [{
 }, ...compat.extends(
 	'eslint:recommended',
 	'plugin:@typescript-eslint/recommended',
+	'plugin:typescript-enum/recommended',
 ), {
 	plugins: {
 		'@typescript-eslint': typescriptEslint,
 		tsdoc,
+		'typescript-enum': typescriptEnum,
 	},
 
 	files: ['**/*.js', '**/*.ts'],

diff --git a/lib/config/common-media-library.api.md b/lib/config/common-media-library.api.md
@@ -100,9 +100,30 @@ 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";
+
+// @beta
+export const CMCD_SESSION = "CMCD-Session";
+
+// @beta
+export const CMCD_STATUS = "CMCD-Status";
+
 // @beta
 export const CMCD_V1 = 1;
 
@@ -118,11 +139,16 @@ export type CmcdEncodeOptions = {
 };
 
 // @beta
-export enum CmcdEncoding {
-    HEADERS = "headers",
-    JSON = "json",
-    QUERY = "query"
-}
+export const CmcdEncoding: {
+    readonly JSON: typeof CMCD_JSON;
+    readonly QUERY: typeof CMCD_QUERY;
+    readonly HEADERS: typeof CMCD_HEADERS;
+};
+
+// Warning: (ae-forgotten-export) The symbol "ValueOf" needs to be exported by the entry point index.d.ts
+//
+// @beta (undocumented)
+export type CmcdEncoding = ValueOf<typeof CmcdEncoding>;
 
 // @beta
 export type CmcdFormatter = (value: CmcdValue, options?: CmcdEncodeOptions) => string | number;
@@ -131,45 +157,45 @@ export type CmcdFormatter = (value: CmcdValue, options?: CmcdEncodeOptions) => s
 export const CmcdFormatters: Record<string, CmcdFormatter>;
 
 // @beta
-export enum CmcdHeaderField {
-    OBJECT = "CMCD-Object",
-    REQUEST = "CMCD-Request",
-    SESSION = "CMCD-Session",
-    STATUS = "CMCD-Status"
-}
+export const CmcdHeaderField: {
+    readonly OBJECT: typeof CMCD_OBJECT;
+    readonly REQUEST: typeof CMCD_REQUEST;
+    readonly SESSION: typeof CMCD_SESSION;
+    readonly STATUS: typeof CMCD_STATUS;
+};
+
+// @beta (undocumented)
+export type CmcdHeaderField = ValueOf<typeof CmcdHeaderField>;
 
 // @beta
 export type CmcdHeadersMap = Record<CmcdHeaderField, CmcdKey[]>;
 
 // @beta
 export type CmcdKey = keyof Cmcd;
 
+// Warning: (ae-forgotten-export) The symbol "CmObjectType" needs to be exported by the entry point index.d.ts
+//
 // @beta
-export enum CmcdObjectType {
-    AUDIO = "a",
-    CAPTION = "c",
-    INIT = "i",
-    KEY = "k",
-    MANIFEST = "m",
-    MUXED = "av",
-    OTHER = "o",
-    TIMED_TEXT = "tt",
-    VIDEO = "v"
-}
+export const CmcdObjectType: typeof CmObjectType;
 
+// @beta (undocumented)
+export type CmcdObjectType = CmObjectType;
+
+// Warning: (ae-forgotten-export) The symbol "CmStreamingFormat" needs to be exported by the entry point index.d.ts
+//
 // @beta
-export enum CmcdStreamingFormat {
-    DASH = "d",
-    HLS = "h",
-    OTHER = "o",
-    SMOOTH = "s"
-}
+export const CmcdStreamingFormat: typeof CmStreamingFormat;
+
+// @beta (undocumented)
+export type CmcdStreamingFormat = CmStreamingFormat;
 
+// Warning: (ae-forgotten-export) The symbol "CmStreamType" needs to be exported by the entry point index.d.ts
+//
 // @beta
-export enum CmcdStreamType {
-    LIVE = "l",
-    VOD = "v"
-}
+export const CmcdStreamType: typeof CmStreamType;
+
+// @beta (undocumented)
+export type CmcdStreamType = CmStreamType;
 
 // @beta
 export type CmcdValue = CmcdObjectType | CmcdStreamingFormat | CmcdStreamType | string | number | boolean | symbol | SfToken;
@@ -180,10 +206,10 @@ export type CmcdValue = CmcdObjectType | CmcdStreamingFormat | CmcdStreamType |
 export type CmCustomKey = `${string}-${string}`;
 
 // @beta
-export const CMSD_DYNAMIC: string;
+export const CMSD_DYNAMIC = "CMSD-Dynamic";
 
 // @beta
-export const CMSD_STATIC: string;
+export const CMSD_STATIC = "CMSD-Static";
 
 // @beta
 export const CMSD_V1 = 1;
@@ -213,23 +239,19 @@ export type CmsdEncodeOptions = {
 };
 
 // @beta
-export enum CmsdHeaderField {
-    DYNAMIC = "CMSD-Dynamic",
-    STATIC = "CMSD-Static"
-}
+export const CmsdHeaderField: {
+    readonly STATIC: typeof CMSD_STATIC;
+    readonly DYNAMIC: typeof CMSD_DYNAMIC;
+};
+
+// @beta (undocumented)
+export type CmsdHeaderField = ValueOf<typeof CmsdHeaderField>;
 
 // @beta
-export enum CmsdObjectType {
-    AUDIO = "a",
-    CAPTION = "c",
-    INIT = "i",
-    KEY = "k",
-    MANIFEST = "m",
-    MUXED = "av",
-    OTHER = "o",
-    TIMED_TEXT = "tt",
-    VIDEO = "v"
-}
+export const CmsdObjectType: typeof CmObjectType;
+
+// @beta (undocumented)
+export type CmsdObjectType = CmObjectType;
 
 // @beta
 export type CmsdStatic = {
@@ -249,25 +271,20 @@ export type CmsdStatic = {
 };
 
 // @beta
-export enum CmsdStreamingFormat {
-    DASH = "d",
-    HLS = "h",
-    OTHER = "o",
-    SMOOTH = "s"
-}
+export const CmsdStreamingFormat: typeof CmStreamingFormat;
+
+// @beta (undocumented)
+export type CmsdStreamingFormat = CmStreamingFormat;
 
 // @beta
-export enum CmsdStreamType {
-    LIVE = "l",
-    VOD = "v"
-}
+export const CmsdStreamType: typeof CmStreamType;
+
+// @beta (undocumented)
+export type CmsdStreamType = CmStreamType;
 
 // @beta
 export type CmsdValue = CmsdObjectType | CmsdStreamingFormat | CmsdStreamType | string | number | boolean | symbol | SfToken;
 
-// Warning: (ae-forgotten-export) The symbol "CmObjectType" needs to be exported by the entry point index.d.ts
-// Warning: (ae-forgotten-export) The symbol "CmStreamingFormat" needs to be exported by the entry point index.d.ts
-// Warning: (ae-forgotten-export) The symbol "CmStreamType" needs to be exported by the entry point index.d.ts
 // Warning: (ae-internal-missing-underscore) The name "CmValue" should be prefixed with an underscore because the declaration is marked as @internal
 //
 // @internal
@@ -766,20 +783,17 @@ export type Validation = {
 };
 
 // @beta
-export const enum VerboseLevel {
-    // (undocumented)
-    DATA = 3,
-    // (undocumented)
-    DEBUG = 3,
-    // (undocumented)
-    ERROR = 0,
-    // (undocumented)
-    INFO = 2,
-    // (undocumented)
-    TEXT = 1,
-    // (undocumented)
-    WARNING = 2
-}
+export const VerboseLevel: {
+    readonly ERROR: 0;
+    readonly TEXT: 1;
+    readonly WARNING: 2;
+    readonly INFO: 2;
+    readonly DEBUG: 3;
+    readonly DATA: 3;
+};
+
+// @beta (undocumented)
+export type VerboseLevel = ValueOf<typeof VerboseLevel>;
 
 // @alpha
 export type VideoTrack = Track & {

diff --git a/lib/src/cmcd.ts b/lib/src/cmcd.ts
@@ -5,9 +5,18 @@
  *
  * @beta
  */
+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 { Cmcd } from './cmcd/Cmcd.js';
 export type { CmcdCustomKey } from './cmcd/CmcdCustomKey.js';
 export type { CmcdEncodeOptions } from './cmcd/CmcdEncodeOptions.js';
 export { CmcdEncoding } from './cmcd/CmcdEncoding.js';
@@ -17,11 +26,9 @@ export { CmcdHeaderField } from './cmcd/CmcdHeaderField.js';
 export type { CmcdHeadersMap } from './cmcd/CmcdHeadersMap.js';
 export type { CmcdKey } from './cmcd/CmcdKey.js';
 export { CmcdObjectType } from './cmcd/CmcdObjectType.js';
-export { CmcdStreamType } from './cmcd/CmcdStreamType.js';
 export { CmcdStreamingFormat } from './cmcd/CmcdStreamingFormat.js';
+export { CmcdStreamType } from './cmcd/CmcdStreamType.js';
 export type { CmcdValue } from './cmcd/CmcdValue.js';
-export { appendCmcdHeaders } from './cmcd/appendCmcdHeaders.js';
-export { appendCmcdQuery } from './cmcd/appendCmcdQuery.js';
 export { decodeCmcd } from './cmcd/decodeCmcd.js';
 export { encodeCmcd } from './cmcd/encodeCmcd.js';
 export { fromCmcdHeaders } from './cmcd/fromCmcdHeaders.js';

diff --git a/lib/src/cmcd/CMCD_HEADERS.ts b/lib/src/cmcd/CMCD_HEADERS.ts
@@ -0,0 +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
@@ -0,0 +1,8 @@
+/**
+ * CMCD `json` transmission mode.
+ *
+ * @group CMCD
+ *
+ * @beta
+ */
+export const CMCD_JSON = 'json';
diff --git a/lib/src/cmcd/CMCD_OBJECT.ts b/lib/src/cmcd/CMCD_OBJECT.ts
@@ -0,0 +1,8 @@
+/**
+ * CMCD object header name.
+ *
+ * @group CMCD
+ *
+ * @beta
+ */
+export const CMCD_OBJECT = 'CMCD-Object';
diff --git a/lib/src/cmcd/CMCD_QUERY.ts b/lib/src/cmcd/CMCD_QUERY.ts
@@ -0,0 +1,8 @@
+/**
+ * CMCD `query` transmission mode.
+ *
+ * @group CMCD
+ *
+ * @beta
+ */
+export const CMCD_QUERY = 'query';
diff --git a/lib/src/cmcd/CMCD_REQUEST.ts b/lib/src/cmcd/CMCD_REQUEST.ts
@@ -0,0 +1,8 @@
+/**
+ * CMCD request header name.
+ *
+ * @group CMCD
+ *
+ * @beta
+ */
+export const CMCD_REQUEST = 'CMCD-Request';
diff --git a/lib/src/cmcd/CMCD_SESSION.ts b/lib/src/cmcd/CMCD_SESSION.ts
@@ -0,0 +1,8 @@
+/**
+ * CMCD session header name.
+ *
+ * @group CMCD
+ *
+ * @beta
+ */
+export const CMCD_SESSION = 'CMCD-Session';
diff --git a/lib/src/cmcd/CMCD_STATUS.ts b/lib/src/cmcd/CMCD_STATUS.ts
@@ -0,0 +1,8 @@
+/**
+ * CMCD status header name.
+ *
+ * @group CMCD
+ *
+ * @beta
+ */
+export const CMCD_STATUS = 'CMCD-Status';