Merge pull request #18 from THEOplayer/api-docs

Publish API docs to GitHub Pages

.changeset/hungry-crabs-report.md

@@ -0,0 +1,6 @@
+---
+"@theoplayer/yospace-connector-web": patch
+"@theoplayer/cmcd-connector-web": patch
+---
+
+Fix missing API types in TypeScript type definitions.

.github/workflows/pages.yml

@@ -0,0 +1,51 @@
+# Based on https://github.com/actions/starter-workflows/blob/b53d05e4b0dde7cdaeda60476acfcaaa1713f8cc/pages/jekyll-gh-pages.yml
+name: GitHub Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches:
+      - main
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Install dependencies
+        run: npm ci --workspaces --include-workspace-root
+      - name: Build API docs
+        run: npm run docs -- --out ./_site/api
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}

.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Test
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    types: [opened, reopened, synchronize]
+    paths-ignore:
+      - '**.md'
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci --workspaces --include-workspace-root
+      - name: Build
+        run: npm run build
+      - name: Test
+        run: npm test

.gitignore

@@ -2,3 +2,6 @@ node_modules/
 
 # Generated by MacOS
 .DS_Store
+
+# TypeDoc
+api/

.prettierignore

@@ -1,2 +1,5 @@
 */dist/
-*/test/pages/
+*/test/pages/
+
+# TypeDoc
+api/

README.md

@@ -0,0 +1,21 @@
+# THEOplayer Web SDK Connectors
+
+This repository is maintained by [THEO Technologies](https://www.theoplayer.com/) and contains the different connectors
+available for the THEOplayer Web SDK.
+
+The THEOplayer Web SDK enables you to quickly deliver content playback on your website or web app.
+
+Using the available connectors allows you to augment the features delivered through the Web SDK.
+
+## Available Connectors
+
+| Connector | npm package                                                                                                                                          | Source code                                                               |
+|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------|
+| CMCD      | ![@theoplayer/cmcd-connector-web](https://img.shields.io/npm/v/%40theoplayer%2Fcmcd-connector-web?label=%40theoplayer%2Fcmcd-connector-web)          | [cmcd](https://github.com/THEOplayer/web-connectors/tree/main/cmcd)       |
+| Conviva   | ![@theoplayer/conviva-connector-web](https://img.shields.io/npm/v/%40theoplayer%2Fconviva-connector-web?label=%40theoplayer%2Fconviva-connector-web) | [conviva](https://github.com/THEOplayer/web-connectors/tree/main/conviva) |
+| Nielsen   | ![@theoplayer/nielsen-connector-web](https://img.shields.io/npm/v/%40theoplayer%2Fnielsen-connector-web?label=%40theoplayer%2Fnielsen-connector-web) | [nielsen](https://github.com/THEOplayer/web-connectors/tree/main/nielsen) |
+| Yospace   | ![@theoplayer/yospace-connector-web](https://img.shields.io/npm/v/%40theoplayer%2Fyospace-connector-web?label=%40theoplayer%2Fyospace-connector-web) | [yospace](https://github.com/THEOplayer/web-connectors/tree/main/yospace) |
+
+## License
+
+The contents of this package are subject to the [THEOplayer license](https://www.theoplayer.com/terms).

cmcd/package.json

@@ -10,10 +10,10 @@
   },
   "homepage": "https://theoplayer.com/",
   "module": "dist/cmcd-connector.esm.js",
-  "types": "dist/cmcd-connector.d.ts",
+  "types": "dist/types/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/cmcd-connector.d.ts",
+      "types": "./dist/types/index.d.ts",
       "import": "./dist/cmcd-connector.esm.js",
       "require": "./dist/cmcd-connector.umd.js"
     },

cmcd/src/index.ts

@@ -1,15 +1,3 @@
-import { CMCDObjectType, CMCDPayload, CMCDReservedKey, CMCDStreamingFormat, CMCDStreamType } from './CMCDPayload';
-import { TransmissionMode } from './Configuration';
-import { CMCDConnector, CMCDPayloadProcessor, createCMCDConnector } from './CMCDConnector';
-
-export {
-    CMCDConnector,
-    createCMCDConnector,
-    CMCDPayloadProcessor,
-    TransmissionMode,
-    CMCDPayload,
-    CMCDReservedKey,
-    CMCDStreamingFormat,
-    CMCDObjectType,
-    CMCDStreamType
-};
+export { CMCDObjectType, CMCDPayload, CMCDReservedKey, CMCDStreamingFormat, CMCDStreamType } from './CMCDPayload';
+export * from './Configuration';
+export { CMCDConnector, CMCDPayloadProcessor, createCMCDConnector } from './CMCDConnector';

cmcd/tsconfig.json

@@ -1,13 +1,11 @@
 {
+  "extends": "../tsconfig.base.json",
   "compilerOptions": {
-    "target": "es5",
-    "module": "commonjs",
-    "strict": true,
-    "baseUrl": "./",
-    "rootDir": ".",
-    "paths": { "THEOplayer": ["./src/THEOplayer"] },
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true
-  }
+    "rootDir": "src",
+    "outDir": "dist",
+    "declarationDir": "dist/types"
+  },
+  "include": [
+    "src/**/*"
+  ]
 }

cmcd/typedoc.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "extends": [
+    "../typedoc.base.json"
+  ],
+  "entryPoints": [
+    "src/index.ts"
+  ],
+  "tsconfig": "tsconfig.json",
+  "readme": "README.md",
+  "name": "CMCD Connector"
+}

conviva/package.json

@@ -6,10 +6,10 @@
   "repository": "https://github.com/THEOplayer/conviva-connector-web",
   "homepage": "https://theoplayer.com/",
   "module": "dist/conviva-connector.esm.js",
-  "types": "dist/conviva-connector.d.ts",
+  "types": "dist/types/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/conviva-connector.d.ts",
+      "types": "./dist/types/index.d.ts",
       "import": "./dist/conviva-connector.esm.js",
       "require": "./dist/conviva-connector.umd.js"
     },

conviva/tsconfig.json

@@ -1,13 +1,11 @@
 {
+  "extends": "../tsconfig.base.json",
   "compilerOptions": {
-    "target": "es5",
-    "module": "commonjs",
-    "strict": true,
-    "baseUrl": "./",
-    "rootDir": ".",
-    "paths": { "THEOplayer": ["./src/THEOplayer"] },
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true
-  }
+    "rootDir": "src",
+    "outDir": "dist",
+    "declarationDir": "dist/types"
+  },
+  "include": [
+    "src/**/*"
+  ]
 }

conviva/typedoc.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "extends": [
+    "../typedoc.base.json"
+  ],
+  "entryPoints": [
+    "src/index.ts"
+  ],
+  "tsconfig": "tsconfig.json",
+  "readme": "README.md",
+  "name": "Conviva Connector"
+}

nielsen/package.json

@@ -4,10 +4,10 @@
   "description": "A connector implementing Nielsen with THEOplayer.",
   "main": "dist/nielsen-connector.umd.js",
   "module": "dist/nielsen-connector.esm.js",
-  "types": "dist/nielsen-connector.d.ts",
+  "types": "dist/types/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/nielsen-connector.d.ts",
+      "types": "./dist/types/index.d.ts",
       "import": "./dist/nielsen-connector.esm.js",
       "require": "./dist/nielsen-connector.umd.js"
     },

nielsen/tsconfig.json

@@ -1,13 +1,11 @@
 {
+  "extends": "../tsconfig.base.json",
   "compilerOptions": {
-    "target": "es5",
-    "module": "commonjs",
-    "strict": true,
-    "baseUrl": "./",
-    "rootDir": ".",
-    "paths": { "THEOplayer": ["./src/THEOplayer"] },
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true
-  }
+    "rootDir": "src",
+    "outDir": "dist",
+    "declarationDir": "dist/types"
+  },
+  "include": [
+    "src/**/*"
+  ]
 }

nielsen/typedoc.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "extends": [
+    "../typedoc.base.json"
+  ],
+  "entryPoints": [
+    "src/index.ts"
+  ],
+  "tsconfig": "tsconfig.json",
+  "readme": "README.md",
+  "name": "Nielsen Connector"
+}