@unisphere/nx 4.15.8 → 5.0.0

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

@@ -1,145 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addDocumentationGenerator = addDocumentationGenerator;
-const tslib_1 = require("tslib");
-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");
-function validateOptions(options) {
-    if (options.subName) {
-        const subNamePattern = /^[a-zA-Z][a-zA-Z0-9\-\s]*$/;
-        if (!subNamePattern.test(options.subName)) {
-            throw new Error(`Invalid value '${options.subName}' for option 'subName'\n` +
-                `  Pattern: ^[a-zA-Z][a-zA-Z0-9\\-\\s]*$\n` +
-                `  Received: ${options.subName}`);
-        }
-    }
-}
-async function addDocumentationGenerator(tree, options) {
-    // Validate options
-    validateOptions(options);
-    // Validate .unisphere configuration exists
-    const unisphereConfig = (0, utils_1.validateUnisphereConfig)(tree);
-    // Check workspace pattern for documentation apps
-    const rootPackageJsonPath = 'package.json';
-    if (tree.exists(rootPackageJsonPath)) {
-        const packageJson = JSON.parse(tree.read(rootPackageJsonPath, 'utf-8') || '{}');
-        const workspaces = packageJson.workspaces || [];
-        // Check if using the old catch-all pattern that doesn't work with documentation apps
-        const hasCatchAllPattern = workspaces.includes('unisphere/**');
-        if (hasCatchAllPattern) {
-            throw new Error('Documentation sites require @unisphere/nx version 3.1.0 or higher.\n\n' +
-                'Your workspace is using an old npm workspaces pattern that prevents documentation sites ' +
-                'from having their own node_modules.\n\n' +
-                'Please upgrade by running:\n' +
-                '  npx nx migrate @unisphere/nx@latest\n' +
-                '  npx nx migrate --run-migrations\n\n' +
-                'This will update your workspace pattern to support documentation sites.');
-        }
-    }
-    // Resolve experience name from .unisphere config
-    const documentationName = unisphereConfig.name;
-    const documentationNameAsLowerDashCase = (0, devkit_1.names)(documentationName).fileName;
-    devkit_1.logger.info(`Using experience name: ${documentationNameAsLowerDashCase}`);
-    // Build the full documentation name
-    const subNameAsLowerDashCase = options.subName ? (0, devkit_1.names)(options.subName).fileName : null;
-    const fullDocumentationName = subNameAsLowerDashCase
-        ? `${documentationNameAsLowerDashCase}-${subNameAsLowerDashCase}`
-        : documentationNameAsLowerDashCase;
-    const projectRoot = `unisphere/documentation/${fullDocumentationName}`;
-    // Check if name already exists across all element types in .unisphere
-    (0, utils_1.validateElementNameUnique)(tree, fullDocumentationName, 'documentation');
-    // Check if documentation already exists on filesystem
-    if (tree.exists(projectRoot)) {
-        const docType = subNameAsLowerDashCase ? `sub-documentation "${subNameAsLowerDashCase}"` : 'main documentation';
-        throw new Error(`Documentation site already exists: ${docType} at ${projectRoot}.\n` +
-            'Please choose a different sub-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);
-    // Write .gitignore explicitly — npm strips .gitignore files from published packages
-    tree.write(`${projectRoot}/.gitignore`, `# Dependencies
-node_modules
-
-# Production
-build
-
-# Generated files
-.docusaurus
-.cache-loader
-`);
-    // Update .unisphere configuration
-    (0, utils_1.updateUnisphereConfig)(tree, 'documentation', fullDocumentationName, {
-        sourceRoot: projectRoot,
-    });
-    // Add documentation folder to .nxignore to prevent NX from scanning it
-    // Docusaurus has its own node_modules which can slow down NX
-    const nxIgnorePath = '.nxignore';
-    const ignoreEntry = `${projectRoot}/node_modules`;
-    let nxIgnoreContent = '';
-    if (tree.exists(nxIgnorePath)) {
-        nxIgnoreContent = tree.read(nxIgnorePath, 'utf-8') || '';
-    }
-    if (!nxIgnoreContent.includes(ignoreEntry)) {
-        const newContent = nxIgnoreContent
-            ? `${nxIgnoreContent.trimEnd()}\n\n# Documentation site (Docusaurus) - has its own node_modules\n${ignoreEntry}\n`
-            : `# Documentation site (Docusaurus) - has its own node_modules\n${ignoreEntry}\n`;
-        tree.write(nxIgnorePath, newContent);
-    }
-    // Copy .npmrc from workspace root so npm install can authenticate with private registries
-    const npmrcPath = '.npmrc';
-    if (tree.exists(npmrcPath)) {
-        const npmrcContent = tree.read(npmrcPath, 'utf-8');
-        if (npmrcContent) {
-            tree.write(`${projectRoot}/.npmrc`, npmrcContent);
-        }
-    }
-    await (0, devkit_1.formatFiles)(tree);
-    devkit_1.logger.info('');
-    devkit_1.logger.info('Documentation site generated successfully!');
-    devkit_1.logger.info('');
-    devkit_1.logger.info(`Name: ${fullDocumentationName}`);
-    devkit_1.logger.info(`Type: Documentation Site (Docusaurus)`);
-    devkit_1.logger.info(`Location: ${projectRoot}`);
-    devkit_1.logger.info('');
-    if (options.skipInstall) {
-        devkit_1.logger.info('Skipping npm install (--skip-install).');
-        devkit_1.logger.info('');
-        devkit_1.logger.info(`To install: cd ${projectRoot} && npm install`);
-        devkit_1.logger.info(`To serve:   npx unisphere documentation serve ${fullDocumentationName}`);
-        devkit_1.logger.info(`To build:   npx unisphere documentation build ${fullDocumentationName}`);
-        devkit_1.logger.info('');
-        return;
-    }
-    // Return callback to run npm install after the tree is flushed to disk
-    const workspaceRoot = tree.root;
-    return () => {
-        const fullProjectPath = path.join(workspaceRoot, projectRoot);
-        devkit_1.logger.info('Installing dependencies...');
-        devkit_1.logger.info('');
-        (0, child_process_1.execSync)('npm install', {
-            cwd: fullProjectPath,
-            stdio: 'inherit',
-        });
-        devkit_1.logger.info('');
-        devkit_1.logger.info(`To serve: npx unisphere documentation serve ${fullDocumentationName}`);
-        devkit_1.logger.info(`To build: npx unisphere documentation build ${fullDocumentationName}`);
-        devkit_1.logger.info('');
-    };
-}
-exports.default = addDocumentationGenerator;

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

@@ -1,23 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

@@ -1,128 +0,0 @@
-"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/schema.d.ts

@@ -1,4 +0,0 @@
-export interface AddDocumentationGeneratorSchema {
-  subName?: string;
-  skipInstall?: boolean;
-}

package/dist/generators/add-documentation/schema.json

@@ -1,20 +0,0 @@
-{
-  "$schema": "https://json-schema.org/schema",
-  "$id": "AddDocumentation",
-  "title": "Add Documentation Generator",
-  "type": "object",
-  "properties": {
-    "subName": {
-      "type": "string",
-      "description": "Sub-name for the documentation site. If not provided, creates the main experience-level documentation.",
-      "pattern": "^[a-zA-Z][a-zA-Z0-9\\-\\s]*$"
-    },
-    "skipInstall": {
-      "type": "boolean",
-      "description": "Internal: skip npm install (used by unisphere create)",
-      "default": false,
-      "x-internal": true
-    }
-  },
-  "required": []
-}

package/dist/generators/add-documentation/templates/babel.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
-};

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

@@ -1,9 +0,0 @@
----
-id: overview
-sidebar_position: 1
-sidebar_label: Overview
----
-
-# Changelog
-
-Release notes and version history will be documented here.

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

@@ -1,9 +0,0 @@
----
-id: overview
-sidebar_position: 1
-sidebar_label: Overview
----
-
-# Documentation
-
-Welcome to the documentation site. This portal covers everything you need to build, configure, and deploy your application.

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

@@ -1,9 +0,0 @@
----
-id: overview
-sidebar_position: 1
-sidebar_label: Overview
----
-
-# API Reference
-
-API documentation will be added here.

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

@@ -1,134 +0,0 @@
-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) { -%>
-  title: '<%= experienceName__humanReadable %> | <%= subNameKebab %> Documentation',
-<% } else { -%>
-  title: '<%= experienceName__humanReadable %> Documentation',
-<% } -%>
-  tagline: '',
-  favicon: 'img/favicon.ico',
-
-  url: 'https://docs.kaltura.com',
-<% if (hasSubName) { -%>
-  baseUrl: '/_/<%= experienceName__lowerDashCase %>/<%= subNameKebab %>',
-<% } else { -%>
-  baseUrl: '/<%= experienceName__lowerDashCase %>',
-<% } -%>
-
-  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: {
-<% if (hasSubName) { -%>
-      title: '<%= experienceName__humanReadable %> | <%= subNameKebab %>',
-<% } else { -%>
-      title: '<%= experienceName__humanReadable %>',
-<% } -%>
-      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;

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

@@ -1,59 +0,0 @@
-{
-  "name": "<%= documentationName__lowerDashCase %>",
-  "version": "0.0.0",
-  "private": true,
-  "scripts": {
-    "docusaurus": "docusaurus",
-    "start": "docusaurus start",
-    "build": "docusaurus build",
-    "clear": "docusaurus clear",
-    "serve": "docusaurus serve",
-    "write-heading-ids": "docusaurus write-heading-ids",
-    "typecheck": "tsc",
-    "discover-plugins": "node plugins/discover-typedoc-plugins.mjs"
-  },
-  "dependencies": {
-    "@docusaurus/core": "^3.8.1",
-    "@docusaurus/preset-classic": "^3.8.1",
-    "@docusaurus/theme-mermaid": "^3.8.1",
-    "@easyops-cn/docusaurus-search-local": "^0.55.1",
-    "@heroicons/react": "^2.2.0",
-    "@mdx-js/react": "^3.0.0",
-    "@unisphere/notifications-core": "^1.24.0",
-    "@unisphere/runtime-js": "^1.83.0",
-    "autoprefixer": "^10.4.20",
-    "clsx": "^2.0.0",
-    "postcss": "^8.4.41",
-    "prism-react-renderer": "^2.3.0",
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0",
-    "tailwindcss": "^3.4.10"
-  },
-  "devDependencies": {
-    "@docusaurus/module-type-aliases": "^3.8.1",
-    "@docusaurus/tsconfig": "^3.8.1",
-    "@docusaurus/types": "^3.8.1",
-    "docusaurus-plugin-typedoc": "^1.4.2",
-    "typedoc": "^0.28.17",
-    "typedoc-plugin-markdown": "^4.8.0",
-    "typescript": "~5.2.2"
-  },
-  "browserslist": {
-    "production": [
-      ">0.5%",
-      "not dead",
-      "not op_mini all"
-    ],
-    "development": [
-      "last 3 chrome version",
-      "last 3 firefox version",
-      "last 5 safari version"
-    ]
-  },
-  "engines": {
-    "node": ">=18.0"
-  },
-  "overrides": {
-    "webpack": "5.105.4"
-  }
-}