@xleddyl/nuxt-cms 0.9.3 → 0.10.0

package/dist/runtime/shared/preview-links.js

@@ -0,0 +1,54 @@
+export const PREVIEW_QUERY_PARAM = "cms-preview";
+export const PREVIEW_HEADER = "x-cms-preview";
+export const PREVIEW_TOKEN_BYTES = 32;
+export const PREVIEW_RESPONSE_HEADERS = {
+  "cache-control": "private, no-store",
+  "x-robots-tag": "noindex, nofollow",
+  "referrer-policy": "same-origin"
+};
+const HOUR_MS = 36e5;
+export const PREVIEW_LINK_DURATIONS = [
+  { value: "1h", label: "1 hour", ms: HOUR_MS },
+  { value: "1d", label: "1 day", ms: 24 * HOUR_MS },
+  { value: "7d", label: "7 days", ms: 7 * 24 * HOUR_MS },
+  { value: "30d", label: "30 days", ms: 30 * 24 * HOUR_MS }
+];
+export const DEFAULT_PREVIEW_LINK_DURATION = "1d";
+const TOKEN_PATTERN = /^[A-Za-z0-9_-]{43}$/;
+export function isPreviewToken(value) {
+  return typeof value === "string" && TOKEN_PATTERN.test(value);
+}
+export function previewTokenFrom(value) {
+  const candidate = Array.isArray(value) ? value[0] : value;
+  return isPreviewToken(candidate) ? candidate : null;
+}
+export function hasPreviewQuery(path) {
+  const query = path.replace(/#.*$/s, "").split("?").slice(1).join("?");
+  return query.split("&").some((part) => part.split("=")[0] === PREVIEW_QUERY_PARAM);
+}
+export function isPreviewLinkDuration(value) {
+  return PREVIEW_LINK_DURATIONS.some((duration) => duration.value === value);
+}
+export function previewLinkExpiry(duration, now = /* @__PURE__ */ new Date()) {
+  const ms = PREVIEW_LINK_DURATIONS.find((option) => option.value === duration).ms;
+  return new Date(now.getTime() + ms).toISOString();
+}
+export function isPreviewLinkActive(link, now = /* @__PURE__ */ new Date()) {
+  if (link.revokedAt) return false;
+  const expires = Date.parse(link.expiresAt);
+  return Number.isFinite(expires) && expires > now.getTime();
+}
+export function previewGrantAllows(grant, entry, itemId) {
+  if (!grant || grant.entry !== entry) return false;
+  return itemId === void 0 || grant.itemId === itemId;
+}
+export function previewLinkUrl(path, token) {
+  const [base = "", hash] = path.split(/#(.*)/s);
+  const separator = base.includes("?") ? "&" : "?";
+  const url = `${base}${separator}${PREVIEW_QUERY_PARAM}=${token}`;
+  return hash === void 0 ? url : `${url}#${hash}`;
+}
+export function previewBannerErrors(banner) {
+  if (banner === void 0 || typeof banner === "boolean") return [];
+  return [`preview.banner must be a boolean, got ${JSON.stringify(banner)}`];
+}

package/dist/runtime/shared/preview.d.ts

@@ -1,4 +1,6 @@
-import type { BlockConfig, FieldConfig, MediaItem, MediaType } from './index.js';
+import type { BlockConfig, CmsLink, FieldConfig, MediaItem, MediaType } from './index.js';
+import type { CmsBlockPath } from './block-paths.js';
+export type CmsPreviewLinkResolver = (value: unknown) => CmsLink | null;
 export declare const CMS_PREVIEW_CHANNEL = "nuxt-cms:preview";
 export declare const DEFAULT_CMS_PREVIEW_PATH = "/cms/preview";
 export declare function previewPathErrors(path: string, entryNames: string[]): string[];
@@ -13,7 +15,11 @@ export interface CmsPreviewMedia {
     size: number | null;
     width: number | null;
     height: number | null;
+    focalX: number | null;
+    focalY: number | null;
 }
+export type CmsPreviewTheme = 'system' | 'light' | 'dark';
+export declare function readPreviewTheme(value: unknown): CmsPreviewTheme;
 export interface CmsPreviewState {
     entry: string;
     field: string;
@@ -21,65 +27,162 @@ export interface CmsPreviewState {
     blocks: CmsBlockValue[];
     item: Record<string, unknown> | null;
     media: Record<string, CmsPreviewMedia>;
-    selected: number | null;
+    selected: CmsBlockPath | null;
+    editable: boolean;
+    lockedFields: string[];
+    theme: CmsPreviewTheme;
 }
 export type CmsPreviewHostMessage = {
     type: 'render';
     state: CmsPreviewState;
+} | {
+    type: 'highlight';
+    path: CmsBlockPath | null;
+} | {
+    type: 'reveal';
+    path: CmsBlockPath;
 };
 export type CmsPreviewFrameMessage = {
     type: 'ready';
 } | {
     type: 'select';
-    index: number | null;
+    path: CmsBlockPath | null;
     focus?: boolean;
+} | {
+    type: 'hover';
+    path: CmsBlockPath | null;
 } | {
     type: 'insert';
-    index: number;
+    path: CmsBlockPath;
 } | {
     type: 'move';
-    from: number;
-    to: number;
+    from: CmsBlockPath;
+    to: CmsBlockPath;
     focus?: boolean;
 } | {
     type: 'duplicate';
-    index: number;
+    path: CmsBlockPath;
 } | {
     type: 'toggle-hidden';
-    index: number;
+    path: CmsBlockPath;
 } | {
     type: 'remove';
-    index: number;
+    path: CmsBlockPath;
+} | {
+    type: 'copy';
+    path: CmsBlockPath;
+} | {
+    type: 'cut';
+    path: CmsBlockPath;
+} | {
+    type: 'paste';
+    path: CmsBlockPath;
+    text?: string;
+} | {
+    type: 'focus-field';
+    path: CmsBlockPath | null;
+    key: string;
+} | {
+    type: 'field-input';
+    path: CmsBlockPath | null;
+    key: string;
+    locale: string;
+    value: string;
+    commit?: boolean;
+} | {
+    type: 'undo';
+} | {
+    type: 'redo';
+} | {
+    type: 'save';
 };
+export declare const CMS_CLIPBOARD_MAX_LENGTH = 2000000;
 export type CmsPreviewEnvelope<T> = T & {
     channel: typeof CMS_PREVIEW_CHANNEL;
 };
 export declare function previewEnvelope<T extends {
     type: string;
 }>(message: T): CmsPreviewEnvelope<T>;
+export declare function isFieldKey(value: unknown): value is string;
+export declare function readMessagePath(value: unknown): CmsBlockPath | null;
 export declare function parseFrameMessage(data: unknown): CmsPreviewFrameMessage | null;
 export declare function parseHostMessage(data: unknown): CmsPreviewHostMessage | null;
+export interface CmsFieldTarget {
+    path: CmsBlockPath | null;
+    key: string;
+}
+export declare function previewFieldConfig(target: CmsFieldTarget, blocksFields: Record<string, FieldConfig>, blocksValues: Record<string, unknown>, entryFields: Record<string, FieldConfig> | null | undefined, blocksKey: string): FieldConfig | undefined;
+export type CmsEditorShortcut = 'undo' | 'redo' | 'save' | 'remove' | 'duplicate' | 'move-up' | 'move-down' | 'insert-after' | 'insert-before' | 'deselect';
+export interface CmsShortcutKey {
+    key: string;
+    metaKey: boolean;
+    ctrlKey: boolean;
+    altKey: boolean;
+    shiftKey: boolean;
+}
+export interface CmsShortcutTarget {
+    editable: boolean;
+    interactive: boolean;
+    selected: boolean;
+}
+export declare function isApplePlatform(platform: string): boolean;
+export declare function editorShortcut(event: CmsShortcutKey, apple: boolean): CmsEditorShortcut | null;
+export declare function shortcutApplies(action: CmsEditorShortcut, target: CmsShortcutTarget): boolean;
+export type CmsClipboardAction = 'copy' | 'cut' | 'paste';
+export interface CmsClipboardTarget {
+    editable: boolean;
+    interactive: boolean;
+    textSelected: boolean;
+    selected: boolean;
+}
+export declare function clipboardActionApplies(action: CmsClipboardAction, target: CmsClipboardTarget): boolean;
 export declare function isTrustedPreviewEvent(event: {
     origin: string;
     source: unknown;
 }, origin: string, source: unknown): boolean;
 export declare function emptyBlock(type: string, block: BlockConfig): CmsBlockValue;
-export declare function insertBlock(list: readonly CmsBlockValue[], index: number, item: CmsBlockValue): CmsBlockValue[];
-export declare function moveBlock(list: readonly CmsBlockValue[], from: number, to: number): CmsBlockValue[];
-export declare function duplicateBlock(list: readonly CmsBlockValue[], index: number): CmsBlockValue[];
-export declare function removeBlock(list: readonly CmsBlockValue[], index: number): CmsBlockValue[];
+export declare function duplicateBlockAt(values: Record<string, unknown>, path: CmsBlockPath): Record<string, unknown>;
 export declare function canHideBlock(block: BlockConfig | undefined): boolean;
-export declare function toggleBlockHidden(list: readonly CmsBlockValue[], index: number, block: BlockConfig | undefined): CmsBlockValue[];
-export declare function selectionAfterMove(selected: number | null, from: number, to: number): number | null;
-export declare function selectionAfterRemove(selected: number | null, index: number): number | null;
-export declare function moveTargetForInsertion(from: number, insertAt: number): number;
-export declare function insertionIndex(blocks: readonly {
+export declare function toggleBlockHiddenAt(values: Record<string, unknown>, path: CmsBlockPath, block: BlockConfig | undefined): Record<string, unknown>;
+export declare function canMoveBlock(fields: Record<string, FieldConfig>, values: Record<string, unknown>, from: CmsBlockPath, toList: CmsBlockPath): boolean;
+export interface CmsDropBox {
     index: number;
     top: number;
     bottom: number;
-}[], y: number, total: number): number;
+    left: number;
+    right: number;
+}
+export declare function isHorizontalList(boxes: readonly CmsDropBox[]): boolean;
+export declare function insertionIndex(boxes: readonly CmsDropBox[], point: {
+    x: number;
+    y: number;
+}, total: number): number;
 export declare function collectMediaKeys(fields: Record<string, FieldConfig>, values: Record<string, unknown> | null | undefined): string[];
 export declare function previewMedia(key: string, item: MediaItem | undefined, baseUrl: string | null | undefined): CmsPreviewMedia;
-export declare function previewBlocks(field: FieldConfig, value: unknown, locale: string, defaultLocale: string, media: Record<string, CmsPreviewMedia>): CmsBlockValue[];
-export declare function previewItem(fields: Record<string, FieldConfig>, values: Record<string, unknown>, locale: string, defaultLocale: string, media: Record<string, CmsPreviewMedia>): Record<string, unknown>;
+export declare function previewBlocks(field: FieldConfig, value: unknown, locale: string, defaultLocale: string, media: Record<string, CmsPreviewMedia>, resolveLink?: CmsPreviewLinkResolver): CmsBlockValue[];
+export declare function previewItem(fields: Record<string, FieldConfig>, values: Record<string, unknown>, locale: string, defaultLocale: string, media: Record<string, CmsPreviewMedia>, resolveLink?: CmsPreviewLinkResolver): Record<string, unknown>;
 export declare function blockSummary(block: BlockConfig | undefined, item: CmsBlockValue, locale: string, defaultLocale: string, max?: number): string;
+export declare function blockErrorPaths(errors: Record<string, string | undefined | null>, fieldKey: string): Set<string>;
+export declare function firstBlockError(errors: Record<string, string | undefined | null>, fieldKey: string): {
+    path: CmsBlockPath;
+    key?: string;
+} | null;
+export declare function editorIssueKeys(fields: Record<string, FieldConfig>, values: Record<string, unknown>, path: readonly unknown[], fieldKey: string): string[];
+export interface CmsBlockTreeVisit {
+    path: CmsBlockPath;
+    item: CmsBlockValue;
+    block: BlockConfig | undefined;
+    field: FieldConfig;
+}
+export declare function blockTreeVisits(fields: Record<string, FieldConfig>, values: Record<string, unknown> | null | undefined, prefix?: CmsBlockPath): CmsBlockTreeVisit[];
+export interface CmsBlockIdSnapshot<T> {
+    items: Map<CmsBlockValue, T>;
+    lists: Map<string, {
+        items: CmsBlockValue[];
+        ids: T[];
+    }>;
+}
+export declare function stableBlockTreeIds<T>(visits: readonly CmsBlockTreeVisit[], previous: CmsBlockIdSnapshot<T> | null, createId: () => T): {
+    ids: Map<string, T>;
+    snapshot: CmsBlockIdSnapshot<T>;
+};