@cmssy/core 9.10.0 → 10.1.0

package/dist/csp-Blh6P15m.d.ts

@@ -0,0 +1,189 @@
+import { CmssyClientConfig, BlockRect, BlockSchema, BlockMeta } from '@cmssy/types';
+import { G as GraphqlRequestOptions } from './locale-XintNd0n.js';
+
+declare const DEFAULT_CMSSY_EDITOR_ORIGINS: string[];
+declare function isDevelopment(): boolean;
+declare function resolveEditorOrigin(editorOrigin: string | string[] | undefined): string | string[];
+interface CmssyConfig {
+    /**
+     * Full GraphQL delivery endpoint. Defaults to the cmssy cloud endpoint
+     * (`https://api.cmssy.io/graphql`); set it only for self-hosted / staging.
+     */
+    apiUrl?: string;
+    /** Organization slug - part of the org-scoped delivery path. */
+    org: string;
+    workspaceSlug: string;
+    draftSecret: string;
+    /**
+     * A cmssy API token (`cs_…`) that opts this app into the editor-controlled dev
+     * preview. In development only, the SDK sends it on every page fetch so the
+     * backend can resolve the token's user and honour that user's dev-preview flag
+     * (toggled from the editor's dev-mode switch): flag on + a saved dev draft ⇒
+     * the draft overlay renders, otherwise published content. Server-only (never
+     * reaches the client); ignored outside development. See the Quickstart
+     * "Dev preview" section.
+     */
+    devToken?: string;
+    /**
+     * Origin allowed to frame your app in the editor. Defaults to
+     * {@link DEFAULT_CMSSY_EDITOR_ORIGINS}; set it only for self-hosted admins.
+     */
+    editorOrigin?: string | string[];
+    /**
+     * Canonical absolute site URL (e.g. https://cmssy.com), used by
+     * createCmssyRobots / createCmssySitemap. When omitted the helpers derive the
+     * origin from the request `host` header at render time (multi-domain safe).
+     */
+    siteUrl?: string;
+    /**
+     * Fallback locale resolver for a site whose URLs carry no language (e.g. a
+     * cookie or Accept-Language strategy). The workspace site config remains the
+     * source of truth for the default and enabled languages.
+     */
+    resolveLocale?: () => string | Promise<string>;
+}
+/**
+ * Env-shaped input for {@link defineCmssyConfig}: the required string fields are
+ * widened to `string | undefined` so a config can pass `process.env.*` straight
+ * through without a `?? ""` fallback (which would mask a missing value as an
+ * empty string) or a cast.
+ */
+type CmssyEnvConfig = Omit<CmssyConfig, "org" | "workspaceSlug" | "draftSecret"> & {
+    org?: string;
+    workspaceSlug?: string;
+    draftSecret?: string;
+};
+/**
+ * Validates an env-sourced config and returns a strictly-typed
+ * {@link CmssyConfig}. Pass raw `process.env.*` values; this throws a clear,
+ * actionable error listing any missing required variables (rendered by the
+ * Next.js error overlay / boundary), so the app fails fast instead of running
+ * with silently-empty config.
+ */
+declare function defineCmssyConfig(config: CmssyEnvConfig): CmssyConfig;
+
+interface QueryScopedOptions extends GraphqlRequestOptions {
+    workspaceId?: string;
+}
+interface CmssyClient {
+    readonly config: CmssyClientConfig;
+    query<T = unknown>(document: string, variables?: Record<string, unknown>, options?: GraphqlRequestOptions): Promise<T>;
+    queryScoped<T = unknown>(document: string, variables?: Record<string, unknown>, options?: QueryScopedOptions): Promise<T>;
+    resolveWorkspaceId(options?: GraphqlRequestOptions): Promise<string>;
+}
+declare function createCmssyClient(input: CmssyClientConfig): CmssyClient;
+
+declare const PROTOCOL_VERSION = 2;
+
+interface ReadyMessage {
+    type: "cmssy:ready";
+    protocolVersion: number;
+    blocks: Array<{
+        id: string;
+        type: string;
+        bounds: BlockRect;
+        layoutPosition?: string;
+    }>;
+    schemas: Record<string, BlockSchema>;
+    blockMeta?: Record<string, BlockMeta>;
+}
+interface BoundsMessage {
+    type: "cmssy:bounds";
+    blockId: string;
+    rect: BlockRect;
+}
+interface ClickMessage {
+    type: "cmssy:click";
+    blockId: string;
+    rect: BlockRect;
+    layoutPosition?: string;
+}
+interface DeselectMessage {
+    type: "cmssy:deselect";
+}
+interface MoveMessage {
+    type: "cmssy:move";
+    protocolVersion: number;
+    blockId: string;
+    index: number;
+}
+interface DragIndexMessage {
+    type: "cmssy:drag-index";
+    protocolVersion: number;
+    index: number;
+}
+type AppToEditorMessage = ReadyMessage | BoundsMessage | ClickMessage | DeselectMessage | MoveMessage | DragIndexMessage;
+interface SelectMessage {
+    type: "cmssy:select";
+    protocolVersion: number;
+    blockId: string;
+}
+interface PatchMessage {
+    type: "cmssy:patch";
+    protocolVersion: number;
+    blockId: string;
+    content: Record<string, unknown>;
+    style?: Record<string, unknown>;
+    advanced?: Record<string, unknown>;
+    layoutPosition?: string;
+}
+interface ParentReadyMessage {
+    type: "cmssy:parent-ready";
+    protocolVersion: number;
+}
+interface InsertMessage {
+    type: "cmssy:insert";
+    protocolVersion: number;
+    blockId: string;
+    blockType: string;
+    content: Record<string, unknown>;
+    style?: Record<string, unknown>;
+    advanced?: Record<string, unknown>;
+    index: number;
+}
+interface ReorderMessage {
+    type: "cmssy:reorder";
+    protocolVersion: number;
+    blockIds: string[];
+}
+interface RemoveMessage {
+    type: "cmssy:remove";
+    protocolVersion: number;
+    blockId: string;
+}
+interface DragOverMessage {
+    type: "cmssy:drag-over";
+    protocolVersion: number;
+    y: number;
+}
+interface DragEndMessage {
+    type: "cmssy:drag-end";
+    protocolVersion: number;
+}
+type EditorToAppMessage = SelectMessage | PatchMessage | ParentReadyMessage | InsertMessage | ReorderMessage | RemoveMessage | DragOverMessage | DragEndMessage;
+declare function isProtocolCompatible(version: number): boolean;
+
+interface PostTarget {
+    postMessage: (message: unknown, targetOrigin: string) => void;
+}
+declare function normalizeOrigin(origin: string): string;
+declare function postToEditor(target: PostTarget, editorOrigin: string, message: AppToEditorMessage): void;
+declare function resolveInitialTarget(editorOrigin: string | string[]): string;
+declare function parseEditorMessage(data: unknown, origin: string, expectedOrigin: string | string[]): EditorToAppMessage | null;
+
+interface CmssyCspOptions {
+    /** Defaults to the cmssy cloud admin origin when unset. */
+    editorOrigin?: string | string[];
+}
+interface MutableHeaders {
+    headers: {
+        get: (name: string) => string | null;
+        set: (name: string, value: string) => void;
+        delete: (name: string) => void;
+    };
+}
+declare function toCspOrigin(origin: string): string;
+declare function cmssyCspHeaders(options: CmssyCspOptions): Record<string, string>;
+declare function applyCmssyCsp<T extends MutableHeaders>(response: T, options: CmssyCspOptions): T;
+
+export { type AppToEditorMessage as A, type BoundsMessage as B, type ClickMessage as C, DEFAULT_CMSSY_EDITOR_ORIGINS as D, type EditorToAppMessage as E, PROTOCOL_VERSION as P, type QueryScopedOptions as Q, type ReadyMessage as R, type SelectMessage as S, type CmssyClient as a, type CmssyConfig as b, type CmssyCspOptions as c, type CmssyEnvConfig as d, type ParentReadyMessage as e, type PatchMessage as f, type PostTarget as g, applyCmssyCsp as h, createCmssyClient as i, defineCmssyConfig as j, isProtocolCompatible as k, postToEditor as l, cmssyCspHeaders as m, normalizeOrigin as n, isDevelopment as o, parseEditorMessage as p, resolveInitialTarget as q, resolveEditorOrigin as r, toCspOrigin as t };

package/dist/csp-DlAEXYjA.d.cts

@@ -0,0 +1,189 @@
+import { CmssyClientConfig, BlockRect, BlockSchema, BlockMeta } from '@cmssy/types';
+import { G as GraphqlRequestOptions } from './locale-rhYcXU5z.cjs';
+
+declare const DEFAULT_CMSSY_EDITOR_ORIGINS: string[];
+declare function isDevelopment(): boolean;
+declare function resolveEditorOrigin(editorOrigin: string | string[] | undefined): string | string[];
+interface CmssyConfig {
+    /**
+     * Full GraphQL delivery endpoint. Defaults to the cmssy cloud endpoint
+     * (`https://api.cmssy.io/graphql`); set it only for self-hosted / staging.
+     */
+    apiUrl?: string;
+    /** Organization slug - part of the org-scoped delivery path. */
+    org: string;
+    workspaceSlug: string;
+    draftSecret: string;
+    /**
+     * A cmssy API token (`cs_…`) that opts this app into the editor-controlled dev
+     * preview. In development only, the SDK sends it on every page fetch so the
+     * backend can resolve the token's user and honour that user's dev-preview flag
+     * (toggled from the editor's dev-mode switch): flag on + a saved dev draft ⇒
+     * the draft overlay renders, otherwise published content. Server-only (never
+     * reaches the client); ignored outside development. See the Quickstart
+     * "Dev preview" section.
+     */
+    devToken?: string;
+    /**
+     * Origin allowed to frame your app in the editor. Defaults to
+     * {@link DEFAULT_CMSSY_EDITOR_ORIGINS}; set it only for self-hosted admins.
+     */
+    editorOrigin?: string | string[];
+    /**
+     * Canonical absolute site URL (e.g. https://cmssy.com), used by
+     * createCmssyRobots / createCmssySitemap. When omitted the helpers derive the
+     * origin from the request `host` header at render time (multi-domain safe).
+     */
+    siteUrl?: string;
+    /**
+     * Fallback locale resolver for a site whose URLs carry no language (e.g. a
+     * cookie or Accept-Language strategy). The workspace site config remains the
+     * source of truth for the default and enabled languages.
+     */
+    resolveLocale?: () => string | Promise<string>;
+}
+/**
+ * Env-shaped input for {@link defineCmssyConfig}: the required string fields are
+ * widened to `string | undefined` so a config can pass `process.env.*` straight
+ * through without a `?? ""` fallback (which would mask a missing value as an
+ * empty string) or a cast.
+ */
+type CmssyEnvConfig = Omit<CmssyConfig, "org" | "workspaceSlug" | "draftSecret"> & {
+    org?: string;
+    workspaceSlug?: string;
+    draftSecret?: string;
+};
+/**
+ * Validates an env-sourced config and returns a strictly-typed
+ * {@link CmssyConfig}. Pass raw `process.env.*` values; this throws a clear,
+ * actionable error listing any missing required variables (rendered by the
+ * Next.js error overlay / boundary), so the app fails fast instead of running
+ * with silently-empty config.
+ */
+declare function defineCmssyConfig(config: CmssyEnvConfig): CmssyConfig;
+
+interface QueryScopedOptions extends GraphqlRequestOptions {
+    workspaceId?: string;
+}
+interface CmssyClient {
+    readonly config: CmssyClientConfig;
+    query<T = unknown>(document: string, variables?: Record<string, unknown>, options?: GraphqlRequestOptions): Promise<T>;
+    queryScoped<T = unknown>(document: string, variables?: Record<string, unknown>, options?: QueryScopedOptions): Promise<T>;
+    resolveWorkspaceId(options?: GraphqlRequestOptions): Promise<string>;
+}
+declare function createCmssyClient(input: CmssyClientConfig): CmssyClient;
+
+declare const PROTOCOL_VERSION = 2;
+
+interface ReadyMessage {
+    type: "cmssy:ready";
+    protocolVersion: number;
+    blocks: Array<{
+        id: string;
+        type: string;
+        bounds: BlockRect;
+        layoutPosition?: string;
+    }>;
+    schemas: Record<string, BlockSchema>;
+    blockMeta?: Record<string, BlockMeta>;
+}
+interface BoundsMessage {
+    type: "cmssy:bounds";
+    blockId: string;
+    rect: BlockRect;
+}
+interface ClickMessage {
+    type: "cmssy:click";
+    blockId: string;
+    rect: BlockRect;
+    layoutPosition?: string;
+}
+interface DeselectMessage {
+    type: "cmssy:deselect";
+}
+interface MoveMessage {
+    type: "cmssy:move";
+    protocolVersion: number;
+    blockId: string;
+    index: number;
+}
+interface DragIndexMessage {
+    type: "cmssy:drag-index";
+    protocolVersion: number;
+    index: number;
+}
+type AppToEditorMessage = ReadyMessage | BoundsMessage | ClickMessage | DeselectMessage | MoveMessage | DragIndexMessage;
+interface SelectMessage {
+    type: "cmssy:select";
+    protocolVersion: number;
+    blockId: string;
+}
+interface PatchMessage {
+    type: "cmssy:patch";
+    protocolVersion: number;
+    blockId: string;
+    content: Record<string, unknown>;
+    style?: Record<string, unknown>;
+    advanced?: Record<string, unknown>;
+    layoutPosition?: string;
+}
+interface ParentReadyMessage {
+    type: "cmssy:parent-ready";
+    protocolVersion: number;
+}
+interface InsertMessage {
+    type: "cmssy:insert";
+    protocolVersion: number;
+    blockId: string;
+    blockType: string;
+    content: Record<string, unknown>;
+    style?: Record<string, unknown>;
+    advanced?: Record<string, unknown>;
+    index: number;
+}
+interface ReorderMessage {
+    type: "cmssy:reorder";
+    protocolVersion: number;
+    blockIds: string[];
+}
+interface RemoveMessage {
+    type: "cmssy:remove";
+    protocolVersion: number;
+    blockId: string;
+}
+interface DragOverMessage {
+    type: "cmssy:drag-over";
+    protocolVersion: number;
+    y: number;
+}
+interface DragEndMessage {
+    type: "cmssy:drag-end";
+    protocolVersion: number;
+}
+type EditorToAppMessage = SelectMessage | PatchMessage | ParentReadyMessage | InsertMessage | ReorderMessage | RemoveMessage | DragOverMessage | DragEndMessage;
+declare function isProtocolCompatible(version: number): boolean;
+
+interface PostTarget {
+    postMessage: (message: unknown, targetOrigin: string) => void;
+}
+declare function normalizeOrigin(origin: string): string;
+declare function postToEditor(target: PostTarget, editorOrigin: string, message: AppToEditorMessage): void;
+declare function resolveInitialTarget(editorOrigin: string | string[]): string;
+declare function parseEditorMessage(data: unknown, origin: string, expectedOrigin: string | string[]): EditorToAppMessage | null;
+
+interface CmssyCspOptions {
+    /** Defaults to the cmssy cloud admin origin when unset. */
+    editorOrigin?: string | string[];
+}
+interface MutableHeaders {
+    headers: {
+        get: (name: string) => string | null;
+        set: (name: string, value: string) => void;
+        delete: (name: string) => void;
+    };
+}
+declare function toCspOrigin(origin: string): string;
+declare function cmssyCspHeaders(options: CmssyCspOptions): Record<string, string>;
+declare function applyCmssyCsp<T extends MutableHeaders>(response: T, options: CmssyCspOptions): T;
+
+export { type AppToEditorMessage as A, type BoundsMessage as B, type ClickMessage as C, DEFAULT_CMSSY_EDITOR_ORIGINS as D, type EditorToAppMessage as E, PROTOCOL_VERSION as P, type QueryScopedOptions as Q, type ReadyMessage as R, type SelectMessage as S, type CmssyClient as a, type CmssyConfig as b, type CmssyCspOptions as c, type CmssyEnvConfig as d, type ParentReadyMessage as e, type PatchMessage as f, type PostTarget as g, applyCmssyCsp as h, createCmssyClient as i, defineCmssyConfig as j, isProtocolCompatible as k, postToEditor as l, cmssyCspHeaders as m, normalizeOrigin as n, isDevelopment as o, parseEditorMessage as p, resolveInitialTarget as q, resolveEditorOrigin as r, toCspOrigin as t };