@open-mercato/cli 0.4.9-develop-94fb251ed3 → 0.4.9-develop-8d8db18714

package/src/lib/module-install.ts

@@ -0,0 +1,234 @@
+import fs from 'node:fs'
+import path from 'node:path'
+import { spawn } from 'node:child_process'
+import { copyDirRecursive, rewriteCrossModuleImports } from './eject'
+import {
+  parsePackageNameFromSpec,
+  resolveInstalledOfficialModulePackage,
+  validateEjectBoundaries,
+  type ValidatedOfficialModulePackage,
+} from './module-package'
+import { ensureModuleRegistration } from './modules-config'
+import type { PackageResolver } from './resolver'
+
+type ModuleCommandResult = {
+  moduleId: string
+  packageName: string
+  from: string
+  registrationChanged: boolean
+}
+
+type InstallTarget = {
+  cwd: string
+  args: string[]
+}
+
+function resolveYarnBinary(): string {
+  return process.platform === 'win32' ? 'yarn.cmd' : 'yarn'
+}
+
+function readAppPackageName(appDir: string): string {
+  const packageJsonPath = path.join(appDir, 'package.json')
+  if (!fs.existsSync(packageJsonPath)) {
+    throw new Error(`App package.json not found at ${packageJsonPath}.`)
+  }
+
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')) as { name?: string }
+  if (!packageJson.name) {
+    throw new Error(`App package.json at ${packageJsonPath} is missing the "name" field.`)
+  }
+
+  return packageJson.name
+}
+
+function resolveInstallTarget(resolver: PackageResolver): InstallTarget {
+  if (!resolver.isMonorepo()) {
+    return {
+      cwd: resolver.getAppDir(),
+      args: ['add'],
+    }
+  }
+
+  return {
+    cwd: resolver.getRootDir(),
+    args: ['workspace', readAppPackageName(resolver.getAppDir()), 'add'],
+  }
+}
+
+function runCommand(
+  command: string,
+  args: string[],
+  cwd: string,
+): Promise<void> {
+  return new Promise((resolve, reject) => {
+    const child = spawn(command, args, {
+      cwd,
+      env: process.env,
+      stdio: 'inherit',
+    })
+
+    child.on('error', reject)
+    child.on('exit', (code) => {
+      if (code === 0) {
+        resolve()
+        return
+      }
+
+      reject(new Error(`Command failed: ${command} ${args.join(' ')} (exit ${code ?? 'unknown'}).`))
+    })
+  })
+}
+
+async function installPackageSpec(
+  resolver: PackageResolver,
+  packageSpec: string,
+): Promise<void> {
+  const target = resolveInstallTarget(resolver)
+  await runCommand(resolveYarnBinary(), [...target.args, packageSpec], target.cwd)
+}
+
+export async function runModuleGenerators(
+  resolver: PackageResolver,
+  quiet = true,
+): Promise<void> {
+  const {
+    generateEntityIds,
+    generateModuleDi,
+    generateModuleEntities,
+    generateModulePackageSources,
+    generateModuleRegistry,
+    generateModuleRegistryCli,
+    generateOpenApi,
+  } = await import('./generators')
+
+  await generateEntityIds({ resolver, quiet })
+  await generateModuleRegistry({ resolver, quiet })
+  await generateModuleRegistryCli({ resolver, quiet })
+  await generateModuleEntities({ resolver, quiet })
+  await generateModuleDi({ resolver, quiet })
+  await generateModulePackageSources({ resolver, quiet })
+  await generateOpenApi({ resolver, quiet })
+}
+
+async function runGeneratorsWithRegistrationNotice(
+  resolver: PackageResolver,
+  moduleId: string,
+): Promise<void> {
+  try {
+    await runModuleGenerators(resolver)
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error)
+    throw new Error(
+      `Module "${moduleId}" is enabled, but generated artifacts are stale because generation failed. Rerun "yarn mercato generate" after fixing the underlying error. ${message}`,
+    )
+  }
+}
+
+function assertPackageName(packageName: string | null): asserts packageName is string {
+  if (!packageName || !packageName.startsWith('@open-mercato/')) {
+    throw new Error('Only @open-mercato/* package specs are supported by "mercato module add".')
+  }
+}
+
+function validateBeforeRegistration(
+  modulePackage: ValidatedOfficialModulePackage,
+  resolver: PackageResolver,
+  eject: boolean,
+): string {
+  const appModuleDir = path.join(resolver.getAppDir(), 'src', 'modules', modulePackage.metadata.moduleId)
+
+  if (eject && fs.existsSync(appModuleDir)) {
+    throw new Error(`Destination directory already exists: ${appModuleDir}. Remove it first or rerun without --eject.`)
+  }
+
+  return appModuleDir
+}
+
+function prepareRegistrationSource(
+  modulePackage: ValidatedOfficialModulePackage,
+  resolver: PackageResolver,
+  packageName: string,
+  eject: boolean,
+): string {
+  const appModuleDir = validateBeforeRegistration(modulePackage, resolver, eject)
+
+  if (!eject) {
+    return packageName
+  }
+
+  if (!modulePackage.metadata.ejectable) {
+    throw new Error(`Package "${packageName}" is not ejectable. --eject requires open-mercato.ejectable === true.`)
+  }
+
+  validateEjectBoundaries(modulePackage)
+  copyDirRecursive(modulePackage.sourceModuleDir, appModuleDir)
+  rewriteCrossModuleImports(
+    modulePackage.sourceModuleDir,
+    appModuleDir,
+    modulePackage.metadata.moduleId,
+    packageName,
+  )
+
+  return '@app'
+}
+
+async function registerResolvedOfficialModule(
+  resolver: PackageResolver,
+  modulePackage: ValidatedOfficialModulePackage,
+  packageName: string,
+  eject: boolean,
+): Promise<ModuleCommandResult> {
+  const from = prepareRegistrationSource(modulePackage, resolver, packageName, eject)
+
+  const registration = ensureModuleRegistration(
+    resolver.getModulesConfigPath(),
+    {
+      id: modulePackage.metadata.moduleId,
+      from,
+    },
+  )
+
+  if (!registration.changed) {
+    throw new Error(
+      `Module "${modulePackage.metadata.moduleId}" from "${from}" is already enabled in modules.ts.`,
+    )
+  }
+
+  await runGeneratorsWithRegistrationNotice(resolver, modulePackage.metadata.moduleId)
+
+  return {
+    moduleId: modulePackage.metadata.moduleId,
+    packageName,
+    from,
+    registrationChanged: registration.changed,
+  }
+}
+
+export async function addOfficialModule(
+  resolver: PackageResolver,
+  packageSpec: string,
+  eject: boolean,
+  moduleId?: string,
+): Promise<ModuleCommandResult> {
+  const packageName = parsePackageNameFromSpec(packageSpec)
+  assertPackageName(packageName)
+
+  await installPackageSpec(resolver, packageSpec)
+
+  const modulePackage = resolveInstalledOfficialModulePackage(resolver, packageName, moduleId)
+  return registerResolvedOfficialModule(resolver, modulePackage, packageName, eject)
+}
+
+export async function enableOfficialModule(
+  resolver: PackageResolver,
+  packageName: string,
+  moduleId?: string,
+  eject = false,
+): Promise<ModuleCommandResult> {
+  if (!packageName.startsWith('@open-mercato/')) {
+    throw new Error('Only @open-mercato/* packages can be enabled with "mercato module enable".')
+  }
+
+  const modulePackage = resolveInstalledOfficialModulePackage(resolver, packageName, moduleId)
+  return registerResolvedOfficialModule(resolver, modulePackage, packageName, eject)
+}

package/src/lib/module-package.ts

@@ -0,0 +1,355 @@
+import fs from 'node:fs'
+import path from 'node:path'
+import { createRequire } from 'node:module'
+import type { PackageResolver } from './resolver'
+
+type PackageJsonRecord = {
+  name?: string
+  version?: string
+  dependencies?: Record<string, string>
+  peerDependencies?: Record<string, string>
+}
+
+export type ModulePackageMetadata = {
+  moduleId: string
+  ejectable: boolean
+}
+
+export type ModuleInfoSnapshot = {
+  title?: string
+  description?: string
+}
+
+export type ValidatedOfficialModulePackage = {
+  packageName: string
+  packageRoot: string
+  packageJson: PackageJsonRecord
+  metadata: ModulePackageMetadata
+  moduleInfo: ModuleInfoSnapshot
+  sourceModuleDir: string
+  distModuleDir: string
+}
+
+type DiscoveredModule = {
+  moduleId: string
+  ejectable: boolean
+}
+
+const SOURCE_FILE_EXTENSIONS = ['.ts', '.tsx', '.js', '.jsx', '.mjs', '.cjs']
+const SKIP_DIRS = new Set(['__tests__', '__mocks__', 'node_modules'])
+const MODULE_ID_PATTERN = /^[a-z0-9]+(?:_[a-z0-9]+)*$/
+const requireFromCli = createRequire(path.join(process.cwd(), 'package.json'))
+
+function shouldSkipEntryName(name: string): boolean {
+  return SKIP_DIRS.has(name) || name === '.DS_Store' || name.startsWith('._')
+}
+
+function readPackageJson(packageJsonPath: string): PackageJsonRecord {
+  try {
+    const raw = fs.readFileSync(packageJsonPath, 'utf8')
+    return JSON.parse(raw) as PackageJsonRecord
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error)
+    throw new Error(`Failed to read package manifest at ${packageJsonPath}: ${message}`)
+  }
+}
+
+function parseModuleInfo(indexPath: string): { title?: string; description?: string; ejectable?: boolean } {
+  if (!fs.existsSync(indexPath)) return {}
+
+  const source = fs.readFileSync(indexPath, 'utf8')
+  const result: { title?: string; description?: string; ejectable?: boolean } = {}
+
+  const titleMatch = source.match(/\btitle\s*:\s*['"]([^'"]+)['"]/)
+  if (titleMatch) result.title = titleMatch[1]
+
+  const descriptionMatch = source.match(/\bdescription\s*:\s*['"]([^'"]+)['"]/)
+  if (descriptionMatch) result.description = descriptionMatch[1]
+
+  const ejectableMatch = source.match(/\bejectable\s*:\s*(true|false)/)
+  if (ejectableMatch) result.ejectable = ejectableMatch[1] === 'true'
+
+  return result
+}
+
+export function discoverModulesInPackage(packageRoot: string): DiscoveredModule[] {
+  const srcModulesDir = path.join(packageRoot, 'src', 'modules')
+  const distModulesDir = path.join(packageRoot, 'dist', 'modules')
+
+  const enumerationDir = fs.existsSync(srcModulesDir)
+    ? srcModulesDir
+    : fs.existsSync(distModulesDir)
+      ? distModulesDir
+      : null
+
+  if (!enumerationDir) return []
+
+  const modules: DiscoveredModule[] = []
+
+  for (const entry of fs.readdirSync(enumerationDir, { withFileTypes: true })) {
+    if (!entry.isDirectory() || shouldSkipEntryName(entry.name) || !MODULE_ID_PATTERN.test(entry.name)) continue
+
+    const moduleId = entry.name
+    const srcIndexPath = path.join(packageRoot, 'src', 'modules', moduleId, 'index.ts')
+    const distIndexPath = path.join(packageRoot, 'dist', 'modules', moduleId, 'index.js')
+    const indexPath = fs.existsSync(srcIndexPath) ? srcIndexPath : distIndexPath
+
+    const info = parseModuleInfo(indexPath)
+    modules.push({ moduleId, ejectable: info.ejectable ?? false })
+  }
+
+  return modules
+}
+
+function resolveRelativeImportTarget(sourceFile: string, importPath: string): string | null {
+  if (!importPath.startsWith('.')) return null
+
+  const basePath = path.resolve(path.dirname(sourceFile), importPath)
+  const candidates = [basePath]
+
+  for (const ext of SOURCE_FILE_EXTENSIONS) {
+    candidates.push(`${basePath}${ext}`)
+    candidates.push(path.join(basePath, `index${ext}`))
+  }
+
+  for (const candidate of candidates) {
+    if (fs.existsSync(candidate)) {
+      return candidate
+    }
+  }
+
+  return null
+}
+
+function collectSourceFiles(dir: string): string[] {
+  const files: string[] = []
+  const entries = fs.readdirSync(dir, { withFileTypes: true })
+
+  for (const entry of entries) {
+    if (shouldSkipEntryName(entry.name)) continue
+
+    const fullPath = path.join(dir, entry.name)
+    if (entry.isDirectory()) {
+      files.push(...collectSourceFiles(fullPath))
+      continue
+    }
+
+    const ext = path.extname(entry.name)
+    if (!SOURCE_FILE_EXTENSIONS.includes(ext)) continue
+    files.push(fullPath)
+  }
+
+  return files
+}
+
+function collectBoundaryViolations(moduleDir: string): string[] {
+  const modulesRoot = path.resolve(moduleDir, '..')
+  const modulePrefix = `${moduleDir}${path.sep}`
+  const modulesPrefix = `${modulesRoot}${path.sep}`
+  const files = collectSourceFiles(moduleDir)
+  const violations = new Set<string>()
+
+  for (const filePath of files) {
+    const content = fs.readFileSync(filePath, 'utf8')
+    const matches = [
+      ...content.matchAll(/\bfrom\s*['"]([^'"]+)['"]/g),
+      ...content.matchAll(/\bimport\s*\(\s*['"]([^'"]+)['"]\s*\)/g),
+    ]
+
+    for (const match of matches) {
+      const specifier = match[1]
+      if (!specifier) continue
+      const resolvedTarget = resolveRelativeImportTarget(filePath, specifier)
+      if (!resolvedTarget) continue
+      if (resolvedTarget.startsWith(modulePrefix)) continue
+      if (resolvedTarget.startsWith(modulesPrefix)) continue
+
+      const relativeSource = path.relative(moduleDir, filePath).split(path.sep).join('/')
+      const relativeTarget = path.relative(path.dirname(filePath), resolvedTarget).split(path.sep).join('/')
+      violations.add(`${relativeSource} -> ${relativeTarget}`)
+    }
+  }
+
+  return Array.from(violations).sort((left, right) => left.localeCompare(right))
+}
+
+function findResolvedPackageRoot(
+  resolvedPath: string,
+  packageName: string,
+): string | null {
+  let currentPath = fs.statSync(resolvedPath).isDirectory()
+    ? resolvedPath
+    : path.dirname(resolvedPath)
+
+  while (currentPath !== path.dirname(currentPath)) {
+    const packageJsonPath = path.join(currentPath, 'package.json')
+    if (fs.existsSync(packageJsonPath)) {
+      const packageJson = readPackageJson(packageJsonPath)
+      if (packageJson.name === packageName) {
+        return currentPath
+      }
+    }
+    currentPath = path.dirname(currentPath)
+  }
+
+  return null
+}
+
+function resolveInstalledPackageRootWithRequire(packageName: string, appDir: string): string | null {
+  const specifiers = [`${packageName}/package.json`, packageName]
+
+  for (const specifier of specifiers) {
+    try {
+      const resolvedPath = requireFromCli.resolve(specifier, {
+        paths: [appDir],
+      })
+      const packageRoot =
+        specifier === packageName
+          ? findResolvedPackageRoot(resolvedPath, packageName)
+          : path.dirname(resolvedPath)
+
+      if (packageRoot) {
+        return packageRoot
+      }
+    } catch {
+      continue
+    }
+  }
+
+  return null
+}
+
+export function parsePackageNameFromSpec(packageSpec: string): string | null {
+  const trimmed = packageSpec.trim()
+  if (!trimmed) return null
+
+  if (trimmed.startsWith('@')) {
+    const slashIndex = trimmed.indexOf('/')
+    if (slashIndex < 0) return null
+    const versionSeparator = trimmed.indexOf('@', slashIndex + 1)
+    return versionSeparator < 0 ? trimmed : trimmed.slice(0, versionSeparator)
+  }
+
+  const versionSeparator = trimmed.indexOf('@')
+  return versionSeparator < 0 ? trimmed : trimmed.slice(0, versionSeparator)
+}
+
+export function resolveInstalledPackageRoot(
+  resolver: PackageResolver,
+  packageName: string,
+): string {
+  const resolvedWithRequire = resolveInstalledPackageRootWithRequire(packageName, resolver.getAppDir())
+  if (resolvedWithRequire) {
+    return resolvedWithRequire
+  }
+
+  const fallback = resolver.getPackageRoot(packageName)
+  if (fs.existsSync(path.join(fallback, 'package.json'))) {
+    return fallback
+  }
+
+  // In monorepo mode, getPackageRoot resolves to packages/<name> (workspace convention),
+  // but externally installed packages land in root node_modules — check there too.
+  const nodeModulesFallback = path.join(resolver.getRootDir(), 'node_modules', packageName)
+  if (fs.existsSync(path.join(nodeModulesFallback, 'package.json'))) {
+    return nodeModulesFallback
+  }
+
+  throw new Error(`Package "${packageName}" is not installed in ${resolver.getAppDir()}.`)
+}
+
+export function readOfficialModulePackageFromRoot(
+  packageRoot: string,
+  expectedPackageName?: string,
+  targetModuleId?: string,
+): ValidatedOfficialModulePackage {
+  const packageJsonPath = path.join(packageRoot, 'package.json')
+  if (!fs.existsSync(packageJsonPath)) {
+    throw new Error(`Package manifest not found at ${packageJsonPath}.`)
+  }
+
+  const packageJson = readPackageJson(packageJsonPath)
+  const packageName = packageJson.name
+  if (!packageName || !packageName.startsWith('@open-mercato/')) {
+    throw new Error(`Package at ${packageRoot} is not under the @open-mercato scope.`)
+  }
+
+  if (expectedPackageName && packageName !== expectedPackageName) {
+    throw new Error(`Resolved package "${packageName}" does not match requested package "${expectedPackageName}".`)
+  }
+
+  const discoveredModules = discoverModulesInPackage(packageRoot)
+
+  if (discoveredModules.length === 0) {
+    throw new Error(`Package "${packageName}" has no modules in src/modules/ or dist/modules/.`)
+  }
+
+  let selected: DiscoveredModule
+
+  if (targetModuleId) {
+    const found = discoveredModules.find((m) => m.moduleId === targetModuleId)
+    if (!found) {
+      const available = discoveredModules.map((m) => m.moduleId).join(', ')
+      throw new Error(
+        `Package "${packageName}" does not contain module "${targetModuleId}". Available: ${available}`,
+      )
+    }
+    selected = found
+  } else {
+    if (discoveredModules.length > 1) {
+      const available = discoveredModules.map((m) => m.moduleId).join(', ')
+      throw new Error(
+        `Package "${packageName}" contains multiple modules (${available}). Specify one with --module <moduleId>.`,
+      )
+    }
+    selected = discoveredModules[0]
+  }
+
+  const { moduleId } = selected
+  const sourceModuleDir = path.join(packageRoot, 'src', 'modules', moduleId)
+  const distModuleDir = path.join(packageRoot, 'dist', 'modules', moduleId)
+
+  if (!fs.existsSync(sourceModuleDir)) {
+    throw new Error(`Package "${packageName}" is missing src/modules/${moduleId}.`)
+  }
+
+  if (!fs.existsSync(distModuleDir)) {
+    throw new Error(`Package "${packageName}" is missing dist/modules/${moduleId}.`)
+  }
+
+  const info = parseModuleInfo(path.join(sourceModuleDir, 'index.ts'))
+
+  return {
+    packageName,
+    packageRoot,
+    packageJson,
+    metadata: { moduleId, ejectable: selected.ejectable },
+    moduleInfo: { title: info.title, description: info.description },
+    sourceModuleDir,
+    distModuleDir,
+  }
+}
+
+export function resolveInstalledOfficialModulePackage(
+  resolver: PackageResolver,
+  packageName: string,
+  moduleId?: string,
+): ValidatedOfficialModulePackage {
+  const packageRoot = resolveInstalledPackageRoot(resolver, packageName)
+  return readOfficialModulePackageFromRoot(packageRoot, packageName, moduleId)
+}
+
+export function validateEjectBoundaries(modulePackage: ValidatedOfficialModulePackage): void {
+  const violations = collectBoundaryViolations(modulePackage.sourceModuleDir)
+  if (violations.length === 0) {
+    return
+  }
+
+  throw new Error(
+    [
+      `Package "${modulePackage.packageName}" cannot be added with --eject because it imports files outside src/modules/${modulePackage.metadata.moduleId}.`,
+      'Invalid imports:',
+      ...violations.map((violation) => `- ${violation}`),
+    ].join('\n'),
+  )
+}