npm - @unisphere/nx - Versions diffs - 1.0.1 - Mend

@unisphere/nx 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (102) hide show

package/dist/generators/add-application/templates/interactive-playground/src/app/utils/merge-deep.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"merge-deep.d.ts","sourceRoot":"","sources":["../../../../../../../../src/generators/add-application/templates/interactive-playground/src/app/utils/merge-deep.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,GAAG,OAEjC;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,GAAG,GAAG,CAgB7D"}

package/dist/generators/add-application/templates/interactive-playground/src/app/utils/merge-deep.js ADDED Viewed

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObject = isObject;
+exports.mergeDeep = mergeDeep;
+/**
+ * Simple object check.
+ * @param item
+ * @returns {boolean}
+ */
+function isObject(item) {
+    return item && typeof item === 'object' && !Array.isArray(item);
+}
+/**
+ * Deep merge two objects.
+ * @param target
+ * @param ...sources
+ */
+function mergeDeep(target, ...sources) {
+    if (!sources.length)
+        return target;
+    const source = sources.shift();
+    if (isObject(target) && isObject(source)) {
+        for (const key in source) {
+            if (isObject(source[key])) {
+                if (!target[key])
+                    Object.assign(target, { [key]: {} });
+                mergeDeep(target[key], source[key]);
+            }
+            else {
+                Object.assign(target, { [key]: source[key] });
+            }
+        }
+    }
+    return mergeDeep(target, ...sources);
+}

package/dist/generators/add-application/templates/interactive-playground/src/favicon.ico ADDED Viewed

Binary file

package/dist/generators/add-application/templates/interactive-playground/src/index.html ADDED Viewed

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <title>
+    <%= htmlPageTitle %>
+  </title>
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <link rel="icon" type="image/x-icon" href="favicon.ico" />
+</head>
+<body>
+  <div id="root"></div>
+</body>
+</html>

package/dist/generators/add-application/templates/interactive-playground/src/main.tsx ADDED Viewed

@@ -0,0 +1,13 @@
+import { StrictMode } from 'react';
+import * as ReactDOM from 'react-dom/client';
+import App from './app/app';
+const root = ReactDOM.createRoot(
+  document.getElementById('root') as HTMLElement
+);
+root.render(
+  <StrictMode>
+    <App />
+  </StrictMode>
+);

package/dist/generators/add-application/templates/interactive-playground/src/styles.css ADDED Viewed

File without changes

package/dist/generators/add-application/templates/interactive-playground/tsconfig.app.json ADDED Viewed

@@ -0,0 +1,24 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "types": [
+      "node",
+      "@nx/react/typings/cssmodule.d.ts",
+      "@nx/react/typings/image.d.ts"
+    ]
+  },
+  "exclude": [
+    "jest.config.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.tsx",
+    "src/**/*.spec.js",
+    "src/**/*.test.js",
+    "src/**/*.spec.jsx",
+    "src/**/*.test.jsx"
+  ],
+  "include": ["src/**/*.js", "src/**/*.jsx", "src/**/*.ts", "src/**/*.tsx"]
+}

package/dist/generators/add-application/templates/interactive-playground/tsconfig.json ADDED Viewed

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "jsx": "react-jsx",
+    "allowJs": false,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "strict": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.app.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "extends": "../../../tsconfig.base.json"
+}

package/dist/generators/add-application/templates/interactive-playground/tsconfig.spec.json ADDED Viewed

@@ -0,0 +1,25 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "module": "commonjs",
+    "types": [
+      "jest",
+      "node",
+      "@nx/react/typings/cssmodule.d.ts",
+      "@nx/react/typings/image.d.ts"
+    ]
+  },
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.test.tsx",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.js",
+    "src/**/*.spec.js",
+    "src/**/*.test.jsx",
+    "src/**/*.spec.jsx",
+    "src/**/*.d.ts"
+  ]
+}

package/dist/generators/add-application/templates/interactive-playground/webpack.config.js ADDED Viewed

@@ -0,0 +1,33 @@
+const { NxAppWebpackPlugin } = require('@nx/webpack/app-plugin');
+const { NxReactWebpackPlugin } = require('@nx/react/webpack-plugin');
+const { join } = require('path');
+const baseHref = process.env.UNISPHERE_BASE_HREF || '/';
+module.exports = {
+  output: {
+    path: join(__dirname, '../../../dist/unisphere/applications/<%= applicationName__lowerDashCase %>'),
+    publicPath: baseHref,
+  },
+  devServer: {
+    port: 4200,
+  },
+  plugins: [
+    new NxAppWebpackPlugin({
+      tsConfig: './tsconfig.app.json',
+      compiler: 'babel',
+      main: './src/main.tsx',
+      index: './src/index.html',
+      baseHref,
+      assets: ['./src/favicon.ico'],
+      styles: ['./src/styles.css'],
+      outputHashing: process.env['NODE_ENV'] === 'production' ? 'all' : 'none',
+      optimization: process.env['NODE_ENV'] === 'production',
+    }),
+    new NxReactWebpackPlugin({
+      // Uncomment this line if you don't want to use SVGR
+      // See: https://react-svgr.com/
+      // svgr: false
+    }),
+  ],
+};

package/dist/generators/add-package/README.md ADDED Viewed

@@ -0,0 +1,70 @@
+# Add Package Generator
+This generator creates a new package in the Unisphere workspace with proper configuration based on the scope and naming conventions.
+## Usage
+```bash
+# Using the generator with the full path
+npx nx generate @unisphere/nx:add-package
+```
+## User Prompts
+The generator will prompt you for the following information:
+### Required Inputs
+1. **packageName** (mandatory)
+   - Format: `a-zA-Z[-][ ]` (alphanumeric with dashes and spaces allowed)
+   - Example: `core`, `notification-service`, `user management`
+2. **scope** (required, defaults to 'internal')
+   - **public**: Published to npm with `@unisphere/` prefix
+   - **internal**: Published to GitHub packages with `@kaltura/unisphere-` prefix
+   - **none**: Private repository only, no scope prefix
+## Local Development & Distribution
+### Packaging for Local Use
+Use the built-in packaging tool to create distributable packages:
+```bash
+# Interactive packager - guides you through the process
+npm run pack-generator
+# This will:
+# 1. Build the generator automatically
+# 2. Create an npm package (.tgz file)
+# 3. Ask what you want to do with it:
+#    - Move to a specific directory
+#    - Install directly in a target repository
+#    - Keep in current directory
+```
+### Installing in Other Repositories
+After packaging, install in your target repository:
+```bash
+# Install the generated package
+npm install --save-dev path/to/unisphere-nx-workspace-plugin-unisphere-generator-0.0.1.tgz
+# Use the generator
+npx nx g @unisphere/nx:add-package
+```
+### Alternative Installation Methods
+1. **Direct file path** (for development):
+   ```bash
+   npm install --save-dev file:../path/to/unisphere-nx-workspace-plugin/unisphere-generator
+   ```
+2. **Using npx directly**:
+   ```bash
+   npx --package file:../unisphere-nx-workspace-plugin/unisphere-generator nx g @unisphere/nx:add-package
+   ```

package/dist/generators/add-package/add-package.d.ts ADDED Viewed

@@ -0,0 +1,5 @@
+import { Tree } from '@nx/devkit';
+import { AddPackageGeneratorSchema } from './schema';
+export declare function addPackageGenerator(tree: Tree, options: AddPackageGeneratorSchema): Promise<() => void>;
+export default addPackageGenerator;
+//# sourceMappingURL=add-package.d.ts.map

package/dist/generators/add-package/add-package.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"add-package.d.ts","sourceRoot":"","sources":["../../../src/generators/add-package/add-package.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,IAAI,EAGL,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AAkBrD,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,yBAAyB,uBAoGnC;AAED,eAAe,mBAAmB,CAAC"}

package/dist/generators/add-package/add-package.js ADDED Viewed

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addPackageGenerator = addPackageGenerator;
+const tslib_1 = require("tslib");
+const devkit_1 = require("@nx/devkit");
+const path = tslib_1.__importStar(require("path"));
+const utils_1 = require("../utils");
+async function addPackageGenerator(tree, options) {
+    // Validate and read .unisphere configuration
+    const unisphereConfig = (0, utils_1.validateUnisphereConfig)(tree);
+    // Extract environment variables
+    const companyName = unisphereConfig.company;
+    const experienceName = unisphereConfig.name;
+    // Calculate packageJsonName based on scope and names
+    let packageJsonName;
+    const userInputPackageName = (0, devkit_1.names)(options.packageName).fileName;
+    if (experienceName === userInputPackageName) {
+        packageJsonName = userInputPackageName;
+    }
+    else {
+        packageJsonName = experienceName + `-${userInputPackageName}`;
+    }
+    const prefix = options.scope === 'public' ? '@unisphere/' : '@kaltura/unisphere-';
+    packageJsonName = prefix + packageJsonName;
+    const repositoryPrivate = options.scope === 'none';
+    // Calculate distributionChannel
+    let distributionChannel;
+    switch (options.scope) {
+        case 'public':
+            distributionChannel = 'npm';
+            break;
+        case 'none':
+            distributionChannel = 'none';
+            break;
+        case 'internal':
+        default:
+            distributionChannel = 'github';
+            break;
+    }
+    const transformedPackageName = (0, devkit_1.names)(userInputPackageName);
+    const githubUrl = `https://github.com/${companyName}/${experienceName}`;
+    // Prepare template variables
+    const templateVariables = {
+        scope: options.scope,
+        repositoryPrivate,
+        distributionChannel,
+        githubUrl,
+        companyName,
+        ...(0, utils_1.createNameTransforms)(userInputPackageName, 'packageName'),
+        ...(0, utils_1.createNameTransforms)(experienceName, 'experienceName'),
+        ...(0, utils_1.createNameTransforms)(packageJsonName, 'packageJsonName'),
+        ...transformedPackageName,
+        tmpl: '',
+    };
+    const projectRoot = `unisphere/packages/${userInputPackageName}`;
+    // Check if the project already exists
+    if (tree.exists(projectRoot)) {
+        throw new Error(`Package "${userInputPackageName}" already exists at ${projectRoot}.\n` +
+            'Please choose a different package name or remove the existing package first.');
+    }
+    // Generate files from templates (project.json.template will define the project)
+    (0, devkit_1.generateFiles)(tree, path.join(__dirname, 'files'), projectRoot, templateVariables);
+    // Update .unisphere configuration
+    (0, utils_1.updateUnisphereConfig)(tree, 'packages', userInputPackageName, {
+        sourceRoot: `unisphere/packages/${userInputPackageName}`,
+        distributionChannel: distributionChannel,
+        scope: 'widget',
+    });
+    // Update tsconfig.base.json with path mapping
+    (0, utils_1.updateTsConfigPaths)(tree, packageJsonName, `unisphere/packages/${userInputPackageName}/src/index.ts`);
+    await (0, devkit_1.formatFiles)(tree);
+    // Return a function that will be executed after all file operations are complete
+    return () => {
+        devkit_1.logger.info('');
+        devkit_1.logger.info('✅ Package generated successfully!');
+        devkit_1.logger.info('');
+        devkit_1.logger.info(`📦 Package Name: ${userInputPackageName}`);
+        devkit_1.logger.info(`🏷️  Full Package Name: ${packageJsonName}`);
+        devkit_1.logger.info(`📁 Location: ${projectRoot}`);
+        devkit_1.logger.info(`🔧 Scope: ${options.scope}`);
+        devkit_1.logger.info(`📤 Distribution Channel: ${distributionChannel}`);
+        devkit_1.logger.info('');
+    };
+}
+exports.default = addPackageGenerator;

package/dist/generators/add-package/files/.babelrc ADDED Viewed

@@ -0,0 +1,12 @@
+{
+  "presets": [
+    [
+      "@nx/react/babel",
+      {
+        "runtime": "automatic",
+        "useBuiltIns": "usage"
+      }
+    ]
+  ],
+  "plugins": []
+}

package/dist/generators/add-package/files/.eslintrc.json ADDED Viewed

@@ -0,0 +1,18 @@
+{
+  "extends": ["plugin:@nx/react", "../../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

package/dist/generators/add-package/files/README.md ADDED Viewed

	@@ -0,0 +1 @@
1	+ # Unisphere <%= experienceName__humanReadable %> - Package <%= packageName__humanReadable %>

package/dist/generators/add-package/files/package.json.template ADDED Viewed

@@ -0,0 +1,22 @@
+{
+  "name": "<%= packageJsonName %>",
+  "version": "1.0.0",
+  "author": "kaltura",
+  "private": <%= repositoryPrivate %>,
+  "license": "AGPL-3.0",
+  "repository": {
+    "type": "git",
+    "url": "<%= githubUrl %>"
+  },
+  "types": "./index.esm.d.ts",
+  "dependencies": {
+    "@unisphere/runtime": "^1.54.1"
+  },
+  "publishConfig": {
+    <% if (distributionChannel === 'github') { %>
+    "registry": "https://npm.pkg.github.com"
+    <% } else if (distributionChannel === 'npm') { %>
+    "registry": "https://registry.npmjs.org"
+    <% } %>
+  }
+}

package/dist/generators/add-package/files/project.json.template ADDED Viewed

@@ -0,0 +1,22 @@
+{
+  "name": "unisphere-package-<%= packageName__lowerDashCase %>",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "unisphere/packages/<%= packageName__lowerDashCase %>/src",
+  "projectType": "library",
+  "tags": [],
+  "// targets": "to see all targets run: nx show project unisphere-package-<%= packageName__lowerDashCase %> --web",
+  "targets": {
+    "lint": {
+      "executor": "@nx/eslint:lint",
+      "outputs": [
+        "{options.outputFile}"
+      ],
+      "options": {
+        "lintFilePatterns": [
+          "unisphere/packages/<%= packageName__lowerDashCase %>/src/**/*.{ts,tsx,js,jsx}",
+          "unisphere/packages/<%= packageName__lowerDashCase %>/package.json"
+        ]
+      }
+    }
+  }
+}

package/dist/generators/add-package/files/rollup.config.js ADDED Viewed

@@ -0,0 +1,6 @@
+const createUnisphereWithNX = require('../../../node_modules/@unisphere/cli/bundler/package/rollup.js');
+module.exports = createUnisphereWithNX({
+  cwd: __dirname,
+})

package/dist/generators/add-package/files/src/index.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/dist/generators/add-package/files/tsconfig.json ADDED Viewed

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "jsx": "react-jsx",
+    "allowJs": false,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "strict": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "extends": "../../../tsconfig.base.json"
+}

package/dist/generators/add-package/files/tsconfig.lib.json ADDED Viewed

@@ -0,0 +1,23 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "types": [
+      "node",
+      "@kaltura/ds-react-theme/src/lib/theme.d.ts",
+      "@nx/react/typings/cssmodule.d.ts",
+      "@nx/react/typings/image.d.ts"
+    ]
+  },
+  "exclude": [
+    "**/*.spec.ts",
+    "**/*.test.ts",
+    "**/*.spec.tsx",
+    "**/*.test.tsx",
+    "**/*.spec.js",
+    "**/*.test.js",
+    "**/*.spec.jsx",
+    "**/*.test.jsx"
+  ],
+  "include": ["src/**/*.js", "src/**/*.jsx", "src/**/*.ts", "src/**/*.tsx"]
+}

package/dist/generators/add-package/files/tsconfig.spec.json ADDED Viewed

@@ -0,0 +1,26 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "types": [
+      "vitest/globals",
+      "vitest/importMeta",
+      "vite/client",
+      "node",
+      "vitest"
+    ]
+  },
+  "include": [
+    "vite.config.ts",
+    "vitest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.test.tsx",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.js",
+    "src/**/*.spec.js",
+    "src/**/*.test.jsx",
+    "src/**/*.spec.jsx",
+    "src/**/*.d.ts"
+  ]
+}

package/dist/generators/add-package/files/vite.config.ts ADDED Viewed

@@ -0,0 +1,30 @@
+import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react';
+import { nxViteTsPaths } from '@nx/vite/plugins/nx-tsconfig-paths.plugin';
+export default defineConfig({
+  root: __dirname,
+  cacheDir: '../../../node_modules/.vite/unisphere/package-<%= packageName__lowerDashCase %>',
+  plugins: [react(), nxViteTsPaths()],
+  // Uncomment this if you are using workers.
+  // worker: {
+  //  plugins: [ nxViteTsPaths() ],
+  // },
+  test: {
+    watch: false,
+    globals: true,
+    cache: {
+      dir: '../../../node_modules/.vitest/unisphere/package-<%= packageName__lowerDashCase %>',
+    },
+    environment: 'jsdom',
+    include: ['src/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
+    reporters: ['default'],
+    coverage: {
+      reportsDirectory: '../../../coverage/unisphere/package-<%= packageName__lowerDashCase %>',
+      provider: 'v8',
+    },
+  },
+});

package/dist/generators/add-package/schema.d.ts ADDED Viewed

@@ -0,0 +1,4 @@
+export interface AddPackageGeneratorSchema {
+  packageName: string;
+  scope: 'public' | 'internal' | 'none';
+}

package/dist/generators/add-package/schema.json ADDED Viewed

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "AddPackage",
+  "title": "Add Package Generator",
+  "type": "object",
+  "properties": {
+    "packageName": {
+      "type": "string",
+      "description": "The name of the package to create",
+      "pattern": "^[a-zA-Z][a-zA-Z0-9\\-\\s]*$",
+      "x-prompt": "What is the package name? (alphanumeric with dashes and spaces allowed)"
+    },
+    "scope": {
+      "type": "string",
+      "description": "The distribution scope of the package",
+      "enum": [
+        "public",
+        "internal",
+        "none"
+      ],
+      "default": "internal",
+      "x-prompt": {
+        "message": "What scope should this package have?",
+        "type": "list",
+        "items": [
+          {
+            "value": "public",
+            "label": "Public (@unisphere/) - Published to npm"
+          },
+          {
+            "value": "internal",
+            "label": "Internal (@kaltura/unisphere-) - Published to GitHub packages"
+          },
+          {
+            "value": "none",
+            "label": "None (no scope) - Private repository only"
+          }
+        ]
+      }
+    }
+  },
+  "required": [
+    "packageName",
+    "scope"
+  ]
+}

package/dist/generators/add-runtime/add-runtime.d.ts ADDED Viewed

@@ -0,0 +1,5 @@
+import { Tree } from '@nx/devkit';
+import { AddRuntimeGeneratorSchema } from './schema';
+export declare function addRuntimeGenerator(tree: Tree, options: AddRuntimeGeneratorSchema): Promise<() => void>;
+export default addRuntimeGenerator;
+//# sourceMappingURL=add-runtime.d.ts.map

package/dist/generators/add-runtime/add-runtime.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"add-runtime.d.ts","sourceRoot":"","sources":["../../../src/generators/add-runtime/add-runtime.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,IAAI,EAAiB,MAAM,YAAY,CAAC;AAE7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AAyCrD,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,yBAAyB,uBAsHnC;AAED,eAAe,mBAAmB,CAAC"}