@cmssy/react 2.3.1 → 2.5.0

package/dist/index.d.ts

@@ -1,12 +1,145 @@
-import { F as FieldDefinition, C as CmssyPageData, b as BlockDefinition, c as CmssyFormDefinition, o as CmssyBlockAuthContext, p as CmssyBlockWorkspace, d as CmssyLayoutGroup, E as EditorToAppMessage, A as AppToEditorMessage, q as FetchLike, r as CmssyClientConfig, s as CmssySiteConfig, R as RawBlock, e as CmssyLocaleContext, t as BlockMap, u as CmssyBlockContext } from './commerce-queries-CQgJBHMK.js';
-export { a as BlockMeta, v as BlockRect, B as BlockSchema, w as BoundsMessage, x as BuildBlockContextExtra, y as ClickMessage, f as CmssyAddress, z as CmssyBlockMember, D as CmssyBranding, g as CmssyCart, j as CmssyCartDiscount, k as CmssyCartItem, l as CmssyCartItemSnapshot, G as CmssyFormField, H as CmssyFormSettings, I as CmssyFormSubmitResponse, J as CmssyLayoutSettings, K as CmssyLocalizedValue, L as CmssyModelDefinition, M as CmssyModelRecord, h as CmssyOrder, N as CmssyOrderDiscount, m as CmssyOrderItem, O as CmssyOrderTaxSummaryLine, P as CmssyPageMeta, Q as CmssyPageSummary, S as CmssyPriceTier, i as CmssyProduct, n as CmssyProductVariant, T as CmssyRecordList, U as CmssyShippingMethod, V as CmssyTaxSummaryLine, W as DEFAULT_CMSSY_API_URL, X as FORM_QUERY, Y as FetchLikeResponse, Z as FetchPageOptions, _ as MODEL_DEFINITIONS_QUERY, $ as MODEL_RECORDS_QUERY, a0 as PROTOCOL_VERSION, a1 as ParentReadyMessage, a2 as PatchMessage, a3 as RawLayoutBlock, a4 as ReadyMessage, a5 as SITE_CONFIG_QUERY, a6 as SUBMIT_FORM_MUTATION, a7 as SelectMessage, a8 as SubmitFormInput, a9 as blocksToMeta, aa as blocksToSchemas, ab as buildBlockContext, ac as buildBlockMap, ad as defineBlock, ae as fetchLayouts, af as fetchPage, ag as fetchPageById, ah as fetchPageMeta, ai as fetchPages, aj as isProtocolCompatible, ak as normalizeSlug, al as resolveApiUrl, am as resolvePublicUrl } from './commerce-queries-CQgJBHMK.js';
+import { CmssyClientConfig, CmssyLayoutGroup, CmssyPageData, CmssyPageMeta, CmssyPageSummary, CmssyFormDefinition, BuildBlockContextExtra, CmssyBlockContext, BlockRect, BlockSchema, BlockMeta, FieldControl, FieldDefinition, CmssyBlockAuthContext, CmssyBlockWorkspace, CmssySiteConfig, RawBlock, CmssySiteLocales, CmssyLocaleContext } from '@cmssy/types';
+export { BlockMeta, BlockRect, BlockSchema, BuildBlockContextExtra, CmssyBlockAuthContext, CmssyBlockContext, CmssyBlockMember, CmssyBlockWorkspace, CmssyBranding, CmssyClientConfig, CmssyFormDefinition, CmssyFormField, CmssyFormSettings, CmssyFormSubmitResponse, CmssyLayoutGroup, CmssyLayoutSettings, CmssyLocaleContext, CmssyLocalizedValue, CmssyModelDefinition, CmssyModelRecord, CmssyPageData, CmssyPageMeta, CmssyPageSummary, CmssyRecordList, CmssySiteConfig, CmssySiteLocales, FieldCondition, FieldConditionGroup, FieldConditionLogic, FieldControl, FieldDefinition, FieldType, RawBlock, RawLayoutBlock, SubmitFormInput, evaluateFieldConditionGroup } from '@cmssy/types';
+import { B as BlockDefinition, i as BlockMap } from './commerce-queries-CfjwkgfE.js';
+export { C as CmssyAddress, a as CmssyCart, d as CmssyCartDiscount, e as CmssyCartItem, f as CmssyCartItemSnapshot, b as CmssyOrder, j as CmssyOrderDiscount, g as CmssyOrderItem, k as CmssyOrderTaxSummaryLine, l as CmssyPriceTier, c as CmssyProduct, h as CmssyProductVariant, m as CmssyShippingMethod, n as CmssyTaxSummaryLine, o as blocksToMeta, p as blocksToSchemas, q as buildBlockMap, r as defineBlock } from './commerce-queries-CfjwkgfE.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-export { FieldCondition, FieldConditionGroup, FieldConditionLogic, FieldType, evaluateFieldConditionGroup } from '@cmssy/types';
 import 'react';
 
-type FieldControl = Omit<FieldDefinition, "type" | "label"> & {
-    label?: string;
-};
+/**
+ * The cmssy cloud GraphQL delivery endpoint. It is the same for every workspace,
+ * so consumers never need to set it - `apiUrl` defaults to this. Self-hosted /
+ * staging deployments override it via config.
+ */
+declare const DEFAULT_CMSSY_API_URL = "https://api.cmssy.io/graphql";
+declare function resolveApiUrl(apiUrl: string | undefined): string;
+/**
+ * Public delivery endpoint for a workspace: the org-scoped path
+ * `{base}/public/{orgSlug}/{workspaceSlug}/graphql`. `apiUrl` is the GraphQL
+ * base (its trailing `/graphql` is stripped); the org path is what tells the
+ * backend which workspace to serve, so slugs only need to be unique per org.
+ */
+declare function resolvePublicUrl(config: CmssyClientConfig): string;
+interface FetchLikeResponse {
+    ok: boolean;
+    status: number;
+    json: () => Promise<unknown>;
+}
+type FetchLike = (url: string, init: {
+    method: string;
+    headers: Record<string, string>;
+    body: string;
+    signal?: AbortSignal;
+}) => Promise<FetchLikeResponse>;
+interface FetchPageOptions {
+    previewSecret?: string;
+    devPreview?: boolean;
+    devToken?: string;
+    workspaceId?: string;
+    fetch?: FetchLike;
+    signal?: AbortSignal;
+}
+declare function normalizeSlug(path: string | string[] | undefined): string;
+declare function fetchPage(config: CmssyClientConfig, path: string | string[] | undefined, options?: FetchPageOptions): Promise<CmssyPageData | null>;
+declare function fetchPageById(config: CmssyClientConfig, pageId: string, options?: Pick<FetchPageOptions, "fetch" | "signal">): Promise<CmssyPageData | null>;
+declare function fetchPages(config: CmssyClientConfig, options?: Pick<FetchPageOptions, "fetch" | "signal">): Promise<CmssyPageSummary[]>;
+declare function fetchPageMeta(config: CmssyClientConfig, path: string | string[] | undefined, options?: Pick<FetchPageOptions, "fetch" | "signal">): Promise<CmssyPageMeta | null>;
+declare function fetchLayouts(config: CmssyClientConfig, path: string | string[] | undefined, options?: FetchPageOptions): Promise<CmssyLayoutGroup[]>;
+
+declare const SITE_CONFIG_QUERY = "query PublicSiteConfig($workspaceSlug: String!) {\n  public {\n    siteConfig(workspaceSlug: $workspaceSlug) {\n      id\n      workspaceId\n      siteName\n      defaultLanguage\n      enabledLanguages\n      enabledFeatures\n      notFoundPageId\n      previewUrl\n      branding {\n        brandName\n        logoUrl\n        faviconUrl\n        ogImageUrl\n      }\n    }\n  }\n}";
+declare const MODEL_DEFINITIONS_QUERY = "query PublicModelDefinitions($workspaceId: String!) {\n  public {\n    model {\n      definitions(workspaceId: $workspaceId) {\n        id name slug description icon color displayField recordCount\n      }\n    }\n  }\n}";
+declare const MODEL_RECORDS_QUERY = "query PublicModelRecords($workspaceId: String!, $modelSlug: String!, $filter: JSON, $sort: String, $limit: Int, $offset: Int, $populate: [String!]) {\n  public {\n    model {\n      records(workspaceId: $workspaceId, modelSlug: $modelSlug, filter: $filter, sort: $sort, limit: $limit, offset: $offset, populate: $populate) {\n        items { id modelId data status createdAt updatedAt }\n        total\n        hasMore\n      }\n    }\n  }\n}";
+declare const FORM_QUERY = "query PublicForm($formId: ID!) {\n  public {\n    form {\n      get(formId: $formId) {\n        id\n        name\n        slug\n        description\n        fields {\n          id name fieldType label placeholder helpText\n          defaultValue width order showWhen requiredWhen\n          options { value label disabled }\n          validation { required minLength maxLength minValue maxValue pattern customMessage }\n        }\n        settings {\n          actionType submitButtonLabel successMessage errorMessage\n          redirectUrl requireLogin enableCaptcha\n        }\n      }\n    }\n  }\n}";
+declare const SUBMIT_FORM_MUTATION = "mutation SubmitForm($formId: ID!, $input: SubmitFormInput!) {\n  public {\n    form {\n      submit(formId: $formId, input: $input) {\n        success message submissionId redirectUrl accessToken customer\n      }\n    }\n  }\n}";
+
+declare function buildBlockContext(locale: string, defaultLocale: string, enabledLocales?: string[], isPreview?: boolean, forms?: Record<string, CmssyFormDefinition>, extra?: BuildBlockContextExtra): CmssyBlockContext;
+
+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 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 | 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;
+
 declare const fields: {
     text: (opts?: FieldControl) => FieldDefinition;
     textarea: (opts?: FieldControl) => FieldDefinition;
@@ -107,10 +240,6 @@ declare function createCmssyClient(input: CmssyClientConfig): CmssyClient;
 declare function collectFormIds(blocks: RawBlock[], locale: string, defaultLocale: string): string[];
 declare function resolveForms(config: CmssyClientConfig, blocks: RawBlock[], locale: string, defaultLocale: string, options?: QueryScopedOptions): Promise<Record<string, CmssyFormDefinition>>;
 
-interface CmssySiteLocales {
-    defaultLocale: string;
-    locales: string[];
-}
 declare function resolveSiteLocales(config: CmssyClientConfig, options?: GraphqlRequestOptions): Promise<CmssySiteLocales>;
 declare function splitLocaleFromPath(path: string[] | undefined, siteLocales: CmssySiteLocales): {
     locale: string;
@@ -153,4 +282,4 @@ interface UnknownBlockProps {
 }
 declare function UnknownBlock({ type }: UnknownBlockProps): react_jsx_runtime.JSX.Element;
 
-export { AppToEditorMessage, BlockDefinition, BlockMap, CmssyBlock, CmssyBlockAuthContext, CmssyBlockContext, type CmssyBlockProps, CmssyBlockWorkspace, type CmssyClient, CmssyClientConfig, CmssyFormDefinition, CmssyLayoutGroup, CmssyLocaleContext, CmssyPageData, CmssyServerLayout, type CmssyServerLayoutProps, CmssyServerPage, type CmssyServerPageProps, CmssySiteConfig, type CmssySiteLocales, EditorToAppMessage, FetchLike, type FieldControl, FieldDefinition, type GraphqlRequestOptions, type PostTarget, type QueryScopedOptions, RawBlock, UnknownBlock, type UnknownBlockProps, buildLocaleSwitchHref, collectFormIds, createCmssyClient, fetchSiteConfig, fields, getBlockContentForLanguage, graphqlRequest, localizeHref, localizeHtmlLinks, normalizeOrigin, parseEditorMessage, postToEditor, resolveForms, resolveSiteLocales, resolveWorkspaceId, splitLocaleFromPath };
+export { type AppToEditorMessage, BlockDefinition, BlockMap, type BoundsMessage, type ClickMessage, CmssyBlock, type CmssyBlockProps, type CmssyClient, CmssyServerLayout, type CmssyServerLayoutProps, CmssyServerPage, type CmssyServerPageProps, DEFAULT_CMSSY_API_URL, type EditorToAppMessage, FORM_QUERY, type FetchLike, type FetchLikeResponse, type FetchPageOptions, type GraphqlRequestOptions, MODEL_DEFINITIONS_QUERY, MODEL_RECORDS_QUERY, PROTOCOL_VERSION, type ParentReadyMessage, type PatchMessage, type PostTarget, type QueryScopedOptions, type ReadyMessage, SITE_CONFIG_QUERY, SUBMIT_FORM_MUTATION, type SelectMessage, UnknownBlock, type UnknownBlockProps, buildBlockContext, buildLocaleSwitchHref, collectFormIds, createCmssyClient, fetchLayouts, fetchPage, fetchPageById, fetchPageMeta, fetchPages, fetchSiteConfig, fields, getBlockContentForLanguage, graphqlRequest, isProtocolCompatible, localizeHref, localizeHtmlLinks, normalizeOrigin, normalizeSlug, parseEditorMessage, postToEditor, resolveApiUrl, resolveForms, resolvePublicUrl, resolveSiteLocales, resolveWorkspaceId, splitLocaleFromPath };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cmssy/react",
-  "version": "2.3.1",
+  "version": "2.5.0",
   "description": "React blocks, renderers, data client and editor bridge for cmssy headless sites",
   "keywords": [
     "cmssy",
@@ -56,7 +56,7 @@
     "vitest": "^2.1.0"
   },
   "dependencies": {
-    "@cmssy/types": "0.22.0"
+    "@cmssy/types": "0.25.0"
   },
   "scripts": {
     "build": "tsup",