Merge branch 'main' of github.com:qualabs/common-media-library into f…

…eature/add-unit-tests

.github/workflows/ci.pr.yml

@@ -20,7 +20,7 @@ jobs:
           node-version: 20
           cache: 'npm'
           registry-url: "https://npm.pkg.github.com"
-          scope: "@cbsinteractive"
+          scope: "@svta"
 
       - name: Install
         run: npm ci

.github/workflows/publish-tag.yml

@@ -11,18 +11,20 @@ on:
         description: "An id to append to the version. Defaults to the current timestamp"
         type: string
         required: false
-      
+
 env:
   NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+  PKG_VERSION: ""
+  BUILD_ID: ""
 
 jobs:
   publish:
     runs-on: ubuntu-latest
-    
+
     permissions:
       contents: read
       id-token: write
-    
+
     steps:
       - uses: actions/checkout@v3
         with:
@@ -39,20 +41,20 @@ jobs:
 
       - name: Test
         run: npm test
-      
+
       - name: Get Version
-        run: echo "version=`node -p "require('./package').version"`" >> $GITHUB_ENV
+        run: echo "PKG_VERSION=`node -p "require('./package').version"`" >> $GITHUB_ENV
 
       - name: Get Time
         if: github.event.inputs.id == ''
-        run: echo "id=`date +%s`" >> $GITHUB_ENV
+        run: echo "BUILD_ID=`date +%s`" >> $GITHUB_ENV
 
       - name: Get ID
         if: github.event.inputs.id != ''
-        run: echo "id=${{ github.event.inputs.id }}" >> $GITHUB_ENV
+        run: echo "BUILD_ID=${{ github.event.inputs.id }}" >> $GITHUB_ENV
 
       - name: Generate Version
-        run: npm version ${{ env.version }}-${{ github.event.inputs.tag }}.${{ env.id }} --no-git-tag-version
+        run: npm version ${{ env.PKG_VERSION }}-${{ github.event.inputs.tag }}.${{ env.BUILD_ID }} --no-git-tag-version
 
       - name: Publish Tag
         run: npm run pub --tag ${{ github.event.inputs.tag }}

.github/workflows/publish.yml

@@ -5,15 +5,16 @@ on:
 
 env:
   NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+  PKG_VERSION: ""
 
 jobs:
   publish:
     runs-on: ubuntu-latest
-    
+
     permissions:
       contents: read
       id-token: write
-    
+
     steps:
       - uses: actions/checkout@v3
         with:
@@ -35,7 +36,7 @@ jobs:
         run: npm run pub
 
       - name: Get Version
-        run: echo "version=`node -p "require('./package').version"`" >> $GITHUB_ENV
+        run: echo "PKG_VERSION=`node -p "require('./package').version"`" >> $GITHUB_ENV
 
       - name: Create Release Notes
         run: npm run notes
@@ -45,8 +46,8 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GH_ACTIONS }}
         with:
-          tag_name: v${{ env.version }}
-          release_name: ${{ env.version }}
+          tag_name: v${{ env.PKG_VERSION }}
+          release_name: ${{ env.PKG_VERSION }}
           commitish: main
           body_path: ./RELEASE.md
           draft: true

dev/package.json

@@ -14,9 +14,9 @@
 		"url": "https://github.com/streaming-video-technology-alliance/common-media-library/issues"
 	},
 	"scripts": {
-		"start": "web-dev-server --node-resolve --open --watch"
+		"start": "wds --node-resolve --open --watch"
 	},
 	"devDependencies": {
-		"typedoc": "0.25.2"
+		"@web/dev-server": "0.4.2"
 	}
 }

docs/package.json

@@ -16,8 +16,5 @@
 	"scripts": {
 		"build": "typedoc",
 		"start": "npm run build && npx -y http-server dist --cors -p 8080"
-	},
-	"devDependencies": {
-		"typedoc": "0.25.2"
 	}
 }

docs/typedoc.json

@@ -5,6 +5,7 @@
 	"entryPoints": [
 		"../lib/src/index.ts"
 	],
+	"excludeInternal": true,
 	"excludePrivate": true,
 	"hideGenerator": true,
 	"navigation": {

lib/src/cmcd/CmcdCustomKey.ts

@@ -1,5 +1,3 @@
-import { CmCustomKey } from '../cta/CmCustomKey.js';
-
 /**
  * A custom key for CMCD. Custom keys MUST carry a hyphenated prefix
  * to ensure that there will not be a namespace collision with future
@@ -10,4 +8,4 @@ import { CmCustomKey } from '../cta/CmCustomKey.js';
  *
  * @beta
  */
-export type CmcdCustomKey = CmCustomKey;
+export type CmcdCustomKey = `${string}-${string}`;

lib/src/cmcd/CmcdObjectType.ts

@@ -1,8 +1,53 @@
 /**
- * Common Media Object Type
+ * Common Media Client Data Object Type
  *
  * @group CMCD
  *
  * @beta
  */
-export { CmObjectType as CmcdObjectType } from '../cta/CmObjectType.js';
+export enum CmcdObjectType {
+	/**
+	 * text file, such as a manifest or playlist
+	 */
+	MANIFEST = 'm',
+
+	/**
+	 * audio only
+	 */
+	AUDIO = 'a',
+
+	/**
+	 * video only
+	 */
+	VIDEO = 'v',
+
+	/**
+	 * muxed audio and video
+	 */
+	MUXED = 'av',
+
+	/**
+	 * init segment
+	 */
+	INIT = 'i',
+
+	/**
+	 * caption or subtitle
+	 */
+	CAPTION = 'c',
+
+	/**
+	 * ISOBMFF timed text track
+	 */
+	TIMED_TEXT = 'tt',
+
+	/**
+	 * cryptographic key, license or certificate.
+	 */
+	KEY = 'k',
+
+	/**
+	 * other
+	 */
+	OTHER = 'o',
+}

lib/src/cmcd/CmcdStreamType.ts

@@ -1,8 +1,18 @@
 /**
- * Common Media Streaming Type
+ * Common Media Client Data Stream Type
  *
  * @group CMCD
  *
  * @beta
  */
-export { CmStreamType as CmcdStreamType } from '../cta/CmStreamType.js';
+export enum CmcdStreamType {
+	/**
+	 *  All segments are available – e.g., VOD
+	 */
+	VOD = 'v',
+
+	/**
+	 * Segments become available over time – e.g., LIVE
+	 */
+	LIVE = 'l',
+}

lib/src/cmcd/CmcdStreamingFormat.ts

@@ -1,8 +1,29 @@
 /**
- * Common Media Streaming Format
+ * Common Media Client Data Streaming Format
  *
  * @group CMCD
  *
  * @beta
  */
-export { CmStreamingFormat as CmcdStreamingFormat } from '../cta/CmStreamingFormat.js';
+export enum CmcdStreamingFormat {
+	/**
+	 * MPEG DASH
+	 */
+	DASH = 'd',
+
+	/**
+	 * HTTP Live Streaming (HLS)
+	 */
+	HLS = 'h',
+
+	/**
+	 * Smooth Streaming
+	 */
+	SMOOTH = 's',
+
+	/**
+	 * Other
+	 */
+	OTHER = 'o',
+}
+

lib/src/cmcd/CmcdValue.ts

@@ -1,4 +1,7 @@
-import { CmValue } from '../cta/CmValue.js';
+import type { SfToken } from '../structuredfield/SfToken';
+import type { CmcdObjectType } from './CmcdObjectType';
+import type { CmcdStreamType } from './CmcdStreamType';
+import type { CmcdStreamingFormat } from './CmcdStreamingFormat';
 
 /**
  * CMCD Value
@@ -7,4 +10,4 @@ import { CmValue } from '../cta/CmValue.js';
  *
  * @beta
  */
-export type CmcdValue = CmValue;
+export type CmcdValue = CmcdObjectType | CmcdStreamingFormat | CmcdStreamType | string | number | boolean | symbol | SfToken;

lib/src/cmcd/appendCmcdHeaders.ts

@@ -7,7 +7,7 @@ import { toCmcdHeaders } from './toCmcdHeaders.js';
  *
  * @param headers - The headers to append to.
  * @param cmcd - The CMCD object to append.
- * @param customHeaderMap - A map of custom CMCD keys to header fields.
+ * @param options - Encode options.
  *
  * @returns The headers with the CMCD header shards appended.
  *

lib/src/cmsd/CmsdCustomKey.ts

@@ -1,5 +1,3 @@
-import { CmCustomKey } from '../cta/CmCustomKey.js';
-
 /**
  * A custom key for CMSD. Custom keys MUST carry a hyphenated prefix
  * to ensure that there will not be a namespace collision with future
@@ -10,4 +8,4 @@ import { CmCustomKey } from '../cta/CmCustomKey.js';
  *
  * @beta
  */
-export type CmsdCustomKey = CmCustomKey;
+export type CmsdCustomKey = `${string}-${string}`;

lib/src/cmsd/CmsdObjectType.ts

@@ -1,10 +1,53 @@
-import { CmObjectType } from '../cta/CmObjectType.js';
-
 /**
- * Common Media Object Type
+ * Common Media Server Data Object Type
  *
  * @group CMSD
  *
  * @beta
  */
-export { CmObjectType as CmsdObjectType };
+export enum CmsdObjectType {
+	/**
+	 * text file, such as a manifest or playlist
+	 */
+	MANIFEST = 'm',
+
+	/**
+	 * audio only
+	 */
+	AUDIO = 'a',
+
+	/**
+	 * video only
+	 */
+	VIDEO = 'v',
+
+	/**
+	 * muxed audio and video
+	 */
+	MUXED = 'av',
+
+	/**
+	 * init segment
+	 */
+	INIT = 'i',
+
+	/**
+	 * caption or subtitle
+	 */
+	CAPTION = 'c',
+
+	/**
+	 * ISOBMFF timed text track
+	 */
+	TIMED_TEXT = 'tt',
+
+	/**
+	 * cryptographic key, license or certificate.
+	 */
+	KEY = 'k',
+
+	/**
+	 * other
+	 */
+	OTHER = 'o',
+}

lib/src/cmsd/CmsdStreamType.ts

@@ -1,8 +1,19 @@
 /**
- * Common Media Streaming Type
+ * Common Media Server Data Stream Type
  *
  * @group CMSD
  *
  * @beta
  */
-export { CmStreamType as CmsdStreamType } from '../cta/CmStreamType.js';
+export enum CmsdStreamType {
+	/**
+	 *  All segments are available – e.g., VOD
+	 */
+	VOD = 'v',
+
+	/**
+	 * Segments become available over time – e.g., LIVE
+	 */
+	LIVE = 'l',
+}
+

lib/src/cmsd/CmsdStreamingFormat.ts

@@ -1,8 +1,29 @@
 /**
- * Common Media Streaming Format
+ * Common Media Server Data Streaming Format
  *
  * @group CMSD
  *
  * @beta
  */
-export { CmStreamingFormat as CmsdStreamingFormat } from '../cta/CmStreamingFormat.js';
+export enum CmsdStreamingFormat {
+	/**
+	 * MPEG DASH
+	 */
+	DASH = 'd',
+
+	/**
+	 * HTTP Live Streaming (HLS)
+	 */
+	HLS = 'h',
+
+	/**
+	 * Smooth Streaming
+	 */
+	SMOOTH = 's',
+
+	/**
+	 * Other
+	 */
+	OTHER = 'o',
+}
+