@chaibuilder/sdk 1.2.86 → 1.2.88

package/dist/core.d.ts

@@ -36,11 +36,6 @@ declare type AskAiResponse = {
     error?: any;
 };
 
-declare interface Block {
-    type: string;
-    [key: string]: any;
-}
-
 export declare const BlockAttributesEditor: React_2.MemoExoticComponent<() => JSX_2.Element>;
 
 /**
@@ -77,29 +72,72 @@ export declare const ChaiBuilderCanvas: React_3.FC;
 
 /**
  * ChaiBuilder is the main entry point for the Chai Builder Studio.
- * @param props
- * @constructor
  */
-export declare const ChaiBuilderEditor: (props: ChaiBuilderEditorProps) => JSX_2.Element;
+export declare const ChaiBuilderEditor: React_3.FC<ChaiBuilderEditorProps>;
 
 export declare interface ChaiBuilderEditorProps {
+    /**
+     * onError callback function
+     * @param error
+     */
     onError?: (error: Error) => void;
+    /**
+     * Translations object
+     */
     translations?: Record<string, Record<string, any>>;
+    /**
+     * onLoad callback function
+     * @param editorInstance
+     */
     onLoad?: (editorInstance: ChaiBuilderInstance) => void;
+    /**
+     * Custom layout component
+     */
     layout?: React_3.ComponentType;
+    /**
+     * Layout variant. Not supported with custom layout
+     */
     layoutVariant?: LayoutVariant;
+    /**
+     * HTML direction.
+     */
     htmlDir?: "ltr" | "rtl";
-    hideSaveButton?: boolean;
+    /**
+     * Filter function for blocks to be shown in the builder
+     */
     filterChaiBlock?: (block: any) => boolean;
+    /**
+     * Show debug logs
+     */
     showDebugLogs?: boolean;
+    /**
+     * Auto save support
+     */
     autoSaveSupport?: boolean;
+    /**
+     * Auto save interval in seconds
+     */
     autoSaveInterval?: TimeInSeconds;
+    /**
+     * Breakpoints
+     */
     breakpoints?: Breakpoint[];
+    /**
+     * Editable
+     */
     editable?: boolean;
+    /**
+     * Loading state
+     */
     loading?: boolean;
+    /**
+     * Locale
+     */
     locale?: string;
     nonEditableComponent?: ReactComponentType;
-    canvas?: React_3.FC<any>;
+    /**
+     * Canvas component. Not supported with custom layout
+     */
     canvasTopBarComponents?: {
         right?: ReactComponentType[];
     };
@@ -107,7 +145,6 @@ export declare interface ChaiBuilderEditorProps {
     dataBindingSupport?: boolean;
     dataProviders?: DataProvider[];
     darkMode?: boolean;
-    dndOptions?: any;
     importHTMLSupport?: boolean;
     fetchMediaCallback?: (limit?: number, offset?: number) => Promise<any[]>;
     uploadMediaCallback?: (file: File) => Promise<{
@@ -116,23 +153,28 @@ export declare interface ChaiBuilderEditorProps {
     askAiCallBack?: (type: "styles" | "content", prompt: string, blocks: ChaiBlock[]) => Promise<AskAiResponse>;
     saveAiContextCallback?: (content: string) => Promise<true | Error>;
     aiContext?: string;
-    getExternalPredefinedBlock?: (block: PredefinedBlock) => Promise<PredefinedBlock & {
-        blocks: ChaiBlock[];
-        html: string;
-    }>;
     uiLibraries?: Omit<UILibrary, "blocks">[];
     getUILibraryBlocks?: (library: UILibrary) => Promise<UiLibraryBlock[]>;
     getUILibraryBlock?: (library: UILibrary, uiLibBlock: UiLibraryBlock) => Promise<ChaiBlock[]>;
-    subPages?: Block[];
-    subPagesSupport?: boolean;
     blocks?: ChaiBlock[];
-    onSaveBlocks?: ({ blocks, providers }: any) => Promise<any>;
-    onSavePage?: ({ blocks, providers }: SavePageData) => Promise<boolean | Error>;
     onSave?: ({ blocks, providers }: SavePageData) => Promise<boolean | Error>;
     brandingOptions?: Record<string, string>;
-    onSaveBrandingOptions?: (brandingOptions: Record<string, any>) => Promise<boolean | Error>;
+    /**
+     * Theme configuration
+     */
+    themeConfiguration?: Record<string, string>;
+    /**
+     * onSaveStateChange callback function
+     * @param syncStatus
+     */
     onSaveStateChange?: (syncStatus: "UNSAVED" | "SAVED" | "SAVING") => void;
+    /**
+     * Preview component
+     */
     previewComponent?: ReactComponentType;
+    /**
+     * Sidebar components. Not supported with custom layout
+     */
     sideBarComponents?: {
         bottom?: ReactComponentType[];
         top?: {
@@ -141,13 +183,25 @@ export declare interface ChaiBuilderEditorProps {
             component: ReactComponentType;
         }[];
     };
+    /**
+     * Topbar components. Not supported with custom layout
+     */
     topBarComponents?: {
         center?: ReactComponentType[];
         left?: ReactComponentType[];
         right?: ReactComponentType[];
     };
+    /**
+     * Outline menu items
+     */
     outlineMenuItems?: OutlineMenuItems;
+    /**
+     * getPages callback function
+     */
     getPages?: () => Promise<ChaiPage[]>;
+    /**
+     * Unsplash access key
+     */
     unsplashAccessKey?: string;
     _flags?: Record<string, boolean>;
 }
@@ -223,9 +277,9 @@ export declare const ImportHTML: ({ parentId }: {
     parentId?: string;
 }) => JSX_2.Element;
 
-declare const LAYOUT_VARIANTS: Record<string, string>;
+declare const LAYOUT_MODE: Record<string, string>;
 
-declare type LayoutVariant = keyof typeof LAYOUT_VARIANTS;
+declare type LayoutVariant = keyof typeof LAYOUT_MODE;
 
 export declare const mergeClasses: (...inputs: ClassValue[]) => string;
 
@@ -240,14 +294,6 @@ declare type OutlineMenuItem = {
 
 declare type OutlineMenuItems = OutlineMenuItem[];
 
-declare type PredefinedBlock = {
-    uuid: string;
-    name: string;
-    preview: string;
-    blocks?: ChaiBlock[];
-    html?: string;
-};
-
 declare type ReactComponentType = React_3.ComponentType<any>;
 
 declare type RichText = string;
@@ -358,6 +404,11 @@ export declare const useChaiBuilderMsgListener: (handler: (payload: {
     data?: any;
 }) => void) => void;
 
+/**
+ * Custom hook to access the current state of the code editor.
+ * @category Hooks
+ * @returns The current state of the code editor from the `codeEditorAtom`.
+ */
 export declare const useCodeEditor: () => [CodeEditorProps, never];
 
 export declare const useCopyBlockIds: () => [Array<string>, Function];
@@ -385,7 +436,7 @@ export declare const useGetPageData: () => () => {
     blocks: any;
 };
 
-export declare const useHiddenBlockIds: () => (string[] | ((args_0: string[] | ((prev: string[]) => string[])) => void) | ((blockId: string) => void))[];
+export declare const useHiddenBlockIds: () => readonly [string[], (args_0: string[] | ((prev: string[]) => string[])) => void, (blockId: string) => void];
 
 /**
  *
@@ -441,7 +492,8 @@ export declare const useSelectedBlocksDisplayChild: () => {
 export declare const useSelectedBreakpoints: () => [string[], Function];
 
 /**
- *
+ * @group Hooks
+ * @returns {TStyleBlock[]} selected styling blocks
  */
 export declare const useSelectedStylingBlocks: () => [TStyleBlock[], (args_0: TStyleBlock[] | ((prev: TStyleBlock[]) => TStyleBlock[])) => void];
 

package/dist/core.js

@@ -1,4 +1,4 @@
-import { m as os, n as as, i as ts, A as rs, o as is, B as ps, h as ls, l as ms, g as us, p as ds, q as cs, D as Bs, I as ks, O as ns, r as Cs, T as Ss, U as gs, s as As, j as Is, t as Ps, z as hs, a6 as ys, E as Ms, a7 as vs, G as Us, a5 as Ds, v as Es, ab as Ls, X as Rs, d as Ts, x as bs, H as fs, J as xs, k as Hs, u as Os, K as ws, L as Vs, M as _s, N as zs, P as Fs, Q as Gs, R as Ns, S as Ws, V as Zs, aa as js, W as qs, f as Js, y as Ks, Y as Qs, Z as Xs, e as Ys, a0 as $s, $ as se, _ as ee, a as oe, a4 as ae, a8 as te, a9 as re, a1 as ie, a3 as pe, a2 as le, w as me, b as ue, c as de } from "./index-PmGJgG89.js";
+import { m as os, n as as, i as ts, A as rs, o as is, B as ps, h as ls, l as ms, g as us, p as ds, q as cs, D as Bs, I as ks, O as ns, r as Cs, T as Ss, U as gs, s as As, j as Is, t as Ps, z as hs, a6 as ys, E as Ms, a7 as vs, G as Us, a5 as Ds, v as Es, ab as Ls, X as Rs, d as Ts, x as bs, H as fs, J as xs, k as Hs, u as Os, K as ws, L as Vs, M as _s, N as zs, P as Fs, Q as Gs, R as Ns, S as Ws, V as Zs, aa as js, W as qs, f as Js, y as Ks, Y as Qs, Z as Xs, e as Ys, a0 as $s, $ as se, _ as ee, a as oe, a4 as ae, a8 as te, a9 as re, a1 as ie, a3 as pe, a2 as le, w as me, b as ue, c as de } from "./index-JAlLL51L.js";
 import { g as Be, c as ke } from "./iconBase-zweRWSz0.js";
 import { useTranslation as Ce } from "react-i18next";
 import { default as ge } from "i18next";
@@ -47,10 +47,10 @@ import "react-dom";
 import "prop-types";
 import "react-error-boundary";
 import "re-resizable";
+import "lucide-react";
 import "@rjsf/validator-ajv8";
 import "@rjsf/core";
 import "react-arborist";
-import "lucide-react";
 import "himalaya";
 import "react-icons-picker";
 import "react-autosuggest";