@unisphere/nx 3.21.0 → 3.23.0

package/dist/generators/add-documentation/add-documentation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"add-documentation.d.ts","sourceRoot":"","sources":["../../../src/generators/add-documentation/add-documentation.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,IAAI,EAAiB,MAAM,YAAY,CAAC;AAG7E,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AAY3D,wBAAsB,yBAAyB,CAC7C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,+BAA+B,qCAwJzC;AAED,eAAe,yBAAyB,CAAC"}
+{"version":3,"file":"add-documentation.d.ts","sourceRoot":"","sources":["../../../src/generators/add-documentation/add-documentation.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,IAAI,EAAiB,MAAM,YAAY,CAAC;AAG7E,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AAa3D,wBAAsB,yBAAyB,CAC7C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,+BAA+B,qCA+JzC;AAED,eAAe,yBAAyB,CAAC"}

package/dist/generators/add-documentation/add-documentation.js

@@ -6,6 +6,7 @@ const devkit_1 = require("@nx/devkit");
 const child_process_1 = require("child_process");
 const path = tslib_1.__importStar(require("path"));
 const utils_1 = require("../utils");
+const discover_typedoc_plugins_1 = require("./discover-typedoc-plugins");
 async function getEnquirerPrompt() {
     const enquirer = await import('enquirer');
     return enquirer.prompt || enquirer.default?.prompt || enquirer;
@@ -65,12 +66,18 @@ async function addDocumentationGenerator(tree, options) {
         throw new Error(`Documentation site "${fullDocumentationName}" already exists at ${projectRoot}.\n` +
             'Please choose a different name or remove the existing documentation site first.');
     }
+    // Discover publishable packages for typedoc plugin auto-configuration
+    const discoveredPlugins = (0, discover_typedoc_plugins_1.discoverTypedocPlugins)(tree, projectRoot);
+    if (discoveredPlugins.length > 0) {
+        devkit_1.logger.info(`📚 Auto-discovered ${discoveredPlugins.length} package(s) for TypeDoc API documentation`);
+    }
     // Generate files from template
     const templateVariables = {
         ...(0, utils_1.createNameTransforms)(fullDocumentationName, 'documentationName'),
         ...(0, utils_1.createNameTransforms)(documentationNameAsLowerDashCase, 'experienceName'),
         hasSubName: !!subNameAsLowerDashCase,
         subNameKebab: subNameAsLowerDashCase || '',
+        typedocPluginsConfig: (0, discover_typedoc_plugins_1.buildTypedocPluginsCode)(discoveredPlugins),
         tmpl: '',
     };
     (0, devkit_1.generateFiles)(tree, path.join(__dirname, 'templates'), projectRoot, templateVariables);

package/dist/generators/add-documentation/discover-typedoc-plugins.d.ts

@@ -0,0 +1,23 @@
+import { Tree } from '@nx/devkit';
+interface TypdocPluginConfig {
+    id: string;
+    packageName: string;
+    entryPointsRelative: string;
+    tsconfigRelative: string;
+    out: string;
+}
+/**
+ * Discovers publishable packages from .unisphere config and generates
+ * docusaurus-plugin-typedoc configuration entries.
+ *
+ * Excludes packages whose sourceRoot contains '/local/' (internal packages).
+ * The docsProjectRoot is used to compute relative paths (e.g. "unisphere/documentation/genie").
+ */
+export declare function discoverTypedocPlugins(tree: Tree, docsProjectRoot: string): TypdocPluginConfig[];
+/**
+ * Serialises the discovered plugin configs into a TypeScript source fragment
+ * suitable for injection into docusaurus.config.ts via EJS (<%- typedocPluginsConfig %>).
+ */
+export declare function buildTypedocPluginsCode(plugins: TypdocPluginConfig[]): string;
+export {};
+//# sourceMappingURL=discover-typedoc-plugins.d.ts.map

package/dist/generators/add-documentation/discover-typedoc-plugins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"discover-typedoc-plugins.d.ts","sourceRoot":"","sources":["../../../src/generators/add-documentation/discover-typedoc-plugins.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAoB,MAAM,YAAY,CAAC;AAepD,UAAU,kBAAkB;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,GAAG,EAAE,MAAM,CAAC;CACb;AAsCD;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,IAAI,EACV,eAAe,EAAE,MAAM,GACtB,kBAAkB,EAAE,CAkDtB;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAyB7E"}

package/dist/generators/add-documentation/discover-typedoc-plugins.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.discoverTypedocPlugins = discoverTypedocPlugins;
+exports.buildTypedocPluginsCode = buildTypedocPluginsCode;
+const tslib_1 = require("tslib");
+const devkit_1 = require("@nx/devkit");
+const path = tslib_1.__importStar(require("path"));
+/**
+ * Non-local scopes whose packages should be documented.
+ * Packages under 'local' are internal-only and excluded.
+ */
+const DOCUMENTED_SCOPES = [
+    'kaltura-corp',
+    'kaltura-apps',
+    'kaltura-ui',
+    'kaltura-sdk',
+    'unisphere',
+];
+/**
+ * Returns the npm package name for a given sourceRoot by looking up
+ * tsconfig.base.json paths.
+ * e.g. sourceRoot "unisphere/packages/kaltura-corp/shared-react"
+ *   → "@kaltura-corp/unisphere-genie-shared-react"
+ */
+function findPackageName(tree, sourceRoot) {
+    if (!tree.exists('tsconfig.base.json'))
+        return null;
+    try {
+        const tsconfig = (0, devkit_1.readJson)(tree, 'tsconfig.base.json');
+        const paths = tsconfig?.compilerOptions?.paths ?? {};
+        const expectedPath = `${sourceRoot}/src/index.ts`;
+        for (const [alias, pathList] of Object.entries(paths)) {
+            if (Array.isArray(pathList) && pathList.includes(expectedPath)) {
+                return alias;
+            }
+        }
+    }
+    catch {
+        // ignore
+    }
+    return null;
+}
+/**
+ * Derives a short plugin id from an npm package name.
+ * "@kaltura-corp/unisphere-genie-shared-react" → "unisphere-genie-shared-react"
+ * "@unisphere/genie-types" → "genie-types"
+ */
+function shortName(packageName) {
+    const parts = packageName.split('/');
+    return parts[parts.length - 1];
+}
+/**
+ * Discovers publishable packages from .unisphere config and generates
+ * docusaurus-plugin-typedoc configuration entries.
+ *
+ * Excludes packages whose sourceRoot contains '/local/' (internal packages).
+ * The docsProjectRoot is used to compute relative paths (e.g. "unisphere/documentation/genie").
+ */
+function discoverTypedocPlugins(tree, docsProjectRoot) {
+    if (!tree.exists('.unisphere'))
+        return [];
+    let config;
+    try {
+        config = (0, devkit_1.readJson)(tree, '.unisphere');
+    }
+    catch {
+        return [];
+    }
+    const packages = config?.elements?.packages ?? {};
+    const plugins = [];
+    for (const [, pkgConfig] of Object.entries(packages)) {
+        const sourceRoot = pkgConfig?.sourceRoot;
+        if (!sourceRoot)
+            continue;
+        // Determine the scope directory from the sourceRoot path
+        // Expected: unisphere/packages/<scope>/<name>
+        const parts = sourceRoot.split('/');
+        if (parts.length < 4)
+            continue;
+        const scope = parts[2]; // e.g. "local", "kaltura-corp", "unisphere"
+        if (!DOCUMENTED_SCOPES.includes(scope))
+            continue;
+        const packageName = findPackageName(tree, sourceRoot);
+        if (!packageName) {
+            devkit_1.logger.warn(`⚠️  Could not find npm package name for ${sourceRoot} — skipping in typedoc plugins`);
+            continue;
+        }
+        const short = shortName(packageName);
+        // Relative path from docs site root to the package
+        // docsProjectRoot: "unisphere/documentation/genie"
+        // sourceRoot:       "unisphere/packages/kaltura-corp/shared-react"
+        const relativeBase = path.relative(docsProjectRoot, sourceRoot).replace(/\\/g, '/');
+        plugins.push({
+            id: `api-${short}`,
+            packageName,
+            entryPointsRelative: `${relativeBase}/src/index.ts`,
+            tsconfigRelative: `${relativeBase}/tsconfig.json`,
+            out: `docs/api/${short}/v1`,
+        });
+    }
+    return plugins;
+}
+/**
+ * Serialises the discovered plugin configs into a TypeScript source fragment
+ * suitable for injection into docusaurus.config.ts via EJS (<%- typedocPluginsConfig %>).
+ */
+function buildTypedocPluginsCode(plugins) {
+    if (plugins.length === 0)
+        return '[]';
+    const entries = plugins
+        .map((p) => `\n    // ${p.packageName}\n` +
+        `    [\n` +
+        `      'docusaurus-plugin-typedoc',\n` +
+        `      {\n` +
+        `        id: '${p.id}',\n` +
+        `        entryPoints: ['${p.entryPointsRelative}'],\n` +
+        `        tsconfig: '${p.tsconfigRelative}',\n` +
+        `        out: '${p.out}',\n` +
+        `        readme: 'none',\n` +
+        `        excludePrivate: true,\n` +
+        `        excludeProtected: true,\n` +
+        `        excludeInternal: true,\n` +
+        `        disableSources: true,\n` +
+        `      },\n` +
+        `    ]`)
+        .join(',');
+    return `[${entries},\n  ]`;
+}

package/dist/generators/add-documentation/templates/docusaurus.config.ts.template

@@ -1,6 +1,7 @@
 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 = {
 <% if (hasSubName) { -%>
@@ -47,7 +48,7 @@ const config: Config = {
       } satisfies Preset.Options,
     ],
   ],
-  plugins: [],
+  plugins: typedocPlugins,
   themes: [
     '@docusaurus/theme-mermaid',
     [

package/dist/generators/add-documentation/templates/package.json.template

@@ -12,7 +12,8 @@
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
-    "typecheck": "tsc"
+    "typecheck": "tsc",
+    "discover-plugins": "node plugins/discover-typedoc-plugins.mjs"
   },
   "dependencies": {
     "@docusaurus/core": "^3.8.1",

package/dist/generators/add-documentation/templates/plugins/discover-typedoc-plugins.mjs

@@ -0,0 +1,156 @@
+#!/usr/bin/env node
+/**
+ * Auto-discovers publishable packages from .unisphere config and regenerates
+ * plugins/typedoc-plugins.ts with updated docusaurus-plugin-typedoc entries.
+ *
+ * Run: npm run discover-plugins
+ *
+ * - Reads  <workspace-root>/.unisphere        for packages list
+ * - Reads  <workspace-root>/tsconfig.base.json for npm package names
+ * - Writes plugins/typedoc-plugins.ts
+ *
+ * Packages under the "local" scope are excluded (internal-only packages).
+ */
+
+import { readFileSync, writeFileSync, existsSync } from 'fs';
+import { join, relative, dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+const DOCUMENTED_SCOPES = [
+  'kaltura-corp',
+  'kaltura-apps',
+  'kaltura-ui',
+  'kaltura-sdk',
+  'unisphere',
+];
+
+// This script lives at <docs-site>/plugins/discover-typedoc-plugins.mjs
+const pluginsDir = dirname(fileURLToPath(import.meta.url));
+const docsSiteRoot = join(pluginsDir, '..');
+
+// Walk up from docs site to find workspace root (where .unisphere lives)
+function findWorkspaceRoot(startDir) {
+  let dir = startDir;
+  while (true) {
+    if (existsSync(join(dir, '.unisphere'))) return dir;
+    const parent = dirname(dir);
+    if (parent === dir) {
+      throw new Error(
+        'Could not find .unisphere — are you inside a Unisphere workspace?'
+      );
+    }
+    dir = parent;
+  }
+}
+
+const workspaceRoot = findWorkspaceRoot(docsSiteRoot);
+
+// Parse workspace configs
+const unisphere = JSON.parse(
+  readFileSync(join(workspaceRoot, '.unisphere'), 'utf-8')
+);
+const tsconfig = JSON.parse(
+  readFileSync(join(workspaceRoot, 'tsconfig.base.json'), 'utf-8')
+);
+const tsconfigPaths = tsconfig?.compilerOptions?.paths ?? {};
+const packages = unisphere?.elements?.packages ?? {};
+
+// Build reverse lookup: "sourceRoot/src/index.ts" → npm package name
+const pathToPackageName = {};
+for (const [pkgName, paths] of Object.entries(tsconfigPaths)) {
+  if (Array.isArray(paths)) {
+    for (const p of paths) {
+      pathToPackageName[p] = pkgName;
+    }
+  }
+}
+
+function findPackageName(sourceRoot) {
+  return pathToPackageName[`${sourceRoot}/src/index.ts`] ?? null;
+}
+
+function shortName(pkgName) {
+  return pkgName.split('/').pop();
+}
+
+// Discover plugins
+const discovered = [];
+for (const [, pkgConfig] of Object.entries(packages)) {
+  const sourceRoot = pkgConfig?.sourceRoot;
+  if (!sourceRoot) continue;
+
+  // Expected sourceRoot format: unisphere/packages/<scope>/<name>
+  const parts = sourceRoot.split('/');
+  if (parts.length < 4) continue;
+  const scope = parts[2];
+
+  if (!DOCUMENTED_SCOPES.includes(scope)) continue;
+
+  const pkgName = findPackageName(sourceRoot);
+  if (!pkgName) {
+    console.warn(`⚠️  No tsconfig path found for ${sourceRoot} — skipping`);
+    continue;
+  }
+
+  const short = shortName(pkgName);
+  // Relative path from docs site root to the package folder
+  const relBase = relative(
+    docsSiteRoot,
+    join(workspaceRoot, sourceRoot)
+  ).replace(/\\/g, '/');
+
+  discovered.push({
+    id: `api-${short}`,
+    packageName: pkgName,
+    entryPoints: `${relBase}/src/index.ts`,
+    tsconfig: `${relBase}/tsconfig.json`,
+    out: `docs/api/${short}/v1`,
+  });
+}
+
+// Serialise to TypeScript
+function pluginsToTs(plugins) {
+  if (plugins.length === 0) return '[]';
+
+  const entries = plugins
+    .map(
+      (p) =>
+        `  // ${p.packageName}\n` +
+        `  [\n` +
+        `    'docusaurus-plugin-typedoc',\n` +
+        `    {\n` +
+        `      id: '${p.id}',\n` +
+        `      entryPoints: ['${p.entryPoints}'],\n` +
+        `      tsconfig: '${p.tsconfig}',\n` +
+        `      out: '${p.out}',\n` +
+        `      readme: 'none',\n` +
+        `      excludePrivate: true,\n` +
+        `      excludeProtected: true,\n` +
+        `      excludeInternal: true,\n` +
+        `      disableSources: true,\n` +
+        `    },\n` +
+        `  ]`
+    )
+    .join(',\n');
+
+  return `[\n${entries},\n]`;
+}
+
+const content =
+  `// Auto-generated by plugins/discover-typedoc-plugins.mjs\n` +
+  `// Run "npm run discover-plugins" to regenerate\n` +
+  `\n` +
+  `// eslint-disable-next-line @typescript-eslint/no-explicit-any\n` +
+  `const typedocPlugins: any[] = ${pluginsToTs(discovered)};\n` +
+  `\n` +
+  `export default typedocPlugins;\n`;
+
+const outPath = join(pluginsDir, 'typedoc-plugins.ts');
+writeFileSync(outPath, content, 'utf-8');
+
+console.log(
+  `✅ Discovered ${discovered.length} package(s) → plugins/typedoc-plugins.ts`
+);
+for (const p of discovered) {
+  console.log(`   • ${p.packageName} → ${p.out}`);
+}

package/dist/generators/add-documentation/templates/plugins/typedoc-plugins.ts.template

@@ -0,0 +1,7 @@
+// Auto-generated by plugins/discover-typedoc-plugins.mjs
+// Run "npm run discover-plugins" to regenerate
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const typedocPlugins: any[] = <%- typedocPluginsConfig %>;
+
+export default typedocPlugins;

package/dist/generators/add-documentation/templates/src/theme/Navbar/Content/index.tsx

@@ -67,6 +67,14 @@ const navIcons: Record<string, ReactNode> = {
       <circle cx="12" cy="12" r="10" />
     </svg>
   ),
+  'Examples': (
+    <svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round">
+      <rect x="3" y="3" width="7" height="7" />
+      <rect x="14" y="3" width="7" height="7" />
+      <rect x="3" y="14" width="7" height="7" />
+      <rect x="14" y="14" width="7" height="7" />
+    </svg>
+  ),
 };
 
 function NavbarItemWithIcon({item, index}: {item: NavbarItemConfig; index: number}): ReactNode {

package/dist/generators/change-package-scope/change-package-scope.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Change Package Scope Generator
+ *
+ * Changes a package's npm scope by:
+ * 1. Validating the package exists and target scope is valid
+ * 2. Parsing the package.json name to extract current scope and package name
+ * 3. Using Nx's built-in move generator to handle:
+ *    - Directory and file moves
+ *    - Import statement updates across the workspace
+ *    - TypeScript path mappings in tsconfig.base.json
+ * 4. Performing Unisphere-specific cleanup:
+ *    - Updating .unisphere configuration
+ *    - Ensuring package.json name matches conventions
+ *    - Updating package-lock.json path keys
+ *    - Updating vite.config.ts cache directory paths
+ *    - Updating project.json lintFilePatterns and comments
+ *    - Updating README.md with new package name
+ */
+import { Tree } from '@nx/devkit';
+import { ChangePackageScopeGeneratorSchema } from './schema';
+export declare function changePackageScopeGenerator(tree: Tree, options: ChangePackageScopeGeneratorSchema): Promise<void>;
+export default changePackageScopeGenerator;
+//# sourceMappingURL=change-package-scope.d.ts.map

package/dist/generators/change-package-scope/change-package-scope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"change-package-scope.d.ts","sourceRoot":"","sources":["../../../src/generators/change-package-scope/change-package-scope.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EACL,IAAI,EAIL,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,iCAAiC,EAAE,MAAM,UAAU,CAAC;AAiW7D,wBAAsB,2BAA2B,CAC/C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,iCAAiC,iBAoH3C;AAED,eAAe,2BAA2B,CAAC"}