@acorex/platform-generator 21.0.0-next.3 → 21.0.0-next.33

package/src/bin/standalone-scaffold.js

@@ -0,0 +1,533 @@
+#!/usr/bin/env node
+/**
+ * Scaffolds a new Nx + Angular workspace with an ACoreX Platform app from bundled templates.
+ * Templates live under generator/src/generators (app-module/files + standalone-workspace).
+ * Requires published @acorex/* packages (see generator/src/generators/standalone-workspace/versions.json).
+ */
+const fs = require('fs');
+const path = require('path');
+const { spawnSync } = require('child_process');
+const ejs = require('ejs');
+
+const BIN_DIR = __dirname;
+const GENERATORS_ROOT = path.join(BIN_DIR, '..', 'generators');
+const APP_MODULE_FILES = path.join(GENERATORS_ROOT, 'app-module', 'files');
+const VERSIONS_JSON = path.join(GENERATORS_ROOT, 'standalone-workspace', 'versions.json');
+const ROOT_TEMPLATES = path.join(GENERATORS_ROOT, 'standalone-workspace', 'root');
+
+// Office / archives and fonts must never be read as UTF-8: random bytes can match "<%" and break EJS.
+const BINARY_EXT =
+  /\.(ico|png|jpe?g|gif|webp|woff2?|ttf|otf|eot|pdf|svg|docx?|pptx?|xlsx?|xls|zip|7z|mp4|webm|mp3|wasm)$/i;
+
+const MINIMAL_I18N_BASENAMES = new Set([
+  'module.json',
+  'acorex.json',
+  'auth.json',
+  'general.json',
+  'layout.json',
+  'settings.json',
+  'regional.json',
+  'help-desk.json',
+  'dashboard.json',
+  'notification-management.json',
+  'security-management.json',
+  'organization-management.json',
+  'platform-management.json',
+]);
+
+function upperCase(text) {
+  return String(text).toUpperCase();
+}
+
+function toPascalCase(text) {
+  return String(text)
+    .split(/[-_\s.]+/)
+    .filter(Boolean)
+    .map((segment) => segment.charAt(0).toUpperCase() + segment.slice(1))
+    .join('');
+}
+
+function toConstPrefix(text) {
+  return String(text)
+    .split(/[-_\s.]+/)
+    .filter(Boolean)
+    .join('_')
+    .toUpperCase();
+}
+
+function normalizeOptions(raw) {
+  const preset = raw.preset ?? 'full';
+  const entityStorage = raw.entityStorage ?? 'dexie';
+  const connectivity = raw.connectivity ?? 'mock';
+  if (connectivity === 'none') {
+    console.warn(
+      '[acorex-platform] connectivity=none is not fully supported yet; using mock (IndexedDB / mock auth).',
+    );
+  }
+  const connectivityMode = connectivity === 'api' ? 'api' : 'mock';
+
+  return {
+    name: raw.name,
+    title: raw.title,
+    copyright: raw.copyright ?? '© 2025',
+    baseUrl: raw.baseUrl ?? 'https://localhost:44320/api',
+    preset,
+    entityStorage,
+    entityStorageBackend: entityStorage,
+    connectivityMode,
+    includeApiConfig: connectivityMode === 'api',
+    includeConsoleLogCapture: raw.includeConsoleLogCapture ?? false,
+    firebaseApiKey: raw.firebaseApiKey ?? 'YOUR_FIREBASE_API_KEY',
+    firebaseAuthDomain: raw.firebaseAuthDomain ?? 'your-project.firebaseapp.com',
+    firebaseProjectId: raw.firebaseProjectId ?? 'your-project-id',
+    firebaseStorageBucket: raw.firebaseStorageBucket ?? 'your-project.appspot.com',
+    firebaseMessagingSenderId: raw.firebaseMessagingSenderId ?? '000000000000',
+    firebaseAppId: raw.firebaseAppId ?? '1:000000000000:web:000000000000000000000',
+    upperCase,
+    className: toPascalCase(raw.name),
+    constPrefix: toConstPrefix(raw.name),
+    isFullPreset: preset === 'full',
+    isMinimalPreset: preset === 'minimal',
+    includeConnectivityPackage: connectivityMode === 'mock' || connectivityMode === 'api',
+  };
+}
+
+function loadVersions() {
+  const raw = fs.readFileSync(VERSIONS_JSON, 'utf8');
+  return JSON.parse(raw);
+}
+
+function isBinaryFile(filePath) {
+  return BINARY_EXT.test(filePath);
+}
+
+function renderTemplateString(content, vars) {
+  return ejs.render(content, vars, { async: false });
+}
+
+/**
+ * Copies app-module/files to projectRoot (e.g. apps/myapp) with EJS rendering for .template files.
+ */
+function copyAppModuleTemplates(projectRoot, vars) {
+  function walk(srcRel, destRel) {
+    const srcAbs = path.join(APP_MODULE_FILES, srcRel);
+    const st = fs.statSync(srcAbs);
+    if (st.isDirectory()) {
+      fs.mkdirSync(path.join(projectRoot, destRel), { recursive: true });
+      for (const ent of fs.readdirSync(srcAbs, { withFileTypes: true })) {
+        walk(path.join(srcRel, ent.name), path.join(destRel, ent.name));
+      }
+      return;
+    }
+    const base = path.basename(srcAbs);
+    if (isBinaryFile(srcAbs)) {
+      const destAbs = path.join(projectRoot, destRel);
+      fs.mkdirSync(path.dirname(destAbs), { recursive: true });
+      fs.copyFileSync(srcAbs, destAbs);
+      return;
+    }
+    const rawBuf = fs.readFileSync(srcAbs);
+    // Unknown extension but clearly binary (e.g. mis-tagged assets): never pass to EJS.
+    if (rawBuf.includes(0)) {
+      const destAbs = path.join(projectRoot, destRel);
+      fs.mkdirSync(path.dirname(destAbs), { recursive: true });
+      fs.writeFileSync(destAbs, rawBuf);
+      return;
+    }
+    let buf = rawBuf.toString('utf8');
+    if (base.endsWith('.template')) {
+      buf = renderTemplateString(buf, vars);
+      const outName = base.replace(/\.template$/, '');
+      const outPath = path.join(projectRoot, path.dirname(destRel), outName);
+      fs.mkdirSync(path.dirname(outPath), { recursive: true });
+      fs.writeFileSync(outPath, buf, 'utf8');
+      return;
+    }
+    const destAbs = path.join(projectRoot, destRel);
+    fs.mkdirSync(path.dirname(destAbs), { recursive: true });
+    fs.writeFileSync(destAbs, buf, 'utf8');
+  }
+  walk('', '');
+}
+
+function mergeAppConfigFromPreset(projectRoot, preset) {
+  const src = path.join(projectRoot, 'src', 'app');
+  const fullPath = path.join(src, 'app.config.full.ts');
+  const minPath = path.join(src, 'app.config.minimal.ts');
+  const chosen = preset === 'minimal' ? minPath : fullPath;
+  if (!fs.existsSync(chosen)) {
+    throw new Error(`[standalone] Missing ${chosen}`);
+  }
+  const body = fs.readFileSync(chosen, 'utf8');
+  fs.writeFileSync(path.join(src, 'app.config.ts'), body, 'utf8');
+  try {
+    fs.unlinkSync(fullPath);
+  } catch (_) {}
+  try {
+    fs.unlinkSync(minPath);
+  } catch (_) {}
+}
+
+function applyApiAppConfig(projectRoot) {
+  const src = path.join(projectRoot, 'src', 'app');
+  const apiPath = path.join(src, 'app.config.api.ts');
+  if (!fs.existsSync(apiPath)) return;
+  const body = fs.readFileSync(apiPath, 'utf8');
+  fs.writeFileSync(path.join(src, 'app.config.ts'), body, 'utf8');
+}
+
+function deleteIfExists(p) {
+  try {
+    fs.unlinkSync(p);
+  } catch (_) {}
+}
+
+function pruneMinimalI18n(projectRoot, appName) {
+  const locales = ['en-US', 'fa-IR'];
+  for (const loc of locales) {
+    const dir = path.join(projectRoot, 'src', 'assets', 'i18n', loc);
+    if (!fs.existsSync(dir)) continue;
+    for (const file of fs.readdirSync(dir)) {
+      if (!file.endsWith('.json')) continue;
+      const moduleFile = `${appName}-module.json`;
+      if (file === moduleFile) continue;
+      if (MINIMAL_I18N_BASENAMES.has(file)) continue;
+      fs.unlinkSync(path.join(dir, file));
+    }
+  }
+}
+
+function renameRootModule(projectRoot, appName) {
+  const rootDir = path.join(projectRoot, 'src', 'app', 'modules', 'root');
+  const targetDir = path.join(projectRoot, 'src', 'app', 'modules', appName);
+  // Rename the folder first; pre-creating targetDir would block directory rename on all OSes.
+  fs.renameSync(rootDir, targetDir);
+  const oldFile = path.join(targetDir, 'root.module.ts');
+  const newFile = path.join(targetDir, `${appName}-root.module.ts`);
+  fs.renameSync(oldFile, newFile);
+}
+
+function renameModuleI18n(projectRoot, appName) {
+  const en = path.join(projectRoot, 'src', 'assets', 'i18n', 'en-US', 'module.json');
+  const fa = path.join(projectRoot, 'src', 'assets', 'i18n', 'fa-IR', 'module.json');
+  const enTo = path.join(projectRoot, 'src', 'assets', 'i18n', 'en-US', `${appName}-module.json`);
+  const faTo = path.join(projectRoot, 'src', 'assets', 'i18n', 'fa-IR', `${appName}-module.json`);
+  if (fs.existsSync(en)) fs.renameSync(en, enTo);
+  if (fs.existsSync(fa)) fs.renameSync(fa, faTo);
+}
+
+function writeRootWorkspace(outRoot, vars, versions) {
+  fs.mkdirSync(outRoot, { recursive: true });
+  const nxJson = {
+    $schema: './node_modules/nx/schemas/nx-schema.json',
+    namedInputs: {
+      default: ['{projectRoot}/**/*', 'sharedGlobals'],
+      production: ['default'],
+      sharedGlobals: [],
+    },
+    targetDefaults: {
+      build: {
+        dependsOn: ['^build'],
+        inputs: ['production', '^production'],
+      },
+    },
+    plugins: [
+      {
+        plugin: '@nx/angular/plugin',
+        options: {
+          buildTargetName: 'build',
+          serveTargetName: 'serve',
+        },
+      },
+    ],
+  };
+  fs.writeFileSync(path.join(outRoot, 'nx.json'), JSON.stringify(nxJson, null, 2), 'utf8');
+
+  const tsconfigBase = {
+    compileOnSave: false,
+    compilerOptions: {
+      rootDir: '.',
+      sourceMap: true,
+      declaration: false,
+      moduleResolution: 'bundler',
+      experimentalDecorators: true,
+      importHelpers: true,
+      target: 'es2022',
+      module: 'esnext',
+      lib: ['es2020', 'dom'],
+      skipLibCheck: true,
+      baseUrl: '.',
+      paths: {},
+    },
+  };
+  fs.writeFileSync(path.join(outRoot, 'tsconfig.base.json'), JSON.stringify(tsconfigBase, null, 2), 'utf8');
+
+  const pkg = {
+    name: vars.workspacePackageName ?? vars.name,
+    version: '0.0.1',
+    license: 'MIT',
+    private: true,
+    scripts: {
+      start: `nx serve ${vars.name}`,
+      build: `nx build ${vars.name}`,
+      'build:prod': `nx run ${vars.name}:build-esbuild:build-prod`,
+    },
+    dependencies: {},
+    devDependencies: {},
+  };
+
+  const deps = { ...versions };
+  delete deps.$comment;
+  const runtimeKeys = [
+    '@acorex/cdk',
+    '@acorex/charts',
+    '@acorex/components',
+    '@acorex/core',
+    '@acorex/styles',
+    '@acorex/platform',
+    '@acorex/modules',
+    '@angular/animations',
+    '@angular/cdk',
+    '@angular/common',
+    '@angular/compiler',
+    '@angular/core',
+    '@angular/forms',
+    '@angular/platform-browser',
+    '@angular/platform-browser-dynamic',
+    '@angular/router',
+    '@angular/service-worker',
+    '@ngrx/signals',
+    'angular-oauth2-oidc',
+    'dexie',
+    'dom-to-image',
+    'firebase',
+    'lodash-es',
+    'memoizee',
+    'rxjs',
+    'tailwindcss-animate',
+    'tslib',
+    'zone.js',
+  ];
+  if (vars.includeConnectivityPackage) {
+    runtimeKeys.push('@acorex/connectivity');
+  }
+  for (const k of runtimeKeys) {
+    if (deps[k] != null) pkg.dependencies[k] = deps[k];
+  }
+
+  const devKeys = [
+    '@angular-devkit/build-angular',
+    '@angular/cli',
+    '@angular/compiler-cli',
+    '@angular/language-service',
+    '@nx/angular',
+    '@nx/eslint-plugin',
+    '@nx/jest',
+    '@nx/js',
+    '@nx/workspace',
+    '@schematics/angular',
+    'angular-eslint',
+    'eslint',
+    'jest',
+    'jest-environment-jsdom',
+    'jest-preset-angular',
+    'ng-packagr',
+    'nx',
+    'prettier',
+    'sass',
+    'tailwindcss',
+    'typescript',
+  ];
+  for (const k of devKeys) {
+    const v = versions[k] ?? pickDevVersion(k);
+    if (v) pkg.devDependencies[k] = v;
+  }
+
+  fs.writeFileSync(path.join(outRoot, 'package.json'), JSON.stringify(pkg, null, 2), 'utf8');
+
+  const gitignore = [
+    'node_modules',
+    'dist',
+    '.angular',
+    '.nx/cache',
+    'coverage',
+    '*.log',
+    '.env',
+    '',
+  ].join('\n');
+  fs.writeFileSync(path.join(outRoot, '.gitignore'), gitignore, 'utf8');
+
+  const readme = renderTemplateString(
+    `# <%= title %>\n\nGenerated by @acorex/platform-generator.\n\n## Scripts\n\n- npm start — dev server\n- npm run build — production build\n\nInstall dependencies: npm install\n`,
+    vars,
+  );
+  fs.writeFileSync(path.join(outRoot, 'README.md'), readme, 'utf8');
+
+  const jestPreset = "const { getJestProjectsAsync } = require('@nx/jest');\nmodule.exports = async () => ({\n  projects: await getJestProjectsAsync(),\n});\n";
+  fs.writeFileSync(path.join(outRoot, 'jest.preset.js'), jestPreset, 'utf8');
+
+  fs.writeFileSync(path.join(outRoot, 'eslint.config.mjs'), `export default [];\n`, 'utf8');
+}
+
+function pickDevVersion(key) {
+  const map = {
+    '@angular-devkit/build-angular': '~20.3.0',
+    '@angular/cli': '~20.3.0',
+    '@angular/compiler-cli': '~20.3.0',
+    '@angular/language-service': '~20.3.0',
+    '@nx/angular': '21.6.3',
+    '@nx/eslint-plugin': '21.6.3',
+    '@nx/jest': '21.6.3',
+    '@nx/js': '21.6.3',
+    '@nx/workspace': '21.6.3',
+    '@schematics/angular': '20.3.4',
+    'angular-eslint': '^20.3.0',
+    eslint: '9.26.0',
+    jest: '^29.7.0',
+    'jest-environment-jsdom': '^29.7.0',
+    'jest-preset-angular': '^14.6.0',
+    'ng-packagr': '20.3.0',
+    nx: '21.6.3',
+    prettier: '^3.5.3',
+    sass: '^1.83.4',
+    tailwindcss: '^3.4.17',
+    typescript: '5.9.2',
+  };
+  return map[key];
+}
+
+function parseArgs(argv) {
+  const flags = {};
+  const positional = [];
+  for (let i = 0; i < argv.length; i++) {
+    const a = argv[i];
+    if (a === '--workspace' && argv[i + 1]) {
+      flags.workspace = argv[++i];
+      continue;
+    }
+    if (a.startsWith('--')) {
+      const eq = a.indexOf('=');
+      if (eq !== -1) {
+        flags[a.slice(2, eq)] = a.slice(eq + 1);
+      } else {
+        const key = a.slice(2);
+        const next = argv[i + 1];
+        if (next && !next.startsWith('--')) {
+          flags[key] = next;
+          i++;
+        } else {
+          flags[key] = true;
+        }
+      }
+      continue;
+    }
+    positional.push(a);
+  }
+  return { flags, positional };
+}
+
+function runStandalone(argv) {
+  const { flags, positional } = parseArgs(argv);
+  if (flags.help || flags.h) {
+    console.log(`
+Usage:
+  acorex-platform <project-directory> "<app title>" [options]
+
+Options:
+  --preset=full|minimal       Full module set vs minimal (default: full)
+  --connectivity=mock|api|none  Mock vs API app config; none warns and falls back to mock (default: mock)
+  --copyright="..."         Copyright line in platform config
+  --baseUrl=...               API base URL in environment
+  --skip-install              Do not run npm install
+  --dry-run                   Print actions only
+
+Examples:
+  npx @acorex/platform-generator@latest my-app "My App"
+  npx @acorex/platform-generator@latest my-app "My App" --preset=minimal --connectivity=api
+`);
+    process.exit(0);
+  }
+
+  const dryRun = Boolean(flags['dry-run']);
+  const skipInstall = Boolean(flags['skip-install']);
+  const outDir = positional[0];
+  const title = positional[1] ?? 'ACoreX App';
+
+  if (!outDir) {
+    console.error('[acorex-platform] Missing project directory. Example: acorex-platform my-app "My App"');
+    process.exit(1);
+  }
+
+  const resolvedOut = path.resolve(process.cwd(), outDir);
+  const name = path.basename(resolvedOut);
+
+  if (!dryRun && fs.existsSync(resolvedOut) && fs.readdirSync(resolvedOut).length > 0) {
+    console.error(`[acorex-platform] Directory is not empty: ${resolvedOut}`);
+    process.exit(1);
+  }
+
+  const versions = loadVersions();
+  const vars = normalizeOptions({
+    name,
+    title,
+    preset: flags.preset,
+    connectivity: flags.connectivity,
+    copyright: flags.copyright,
+    baseUrl: flags.baseUrl,
+    includeConsoleLogCapture: flags['include-console-log-capture'] === true || flags['include-console-log-capture'] === 'true',
+  });
+  vars.workspacePackageName =
+    name
+      .replace(/[^a-z0-9-]/gi, '-')
+      .toLowerCase()
+      .replace(/-+/g, '-')
+      .replace(/^-+|-+$/g, '') || 'acorex-app';
+
+  if (dryRun) {
+    console.log('[dry-run] Would create:', resolvedOut);
+    console.log('[dry-run] Options:', vars);
+    return;
+  }
+
+  fs.mkdirSync(resolvedOut, { recursive: true });
+
+  writeRootWorkspace(resolvedOut, vars, versions);
+
+  const appRoot = path.join(resolvedOut, 'apps', name);
+  fs.mkdirSync(appRoot, { recursive: true });
+
+  copyAppModuleTemplates(appRoot, vars);
+
+  mergeAppConfigFromPreset(appRoot, vars.preset);
+
+  if (vars.connectivityMode === 'api') {
+    applyApiAppConfig(appRoot);
+  }
+
+  if (!vars.includeApiConfig) {
+    deleteIfExists(path.join(appRoot, 'src', 'app', 'app.config.api.ts'));
+  }
+
+  if (vars.isMinimalPreset) {
+    pruneMinimalI18n(appRoot, name);
+  }
+
+  renameRootModule(appRoot, name);
+  renameModuleI18n(appRoot, name);
+
+  console.log(`\nCreated workspace at ${resolvedOut}`);
+  console.log('Next: cd ' + path.basename(resolvedOut) + ' && npm install && npm start\n');
+
+  if (!skipInstall) {
+    const isWindows = process.platform === 'win32';
+    const npmCmd = isWindows ? 'npm.cmd' : 'npm';
+    const r = spawnSync(npmCmd, ['install'], { cwd: resolvedOut, stdio: 'inherit', shell: isWindows });
+    process.exit(r.status === null ? 1 : r.status);
+  }
+}
+
+module.exports = { runStandalone, parseArgs, normalizeOptions };
+
+if (require.main === module) {
+  runStandalone(process.argv.slice(2));
+}