@orion-studios/payload-studio-core 0.1.0-beta.1

package/dist/index.d.mts

@@ -0,0 +1,104 @@
+type StudioNodeData = Record<string, unknown>;
+type StudioNode = {
+    id: string;
+    type: string;
+    data: StudioNodeData;
+};
+type StudioDocumentV1 = {
+    schemaVersion: 1;
+    title?: string;
+    nodes: StudioNode[];
+    updatedAt?: string;
+};
+type StudioValidationIssue = {
+    code: string;
+    message: string;
+    path: string;
+    severity: 'error' | 'warning';
+};
+type StudioCompileResult = {
+    issues: StudioValidationIssue[];
+    layout: Record<string, unknown>[];
+};
+type StudioMigration = {
+    fromVersion: number;
+    migrate: (value: unknown) => StudioDocumentV1;
+    toVersion: number;
+};
+type StudioPermission = {
+    action: 'create' | 'publish' | 'read' | 'update';
+    role: 'admin' | 'client' | 'editor';
+};
+type StudioPaletteItem = {
+    description?: string;
+    nodeType: string;
+    title: string;
+};
+type StudioPaletteGroup = {
+    id: string;
+    items: StudioPaletteItem[];
+    label: string;
+};
+type StudioInspectorField = {
+    key: string;
+    label: string;
+    type: 'array' | 'checkbox' | 'number' | 'select' | 'text' | 'textarea';
+};
+type StudioInspectorPanel = {
+    fields: StudioInspectorField[];
+    id: string;
+    label: string;
+    nodeType: string;
+};
+type StudioNodeTypeDefinition = {
+    description?: string;
+    displayName: string;
+    getDefaultData: () => StudioNodeData;
+    type: string;
+};
+type StudioModuleManifest = {
+    compiler?: {
+        compileNode?: (node: StudioNode) => Record<string, unknown> | null;
+    };
+    displayName: string;
+    id: string;
+    inspectorPanels: StudioInspectorPanel[];
+    migrations: StudioMigration[];
+    nodeTypes: StudioNodeTypeDefinition[];
+    paletteGroups: StudioPaletteGroup[];
+    permissions?: StudioPermission[];
+    validators: Array<(value: StudioDocumentV1) => StudioValidationIssue[]>;
+    version: string;
+};
+type StudioRegistry = {
+    getModuleByID: (id: string) => StudioModuleManifest | undefined;
+    getNodeTypeByName: (type: string) => StudioNodeTypeDefinition | undefined;
+    listInspectorPanels: () => StudioInspectorPanel[];
+    listModules: () => StudioModuleManifest[];
+    listPaletteGroups: () => StudioPaletteGroup[];
+    listNodeTypes: () => StudioNodeTypeDefinition[];
+};
+type StudioPageService = {
+    getPageForStudio: (pageID: string) => Promise<{
+        id: string;
+        studioDocument: StudioDocumentV1;
+        title: string;
+    }>;
+    publish: (pageID: string, document: StudioDocumentV1, metadata?: Record<string, unknown>) => Promise<{
+        id: string;
+        status: 'published';
+    }>;
+    saveDraft: (pageID: string, document: StudioDocumentV1, metadata?: Record<string, unknown>) => Promise<{
+        id: string;
+        status: 'draft';
+    }>;
+    validateStudioDocument: (document: StudioDocumentV1) => StudioValidationIssue[];
+};
+declare const createEmptyStudioDocument: (title?: string) => StudioDocumentV1;
+declare function assertStudioDocumentV1(input: unknown): StudioDocumentV1;
+declare function createStudioRegistry(modules: StudioModuleManifest[]): StudioRegistry;
+declare function validateStudioDocument(document: StudioDocumentV1, modules: StudioModuleManifest[]): StudioValidationIssue[];
+declare function compileStudioDocument(document: StudioDocumentV1, modules: StudioModuleManifest[]): StudioCompileResult;
+declare function migrateStudioDocument(value: unknown, migrations: StudioMigration[]): StudioDocumentV1;
+
+export { type StudioCompileResult, type StudioDocumentV1, type StudioInspectorField, type StudioInspectorPanel, type StudioMigration, type StudioModuleManifest, type StudioNode, type StudioNodeData, type StudioNodeTypeDefinition, type StudioPageService, type StudioPaletteGroup, type StudioPaletteItem, type StudioPermission, type StudioRegistry, type StudioValidationIssue, assertStudioDocumentV1, compileStudioDocument, createEmptyStudioDocument, createStudioRegistry, migrateStudioDocument, validateStudioDocument };

package/dist/index.d.ts

@@ -0,0 +1,104 @@
+type StudioNodeData = Record<string, unknown>;
+type StudioNode = {
+    id: string;
+    type: string;
+    data: StudioNodeData;
+};
+type StudioDocumentV1 = {
+    schemaVersion: 1;
+    title?: string;
+    nodes: StudioNode[];
+    updatedAt?: string;
+};
+type StudioValidationIssue = {
+    code: string;
+    message: string;
+    path: string;
+    severity: 'error' | 'warning';
+};
+type StudioCompileResult = {
+    issues: StudioValidationIssue[];
+    layout: Record<string, unknown>[];
+};
+type StudioMigration = {
+    fromVersion: number;
+    migrate: (value: unknown) => StudioDocumentV1;
+    toVersion: number;
+};
+type StudioPermission = {
+    action: 'create' | 'publish' | 'read' | 'update';
+    role: 'admin' | 'client' | 'editor';
+};
+type StudioPaletteItem = {
+    description?: string;
+    nodeType: string;
+    title: string;
+};
+type StudioPaletteGroup = {
+    id: string;
+    items: StudioPaletteItem[];
+    label: string;
+};
+type StudioInspectorField = {
+    key: string;
+    label: string;
+    type: 'array' | 'checkbox' | 'number' | 'select' | 'text' | 'textarea';
+};
+type StudioInspectorPanel = {
+    fields: StudioInspectorField[];
+    id: string;
+    label: string;
+    nodeType: string;
+};
+type StudioNodeTypeDefinition = {
+    description?: string;
+    displayName: string;
+    getDefaultData: () => StudioNodeData;
+    type: string;
+};
+type StudioModuleManifest = {
+    compiler?: {
+        compileNode?: (node: StudioNode) => Record<string, unknown> | null;
+    };
+    displayName: string;
+    id: string;
+    inspectorPanels: StudioInspectorPanel[];
+    migrations: StudioMigration[];
+    nodeTypes: StudioNodeTypeDefinition[];
+    paletteGroups: StudioPaletteGroup[];
+    permissions?: StudioPermission[];
+    validators: Array<(value: StudioDocumentV1) => StudioValidationIssue[]>;
+    version: string;
+};
+type StudioRegistry = {
+    getModuleByID: (id: string) => StudioModuleManifest | undefined;
+    getNodeTypeByName: (type: string) => StudioNodeTypeDefinition | undefined;
+    listInspectorPanels: () => StudioInspectorPanel[];
+    listModules: () => StudioModuleManifest[];
+    listPaletteGroups: () => StudioPaletteGroup[];
+    listNodeTypes: () => StudioNodeTypeDefinition[];
+};
+type StudioPageService = {
+    getPageForStudio: (pageID: string) => Promise<{
+        id: string;
+        studioDocument: StudioDocumentV1;
+        title: string;
+    }>;
+    publish: (pageID: string, document: StudioDocumentV1, metadata?: Record<string, unknown>) => Promise<{
+        id: string;
+        status: 'published';
+    }>;
+    saveDraft: (pageID: string, document: StudioDocumentV1, metadata?: Record<string, unknown>) => Promise<{
+        id: string;
+        status: 'draft';
+    }>;
+    validateStudioDocument: (document: StudioDocumentV1) => StudioValidationIssue[];
+};
+declare const createEmptyStudioDocument: (title?: string) => StudioDocumentV1;
+declare function assertStudioDocumentV1(input: unknown): StudioDocumentV1;
+declare function createStudioRegistry(modules: StudioModuleManifest[]): StudioRegistry;
+declare function validateStudioDocument(document: StudioDocumentV1, modules: StudioModuleManifest[]): StudioValidationIssue[];
+declare function compileStudioDocument(document: StudioDocumentV1, modules: StudioModuleManifest[]): StudioCompileResult;
+declare function migrateStudioDocument(value: unknown, migrations: StudioMigration[]): StudioDocumentV1;
+
+export { type StudioCompileResult, type StudioDocumentV1, type StudioInspectorField, type StudioInspectorPanel, type StudioMigration, type StudioModuleManifest, type StudioNode, type StudioNodeData, type StudioNodeTypeDefinition, type StudioPageService, type StudioPaletteGroup, type StudioPaletteItem, type StudioPermission, type StudioRegistry, type StudioValidationIssue, assertStudioDocumentV1, compileStudioDocument, createEmptyStudioDocument, createStudioRegistry, migrateStudioDocument, validateStudioDocument };

package/dist/index.js

@@ -0,0 +1,169 @@
+"use strict";
+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, {
+  assertStudioDocumentV1: () => assertStudioDocumentV1,
+  compileStudioDocument: () => compileStudioDocument,
+  createEmptyStudioDocument: () => createEmptyStudioDocument,
+  createStudioRegistry: () => createStudioRegistry,
+  migrateStudioDocument: () => migrateStudioDocument,
+  validateStudioDocument: () => validateStudioDocument
+});
+module.exports = __toCommonJS(index_exports);
+var isRecord = (value) => Boolean(value) && typeof value === "object" && !Array.isArray(value);
+var makeIssue = (message, path, code = "studio.invalid") => ({
+  code,
+  message,
+  path,
+  severity: "error"
+});
+var createEmptyStudioDocument = (title) => ({
+  schemaVersion: 1,
+  title,
+  nodes: [],
+  updatedAt: (/* @__PURE__ */ new Date()).toISOString()
+});
+function assertStudioDocumentV1(input) {
+  if (!isRecord(input)) {
+    throw new Error("Studio document must be an object");
+  }
+  if (input.schemaVersion !== 1) {
+    throw new Error("Unsupported studio schemaVersion");
+  }
+  if (!Array.isArray(input.nodes)) {
+    throw new Error("Studio document nodes must be an array");
+  }
+  const nodes = input.nodes.map((node, index) => {
+    if (!isRecord(node)) {
+      throw new Error(`Node at index ${index} must be an object`);
+    }
+    if (typeof node.id !== "string" || node.id.length === 0) {
+      throw new Error(`Node at index ${index} has invalid id`);
+    }
+    if (typeof node.type !== "string" || node.type.length === 0) {
+      throw new Error(`Node at index ${index} has invalid type`);
+    }
+    if (!isRecord(node.data)) {
+      throw new Error(`Node at index ${index} has invalid data`);
+    }
+    return {
+      id: node.id,
+      type: node.type,
+      data: node.data
+    };
+  });
+  return {
+    schemaVersion: 1,
+    title: typeof input.title === "string" ? input.title : void 0,
+    nodes,
+    updatedAt: typeof input.updatedAt === "string" ? input.updatedAt : void 0
+  };
+}
+function createStudioRegistry(modules) {
+  const moduleByID = new Map(modules.map((mod) => [mod.id, mod]));
+  const nodeTypes = modules.flatMap((mod) => mod.nodeTypes);
+  const nodeTypeByName = new Map(nodeTypes.map((definition) => [definition.type, definition]));
+  return {
+    getModuleByID: (id) => moduleByID.get(id),
+    getNodeTypeByName: (type) => nodeTypeByName.get(type),
+    listInspectorPanels: () => modules.flatMap((mod) => mod.inspectorPanels),
+    listModules: () => [...modules],
+    listPaletteGroups: () => modules.flatMap((mod) => mod.paletteGroups),
+    listNodeTypes: () => [...nodeTypes]
+  };
+}
+function validateStudioDocument(document, modules) {
+  const issues = [];
+  if (document.schemaVersion !== 1) {
+    issues.push(makeIssue("Unsupported schema version", "schemaVersion", "studio.schemaVersion"));
+  }
+  if (!Array.isArray(document.nodes)) {
+    issues.push(makeIssue("Nodes must be an array", "nodes", "studio.nodes"));
+    return issues;
+  }
+  const registry = createStudioRegistry(modules);
+  const nodeIDs = /* @__PURE__ */ new Set();
+  document.nodes.forEach((node, index) => {
+    if (!node.id) {
+      issues.push(makeIssue("Node id is required", `nodes.${index}.id`, "studio.node.id"));
+    }
+    if (nodeIDs.has(node.id)) {
+      issues.push(makeIssue("Node id must be unique", `nodes.${index}.id`, "studio.node.id.duplicate"));
+    }
+    nodeIDs.add(node.id);
+    if (!registry.getNodeTypeByName(node.type)) {
+      issues.push(makeIssue("Unsupported node type", `nodes.${index}.type`, "studio.node.type"));
+    }
+  });
+  for (const module2 of modules) {
+    for (const validate of module2.validators) {
+      issues.push(...validate(document));
+    }
+  }
+  return issues;
+}
+function compileStudioDocument(document, modules) {
+  const issues = validateStudioDocument(document, modules);
+  const compilerEntries = modules.filter((mod) => typeof mod.compiler?.compileNode === "function").map((mod) => mod.compiler?.compileNode);
+  const layout = document.nodes.map((node) => {
+    for (const compileNode of compilerEntries) {
+      if (!compileNode) {
+        continue;
+      }
+      const compiled = compileNode(node);
+      if (compiled) {
+        return compiled;
+      }
+    }
+    return {
+      id: node.id,
+      blockType: node.type,
+      ...node.data
+    };
+  });
+  return {
+    issues,
+    layout
+  };
+}
+function migrateStudioDocument(value, migrations) {
+  const sorted = [...migrations].sort((a, b) => a.fromVersion - b.fromVersion);
+  if (isRecord(value) && value.schemaVersion === 1) {
+    return assertStudioDocumentV1(value);
+  }
+  let current = value;
+  for (const migration of sorted) {
+    if (!isRecord(current) || current.schemaVersion !== migration.fromVersion) {
+      continue;
+    }
+    current = migration.migrate(current);
+  }
+  return assertStudioDocumentV1(current);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  assertStudioDocumentV1,
+  compileStudioDocument,
+  createEmptyStudioDocument,
+  createStudioRegistry,
+  migrateStudioDocument,
+  validateStudioDocument
+});

package/dist/index.mjs

@@ -0,0 +1,139 @@
+// src/index.ts
+var isRecord = (value) => Boolean(value) && typeof value === "object" && !Array.isArray(value);
+var makeIssue = (message, path, code = "studio.invalid") => ({
+  code,
+  message,
+  path,
+  severity: "error"
+});
+var createEmptyStudioDocument = (title) => ({
+  schemaVersion: 1,
+  title,
+  nodes: [],
+  updatedAt: (/* @__PURE__ */ new Date()).toISOString()
+});
+function assertStudioDocumentV1(input) {
+  if (!isRecord(input)) {
+    throw new Error("Studio document must be an object");
+  }
+  if (input.schemaVersion !== 1) {
+    throw new Error("Unsupported studio schemaVersion");
+  }
+  if (!Array.isArray(input.nodes)) {
+    throw new Error("Studio document nodes must be an array");
+  }
+  const nodes = input.nodes.map((node, index) => {
+    if (!isRecord(node)) {
+      throw new Error(`Node at index ${index} must be an object`);
+    }
+    if (typeof node.id !== "string" || node.id.length === 0) {
+      throw new Error(`Node at index ${index} has invalid id`);
+    }
+    if (typeof node.type !== "string" || node.type.length === 0) {
+      throw new Error(`Node at index ${index} has invalid type`);
+    }
+    if (!isRecord(node.data)) {
+      throw new Error(`Node at index ${index} has invalid data`);
+    }
+    return {
+      id: node.id,
+      type: node.type,
+      data: node.data
+    };
+  });
+  return {
+    schemaVersion: 1,
+    title: typeof input.title === "string" ? input.title : void 0,
+    nodes,
+    updatedAt: typeof input.updatedAt === "string" ? input.updatedAt : void 0
+  };
+}
+function createStudioRegistry(modules) {
+  const moduleByID = new Map(modules.map((mod) => [mod.id, mod]));
+  const nodeTypes = modules.flatMap((mod) => mod.nodeTypes);
+  const nodeTypeByName = new Map(nodeTypes.map((definition) => [definition.type, definition]));
+  return {
+    getModuleByID: (id) => moduleByID.get(id),
+    getNodeTypeByName: (type) => nodeTypeByName.get(type),
+    listInspectorPanels: () => modules.flatMap((mod) => mod.inspectorPanels),
+    listModules: () => [...modules],
+    listPaletteGroups: () => modules.flatMap((mod) => mod.paletteGroups),
+    listNodeTypes: () => [...nodeTypes]
+  };
+}
+function validateStudioDocument(document, modules) {
+  const issues = [];
+  if (document.schemaVersion !== 1) {
+    issues.push(makeIssue("Unsupported schema version", "schemaVersion", "studio.schemaVersion"));
+  }
+  if (!Array.isArray(document.nodes)) {
+    issues.push(makeIssue("Nodes must be an array", "nodes", "studio.nodes"));
+    return issues;
+  }
+  const registry = createStudioRegistry(modules);
+  const nodeIDs = /* @__PURE__ */ new Set();
+  document.nodes.forEach((node, index) => {
+    if (!node.id) {
+      issues.push(makeIssue("Node id is required", `nodes.${index}.id`, "studio.node.id"));
+    }
+    if (nodeIDs.has(node.id)) {
+      issues.push(makeIssue("Node id must be unique", `nodes.${index}.id`, "studio.node.id.duplicate"));
+    }
+    nodeIDs.add(node.id);
+    if (!registry.getNodeTypeByName(node.type)) {
+      issues.push(makeIssue("Unsupported node type", `nodes.${index}.type`, "studio.node.type"));
+    }
+  });
+  for (const module of modules) {
+    for (const validate of module.validators) {
+      issues.push(...validate(document));
+    }
+  }
+  return issues;
+}
+function compileStudioDocument(document, modules) {
+  const issues = validateStudioDocument(document, modules);
+  const compilerEntries = modules.filter((mod) => typeof mod.compiler?.compileNode === "function").map((mod) => mod.compiler?.compileNode);
+  const layout = document.nodes.map((node) => {
+    for (const compileNode of compilerEntries) {
+      if (!compileNode) {
+        continue;
+      }
+      const compiled = compileNode(node);
+      if (compiled) {
+        return compiled;
+      }
+    }
+    return {
+      id: node.id,
+      blockType: node.type,
+      ...node.data
+    };
+  });
+  return {
+    issues,
+    layout
+  };
+}
+function migrateStudioDocument(value, migrations) {
+  const sorted = [...migrations].sort((a, b) => a.fromVersion - b.fromVersion);
+  if (isRecord(value) && value.schemaVersion === 1) {
+    return assertStudioDocumentV1(value);
+  }
+  let current = value;
+  for (const migration of sorted) {
+    if (!isRecord(current) || current.schemaVersion !== migration.fromVersion) {
+      continue;
+    }
+    current = migration.migrate(current);
+  }
+  return assertStudioDocumentV1(current);
+}
+export {
+  assertStudioDocumentV1,
+  compileStudioDocument,
+  createEmptyStudioDocument,
+  createStudioRegistry,
+  migrateStudioDocument,
+  validateStudioDocument
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@orion-studios/payload-studio-core",
+  "version": "0.1.0-beta.1",
+  "description": "Core types, contracts, registry, and validation for Orion Studio",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "payload",
+    "cms",
+    "studio",
+    "headless"
+  ],
+  "author": "Orion Studios",
+  "license": "MIT",
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0"
+  }
+}