rimelight-components 2.0.99 → 2.1.2

package/dist/runtime/composables/usePageEditor.js

@@ -27,9 +27,13 @@ export function usePageEditor(page, maxHistorySize = 100) {
   const save = () => {
     return JSON.parse(JSON.stringify(page.value));
   };
-  watch(() => page.value.properties, () => {
-    captureSnapshot();
-  }, { deep: true });
+  watch(
+    () => page.value.properties,
+    () => {
+      captureSnapshot();
+    },
+    { deep: true }
+  );
   return {
     undo,
     redo,

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

@@ -0,0 +1,33 @@
+import { type PageType, type PageDefinition } from "../types/index.js";
+export declare const usePageRegistry: () => {
+    registerDefinitions: (definitions: Record<string, PageDefinition>) => void;
+    getTypeLabelKey: (type: PageType) => string;
+    definitions: {
+        readonly Default?: {
+            readonly typeLabelKey: string;
+            readonly properties: {
+                readonly [x: string]: {
+                    readonly label: {
+                        readonly [x: string]: string;
+                    };
+                    readonly order?: number | undefined;
+                    readonly fields: {
+                        readonly [x: string]: {
+                            readonly value: any;
+                            readonly label: {
+                                readonly [x: string]: string;
+                            };
+                            readonly type: "number" | "text" | "text-array" | "enum" | "page" | "page-array";
+                            readonly options?: readonly string[] | undefined;
+                            readonly allowedPageTypes?: readonly "Default"[] | undefined;
+                            readonly order?: number | undefined;
+                            readonly visibleIf?: ((properties: any) => boolean) | undefined;
+                        };
+                    };
+                    readonly defaultOpen: boolean;
+                };
+            };
+            readonly initialBlocks?: (() => import("../types/index.js").Block[]) | undefined;
+        } | undefined;
+    };
+};

package/dist/runtime/composables/usePageRegistry.js

@@ -0,0 +1,16 @@
+import { reactive, readonly } from "vue";
+const PAGE_DEFINITIONS = reactive({});
+export const usePageRegistry = () => {
+  const registerDefinitions = (definitions) => {
+    Object.assign(PAGE_DEFINITIONS, definitions);
+  };
+  const getTypeLabelKey = (type) => {
+    const definition = PAGE_DEFINITIONS[type];
+    return definition?.typeLabelKey ?? `page.type.${type.toLowerCase()}`;
+  };
+  return {
+    registerDefinitions,
+    getTypeLabelKey,
+    definitions: readonly(PAGE_DEFINITIONS)
+  };
+};

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

@@ -139,9 +139,7 @@ export interface InlineLink extends BaseInlineContent {
 export interface InlineMention extends BaseInlineContent {
     type: "mention";
     props: {
-        href: string;
-        target?: "_blank" | "_self";
-        content: string;
+        pageId: string;
     };
 }
 /**

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

@@ -1,12 +1,15 @@
-import { type Image } from "../types/index.js";
-import { type Block } from "../types/index.js";
+import { type Block, type Image, type Link } from "../types/index.js";
+export type Localized<T = string> = Record<string, T>;
 declare global {
     interface RimelightRegisterPageTypes {
     }
 }
+export interface RegisterPageTypes extends RimelightRegisterPageTypes {
+    Default: BasePageProperties;
+}
 export type PageType = keyof RegisterPageTypes;
 export interface Property<T = any> {
-    value: T extends never[] ? Localized[] : T;
+    value: T | string | string[] | number | Localized | Localized[];
     label: Localized<string>;
     type: "number" | "text" | "text-array" | "enum" | "page" | "page-array";
     options?: string[];
@@ -14,7 +17,6 @@ export interface Property<T = any> {
     order?: number;
     visibleIf?: (properties: any) => boolean;
 }
-export type Localized<T = string> = Record<string, T>;
 export interface PropertyGroup {
     label: Localized<string>;
     order?: number;
@@ -25,24 +27,25 @@ export interface PropertyGroup {
  * A PageTemplate is the single definition for a page's properties and initial blocks.
  */
 export interface PageDefinition {
+    typeLabelKey: string;
     properties: Record<string, PropertyGroup>;
     initialBlocks?: () => Block[];
 }
 export interface BasePageProperties {
 }
-export interface RegisterPageTypes extends RimelightRegisterPageTypes {
-    Default: BasePageProperties;
-}
 /**
  * Common fields shared by every page regardless of type.
  */
 export interface BasePage {
     id: string;
     slug: string;
-    image?: Image;
+    icon?: Image;
+    banner?: Image;
+    images?: Image[];
     title: Localized<string>;
     description?: Localized<string>;
     tags?: Localized<string>[];
+    links?: Link[];
     authorsIds?: string[];
     blocks: Block[];
     posted_at?: Date | null;
@@ -58,3 +61,8 @@ export type Page = {
         properties: RegisterPageTypes[K];
     } & BasePage;
 }[PageType];
+export type SurroundItem = Pick<BasePage, "id" | "slug" | "title" | "description">;
+export interface PageSurround {
+    previous: SurroundItem | null;
+    next: SurroundItem | null;
+}

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

@@ -1,4 +1,9 @@
 import { z } from "zod";
+import { type Localized } from "./index.js";
+/**
+ * Helper to create a Zod schema for the Localized<T> type
+ */
+export declare const LocalizedSchema: <T extends z.ZodTypeAny>(schema: T) => z.ZodType<Localized<z.infer<T>>>;
 export declare const linkVariantEnum: z.ZodEnum<{
     link: "link";
     solid: "solid";
@@ -21,6 +26,7 @@ export declare const ImageSchema: z.ZodObject<{
     alt: z.ZodString;
     width: z.ZodOptional<z.ZodNumber>;
     height: z.ZodOptional<z.ZodNumber>;
+    name: z.ZodOptional<z.ZodType<Localized<string>, unknown, z.core.$ZodTypeInternals<Localized<string>, unknown>>>;
 }, z.core.$strip>;
 export type Image = z.infer<typeof ImageSchema>;
 export declare const LinkSchema: z.ZodObject<{

package/dist/runtime/types/schemas.js

@@ -1,4 +1,5 @@
 import { z } from "zod";
+export const LocalizedSchema = (schema) => z.record(z.string(), schema);
 export const linkVariantEnum = z.enum(["solid", "outline", "subtle", "soft", "ghost", "link"]);
 export const linkColorEnum = z.enum([
   "primary",
@@ -13,7 +14,8 @@ export const ImageSchema = z.object({
   src: z.string().min(1, "Image source must be provided."),
   alt: z.string().min(1, "Image alt text must be provided."),
   width: z.number().int().positive().optional(),
-  height: z.number().int().positive().optional()
+  height: z.number().int().positive().optional(),
+  name: LocalizedSchema(z.string()).optional()
 });
 export const LinkSchema = z.object({
   label: z.string().min(1, "Link label must be provided."),

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

@@ -1,4 +1,4 @@
-import { type MaybeRefOrGetter } from 'vue';
+import { type MaybeRefOrGetter } from "vue";
 import { type Page, type Localized, type PageDefinition, type Property } from "../types/index.js";
 export declare const getLocalizedContent: <T = string>(field: Localized<T> | undefined, currentLocale: MaybeRefOrGetter<string>) => T | string;
 type WidenProperty<T> = T extends string ? string : T extends number ? number : T extends never[] ? Localized[] : T extends object ? {
@@ -9,12 +9,12 @@ type WidenProperty<T> = T extends string ? string : T extends number ? number :
  * This is used by consuming apps to define their custom page types.
  */
 export declare function definePageDefinition<T extends PageDefinition>(def: T): {
-    [K in keyof T]: K extends 'properties' ? {
-        [G in keyof T['properties']]: {
+    [K in keyof T]: K extends "properties" ? {
+        [G in keyof T["properties"]]: {
             label: Localized<string>;
             defaultOpen: boolean;
             fields: {
-                [F in keyof T['properties'][G]['fields']]: Property<WidenProperty<T['properties'][G]['fields'][F]['value']>>;
+                [F in keyof T["properties"][G]["fields"]]: Property<WidenProperty<T["properties"][G]["fields"][F]["value"]>>;
             };
         };
     } : T[K];

package/dist/runtime/utils/richTextHelpers.js

@@ -1,6 +1,14 @@
 import { v7 as uuidv7 } from "uuid";
 export function richTextToHtml(content) {
-  return content.map((item) => item.props.content).join("");
+  return content.map((item) => {
+    if (item.type === "text" || item.type === "link") {
+      return item.props.content;
+    }
+    if (item.type === "mention") {
+      return "";
+    }
+    return "";
+  }).join("");
 }
 export function parseHtmlToRichText(html) {
   if (html.trim().length === 0) {

package/package.json

@@ -1,20 +1,21 @@
 {
   "name": "rimelight-components",
+  "version": "2.1.2",
   "description": "A component library by Rimelight Entertainment.",
-  "version": "2.0.99",
-  "type": "module",
+  "keywords": [
+    "nuxt",
+    "rimelight",
+    "typescript",
+    "vue"
+  ],
+  "homepage": "https://rimelight.com/tools/rimelight-components",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Rimelight-Entertainment/rimelight-components.git"
   },
-  "homepage": "https://rimelight.com/tools/rimelight-components",
   "license": "MIT",
-  "keywords": [
-    "rimelight",
-    "typescript",
-    "vue",
-    "nuxt"
-  ],
+  "type": "module",
+  "main": "./dist/module.mjs",
   "imports": {
     "#build/rimelight-components/*": "./.nuxt/rimelight-components/*.ts",
     "#build/rimelight-components.css": "./.nuxt/rimelight-components.css"
@@ -22,12 +23,12 @@
   "exports": {
     ".": {
       "types": "./dist/module.d.mts",
-      "style": "./dist/runtime/index.css",
-      "import": "./dist/module.mjs"
+      "import": "./dist/module.mjs",
+      "style": "./dist/runtime/index.css"
     },
-    "./runtime/*": "./dist/runtime/*",
     "./components/*": "./dist/runtime/components/*",
     "./composables/*": "./dist/runtime/composables/*",
+    "./runtime/*": "./dist/runtime/*",
     "./utils/*": {
       "types": "./dist/runtime/utils/*.d.mts",
       "import": "./dist/runtime/utils/*.js"
@@ -59,7 +60,6 @@
     }
   },
   "style": "./dist/runtime/index.css",
-  "main": "./dist/module.mjs",
   "files": [
     "dist"
   ],
@@ -79,6 +79,9 @@
     "test": "vitest",
     "release": "release-it --ci"
   },
+  "resolutions": {
+    "rimelight-components": "workspace:*"
+  },
   "dependencies": {
     "@nuxt/kit": "^4.2.2",
     "@vueuse/core": "^14.1.0",
@@ -123,8 +126,5 @@
     "esbuild",
     "sharp",
     "vue-demi"
-  ],
-  "resolutions": {
-    "rimelight-components": "workspace:*"
-  }
+  ]
 }

package/dist/runtime/components/blocks/TOC.vue

@@ -1,95 +0,0 @@
-<script setup>
-import { computed } from "vue";
-import {} from "../../types";
-import { slugify } from "../../utils";
-import { useI18n } from "vue-i18n";
-const { t } = useI18n();
-const {
-  pageBlocks,
-  title = "table_of_contents",
-  levels = [2, 3, 4]
-} = defineProps({
-  pageBlocks: { type: [Array, null], required: true },
-  title: { type: String, required: false },
-  levels: { type: Array, required: false }
-});
-const extractHeadings = (blocks) => {
-  const headings = [];
-  if (!blocks || blocks.length === 0) {
-    return headings;
-  }
-  for (const block of blocks) {
-    if (block.type === "SectionBlock") {
-      const props = block.props;
-      const title2 = props.title;
-      const level = props.level;
-      if (title2 && level) {
-        headings.push({
-          id: slugify(title2),
-          title: title2,
-          level
-        });
-      }
-      if (props.children && props.children.length > 0) {
-        headings.push(...extractHeadings(props.children));
-      }
-    }
-  }
-  return headings;
-};
-const tocItems = computed(() => {
-  if (!pageBlocks || pageBlocks.length === 0) {
-    return [];
-  }
-  if (levels.length === 0) {
-    return [];
-  }
-  const allHeadings = extractHeadings(pageBlocks);
-  const filteredHeadings = allHeadings.filter(
-    (item) => levels.includes(item.level)
-  );
-  return Array.from(new Set(filteredHeadings.map((h) => h.id))).map(
-    (id) => filteredHeadings.find((h) => h.id === id)
-  );
-});
-</script>
-
-<template>
-    <nav
-      class="flex flex-col gap-md pt-lg"
-      aria-label="Table of Contents"
-    >
-      <h5 class="text-highlighted">
-        {{ t(title) }}
-      </h5>
-
-      <ul
-        v-if="tocItems.length > 0"
-        class="flex flex-col gap-0 border-s border-default"
-      >
-        <li
-          v-for="item in tocItems"
-          :key="item.id"
-          class="relative flex min-w-0"
-          :class="{
-  'ms-2': item.level === 2,
-  'ms-4': item.level === 3,
-  'ms-6': item.level === 4,
-  'ms-8': item.level === 5,
-  'ms-10': item.level === 6
-}"
-        >
-          <NuxtLink
-            :href="`#${item.id}`"
-            class="group relative flex size-full items-center px-1.5 py-1.5 text-start text-sm font-medium before:absolute before:inset-x-0 before:inset-y-px before:z-[-1] before:rounded-md focus:outline-none focus-visible:outline-none focus-visible:before:ring-2 focus-visible:before:ring-inset dark:focus-visible:outline-none"
-          >
-            <span class="truncate">
-              {{ item.title }}
-            </span>
-          </NuxtLink>
-        </li>
-      </ul>
-
-      <slot name="bottom" />
-    </nav>
-</template>

package/dist/runtime/components/nodes/MentionNode.d.vue.ts

@@ -1,8 +0,0 @@
-type __VLS_Props = {
-    href: string;
-    target?: string;
-    content: string;
-};
-declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
-declare const _default: typeof __VLS_export;
-export default _default;

package/dist/runtime/components/nodes/MentionNode.vue

@@ -1,22 +0,0 @@
-<script setup>
-import { computed } from "vue";
-const { href, target, content } = defineProps({
-  href: { type: String, required: true },
-  target: { type: String, required: false },
-  content: { type: String, required: true }
-});
-const rel = computed(
-  () => target === "_blank" ? "noopener noreferrer" : void 0
-);
-</script>
-
-<template>
-  <ULink
-    :to="href"
-    :target="target"
-    :rel="rel"
-    class="rounded-md bg-secondary-700 px-1.5 py-0.5 text-secondary-300"
-  >
-    {{ content }}
-  </ULink>
-</template>

package/dist/runtime/components/nodes/MentionNode.vue.d.ts

@@ -1,8 +0,0 @@
-type __VLS_Props = {
-    href: string;
-    target?: string;
-    content: string;
-};
-declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
-declare const _default: typeof __VLS_export;
-export default _default;