@maker-or/opencms 0.1.6 → 0.1.8

package/README.md

@@ -23,6 +23,15 @@ npx @maker-or/opencms deploy
 
 The generated `cms/schema.json` file defines the project's content types and allowed blocks. The CLI syncs it to the development environment when `dev` or `deploy` runs.
 
+`opencms deploy` promotes the development schema and only published development pages as one production snapshot. Draft pages stay out of production and production pages no longer present in the published development snapshot are removed. When `VERCEL_TOKEN` is set, the command also deploys the application with its project ID, API origin, and production CMS environment supplied to Vercel at build time and runtime.
+
 The CLI stores its local login configuration in `~/.config/opencms/config.json` (or `$XDG_CONFIG_HOME/opencms/config.json` when configured).
 
-The CLI defaults to the hosted OpenCMS dashboard and API. Use `OPENCMS_DASHBOARD_URL` and `OPENCMS_API_URL` to target a local or self-hosted instance.
+The CLI uses the OpenCMS control-plane origin from `OPENCMS_URL`. Set it to the dashboard/API origin for your hosted, local, or self-hosted instance. `OPENCMS_API_URL` and `OPENCMS_DASHBOARD_URL` remain supported as separate legacy overrides, but there is no baked-in deployment URL.
+
+For example:
+
+```bash
+export OPENCMS_URL=https://your-opencms-domain.example
+npx @maker-or/opencms login
+```

package/dist/index.js

@@ -2,9 +2,10 @@
 
 // src/index.ts
 import { createServer } from "node:http";
+import { randomUUID } from "node:crypto";
 import { homedir } from "node:os";
 import { join, resolve } from "node:path";
-import { access, mkdir, readdir, readFile, rm, writeFile } from "node:fs/promises";
+import { access, chmod, mkdir, readdir, readFile, rm, writeFile } from "node:fs/promises";
 import { constants } from "node:fs";
 import { spawn } from "node:child_process";
 import { createInterface } from "node:readline/promises";
@@ -67,10 +68,7 @@ class OpenCmsApiError extends Error {
 function createSdk(options = {}) {
   const defaultBaseUrl = typeof window === "undefined" ? undefined : window.location.origin;
   const configuredBaseUrl = options.baseUrl ?? defaultBaseUrl;
-  if (!configuredBaseUrl) {
-    throw new Error("baseUrl is required when using the OpenCMS SDK outside a browser.");
-  }
-  const baseUrl = configuredBaseUrl.replace(/\/$/, "");
+  const baseUrl = configuredBaseUrl?.replace(/\/$/, "") ?? "";
   const fetcher = options.fetch ?? globalThis.fetch;
   const projectId = options.projectId;
   const environment = options.environment ?? "development";
@@ -81,6 +79,9 @@ function createSdk(options = {}) {
     if (token) {
       headers.set("Authorization", `Bearer ${token}`);
     }
+    if (!baseUrl && typeof window === "undefined") {
+      throw new Error("baseUrl is required when making OpenCMS SDK requests outside a browser.");
+    }
     const response = await fetcher(`${baseUrl}${path}`, {
       ...init,
       headers
@@ -103,18 +104,21 @@ function createSdk(options = {}) {
         method: "POST",
         headers: { "Content-Type": "application/json" },
         body: JSON.stringify(input)
+      }),
+      delete: (targetProjectId) => request(`/api/projects/${targetProjectId}`, {
+        method: "DELETE"
       })
     },
     schema: {
       get: () => {
         if (!projectId)
           throw new Error("projectId is required to get the schema");
-        return request(`/api/projects/${projectId}/schema`);
+        return request(`/api/projects/${projectId}/schema?environment=${environment}`);
       },
       update: (schema) => {
         if (!projectId)
           throw new Error("projectId is required to update the schema");
-        return request(`/api/projects/${projectId}/schema`, {
+        return request(`/api/projects/${projectId}/schema?environment=${environment}`, {
           method: "PUT",
           headers: { "Content-Type": "application/json" },
           body: JSON.stringify(schema)
@@ -205,13 +209,30 @@ function createSdk(options = {}) {
   };
 }
 
+// src/vercel.ts
+function vercelDeploymentArgs({
+  apiUrl,
+  projectId,
+  token
+}) {
+  const connectionVariables = [
+    `NEXT_PUBLIC_OPENCMS_PROJECT_ID=${projectId}`,
+    `OPENCMS_API_URL=${apiUrl}`,
+    "OPENCMS_ENVIRONMENT=production"
+  ];
+  return [
+    "vercel",
+    "--prod",
+    "--yes",
+    "--token",
+    token,
+    ...connectionVariables.flatMap((value) => ["--build-env", value, "--env", value])
+  ];
+}
+
 // src/index.ts
-var hostedUrl = "https://web-eta-ten-16.vercel.app";
-var dashboardUrl = process.env.OPENCMS_DASHBOARD_URL ?? hostedUrl;
-var apiUrl = process.env.OPENCMS_API_URL ?? hostedUrl;
 var configRoot = process.env.XDG_CONFIG_HOME ?? join(homedir(), ".config");
 var configPath = join(configRoot, "opencms", "config.json");
-var legacyLocalApiUrl = "http://localhost:3000";
 async function readConfig() {
   if (!await fileExists(configPath))
     return {};
@@ -222,19 +243,30 @@ async function readConfig() {
   }
 }
 async function writeConfig(config) {
-  await mkdir(join(configRoot, "opencms"), { recursive: true });
+  const directory = join(configRoot, "opencms");
+  await mkdir(directory, { recursive: true, mode: 448 });
   await writeFile(configPath, `${JSON.stringify(config, null, 2)}
-`, "utf8");
+`, { encoding: "utf8", mode: 384 });
+  if (process.platform !== "win32") {
+    await chmod(directory, 448);
+    await chmod(configPath, 384);
+  }
 }
 function tokenFor(config) {
   return process.env.OPENCMS_CLERK_TOKEN ?? config.token ?? null;
 }
+function requireEndpoint(endpoint) {
+  const normalized = endpoint?.trim().replace(/\/$/, "");
+  if (!normalized) {
+    throw new Error("OpenCMS endpoint is not configured. Set OPENCMS_URL to your OpenCMS dashboard/API origin and try again.");
+  }
+  return normalized;
+}
 function apiUrlFor(config) {
-  if (process.env.OPENCMS_API_URL)
-    return process.env.OPENCMS_API_URL;
-  if (config?.apiUrl && config.apiUrl !== legacyLocalApiUrl)
-    return config.apiUrl;
-  return apiUrl;
+  return requireEndpoint(process.env.OPENCMS_URL ?? process.env.OPENCMS_API_URL ?? config?.apiUrl ?? process.env.OPENCMS_DASHBOARD_URL);
+}
+function dashboardUrlFor(config) {
+  return requireEndpoint(process.env.OPENCMS_URL ?? process.env.OPENCMS_DASHBOARD_URL ?? process.env.OPENCMS_API_URL ?? config?.apiUrl);
 }
 function sdk(config, projectId) {
   return createSdk({
@@ -269,7 +301,8 @@ async function openBrowser(url) {
   const command = process.platform === "darwin" ? ["open", url] : process.platform === "win32" ? ["cmd", "/c", "start", "", url] : ["xdg-open", url];
   await runCommand(command[0], command.slice(1));
 }
-async function browserLogin() {
+async function browserLogin(config) {
+  const loginState = randomUUID();
   let resolveToken = () => {
     return;
   };
@@ -287,14 +320,24 @@ async function browserLogin() {
       response.end("Waiting for opencms login.");
       return;
     }
+    if (url.searchParams.get("state") !== loginState) {
+      response.writeHead(400, { "Content-Type": "text/plain", "Cache-Control": "no-store" });
+      response.end("Invalid login state.");
+      return;
+    }
     const token = url.searchParams.get("token");
     if (!token) {
-      response.writeHead(400, { "Content-Type": "text/plain" });
+      response.writeHead(400, { "Content-Type": "text/plain", "Cache-Control": "no-store" });
       response.end("Missing login token.");
       return;
     }
     resolveToken(token);
-    response.writeHead(200, { "Content-Type": "text/html" });
+    response.writeHead(200, {
+      "Content-Type": "text/html",
+      "Cache-Control": "no-store",
+      "Content-Security-Policy": "default-src 'none'; style-src 'unsafe-inline'",
+      "X-Content-Type-Options": "nosniff"
+    });
     response.end("<h1>OpenCMS login complete</h1><p>You can close this window.</p>");
   });
   await new Promise((resolve2, reject) => {
@@ -305,7 +348,7 @@ async function browserLogin() {
   if (!address || typeof address === "string")
     throw new Error("Unable to start the login callback server.");
   const callback = `http://127.0.0.1:${address.port}/callback`;
-  const loginUrl = `${dashboardUrl.replace(/\/$/, "")}/cli/login?redirect_uri=${encodeURIComponent(callback)}`;
+  const loginUrl = `${dashboardUrlFor(config)}/cli/login?redirect_uri=${encodeURIComponent(callback)}&state=${encodeURIComponent(loginState)}`;
   console.log(`Opening ${loginUrl}`);
   try {
     await openBrowser(loginUrl);
@@ -324,7 +367,7 @@ async function ensureToken(config) {
   const token = tokenFor(config);
   if (token)
     return token;
-  const loggedInToken = await browserLogin();
+  const loggedInToken = await browserLogin(config);
   await writeConfig({ ...config, token: loggedInToken, apiUrl: apiUrlFor(config) });
   return loggedInToken;
 }
@@ -333,10 +376,22 @@ async function reauthenticate(config) {
     throw new Error("OPENCMS_CLERK_TOKEN was rejected or expired. Provide a fresh token or unset the variable to use browser login.");
   }
   console.log("Your OpenCMS session has expired. Opening browser login…");
-  const loggedInToken = await browserLogin();
+  const loggedInToken = await browserLogin(config);
   await writeConfig({ ...config, token: loggedInToken, apiUrl: apiUrlFor(config) });
   return loggedInToken;
 }
+async function withReauthentication(operation) {
+  let config = await readConfig();
+  try {
+    return await operation(config);
+  } catch (error) {
+    if (!(error instanceof OpenCmsApiError) || error.status !== 401)
+      throw error;
+    await reauthenticate(config);
+    config = await readConfig();
+    return operation(config);
+  }
+}
 async function login() {
   const config = await readConfig();
   if (process.env.OPENCMS_CLERK_TOKEN) {
@@ -344,12 +399,24 @@ async function login() {
     console.log("Saved OPENCMS_CLERK_TOKEN for local CLI use.");
     return;
   }
-  const loggedInToken = await browserLogin();
+  const loggedInToken = await browserLogin(config);
   await writeConfig({ ...config, token: loggedInToken, apiUrl: apiUrlFor(config) });
   console.log("Logged in to OpenCMS.");
 }
 async function logout() {
   const config = await readConfig();
+  if (config.token?.startsWith("ocms_")) {
+    try {
+      const response = await fetch(`${apiUrlFor(config)}/api/cli/tokens/current`, {
+        method: "DELETE",
+        headers: { Authorization: `Bearer ${config.token}` }
+      });
+      if (!response.ok)
+        console.warn("OpenCMS: The remote CLI session could not be revoked.");
+    } catch {
+      console.warn("OpenCMS: The remote CLI session could not be revoked.");
+    }
+  }
   const { token: _token, ...withoutToken } = config;
   await writeConfig(withoutToken);
   console.log("Logged out of OpenCMS.");
@@ -381,8 +448,8 @@ async function ensureCmsDirectory(destination, project, baseUrl) {
   const configFile = join(cmsDirectory, "opencms.ts");
   if (!await fileExists(configFile)) {
     await writeFile(configFile, `export const opencms = {
-  projectId: process.env.NEXT_PUBLIC_OPENCMS_PROJECT_ID ?? "${project.id}",
-  apiUrl: process.env.OPENCMS_API_URL ?? "${baseUrl}",
+  projectId: process.env.NEXT_PUBLIC_OPENCMS_PROJECT_ID ?? "",
+  apiUrl: process.env.OPENCMS_API_URL ?? "",
   environment: process.env.OPENCMS_ENVIRONMENT ?? "development",
 } as const;
 `, "utf8");
@@ -428,6 +495,9 @@ async function createProject() {
   const name = await ask("Project name: ");
   if (!name)
     throw new Error("A project name is required.");
+  const destination = resolve(process.cwd(), slugify(name));
+  if (await fileExists(destination))
+    throw new Error(`Destination already exists: ${destination}`);
   let currentConfig = await readConfig();
   let client = sdk(currentConfig);
   let project;
@@ -441,17 +511,26 @@ async function createProject() {
     client = sdk(currentConfig);
     project = await client.projects.create({ name });
   }
-  const destination = resolve(process.cwd(), slugify(project.name));
-  await pullTemplate(destination);
-  const baseUrl = apiUrlFor(config);
-  await writeProjectEnv(destination, project, baseUrl);
-  await ensureCmsDirectory(destination, project, baseUrl);
-  await installDependencies(destination);
+  const baseUrl = apiUrlFor(currentConfig);
+  try {
+    await pullTemplate(destination);
+    await writeProjectEnv(destination, project, baseUrl);
+    await ensureCmsDirectory(destination, project, baseUrl);
+    await installDependencies(destination);
+  } catch (error) {
+    await rm(destination, { recursive: true, force: true });
+    try {
+      await client.projects.delete(project.id);
+    } catch {
+      console.error(`OpenCMS: Local setup failed and cloud rollback also failed. Project ID: ${project.id}`);
+    }
+    throw error;
+  }
   await writeConfig({ ...await readConfig(), projectId: project.id, apiUrl: baseUrl });
   console.log(`
 Created ${project.name}.`);
   console.log(`Project ID: ${project.id}`);
-  console.log(`Dashboard: ${dashboardUrl.replace(/\/$/, "")}/dashboard/${project.id}`);
+  console.log(`Dashboard: ${dashboardUrlFor(await readConfig())}/dashboard/${project.id}`);
   console.log(`
 Next steps:
   cd ${slugify(project.name)}
@@ -461,16 +540,11 @@ Next steps:
 async function runDev() {
   const config = await readConfig();
   await ensureToken(config);
-  try {
-    await syncLocalSchema(await projectIdFromEnv(), await readConfig());
-  } catch (error) {
-    if (!(error instanceof OpenCmsApiError) || error.status !== 401)
-      throw error;
-    await reauthenticate(await readConfig());
-    await syncLocalSchema(await projectIdFromEnv(), await readConfig());
-  }
+  const projectId = await projectIdFromEnv();
+  await withReauthentication((currentConfig) => syncLocalSchema(projectId, currentConfig));
   const manager = await packageManager(process.cwd());
-  const command = manager[0] === "npm" ? ["npm", "run", "dev"] : manager[0] === "pnpm" ? ["pnpm", "dev"] : manager[0] === "yarn" ? ["yarn", "dev"] : ["bun", "run", "dev"];
+  const script = await nextDevScript(process.cwd());
+  const command = manager[0] === "npm" ? ["npm", "run", script] : manager[0] === "pnpm" ? ["pnpm", script] : manager[0] === "yarn" ? ["yarn", script] : ["bun", "run", script];
   process.exit(await runCommand(command[0], command.slice(1), {
     cwd: process.cwd(),
     env: {
@@ -481,6 +555,24 @@ async function runDev() {
     inherit: true
   }));
 }
+async function nextDevScript(destination) {
+  const packagePath = join(destination, "package.json");
+  if (!await fileExists(packagePath))
+    return "dev";
+  try {
+    const packageJson = JSON.parse(await readFile(packagePath, "utf8"));
+    if (typeof packageJson.scripts?.["dev:next"] === "string")
+      return "dev:next";
+    if (typeof packageJson.scripts?.dev === "string" && /opencms(?:@[^\s]+)?\s+dev/.test(packageJson.scripts.dev)) {
+      throw new Error("This OpenCMS template is missing its dev:next script. Update the template before running opencms dev.");
+    }
+  } catch (error) {
+    if (error instanceof SyntaxError)
+      throw new Error("package.json is not valid JSON.");
+    throw error;
+  }
+  return "dev";
+}
 async function syncLocalSchema(projectId, config) {
   if (!projectId)
     return;
@@ -511,24 +603,20 @@ async function deploy() {
   const projectId = await projectIdFromEnv() ?? config.projectId;
   if (!projectId)
     throw new Error("No OpenCMS project is configured in this directory.");
-  let deployment;
-  try {
-    await syncLocalSchema(projectId, await readConfig());
-    deployment = await sdk(await readConfig()).deploy(projectId);
-  } catch (error) {
-    if (!(error instanceof OpenCmsApiError) || error.status !== 401)
-      throw error;
-    await reauthenticate(await readConfig());
-    await syncLocalSchema(projectId, await readConfig());
-    deployment = await sdk(await readConfig()).deploy(projectId);
-  }
-  console.log(`Deployed ${deployment.sourceEnvironment} content to ${deployment.targetEnvironment}.`);
+  await withReauthentication((currentConfig) => syncLocalSchema(projectId, currentConfig));
   if (process.env.VERCEL_TOKEN) {
     console.log("Deploying the application to Vercel…");
-    if (await runCommand("npx", ["vercel", "--prod", "--yes", "--token", process.env.VERCEL_TOKEN], { cwd: process.cwd(), inherit: true }) !== 0) {
+    const args = vercelDeploymentArgs({
+      apiUrl: apiUrlFor(await readConfig()),
+      projectId,
+      token: process.env.VERCEL_TOKEN
+    });
+    if (await runCommand("npx", args, { cwd: process.cwd(), inherit: true }) !== 0) {
       throw new Error("Vercel deployment failed.");
     }
   }
+  const deployment = await withReauthentication((currentConfig) => sdk(currentConfig).deploy(projectId));
+  console.log(`Deployed ${deployment.sourceEnvironment} content to ${deployment.targetEnvironment}.`);
 }
 function printHelp() {
   console.log(`OpenCMS CLI

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maker-or/opencms",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "The developer-first CLI for OpenCMS",
   "type": "module",
   "repository": {
@@ -28,6 +28,7 @@
     "build": "bun build src/index.ts --outfile dist/index.js --target=node --format=esm",
     "dev": "bun --watch src/index.ts",
     "start": "node dist/index.js",
+    "test": "bun run build && bun test",
     "typecheck": "tsc --noEmit",
     "prepack": "bun run build"
   },
@@ -35,6 +36,7 @@
     "node": ">=20"
   },
   "devDependencies": {
+    "@types/bun": "latest",
     "@types/node": "^22.13.10",
     "typescript": "^5.8.3"
   }