@chaibuilder/sdk 4.0.0-beta.4 → 4.0.0-beta.41

package/dist/runtime.d.ts

@@ -1,20 +1,8 @@
-import { ComponentType } from 'react';
 import { default as default_2 } from 'react';
-import { ReactNode } from 'react';
 import { RJSFSchema } from '@rjsf/utils';
 import { UiSchema } from '@rjsf/utils';
 
-export declare const ADD_BLOCK_TABS: Record<string, AddBlockTab>;
-
-export declare type AddBlockTab = {
-    id: string;
-    tab: React.ComponentType;
-    tabContent: React.ComponentType;
-};
-
-export declare const builderProp: (options: ChaiBlockPropSchema) => ChaiBlockPropSchema;
-
-export declare const CHAI_BUILDER_PANELS: Record<string, ChaiSidebarPanel>;
+export declare const builderProp: (options: ChaiBlockPropsSchema) => ChaiBlockPropsSchema;
 
 export declare let CHAI_GLOBAL_DATA_PROVIDER: (args: {
     lang: string;
@@ -22,25 +10,7 @@ export declare let CHAI_GLOBAL_DATA_PROVIDER: (args: {
     inBuilder: boolean;
 }) => Promise<any>;
 
-declare type ChaiAsset = {
-    url: string;
-    id?: string;
-    thumbnailUrl?: string;
-    description?: string;
-    width?: number;
-    height?: number;
-};
-
-export declare type ChaiAsyncProp<T> = T | undefined;
-
-export declare type ChaiBlock<BlockProps = Record<string, any>> = {
-    _id: string;
-    _type: string;
-    _name?: string;
-    _parent?: string | null;
-} & BlockProps;
-
-declare type ChaiBlock_2<T = Record<string, any>> = {
+declare type ChaiBlock<T = Record<string, any>> = {
     _id: string;
     _name?: string;
     _parent?: string | null | undefined;
@@ -49,15 +19,7 @@ declare type ChaiBlock_2<T = Record<string, any>> = {
     partialBlockId?: string;
 } & T;
 
-declare type ChaiBlock_3<T = Record<string, any>> = {
-    _id: string;
-    _name?: string;
-    _parent?: string | null | undefined;
-    _type: string;
-    _libBlock?: string;
-} & T;
-
-export declare type ChaiBlockComponentProps<BlockProps, PageData = Record<string, unknown>> = ChaiBlock<BlockProps> & {
+declare type ChaiBlockComponentProps<BlockProps = unknown, PageData = Record<string, unknown>> = ChaiBlock<BlockProps> & {
     $loading?: boolean;
     blockProps: Record<string, string>;
     inBuilder: boolean;
@@ -68,8 +30,7 @@ export declare type ChaiBlockComponentProps<BlockProps, PageData = Record<string
     children?: default_2.ReactNode;
 };
 
-export declare interface ChaiBlockDefinition<T = Record<string, any>, K = Record<string, any>> {
-    component: default_2.ComponentType<ChaiBlockComponentProps<T>>;
+declare interface ChaiBlockConfig {
     type: string;
     label: string;
     group: string;
@@ -85,10 +46,20 @@ export declare interface ChaiBlockDefinition<T = Record<string, any>, K = Record
         lang: string;
         draft: boolean;
         inBuilder: boolean;
-        block: ChaiBlock<T>;
+        block: ChaiBlock;
         pageProps: ChaiPageProps;
-    }) => K;
+    }) => Record<string, unknown>;
+    props?: {
+        schema: ChaiBlockSchema;
+        uiSchema: ChaiBlockUiSchema;
+    };
+    /**
+     * @deprecated Use props.schema instead
+     */
     schema?: ChaiBlockSchema;
+    /**
+     * @deprecated Use props.uiSchema instead
+     */
     uiSchema?: ChaiBlockUiSchema;
     i18nProps?: string[];
     aiProps?: string[];
@@ -100,36 +71,102 @@ export declare interface ChaiBlockDefinition<T = Record<string, any>, K = Record
     canBeNested?: (type: string) => boolean;
 }
 
-declare type ChaiBlockDefinitionOptions<T, K> = Omit<ChaiBlockDefinition<T, K>, "component">;
+declare type ChaiBlockPropsSchema = RJSFSchema & {
+    properties?: {
+        [key: string]: RJSFSchema;
+    } | undefined;
+    enumNames?: (string | number)[];
+};
 
-export declare type ChaiBlockPropSchema = RJSFSchema & {
-    ui?: ChaiBlockUiSchema;
-    default: any;
+declare type ChaiBlockRJSFSchemas = {
+    schema: object | Omit<ChaiBlockSchema, "ui">;
+    uiSchema: ChaiBlockUiSchema;
 };
 
-export declare type ChaiBlockSchema = {
-    properties?: Record<string, ChaiBlockPropSchema>;
+declare type ChaiBlockSchema = {
+    properties?: Record<string, ChaiBlockPropsSchema>;
     allOf?: any[];
     oneOf?: any[];
-} & Partial<Pick<ChaiBlockPropSchema, "required" | "dependencies" | "ui" | "title" | "description" | "default">>;
+} & Partial<Pick<ChaiBlockPropsSchema, "required" | "dependencies" | "ui" | "title" | "description" | "default">>;
 
-export declare type ChaiBlockSchemas = {
-    schema: object | Omit<ChaiBlockSchema, "ui">;
-    uiSchema?: ChaiBlockUiSchema;
+declare type ChaiBlockUiSchema = UiSchema;
+
+declare interface ChaiDesignTokens {
+    [uniqueId: string]: {
+        name: string;
+        value: string;
+        archived?: boolean;
+    };
+}
+
+declare type ChaiFont = ChaiFontByUrl | ChaiFontBySrc | ChaiSystemFont;
+
+declare type ChaiFontBySrc = {
+    family: string;
+    src: ChaiFontSource[];
+    fallback: string;
 };
 
-export declare type ChaiBlockUiSchema = UiSchema;
+declare type ChaiFontByUrl = {
+    family: string;
+    url: string;
+    fallback: string;
+};
 
-declare type ChaiBuilderPage = {
+declare type ChaiFontSource = {
+    url: string;
+    format: string;
+    fontWeight?: string;
+    fontStyle?: string;
+    fontDisplay?: string;
+    fontStretch?: string;
+};
+
+declare type ChaiPage = {
     id: string;
     slug: string;
-    name: string;
     lang: string;
+    name: string;
+    pageType: string;
+    blocks: ChaiBlock[];
+    createdAt: string;
+    lastSaved: string;
+    dynamic: boolean;
     online: boolean;
-    seo: Record<string, any>;
+    seo: ChaiPageSeo;
+    app: string;
+    primaryPage?: string | null;
+    currentEditor?: string | null;
+    changes: object[];
+    parent?: string | null;
+    libRefId?: string | null;
+    dynamicSlugCustom?: string | null;
+    metadata?: object;
+    jsonld?: object;
+    globalJsonLds?: string[];
+    links?: string;
+    partialBlocks?: string;
+    designTokens?: ChaiDesignTokens;
+};
+
+declare type ChaiPageProps<T = Record<string, any>> = {
+    slug: string;
+    searchParams?: Record<string, string>;
+} & T;
+
+declare type ChaiPageSeo = {
+    title?: string;
+    description?: string;
+    ogTitle?: string;
+    ogDescription?: string;
+    ogImage?: string;
+    canonicalUrl?: string;
+    noIndex?: boolean;
+    noFollow?: boolean;
+    jsonLD?: string;
 };
 
-declare type ChaiBuilderPageType = {
+declare type ChaiPageType = {
     key: string;
     helpText?: string;
     icon?: string;
@@ -137,135 +174,36 @@ declare type ChaiBuilderPageType = {
     name: string | (() => Promise<string>);
     dynamicSegments?: string;
     dynamicSlug?: string;
-    getDynamicPages?: ({ query, uuid }: {
+    getDynamicPages?: ({ query, uuid, }: {
         query?: string;
         uuid?: string;
-    }) => Promise<ChaiDynamicPage[]>;
-    search?: (query: string) => Promise<PageTypeSearchResult[] | Error>;
+    }) => Promise<Pick<ChaiPage, "id" | "name" | "slug" | "primaryPage">[]>;
+    search?: (query: string) => Promise<Pick<ChaiPage, "id" | "name" | "slug">[] | Error>;
     resolveLink?: (id: string, draft?: boolean, lang?: string) => Promise<string>;
-    onCreate?: (data: Omit<ChaiBuilderPage, "seo">) => Promise<void>;
-    onUpdate?: (data: ChaiBuilderPage) => Promise<void>;
-    onDelete?: (data: Pick<ChaiBuilderPage, "id">) => Promise<void>;
+    onCreate?: (data: Partial<ChaiPage> & {
+        id: string;
+    }) => Promise<void>;
+    onUpdate?: (data: Partial<ChaiPage> & {
+        id: string;
+    }) => Promise<void>;
+    onDelete?: (data: Pick<ChaiPage, "id">) => Promise<void>;
     dataProvider?: (args: {
         lang: string;
         draft: boolean;
         inBuilder: boolean;
         pageProps: ChaiPageProps;
     }) => Promise<Record<string, any>>;
-    defaultTrackingInfo?: () => Record<string, any>;
     defaultSeo?: () => Record<string, any>;
     defaultJSONLD?: () => Record<string, any>;
     defaultMetaTags?: () => Record<string, string>;
 };
 
-export declare type ChaiDataProviderArgs<T = Record<string, any>, K = Record<string, any>> = {
-    block: ChaiBlock<T>;
-} & K;
-
-declare type ChaiDynamicPage = {
-    id: string;
-    slug: string;
-    name: string;
-    primaryPage?: string;
-};
-
-declare type ChaiFlagOptions = {
-    key: string;
-    value?: any;
-    description?: string;
-};
-
-export declare type ChaiFont = ChaiFontViaUrl | ChaiFontViaSrc;
-
-export declare type ChaiFontViaSrc = {
-    family: string;
-    src: {
-        url: string;
-        format: string;
-        fontWeight?: string;
-        fontStyle?: string;
-        fontDisplay?: string;
-        fontStretch?: string;
-    }[];
-    fallback: string;
-};
-
-export declare type ChaiFontViaUrl = {
+declare type ChaiSystemFont = {
     family: string;
-    url: string;
     fallback: string;
 };
 
-declare type ChaiLibrary<T = Record<string, any>> = {
-    id: string;
-    name: string;
-    blocks?: ChaiLibraryBlock[];
-    description?: string;
-} & T;
-
-declare type ChaiLibraryBlock<T = Record<string, any>> = {
-    id: string;
-    group: string;
-    name: string;
-    preview?: string;
-    tags?: string[];
-    description?: string;
-} & T;
-
-declare type ChaiLibraryConfig<T> = {
-    id: string;
-    name: string;
-    description: string;
-    getBlocksList: (library: ChaiLibrary) => Promise<ChaiLibraryBlock<T>[]>;
-    getBlock: ({ library, block, }: {
-        library: ChaiLibrary;
-        block: ChaiLibraryBlock<T>;
-    }) => Promise<HTMLString | ChaiBlock_2[]>;
-};
-
-export declare interface ChaiPageProps {
-    slug: string;
-    searchParams?: Record<string, string>;
-    [key: string]: any;
-}
-
-export declare type ChaiRuntimeProp<T> = T | undefined;
-
-export declare interface ChaiServerBlockDefinition<T = Record<string, any>, K = Record<string, any>> {
-    component: default_2.ComponentType<ChaiBlockComponentProps<T>>;
-    type: string;
-    dataProvider?: (args: {
-        draft: boolean;
-        inBuilder: boolean;
-        lang: string;
-        block: ChaiBlock<T>;
-        pageProps: ChaiPageProps;
-    }) => Promise<K>;
-    suspenseFallback?: default_2.ComponentType<any>;
-}
-
-export declare interface ChaiSidebarPanel {
-    id: string;
-    position: "top" | "bottom";
-    view?: "standard" | "modal" | "overlay" | "drawer";
-    button: React.ComponentType<{
-        isActive: boolean;
-        show: () => void;
-        panelId: string;
-        position: "top" | "bottom";
-    }>;
-    label: string;
-    panel?: ComponentType;
-    width?: number;
-    isInternal?: boolean;
-    icon?: React.ReactNode;
-}
-
-export declare type ChaiStyles = {
-    [key: string]: string;
-};
-
-export declare const closestBlockProp: (blockType: keyof typeof REGISTERED_CHAI_BLOCKS, prop: string) => ChaiBlockPropSchema;
+export declare const closestBlockProp: (blockType: keyof typeof REGISTERED_CHAI_BLOCKS, prop: string) => ChaiBlockPropsSchema;
 
 declare interface CollectionConfig<T> {
     id: string;
@@ -301,14 +239,22 @@ export declare const COLLECTIONS: Record<string, CollectionConfig<any>>;
 
 export declare const defaultChaiStyles: (classes: string) => string;
 
-export declare const getAIBlockProps: (type: keyof typeof REGISTERED_CHAI_BLOCKS) => ChaiBlockDefinition<Record<string, any>, Record<string, any>> | ChaiServerBlockDefinition<Record<string, any>, Record<string, any>> | never[];
+export declare const getAIBlockProps: (type: keyof typeof REGISTERED_CHAI_BLOCKS) => never[] | (ChaiBlockConfig & {
+    component: default_2.ComponentType<ChaiBlockComponentProps>;
+});
 
 export declare const getAllRegisteredFonts: () => ChaiFont[];
 
+export declare const getBlockDefaultProps: (type: keyof typeof REGISTERED_CHAI_BLOCKS) => Record<string, any>;
+
 export declare const getBlockFormSchemas: (type: keyof typeof REGISTERED_CHAI_BLOCKS) => {
     schema: RJSFSchema;
     uiSchema: UiSchema;
-} | null;
+} | undefined;
+
+/* Excluded from this release type: getBlockSchema */
+
+/* Excluded from this release type: getBlockUiSchema */
 
 export declare const getChaiCollection: (key: string) => CollectionConfig<any>;
 
@@ -320,63 +266,38 @@ export declare const getChaiGlobalData: (args: {
     inBuilder: boolean;
 }) => Promise<any>;
 
-export declare const getChaiLibrary: (id: string) => ChaiLibraryConfig<any>;
-
-export declare const getChaiPageType: (key: keyof typeof PAGE_TYPES) => ChaiBuilderPageType;
+export declare const getChaiPageType: (key: keyof typeof PAGE_TYPES) => ChaiPageType;
 
-export declare const getChaiPageTypes: () => ChaiBuilderPageType[];
+export declare const getChaiPageTypes: () => ChaiPageType[];
 
 export declare const getDefaultBlockProps: (type: keyof typeof REGISTERED_CHAI_BLOCKS) => Record<string, any>;
 
-export declare const getI18nBlockProps: (type: keyof typeof REGISTERED_CHAI_BLOCKS) => ChaiBlockDefinition<Record<string, any>, Record<string, any>> | ChaiServerBlockDefinition<Record<string, any>, Record<string, any>> | never[];
+export declare const getFontStyles: (headingFont: string, bodyFont: string) => Promise<{
+    fontStyles: string;
+    preloads: string[];
+}>;
 
-export declare const getPreImportHTML: (code: string) => Promise<string>;
+export declare const getI18nBlockProps: (type: keyof typeof REGISTERED_CHAI_BLOCKS) => never[] | (ChaiBlockConfig & {
+    component: default_2.ComponentType<ChaiBlockComponentProps>;
+});
 
-export declare const getRegisteredChaiBlock: (type: keyof typeof REGISTERED_CHAI_BLOCKS) => ChaiBlockDefinition | null;
+export declare const getRegisteredChaiBlock: (type: keyof typeof REGISTERED_CHAI_BLOCKS) => (ChaiBlockConfig & {
+    component: default_2.ComponentType<ChaiBlockComponentProps>;
+}) | undefined;
 
 export declare const getRegisteredFont: (family: string) => ChaiFont | undefined;
 
-declare type HTMLString = string;
+export declare const PAGE_TYPES: Record<string, ChaiPageType>;
 
-export declare const IfChaiFeatureFlag: ({ flagKey, children }: {
-    flagKey: string;
-    children: React.ReactNode;
-}) => ReactNode;
+export declare const registerChaiBlock: (component: default_2.ComponentType<ChaiBlockComponentProps<any>>, options: ChaiBlockConfig) => void;
 
-export declare type MediaManagerProps = {
-    assetId?: string;
-    close: () => void;
-    onSelect: (assets: ChaiAsset | ChaiAsset[]) => void;
-    mode?: "image" | "video" | "audio";
-};
+export declare const registerChaiBlockProps: (blockSchema: ChaiBlockPropsSchema) => ChaiBlockRJSFSchemas;
 
-export declare const PAGE_TYPES: Record<string, ChaiBuilderPageType>;
-
-declare type PageTypeSearchResult = {
-    id: string;
-    name: string;
-    slug?: string;
-};
-
-export declare const registerBlockSettingField: (id: string, component: React.ComponentType<any>) => void;
-
-export declare const registerBlockSettingTemplate: (id: string, component: React.ComponentType<any>) => void;
-
-export declare const registerBlockSettingWidget: (id: string, component: React.ComponentType<any>) => void;
-
-export declare const registerChaiAddBlockTab: (id: string, tab: Omit<AddBlockTab, "id">) => void;
-
-export declare const registerChaiBlock: <T extends Record<string, any> = Record<string, any>, K extends Record<string, any> = Record<string, any>>(component: default_2.ComponentType<ChaiBlockComponentProps<T>>, options: ChaiBlockDefinitionOptions<T, K>) => void;
-
-export declare const registerChaiBlockSchema: (blockSchema: ChaiBlockSchema) => ChaiBlockSchemas;
+export declare const registerChaiBlockSchema: (blockSchema: ChaiBlockPropsSchema) => ChaiBlockRJSFSchemas;
 
 export declare function registerChaiCollection<T = Record<any, any>>(id: string, collection: Omit<CollectionConfig<T>, "id">): void;
 
-export declare const registerChaiFeatureFlag: (key: string, flagOptions: Omit<ChaiFlagOptions, "key">) => void;
-
-export declare const registerChaiFeatureFlags: (flags: Record<string, Omit<ChaiFlagOptions, "key">>) => void;
-
-export declare const registerChaiFont: (family: string, font: Omit<ChaiFont, "family">) => void;
+export declare const registerChaiFont: (family: string, font: Omit<ChaiFontBySrc, "family">) => void;
 
 export declare const registerChaiGlobalDataProvider: <T>(globalDataProvider: (args: {
     lang: string;
@@ -384,43 +305,19 @@ export declare const registerChaiGlobalDataProvider: <T>(globalDataProvider: (ar
     inBuilder: boolean;
 }) => Promise<T>) => void;
 
-export declare const registerChaiLibrary: <T extends Record<string, any> = Record<string, any>>(id: string, library: Omit<ChaiLibraryConfig<T>, "id">) => void;
-
-export declare const registerChaiMediaManager: (component: React.ComponentType<MediaManagerProps>) => void;
-
-export declare const registerChaiPageType: (key: string, pageTypeOptions: Omit<ChaiBuilderPageType, "key" | "hasSlug">) => void;
-
-export declare const registerChaiPartialType: (key: string, pageTypeOptions: Omit<ChaiBuilderPageType, "key">) => void;
-
-export declare const registerChaiPreImportHTMLHook: (fn: (code: string) => Promise<string>) => void;
-
-export declare const registerChaiSaveToLibrary: (component: ComponentType<SaveToLibraryProps>) => void;
-
-export declare const registerChaiServerBlock: <T extends Record<string, any> = Record<string, any>, K extends Record<string, any> = Record<string, any>>(component: default_2.ComponentType<ChaiBlockComponentProps<T>>, options: Pick<ChaiBlockDefinition<T, K>, "type" | "dataProvider" | "i18nProps" | "aiProps">) => void;
+export declare const registerChaiPageType: (key: string, pageTypeOptions: Omit<ChaiPageType, "key" | "hasSlug">) => void;
 
-export declare const registerChaiSidebarPanel: (panelId: string, panelOptions: Omit<ChaiSidebarPanel, "id">) => void;
+export declare const registerChaiPartialType: (key: string, pageTypeOptions: Omit<ChaiPageType, "key">) => void;
 
-export declare const registerChaiTopBar: (component: React.ComponentType) => void;
+export declare const registerChaiServerBlock: (component: default_2.ComponentType<ChaiBlockComponentProps<any>>, options: Pick<ChaiBlockConfig, "type" | "dataProvider" | "i18nProps" | "aiProps">) => void;
 
-declare const REGISTERED_CHAI_BLOCKS: Record<string, ChaiBlockDefinition | ChaiServerBlockDefinition>;
-
-export declare const resetSaveToLibrary: () => void;
-
-export declare const RJSF_EXTENSIONS: Record<string, {
-    id: string;
-    component: React.ComponentType<any>;
-    type: string;
+declare const REGISTERED_CHAI_BLOCKS: Record<string, ChaiBlockConfig & {
+    component: default_2.ComponentType<ChaiBlockComponentProps>;
 }>;
 
-export declare const runtimeProp: (options: ChaiBlockPropSchema) => ChaiBlockPropSchema;
+export declare const runtimeProp: (options: ChaiBlockPropsSchema) => ChaiBlockPropsSchema;
 
-export declare type SaveToLibraryProps = {
-    blockId: string;
-    blocks: ChaiBlock_3[];
-    close: () => void;
-};
-
-export declare const setChaiBlockComponent: <T extends Record<string, any> = Record<string, any>>(type: keyof typeof REGISTERED_CHAI_BLOCKS, component: default_2.ComponentType<ChaiBlockComponentProps<T>>) => void;
+export declare const setChaiBlockComponent: (type: keyof typeof REGISTERED_CHAI_BLOCKS, component: default_2.ComponentType<ChaiBlockComponentProps<any>>) => void;
 
 export declare const setChaiBlockDataProvider: <K extends Record<string, any> = Record<string, any>>(type: string, dataProvider: (args: {
     lang: string;
@@ -438,36 +335,22 @@ export declare const setChaiServerBlockDataProvider: <K extends Record<string, a
     pageProps: ChaiPageProps;
 }) => Promise<K>) => void;
 
-export declare const StylesProp: (defaultClasses?: string) => ChaiBlockPropSchema;
-
-export declare const stylesProp: (defaultClasses?: string) => ChaiBlockPropSchema;
-
-export declare const syncBlocksWithDefaults: (blocks: ChaiBlock[]) => ChaiBlock[];
-
-export declare const useBlockSettingComponents: (type: "widget" | "field" | "template") => Record<string, React.ComponentType<any>>;
-
-export declare const useChaiAddBlockTabs: () => AddBlockTab[];
-
-export declare const useChaiFeatureFlag: (flagKey: string) => boolean;
+export declare const StylesProp: (defaultClasses?: string) => ChaiBlockPropsSchema;
 
-export declare const useChaiFeatureFlags: () => Record<string, ChaiFlagOptions>;
+export declare const stylesProp: (defaultClasses?: string) => ChaiBlockPropsSchema;
 
-export declare const useChaiLibraries: () => ChaiLibraryConfig<any>[];
+export declare const syncBlocksWithDefaultProps: (blocks: ChaiBlock[]) => ChaiBlock[];
 
-export declare const useChaiSidebarPanels: (position: "top" | "bottom") => ChaiSidebarPanel[];
-
-export declare const useMediaManagerComponent: () => ComponentType<MediaManagerProps>;
+export declare const syncBlocksWithDefaults: (blocks: ChaiBlock[]) => ChaiBlock[];
 
-export declare const useRegisteredChaiBlock: (type: keyof typeof REGISTERED_CHAI_BLOCKS) => ChaiBlockDefinition<Record<string, any>, Record<string, any>> | ChaiServerBlockDefinition<Record<string, any>, Record<string, any>> | null;
+export declare const useRegisteredChaiBlock: (type: keyof typeof REGISTERED_CHAI_BLOCKS) => (ChaiBlockConfig & {
+    component: default_2.ComponentType<ChaiBlockComponentProps>;
+}) | null;
 
-export declare const useRegisteredChaiBlocks: () => Record<string, ChaiBlockDefinition<Record<string, any>, Record<string, any>> | ChaiServerBlockDefinition<Record<string, any>, Record<string, any>>>;
+export declare const useRegisteredChaiBlocks: () => Record<string, ChaiBlockConfig & {
+    component: default_2.ComponentType<ChaiBlockComponentProps>;
+}>;
 
 export declare const useRegisteredFonts: () => ChaiFont[];
 
-export declare const useSaveToLibraryComponent: () => ComponentType<SaveToLibraryProps> | null;
-
-export declare const useToggleChaiFeatureFlag: (flagKey: string) => () => void;
-
-export declare const useTopBarComponent: () => ComponentType<    {}>;
-
 export { }