rimelight-components 2.0.60 → 2.0.63

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

@@ -1,5 +1,5 @@
 import { type Ref } from "vue";
-import type { Page } from "../types/pages.js";
+import type { Page } from "../types/pages";
 export declare function usePageEditor(page: Ref<Page>, maxHistorySize?: number): {
     undo: () => void;
     redo: () => void;

package/dist/runtime/types/app.config.d.ts

@@ -1,6 +1,14 @@
 declare module '#build/app.config' {
   import type { AppConfig } from '@nuxt/schema'
 
-  const _default: AppConfig
+  interface RimelightComponentsConfig {
+    [key: string]: any
+  }
+
+  interface CustomAppConfig extends AppConfig {
+    rimelightComponents?: RimelightComponentsConfig
+  }
+
+  const _default: CustomAppConfig
   export default _default
-}
+}

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

@@ -1,4 +1,3 @@
-export * from "./blocks.js";
-export * from "./pages.js";
-export * from "./pageTemplates.js";
-export * from "./schemas.js";
+export * from "./blocks";
+export * from "./pages";
+export * from "./schemas";

package/dist/runtime/types/index.js

@@ -1,4 +1,3 @@
 export * from "./blocks.js";
 export * from "./pages.js";
-export * from "./pageTemplates.js";
 export * from "./schemas.js";

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

@@ -1,7 +1,12 @@
-import { type Image } from "../types/schemas.js";
-import { type Block } from "./blocks.js";
-export type PageType = "Default" | "Document" | "BlogPost" | "PatchNote" | "Location" | "Species" | "Character" | "Object" | "Tale" | "Item" | "Skill" | "Hero" | "Card" | "Series" | "Episode";
-export interface Property {
+import { type Image } from "../types";
+import { type Block } from "../types";
+declare global {
+    interface RimelightRegisterPageTypes {
+    }
+}
+export type PageType = keyof RegisterPageTypes;
+export interface Property<T = any> {
+    value: T;
     label: string;
     type: "number" | "text" | "text-array" | "enum" | "page" | "page-array";
     options?: string[];
@@ -9,70 +14,33 @@ export interface Property {
     order?: number;
     visibleIf?: (properties: any) => boolean;
 }
+export type Localized<T = string> = Record<string, T>;
 export interface PropertyGroup {
-    id: string;
-    label: string;
+    label: Localized<string>;
     order?: number;
     fields: Record<string, Property>;
 }
-export interface BasePageProperties {
-}
-export interface DocumentProperties extends BasePageProperties {
-}
-export interface BlogPostProperties extends BasePageProperties {
-}
-export interface PatchNoteProperties extends 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;
+/**
+ * A PageTemplate is the single definition for a page's properties and initial blocks.
+ */
+export interface PageDefinition {
+    properties: Record<string, PropertyGroup>;
+    initialBlocks?: () => Block[];
 }
-export interface SeriesProperties extends BasePageProperties {
+/**
+ * Helper to define a page with full type safety and literal preservation.
+ * This is used by consuming apps to define their custom page types.
+ */
+export declare function definePageDefinition<T extends PageDefinition>(def: T): T;
+export interface BasePageProperties {
 }
-export interface EpisodeProperties extends BasePageProperties {
+export interface RegisterPageTypes extends RimelightRegisterPageTypes {
+    Default: BasePageProperties;
 }
-export type Localized<T = string> = Record<string, T>;
 /**
  * Common fields shared by every page regardless of type.
  */
-interface BasePage {
+export interface BasePage {
     id: string;
     slug: string;
     image?: Image;
@@ -89,54 +57,8 @@ interface BasePage {
  * Discriminated Union for Page Data structure
  */
 export type Page = {
-    type: "Default";
-    properties: BasePageProperties;
-} & BasePage | {
-    type: "Document";
-    properties: DocumentProperties;
-} & BasePage | {
-    type: "BlogPost";
-    properties: BlogPostProperties;
-} & BasePage | {
-    type: "PatchNote";
-    properties: PatchNoteProperties;
-} & 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 {};
+    [K in PageType]: {
+        type: K;
+        properties: RegisterPageTypes[K];
+    } & BasePage;
+}[PageType];

package/dist/runtime/types/pages.js

@@ -1,58 +1,3 @@
-export const PAGE_SCHEMAS = {
-  Default: [],
-  Document: [],
-  BlogPost: [],
-  PatchNote: [],
-  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: []
-};
+export function definePageDefinition(def) {
+  return def;
+}

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

@@ -1,10 +1,4 @@
 import { z } from "zod";
-export declare const id: import("drizzle-orm").NotNull<import("drizzle-orm").HasDefault<import("drizzle-orm/pg-core").PgUUIDBuilderInitial<"id">>>;
-export declare const timestamps: {
-    updated_at: import("drizzle-orm").HasDefault<import("drizzle-orm/pg-core").PgTimestampBuilderInitial<"updated_at">>;
-    created_at: import("drizzle-orm").NotNull<import("drizzle-orm").HasDefault<import("drizzle-orm/pg-core").PgTimestampBuilderInitial<"created_at">>>;
-    deleted_at: import("drizzle-orm/pg-core").PgTimestampBuilderInitial<"deleted_at">;
-};
 export declare const linkVariantEnum: z.ZodEnum<{
     link: "link";
     solid: "solid";

package/dist/runtime/types/schemas.js

@@ -1,14 +1,4 @@
-import { uuid, timestamp } from "drizzle-orm/pg-core";
 import { z } from "zod";
-import { sql } from "drizzle-orm";
-export const id = uuid("id").default(sql`uuidv7()`).notNull();
-export const timestamps = {
-  updated_at: timestamp("updated_at", {
-    withTimezone: true
-  }).$onUpdate(() => /* @__PURE__ */ new Date()),
-  created_at: timestamp("created_at", { withTimezone: true }).defaultNow().notNull(),
-  deleted_at: timestamp("deleted_at", { withTimezone: true })
-};
 export const linkVariantEnum = z.enum(["solid", "outline", "subtle", "soft", "ghost", "link"]);
 export const linkColorEnum = z.enum([
   "primary",

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

@@ -1,5 +1,5 @@
 import { type Component } from "vue";
-import { type BlockType } from "../types/blocks.js";
+import { type BlockType } from "../types";
 /**
  * Maps the block type string from the database to a dynamically imported Vue component.
  *

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

@@ -0,0 +1,6 @@
+export declare const id: import("drizzle-orm").NotNull<import("drizzle-orm").HasDefault<import("drizzle-orm/pg-core").PgUUIDBuilderInitial<"id">>>;
+export declare const timestamps: {
+    updated_at: import("drizzle-orm").HasDefault<import("drizzle-orm/pg-core").PgTimestampBuilderInitial<"updated_at">>;
+    created_at: import("drizzle-orm").NotNull<import("drizzle-orm").HasDefault<import("drizzle-orm/pg-core").PgTimestampBuilderInitial<"created_at">>>;
+    deleted_at: import("drizzle-orm/pg-core").PgTimestampBuilderInitial<"deleted_at">;
+};

package/dist/runtime/utils/database.js

@@ -0,0 +1,10 @@
+import { uuid, timestamp } from "drizzle-orm/pg-core";
+import { sql } from "drizzle-orm";
+export const id = uuid("id").default(sql`uuidv7()`).notNull();
+export const timestamps = {
+  updated_at: timestamp("updated_at", {
+    withTimezone: true
+  }).$onUpdate(() => /* @__PURE__ */ new Date()),
+  created_at: timestamp("created_at", { withTimezone: true }).defaultNow().notNull(),
+  deleted_at: timestamp("deleted_at", { withTimezone: true })
+};

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

@@ -1,6 +1,7 @@
-export * from "./richTextHelpers.js";
-export * from "./blockMapper.js";
-export * from "./page.js";
+export * from "./richTextHelpers";
+export * from "./blockMapper";
+export * from "./page";
+export * from "./database";
 /**
  * Converts a string into a URL-friendly slug.
  * - Converts to lowercase.

package/dist/runtime/utils/index.js

@@ -1,6 +1,7 @@
 export * from "./richTextHelpers.js";
 export * from "./blockMapper.js";
 export * from "./page.js";
+export * from "./database.js";
 export function slugify(text) {
   if (!text) {
     return "";

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

@@ -1,7 +1,10 @@
-import type { Page, Localized } from "../types/pages.js";
+import type { Page, Localized, PageDefinition } from "../types/pages";
 export declare const getLocalizedContent: (field: Localized | undefined, currentLocale: string) => string;
 /**
- * Ensures an existing page has all the blocks currently defined in its template.
- * Matches based on SectionBlock titles.
+ * Ensures a page strictly adheres to its PageDefinition.
+ * - Adds missing properties and groups in the correct order.
+ * - Removes properties and groups no longer in the definition.
+ * - Adds missing templated blocks in the correct relative position.
+ * - Removes templated blocks no longer in the definition.
  */
-export declare function syncTemplateBlocks(page: Page): Page;
+export declare function syncPageWithDefinition(page: Page, definition?: PageDefinition): Page;

package/dist/runtime/utils/page.js

@@ -1,20 +1,71 @@
-import { PAGE_TEMPLATES } from "../types/pageTemplates.js";
 export const getLocalizedContent = (field, currentLocale) => {
   if (!field) return "";
   return field[currentLocale] || field["en"] || "";
 };
-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];
+export function syncPageWithDefinition(page, definition) {
+  if (!definition) return page;
+  let hasChanged = false;
+  const updatedProperties = {};
+  const definitionGroups = definition.properties;
+  for (const [groupId, definitionGroup] of Object.entries(definitionGroups)) {
+    const existingGroup = page.properties[groupId];
+    const updatedGroupFields = {};
+    for (const [fieldId, definitionField] of Object.entries(definitionGroup.fields)) {
+      if (existingGroup?.fields[fieldId]) {
+        updatedGroupFields[fieldId] = {
+          ...definitionField,
+          value: existingGroup.fields[fieldId].value
+        };
+      } else {
+        updatedGroupFields[fieldId] = { ...definitionField };
+        hasChanged = true;
+      }
+    }
+    updatedProperties[groupId] = {
+      ...definitionGroup,
+      fields: updatedGroupFields
+    };
+    if (!existingGroup) {
+      hasChanged = true;
+    }
+  }
+  if (Object.keys(page.properties).length !== Object.keys(updatedProperties).length) {
+    hasChanged = true;
+  } else {
+    for (const groupId in updatedProperties) {
+      const pageGroup = page.properties[groupId];
+      if (Object.keys(pageGroup?.fields || {}).length !== Object.keys(updatedProperties[groupId].fields).length) {
+        hasChanged = true;
+        break;
+      }
+    }
+  }
+  page.properties = updatedProperties;
+  if (definition.initialBlocks) {
+    const idealBlocks = definition.initialBlocks();
+    const currentBlocks = [...page.blocks];
+    const idealBlocksMap = new Map(idealBlocks.map((b) => [b.id, b]));
+    const filteredCurrent = currentBlocks.filter((b) => {
+      if (!b.isTemplated) return true;
+      return idealBlocksMap.has(b.id);
+    });
+    if (filteredCurrent.length !== currentBlocks.length) {
+      hasChanged = true;
+    }
+    let lastExistingIdealIndex = -1;
+    for (const idealBlock of idealBlocks) {
+      const existingIndex = filteredCurrent.findIndex((b) => b.id === idealBlock.id);
+      if (existingIndex !== -1) {
+        lastExistingIdealIndex = existingIndex;
+      } else {
+        filteredCurrent.splice(lastExistingIdealIndex + 1, 0, { ...idealBlock });
+        lastExistingIdealIndex++;
+        hasChanged = true;
+      }
+    }
+    page.blocks = filteredCurrent;
+  }
+  if (hasChanged) {
     page.updatedAt = (/* @__PURE__ */ new Date()).toISOString();
   }
   return page;

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

@@ -1,4 +1,4 @@
-import type { RichTextContent } from "../types/blocks.js";
+import type { RichTextContent } from "../types/blocks";
 /**
  * Helper: Converts RichTextContent array into a plain string for a simple contenteditable area.
  * For complex editors, this would generate full HTML/DOM nodes, preserving links/mentions.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rimelight-components",
   "description": "A component library by Rimelight Entertainment.",
-  "version": "2.0.60",
+  "version": "2.0.63",
   "type": "module",
   "repository": {
     "type": "git",
@@ -22,50 +22,55 @@
   "exports": {
     ".": {
       "types": "./dist/module.d.mts",
-      "import": "./dist/module.mjs",
-      "require": "./dist/module.mjs"
-    },
-    "./types": {
-      "types": "./dist/runtime/types/index.d.ts",
-      "import": "./dist/runtime/types/index.js",
-      "require": "./dist/runtime/types/index.js"
+      "style": "./dist/runtime/index.css",
+      "import": "./dist/module.mjs"
     },
     "./runtime/*": "./dist/runtime/*",
     "./components/*": "./dist/runtime/components/*",
-    "./composables/*": "./dist/runtime/composables/*",
+    "./composables": {
+      "types": "./dist/runtime/composables/index.d.mts",
+      "import": "./dist/runtime/composables/index.mjs"
+    },
+    "./composables/*": {
+      "types": "./dist/runtime/composables/*.d.mts",
+      "import": "./dist/runtime/composables/*.mjs"
+    },
+    "./utils": {
+      "types": "./dist/runtime/utils/index.d.mts",
+      "import": "./dist/runtime/utils/index.mjs"
+    },
     "./utils/*": {
       "types": "./dist/runtime/utils/*.d.mts",
-      "import": "./dist/runtime/utils/*.js"
+      "import": "./dist/runtime/utils/*.mjs"
     }
   },
-  "main": "./dist/module.mjs",
-  "types": "./dist/module.d.mts",
-  "style": "./dist/runtime/index.css",
   "typesVersions": {
     "*": {
       ".": [
         "./dist/module.d.mts"
       ],
-      "vite": [
-        "./dist/vite.d.mts"
-      ],
-      "./runtime/*": [
-        "./dist/runtime/index.d.ts"
+      "runtime/*": [
+        "./dist/runtime/*"
       ],
       "components/*": [
         "./dist/runtime/components/*"
       ],
+      "composables": [
+        "./dist/runtime/composables/index.d.mts"
+      ],
       "composables/*": [
-        "./dist/runtime/composables/*"
+        "./dist/runtime/composables/*.d.mts"
       ],
       "utils": [
-        "./dist/runtime/utils/index.d.ts"
+        "./dist/runtime/utils/index.d.mts"
       ],
       "utils/*": [
-        "./dist/runtime/utils/*.d.ts"
+        "./dist/runtime/utils/*.d.mts"
       ]
     }
   },
+  "style": "./dist/runtime/index.css",
+  "main": "./dist/module.mjs",
   "files": [
     "dist"
   ],
@@ -78,8 +83,10 @@
     "typecheck": "vue-tsc --noEmit && nuxt typecheck",
     "lint": "oxlint .",
     "lint:fix": "oxlint . --fix",
-    "format": "prettier . --check .",
-    "format:fix": "prettier . --write .",
+    "format": "oxfmt --check",
+    "format:fix": "oxfmt .",
+    "check": "bun run typecheck && bun run lint && bun run format",
+    "fix": "bun run lint:fix && bun run format:fix",
     "test": "vitest",
     "release": "release-it --ci"
   },

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

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