@maker-or/opencms 0.1.2 → 0.1.3

package/README.md

@@ -19,4 +19,6 @@ npx @maker-or/opencms deploy
 
 `opencms create` authenticates you, creates an OpenCMS project, pulls the Next.js template, writes the project configuration, and installs dependencies.
 
+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.
+
 The CLI stores its local login configuration in `~/.config/opencms/config.json` (or `$XDG_CONFIG_HOME/opencms/config.json` when configured).

package/dist/index.js

@@ -10,6 +10,51 @@ import { spawn } from "node:child_process";
 import { createInterface } from "node:readline/promises";
 import process from "node:process";
 
+// ../../packages/sdk/src/schema.ts
+var emptyPageContent = { version: 1, blocks: [] };
+var defaultSchema = {
+  version: 1,
+  blocks: {
+    heading: {
+      label: "Heading",
+      fields: {
+        text: { type: "text", label: "Text", required: true },
+        level: { type: "number", label: "Level", required: true }
+      }
+    },
+    text: {
+      label: "Text",
+      fields: {
+        text: { type: "text", label: "Text", required: true }
+      }
+    },
+    quote: {
+      label: "Quote",
+      fields: {
+        text: { type: "text", label: "Quote", required: true },
+        author: { type: "text", label: "Author" }
+      }
+    },
+    "feature-list": {
+      label: "Feature list",
+      fields: {
+        title: { type: "text", label: "Title", required: true },
+        items: { type: "text", label: "Items", required: true }
+      }
+    }
+  },
+  contentTypes: {
+    page: {
+      label: "Page",
+      fields: {
+        title: { type: "text", label: "Title", required: true },
+        slug: { type: "slug", label: "Slug", required: true, unique: true }
+      },
+      blocks: ["heading", "text", "quote", "feature-list"]
+    }
+  }
+};
+
 // ../../packages/sdk/src/index.ts
 class OpenCmsApiError extends Error {
   status;
@@ -55,6 +100,22 @@ function createSdk(options = {}) {
         body: JSON.stringify(input)
       })
     },
+    schema: {
+      get: () => {
+        if (!projectId)
+          throw new Error("projectId is required to get the schema");
+        return request(`/api/projects/${projectId}/schema`);
+      },
+      update: (schema) => {
+        if (!projectId)
+          throw new Error("projectId is required to update the schema");
+        return request(`/api/projects/${projectId}/schema`, {
+          method: "PUT",
+          headers: { "Content-Type": "application/json" },
+          body: JSON.stringify(schema)
+        });
+      }
+    },
     pages: {
       list: () => {
         if (!projectId)
@@ -67,8 +128,29 @@ function createSdk(options = {}) {
         return request(`/api/projects/${projectId}/pages`, {
           method: "POST",
           headers: { "Content-Type": "application/json" },
+          body: JSON.stringify({ ...input, environment, content: input.content ?? emptyPageContent })
+        });
+      },
+      get: (documentId) => {
+        if (!projectId)
+          throw new Error("projectId is required to get pages");
+        return request(`/api/projects/${projectId}/pages/${documentId}?environment=${environment}`);
+      },
+      update: (documentId, input) => {
+        if (!projectId)
+          throw new Error("projectId is required to update pages");
+        return request(`/api/projects/${projectId}/pages/${documentId}`, {
+          method: "PATCH",
+          headers: { "Content-Type": "application/json" },
           body: JSON.stringify({ ...input, environment })
         });
+      },
+      delete: (documentId) => {
+        if (!projectId)
+          throw new Error("projectId is required to delete pages");
+        return request(`/api/projects/${projectId}/pages/${documentId}?environment=${environment}`, {
+          method: "DELETE"
+        });
       }
     },
     deploy: (targetProjectId = projectId) => {
@@ -84,11 +166,36 @@ function createSdk(options = {}) {
           throw new Error("projectId is required to list documents");
         return request(`/api/projects/${projectId}/pages?environment=${environment}`);
       },
-      create: (input) => request(`/api/projects/${projectId ?? ""}/pages`, {
-        method: "POST",
-        headers: { "Content-Type": "application/json" },
-        body: JSON.stringify({ ...input, environment })
-      })
+      create: (input) => {
+        if (!projectId)
+          throw new Error("projectId is required to create documents");
+        return request(`/api/projects/${projectId}/pages`, {
+          method: "POST",
+          headers: { "Content-Type": "application/json" },
+          body: JSON.stringify({ ...input, environment, content: input.content ?? emptyPageContent })
+        });
+      },
+      get: (documentId) => {
+        if (!projectId)
+          throw new Error("projectId is required to get documents");
+        return request(`/api/projects/${projectId}/pages/${documentId}?environment=${environment}`);
+      },
+      update: (documentId, input) => {
+        if (!projectId)
+          throw new Error("projectId is required to update documents");
+        return request(`/api/projects/${projectId}/pages/${documentId}`, {
+          method: "PATCH",
+          headers: { "Content-Type": "application/json" },
+          body: JSON.stringify({ ...input, environment })
+        });
+      },
+      delete: (documentId) => {
+        if (!projectId)
+          throw new Error("projectId is required to delete documents");
+        return request(`/api/projects/${projectId}/pages/${documentId}?environment=${environment}`, {
+          method: "DELETE"
+        });
+      }
     }
   };
 }
@@ -260,6 +367,11 @@ async function ensureCmsDirectory(destination, project, baseUrl) {
   apiUrl: process.env.OPENCMS_API_URL ?? "${baseUrl}",
   environment: process.env.OPENCMS_ENVIRONMENT ?? "development",
 } as const;
+`, "utf8");
+  }
+  const schemaFile = join(cmsDirectory, "schema.json");
+  if (!await fileExists(schemaFile)) {
+    await writeFile(schemaFile, `${JSON.stringify(defaultSchema, null, 2)}
 `, "utf8");
   }
 }
@@ -283,7 +395,7 @@ async function installDependencies(destination) {
   }
 }
 async function pullTemplate(destination) {
-  const repository = process.env.OPENCMS_TEMPLATE_REPO ?? "https://github.com/opencms/template-nextjs.git";
+  const repository = process.env.OPENCMS_TEMPLATE_REPO ?? "https://github.com/maker-or/nextjs-template.git";
   if (await fileExists(destination))
     throw new Error(`Destination already exists: ${destination}`);
   console.log("Pulling the OpenCMS Next.js template…");
@@ -331,10 +443,26 @@ Next steps:
 async function runDev() {
   const config = await readConfig();
   await ensureToken(config);
+  await syncLocalSchema(await projectIdFromEnv(), await readConfig());
   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"];
   process.exit(await runCommand(command[0], command.slice(1), { cwd: process.cwd(), env: { ...process.env, OPENCMS_ENVIRONMENT: "development" }, inherit: true }));
 }
+async function syncLocalSchema(projectId, config) {
+  if (!projectId)
+    return;
+  const schemaPath = join(process.cwd(), "cms", "schema.json");
+  if (!await fileExists(schemaPath))
+    return;
+  let schema;
+  try {
+    schema = JSON.parse(await readFile(schemaPath, "utf8"));
+  } catch {
+    throw new Error("cms/schema.json is not valid JSON.");
+  }
+  console.log("Syncing the OpenCMS schema to development…");
+  await sdk(config, projectId).schema.update(schema);
+}
 function projectIdFromEnv() {
   const envPath = join(process.cwd(), ".env.local");
   return fileExists(envPath).then(async (exists) => {
@@ -350,6 +478,7 @@ async function deploy() {
   const projectId = await projectIdFromEnv() ?? config.projectId;
   if (!projectId)
     throw new Error("No OpenCMS project is configured in this directory.");
+  await syncLocalSchema(projectId, await readConfig());
   const deployment = await sdk(await readConfig()).deploy(projectId);
   console.log(`Deployed ${deployment.sourceEnvironment} content to ${deployment.targetEnvironment}.`);
   if (process.env.VERCEL_TOKEN) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maker-or/opencms",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "The developer-first CLI for OpenCMS",
   "type": "module",
   "repository": {