create-unisphere-project 1.2.4 → 2.0.0

package/_templates/unisphere-project/.github/workflows/_publish-artifacts.yml

@@ -4,16 +4,61 @@ on:
   workflow_call:
 
 jobs:
-  prepare-runtimes:
+  check-elements:
     runs-on: codebuild-ovp-unisphere-runner-${{ github.run_id }}-${{ github.attempt }}
+    outputs:
+      has_packages: ${{ steps.check.outputs.has_packages }}
+      has_runtimes: ${{ steps.check.outputs.has_runtimes }}
+      has_applications: ${{ steps.check.outputs.has_applications }}
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event_name == 'pull_request' && github.head_ref || github.ref }}
+          fetch-tags: true
+      
+      - name: Check elements in .unisphere
+        id: check
+        run: |
+          if [ -f .unisphere ]; then
+            PACKAGES=$(jq -r '.elements.packages // {} | length' .unisphere)
+            RUNTIMES=$(jq -r '(.elements.runtimes // {} | length) + (.elements.workspace // {} | length) + (.elements.loader // {} | length)' .unisphere)
+            APPLICATIONS=$(jq -r '.elements.applications // {} | length' .unisphere)
+            
+            if [ "$PACKAGES" -gt 0 ]; then
+              echo "has_packages=true" >> $GITHUB_OUTPUT
+            else
+              echo "has_packages=false" >> $GITHUB_OUTPUT
+            fi
+            
+            if [ "$RUNTIMES" -gt 0 ]; then
+              echo "has_runtimes=true" >> $GITHUB_OUTPUT
+            else
+              echo "has_runtimes=false" >> $GITHUB_OUTPUT
+            fi
+            
+            if [ "$APPLICATIONS" -gt 0 ]; then
+              echo "has_applications=true" >> $GITHUB_OUTPUT
+            else
+              echo "has_applications=false" >> $GITHUB_OUTPUT
+            fi
+          else
+            echo "has_packages=false" >> $GITHUB_OUTPUT
+            echo "has_runtimes=false" >> $GITHUB_OUTPUT
+            echo "has_applications=false" >> $GITHUB_OUTPUT
+          fi
 
+  prepare-runtimes:
+    runs-on: codebuild-ovp-unisphere-runner-${{ github.run_id }}-${{ github.attempt }}
+    if: needs.check-elements.outputs.has_runtimes == 'true'
+    needs: check-elements
     outputs:
       unisphereElementsArtifactsFolder: ${{ steps.prepare-runtimes.outputs.artifactsRootFolder }}
       hasArtifacts: ${{ steps.prepare-runtimes.outputs.hasArtifacts }}
       commit_sha: ${{ steps.capture_commit_sha.outputs.commit_sha }}
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.event_name == 'pull_request' && github.head_ref || github.ref }}
           fetch-tags: true
@@ -25,10 +70,21 @@ jobs:
         run: git reset --hard HEAD
       - name: Clean npm cache
         run: npm cache clean --force
+      
+      - name: Setup JFrog        
+        uses: jfrog/setup-jfrog-cli@v4
+        id: setup-jfrog
+        env:
+          JF_URL: https://kalturaa.jfrog.io
+        with:
+          oidc-provider-name: ovp-github-oidc
+
       - name: Install dependencies
-        run: npm ci --include=optional
+        run: npm ci --ignore-scripts          
         env:
           GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          KALTURA_JFROG_TOKEN: ${{ steps.setup-jfrog.outputs.oidc-token }}
+
       - name: Prepare Unisphere Elements
         id: prepare-runtimes
         run: npx unisphere runtime publish prepare --verbose
@@ -46,21 +102,36 @@ jobs:
           retention-days: 1
 
   deploy-packages:
+    if: needs.check-elements.outputs.has_packages == 'true'
+    needs: check-elements
     runs-on: codebuild-ovp-unisphere-runner-${{ github.run_id }}-${{ github.attempt }}
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.event_name == 'pull_request' && github.head_ref || github.ref }}
           fetch-tags: true
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version-file: '.nvmrc'
+      
+      - name: Setup JFrog        
+        uses: jfrog/setup-jfrog-cli@v4
+        id: setup-jfrog
+        env:
+          JF_URL: https://kalturaa.jfrog.io
+        with:
+          oidc-provider-name: ovp-github-oidc
+      
       - name: Install dependencies
-        run: npm ci --include=optional
+        run: |
+          npm ci --ignore-scripts
+
         env:
           GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          KALTURA_JFROG_TOKEN: ${{ steps.setup-jfrog.outputs.oidc-token }}
+
       - name: Get NPM Token from AWS Secrets Manager
         id: get-npm-token
         run: |
@@ -82,22 +153,39 @@ jobs:
           - { env: 'frp2', region: 'eu-central-1', accountid: '082111255551' }
           - { env: 'irp2', region: 'eu-west-1', accountid: '137576761235' }
           - { env: 'nvq2', region: 'us-east-1', accountid: '383697330906' }
+          - { env: 'sgp2', region: 'ap-southeast-1', accountid: '882351240370' }
+          - { env: 'syp2', region: 'ap-southeast-2', accountid: '650755435642' }
+          - { env: 'cap2', region: 'ca-central-1', accountid: '948632009361' }
       fail-fast: false
 
     steps:
+      - name: Check available disk space
+        run: df -h
       - name: Checkout Repo at specific commit
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ needs.prepare-runtimes.outputs.commit_sha }}
           fetch-tags: true
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version-file: '.nvmrc'
+      
+      - name: Setup JFrog        
+        uses: jfrog/setup-jfrog-cli@v4
+        id: setup-jfrog
+        env:
+          JF_URL: https://kalturaa.jfrog.io
+        with:
+          oidc-provider-name: ovp-github-oidc
+      
       - name: Install dependencies
-        run: npm ci --include=optional
+        run: |
+          npm ci --ignore-scripts          
         env:
           GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          KALTURA_JFROG_TOKEN: ${{ steps.setup-jfrog.outputs.oidc-token }}
+
       - name: Download artifacts folder
         uses: actions/download-artifact@v4
         with:
@@ -112,16 +200,19 @@ jobs:
           --artifacts-folder '${{ needs.prepare-runtimes.outputs.unisphereElementsArtifactsFolder }}' \
           --verbose
 
-  prepare-applications:
-    runs-on: codebuild-ovp-unisphere-runner-${{ github.run_id }}-${{ github.attempt }}
-
+  prepare-applications:    
+    if: needs.check-elements.outputs.has_applications == 'true'
+    needs: [deploy-runtimes, check-elements]
+    runs-on: 
+      - codebuild-ovp-unisphere-runner-${{ github.run_id }}-${{ github.attempt }}
+      - instance-size:medium
     outputs:
       unisphereApplicationsArtifactsFolder: ${{ steps.prepare-applications.outputs.artifactsRootFolder }}
       hasArtifacts: ${{ steps.prepare-applications.outputs.hasArtifacts }}
       commit_sha: ${{ steps.capture_commit_sha.outputs.commit_sha }}
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.event_name == 'pull_request' && github.head_ref || github.ref }}
           fetch-tags: true
@@ -133,10 +224,18 @@ jobs:
         run: git reset --hard HEAD
       - name: Clean npm cache
         run: npm cache clean --force
+      - name: Setup JFrog        
+        uses: jfrog/setup-jfrog-cli@v4
+        id: setup-jfrog
+        env:
+          JF_URL: https://kalturaa.jfrog.io
+        with:
+          oidc-provider-name: ovp-github-oidc
       - name: Install dependencies
-        run: npm ci --include=optional
+        run: npm ci --ignore-scripts          
         env:
           GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          KALTURA_JFROG_TOKEN: ${{ steps.setup-jfrog.outputs.oidc-token }}
       - name: Prepare Unisphere Applications
         id: prepare-applications
         run: npx unisphere application publish prepare --verbose
@@ -155,8 +254,10 @@ jobs:
 
   deploy-applications:
     if: needs.prepare-applications.outputs.hasArtifacts == 'true'
-    needs: prepare-applications
-    runs-on: codebuild-ovp-unisphere-runner-${{ github.run_id }}-${{ github.attempt }}
+    needs: [prepare-applications]
+    runs-on: 
+      - codebuild-ovp-unisphere-runner-${{ github.run_id }}-${{ github.attempt }}
+      - instance-size:medium
     strategy:
       matrix:
         envs_regions:
@@ -164,22 +265,32 @@ jobs:
           - { env: 'frp2', region: 'eu-central-1', accountid: '082111255551' }
           - { env: 'irp2', region: 'eu-west-1', accountid: '137576761235' }
           - { env: 'nvq2', region: 'us-east-1', accountid: '383697330906' }
+          - { env: 'sgp2', region: 'ap-southeast-1', accountid: '882351240370' }
+          - { env: 'syp2', region: 'ap-southeast-2', accountid: '650755435642' }
+          - { env: 'cap2', region: 'ca-central-1', accountid: '948632009361' }
       fail-fast: false
-
     steps:
       - name: Checkout Repo at specific commit
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ needs.prepare-applications.outputs.commit_sha }}
           fetch-tags: true
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version-file: '.nvmrc'
+      - name: Setup JFrog        
+        uses: jfrog/setup-jfrog-cli@v4
+        id: setup-jfrog
+        env:
+          JF_URL: https://kalturaa.jfrog.io
+        with:
+          oidc-provider-name: ovp-github-oidc
       - name: Install dependencies
-        run: npm ci --include=optional
+        run: npm ci --ignore-scripts          
         env:
           GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          KALTURA_JFROG_TOKEN: ${{ steps.setup-jfrog.outputs.oidc-token }}
       - name: Download artifacts folder
         uses: actions/download-artifact@v4
         with:
@@ -192,4 +303,4 @@ jobs:
           --aws-region '${{ matrix.envs_regions.region }}' \
           --aws-arn 'arn:aws:iam::${{matrix.envs_regions.accountid }}:role/${{ matrix.envs_regions.env }}-unisphere-content-role' \
           --artifacts-folder '${{ needs.prepare-applications.outputs.unisphereApplicationsArtifactsFolder }}' \
-          --verbose
+          --verbose

package/_templates/unisphere-project/.github/workflows/cicd.yml

@@ -6,6 +6,11 @@ on:
       - main
       - 'prerelease/**'
 
+permissions:
+  id-token: write
+  contents: write
+  packages: read
+
 jobs:
   release:
     name: Release
@@ -18,24 +23,43 @@ jobs:
       - name: Check if part of prerelease or official release
         id: check
         run: |
-          if [ ! -f ".changeset/pre.json" ] && [ "${{ github.ref }}" != "refs/heads/main" ]; then
+          if [ "${{ github.ref }}" = "refs/heads/main" ] && [ -f ".changeset/pre.json" ]; then
+            echo "main branch should not have pre.json file, skipping job"
+            exit 1
+          elif [[ "${{ github.ref }}" == "refs/heads/prerelease/"* ]] && [ ! -f ".changeset/pre.json" ]; then
+            echo "prerelease branch must have pre.json file, skipping job"
+            exit 1
+          elif [ "${{ github.ref }}" != "refs/heads/main" ] && [[ "${{ github.ref }}" != "refs/heads/prerelease/"* ]]; then
             echo "not part of prerelease or official release, skipping job"
-            echo "::stop-commands::`date +%s`"
-            exit 0
+            exit 1
           fi
 
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
 
+      - name: Run Kaltura Tools Check
+        uses: kaltura/kaltura-tools@unisphere
+        with:
+          repo-path: '${{ github.workspace }}'
+            
+      - name: Setup JFrog        
+        uses: jfrog/setup-jfrog-cli@v4
+        id: setup-jfrog
+        env:
+          JF_URL: https://kalturaa.jfrog.io
+        with:
+          oidc-provider-name: ovp-github-oidc
+
       - name: Install Dependencies
         run: npm ci --include=optional
         env:
           GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          KALTURA_JFROG_TOKEN: ${{ steps.setup-jfrog.outputs.oidc-token }}
 
       - name: Create Release Pull Request or Publish to npm
         id: changesets

package/_templates/unisphere-project/README.md

@@ -1 +1,134 @@
-# Unisphere {{company-name|human-readable}} {{project-name|human-readable}}
+# Unisphere - {{company-name|human-readable}} {{project-name|human-readable}}
+
+## Overview
+
+This repository is a **Unisphere workspace** for an experience named **{{project-name|human-readable}}**.
+
+It contains everything you need to:
+- Create and publish npm / JFrog packages  
+- Bundle and version runtime artifacts  
+- Build and deploy applications  
+- Develop locally and promote changes to production  
+
+The Unisphere workspace acts as the single entry point for the entire lifecycle — from local development, through CI/CD, and all the way to production deployment.
+
+To better understand the ideas behind Unisphere and how it works, read more at:  
+https://unisphere.kaltura.com/
+
+---
+
+## Prerequisites
+
+At the moment, **deploying Unisphere experiences is available only to Kaltura employees**.
+
+Before doing anything else, make sure your machine is properly configured to access:
+- Kaltura GitHub repositories  
+- Kaltura JFrog Artifactory registries  
+
+Follow the setup guide here:  
+https://unisphere.kaltura.com/docs/create/kaltura-employees/setup-machine
+
+---
+
+## Add the Experience to Kaltura Github Organization
+
+Before you can deploy or activate this experience, it must be registered in Github under Kaltura Organization.
+
+This step connects your Unisphere workspace to the relevant Kaltura infrastructure and enables CI/CD, deployment, and activation flows.
+
+Follow the guide here:  
+https://unisphere.kaltura.com/docs/create/devops/create-github-repository
+
+---
+
+## Create Artifacts
+
+Unisphere allows you to create and manage different types of artifacts, including:
+- Packages  
+- Runtimes  
+- Applications  
+
+Each artifact type has its own role in the ecosystem, but they all live and evolve together inside this workspace.
+
+Read more about creating artifacts here:  
+https://unisphere.kaltura.com/docs/create/overview
+
+---
+
+## Deploy
+
+To deploy **packages, applications, and runtimes**, follow the deployment guide:  
+https://unisphere.kaltura.com/docs/create/devops/deploy
+
+For **applications and runtimes**, deployment is only part of the process.  
+After deployment, they must also be activated to become available in production.
+
+Activation guide:  
+https://unisphere.kaltura.com/docs/create/devops/activate
+
+---
+
+## Local Development
+
+Unisphere provides a structured local development flow that mirrors production as closely as possible, while still keeping things fast and developer-friendly.
+
+This includes:
+- Local builds  
+- Watching and rebuilding artifacts  
+- Running applications in isolation or as part of a larger workspace  
+
+Read more about local development here:  
+https://unisphere.kaltura.com/docs/create/local-development
+
+---
+
+## Available Commands
+
+This workspace exposes a small set of opinionated commands to help you explore, validate, and manage the experience.
+
+### Start
+Lists all available commands for each artifact in the experience, including how to build and serve runtimes, and how to spawn applications.
+
+```bash
+npm run start
+```
+
+
+### Info
+Displays information about the current workspace, including detected artifacts, configuration, and environment details.
+
+```bash
+npm run info
+```
+
+### Check
+Validates the workspace setup and verifies that all required artifacts and configurations are in place.
+
+```bash
+npm run check
+```
+
+### Reset
+Resets the workspace to a clean state. Useful when experimenting or when local state becomes inconsistent.
+
+```bash
+npm run reset
+```
+
+
+---
+
+## Next Steps
+
+If this is your first time working with Unisphere, a great next step is to **create a runtime with a playground**.
+
+Follow the Hello World walkthrough here:
+[https://unisphere.kaltura.com/docs/create/overview](https://unisphere.kaltura.com/docs/create/overview)
+
+The walkthrough will guide you through:
+
+* Creating your first runtime
+* Running it locally with a playground
+* Understanding how runtimes, packages, and applications connect together
+
+This will give you a strong foundation for building and evolving the experience over time.

package/_templates/unisphere-project/package.json

@@ -1,8 +1,9 @@
 {
-  "name": "heya-heyaaa/source",
+  "name": "{{company-name|lower-dash-case}}-{{project-name|lower-dash-case}}/source",
   "version": "1.0.0",
   "license": "MIT",
   "scripts": {
+    "preinstall": "npx --yes --prefer-online --registry=https://npm.pkg.github.com --package @kaltura/kaltura-tools@latest kaltura-tools check --allow-missing --root=.",
     "postinstall": "patch-package && npm run reset",
     "start": "unisphere how-to",
     "info": "unisphere info",
@@ -15,17 +16,17 @@
   "devDependencies": {
     "@babel/core": "^7.14.5",
     "@babel/preset-react": "^7.14.5",
-    "@changesets/cli": "2.27.11",
-    "@nx/eslint": "22.0.2",
-    "@nx/eslint-plugin": "22.0.2",
-    "@nx/jest": "22.0.2",
-    "@nx/js": "22.0.2",
-    "@nx/react": "22.0.2",
-    "@nx/rollup": "22.0.2",
-    "@nx/vite": "22.0.2",
-    "@nx/web": "22.0.2",
-    "@nx/webpack": "22.0.2",
-    "@nx/workspace": "22.0.2",
+    "@changesets/cli": "2.29.7",
+    "@nx/eslint": "22.1.3",
+    "@nx/eslint-plugin": "22.1.3",
+    "@nx/jest": "22.1.3",
+    "@nx/js": "22.1.3",
+    "@nx/react": "22.1.3",
+    "@nx/rollup": "22.1.3",
+    "@nx/vite": "22.1.3",
+    "@nx/web": "22.1.3",
+    "@nx/webpack": "22.1.3",
+    "@nx/workspace": "22.1.3",
     "@rollup/plugin-alias": "^5.1.0",
     "@rollup/plugin-replace": "^5.0.7",
     "@rollup/plugin-terser": "^0.4.4",
@@ -35,15 +36,15 @@
     "@swc-node/register": "~1.9.1",
     "@swc/cli": "0.6.0",
     "@swc/core": "~1.5.7",
-    "@swc/helpers": "~0.5.17",
+    "@swc/helpers": "0.5.17",
     "@testing-library/react": "16.1.0",
     "@types/jest": "30.0.0",
-    "@types/react": "^19.0.0",
-    "@types/react-dom": "^19.0.0",
+    "@types/react": "19.2.7",
+    "@types/react-dom": "19.2.3",
     "@typescript-eslint/eslint-plugin": "^7.3.0",
     "@typescript-eslint/parser": "^7.3.0",
-    "@unisphere/nx": "^1.11.0",
-    "@vitejs/plugin-react": "^5.1.0",
+    "@unisphere/nx": "2.0.0",
+    "@vitejs/plugin-react": "^4.2.0",
     "@vitest/coverage-v8": "^1.0.4",
     "@vitest/ui": "^1.3.1",
     "babel-jest": "30.0.5",
@@ -61,60 +62,55 @@
     "jiti": "2.4.2",
     "jsdom": "~22.1.0",
     "local-web-server": "^5.3.3",
-    "nx": "22.0.2",
+    "nx": "22.1.3",
     "patch-package": "^8.0.0",
     "prettier": "^2.6.2",
     "rollup": "^4.14.0",
     "rollup-plugin-analyzer": "^4.0.0",
-    "ts-jest": "29.4.5",
+    "ts-jest": "29.4.6",
     "ts-node": "10.9.1",
     "tslib": "^2.3.0",
     "typescript": "~5.4.2",
-    "vite": "7.2.1",
+    "vite": "7.2.7",
     "vitest": "^1.3.1",
     "webpack-cli": "^5.1.4"
   },
-  "overrides": {
-    "@unisphere/ui-i18n-react": {
-      "react": "^19.0.0",
-      "react-dom": "^19.0.0",
-      "@unisphere/runtime-js": "^1.81.0",
-      "@unisphere/runtime": "^1.82.0"
-    },
-    "@unisphere/runtime-react": {
-      "react": "^19.0.0",
-      "react-dom": "^19.0.0"
-    },
-    "@swc-node/core": {
-      "@swc/core": "~1.5.7"
-    }
-  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
   "dependencies": {
     "@emotion/react": "11.14.0",
     "@emotion/styled": "11.14.1",
-    "@kaltura/ds-react-bits": "^12.1.0",
-    "@kaltura/ds-react-components": "^12.1.0",
-    "@kaltura/ds-react-icons": "^12.1.0",
-    "@kaltura/ds-react-theme": "^12.1.0",
-    "@kaltura/ds-react-utils": "^12.1.0",
-    "@mui/icons-material": "^7.3.4",
-    "@mui/material": "^7.3.4",
-    "@unisphere/cli": "^1.56.1",
-    "@unisphere/core": "^1.85.0",
-    "@unisphere/notifications-core": "^1.24.0",
-    "@unisphere/notifications-runtime-react": "^1.23.0",
-    "@unisphere/runtime": "^1.84.1",
-    "@unisphere/runtime-js": "^1.83.1",
-    "@unisphere/runtime-react": "^1.78.1",
+    "@kaltura/ds-react-bits": "12.2.3",
+    "@kaltura/ds-react-components": "^12.2.3",
+    "@kaltura/ds-react-icons": "12.2.3",
+    "@kaltura/ds-react-theme": "12.2.3",
+    "@kaltura/ds-react-utils": "12.2.3",
+    "@mui/icons-material": "7.3.6",
+    "@mui/material": "7.3.6",
+    "@unisphere/cli": "1.57.2",
+    "@unisphere/core": "^1.87.1",
+    "@unisphere/notifications-core": "1.24.0",
+    "@unisphere/notifications-runtime-react": "1.23.0",
+    "@unisphere/runtime": "^1.86.1",
+    "@unisphere/runtime-js": "^1.85.1",
+    "@unisphere/runtime-react": "^1.80.1",
     "@unisphere/ui-i18n-react": "^1.69.0",
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0"
+    "react": "19.2.3",
+    "react-dom": "19.2.3",
+    "react-hook-form": "^7.66.0"
   },
   "optionalDependencies": {
-    "@nx/nx-linux-x64-gnu": "22.0.2",
+    "@nx/nx-linux-x64-gnu": "^22.1.3",
     "@rollup/rollup-linux-x64-gnu": "4.22.4"
   },
   "workspaces": [
     "unisphere/**"
   ]
-}
+}