@blockforgecms/cms-core 0.1.0

package/README.md

@@ -0,0 +1,10 @@
+# @blockforgecms/cms-core
+
+Shared core utilities for BlockForge contract-driven CMS:
+
+- content model contract types
+- model key normalization helpers
+- default content builders from contracts
+- storage adapter interface + resolvers (`local`, `file`)
+
+This package is framework-agnostic and intended to be reused by adapters and tooling.

package/dist/index.cjs

@@ -0,0 +1,202 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  EMPTY_RICH_TEXT_DOCUMENT: () => EMPTY_RICH_TEXT_DOCUMENT,
+  buildDefaultContentFromContract: () => buildDefaultContentFromContract,
+  createFileStorageAdapter: () => createFileStorageAdapter,
+  createLocalStorageAdapter: () => createLocalStorageAdapter,
+  modelKeyToDisplay: () => modelKeyToDisplay,
+  normalizeModelKey: () => normalizeModelKey,
+  resolveStorageAdapter: () => resolveStorageAdapter
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/model-key.ts
+var normalizeModelKey = (value) => value.trim().replace(/([a-z0-9])([A-Z])/g, "$1-$2").replace(/[^A-Za-z0-9]+/g, "-").replace(/^-+|-+$/g, "").replace(/-+/g, "-").toUpperCase();
+var modelKeyToDisplay = (value) => normalizeModelKey(value).toLowerCase().split("-").filter(Boolean).map((word) => word[0].toUpperCase() + word.slice(1)).join(" ");
+
+// src/defaults.ts
+var clone = (value) => JSON.parse(JSON.stringify(value));
+var EMPTY_RICH_TEXT_DOCUMENT = {
+  type: "doc",
+  content: []
+};
+var getDefaultArrayObjectItemFieldValue = (field) => {
+  switch (field.kind) {
+    case "number":
+      return 0;
+    case "toggle":
+      return false;
+    case "select":
+      return field.options?.[0] || "";
+    case "json":
+      return null;
+    case "text":
+    default:
+      return "";
+  }
+};
+var getDefaultValueForField = (field) => {
+  switch (field.kind) {
+    case "text":
+      return "";
+    case "number":
+      return 0;
+    case "toggle":
+      return false;
+    case "select":
+      return field.options?.[0] || "";
+    case "richtext":
+      return clone(EMPTY_RICH_TEXT_DOCUMENT);
+    case "array-text":
+    case "array-number":
+    case "array-boolean":
+    case "array-object":
+      return [];
+    case "json":
+    default:
+      return null;
+  }
+};
+var normalizeArrayObjectField = (field) => {
+  if (field.kind !== "array-object" || !Array.isArray(field.itemFields)) {
+    return field;
+  }
+  return {
+    ...field,
+    itemFields: field.itemFields.map((itemField) => ({
+      ...itemField,
+      required: itemField.required ?? false
+    }))
+  };
+};
+var buildDefaultContentFromContract = (contract) => {
+  const content = {};
+  for (const rawField of contract.fields || []) {
+    const field = normalizeArrayObjectField(rawField);
+    if (field.kind === "array-object" && field.required && field.itemFields?.length) {
+      const firstItem = field.itemFields.reduce((acc, itemField) => {
+        acc[itemField.key] = getDefaultArrayObjectItemFieldValue(itemField);
+        return acc;
+      }, {});
+      content[field.key] = [firstItem];
+      continue;
+    }
+    content[field.key] = getDefaultValueForField(field);
+  }
+  return content;
+};
+
+// src/storage/local-storage.ts
+var getKey = (namespace, projectId, bucket) => `${namespace}:${projectId}:${bucket}`;
+var safeParse = (value) => {
+  if (!value) {
+    return null;
+  }
+  try {
+    return JSON.parse(value);
+  } catch (_error) {
+    return null;
+  }
+};
+var createLocalStorageAdapter = (namespace = "blockforge") => ({
+  mode: "local",
+  async read(projectId, bucket) {
+    if (typeof window === "undefined") {
+      return null;
+    }
+    return safeParse(window.localStorage.getItem(getKey(namespace, projectId, bucket)));
+  },
+  async write(projectId, bucket, value) {
+    if (typeof window === "undefined") {
+      return;
+    }
+    window.localStorage.setItem(getKey(namespace, projectId, bucket), JSON.stringify(value));
+  },
+  async remove(projectId, bucket) {
+    if (typeof window === "undefined") {
+      return;
+    }
+    window.localStorage.removeItem(getKey(namespace, projectId, bucket));
+  }
+});
+
+// src/storage/file-storage.ts
+var toQuery = (projectId, bucket) => {
+  const params = new URLSearchParams();
+  params.set("projectId", projectId);
+  params.set("bucket", bucket);
+  return params.toString();
+};
+var createFileStorageAdapter = (endpoint = "/api/blockforge/content") => ({
+  mode: "file",
+  async read(projectId, bucket) {
+    const response = await fetch(`${endpoint}?${toQuery(projectId, bucket)}`, {
+      method: "GET",
+      headers: { Accept: "application/json" },
+      credentials: "same-origin"
+    });
+    if (!response.ok) {
+      throw new Error(`File storage read failed (${response.status})`);
+    }
+    const payload = await response.json();
+    return payload.value ?? null;
+  },
+  async write(projectId, bucket, value) {
+    const response = await fetch(endpoint, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      credentials: "same-origin",
+      body: JSON.stringify({ projectId, bucket, value })
+    });
+    if (!response.ok) {
+      throw new Error(`File storage write failed (${response.status})`);
+    }
+  },
+  async remove(projectId, bucket) {
+    const response = await fetch(`${endpoint}?${toQuery(projectId, bucket)}`, {
+      method: "DELETE",
+      credentials: "same-origin"
+    });
+    if (!response.ok) {
+      throw new Error(`File storage delete failed (${response.status})`);
+    }
+  }
+});
+
+// src/storage/resolve.ts
+var resolveStorageAdapter = (options = {}) => {
+  const mode = options.mode || "local";
+  if (mode === "file") {
+    return createFileStorageAdapter(options.fileEndpoint);
+  }
+  return createLocalStorageAdapter(options.namespace);
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  EMPTY_RICH_TEXT_DOCUMENT,
+  buildDefaultContentFromContract,
+  createFileStorageAdapter,
+  createLocalStorageAdapter,
+  modelKeyToDisplay,
+  normalizeModelKey,
+  resolveStorageAdapter
+});

package/dist/index.d.cts

@@ -0,0 +1,66 @@
+type ContractFieldKind = 'text' | 'number' | 'toggle' | 'select' | 'richtext' | 'array-text' | 'array-number' | 'array-boolean' | 'array-object' | 'json';
+interface ContractArrayObjectItemField {
+    key: string;
+    label: string;
+    kind: 'text' | 'number' | 'toggle' | 'select' | 'json';
+    required: boolean;
+    options?: string[];
+}
+interface ContractField {
+    key: string;
+    label: string;
+    kind: ContractFieldKind;
+    required: boolean;
+    options?: string[];
+    itemFields?: ContractArrayObjectItemField[];
+}
+interface ContentModelContract {
+    modelKey: string;
+    displayName: string;
+    sourceKind: 'typescript';
+    sourceRef: string;
+    fields: ContractField[];
+}
+interface ActiveContentModelContract extends ContentModelContract {
+    version: number;
+    contractHash: string;
+}
+interface GeneratedContentModelContract extends ContentModelContract {
+    contractHash: string;
+}
+interface GeneratedContentModelDocument {
+    generatedAt: string;
+    projectId: string;
+    models: GeneratedContentModelContract[];
+}
+
+declare const normalizeModelKey: (value: string) => string;
+declare const modelKeyToDisplay: (value: string) => string;
+
+declare const EMPTY_RICH_TEXT_DOCUMENT: {
+    type: string;
+    content: any[];
+};
+declare const buildDefaultContentFromContract: (contract: ActiveContentModelContract | ContentModelContract) => Record<string, unknown>;
+
+type CMSStorageMode = 'local' | 'file';
+type CMSStorageBucket = 'pages' | 'settings' | 'reusableSections' | 'contentModels' | 'projectApiKeys' | 'projects';
+interface CMSStorageAdapter {
+    mode: CMSStorageMode;
+    read<T>(projectId: string, bucket: CMSStorageBucket): Promise<T | null>;
+    write<T>(projectId: string, bucket: CMSStorageBucket, value: T): Promise<void>;
+    remove(projectId: string, bucket: CMSStorageBucket): Promise<void>;
+}
+interface ResolveStorageAdapterOptions {
+    mode?: CMSStorageMode;
+    namespace?: string;
+    fileEndpoint?: string;
+}
+
+declare const createLocalStorageAdapter: (namespace?: string) => CMSStorageAdapter;
+
+declare const createFileStorageAdapter: (endpoint?: string) => CMSStorageAdapter;
+
+declare const resolveStorageAdapter: (options?: ResolveStorageAdapterOptions) => CMSStorageAdapter;
+
+export { type ActiveContentModelContract, type CMSStorageAdapter, type CMSStorageBucket, type CMSStorageMode, type ContentModelContract, type ContractArrayObjectItemField, type ContractField, type ContractFieldKind, EMPTY_RICH_TEXT_DOCUMENT, type GeneratedContentModelContract, type GeneratedContentModelDocument, type ResolveStorageAdapterOptions, buildDefaultContentFromContract, createFileStorageAdapter, createLocalStorageAdapter, modelKeyToDisplay, normalizeModelKey, resolveStorageAdapter };

package/dist/index.d.ts

@@ -0,0 +1,66 @@
+type ContractFieldKind = 'text' | 'number' | 'toggle' | 'select' | 'richtext' | 'array-text' | 'array-number' | 'array-boolean' | 'array-object' | 'json';
+interface ContractArrayObjectItemField {
+    key: string;
+    label: string;
+    kind: 'text' | 'number' | 'toggle' | 'select' | 'json';
+    required: boolean;
+    options?: string[];
+}
+interface ContractField {
+    key: string;
+    label: string;
+    kind: ContractFieldKind;
+    required: boolean;
+    options?: string[];
+    itemFields?: ContractArrayObjectItemField[];
+}
+interface ContentModelContract {
+    modelKey: string;
+    displayName: string;
+    sourceKind: 'typescript';
+    sourceRef: string;
+    fields: ContractField[];
+}
+interface ActiveContentModelContract extends ContentModelContract {
+    version: number;
+    contractHash: string;
+}
+interface GeneratedContentModelContract extends ContentModelContract {
+    contractHash: string;
+}
+interface GeneratedContentModelDocument {
+    generatedAt: string;
+    projectId: string;
+    models: GeneratedContentModelContract[];
+}
+
+declare const normalizeModelKey: (value: string) => string;
+declare const modelKeyToDisplay: (value: string) => string;
+
+declare const EMPTY_RICH_TEXT_DOCUMENT: {
+    type: string;
+    content: any[];
+};
+declare const buildDefaultContentFromContract: (contract: ActiveContentModelContract | ContentModelContract) => Record<string, unknown>;
+
+type CMSStorageMode = 'local' | 'file';
+type CMSStorageBucket = 'pages' | 'settings' | 'reusableSections' | 'contentModels' | 'projectApiKeys' | 'projects';
+interface CMSStorageAdapter {
+    mode: CMSStorageMode;
+    read<T>(projectId: string, bucket: CMSStorageBucket): Promise<T | null>;
+    write<T>(projectId: string, bucket: CMSStorageBucket, value: T): Promise<void>;
+    remove(projectId: string, bucket: CMSStorageBucket): Promise<void>;
+}
+interface ResolveStorageAdapterOptions {
+    mode?: CMSStorageMode;
+    namespace?: string;
+    fileEndpoint?: string;
+}
+
+declare const createLocalStorageAdapter: (namespace?: string) => CMSStorageAdapter;
+
+declare const createFileStorageAdapter: (endpoint?: string) => CMSStorageAdapter;
+
+declare const resolveStorageAdapter: (options?: ResolveStorageAdapterOptions) => CMSStorageAdapter;
+
+export { type ActiveContentModelContract, type CMSStorageAdapter, type CMSStorageBucket, type CMSStorageMode, type ContentModelContract, type ContractArrayObjectItemField, type ContractField, type ContractFieldKind, EMPTY_RICH_TEXT_DOCUMENT, type GeneratedContentModelContract, type GeneratedContentModelDocument, type ResolveStorageAdapterOptions, buildDefaultContentFromContract, createFileStorageAdapter, createLocalStorageAdapter, modelKeyToDisplay, normalizeModelKey, resolveStorageAdapter };

package/dist/index.js

@@ -0,0 +1,170 @@
+// src/model-key.ts
+var normalizeModelKey = (value) => value.trim().replace(/([a-z0-9])([A-Z])/g, "$1-$2").replace(/[^A-Za-z0-9]+/g, "-").replace(/^-+|-+$/g, "").replace(/-+/g, "-").toUpperCase();
+var modelKeyToDisplay = (value) => normalizeModelKey(value).toLowerCase().split("-").filter(Boolean).map((word) => word[0].toUpperCase() + word.slice(1)).join(" ");
+
+// src/defaults.ts
+var clone = (value) => JSON.parse(JSON.stringify(value));
+var EMPTY_RICH_TEXT_DOCUMENT = {
+  type: "doc",
+  content: []
+};
+var getDefaultArrayObjectItemFieldValue = (field) => {
+  switch (field.kind) {
+    case "number":
+      return 0;
+    case "toggle":
+      return false;
+    case "select":
+      return field.options?.[0] || "";
+    case "json":
+      return null;
+    case "text":
+    default:
+      return "";
+  }
+};
+var getDefaultValueForField = (field) => {
+  switch (field.kind) {
+    case "text":
+      return "";
+    case "number":
+      return 0;
+    case "toggle":
+      return false;
+    case "select":
+      return field.options?.[0] || "";
+    case "richtext":
+      return clone(EMPTY_RICH_TEXT_DOCUMENT);
+    case "array-text":
+    case "array-number":
+    case "array-boolean":
+    case "array-object":
+      return [];
+    case "json":
+    default:
+      return null;
+  }
+};
+var normalizeArrayObjectField = (field) => {
+  if (field.kind !== "array-object" || !Array.isArray(field.itemFields)) {
+    return field;
+  }
+  return {
+    ...field,
+    itemFields: field.itemFields.map((itemField) => ({
+      ...itemField,
+      required: itemField.required ?? false
+    }))
+  };
+};
+var buildDefaultContentFromContract = (contract) => {
+  const content = {};
+  for (const rawField of contract.fields || []) {
+    const field = normalizeArrayObjectField(rawField);
+    if (field.kind === "array-object" && field.required && field.itemFields?.length) {
+      const firstItem = field.itemFields.reduce((acc, itemField) => {
+        acc[itemField.key] = getDefaultArrayObjectItemFieldValue(itemField);
+        return acc;
+      }, {});
+      content[field.key] = [firstItem];
+      continue;
+    }
+    content[field.key] = getDefaultValueForField(field);
+  }
+  return content;
+};
+
+// src/storage/local-storage.ts
+var getKey = (namespace, projectId, bucket) => `${namespace}:${projectId}:${bucket}`;
+var safeParse = (value) => {
+  if (!value) {
+    return null;
+  }
+  try {
+    return JSON.parse(value);
+  } catch (_error) {
+    return null;
+  }
+};
+var createLocalStorageAdapter = (namespace = "blockforge") => ({
+  mode: "local",
+  async read(projectId, bucket) {
+    if (typeof window === "undefined") {
+      return null;
+    }
+    return safeParse(window.localStorage.getItem(getKey(namespace, projectId, bucket)));
+  },
+  async write(projectId, bucket, value) {
+    if (typeof window === "undefined") {
+      return;
+    }
+    window.localStorage.setItem(getKey(namespace, projectId, bucket), JSON.stringify(value));
+  },
+  async remove(projectId, bucket) {
+    if (typeof window === "undefined") {
+      return;
+    }
+    window.localStorage.removeItem(getKey(namespace, projectId, bucket));
+  }
+});
+
+// src/storage/file-storage.ts
+var toQuery = (projectId, bucket) => {
+  const params = new URLSearchParams();
+  params.set("projectId", projectId);
+  params.set("bucket", bucket);
+  return params.toString();
+};
+var createFileStorageAdapter = (endpoint = "/api/blockforge/content") => ({
+  mode: "file",
+  async read(projectId, bucket) {
+    const response = await fetch(`${endpoint}?${toQuery(projectId, bucket)}`, {
+      method: "GET",
+      headers: { Accept: "application/json" },
+      credentials: "same-origin"
+    });
+    if (!response.ok) {
+      throw new Error(`File storage read failed (${response.status})`);
+    }
+    const payload = await response.json();
+    return payload.value ?? null;
+  },
+  async write(projectId, bucket, value) {
+    const response = await fetch(endpoint, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      credentials: "same-origin",
+      body: JSON.stringify({ projectId, bucket, value })
+    });
+    if (!response.ok) {
+      throw new Error(`File storage write failed (${response.status})`);
+    }
+  },
+  async remove(projectId, bucket) {
+    const response = await fetch(`${endpoint}?${toQuery(projectId, bucket)}`, {
+      method: "DELETE",
+      credentials: "same-origin"
+    });
+    if (!response.ok) {
+      throw new Error(`File storage delete failed (${response.status})`);
+    }
+  }
+});
+
+// src/storage/resolve.ts
+var resolveStorageAdapter = (options = {}) => {
+  const mode = options.mode || "local";
+  if (mode === "file") {
+    return createFileStorageAdapter(options.fileEndpoint);
+  }
+  return createLocalStorageAdapter(options.namespace);
+};
+export {
+  EMPTY_RICH_TEXT_DOCUMENT,
+  buildDefaultContentFromContract,
+  createFileStorageAdapter,
+  createLocalStorageAdapter,
+  modelKeyToDisplay,
+  normalizeModelKey,
+  resolveStorageAdapter
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@blockforgecms/cms-core",
+  "version": "0.1.0",
+  "private": false,
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "clean": "rm -rf dist"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.0"
+  }
+}