@cmssy/react 2.3.1 → 2.5.0

package/dist/commerce-queries-CQgJBHMK.d.cts

@@ -1,557 +0,0 @@
-import { ComponentType } from 'react';
-import { FieldConditionGroup, FieldType } from '@cmssy/types';
-
-/**
- * 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 CmssyClientConfig {
-    /**
-     * Full GraphQL endpoint (used as-is for authenticated requests). Defaults to
-     * {@link DEFAULT_CMSSY_API_URL}. Public reads strip its trailing `/graphql`
-     * and append the org-scoped path (see {@link resolvePublicUrl}).
-     */
-    apiUrl?: string;
-    /** Organization slug - part of the org-scoped delivery path. */
-    org: string;
-    workspaceSlug: 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;
-}
-interface RawBlock {
-    id: string;
-    type: string;
-    content: unknown;
-    style?: unknown;
-    advanced?: unknown;
-}
-interface CmssyPageData {
-    id: string;
-    blocks: RawBlock[];
-}
-interface RawLayoutBlock {
-    id: string;
-    type: string;
-    content: unknown;
-    style?: unknown;
-    advanced?: unknown;
-    order: number;
-    isActive: boolean;
-}
-interface CmssyLayoutSettings {
-    desktopWidth: number | null;
-    mobileBehavior: string;
-}
-interface CmssyLayoutGroup {
-    position: string;
-    blocks: RawLayoutBlock[];
-    settings?: CmssyLayoutSettings | null;
-}
-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>;
-interface CmssyPageSummary {
-    id: string;
-    slug: string;
-    updatedAt: string | null;
-    publishedAt: string | null;
-}
-declare function fetchPages(config: CmssyClientConfig, options?: Pick<FetchPageOptions, "fetch" | "signal">): Promise<CmssyPageSummary[]>;
-type CmssyLocalizedValue = Record<string, string> | string | null;
-interface CmssyPageMeta {
-    id: string;
-    seoTitle: CmssyLocalizedValue;
-    seoDescription: CmssyLocalizedValue;
-    seoKeywords: string[] | null;
-    displayName: CmssyLocalizedValue;
-}
-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[]>;
-
-interface CmssyBranding {
-    brandName: string | null;
-    logoUrl: string | null;
-    faviconUrl: string | null;
-    ogImageUrl: string | null;
-}
-interface CmssySiteConfig {
-    id: string;
-    workspaceId: string;
-    siteName: unknown;
-    defaultLanguage: string | null;
-    enabledLanguages: string[];
-    enabledFeatures: string[];
-    notFoundPageId: string | null;
-    previewUrl: string | null;
-    branding: CmssyBranding | null;
-}
-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}";
-interface CmssyModelDefinition {
-    id: string;
-    name: string;
-    slug: string;
-    description: string | null;
-    icon: string | null;
-    color: string | null;
-    displayField: string | null;
-    recordCount: number | null;
-}
-interface CmssyModelRecord {
-    id: string;
-    modelId: string;
-    data: Record<string, unknown>;
-    status: string | null;
-    createdAt: string | null;
-    updatedAt: string | null;
-}
-interface CmssyRecordList {
-    items: CmssyModelRecord[];
-    total: number;
-    hasMore: boolean;
-}
-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}";
-interface CmssyFormField {
-    id: string;
-    name: string;
-    fieldType: string;
-    label: string | null;
-    placeholder: string | null;
-    helpText: string | null;
-    defaultValue: unknown;
-    options: unknown;
-    validation: unknown;
-    width: string | null;
-    order: number | null;
-    showWhen: FieldConditionGroup | null;
-    requiredWhen: FieldConditionGroup | null;
-}
-interface CmssyFormSettings {
-    actionType: string | null;
-    submitButtonLabel: unknown;
-    successMessage: unknown;
-    errorMessage: unknown;
-    redirectUrl: string | null;
-    requireLogin: boolean | null;
-    enableCaptcha: boolean | null;
-}
-interface CmssyFormDefinition {
-    id: string;
-    name: string;
-    slug: string | null;
-    description: string | null;
-    fields: CmssyFormField[];
-    settings: CmssyFormSettings | null;
-}
-interface CmssyFormSubmitResponse {
-    success: boolean;
-    message: string | null;
-    submissionId: string | null;
-    redirectUrl: string | null;
-    accessToken: string | null;
-    customer: unknown;
-}
-interface SubmitFormInput {
-    data: Record<string, unknown>;
-    website?: string;
-}
-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}";
-
-interface CmssyLocaleContext {
-    current: string;
-    default: string;
-    enabled: string[];
-}
-interface CmssyBlockMember {
-    recordId: string;
-    email: string;
-}
-interface CmssyBlockAuthContext {
-    isAuthenticated: boolean;
-    member: CmssyBlockMember | null;
-}
-interface CmssyBlockWorkspace {
-    id: string;
-    slug: string;
-}
-interface CmssyBlockContext {
-    locale: CmssyLocaleContext;
-    isPreview: boolean;
-    forms?: Record<string, CmssyFormDefinition>;
-    auth?: CmssyBlockAuthContext;
-    workspace?: CmssyBlockWorkspace;
-}
-interface BuildBlockContextExtra {
-    auth?: CmssyBlockAuthContext;
-    workspace?: CmssyBlockWorkspace;
-}
-declare function buildBlockContext(locale: string, defaultLocale: string, enabledLocales?: string[], isPreview?: boolean, forms?: Record<string, CmssyFormDefinition>, extra?: BuildBlockContextExtra): CmssyBlockContext;
-
-declare const PROTOCOL_VERSION = 2;
-
-interface FieldDefinition {
-    type: FieldType;
-    label: string;
-    defaultValue?: unknown;
-    helperText?: string;
-    required?: boolean;
-    placeholder?: string;
-    tab?: string;
-    options?: string[];
-    itemSchema?: Record<string, FieldDefinition>;
-    itemLabel?: string;
-    addButtonLabel?: string;
-    minItems?: number;
-    maxItems?: number;
-    collapsible?: boolean;
-    multiple?: boolean;
-    pageType?: string;
-}
-type BlockSchema = Record<string, FieldDefinition>;
-interface BlockMeta {
-    label: string;
-    category?: string;
-    icon?: string;
-    layoutPositions?: string[];
-    /** One-line block description; surfaced to the AI page composer. */
-    description?: string;
-}
-interface BlockRect {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
-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;
-
-interface BlockLoaderArgs {
-    content: Record<string, unknown>;
-    context?: CmssyBlockContext;
-}
-type BlockLoader = (args: BlockLoaderArgs) => Promise<unknown> | unknown;
-interface BlockDefinition {
-    type: string;
-    label?: string;
-    category?: string;
-    icon?: string;
-    layoutPositions?: string[];
-    /**
-     * One-line semantic description of what the block is and when it belongs on a
-     * page. Surfaced to the AI page composer to guide block selection and order.
-     */
-    description?: string;
-    props: Record<string, FieldDefinition>;
-    /**
-     * Optional server-side data loader. Run by CmssyServerPage during SSR; its
-     * result is passed to the component as the `data` prop. Not run in the
-     * editor (the component receives `data: undefined` there).
-     *
-     * The result crosses the server→client boundary when the block component is a
-     * Client Component, so it must be RSC-serializable (plain objects, arrays and
-     * primitives - no functions, class instances, etc.).
-     */
-    loader?: BlockLoader;
-    component: ComponentType<{
-        content: Record<string, unknown>;
-        style?: Record<string, unknown>;
-        advanced?: Record<string, unknown>;
-        context?: CmssyBlockContext;
-        data?: unknown;
-    }>;
-}
-declare function defineBlock<C extends Record<string, unknown>, D = unknown, S extends Record<string, unknown> = Record<string, unknown>, A extends Record<string, unknown> = Record<string, unknown>>(def: {
-    type: string;
-    label?: string;
-    category?: string;
-    icon?: string;
-    layoutPositions?: string[];
-    description?: string;
-    props: Record<string, FieldDefinition>;
-    loader?: (args: {
-        content: C;
-        context?: CmssyBlockContext;
-    }) => Promise<D> | D;
-    component: ComponentType<{
-        content: C;
-        style?: S;
-        advanced?: A;
-        context?: CmssyBlockContext;
-        data?: D;
-    }>;
-}): BlockDefinition;
-type BlockMap = Record<string, ComponentType<{
-    content: Record<string, unknown>;
-    style?: Record<string, unknown>;
-    advanced?: Record<string, unknown>;
-    context?: CmssyBlockContext;
-    data?: unknown;
-}>>;
-declare function buildBlockMap(blocks: BlockDefinition[]): BlockMap;
-declare function blocksToSchemas(blocks: BlockDefinition[]): Record<string, BlockSchema>;
-declare function blocksToMeta(blocks: BlockDefinition[], defaults?: {
-    category?: string;
-}): Record<string, BlockMeta>;
-
-interface CmssyPriceTier {
-    minQty: number;
-    price: number;
-}
-interface CmssyCartItemSnapshot {
-    name: string;
-    price: number;
-    currency: string;
-    imageUrl: string | null;
-    sku: string | null;
-    tiers: CmssyPriceTier[];
-}
-interface CmssyCartItem {
-    id: string;
-    recordId: string;
-    quantity: number;
-    variantSelections: Record<string, string> | null;
-    snapshot: CmssyCartItemSnapshot;
-    unitPrice: number;
-    currentPrice: number | null;
-    priceMismatch: boolean;
-}
-interface CmssyShippingMethod {
-    id: string;
-    label: string;
-    price: number;
-    etaLabel: string | null;
-}
-interface CmssyTaxSummaryLine {
-    rateId: string | null;
-    name: string | null;
-    rate: number;
-    base: number;
-    amount: number;
-}
-interface CmssyAddress {
-    name: string;
-    company?: string | null;
-    line1: string;
-    line2?: string | null;
-    postalCode: string;
-    city: string;
-    region?: string | null;
-    country: string;
-    phone?: string | null;
-    vatId?: string | null;
-}
-interface CmssyCartDiscount {
-    code: string;
-    type: string;
-    value: number;
-    computedAmount: number;
-}
-interface CmssyCart {
-    id: string;
-    status: string;
-    items: CmssyCartItem[];
-    itemCount: number;
-    subtotal: number;
-    currency: string | null;
-    appliedDiscount: CmssyCartDiscount | null;
-    discountedTotal: number;
-    tax: number;
-    taxSummary: CmssyTaxSummaryLine[];
-    totalGross: number;
-    pricesIncludeTax: boolean;
-    shippingMethod: CmssyShippingMethod | null;
-    shippingTotal: number;
-    availableShippingMethods: CmssyShippingMethod[];
-}
-interface CmssyProductVariant {
-    id: string;
-    sku: string | null;
-    price: number;
-    inventory: number | null;
-    selectedOptions: Array<{
-        name: string;
-        value: string;
-    }>;
-    tiers: CmssyPriceTier[];
-}
-interface CmssyProduct {
-    id: string;
-    data: Record<string, unknown>;
-    variants: CmssyProductVariant[];
-    priceTiers: CmssyPriceTier[];
-}
-interface CmssyOrderItem {
-    name: string;
-    price: number;
-    listPrice?: number | null;
-    tierMinQty?: number | null;
-    currency: string;
-    quantity: number;
-    sku: string | null;
-}
-interface CmssyOrderPayment {
-    amount: number;
-    reference: string;
-    provider: string | null;
-    at: string;
-}
-type CmssyOrderTaxSummaryLine = CmssyTaxSummaryLine;
-interface CmssyOrderDiscount {
-    code: string;
-    type: string;
-    value: number;
-    amount: number;
-}
-interface CmssyOrder {
-    id: string;
-    status: string;
-    subtotal: number;
-    discount?: number;
-    appliedDiscount?: CmssyOrderDiscount | null;
-    total: number;
-    currency: string;
-    customerEmail: string;
-    tax?: number;
-    pricesIncludeTax?: boolean;
-    taxSummary?: CmssyOrderTaxSummaryLine[];
-    refundedAmount?: number;
-    items?: CmssyOrderItem[];
-    paymentProvider?: string | null;
-    paymentStatus?: string;
-    fulfillmentStatus?: string;
-    amountPaid?: number;
-    balanceDue?: number;
-    paymentReference?: string | null;
-    trackingNumber?: string | null;
-    trackingCarrier?: string | null;
-    invoiceNumber?: string | null;
-    invoiceUrl?: string | null;
-    invoiceProvider?: string | null;
-    payments?: CmssyOrderPayment[];
-    paidAt?: string | null;
-    fulfilledAt?: string | null;
-    createdAt?: string;
-    orderNumber?: number | null;
-    poNumber?: string | null;
-    customerNote?: string | null;
-    shippingAddress?: CmssyAddress | null;
-    shippingMethod?: {
-        id: string;
-        label: string;
-        price: number;
-    } | null;
-    shippingTotal?: number;
-    accessToken?: string | null;
-}
-
-export { MODEL_RECORDS_QUERY as $, type AppToEditorMessage as A, type BlockSchema as B, type CmssyPageData as C, type CmssyBranding as D, type EditorToAppMessage as E, type FieldDefinition as F, type CmssyFormField as G, type CmssyFormSettings as H, type CmssyFormSubmitResponse as I, type CmssyLayoutSettings as J, type CmssyLocalizedValue as K, type CmssyModelDefinition as L, type CmssyModelRecord as M, type CmssyOrderDiscount as N, type CmssyOrderTaxSummaryLine as O, type CmssyPageMeta as P, type CmssyPageSummary as Q, type RawBlock as R, type CmssyPriceTier as S, type CmssyRecordList as T, type CmssyShippingMethod as U, type CmssyTaxSummaryLine as V, DEFAULT_CMSSY_API_URL as W, FORM_QUERY as X, type FetchLikeResponse as Y, type FetchPageOptions as Z, MODEL_DEFINITIONS_QUERY as _, type BlockMeta as a, PROTOCOL_VERSION as a0, type ParentReadyMessage as a1, type PatchMessage as a2, type RawLayoutBlock as a3, type ReadyMessage as a4, SITE_CONFIG_QUERY as a5, SUBMIT_FORM_MUTATION as a6, type SelectMessage as a7, type SubmitFormInput as a8, blocksToMeta as a9, blocksToSchemas as aa, buildBlockContext as ab, buildBlockMap as ac, defineBlock as ad, fetchLayouts as ae, fetchPage as af, fetchPageById as ag, fetchPageMeta as ah, fetchPages as ai, isProtocolCompatible as aj, normalizeSlug as ak, resolveApiUrl as al, resolvePublicUrl as am, type BlockDefinition as b, type CmssyFormDefinition as c, type CmssyLayoutGroup as d, type CmssyLocaleContext as e, type CmssyAddress as f, type CmssyCart as g, type CmssyOrder as h, type CmssyProduct as i, type CmssyCartDiscount as j, type CmssyCartItem as k, type CmssyCartItemSnapshot as l, type CmssyOrderItem as m, type CmssyProductVariant as n, type CmssyBlockAuthContext as o, type CmssyBlockWorkspace as p, type FetchLike as q, type CmssyClientConfig as r, type CmssySiteConfig as s, type BlockMap as t, type CmssyBlockContext as u, type BlockRect as v, type BoundsMessage as w, type BuildBlockContextExtra as x, type ClickMessage as y, type CmssyBlockMember as z };