@unisphere/nx 4.5.8 → 4.7.0

package/dist/migrations/4-6-0/templates/navbar-content.tsx

@@ -0,0 +1,103 @@
+import React, {type ReactNode} from 'react';
+import clsx from 'clsx';
+import {
+  useThemeConfig,
+  ErrorCauseBoundary,
+  ThemeClassNames,
+} from '@docusaurus/theme-common';
+import {
+  splitNavbarItems,
+  useNavbarMobileSidebar,
+} from '@docusaurus/theme-common/internal';
+import NavbarItem, {type Props as NavbarItemConfig} from '@theme/NavbarItem';
+import NavbarColorModeToggle from '@theme/Navbar/ColorModeToggle';
+import SearchBar from '@theme/SearchBar';
+import NavbarMobileSidebarToggle from '@theme/Navbar/MobileSidebar/Toggle';
+import NavbarSearch from '@theme/Navbar/Search';
+import NavbarLogo from '@theme/Navbar/Logo';
+
+import styles from './styles.module.css';
+
+function useNavbarItems() {
+  return useThemeConfig().navbar.items as NavbarItemConfig[];
+}
+
+function NavbarItems({items}: {items: NavbarItemConfig[]}): ReactNode {
+  return (
+    <>
+      {items.map((item, i) => (
+        <ErrorCauseBoundary
+          key={i}
+          onError={(error) =>
+            new Error(
+              `A theme navbar item failed to render.
+Please double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:
+${JSON.stringify(item, null, 2)}`,
+              {cause: error},
+            )
+          }>
+          <NavbarItem {...item} />
+        </ErrorCauseBoundary>
+      ))}
+    </>
+  );
+}
+
+function NavbarContentLayout({
+  left,
+  right,
+}: {
+  left: ReactNode;
+  right: ReactNode;
+}) {
+  return (
+    <div className="navbar__inner">
+      <div
+        className={clsx(
+          ThemeClassNames.layout.navbar.containerLeft,
+          'navbar__items',
+        )}>
+        {left}
+      </div>
+      <div
+        className={clsx(
+          ThemeClassNames.layout.navbar.containerRight,
+          'navbar__items navbar__items--right',
+        )}>
+        {right}
+      </div>
+    </div>
+  );
+}
+
+export default function NavbarContent(): ReactNode {
+  const mobileSidebar = useNavbarMobileSidebar();
+
+  const items = useNavbarItems();
+  const [leftItems, rightItems] = splitNavbarItems(items);
+
+  const searchBarItem = items.find((item) => item.type === 'search');
+
+  return (
+    <NavbarContentLayout
+      left={
+        <>
+          {!mobileSidebar.disabled && <NavbarMobileSidebarToggle />}
+          <NavbarLogo />
+          <NavbarItems items={leftItems} />
+        </>
+      }
+      right={
+        <>
+          <NavbarItems items={rightItems} />
+          <NavbarColorModeToggle className={styles.colorModeToggle} />
+          {!searchBarItem && (
+            <NavbarSearch>
+              <SearchBar />
+            </NavbarSearch>
+          )}
+        </>
+      }
+    />
+  );
+}

package/dist/migrations/4-6-0/templates/sidebars.ts.template

@@ -0,0 +1,9 @@
+import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
+
+const sidebars: SidebarsConfig = {
+  documentations: [{ type: 'autogenerated', dirName: '.' }],
+  reference: [{ type: 'autogenerated', dirName: '.' }],
+  changelog: [{ type: 'autogenerated', dirName: '.' }],
+};
+
+export default sidebars;

package/dist/migrations/4-6-0/update-documentation-structure.d.ts

@@ -0,0 +1,3 @@
+import { Tree } from '@nx/devkit';
+export default function update(tree: Tree): Promise<void>;
+//# sourceMappingURL=update-documentation-structure.d.ts.map

package/dist/migrations/4-6-0/update-documentation-structure.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-documentation-structure.d.ts","sourceRoot":"","sources":["../../../src/migrations/4-6-0/update-documentation-structure.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAwC,MAAM,YAAY,CAAC;AA0KxE,wBAA8B,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CA8F9D"}

package/dist/migrations/4-6-0/update-documentation-structure.js

@@ -0,0 +1,238 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = update;
+const devkit_1 = require("@nx/devkit");
+const fs_1 = require("fs");
+const path_1 = require("path");
+function moveDirectory(tree, from, to) {
+    if (!tree.exists(from))
+        return;
+    const children = tree.children(from);
+    for (const child of children) {
+        const childPath = `${from}/${child}`;
+        if (tree.isFile(childPath)) {
+            const content = tree.read(childPath);
+            if (content) {
+                tree.write(`${to}/${child}`, content);
+            }
+            tree.delete(childPath);
+        }
+        else {
+            moveDirectory(tree, childPath, `${to}/${child}`);
+        }
+    }
+}
+function generateDocusaurusConfig(experienceName, hasSubName, subNameKebab) {
+    const humanReadable = (0, devkit_1.names)(experienceName).className.replace(/([a-z])([A-Z])/g, '$1 $2');
+    const lowerDashCase = (0, devkit_1.names)(experienceName).fileName;
+    const title = hasSubName
+        ? `${humanReadable} | ${subNameKebab} Documentation`
+        : `${humanReadable} Documentation`;
+    const navbarTitle = hasSubName
+        ? `${humanReadable} | ${subNameKebab}`
+        : humanReadable;
+    const baseUrl = hasSubName
+        ? `/_/${lowerDashCase}/${subNameKebab}`
+        : `/${lowerDashCase}`;
+    return `import { themes as prismThemes } from 'prism-react-renderer';
+import type { Config } from '@docusaurus/types';
+import type * as Preset from '@docusaurus/preset-classic';
+import typedocPlugins from './plugins/typedoc-plugins';
+
+const config: Config = {
+  title: '${title}',
+  tagline: '',
+  favicon: 'img/favicon.ico',
+
+  url: 'https://docs.kaltura.com',
+  baseUrl: '${baseUrl}',
+
+  onBrokenLinks: 'warn',
+  onBrokenMarkdownLinks: 'warn',
+
+  noIndex: true,
+
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  presets: [
+    [
+      'classic',
+      {
+        docs: false,
+        blog: false,
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+        sitemap: {
+          ignorePatterns: ['**'],
+        },
+      } satisfies Preset.Options,
+    ],
+  ],
+  plugins: [
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        path: 'docs/documentations',
+        routeBasePath: 'documentations',
+        sidebarPath: './sidebars.ts',
+      },
+    ],
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'reference',
+        path: 'docs/reference',
+        routeBasePath: 'reference',
+        sidebarPath: './sidebars.ts',
+      },
+    ],
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'changelog',
+        path: 'docs/changelog',
+        routeBasePath: 'changelog',
+        sidebarPath: './sidebars.ts',
+      },
+    ],
+    ...typedocPlugins,
+  ],
+  themes: [
+    '@docusaurus/theme-mermaid',
+    [
+      '@easyops-cn/docusaurus-search-local',
+      {
+        hashed: true,
+        indexBlog: false,
+        forceIgnoreNoIndex: true,
+        docsRouteBasePath: ['documentations', 'reference', 'changelog'],
+      },
+    ],
+  ],
+  markdown: {
+    mermaid: true,
+  },
+  themeConfig: {
+    colorMode: {
+      defaultMode: 'light',
+      disableSwitch: false,
+      respectPrefersColorScheme: true,
+    },
+    image: 'img/social-card.png',
+    navbar: {
+      title: '${navbarTitle}',
+      logo: {
+        alt: 'Logo',
+        src: 'img/logo.svg',
+        srcDark: 'img/logo_dark.svg',
+      },
+      items: [
+        {
+          to: 'documentations/overview',
+          label: 'Documentations',
+          position: 'left',
+        },
+        {
+          to: 'reference/overview',
+          label: 'Reference',
+          position: 'left',
+        },
+        {
+          to: 'changelog/overview',
+          label: 'Changelog',
+          position: 'left',
+        },
+      ],
+    },
+    prism: {
+      theme: prismThemes.github,
+      darkTheme: prismThemes.dracula,
+    },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;
+`;
+}
+async function update(tree) {
+    devkit_1.logger.info('🔄 Updating documentation sites to new multi-plugin structure...');
+    const docsBasePath = 'unisphere/documentation';
+    if (!tree.exists(docsBasePath)) {
+        devkit_1.logger.info('ℹ️ No documentation sites found, skipping');
+        return;
+    }
+    const docsSites = tree.children(docsBasePath);
+    if (docsSites.length === 0) {
+        devkit_1.logger.info('ℹ️ No documentation sites found, skipping');
+        return;
+    }
+    // Read .unisphere config for experience name
+    let experienceName = '';
+    if (tree.exists('.unisphere')) {
+        try {
+            const config = (0, devkit_1.readJson)(tree, '.unisphere');
+            experienceName = config.name || '';
+        }
+        catch {
+            devkit_1.logger.warn('⚠️ Could not read .unisphere config');
+        }
+    }
+    // Read migration template files
+    const sidebarsContent = (0, fs_1.readFileSync)((0, path_1.join)(__dirname, 'templates', 'sidebars.ts.template'), 'utf-8');
+    const cssContent = (0, fs_1.readFileSync)((0, path_1.join)(__dirname, 'templates', 'custom.css'), 'utf-8');
+    const navbarContent = (0, fs_1.readFileSync)((0, path_1.join)(__dirname, 'templates', 'navbar-content.tsx'), 'utf-8');
+    const navbarStylesContent = (0, fs_1.readFileSync)((0, path_1.join)(__dirname, 'templates', 'navbar-content-styles.module.css'), 'utf-8');
+    let updatedCount = 0;
+    for (const site of docsSites) {
+        const sitePath = `${docsBasePath}/${site}`;
+        try {
+            // Determine if this is a sub-documentation site
+            const experienceNameLower = experienceName ? (0, devkit_1.names)(experienceName).fileName : '';
+            const hasSubName = experienceNameLower !== '' && site !== experienceNameLower;
+            const subNameKebab = hasSubName ? site.replace(`${experienceNameLower}-`, '') : '';
+            // 1. Move docs/getting-started → docs/documentations
+            const gettingStartedPath = `${sitePath}/docs/getting-started`;
+            const documentationsPath = `${sitePath}/docs/documentations`;
+            if (tree.exists(gettingStartedPath) && !tree.exists(documentationsPath)) {
+                moveDirectory(tree, gettingStartedPath, documentationsPath);
+                devkit_1.logger.info(`  ✅ Moved docs/getting-started → docs/documentations in ${site}`);
+            }
+            // 2. Move docs/api → docs/reference
+            const apiPath = `${sitePath}/docs/api`;
+            const referencePath = `${sitePath}/docs/reference`;
+            if (tree.exists(apiPath) && !tree.exists(referencePath)) {
+                moveDirectory(tree, apiPath, referencePath);
+                devkit_1.logger.info(`  ✅ Moved docs/api → docs/reference in ${site}`);
+            }
+            // 3. Update docusaurus.config.ts
+            const configPath = `${sitePath}/docusaurus.config.ts`;
+            const nameToUse = experienceName || site;
+            const configContent = generateDocusaurusConfig(nameToUse, hasSubName, subNameKebab);
+            tree.write(configPath, configContent);
+            devkit_1.logger.info(`  ✅ Updated docusaurus.config.ts in ${site}`);
+            // 4. Update sidebars.ts
+            tree.write(`${sitePath}/sidebars.ts`, sidebarsContent);
+            devkit_1.logger.info(`  ✅ Updated sidebars.ts in ${site}`);
+            // 5. Update src/css/custom.css
+            tree.write(`${sitePath}/src/css/custom.css`, cssContent);
+            devkit_1.logger.info(`  ✅ Updated src/css/custom.css in ${site}`);
+            // 6. Update src/theme/Navbar/Content/index.tsx
+            tree.write(`${sitePath}/src/theme/Navbar/Content/index.tsx`, navbarContent);
+            devkit_1.logger.info(`  ✅ Updated Navbar Content in ${site}`);
+            // 7. Update src/theme/Navbar/Content/styles.module.css
+            tree.write(`${sitePath}/src/theme/Navbar/Content/styles.module.css`, navbarStylesContent);
+            devkit_1.logger.info(`  ✅ Updated Navbar Content styles in ${site}`);
+            updatedCount++;
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+            devkit_1.logger.warn(`⚠️ Failed to update ${site}: ${errorMessage}`);
+        }
+    }
+    devkit_1.logger.info(`✅ Updated ${updatedCount} documentation site(s) to new structure`);
+    await (0, devkit_1.formatFiles)(tree);
+}

package/dist/migrations/4-6-1/add-documentation-workflow.d.ts

@@ -0,0 +1,3 @@
+import { Tree } from '@nx/devkit';
+export default function update(tree: Tree): Promise<void>;
+//# sourceMappingURL=add-documentation-workflow.d.ts.map

package/dist/migrations/4-6-1/add-documentation-workflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-documentation-workflow.d.ts","sourceRoot":"","sources":["../../../src/migrations/4-6-1/add-documentation-workflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAoB,MAAM,YAAY,CAAC;AAWpD,wBAA8B,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAkD9D"}

package/dist/migrations/4-6-1/add-documentation-workflow.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = update;
+const devkit_1 = require("@nx/devkit");
+const fs_1 = require("fs");
+const path_1 = require("path");
+async function update(tree) {
+    devkit_1.logger.info('🔄 Adding GitHub documentation workflow...');
+    if (!tree.exists('.unisphere')) {
+        devkit_1.logger.info('⏭️ No .unisphere file found, skipping');
+        return;
+    }
+    const config = (0, devkit_1.readJson)(tree, '.unisphere');
+    const experienceName = config.name;
+    if (!experienceName) {
+        devkit_1.logger.info('⏭️ No experience name found in .unisphere, skipping');
+        return;
+    }
+    if (!config.elements?.documentation || Object.keys(config.elements.documentation).length === 0) {
+        devkit_1.logger.info('⏭️ No documentation elements found in .unisphere, skipping');
+        return;
+    }
+    if (!tree.exists('.github')) {
+        tree.write('.github/.gitkeep', '');
+        devkit_1.logger.info('✅ Created .github directory');
+    }
+    if (!tree.exists('.github/workflows')) {
+        tree.write('.github/workflows/.gitkeep', '');
+        devkit_1.logger.info('✅ Created .github/workflows directory');
+    }
+    try {
+        const workflowPath = '.github/workflows/documentation.yml';
+        const templatePath = (0, path_1.join)(__dirname, 'templates', 'documentation-workflow.template');
+        const templateContent = (0, fs_1.readFileSync)(templatePath, 'utf-8');
+        const workflowContent = templateContent.replace(/__EXPERIENCE_NAME__/g, experienceName);
+        const workflowExists = tree.exists(workflowPath);
+        tree.write(workflowPath, workflowContent);
+        if (workflowExists) {
+            devkit_1.logger.info(`✅ Updated ${workflowPath}`);
+        }
+        else {
+            devkit_1.logger.info(`✅ Created ${workflowPath}`);
+        }
+    }
+    catch (error) {
+        devkit_1.logger.error(`❌ Failed to add documentation workflow: ${error?.message || 'Unknown error'}`);
+        throw error;
+    }
+}

package/dist/migrations/4-6-1/templates/documentation-workflow.template

@@ -0,0 +1,68 @@
+name: Documentations
+
+on:
+  workflow_dispatch:
+
+permissions:
+  id-token: write
+  contents: write
+  packages: write
+
+jobs:
+  deploy-to-aws:
+    runs-on:
+      - codebuild-ovp-unisphere-runner-${{ github.run_id }}-${{ github.attempt }}
+    strategy:
+      matrix:
+        envs_regions:
+          - env: nvp1
+            accountid: "583352821080"
+            region: us-east-1
+
+    steps:
+      - name: Checkout Repo at specific commit
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+
+      - 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: cd unisphere/documentation/__EXPERIENCE_NAME__ && npm ci --include=optional --ignore-scripts
+        env:
+          KALTURA_JFROG_TOKEN: ${{ steps.setup-jfrog.outputs.oidc-token }}
+
+      - name: Build documentation
+        run: cd unisphere/documentation/__EXPERIENCE_NAME__ && npm run build
+        env:
+          DOCUSAURUS_URL: 'https://docs.kaltura.ai/'
+          DOCUSAURUS_BASE_URL: '/__EXPERIENCE_NAME__/'
+
+      - name: Configure AWS credentials
+        run: |
+          aws sts assume-role \
+            --role-arn arn:aws:iam::${{ matrix.envs_regions.accountid }}:role/${{ matrix.envs_regions.env }}-unisphere-content-role \
+            --role-session-name github-actions-deployment \
+            --query 'Credentials.[AccessKeyId,SecretAccessKey,SessionToken]' \
+            --output text | \
+          while read access_key secret_key session_token; do
+            echo "AWS_ACCESS_KEY_ID=$access_key" >> $GITHUB_ENV
+            echo "AWS_SECRET_ACCESS_KEY=$secret_key" >> $GITHUB_ENV
+            echo "AWS_SESSION_TOKEN=$session_token" >> $GITHUB_ENV
+          done
+          echo "AWS_DEFAULT_REGION=${{ matrix.envs_regions.region }}" >> $GITHUB_ENV
+
+      - name: Sync dist/documentations to S3
+        run: |
+          aws s3 sync unisphere/documentation/__EXPERIENCE_NAME__/build s3://nvp1-kaltura-documentation/__EXPERIENCE_NAME__ \
+            --region ${{ matrix.envs_regions.region }} \
+            --delete

package/migrations.json

@@ -434,6 +434,22 @@
       "cli": {
         "postUpdateMessage": "✅ Security audit gate configured: allowlist seeded and CI step added"
       }
+    },
+    "4-6-0-update-documentation-structure": {
+      "version": "4.6.0",
+      "description": "Updates documentation sites to new multi-plugin structure with Documentations/Reference/Changelog tabs",
+      "factory": "./dist/migrations/4-6-0/update-documentation-structure.js",
+      "cli": {
+        "postUpdateMessage": "✅ Documentation sites updated to new structure"
+      }
+    },
+    "4-6-1-add-documentation-workflow": {
+      "version": "4.6.1",
+      "description": "Adds .github/workflows/documentation.yml for deploying documentation sites to AWS",
+      "factory": "./dist/migrations/4-6-1/add-documentation-workflow.js",
+      "cli": {
+        "postUpdateMessage": "✅ GitHub documentation workflow added"
+      }
     }
   },
   "packageJsonUpdates": {
@@ -745,6 +761,17 @@
           "alwaysAddToPackageJson": false
         }
       }
+    },
+    "4.7.0": {
+      "version": "4.7.0",
+      "cli": "nx",
+      "postUpdateMessage": "🎉 Migration to @unisphere/nx 4.7.0 completed successfully!",
+      "packages": {
+        "@unisphere/cli": {
+          "version": "5.1.0",
+          "alwaysAddToPackageJson": false
+        }
+      }
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unisphere/nx",
-  "version": "4.5.8",
+  "version": "4.7.0",
   "private": false,
   "main": "./dist/index.js",
   "module": "./dist/index.js",

package/dist/generators/add-documentation/templates/docs/getting-started/overview.md

@@ -1,8 +0,0 @@
----
-sidebar_position: 1
-title: Overview
----
-
-# Getting Started
-
-Welcome to the documentation site. Start here to learn the basics.