chore: Add GitHub Action to publish typescript package to NPM

Author: nytamin

.github/workflows/publish-npm-nightly.yml

@@ -0,0 +1,55 @@
+name: Publish nightly to NPM
+
+on:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+permissions:
+  id-token: write # Required for OIDC
+  contents: read
+
+jobs:
+  Publish:
+    name: Publish to NPM
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    defaults:
+      run:
+        working-directory: ./v1/typescript-definitions
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
+        with:
+          node-version: 24
+          package-manager-cache: false
+          registry-url: "https://registry.npmjs.org"
+
+      # Ensure npm 11.5.1 or later is installed:
+      # - name: Update npm
+      #   run: npm install -g npm@latest
+
+      - name: Prepare Environment
+        # Install from package-lock.json:
+        run: npm ci
+        env:
+          CI: true
+
+      - name: Bump version to prerelease
+        run: |
+          PRERELEASE_TAG=nightly-$(echo "${{ github.ref_name }}" | sed -r 's/[^a-z0-9]+/-/gi')
+          npm version prerelease --preid $PRERELEASE_TAG-$COMMIT_DATE-$GIT_HASH
+
+      - name: Generate types
+        run: npm run generate-types
+        env:
+          CI: true
+
+      - name: Build
+        run: npm run build
+        env:
+          CI: true
+
+      - name: Publish to NPM
+        run: npm publish --tag nightly
+        env:
+          CI: true

.github/workflows/publish-npm.yml

@@ -13,3 +13,38 @@ jobs:
     name: Publish to NPM
     runs-on: ubuntu-latest
     timeout-minutes: 15
+    defaults:
+      run:
+        working-directory: ./v1/typescript-definitions
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
+        with:
+          node-version: 24
+          package-manager-cache: false
+          registry-url: "https://registry.npmjs.org"
+
+      # Ensure npm 11.5.1 or later is installed:
+      # - name: Update npm
+      #   run: npm install -g npm@latest
+
+      - name: Prepare Environment
+        # Install from package-lock.json:
+        run: npm ci
+        env:
+          CI: true
+
+      - name: Generate types
+        run: npm run generate-types
+        env:
+          CI: true
+
+      - name: Build
+        run: npm run build
+        env:
+          CI: true
+
+      - name: Publish to NPM
+        run: npm publish --tag latest
+        env:
+          CI: true

v1/typescript-definitions/README.md

@@ -66,8 +66,21 @@ The instructions below are for developers who want to work on the Typescript def
 ```bash
 
 npm install
+npm run generate-types # If any of the specification has changed
 npm run build
 # or
 npm run watch
 
 ```
+
+### Publish to NPM
+
+To publish a new version to NPM:
+
+1. Bump the version `npm version major|minor|patch`
+2. Commit and push to GitHub
+3. Go to the Actions tab and trigger the "Publish to NPM" workflow
+
+To publish a nightly build to NPM:
+
+1. Go to the Actions tab and trigger the "Publish nightly to NPM" workflow

v1/typescript-definitions/package.json

@@ -5,6 +5,9 @@
   "types": "dist/main.d.ts",
   "license": "MIT",
   "description": "TypeScript definitions for Ograf graphics",
+  "repository": {
+    "url": "https://github.com/ebu/ograf"
+  },
   "homepage": "https://ograf.ebu.io",
   "keywords": [
     "ograf",
@@ -17,8 +20,7 @@
   "scripts": {
     "build": "tsc --build",
     "watch": "tsc --watch",
-    "generate-types": "node scripts/generate-types.js",
-    "do:publish": "npm run generate-types && npm run build && npm publish --access public"
+    "generate-types": "node scripts/generate-types.js"
   },
   "devDependencies": {
     "typescript": "^5.6.3",