@ws-test-realm/admin-kit 0.1.10 → 0.1.13

package/hooks/ngcc.js

@@ -0,0 +1,41 @@
+// Built-in federation postInstall hook: run ngcc against the federation
+// node_modules tree so every @angular package gets `__processed_by_ivy_ngcc__`
+// markers and class definitions rewritten in place (ɵcmp/ɵdir/etc).
+//
+// Producers reference this hook from their lib's package.json:
+//
+//   "wsmodules": {
+//     "federationHooks": { "postInstall": "@ws-test-realm/admin-kit/hooks/ngcc" }
+//   }
+//
+// The hook resolves `@angular/compiler-cli/ngcc` from the PRODUCER workspace
+// (where compiler-cli is installed as a dev dep, alongside ng-cli, etc.).
+// The federation tree itself only holds runtime peer deps and won't have
+// compiler-cli unless a lib explicitly declares it.
+
+const Module = require("module");
+const path = require("path");
+
+module.exports = function ngccHook({ federationDir, producerWorkspaceDir, libName }) {
+  const requireFromProducer = Module.createRequire(
+    path.join(producerWorkspaceDir, "package.json")
+  );
+  let ngcc;
+  try {
+    ngcc = requireFromProducer("@angular/compiler-cli/ngcc");
+  } catch (e) {
+    console.warn(
+      `\x1b[33mWarning:\x1b[0m ngcc hook (${libName}): couldn't load @angular/compiler-cli/ngcc from ${producerWorkspaceDir}: ${e.message}`
+    );
+    return;
+  }
+
+  const basePath = path.join(federationDir, "node_modules");
+  console.log(`  ngcc: rewriting ${basePath}`);
+  ngcc.process({
+    basePath,
+    propertiesToConsider: ["module_ivy_ngcc", "browser", "module", "main"],
+    compileAllFormats: false,
+    async: false,
+  });
+};

package/lib/deploy-remotes.js

@@ -4,13 +4,31 @@ const { packIntoJar } = require("./pack-into-jar");
 const { loadOrder, partitionByKind } = require("./build-modules");
 const { findMatches } = require("./jar-glob");
 const { loadDeployContext, resolveTarget } = require("./target-resolution");
+const { promotePeerDeps, syncFederationWorkspace } = require("./federation-peers");
 
 function copyTypes(distLib, hostFederationDir) {
+  // Preserve any existing node_modules dir under the staged location —
+  // npm's workspace install populated it and the next syncFederationWorkspace
+  // run will reconcile. Replacing it on every type-copy would force a
+  // fresh per-lib install instead of letting npm hoist across siblings.
+  const preservedNodeModules = path.join(hostFederationDir, "node_modules");
+  let cached = null;
+  if (fs.existsSync(preservedNodeModules)) {
+    cached = preservedNodeModules + `.preserve-${process.pid}`;
+    fs.renameSync(preservedNodeModules, cached);
+  }
   if (fs.existsSync(hostFederationDir)) {
     fs.rmSync(hostFederationDir, { recursive: true, force: true });
   }
   fs.mkdirSync(hostFederationDir, { recursive: true });
   fs.cpSync(distLib, hostFederationDir, { recursive: true });
+  if (cached) {
+    fs.renameSync(cached, preservedNodeModules);
+  }
+  // Promote peerDependencies → dependencies in the staged package.json so
+  // npm's workspace install actually installs them. The producer's source
+  // package.json is untouched; this only affects the host-staged copy.
+  promotePeerDeps(hostFederationDir);
 }
 
 // Copy the federation artifact (dist/admin-remotes/<id>/) to the ext target
@@ -154,6 +172,21 @@ function deployRemotes({ workspaceDir, restrictTo = [], withDeps = false }) {
   }
 
   console.log(`\nDeployed ${results.length} module(s).`);
+
+  // Now that the .federation/<id>/ dirs are fresh, run a single workspace
+  // install at .federation/ to populate node_modules. npm hoists shared
+  // versions to .federation/node_modules/ and only nests on per-lib version
+  // conflicts. Consumers' TypeScript walks up from .federation/<id>/ and
+  // resolves transitive types without consumer-side dep management.
+  try {
+    syncFederationWorkspace(ctx.adminDir, workspaceDir);
+  } catch (e) {
+    console.warn(
+      `\x1b[33mWarning:\x1b[0m federation peer install failed: ${e.message}`
+    );
+    console.warn(`  Consumer workspaces may fail to type-check federated libs.`);
+  }
+
   return { results };
 }
 

package/lib/federation-peers.js

@@ -0,0 +1,184 @@
+const fs = require("fs");
+const path = require("path");
+const Module = require("module");
+const { execSync } = require("child_process");
+
+// Mirror a federation lib's peerDependencies into its dependencies in the
+// STAGED package.json under <adminDir>/.federation/<id>/. ng-packagr emits
+// peerDependencies — the canonical contract for a published library — but
+// for our publish-less federation we want npm to actually INSTALL those
+// peers (so consuming workspaces' TypeScript can resolve their types via
+// walk-up from .federation/<id>/). Promoting peer → dep in the staged copy
+// only doesn't touch the producer's source.
+function promotePeerDeps(libDir) {
+  const pkgPath = path.join(libDir, "package.json");
+  if (!fs.existsSync(pkgPath)) return false;
+  const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
+  if (!pkg.peerDependencies || !Object.keys(pkg.peerDependencies).length) {
+    return false;
+  }
+  pkg.dependencies = Object.assign({}, pkg.dependencies, pkg.peerDependencies);
+  fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
+  return true;
+}
+
+// Reconcile the entire .federation/ dir as an npm workspace root. Lists
+// every lib subdir as a workspace, runs `npm install` (npm hoists shared
+// peer versions, nests only on per-lib disagreement), then runs each
+// lib's declared postInstall hooks against the freshly installed tree.
+//
+// Hooks let a federation lib ship arbitrary prep work that consumers run
+// automatically — e.g. ws-framework declares
+// `wsmodules.federationHooks.postInstall = "@ws-test-realm/admin-kit/hooks/ngcc"`
+// so the consumer's install pipeline Ivy-rewrites the Angular tree in
+// place. admin-kit knows nothing about Angular here; the producer's
+// declaration drives what runs.
+//
+// Idempotent. Re-runs at the end of every deploy.
+function syncFederationWorkspace(adminDir, producerWorkspaceDir) {
+  const federationDir = path.join(adminDir, ".federation");
+  if (!fs.existsSync(federationDir)) return { installed: false };
+
+  const libs = listFederationLibs(federationDir);
+  if (!libs.length) return { installed: false };
+
+  writeWorkspaceManifest(federationDir, libs);
+
+  console.log(
+    `\n=== federation peers: install (${libs.length} workspace${libs.length === 1 ? "" : "s"}) ===`
+  );
+  console.log(`  at ${federationDir}`);
+  execSync("npm install --no-package-lock --no-audit --no-fund", {
+    cwd: federationDir,
+    stdio: "inherit",
+  });
+
+  runFederationHooks({ federationDir, libs, producerWorkspaceDir });
+
+  return { installed: true, libs };
+}
+
+// Walk each federation lib's package.json for declared postInstall hooks
+// (`wsmodules.federationHooks.postInstall`, string or array). Dedupe by
+// hook reference — multiple libs declaring the same hook (e.g. all
+// Angular libs referencing the built-in ngcc hook) run it once. Each hook
+// is a CommonJS module exporting a default function with signature
+// `({ federationDir, libDir, libName, producerWorkspaceDir }) => void`.
+//
+// Hook reference resolution:
+//   - "./..." or "../..."  → relative to the lib's federation dir
+//   - any other specifier  → node `require` resolution, first trying
+//                             admin-kit's own neighborhood (built-in hooks
+//                             like @ws-test-realm/admin-kit/hooks/ngcc),
+//                             then the producer workspace (third-party
+//                             hook packages).
+function runFederationHooks({ federationDir, libs, producerWorkspaceDir }) {
+  const queue = [];
+  const seen = new Set();
+  for (const libName of libs) {
+    const libDir = path.join(federationDir, libName);
+    const pkg = safeReadJson(path.join(libDir, "package.json"));
+    const refs = collectHookRefs(pkg);
+    for (const ref of refs) {
+      if (seen.has(ref)) continue;
+      seen.add(ref);
+      queue.push({ ref, libDir, libName });
+    }
+  }
+  if (!queue.length) return;
+
+  console.log(
+    `\n=== federation peers: postInstall hooks (${queue.length}) ===`
+  );
+  for (const { ref, libDir, libName } of queue) {
+    console.log(`  ${libName} → ${ref}`);
+    let hookFn;
+    try {
+      hookFn = resolveHook({ ref, libDir, producerWorkspaceDir });
+    } catch (e) {
+      console.warn(
+        `  \x1b[33mWarning:\x1b[0m couldn't load hook (${e.message})`
+      );
+      continue;
+    }
+    if (typeof hookFn !== "function") {
+      console.warn(
+        `  \x1b[33mWarning:\x1b[0m hook ${ref} did not export a function`
+      );
+      continue;
+    }
+    try {
+      hookFn({ federationDir, libDir, libName, producerWorkspaceDir });
+    } catch (e) {
+      console.warn(
+        `  \x1b[33mWarning:\x1b[0m hook ${ref} threw: ${e.message}`
+      );
+    }
+  }
+}
+
+function collectHookRefs(pkg) {
+  if (!pkg || !pkg.wsmodules || !pkg.wsmodules.federationHooks) return [];
+  const v = pkg.wsmodules.federationHooks.postInstall;
+  if (!v) return [];
+  return Array.isArray(v) ? v : [v];
+}
+
+function resolveHook({ ref, libDir, producerWorkspaceDir }) {
+  let resolvedPath;
+  if (ref.startsWith("./") || ref.startsWith("../")) {
+    resolvedPath = path.resolve(libDir, ref);
+  } else {
+    const adminKitRequire = Module.createRequire(
+      path.join(__dirname, "..", "package.json")
+    );
+    try {
+      resolvedPath = adminKitRequire.resolve(ref);
+    } catch {
+      const producerRequire = Module.createRequire(
+        path.join(producerWorkspaceDir, "package.json")
+      );
+      resolvedPath = producerRequire.resolve(ref);
+    }
+  }
+  return require(resolvedPath);
+}
+
+function listFederationLibs(federationDir) {
+  return fs
+    .readdirSync(federationDir, { withFileTypes: true })
+    .filter((e) => e.isDirectory())
+    .map((e) => e.name)
+    .filter((name) => {
+      if (name === "node_modules") return false;
+      return fs.existsSync(path.join(federationDir, name, "package.json"));
+    })
+    .sort();
+}
+
+function writeWorkspaceManifest(federationDir, libs) {
+  const pkg = {
+    name: "ws-federation-host",
+    private: true,
+    version: "0.0.0",
+    workspaces: libs.map((id) => `./${id}`),
+  };
+  fs.writeFileSync(
+    path.join(federationDir, "package.json"),
+    JSON.stringify(pkg, null, 2) + "\n"
+  );
+}
+
+function safeReadJson(file) {
+  try {
+    return JSON.parse(fs.readFileSync(file, "utf8"));
+  } catch {
+    return null;
+  }
+}
+
+module.exports = {
+  promotePeerDeps,
+  syncFederationWorkspace,
+  listFederationLibs,
+};

package/lib/purge-remotes.js

@@ -3,6 +3,7 @@ const path = require("path");
 const { purgeJar } = require("./purge-jar");
 const { loadOrder, partitionByKind } = require("./build-modules");
 const { loadDeployContext, resolveTarget } = require("./target-resolution");
+const { syncFederationWorkspace } = require("./federation-peers");
 
 // Per-remote purge action. Returns a structured action record.
 function purgeOne({ workspaceDir, id, ctx }) {
@@ -120,6 +121,20 @@ function purgeRemotes({
   }
 
   reportActions({ actions, skipped, errors });
+
+  // Removed federation type dirs ⇒ workspaces list is stale; resync so
+  // the remaining libs stay correctly installed (and orphaned ones stop
+  // claiming workspace slots).
+  if (actions.some((a) => a.typesRemoved)) {
+    try {
+      syncFederationWorkspace(ctx.adminDir, workspaceDir);
+    } catch (e) {
+      console.warn(
+        `\x1b[33mWarning:\x1b[0m federation peer resync failed: ${e.message}`
+      );
+    }
+  }
+
   return { actions, skipped, errors };
 }
 

package/lib/wire-host.js

@@ -53,6 +53,16 @@ function rebuildFederationTsconfig(workspaceDir) {
     federationTarget = path.join(hostDir, ".federation", "*");
     paths["@ws-remote/*"] = [federationTarget];
   }
+  // Catch-all fallback: any unresolved import resolves against this
+  // workspace's own node_modules. Required for cross-workspace federation
+  // siblings (e.g. @ws-remote/ws-framework) whose .d.ts files reference
+  // transitive deps (@angular/material/form-field, etc.) — TS walks up
+  // from the .d.ts file's location to find node_modules, but federation
+  // remotes live under <wpmRoot>/admin/.federation/ outside any consumer
+  // workspace's tree. This catch-all lets TS fall back to the consumer's
+  // node_modules regardless of where the .d.ts lives. Must come AFTER
+  // specific paths so they win on prefix match.
+  paths["*"] = ["./node_modules/*"];
   // tsconfig.federation.json is the leaf of the extends chain. Its single
   // responsibility now is to combine the workspace-local `paths` with the
   // canonical compiler options from @ws-test-realm/devkit/tsconfig.base.json.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ws-test-realm/admin-kit",
-  "version": "0.1.10",
+  "version": "0.1.13",
   "description": "Workflow CLI + scaffolding for Wiresphere admin-modules workspaces. Ships `ws-init-workspace` (init/merge into a project, stamps @wiresphere/shared's `getOverrides()` into the workspace's npm overrides block), `ws-modules` (build/pack/deploy driver), `ws-generate-module`/`ws-drop-module`, `ws-wire-host`, `ws-wire-pom`, `ws-sync-paths`, and `ws-pack-remote`. Depends on @wiresphere/devkit (toolchain BOM, peerDeps); pairs with @wiresphere/shared (runtime BOM + MF share map + overrides manifest). Requires npm 9+ for overrides + peerDep resolution to coexist cleanly.",
   "license": "Artistic-2.0",
   "publishConfig": {
@@ -21,6 +21,7 @@
   "files": [
     "bin",
     "lib",
+    "hooks",
     "template",
     "template-module",
     "README.md"