Add request package (CommonMediaRequest and CommonMediaResponse)

.github/CODEOWNERS

@@ -1 +1 @@
-*        @streaming-video-technology-alliance/common-media-library @littlespex
+*        @streaming-video-technology-alliance/common-media-library @streaming-video-technology-alliance/players-playback 

.github/workflows/ci.pr.yml

@@ -16,17 +16,10 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: 20
+          cache: 'npm'
           registry-url: "https://npm.pkg.github.com"
           scope: "@cbsinteractive"
 
-      - name: Cache dependencies
-        uses: actions/cache@v3
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
       - name: Install
         run: npm ci
 

.github/workflows/docs.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
 
 env:
-  NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
+  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
 jobs:
   docs:
@@ -21,7 +21,7 @@ jobs:
           node-version: 20
           cache: 'npm'
           registry-url: "https://registry.npmjs.org"
-          scope: "@svta.org"
+          scope: "@svta"
 
       - name: Install
         run: npm ci

.github/workflows/publish-tag.yml

@@ -0,0 +1,56 @@
+name: Publish Tag
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "The npm tag (i.e @svta/common-media-library@dev)"
+        default: 'dev'
+        required: true
+      id:
+        description: "An id to append to the version. Defaults to the current timestamp"
+        type: string
+        required: false
+
+env:
+  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: 'npm'
+          registry-url: "https://registry.npmjs.org"
+          scope: "@svta"
+
+      - name: Install
+        run: npm ci
+
+      - name: Test
+        run: npm test
+
+      - name: Get Version
+        run: echo "version=`node -p "require('./package').version"`" >> $GITHUB_ENV
+
+      - name: Get Time
+        if: github.event.inputs.id == ''
+        run: echo "id=`date +%s`" >> $GITHUB_ENV
+
+      - name: Get ID
+        if: github.event.inputs.id != ''
+        run: echo "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
+
+      - name: Publish Tag
+        run: npm run pub --tag ${{ github.event.inputs.tag }}

.github/workflows/publish.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
 
 env:
-  NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
+  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
 jobs:
   publish:
@@ -21,7 +21,7 @@ jobs:
           node-version: 20
           cache: 'npm'
           registry-url: "https://registry.npmjs.org"
-          scope: "@svta.org"
+          scope: "@svta"
 
       - name: Install
         run: npm ci
@@ -35,6 +35,9 @@ jobs:
       - name: Get Version
         run: echo "version=`node -p "require('./package').version"`" >> $GITHUB_ENV
 
+      - name: Create Release Notes
+        run: npm run notes
+
       - name: Draft Release
         uses: actions/create-release@v1
         env:
@@ -43,18 +46,7 @@ jobs:
           tag_name: v${{ env.version }}
           release_name: ${{ env.version }}
           commitish: main
-          body: |
-            ## Release Notes
-            *
-
-            ## Documentation
-            TBD
-
-            ## NPM Package
-            ```sh
-            npm install @svta.org/common-media-library@${{ env.version }}
-            ```
-
+          body_path: ./RELEASE.md
           draft: true
           prerelease: false
 

.gitignore

@@ -1,2 +1,4 @@
 node_modules/
 dist
+.vscode
+RELEASE.md

CHANGELOG.md

@@ -19,6 +19,45 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 
+## [0.5.0] - ????-??-??
+
+
+## [0.4.5] - 2023-10-12
+
+### Fixed
+- `CMCD_PARAM` constant does not match file name [#27](https://github.com/streaming-video-technology-alliance/common-media-library/issues/27)
+- lint errors when using typedoc specific tags [#32](https://github.com/streaming-video-technology-alliance/common-media-library/issues/32)
+- Allow imports with file extensions [#26](https://github.com/streaming-video-technology-alliance/common-media-library/issues/26)
+
+
+## [0.4.4] - 2023-10-11
+
+### Fixed
+- Module not found: Error: Default condition should be last one [#22](https://github.com/streaming-video-technology-alliance/common-media-library/issues/22)
+
+
+## [0.4.3] - 2023-07-25
+
+### Added
+- Add `NOTICE` file for attributions
+- Export library in cjs format [#11](https://github.com/streaming-video-technology-alliance/common-media-library/issues/11)
+
+### Changed
+- Switch to inline source maps
+
+
+## [0.4.2] - 2023-05-25
+
+### Changed
+- The project has moved to a new NPM org. First release under `@svta/common-media-library`.
+
+
+## [0.4.1] - 2023-05-25
+
+### Changed
+- The project has moved to a new NPM org. Last release under `@svta.org/common-media-library`.
+
+
 ## [0.4.0] - 2023-05-05
 
 ### Added
@@ -97,7 +136,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Bootstrap project [#2](https://github.com/streaming-video-technology-alliance/common-media-library/issues/2)
 
 
-[Unreleased]\: https://github.com/streaming-video-technology-alliance/common-media-library/compare/v0.4.0...HEAD  
+[Unreleased]\: https://github.com/streaming-video-technology-alliance/common-media-library/compare/v0.5.0...HEAD  
+[0.5.0]\: https://github.com/streaming-video-technology-alliance/common-media-library/compare/v0.4.5...v0.5.0  
+[0.4.5]\: https://github.com/streaming-video-technology-alliance/common-media-library/compare/v0.4.4...v0.4.5  
+[0.4.4]\: https://github.com/streaming-video-technology-alliance/common-media-library/compare/v0.4.3...v0.4.4  
+[0.4.3]\: https://github.com/streaming-video-technology-alliance/common-media-library/compare/v0.4.2...v0.4.3  
+[0.4.2]\: https://github.com/streaming-video-technology-alliance/common-media-library/compare/v0.4.1...v0.4.2  
+[0.4.1]\: https://github.com/streaming-video-technology-alliance/common-media-library/compare/v0.4.0...v0.4.1  
 [0.4.0]\: https://github.com/streaming-video-technology-alliance/common-media-library/compare/v0.3.0...v0.4.0   
 [0.3.0]\: https://github.com/streaming-video-technology-alliance/common-media-library/compare/v0.2.6...v0.3.0  
 [0.2.6]\: https://github.com/streaming-video-technology-alliance/common-media-library/compare/v0.2.5...v0.2.6  

CONTRIBUTING.md

@@ -1,8 +1,8 @@
-# Welcome to the Common Media Library contributing guide <!-- omit in toc -->
+# Common Media Library Contributing Guide
 
 Thank you for investing your time in contributing to the Common Media Library. 
 
-<!-- Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. -->
+Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
 
 In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
 
@@ -23,18 +23,23 @@ Scan through our [existing issues](https://github.com/streaming-video-technology
 1. Fork the repository.
 [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
 
-2. Install or update to **Node.js**.
+1. Install or update to **Node.js**.
 
-3. Create a working branch and start with your changes!
+1. Create a working branch and start with your changes!
 
-4. Update the CHANGELOG. Make sure to update the change log with the change you've made, along with a referene to the issue.  See the [CHANGELOG](./CHANGELOG.md) for more information.
+1. Update the [CHANGELOG](./CHANGELOG.md). Make sure to update the change log with the change you've made, along with a referene to the issue.
 
-5. Add tests for your changes.
+1. Add yourself to the [Contributors List](./CONTRIBUTORS.md) if you haven't already.
 
-6. Add documentation for your changes.
+1. Add tests for your changes.
+
+1. Add documentation for your changes.
 
 ### Commit your update
 
+> **Warning**
+> This library requires all commits to sign the DCO. See https://github.com/apps/dco for more information.
+
 1. Run `npm run format` to format the code before committing.
 
 1. Make sure all tests pass by running `npm run test`.

CONTRIBUTORS.md

@@ -0,0 +1,9 @@
+# Common Media Library Contributors List
+Please add entries to the bottom of the list in the following format:
+```
+- @GitHub UserName (Required) [Name, Organization] (Optional)
+```
+
+- @littlespex [Casey Occhialini, Paramount]
+- @dsparacio [Daniel Sparaico, Paramount]
+- @acbegen [Ali C. Begen, Comcast]

GOVERNANCE.md

@@ -0,0 +1,3 @@
+Common Media Library Governance
+
+The Common Media Library is a public project of the Streaming Video Alliance and is governed by https://github.com/streaming-video-technology-alliance/common-media-library/wiki/Governance-Model

LICENSE

@@ -0,0 +1 @@
+./lib/LICENSE

NOTICE

@@ -0,0 +1 @@
+./lib/NOTICE

SCOPING.md

@@ -0,0 +1,63 @@
+# Common Media Library Scope
+
+## Overview
+
+The purpose of the Common Media Library is to consolidate common pieces of functionality  and interfaces relating to browser-based media playback that have been implemented independently across multiple open-source libraries leading to mismatched functionality and feature sets.
+
+In our work across Hls.js, Dash.js and Shaka player, we have noticed common pieces of functionality that have been implemented independently, and sometimes copied and pasted, across the libraries. This is particularly true when looking at standards-based features, like ID3 parsing, 608 parsing and CMCD. Since the functionality is shared in spirit but not implementation, they can fall out of sync where certain bugs are fixed in one player but not the others. Having a common library creates a single place where these utilities can be maintained. It also creates a single place for standards groups to request and oversee feature implementation.
+
+
+## Contributors
+
+- Casey Occhialini - Author, Reviewer
+- Dan Sparacio - Reviewer
+- Ali Begen - Reviewer
+
+
+## Objectives
+
+Maintain a modern, modular, Javascript utility library for media playback. To achieve this the library will:
+- Be written in TypeScript and modern build tools
+- Distributed as standalone files that can be imported as needed.
+- Provide documentation pertaining to the library's API and usage.
+
+
+## Project Scope
+
+The initial scope of the Common Media Library will address the following functionality:
+- Providing SDKs for standards based media player features like:
+  - Common Media Client Data (CMCD) encoding / decoding
+  - Common Media Server Data (CMSD) encoding / decoding
+  - ID3 tag parsing 
+  - ISO BMFF parsing
+  - CTA-608 / 708 parsing and rendering
+  - VTT parsing and rendering
+  - IMSC parsing and rendering
+  - HLS manifest parser 
+  - Dash manifest parser
+- Providing a place to develop SDKs for new/upcoming standards like C2PA, MoQ, etc.
+
+The initial scope of this project does not include:
+- A working media player. The library should be used by developers to implement standards based features in their own players.
+
+
+## Constraints
+
+The library will be licensed under the Apache 2.0 license. References to other license notifications will be maintained in a `NOTICE.md` file when applicable.
+
+
+## Deliverables
+
+### Source Code
+
+The source code for the library will be maintained in a public Github repository under the `streaming-video-technology-alliance` organization. Changes to the library are submitted as pull requests to the repository. All pull requests must be approved by a minimum of two SVTA approved code reviewers (SVTA member or subject matter expert).
+
+
+### Documentation
+
+The documentation for the library will be distributed via Github pages, deployed with every version release.
+
+
+### Distribution
+
+The library will be distributed as an NPM package in the `@svta` organization, `@svta/common-media-library`. Publishing permissions are restricted to SVTA members.

docs/package.json

@@ -1,14 +1,14 @@
 {
-  "name": "@svta.org/common-media-library-docs",
+  "name": "@svta/common-media-library-docs",
   "private": true,
-  "version": "0.4.0",
-  "license": "MIT",
+  "version": "0.5.0",
+  "license": "Apache-2.0",
   "type": "module",
   "homepage": "https://github.com/streaming-video-technology-alliance/common-media-library",
   "authors": "Casey Occhialini <[email protected]>",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/streaming-video-technology-alliance/common-media-library"
+    "url": "git+https://github.com/streaming-video-technology-alliance/common-media-library.git"
   },
   "bugs": {
     "url": "https://github.com/streaming-video-technology-alliance/common-media-library/issues"