@chaibuilder/sdk 4.0.0-beta.1 → 4.0.0-beta.3

package/dist/pages.d.ts

@@ -0,0 +1,491 @@
+import { default as default_2 } from 'react';
+import { JSX } from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { UseMutationResult } from '@tanstack/react-query';
+import { UseQueryResult } from '@tanstack/react-query';
+
+declare type AskAiResponse = {
+    blocks?: Array<{
+        _id: string;
+    } & Partial<ChaiBlock>>;
+    usage?: Record<any, number>;
+    error?: any;
+};
+
+declare type BlocksWithDesignTokens = Record<string, string>;
+
+declare type BorderRadiusValue = false | string;
+
+declare type Breakpoint = {
+    title: string;
+    content: string;
+    breakpoint: "xs" | "sm" | "md" | "lg" | "xl" | "2xl" | string;
+    icon: default_2.ReactNode | Element;
+    width: number;
+};
+
+declare type ChaiBlock<T = Record<string, any>> = {
+    _id: string;
+    _name?: string;
+    _parent?: string | null | undefined;
+    _type: string;
+    _libBlock?: string;
+} & T;
+
+declare interface ChaiBuilderEditorProps {
+    children?: default_2.ReactNode;
+    /**
+     * Goto page callback
+     */
+    gotoPage?: ({ pageId, lang }: {
+        pageId: string;
+        lang: string;
+    }) => void;
+    /**
+     * User
+     */
+    user?: {
+        id: string;
+        name: string;
+        email: string;
+        avatar?: string;
+        role?: string;
+    };
+    /**
+     * Permissions
+     */
+    permissions?: string[];
+    /**
+     * Optional pageId. If not provided, a random pageId will be generated
+     */
+    pageId?: string;
+    /**
+     * Page external data
+     */
+    pageExternalData?: Record<string, any>;
+    /**
+     * Theme presets
+     */
+    themePresets?: Record<string, Partial<ChaiThemeValues>>[];
+    /**
+     * Theme options
+     */
+    themeOptions?: (defaultThemeOptions: ChaiBuilderThemeOptions) => ChaiBuilderThemeOptions;
+    /**
+     * Theme
+     */
+    theme?: Partial<ChaiThemeValues>;
+    /**
+     * Builder theme
+     */
+    builderTheme?: ChaiThemeValues;
+    /**
+     * Theme panel component
+     * TODO: Move to registerChaiThemePanelComponent()
+     */
+    themePanelComponent?: ReactComponentType;
+    /**
+     * onError callback function
+     * @param error
+     */
+    onError?: (error: Error) => void;
+    /**
+     * Translations object
+     */
+    translations?: Record<string, Record<string, any>>;
+    /**
+     * Custom layout component
+     * TODO: Move to registerChaiLayoutComponent()
+     */
+    layout?: default_2.ComponentType;
+    /**
+     * HTML direction.
+     */
+    htmlDir?: "ltr" | "rtl";
+    /**
+     * Show debug logs
+     */
+    debugLogs?: boolean;
+    /**
+     * Auto save support
+     */
+    autoSave?: boolean;
+    /**
+     * Auto save interval in seconds
+     */
+    autoSaveActionsCount?: number;
+    /**
+     * Breakpoints
+     */
+    breakpoints?: Breakpoint[];
+    /**
+     * Loading state
+     */
+    loading?: boolean;
+    /**
+     * Locale
+     */
+    locale?: string;
+    /**
+     * Ask AI callback
+     */
+    askAiCallBack?: (type: "styles" | "content", prompt: string, blocks: ChaiBlock[], lang: string) => Promise<AskAiResponse>;
+    /**
+     * Get partial blocks
+     * @returns {Record<string, { type: string; name: string; description?: string }>}
+     */
+    getPartialBlocks?: () => Promise<Record<string, {
+        type: string;
+        name: string;
+        description?: string;
+    }>>;
+    /**
+     * Get all blocks of a partial block
+     */
+    getPartialBlockBlocks?: (partialBlockKey: string) => Promise<ChaiBlock[]>;
+    /**
+     * Blocks for the page
+     */
+    blocks?: ChaiBlock[];
+    /**
+     * onSave callback function
+     * @param saveData
+     */
+    onSave?: ({ blocks, theme, autoSave }: SavePageData) => Promise<boolean | Error>;
+    /**
+     * onSaveStateChange callback function
+     * @param syncStatus
+     */
+    onSaveStateChange?: (syncStatus: "SAVED" | "SAVING" | "UNSAVED") => void;
+    /**
+     * Preview component
+     * TODO: Move to registerChaiPreviewComponent()
+     */
+    previewComponent?: ReactComponentType;
+    /**
+     * Content locale
+     */
+    fallbackLang?: string;
+    /**
+     * Languages
+     */
+    languages?: Array<string>;
+    /**
+     * Page Types props
+     */
+    pageTypes?: PageType[];
+    /**
+     * Search page type items
+     */
+    searchPageTypeItems?: (pageTypeKey: string, query: string) => Promise<PageTypeItem[] | Error>;
+    /**
+     * Collections
+     */
+    collections?: ChaiCollectoin[];
+    /**
+     * Get Block Async Props
+     */
+    getBlockAsyncProps?: (args: {
+        block: ChaiBlock;
+    }) => Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * temporary props. Not to be used in production
+     */
+    flags?: {
+        librarySite?: boolean;
+        copyPaste?: boolean;
+        exportCode?: boolean;
+        darkMode?: boolean;
+        dataBinding?: boolean;
+        importHtml?: boolean;
+        importTheme?: boolean;
+        gotoSettings?: boolean;
+        dragAndDrop?: boolean;
+        validateStructure?: boolean;
+        designTokens?: boolean;
+    };
+    structureRules?: StructureRule[];
+    designTokens?: DesignTokens;
+    siteWideUsage?: SiteWideUsage;
+    /**
+     * Screen to small message component
+     */
+    smallScreenComponent?: ReactComponentType;
+}
+
+declare type ChaiBuilderThemeOptions = {
+    fontFamily: false | Record<VariableKey, string>;
+    borderRadius: BorderRadiusValue;
+    colors: false | {
+        group: string;
+        items: Record<VariableKey, [HSLColor, HSLColor]>;
+    }[];
+};
+
+declare type ChaiCollectoin = {
+    id: string;
+    name: string;
+    description?: string;
+    filters?: FilterOptions[];
+    sorts?: SortOptions[];
+};
+
+export declare const ChaiJsonInput: React.FC<SmartJsonInputProps>;
+
+declare type ChaiThemeValues = {
+    fontFamily: {
+        heading: string;
+        body: string;
+    };
+    borderRadius: string;
+    colors: {
+        background: [HexColor, HexColor];
+        foreground: [HexColor, HexColor];
+        primary: [HexColor, HexColor];
+        "primary-foreground": [HexColor, HexColor];
+        secondary: [HexColor, HexColor];
+        "secondary-foreground": [HexColor, HexColor];
+        muted: [HexColor, HexColor];
+        "muted-foreground": [HSLColor, HSLColor];
+        accent: [HSLColor, HSLColor];
+        "accent-foreground": [HSLColor, HSLColor];
+        destructive: [HSLColor, HSLColor];
+        "destructive-foreground": [HSLColor, HSLColor];
+        border: [HSLColor, HSLColor];
+        input: [HSLColor, HSLColor];
+        ring: [HexColor, HexColor];
+        card: [HexColor, HexColor];
+        "card-foreground": [HexColor, HexColor];
+        popover: [HexColor, HexColor];
+        "popover-foreground": [HexColor, HexColor];
+        [key: string]: [HexColor, HexColor];
+    };
+};
+
+export declare const ChaiWebsiteBuilder: (props: ChaiWebsiteBuilderProps) => JSX.Element;
+
+declare type ChaiWebsiteBuilderProps = {
+    hasReactQueryProvider?: boolean;
+    topLeftCorner?: React.FC;
+    apiUrl?: string;
+    getPreviewUrl?: (slug: string) => string;
+    getLiveUrl?: (slug: string) => string;
+    onLogout?: () => void;
+    getAccessToken?: () => Promise<string>;
+    currentUser: LoggedInUser | null;
+    websocket?: any;
+    features?: {
+        sharedJsonLD?: boolean;
+        canResetSeoToDefault?: boolean;
+    } & Record<string, boolean>;
+} & Pick<ChaiBuilderEditorProps, "onError" | "translations" | "locale" | "htmlDir" | "autoSave" | "autoSaveActionsCount" | "fallbackLang" | "languages" | "themePresets" | "flags" | "structureRules">;
+
+declare type ChaiWebsiteSetting = {
+    appKey: string;
+    fallbackLang: string;
+    languages: string[];
+    theme: Record<"fontFamily" | "borderRadius" | "colors", any>;
+    designTokens: DesignTokens_2;
+};
+
+declare interface DesignTokens {
+    [uniqueId: string]: {
+        name: string;
+        value: string;
+    };
+}
+
+declare type DesignTokens_2 = {
+    [token: string]: {
+        value: string;
+        name: string;
+    };
+};
+
+declare type FilterOptions = {
+    id: string;
+    name: string;
+    description?: string;
+};
+
+declare type HexColor = string;
+
+declare type HSLColor = string;
+
+export declare const ImagePicker: default_2.FC<ImagePickerProps>;
+
+declare interface ImagePickerProps {
+    assetId?: string;
+    assetUrl?: string;
+    onChange: (value: {
+        url: string;
+        id: string;
+    }) => void;
+    className?: string;
+    placeholder?: string;
+    disabled?: boolean;
+}
+
+export declare const LanguageSwitcher: ({ showAdd, variant, goToDefaultLang, }: {
+    showAdd?: boolean;
+    variant?: "ghost" | "outline";
+    goToDefaultLang?: boolean;
+}) => JSX.Element;
+
+declare type LoggedInUser = {
+    id: string;
+    email: string;
+    name: string;
+    avatar?: string;
+    metadata?: Record<string, any>;
+};
+
+export declare function NestedPathSelector({ data, onSelect, dataType, disabled }: NestedPathSelectorProps): JSX.Element;
+
+declare type NestedPathSelectorProps = {
+    data: Record<string, any>;
+    onSelect: (path: string) => void;
+    dataType?: "value" | "array" | "object";
+    disabled?: boolean;
+};
+
+declare type PageType = {
+    key: string;
+    name: string;
+};
+
+declare type PageTypeItem = {
+    id: string;
+    name: string;
+    slug?: string;
+};
+
+export declare const PermissionChecker: ({ permission, permissions, children, fallback, }: {
+    permission?: string;
+    permissions?: string[];
+    fallback?: React.ReactNode;
+    children: React.ReactNode;
+}) => ReactNode;
+
+declare type ReactComponentType = default_2.ComponentType<any>;
+
+declare type SavePageData = {
+    autoSave: boolean;
+    blocks: ChaiBlock[];
+    theme?: ChaiThemeValues;
+    needTranslations?: boolean;
+    designTokens: DesignTokens;
+};
+
+declare interface SiteWideUsage {
+    [pageId: string]: {
+        name: string;
+        isPartial: boolean;
+        partialBlocks: string[];
+        links: string[];
+        designTokens: BlocksWithDesignTokens;
+    };
+}
+
+declare interface SmartJsonInputProps {
+    value: string;
+    onChange: (value: string) => void;
+    disabled?: boolean;
+    readOnly?: boolean;
+    placeholder?: string;
+    rows?: number;
+    id?: string;
+    pageData?: Record<string, any>;
+    handleFieldInsert?: (field: string, inputId: string) => void;
+    hasJsonLdForSelectedLang?: boolean;
+    copyJsonLDFromDefaultPage?: () => void;
+}
+
+declare type SortOptions = {
+    id: string;
+    name: string;
+    description?: string;
+};
+
+declare type StructureError = {
+    id: string;
+    message: string;
+    severity: "error" | "warning";
+    blockId?: string;
+};
+
+declare type StructureRule = {
+    name: string;
+    description: string;
+    validate: (blocks: ChaiBlock[], tree: any[]) => StructureError[];
+};
+
+export declare const useActivePage: () => {
+    data: any;
+    isFetching: boolean;
+};
+
+export declare const useApiUrl: () => string;
+
+export declare const useBuilderFetch: () => ({ body, headers, url, streamResponse, }: {
+    body: {
+        action: string;
+        data?: any;
+    };
+    headers?: Record<string, string>;
+    url?: string;
+    streamResponse?: boolean;
+}) => Promise<any>;
+
+export declare const useBuilderPageData: () => UseQueryResult<any, Error>;
+
+export declare const useChaiAuth: () => {
+    readonly isLoggedIn: boolean;
+    readonly user: any;
+    readonly logout: any;
+};
+
+export declare const useChaiCurrentPage: () => {
+    data: any;
+    isFetching: boolean;
+};
+
+export declare const useChaiUserInfo: (currentEditor: string) => UseQueryResult<    {
+name: string;
+id: string;
+email: string;
+avatar: string;
+}, Error>;
+
+export declare const useClearAll: () => () => void;
+
+export declare const useFallbackLang: () => string;
+
+export declare const useFetch: () => (url: string, body: {
+    action: string;
+    data?: any;
+}, headers?: Record<string, string>, streamResponse?: boolean) => Promise<any>;
+
+export declare const useGotoPage: () => ({ pageId }: {
+    pageId: string;
+}) => void;
+
+export declare const useLanguagePages: (pageId?: string | undefined) => UseQueryResult<any[], Error>;
+
+export declare const usePageTypes: () => UseQueryResult<any, Error>;
+
+export declare const useReloadPage: () => () => Promise<void>;
+
+export declare const useUpdateActivePageMetadata: () => UseMutationResult<any, Error, Record<string, any>, unknown>;
+
+export declare const useUserPermissions: () => UseQueryResult<any, Error>;
+
+export declare const useWebsitePages: () => UseQueryResult<any, Error>;
+
+export declare const useWebsiteSetting: () => UseQueryResult<ChaiWebsiteSetting, Error>;
+
+declare type VariableKey = string;
+
+export { }

package/dist/pages.js

@@ -0,0 +1,27 @@
+import { aE as s, aT as u, aP as t, aN as i, aO as r, ax as g, aU as P, ar as l, v as h, aK as n, aZ as o, aw as c, ap as C, aV as d, k as p, as as m, aW as A, l as U, m as b, aX as k, aY as W, a_ as v, g as B, j as F } from "./index-ZuacEL1j.js";
+export {
+  s as ChaiJsonInput,
+  u as ChaiWebsiteBuilder,
+  t as ImagePicker,
+  i as LanguageSwitcher,
+  r as NestedPathSelector,
+  g as PermissionChecker,
+  P as useActivePage,
+  l as useApiUrl,
+  h as useBuilderFetch,
+  n as useBuilderPageData,
+  o as useChaiAuth,
+  c as useChaiCurrentPage,
+  C as useChaiUserInfo,
+  d as useClearAll,
+  p as useFallbackLang,
+  m as useFetch,
+  A as useGotoPage,
+  U as useLanguagePages,
+  b as usePageTypes,
+  k as useReloadPage,
+  W as useUpdateActivePageMetadata,
+  v as useUserPermissions,
+  B as useWebsitePages,
+  F as useWebsiteSetting
+};