rimelight-components 2.0.49 → 2.0.50

package/dist/runtime/composables/useBlockEditor.js

@@ -20,7 +20,7 @@ function regenerateIds(block) {
     block.props.children.forEach((child) => regenerateIds(child));
   }
 }
-export function useBlockEditor(initialBlocks, maxHistorySize = 100) {
+export function useBlockEditor(initialBlocks, { maxHistorySize = 100, onMutation } = {}) {
   const history = shallowRef([]);
   const future = shallowRef([]);
   const committedBlocks = ref(JSON.parse(JSON.stringify(initialBlocks.value)));
@@ -34,7 +34,11 @@ export function useBlockEditor(initialBlocks, maxHistorySize = 100) {
     history.value = newHistory;
   };
   const executeMutation = (mutationFn) => {
-    captureSnapshot();
+    if (onMutation) {
+      onMutation();
+    } else {
+      captureSnapshot();
+    }
     mutationFn();
   };
   const undo = () => {

package/dist/runtime/composables/usePageEditor.d.ts

@@ -0,0 +1,10 @@
+import { type Ref } from "vue";
+import type { Page } from "../types/pages.js";
+export declare function usePageEditor(page: Ref<Page>, maxHistorySize?: number): {
+    undo: () => void;
+    redo: () => void;
+    canUndo: import("vue").ComputedRef<boolean>;
+    canRedo: import("vue").ComputedRef<boolean>;
+    save: () => any;
+    captureSnapshot: () => void;
+};

package/dist/runtime/composables/usePageEditor.js

@@ -0,0 +1,41 @@
+import { computed, shallowRef, watch } from "vue";
+export function usePageEditor(page, maxHistorySize = 100) {
+  const history = shallowRef([]);
+  const future = shallowRef([]);
+  const captureSnapshot = () => {
+    const snapshot = JSON.stringify(page.value);
+    if (history.value.length > 0 && history.value[history.value.length - 1] === snapshot) return;
+    future.value = [];
+    const newHistory = [...history.value, snapshot];
+    if (newHistory.length > maxHistorySize) newHistory.shift();
+    history.value = newHistory;
+  };
+  const undo = () => {
+    if (history.value.length === 0) return;
+    future.value = [JSON.stringify(page.value), ...future.value];
+    const previous = JSON.parse(history.value.pop());
+    page.value = previous;
+  };
+  const redo = () => {
+    if (future.value.length === 0) return;
+    history.value = [...history.value, JSON.stringify(page.value)];
+    const next = JSON.parse(future.value.shift());
+    page.value = next;
+  };
+  const canUndo = computed(() => history.value.length > 0);
+  const canRedo = computed(() => future.value.length > 0);
+  const save = () => {
+    return JSON.parse(JSON.stringify(page.value));
+  };
+  watch(() => page.value.properties, () => {
+    captureSnapshot();
+  }, { deep: true });
+  return {
+    undo,
+    redo,
+    canUndo,
+    canRedo,
+    save,
+    captureSnapshot
+  };
+}

package/dist/runtime/types/blocks.d.ts

@@ -14,6 +14,7 @@ export type BlockType = "TestBlock" | "SectionBlock" | "ParagraphBlock" | "Callo
 export interface BaseBlock {
     id: string;
     type: BlockType;
+    isTemplated?: boolean;
     props: Record<string, any>;
 }
 export interface TestBlockProps {

package/dist/runtime/types/pageTemplates.d.ts

@@ -0,0 +1,3 @@
+import { type Block } from "./blocks.js";
+import { type PageType } from "./pages.js";
+export declare const PAGE_TEMPLATES: Record<PageType, () => Block[]>;

package/dist/runtime/types/pageTemplates.js

@@ -0,0 +1,170 @@
+import { v7 as uuidv7 } from "uuid";
+export const PAGE_TEMPLATES = {
+  Default: () => [],
+  Character: () => [
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Appearance", children: [] }
+    },
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Abilities", children: [] }
+    },
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "History", children: [] }
+    }
+  ],
+  Location: () => [
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Geography", children: [] }
+    },
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Points of Interest", children: [] }
+    },
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "History", children: [] }
+    }
+  ],
+  Species: () => [
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Biology", children: [] }
+    },
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Culture", children: [] }
+    }
+  ],
+  Object: () => [
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Description", children: [] }
+    },
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Properties", children: [] }
+    }
+  ],
+  Tale: () => [
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Summary", children: [] }
+    },
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "The Story", children: [] }
+    }
+  ],
+  Item: () => [
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Statistics", children: [] }
+    },
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Lore", children: [] }
+    }
+  ],
+  Skill: () => [
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Effects", children: [] }
+    },
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Acquisition", children: [] }
+    }
+  ],
+  Hero: () => [
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Background", children: [] }
+    },
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Legacy", children: [] }
+    }
+  ],
+  Card: () => [
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Card Art", children: [] }
+    },
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Game Mechanics", children: [] }
+    }
+  ],
+  Series: () => [
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Synopsis", children: [] }
+    },
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "List of Episodes", children: [] }
+    }
+  ],
+  Episode: () => [
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Plot Summary", children: [] }
+    },
+    {
+      id: uuidv7(),
+      type: "SectionBlock",
+      isTemplated: true,
+      props: { level: 2, title: "Characters Appearing", children: [] }
+    }
+  ]
+};

package/dist/runtime/types/pages.d.ts

@@ -0,0 +1,120 @@
+import { type Block } from "./blocks.js";
+export type PageType = "Default" | "Location" | "Species" | "Character" | "Object" | "Tale" | "Item" | "Skill" | "Hero" | "Card" | "Series" | "Episode";
+export interface Property {
+    label: string;
+    type: "number" | "text" | "text-array" | "enum" | "page" | "page-array";
+    options?: string[];
+    allowedPageTypes?: PageType[];
+    order?: number;
+    visibleIf?: (properties: any) => boolean;
+}
+export interface PropertyGroup {
+    id: string;
+    label: string;
+    order?: number;
+    fields: Record<string, Property>;
+}
+export interface BasePageProperties {
+}
+export interface LocationProperties extends BasePageProperties {
+}
+export interface SpeciesProperties extends BasePageProperties {
+}
+export interface CharacterProperties extends BasePageProperties {
+    name: string;
+    title?: string;
+    aliases?: string[];
+    flavourText?: string;
+    species?: string;
+    sex?: string;
+    pronouns?: string;
+    height?: number;
+    weight?: number;
+    dateOfBirth?: string;
+    dateOfDeath?: string;
+    placeOfBirth?: string;
+    placeOfDeath?: string;
+    formerAffiliations?: string[];
+    currentAffiliations?: string[];
+    equipment?: string[];
+    pets?: string[];
+    mounts?: string[];
+    favouriteFood?: string;
+}
+export interface ObjectProperties extends BasePageProperties {
+}
+export interface TaleProperties extends BasePageProperties {
+}
+export interface ItemProperties extends BasePageProperties {
+}
+export interface SkillProperties extends BasePageProperties {
+}
+export interface HeroProperties extends BasePageProperties {
+}
+export interface CardProperties extends BasePageProperties {
+    name: string;
+    alignment: string;
+    type: string;
+    flavourText: string;
+}
+export interface SeriesProperties extends BasePageProperties {
+}
+export interface EpisodeProperties extends BasePageProperties {
+}
+/**
+ * Common fields shared by every page regardless of type.
+ */
+interface BasePage {
+    id: string;
+    slug: string;
+    tags: string[];
+    blocks: Block[];
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Discriminated Union for Page Data structure
+ */
+export type Page = {
+    type: "Default";
+    properties: BasePageProperties;
+} & BasePage | {
+    type: "Character";
+    properties: CharacterProperties;
+} & BasePage | {
+    type: "Card";
+    properties: CardProperties;
+} & BasePage | {
+    type: "Location";
+    properties: BasePageProperties;
+} & BasePage | {
+    type: "Species";
+    properties: BasePageProperties;
+} & BasePage | {
+    type: "Object";
+    properties: BasePageProperties;
+} & BasePage | {
+    type: "Tale";
+    properties: BasePageProperties;
+} & BasePage | {
+    type: "Item";
+    properties: BasePageProperties;
+} & BasePage | {
+    type: "Skill";
+    properties: BasePageProperties;
+} & BasePage | {
+    type: "Hero";
+    properties: BasePageProperties;
+} & BasePage | {
+    type: "Series";
+    properties: BasePageProperties;
+} & BasePage | {
+    type: "Episode";
+    properties: BasePageProperties;
+} & BasePage;
+/**
+ * Registry mapping PageTypes to their UI schema.
+ * This drives the dynamic form generation in the Sidebar.
+ */
+export declare const PAGE_SCHEMAS: Record<PageType, PropertyGroup[]>;
+export {};

package/dist/runtime/types/pages.js

@@ -0,0 +1,55 @@
+export const PAGE_SCHEMAS = {
+  Default: [],
+  Character: [
+    {
+      id: "identity",
+      label: "Identity",
+      fields: {
+        name: { label: "Name", type: "text" },
+        title: { label: "Social Title", type: "text" },
+        aliases: { label: "Aliases", type: "text-array" }
+      }
+    },
+    {
+      id: "characteristics",
+      label: "Characteristics",
+      fields: {
+        species: { label: "Species", type: "page", allowedPageTypes: ["Species"] },
+        sex: { label: "Sex", type: "enum", options: ["Male", "Female", "Other", "Unknown"] },
+        height: { label: "Height", type: "number" },
+        weight: { label: "Weight", type: "number" }
+      }
+    },
+    {
+      id: "timeline",
+      label: "Timeline",
+      fields: {
+        dateOfBirth: { label: "Date of Birth", type: "text" },
+        dateOfDeath: { label: "Date of Death", type: "text" },
+        placeOfDeath: {
+          label: "Place of Death",
+          type: "text",
+          visibleIf: (props) => !!props.dateOfDeath
+        }
+      }
+    },
+    {
+      id: "other",
+      label: "Other",
+      order: 3,
+      fields: {
+        flavourText: { label: "Flavour Text", type: "text" }
+      }
+    }
+  ],
+  Location: [],
+  Species: [],
+  Object: [],
+  Tale: [],
+  Item: [],
+  Skill: [],
+  Hero: [],
+  Card: [],
+  Series: [],
+  Episode: []
+};

package/dist/runtime/utils/page.d.ts

@@ -0,0 +1,7 @@
+import type { Page, PageType } from "../types/pages.js";
+export declare function createPage(type: PageType, slug?: string): Page;
+/**
+ * Ensures an existing page has all the blocks currently defined in its template.
+ * Matches based on SectionBlock titles.
+ */
+export declare function syncTemplateBlocks(page: Page): Page;

package/dist/runtime/utils/page.js

@@ -0,0 +1,33 @@
+import { PAGE_TEMPLATES } from "../types/pageTemplates.js";
+import { v7 as uuidv7 } from "uuid";
+export function createPage(type, slug = "new-page") {
+  const now = (/* @__PURE__ */ new Date()).toISOString();
+  const templateFn = PAGE_TEMPLATES[type];
+  const blocks = templateFn ? templateFn() : [];
+  return {
+    id: uuidv7(),
+    slug,
+    type,
+    tags: [],
+    properties: {},
+    blocks,
+    createdAt: now,
+    updatedAt: now
+  };
+}
+export function syncTemplateBlocks(page) {
+  const templateFn = PAGE_TEMPLATES[page.type];
+  if (!templateFn) return page;
+  const idealBlocks = templateFn();
+  const existingTitles = new Set(
+    page.blocks.filter((b) => b.type === "SectionBlock").map((b) => b.props.title)
+  );
+  const missingBlocks = idealBlocks.filter(
+    (b) => b.type === "SectionBlock" && !existingTitles.has(b.props.title)
+  );
+  if (missingBlocks.length > 0) {
+    page.blocks = [...page.blocks, ...missingBlocks];
+    page.updatedAt = (/* @__PURE__ */ new Date()).toISOString();
+  }
+  return page;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rimelight-components",
   "description": "A component library by Rimelight Entertainment.",
-  "version": "2.0.49",
+  "version": "2.0.50",
   "type": "module",
   "repository": {
     "type": "git",