@unisphere/nx 3.2.3 → 3.2.4

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

@@ -1 +1 @@
-{"version":3,"file":"add-application.d.ts","sourceRoot":"","sources":["../../../src/generators/add-application/add-application.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,IAAI,EAAsC,MAAM,YAAY,CAAC;AAElG,OAAO,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAC;AAkHzD,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,6BAA6B,uBAoIvC;AAED,eAAe,uBAAuB,CAAC"}
+{"version":3,"file":"add-application.d.ts","sourceRoot":"","sources":["../../../src/generators/add-application/add-application.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,IAAI,EAAsC,MAAM,YAAY,CAAC;AAIlG,OAAO,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAC;AAkHzD,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,6BAA6B,uBAgQvC;AAED,eAAe,uBAAuB,CAAC"}

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

@@ -4,6 +4,8 @@ exports.addApplicationGenerator = addApplicationGenerator;
 const tslib_1 = require("tslib");
 const devkit_1 = require("@nx/devkit");
 const path = tslib_1.__importStar(require("path"));
+const child_process_1 = require("child_process");
+const fs = tslib_1.__importStar(require("fs"));
 const utils_1 = require("../utils");
 const dependency_config_1 = require("../dependency-config");
 async function getEnquirerPrompt() {
@@ -79,17 +81,50 @@ async function addApplicationGenerator(tree, options) {
         throw new Error('iframe-with-post-messages serving type is not currently supported. Please choose a different serving type.');
     }
     const isPlayground = options.servingType === 'local-dev-playground';
+    const isDocumentation = options.servingType === 'documentation';
+    // Check workspace pattern for documentation apps
+    if (isDocumentation) {
+        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/**');
+            const hasNegationPattern = workspaces.some((pattern) => pattern.startsWith('!'));
+            if (hasCatchAllPattern || hasNegationPattern) {
+                throw new Error('Documentation applications require @unisphere/nx version 3.1.0 or higher.\n\n' +
+                    'Your workspace is using an old npm workspaces pattern that prevents documentation apps ' +
+                    '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 apps.');
+            }
+        }
+    }
     // Validate and read .unisphere configuration
     const unisphereConfig = (0, utils_1.validateUnisphereConfig)(tree);
-    const { runtimeName, visualName } = await promptForRuntimeName(unisphereConfig.runtimes, options.runtimeName || '', options.visualName || '', options.skipDynamicRuntimeVisualPrompt || false);
-    if (!isPlayground && !options.htmlPageTitle) {
+    // Skip runtime/visual prompts for documentation sites
+    let runtimeName = '';
+    let visualName = '';
+    if (!isDocumentation) {
+        const promptResult = await promptForRuntimeName(unisphereConfig.runtimes, options.runtimeName || '', options.visualName || '', options.skipDynamicRuntimeVisualPrompt || false);
+        runtimeName = promptResult.runtimeName;
+        visualName = promptResult.visualName;
+    }
+    // Skip HTML page title prompt for documentation (Docusaurus has its own config)
+    if (!isPlayground && !isDocumentation && !options.htmlPageTitle) {
         options.htmlPageTitle = options.htmlPageTitle || await promptForHtmlPageTitle();
     }
-    if (options.dependencies === undefined) {
-        options.dependencies = await promptForDependencies(isPlayground);
+    // Skip dependencies prompt for documentation (Docusaurus has its own)
+    let selectedDependencies = [];
+    if (!isDocumentation) {
+        if (options.dependencies === undefined) {
+            options.dependencies = await promptForDependencies(isPlayground);
+        }
+        const baseDependencies = ['react'];
+        selectedDependencies = [...baseDependencies, ...(options.dependencies || [])];
     }
-    const baseDependencies = ['react'];
-    const selectedDependencies = [...baseDependencies, ...(options.dependencies || [])];
     // Validate runtime exists if runtimeName is provided
     if (runtimeName) {
         if (!(0, utils_1.checkIfRuntimeExists)(tree, runtimeName)) {
@@ -103,12 +138,83 @@ async function addApplicationGenerator(tree, options) {
         applicationName += '-dev';
     }
     const applicationNameAsLowerDashCase = (0, devkit_1.names)(applicationName).fileName;
-    // Find types package (or fallback to core)
-    const typesPackageInfo = (0, utils_1.findTypesOrCorePackageInfo)(tree);
+    // Find types package (or fallback to core) - skip for documentation
+    const typesPackageInfo = isDocumentation ? null : (0, utils_1.findTypesOrCorePackageInfo)(tree);
     // Determine subdirectory based on serving type
-    // local-dev-playground -> local/, other types -> server/
-    const subdirectory = isPlayground ? 'local' : 'server';
+    // local-dev-playground -> local/, documentation -> documentation/, other types -> server/
+    const subdirectory = isPlayground ? 'local' : isDocumentation ? 'documentation' : 'server';
     const projectRoot = `unisphere/applications/${subdirectory}/${applicationNameAsLowerDashCase}`;
+    // Handle documentation type separately
+    if (isDocumentation) {
+        // Check if the application already exists
+        if (tree.exists(projectRoot)) {
+            throw new Error(`Application "${applicationNameAsLowerDashCase}" already exists at ${projectRoot}.\n` +
+                'Please choose a different application name or remove the existing application first.');
+        }
+        // Update .unisphere configuration (applicationType is derived from folder path)
+        (0, utils_1.updateUnisphereConfig)(tree, 'applications', applicationNameAsLowerDashCase, {
+            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);
+        }
+        // Documentation folders are automatically excluded from npm workspaces
+        // because the root package.json uses explicit workspace patterns that don't include
+        // unisphere/applications/documentation/**
+        // This allows documentation sites (like Docusaurus) to have their own node_modules
+        await (0, devkit_1.formatFiles)(tree);
+        // Return a function that will be executed after all file operations are complete
+        return () => {
+            const workspaceRoot = process.cwd();
+            const fullProjectPath = path.join(workspaceRoot, projectRoot);
+            devkit_1.logger.info('');
+            devkit_1.logger.info('📚 Setting up Docusaurus documentation site...');
+            devkit_1.logger.info('');
+            try {
+                // Create the parent directory if it doesn't exist
+                const parentDir = path.dirname(fullProjectPath);
+                if (!fs.existsSync(parentDir)) {
+                    fs.mkdirSync(parentDir, { recursive: true });
+                }
+                // Run Docusaurus CLI to scaffold the project
+                // Docusaurus creates a self-contained project with its own package.json
+                // No NX integration needed - we just delegate to Docusaurus CLI for serve/build
+                // Use public npm registry explicitly (workspaces may have private registry configured)
+                devkit_1.logger.info('Running Docusaurus CLI...');
+                (0, child_process_1.execSync)(`npx --yes --registry https://registry.npmjs.org create-docusaurus@3 "${fullProjectPath}" classic --typescript`, {
+                    stdio: 'inherit',
+                    cwd: workspaceRoot,
+                });
+                devkit_1.logger.info('');
+                devkit_1.logger.info('✅ Documentation site generated successfully!');
+                devkit_1.logger.info('');
+                devkit_1.logger.info(`📚 Application Name: ${applicationNameAsLowerDashCase}`);
+                devkit_1.logger.info(`🔧 Type: Documentation Site (Docusaurus)`);
+                devkit_1.logger.info(`📁 Location: ${projectRoot}`);
+                devkit_1.logger.info('');
+                devkit_1.logger.info(`📜 To serve: npx unisphere application serve ${applicationNameAsLowerDashCase}`);
+                devkit_1.logger.info(`📦 To build: npx unisphere application build ${applicationNameAsLowerDashCase}`);
+                devkit_1.logger.info('');
+            }
+            catch (error) {
+                devkit_1.logger.error('Failed to create Docusaurus project:');
+                devkit_1.logger.error(error instanceof Error ? error.message : String(error));
+                throw error;
+            }
+        };
+    }
+    // Standard application flow (non-documentation)
     const hasDs = selectedDependencies.includes('ds');
     const templateVariables = {
         htmlPageTitle: options.servingType === 'local-dev-playground'

package/dist/generators/add-application/schema.d.ts

@@ -1,7 +1,7 @@
 export interface AddApplicationGeneratorSchema {
   name: string;
   htmlPageTitle?: string;
-  servingType: 'local-dev-playground' | 'self-hosted' | 'iframe-with-post-messages';
+  servingType: 'local-dev-playground' | 'self-hosted' | 'iframe-with-post-messages' | 'documentation';
   runtimeName?: string;
   visualName?: string;
   skipDynamicRuntimeVisualPrompt?: boolean; // Internal option to skip the dynamic prompt for visual when runtime is selected

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

@@ -33,6 +33,10 @@
           {
             "value": "iframe-with-post-messages",
             "label": "Iframe + Post Messages (suitible to applications that gets required configuration from post messages)"
+          },
+          {
+            "value": "documentation",
+            "label": "Documentation Site (Docusaurus)"
           }
         ]
       }

package/dist/generators/internal-dev-runner/generator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../../src/generators/internal-dev-runner/generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAalC,wBAA8B,sBAAsB,CAAC,IAAI,EAAE,IAAI,iBAsC9D"}
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../../src/generators/internal-dev-runner/generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAclC,wBAA8B,sBAAsB,CAAC,IAAI,EAAE,IAAI,iBAuC9D"}

package/dist/generators/internal-dev-runner/generator.js

@@ -11,7 +11,8 @@ const tslib_1 = require("tslib");
 // import reorganizeApplicationsByDistributionChannel from '../../migrations/3-0-0/reorganize-applications-by-distribution-channel';
 // import upgradeSchemaTo2 from '../../migrations/3-0-0/upgrade-schema-to-2-0-0';
 // import postCleanupEmptyDirectories from '../../migrations/3-0-0/post-cleanup-empty-directories';
-const remove_private_from_applications_and_runtimes_1 = tslib_1.__importDefault(require("../../migrations/3-0-0/remove-private-from-applications-and-runtimes"));
+// import removePrivateFromApplicationsAndRuntimes from '../../migrations/3-0-0/remove-private-from-applications-and-runtimes';
+const fix_workspaces_pattern_1 = tslib_1.__importDefault(require("../../migrations/3-1-0/fix-workspaces-pattern"));
 async function testMigrationGenerator(tree) {
     // Collect all callbacks to run after all migrations complete
     // const callbacks: (() => void)[] = [];
@@ -29,7 +30,8 @@ async function testMigrationGenerator(tree) {
     // Upgrade schema to 2.0.0 and remove distributionChannel from packages
     // await upgradeSchemaTo2(tree);
     // Remove private field from applications, runtimes, and packages
-    await (0, remove_private_from_applications_and_runtimes_1.default)(tree);
+    // await removePrivateFromApplicationsAndRuntimes(tree);
+    await (0, fix_workspaces_pattern_1.default)(tree);
     // Post-cleanup: Remove empty directories after reorganization
     // const postCleanupCallback = await postCleanupEmptyDirectories(tree);
     // if (postCleanupCallback) {

package/dist/migrations/3-1-0/fix-workspaces-pattern.d.ts

@@ -0,0 +1,23 @@
+import { Tree } from '@nx/devkit';
+/**
+ * Migration: Fix npm workspaces pattern to use explicit includes
+ *
+ * This migration updates the root package.json workspaces array to use
+ * explicit include patterns instead of a catch-all pattern with exclusions.
+ *
+ * The problem with "unisphere/**" + "!unisphere/applications/documentation/**"
+ * is that npm's negation patterns don't work reliably. This caused documentation
+ * apps (like Docusaurus) to be unable to have their own node_modules.
+ *
+ * The fix is to use explicit patterns that only include what should be workspaces:
+ * - unisphere/packages/**
+ * - unisphere/runtimes/**
+ * - unisphere/visuals/**
+ * - unisphere/applications/local/**
+ * - unisphere/applications/server/**
+ *
+ * This automatically excludes unisphere/applications/documentation/** without
+ * needing a negation pattern.
+ */
+export default function update(tree: Tree): Promise<void>;
+//# sourceMappingURL=fix-workspaces-pattern.d.ts.map

package/dist/migrations/3-1-0/fix-workspaces-pattern.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fix-workspaces-pattern.d.ts","sourceRoot":"","sources":["../../../src/migrations/3-1-0/fix-workspaces-pattern.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAA+B,MAAM,YAAY,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAA8B,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CA8D9D"}

package/dist/migrations/3-1-0/fix-workspaces-pattern.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = update;
+const devkit_1 = require("@nx/devkit");
+/**
+ * Migration: Fix npm workspaces pattern to use explicit includes
+ *
+ * This migration updates the root package.json workspaces array to use
+ * explicit include patterns instead of a catch-all pattern with exclusions.
+ *
+ * The problem with "unisphere/**" + "!unisphere/applications/documentation/**"
+ * is that npm's negation patterns don't work reliably. This caused documentation
+ * apps (like Docusaurus) to be unable to have their own node_modules.
+ *
+ * The fix is to use explicit patterns that only include what should be workspaces:
+ * - unisphere/packages/**
+ * - unisphere/runtimes/**
+ * - unisphere/visuals/**
+ * - unisphere/applications/local/**
+ * - unisphere/applications/server/**
+ *
+ * This automatically excludes unisphere/applications/documentation/** without
+ * needing a negation pattern.
+ */
+async function update(tree) {
+    devkit_1.logger.info('🔄 Fixing npm workspaces pattern to use explicit includes');
+    const packageJsonPath = 'package.json';
+    if (!tree.exists(packageJsonPath)) {
+        devkit_1.logger.warn('No package.json found, skipping migration');
+        return;
+    }
+    const packageJson = (0, devkit_1.readJson)(tree, packageJsonPath);
+    if (!packageJson.workspaces || !Array.isArray(packageJson.workspaces)) {
+        devkit_1.logger.warn('No workspaces array found in package.json, skipping migration');
+        return;
+    }
+    const oldWorkspaces = packageJson.workspaces;
+    // Check if using the old catch-all pattern
+    const hasCatchAllPattern = oldWorkspaces.includes('unisphere/**');
+    const hasNegationPattern = oldWorkspaces.some((pattern) => pattern.startsWith('!'));
+    if (!hasCatchAllPattern && !hasNegationPattern) {
+        // Check if already using explicit patterns
+        const expectedPatterns = [
+            'unisphere/packages/**',
+            'unisphere/runtimes/**',
+            'unisphere/visuals/**',
+            'unisphere/applications/local/**',
+            'unisphere/applications/server/**',
+        ];
+        const hasAllExpectedPatterns = expectedPatterns.every(pattern => oldWorkspaces.includes(pattern));
+        if (hasAllExpectedPatterns) {
+            devkit_1.logger.info('Workspaces already using explicit patterns, skipping migration');
+            return;
+        }
+    }
+    // Replace with explicit patterns
+    const newWorkspaces = [
+        'unisphere/packages/**',
+        'unisphere/runtimes/**',
+        'unisphere/visuals/**',
+        'unisphere/applications/local/**',
+        'unisphere/applications/server/**',
+    ];
+    packageJson.workspaces = newWorkspaces;
+    (0, devkit_1.writeJson)(tree, packageJsonPath, packageJson);
+    devkit_1.logger.info('✅ Updated workspaces from:');
+    devkit_1.logger.info(`   ${JSON.stringify(oldWorkspaces)}`);
+    devkit_1.logger.info('   to:');
+    devkit_1.logger.info(`   ${JSON.stringify(newWorkspaces)}`);
+    devkit_1.logger.info('');
+    devkit_1.logger.info('This allows documentation apps (like Docusaurus) to have their own node_modules.');
+}

package/migrations.json

@@ -273,7 +273,15 @@
     "3-0-0-remove-pre-install": {
       "version": "3.0.0",
       "description": "Removes kaltura-tools preinstall script from package.json",
-      "factory": "./dist/migrations/3-0-0/remove-kaltura-tools-to-pre-install.js",
+      "factory": "./dist/migrations/3-0-0/remove-kaltura-tools-to-pre-install.js"
+    },
+    "3-1-0-fix-workspaces-pattern": {
+      "version": "3.1.0",
+      "description": "Fixes npm workspaces pattern to use explicit includes instead of catch-all with exclusions",
+      "factory": "./dist/migrations/3-1-0/fix-workspaces-pattern.js",
+      "cli": {
+        "postUpdateMessage": "✅ npm workspaces pattern updated to use explicit includes. Documentation apps can now have their own node_modules."
+      }
     }
   },
   "packageJsonUpdates": {

package/package.json

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