@domesystems/templates 0.3.2 → 0.3.3

package/README.md

@@ -8,7 +8,7 @@ npx @domesystems/templates pull dome-systems/ai-agent-for-documentation --regist
 npx @domesystems/templates up --dir ai-agent-for-documentation
 ```
 
-Every remote command takes either `--server <Dome application URL>` or `--registry <Registry URL>`. `--server` discovers the Registry endpoint through the app server; `--registry` connects directly to an explicitly supplied Registry. A successful login makes that endpoint the default for later remote commands; either flag overrides it. Credentials are isolated per selected endpoint.
+Remote commands use `https://templates-registry.domesystems.ai` by default. Pass either `--server <Dome application URL>` to discover a different Registry endpoint through an app server, or `--registry <Registry URL>` to connect directly. A successful login makes that endpoint the default for later remote commands; either flag overrides it. Credentials are isolated per selected endpoint.
 
 Use direct Registry endpoints when the app-server discovery document is unavailable:
 
@@ -28,11 +28,11 @@ templates login [--server <URL>|--registry <URL>] [--github]
 templates logout [--server <URL>|--registry <URL>]
 templates doctor <pull|up|publish> [--dir <directory>] [--server <URL>|--registry <URL>] [--json]
 templates pull <scope/package[@version]> [--dir <directory>] [--server <URL>|--registry <URL>]
-templates up [--dir <directory>] [--port <host-port>] [--skip-provision|--provision] [--no-start] [--detach]
+templates up [--dir <directory>] [--port <host-port>] [--server <URL>|--registry <URL>] [--import-job <job-id>] [--skip-provision|--provision] [--no-start] [--detach]
 templates publish [--dry-run] [--server <URL>|--registry <URL>]
 ```
 
-`pull` only accepts scoped package names, verifies the Registry SHA-256 before extraction, accepts only the archive's `template/` root, writes `.dome-template-lock.yaml`, and never overwrites a non-empty directory. `up` is local-only and never downloads or updates a release. `publish` reads the scoped name and SemVer version from `template.yaml`, requires a clean Git checkout, and cannot replace a published version.
+`pull` only accepts scoped package names, verifies the Registry SHA-256 before extraction, accepts only the archive's `template/` root, writes `.dome-template-lock.yaml`, and never overwrites a non-empty directory. `up` is local-only and never downloads or updates a release. When it provisions an unconfigured runtime, it reveals the import's one-time agent token, resolves the workspace default Gateway, and writes only `DOME_TOKEN` and `DOME_GATEWAY_URL` to the ignored `.env` before starting Docker. `publish` reads the scoped name and SemVer version from `template.yaml`, requires a clean Git checkout, and cannot replace a published version.
 
 Use `--verbose` with a command to include its diagnostic stack trace when it fails. When publishing requires a GitHub connection, the CLI opens the authorization page automatically; complete it, then run `publish` again.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@domesystems/templates",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Pull, publish, and run versioned Dome templates.",
   "repository": {
     "type": "git",

package/src/cli.mjs

@@ -1,31 +1,30 @@
 import fs from "node:fs";
 import path from "node:path";
 import { spawn, spawnSync } from "node:child_process";
-import readline from "node:readline/promises";
 import { readManifest, readPublishManifest } from "./manifest.mjs";
 import { imageForRuntime, renderCompose } from "./runtime.mjs";
-import { extractRelease, initializeEnvironment } from "./template-files.mjs";
+import { extractRelease, initializeEnvironment, writeRuntimeEnvironment } from "./template-files.mjs";
 import { createArchive, publishSource } from "./publish-files.mjs";
-import { DEFAULT_SERVER, clearSelectedTarget, deleteProfile, directRegistry, discover, login, normalizeServer, readProfile, readSelectedTarget, registryRequest, writeSelectedTarget } from "./registry.mjs";
+import { DEFAULT_REGISTRY, clearSelectedTarget, deleteProfile, directRegistry, discover, login, normalizeServer, readProfile, readSelectedTarget, registryRequest, writeSelectedTarget } from "./registry.mjs";
 
 function ansi(code, value, options) { return options.color && process.stdout.isTTY ? `\u001B[${code}m${value}\u001B[0m` : value; }
 function line(kind, value, options) { const styles = { info: ["•", "36"], success: ["✓", "32"], warning: ["!", "33"], error: ["✗", "31"] }; const [mark, code] = styles[kind]; return `${ansi(code, mark, options)} ${value}`; }
-function usage() { return "Usage:\n  templates login [--server <Dome application URL>|--registry <Registry URL>] [--github]\n  templates logout [--server <Dome application URL>|--registry <Registry URL>]\n  templates doctor <pull|up|publish> [package] [--dir <directory>] [--server <URL>|--registry <URL>] [--json]\n  templates pull <scope/package[@version]> [--dir <directory>] [--server <URL>|--registry <URL>]\n  templates up [--dir <directory>] [--port <host-port>] [--skip-provision|--provision] [--no-start] [--detach] [--verbose]\n  templates publish [--dry-run] [--server <Dome application URL>|--registry <Registry URL>]\n"; }
+function usage() { return "Usage:\n  templates login [--server <Dome application URL>|--registry <Registry URL>] [--github]\n  templates logout [--server <Dome application URL>|--registry <Registry URL>]\n  templates doctor <pull|up|publish> [package] [--dir <directory>] [--server <URL>|--registry <URL>] [--json]\n  templates pull <scope/package[@version]> [--dir <directory>] [--server <URL>|--registry <URL>]\n  templates up [--dir <directory>] [--port <host-port>] [--server <URL>|--registry <URL>] [--import-job <job-id>] [--skip-provision|--provision] [--no-start] [--detach] [--verbose]\n  templates publish [--dry-run] [--server <Dome application URL>|--registry <Registry URL>]\n"; }
 function parse(argv) {
   if (!argv.length || argv.includes("--help") || argv.includes("-h")) return { help: true };
   const [command, ...rest] = argv;
-  const options = { server: undefined, directory: undefined, port: 3000, dryRun: false, json: false, github: false, provision: true, forceProvision: false, start: true, detach: false, verbose: false, color: !process.env.NO_COLOR };
+  const options = { server: undefined, directory: undefined, port: 3000, dryRun: false, json: false, github: false, importJob: undefined, provision: true, forceProvision: false, start: true, detach: false, verbose: false, color: !process.env.NO_COLOR };
   const values = [];
   for (let i = 0; i < rest.length; i += 1) {
     const arg = rest[i];
-    if (arg === "--server" || arg === "--registry" || arg === "--dir" || arg === "--port" || arg === "--color") { const value = rest[++i]; if (!value) throw new Error(`${arg} requires a value.`); if (arg === "--server") options.server = normalizeServer(value); else if (arg === "--registry") options.registry = normalizeServer(value); else if (arg === "--dir") options.directory = value; else if (arg === "--color") { if (!["auto", "always", "never"].includes(value)) throw new Error("--color must be auto, always, or never."); options.color = value === "always" || (value === "auto" && !process.env.NO_COLOR); } else { options.port = Number(value); if (!Number.isInteger(options.port) || options.port < 1 || options.port > 65535) throw new Error("--port requires an integer from 1 to 65535."); } }
+    if (arg === "--server" || arg === "--registry" || arg === "--dir" || arg === "--port" || arg === "--color" || arg === "--import-job") { const value = rest[++i]; if (!value) throw new Error(`${arg} requires a value.`); if (arg === "--server") options.server = normalizeServer(value); else if (arg === "--registry") options.registry = normalizeServer(value); else if (arg === "--dir") options.directory = value; else if (arg === "--import-job") options.importJob = value; else if (arg === "--color") { if (!["auto", "always", "never"].includes(value)) throw new Error("--color must be auto, always, or never."); options.color = value === "always" || (value === "auto" && !process.env.NO_COLOR); } else { options.port = Number(value); if (!Number.isInteger(options.port) || options.port < 1 || options.port > 65535) throw new Error("--port requires an integer from 1 to 65535."); } }
     else if (arg === "--github") options.github = true; else if (arg === "--dry-run") options.dryRun = true; else if (arg === "--json") options.json = true; else if (arg === "--skip-provision") options.provision = false; else if (arg === "--provision") options.forceProvision = true; else if (arg === "--no-start") options.start = false; else if (arg === "--detach") options.detach = true; else if (arg === "--verbose") options.verbose = true; else if (arg.startsWith("-")) throw new Error(`Unknown option: ${arg}`); else values.push(arg);
   }
   if (options.server && options.registry) throw new Error("Use either --server or --registry, not both.");
   if (!["login", "logout", "doctor", "pull", "up", "publish"].includes(command)) throw new Error(`Unknown command: ${command}`);
   return { command, values, options };
 }
-function remoteTarget(options) { return options.registry ? directRegistry(options.registry) : options.server ?? readSelectedTarget() ?? DEFAULT_SERVER; }
+function remoteTarget(options) { return options.registry ? directRegistry(options.registry) : options.server ?? readSelectedTarget() ?? directRegistry(DEFAULT_REGISTRY); }
 function remoteLocation(options) { const target = remoteTarget(options); return typeof target === "string" ? `--server ${target}` : `--registry ${target.registry}`; }
 const githubPublishingAccessMessage = "GitHub publishing access is required.";
 function openBrowser(url) {
@@ -54,8 +53,22 @@ async function pull(name, options, output, fetchImplementation) {
   output(line("success", `Pulled ${release.name}@${release.version}`, options)); output(`  Saved to ${target}`); if (created) output(line("success", "Created .env from .env.example", options));
 }
 function run(command, args, cwd) { const result = spawnSync(command, args, { cwd, stdio: "inherit" }); if (result.error || result.status !== 0) throw new Error(`${command} ${args.join(" ")} failed.`); }
+function json(text, command) { try { return JSON.parse(text.slice(text.indexOf("{"))); } catch { throw new Error(`${command} did not return valid JSON.`); } }
+function runJSON(command, args, cwd, { reveal = false } = {}) {
+  return new Promise((resolve, reject) => {
+    const child = spawn(command, args, { cwd, stdio: ["inherit", "pipe", "inherit"] });
+    let stdout = "";
+    child.stdout.on("data", (chunk) => { stdout += chunk; if (reveal) process.stdout.write(chunk); });
+    child.on("error", () => reject(new Error(`${command} ${args.join(" ")} failed.`)));
+    child.on("close", (status) => status === 0 ? resolve(json(stdout, command)) : reject(new Error(`${command} ${args.join(" ")} failed.`)));
+  });
+}
 function configured(target) { const env = path.join(target, ".env"); return fs.existsSync(env) && ["DOME_TOKEN", "DOME_GATEWAY_URL"].every((key) => new RegExp(`^${key}=(?!\\s*$|undefined|\"\")`, "m").test(fs.readFileSync(env, "utf8"))); }
-async function up(options, output) { const target = path.resolve(process.cwd(), options.directory ?? "."); const manifest = readManifest(target); output(line("info", `Checking ${target}`, options)); fs.writeFileSync(path.join(target, ".dome-compose.yaml"), renderCompose(manifest.app.runtime, options.port)); if (options.provision && (!configured(target) || options.forceProvision)) { output(line("info", "Setting up Dome resources", options)); run("dome", ["import", "dome.tf"], target); } if (options.start) { output(line("info", `Starting app at http://localhost:${options.port}`, options)); run("docker", ["compose", "-f", ".dome-compose.yaml", "up", ...(options.detach ? ["--detach"] : [])], target); } }
+export function importMadeNoChanges(job) { const summary = job?.plan_summary ?? job?.planSummary; if (!summary) return false; return ["create_count", "update_count", "import_count"].every((key) => Number(summary[key] ?? summary[key.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase())] ?? 0) === 0); }
+export function importHasPendingOutputs(job) { return (job?.outputs_state ?? job?.outputsState) === "pending"; }
+export function importCreatedResources(job) { const summary = job?.plan_summary ?? job?.planSummary; return Number(summary?.create_count ?? summary?.createCount ?? 0) > 0; }
+async function configureRuntime(target, jobID, options, output) { const gateways = await runJSON("dome", ["gateways", "list", "--json"], target); const gatewayURL = gateways?.data?.gateways?.find((candidate) => candidate.is_default)?.endpoints?.gateway_url; if (!gatewayURL) throw new Error("The import did not configure a default Gateway for the runtime."); const revealed = await runJSON("dome", ["import", "outputs", jobID, "--json"], target); const tokens = Object.entries(revealed?.data?.outputs ?? {}).filter(([key, value]) => key.endsWith("_token") && typeof value === "string"); if (tokens.length !== 1) throw new Error("The import did not produce exactly one runtime agent token."); writeRuntimeEnvironment(target, { DOME_TOKEN: tokens[0][1], DOME_GATEWAY_URL: gatewayURL }); output(line("success", "Configured the runtime with the imported agent credentials.", options)); }
+async function up(options, output) { const target = path.resolve(process.cwd(), options.directory ?? "."); const manifest = readManifest(target); const needsCredentials = !configured(target); output(line("info", `Checking ${target}`, options)); fs.writeFileSync(path.join(target, ".dome-compose.yaml"), renderCompose(manifest.app.runtime, options.port)); if (options.importJob) { output(line("info", "Saving credentials from the selected Dome import", options)); await configureRuntime(target, options.importJob, options, output); } else if (options.provision && (needsCredentials || options.forceProvision)) { output(line("info", "Setting up Dome resources", options)); const imported = await runJSON("dome", ["import", "dome.tf", "--json"], target); const job = imported?.data?.job; if (!job?.id) throw new Error("Dome import did not return a job ID."); if (importCreatedResources(job) && importHasPendingOutputs(job)) await configureRuntime(target, job.id, options, output); else if (needsCredentials) throw new Error(`Dome matched existing resources and did not create a new runtime token. Recover a pending import with templates up --dir ${options.directory ?? "."} --import-job <job-id>, or rotate the runtime key and set DOME_TOKEN and DOME_GATEWAY_URL in .env.`); else output(line("success", "Dome resources are already up to date; keeping the existing runtime credentials.", options)); } if (options.start) { output(line("info", `Starting app at http://localhost:${options.port}`, options)); run("docker", ["compose", "-f", ".dome-compose.yaml", "up", ...(options.detach ? ["--detach"] : [])], target); } }
 async function publish(options, output, fetchImplementation) { const target = path.resolve(process.cwd(), options.directory ?? "."); const manifest = readPublishManifest(target); const source = publishSource(target); const name = manifest.metadata.name; const [scope, slug] = name.split("/"); const archive = options.dryRun ? null : createArchive(source); output(line("info", `Checking ${name}@${manifest.metadata.version}`, options)); const payload = { name, version: manifest.metadata.version, title: manifest.metadata.title, summary: manifest.metadata.summary ?? "", sha256: archive?.sha256, size_bytes: archive?.buffer.length, source: { repository: manifest.metadata.source.repository, path: manifest.metadata.source.path, commit: source.commit, remote: source.remote, files: source.files } };
   const remote = remoteTarget(options); let registry; let attempt;
   try { ({ target: registry, body: attempt } = await registryRequest(remote, "/v1/publish-attempts", { method: "POST", body: { ...payload, dry_run: options.dryRun }, authenticated: true, fetchImplementation })); } catch (caught) {

package/src/registry.mjs

@@ -4,6 +4,7 @@ import os from "node:os";
 import path from "node:path";
 
 export const DEFAULT_SERVER = "https://app.domesystems.ai";
+export const DEFAULT_REGISTRY = "https://templates-registry.domesystems.ai";
 
 function profileKey(server) {
   return crypto.createHash("sha256").update(new URL(server).origin).digest("hex").slice(0, 24);

package/src/template-files.mjs

@@ -44,6 +44,25 @@ export function initializeEnvironment(templateDirectory) {
   return false;
 }
 
+export function writeRuntimeEnvironment(templateDirectory, values) {
+  const environment = path.join(templateDirectory, ".env");
+  const required = ["DOME_TOKEN", "DOME_GATEWAY_URL"];
+  for (const key of required) {
+    if (typeof values[key] !== "string" || !values[key].trim() || /[\r\n]/.test(values[key])) {
+      throw new Error(`Cannot configure runtime: ${key} is missing or invalid.`);
+    }
+  }
+
+  let text = fs.existsSync(environment) ? fs.readFileSync(environment, "utf8") : "";
+  for (const key of required) {
+    const assignment = `${key}=${values[key]}`;
+    const pattern = new RegExp(`^${key}=.*$`, "m");
+    text = pattern.test(text) ? text.replace(pattern, assignment) : `${text}${text && !text.endsWith("\n") ? "\n" : ""}${assignment}\n`;
+  }
+  fs.writeFileSync(environment, text, { mode: 0o600 });
+  fs.chmodSync(environment, 0o600);
+}
+
 export function writeLock(destination, release) {
   fs.writeFileSync(path.join(destination, ".dome-template-lock.yaml"), stringify({
     apiVersion: "templates.domesystems.ai/v1", package: release.name, version: release.version, sha256: release.sha256,