npm - @plank-cms/plank - Versions diffs - 0.12.0 - Mend

@plank-cms/plank 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (35) hide show

package/LICENSE +28 -0
package/README.md +34 -0
package/dist/admin/assets/hls-0EiSYoTw.js +40 -0
package/dist/admin/assets/index-BCd-a4uR.css +2 -0
package/dist/admin/assets/index-Db1a-6aD.js +203 -0
package/dist/admin/favicon.png +0 -0
package/dist/admin/index.html +21 -0
package/dist/admin/particles-texture.png +0 -0
package/dist/admin/plank-logo-w.svg +4 -0
package/dist/index.js +177 -0
package/dist/migrations/001_plank_roles.sql +5 -0
package/dist/migrations/002_plank_users.sql +7 -0
package/dist/migrations/003_plank_content_types.sql +9 -0
package/dist/migrations/004_plank_api_tokens.sql +7 -0
package/dist/migrations/005_plank_media.sql +10 -0
package/dist/migrations/006_plank_users_name.sql +3 -0
package/dist/migrations/007_api_tokens_access_type.sql +2 -0
package/dist/migrations/008_content_types_default.sql +2 -0
package/dist/migrations/009_plank_settings.sql +7 -0
package/dist/migrations/010_users_avatar.sql +1 -0
package/dist/migrations/011_entries_status.sql +17 -0
package/dist/migrations/012_entries_published_data.sql +14 -0
package/dist/migrations/013_entries_published_at.sql +14 -0
package/dist/migrations/014_timezone_setting.sql +3 -0
package/dist/migrations/015_entries_scheduled.sql +14 -0
package/dist/migrations/016_entries_created_by.sql +14 -0
package/dist/migrations/017_content_types_kind.sql +2 -0
package/dist/migrations/018_plank_webhooks.sql +8 -0
package/dist/migrations/019_user_prefs.sql +7 -0
package/dist/migrations/020_plank_media_folders.sql +8 -0
package/dist/migrations/021_users_profile_fields.sql +4 -0
package/dist/migrations/022_plank_media_metadata.sql +4 -0
package/dist/migrations/023_entries_localized.sql +17 -0
package/dist/server-VPVKRT67.js +2742 -0
package/package.json +67 -0

package/dist/admin/favicon.png ADDED Viewed

Binary file

package/dist/admin/index.html ADDED Viewed

@@ -0,0 +1,21 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Plank Admin</title>
+    <link rel="icon" type="image/png" href="/admin/favicon.png" />
+    <link rel="preconnect" href="https://fonts.googleapis.com" />
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+    <link
+      href="https://fonts.googleapis.com/css2?family=Google+Sans:ital,opsz,wght@0,17..18,400..700;1,17..18,400..700&display=swap"
+      rel="stylesheet"
+    />
+    <script type="module" crossorigin src="/admin/assets/index-Db1a-6aD.js"></script>
+    <link rel="stylesheet" crossorigin href="/admin/assets/index-BCd-a4uR.css">
+  </head>
+  <body>
+    <div id="root"></div>
+  </body>
+</html>

package/dist/admin/particles-texture.png ADDED Viewed

Binary file

package/dist/admin/plank-logo-w.svg ADDED Viewed

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" width="984.8739" height="1079.5625" viewBox="0 0 984.8739 1079.5625">
+  <path d="M654.0548,0h-166.4155L0,399.8729v565.8804l441.927-363.306v180.4008h212.1278c174.2523,0,330.8192-98.4874,330.8192-395.2159C984.8739,88.3854,834.6244,0,654.0548,0ZM0,965.7533v113.8092h441.927v-113.8092c0-7.4991-441.927,0-441.927,0Z" fill="#fff"/>
+</svg>

package/dist/index.js ADDED Viewed

@@ -0,0 +1,177 @@
+#!/usr/bin/env node
+// src/commands/init.ts
+import { intro, outro, text, spinner, note, isCancel, cancel } from "@clack/prompts";
+import chalk from "chalk";
+import { randomBytes } from "crypto";
+import { resolve, join } from "path";
+import fs from "fs-extra";
+import { execa } from "execa";
+var PACKAGE_VERSION = "0.12.0";
+function generateSecret() {
+  return randomBytes(32).toString("hex");
+}
+function buildEnv(jwtSecret, encryptionKey) {
+  return [
+    `PLANK_DATABASE_URL=postgresql://user:password@localhost:5432/plank`,
+    `PLANK_JWT_SECRET=${jwtSecret}`,
+    `PLANK_ENCRYPTION_KEY=${encryptionKey}`,
+    `PLANK_PORT=5500`
+  ].join("\n") + "\n";
+}
+function buildPackageJson(name) {
+  return {
+    name,
+    version: "0.1.0",
+    private: true,
+    scripts: {
+      start: "plank start"
+    },
+    dependencies: {
+      "@plank-cms/plank": PACKAGE_VERSION
+    }
+  };
+}
+async function init(projectName) {
+  intro(chalk.bold("\u25B2 Plank CMS"));
+  const useCurrentDir = projectName === ".";
+  let name = useCurrentDir ? void 0 : projectName;
+  if (!name) {
+    if (useCurrentDir) {
+      name = process.cwd().split("/").pop() ?? "plank-cms";
+    } else {
+      const answer = await text({
+        message: "Project name",
+        placeholder: "my-plank-cms",
+        defaultValue: "my-plank-cms",
+        validate(value) {
+          if (!value.trim()) return "Project name is required";
+          if (!/^[a-z0-9-_]+$/.test(value)) return "Use only lowercase letters, numbers, hyphens, and underscores";
+        }
+      });
+      if (isCancel(answer)) {
+        cancel("Cancelled.");
+        process.exit(0);
+      }
+      name = answer;
+    }
+  }
+  const projectDir = useCurrentDir ? process.cwd() : resolve(process.cwd(), name);
+  if (!useCurrentDir && await fs.pathExists(projectDir)) {
+    const entries = await fs.readdir(projectDir);
+    if (entries.length > 0) {
+      cancel(`Directory "${name}" already exists and is not empty.`);
+      process.exit(1);
+    }
+  }
+  const s = spinner();
+  s.start("Creating project...");
+  await fs.ensureDir(projectDir);
+  await fs.writeFile(join(projectDir, ".env"), buildEnv(generateSecret(), generateSecret()));
+  await fs.writeJSON(join(projectDir, "package.json"), buildPackageJson(name), { spaces: 2 });
+  await fs.writeFile(join(projectDir, ".gitignore"), ".env\nnode_modules\n");
+  s.stop("Project created");
+  s.start("Installing dependencies...");
+  await execa("npm", ["install"], { cwd: projectDir });
+  s.stop("Dependencies installed");
+  note(
+    [
+      `Edit ${chalk.cyan(".env")} in your project and replace:`,
+      "",
+      `  ${chalk.yellow("PLANK_DATABASE_URL")}=${chalk.dim("postgresql://user:password@localhost:5432/plank")}`,
+      "",
+      `with your real PostgreSQL connection string.`,
+      "",
+      `Then start your CMS:`,
+      "",
+      ...!useCurrentDir ? [`  ${chalk.cyan(`cd ${name}`)}`, ""] : [],
+      `  ${chalk.cyan("npm start")}`
+    ].join("\n"),
+    "Next steps"
+  );
+  outro(`Your Plank CMS is ready${useCurrentDir ? "" : ` at ${chalk.cyan(`./${name}`)}`}`);
+}
+// src/commands/start.ts
+import { config } from "dotenv";
+import { fileURLToPath } from "url";
+import { dirname, join as join2, resolve as resolve2 } from "path";
+async function start() {
+  config({ path: resolve2(process.cwd(), ".env") });
+  process.env.PLANK_ADMIN_DIST = join2(dirname(fileURLToPath(import.meta.url)), "admin");
+  const { start: startServer } = await import("./server-VPVKRT67.js");
+  await startServer();
+}
+// src/commands/publish-scheduled.ts
+import { config as config2 } from "dotenv";
+import { resolve as resolve3 } from "path";
+import pg from "pg";
+var SNAPSHOT_EXCLUDED = ["'id'", "'status'", "'published_data'", "'published_at'", "'scheduled_for'", "'created_at'", "'updated_at'"];
+var snapshotExpr = (table) => `(SELECT ${SNAPSHOT_EXCLUDED.reduce((expr, col) => `${expr} - ${col}`, `to_jsonb(t.*)`)} FROM ${table} t WHERE t.id = $1)`;
+async function publishScheduled() {
+  config2({ path: resolve3(process.cwd(), ".env") });
+  const connectionString = process.env.PLANK_DATABASE_URL;
+  if (!connectionString) {
+    console.error("[publish-scheduled] PLANK_DATABASE_URL is not set");
+    process.exit(1);
+  }
+  const pool = new pg.Pool({ connectionString });
+  try {
+    console.log(`[publish-scheduled] Running at ${(/* @__PURE__ */ new Date()).toISOString()}`);
+    const { rows: cts } = await pool.query(
+      "SELECT slug, table_name FROM plank_content_types"
+    );
+    const published = [];
+    for (const { slug, table_name } of cts) {
+      const { rows: due } = await pool.query(
+        `SELECT id FROM ${table_name} WHERE status = 'scheduled' AND scheduled_for <= NOW()`
+      );
+      if (due.length === 0) continue;
+      for (const { id } of due) {
+        await pool.query(
+          `UPDATE ${table_name} SET
+            status = 'published',
+            published_data = ${snapshotExpr(table_name)},
+            published_at = NOW(),
+            scheduled_for = NULL,
+            updated_at = NOW()
+          WHERE id = $1`,
+          [id]
+        );
+        published.push({ slug, id });
+      }
+    }
+    if (published.length === 0) {
+      console.log("[publish-scheduled] No entries ready to publish.");
+      return;
+    }
+    console.log(`[publish-scheduled] ${published.length} entry(s) published:`);
+    for (const { slug, id } of published) {
+      console.log(`  \u2713 ${slug} \u2014 ${id}`);
+    }
+  } finally {
+    await pool.end();
+  }
+}
+// src/index.ts
+var [, , command, ...args] = process.argv;
+switch (command) {
+  case "init":
+    await init(args[0]);
+    break;
+  case "start":
+    await start();
+    break;
+  case "publish-scheduled":
+    await publishScheduled();
+    break;
+  default:
+    if (command && !command.startsWith("-")) {
+      await init(command);
+    } else {
+      console.error("Usage: plank <init|start|publish-scheduled> [project-name]");
+      process.exit(1);
+    }
+}

package/dist/migrations/001_plank_roles.sql ADDED Viewed

@@ -0,0 +1,5 @@
+CREATE TABLE IF NOT EXISTS plank_roles (
+  id          TEXT PRIMARY KEY,
+  name        VARCHAR(100) NOT NULL UNIQUE,
+  permissions JSONB NOT NULL DEFAULT '[]'
+);

package/dist/migrations/002_plank_users.sql ADDED Viewed

@@ -0,0 +1,7 @@
+CREATE TABLE IF NOT EXISTS plank_users (
+  id         TEXT PRIMARY KEY,
+  email      VARCHAR(255) NOT NULL UNIQUE,
+  password   VARCHAR(255) NOT NULL,
+  role_id    TEXT NOT NULL REFERENCES plank_roles(id),
+  created_at TIMESTAMP NOT NULL DEFAULT NOW()
+);

package/dist/migrations/003_plank_content_types.sql ADDED Viewed

@@ -0,0 +1,9 @@
+CREATE TABLE IF NOT EXISTS plank_content_types (
+  id         TEXT PRIMARY KEY,
+  name       VARCHAR(255) NOT NULL UNIQUE,
+  slug       VARCHAR(255) NOT NULL UNIQUE,
+  table_name VARCHAR(255) NOT NULL UNIQUE,
+  fields     JSONB NOT NULL DEFAULT '[]',
+  created_at TIMESTAMP NOT NULL DEFAULT NOW(),
+  updated_at TIMESTAMP NOT NULL DEFAULT NOW()
+);

package/dist/migrations/004_plank_api_tokens.sql ADDED Viewed

@@ -0,0 +1,7 @@
+CREATE TABLE IF NOT EXISTS plank_api_tokens (
+  id         TEXT PRIMARY KEY,
+  name       VARCHAR(255) NOT NULL,
+  token      VARCHAR(512) NOT NULL UNIQUE,
+  created_by TEXT NOT NULL REFERENCES plank_users(id),
+  created_at TIMESTAMP NOT NULL DEFAULT NOW()
+);

package/dist/migrations/005_plank_media.sql ADDED Viewed

@@ -0,0 +1,10 @@
+CREATE TABLE IF NOT EXISTS plank_media (
+  id           TEXT PRIMARY KEY,
+  filename     VARCHAR(512) NOT NULL,
+  url          TEXT NOT NULL,
+  provider_key TEXT NOT NULL,
+  mime_type    VARCHAR(255),
+  size         INTEGER,
+  uploaded_by  TEXT REFERENCES plank_users(id),
+  created_at   TIMESTAMP NOT NULL DEFAULT NOW()
+);

package/dist/migrations/006_plank_users_name.sql ADDED Viewed

@@ -0,0 +1,3 @@
+ALTER TABLE plank_users
+  ADD COLUMN IF NOT EXISTS first_name VARCHAR(100),
+  ADD COLUMN IF NOT EXISTS last_name  VARCHAR(100);

package/dist/migrations/007_api_tokens_access_type.sql ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ ALTER TABLE plank_api_tokens
2	+ ADD COLUMN IF NOT EXISTS access_type VARCHAR(20) NOT NULL DEFAULT 'read-only';

package/dist/migrations/008_content_types_default.sql ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ ALTER TABLE plank_content_types
2	+ ADD COLUMN IF NOT EXISTS is_default BOOLEAN NOT NULL DEFAULT false;

package/dist/migrations/009_plank_settings.sql ADDED Viewed

@@ -0,0 +1,7 @@
+CREATE TABLE IF NOT EXISTS plank_settings (
+  namespace  VARCHAR(64)  NOT NULL,
+  key        VARCHAR(128) NOT NULL,
+  value      TEXT,
+  updated_at TIMESTAMP   NOT NULL DEFAULT NOW(),
+  PRIMARY KEY (namespace, key)
+);

package/dist/migrations/010_users_avatar.sql ADDED Viewed

	@@ -0,0 +1 @@
1	+ ALTER TABLE plank_users ADD COLUMN IF NOT EXISTS avatar_url TEXT;

package/dist/migrations/011_entries_status.sql ADDED Viewed

@@ -0,0 +1,17 @@
+DO $$
+DECLARE
+  tbl TEXT;
+BEGIN
+  FOR tbl IN SELECT table_name FROM plank_content_types LOOP
+    IF NOT EXISTS (
+      SELECT 1 FROM information_schema.columns
+      WHERE table_name = tbl AND column_name = 'status'
+    ) THEN
+      EXECUTE format(
+        'ALTER TABLE %I ADD COLUMN status VARCHAR(20) NOT NULL DEFAULT ''draft''',
+        tbl
+      );
+    END IF;
+  END LOOP;
+END;
+$$;

package/dist/migrations/012_entries_published_data.sql ADDED Viewed

@@ -0,0 +1,14 @@
+DO $$
+DECLARE
+  tbl TEXT;
+BEGIN
+  FOR tbl IN SELECT table_name FROM plank_content_types LOOP
+    IF NOT EXISTS (
+      SELECT 1 FROM information_schema.columns
+      WHERE table_name = tbl AND column_name = 'published_data'
+    ) THEN
+      EXECUTE format('ALTER TABLE %I ADD COLUMN published_data JSONB', tbl);
+    END IF;
+  END LOOP;
+END;
+$$;

package/dist/migrations/013_entries_published_at.sql ADDED Viewed

@@ -0,0 +1,14 @@
+DO $$
+DECLARE
+  tbl TEXT;
+BEGIN
+  FOR tbl IN SELECT table_name FROM plank_content_types LOOP
+    IF NOT EXISTS (
+      SELECT 1 FROM information_schema.columns
+      WHERE table_name = tbl AND column_name = 'published_at'
+    ) THEN
+      EXECUTE format('ALTER TABLE %I ADD COLUMN published_at TIMESTAMP', tbl);
+    END IF;
+  END LOOP;
+END;
+$$;

package/dist/migrations/014_timezone_setting.sql ADDED Viewed

@@ -0,0 +1,3 @@
+INSERT INTO plank_settings (namespace, key, value)
+VALUES ('general', 'timezone', 'UTC')
+ON CONFLICT (namespace, key) DO NOTHING;

package/dist/migrations/015_entries_scheduled.sql ADDED Viewed

@@ -0,0 +1,14 @@
+DO $$
+DECLARE
+  tbl TEXT;
+BEGIN
+  FOR tbl IN SELECT table_name FROM plank_content_types LOOP
+    IF NOT EXISTS (
+      SELECT 1 FROM information_schema.columns
+      WHERE table_name = tbl AND column_name = 'scheduled_for'
+    ) THEN
+      EXECUTE format('ALTER TABLE %I ADD COLUMN scheduled_for TIMESTAMP', tbl);
+    END IF;
+  END LOOP;
+END;
+$$;

package/dist/migrations/016_entries_created_by.sql ADDED Viewed

@@ -0,0 +1,14 @@
+DO $$
+DECLARE
+  tbl TEXT;
+BEGIN
+  FOR tbl IN SELECT table_name FROM plank_content_types LOOP
+    IF NOT EXISTS (
+      SELECT 1 FROM information_schema.columns
+      WHERE table_name = tbl AND column_name = 'created_by'
+    ) THEN
+      EXECUTE format('ALTER TABLE %I ADD COLUMN created_by TEXT REFERENCES plank_users(id) ON DELETE SET NULL', tbl);
+    END IF;
+  END LOOP;
+END;
+$$;

package/dist/migrations/017_content_types_kind.sql ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ ALTER TABLE plank_content_types
2	+ ADD COLUMN IF NOT EXISTS kind VARCHAR(20) NOT NULL DEFAULT 'collection';

package/dist/migrations/018_plank_webhooks.sql ADDED Viewed

@@ -0,0 +1,8 @@
+CREATE TABLE IF NOT EXISTS plank_webhooks (
+  id         TEXT         NOT NULL PRIMARY KEY,
+  name       VARCHAR(255) NOT NULL,
+  url        TEXT         NOT NULL,
+  events     TEXT[]       NOT NULL DEFAULT '{}',
+  enabled    BOOLEAN      NOT NULL DEFAULT TRUE,
+  created_at TIMESTAMP    NOT NULL DEFAULT NOW()
+);

package/dist/migrations/019_user_prefs.sql ADDED Viewed

@@ -0,0 +1,7 @@
+CREATE TABLE IF NOT EXISTS plank_user_prefs (
+  user_id    TEXT NOT NULL REFERENCES plank_users(id) ON DELETE CASCADE,
+  key        VARCHAR(255) NOT NULL,
+  value      TEXT NOT NULL,
+  updated_at TIMESTAMP NOT NULL DEFAULT NOW(),
+  PRIMARY KEY (user_id, key)
+);

package/dist/migrations/020_plank_media_folders.sql ADDED Viewed

@@ -0,0 +1,8 @@
+CREATE TABLE IF NOT EXISTS plank_folders (
+  id         TEXT PRIMARY KEY,
+  name       VARCHAR(255) NOT NULL,
+  parent_id  TEXT REFERENCES plank_folders(id) ON DELETE CASCADE,
+  created_at TIMESTAMP NOT NULL DEFAULT NOW()
+);
+ALTER TABLE plank_media ADD COLUMN IF NOT EXISTS folder_id TEXT REFERENCES plank_folders(id) ON DELETE SET NULL;

package/dist/migrations/021_users_profile_fields.sql ADDED Viewed

@@ -0,0 +1,4 @@
+ALTER TABLE plank_users
+  ADD COLUMN IF NOT EXISTS job_title    VARCHAR(100),
+  ADD COLUMN IF NOT EXISTS organization VARCHAR(150),
+  ADD COLUMN IF NOT EXISTS country      VARCHAR(100);

package/dist/migrations/022_plank_media_metadata.sql ADDED Viewed

@@ -0,0 +1,4 @@
+ALTER TABLE plank_media
+  ADD COLUMN alt    TEXT,
+  ADD COLUMN width  INTEGER,
+  ADD COLUMN height INTEGER;

package/dist/migrations/023_entries_localized.sql ADDED Viewed

@@ -0,0 +1,17 @@
+DO $$
+DECLARE
+  tbl TEXT;
+BEGIN
+  FOR tbl IN SELECT table_name FROM plank_content_types LOOP
+    IF NOT EXISTS (
+      SELECT 1 FROM information_schema.columns
+      WHERE table_name = tbl AND column_name = 'localized'
+    ) THEN
+      EXECUTE format('ALTER TABLE %I ADD COLUMN localized JSONB NOT NULL DEFAULT ''{}''::jsonb', tbl);
+    END IF;
+    -- Create a per-table GIN index for localized to improve JSONB queries
+    EXECUTE format('CREATE INDEX IF NOT EXISTS %I ON %I USING GIN (localized)', 'idx_' || tbl || '_localized_gin', tbl);
+  END LOOP;
+END;
+$$;