react-bricks 4.7.7 → 5.0.0-alpha.0

package/react-bricks.d.ts

@@ -128,6 +128,8 @@ declare namespace types {
      */
     export type Theme = {
         themeName: string;
+        bannerText?: string;
+        bannerLink?: string;
         categories: Category[];
     };
     /**
@@ -246,6 +248,15 @@ declare namespace types {
             aiText: boolean;
             aiGen: boolean;
             aiSeo: boolean;
+            emailMarketing: boolean;
+            forms: boolean;
+        };
+        emailMarketingConfig?: {
+            providers: Array<{
+                value: string;
+                label: string;
+            }>;
+            testRecipients: string[];
         };
     } | null;
     /**
@@ -278,6 +289,26 @@ declare namespace types {
         date: string;
         user: EditingUser;
     };
+    /**
+     * Provider to send EmailMarketing
+     */
+    export type EmailMarketingProvider = 'brevo' | 'getresponse' | 'mailchimp' | 'mailerlite' | 'resend' | 'sendgrid';
+    /** EmailMarketing Sender (from address) */
+    export type EmailMarketingSender = {
+        email: string;
+        name: string;
+        id?: string;
+    };
+    /**
+     * EmailMarketing configuration on Page
+     */
+    export type EmailMarketingConfig = {
+        provider: EmailMarketingProvider;
+        sender: string;
+        listId: string;
+        campaignName: string;
+        subject: string;
+    };
     /**
      * AppOnPage
      */
@@ -296,6 +327,7 @@ declare namespace types {
         meta: IMeta;
         customValues?: Props;
         externalData?: Props;
+        emailMarketingConfig?: EmailMarketingConfig;
         content: IContentBlock[];
         workingContent?: IContentBlock[];
         committedContent?: IContentBlock[];
@@ -355,6 +387,10 @@ declare namespace types {
         name: string;
         showAsBrick?: boolean;
         previewImageUrl?: string;
+        disabled?: boolean;
+        disabledIcon?: 'purchase' | 'maintenance';
+        disabledLink?: string;
+        disabledTooltip?: string;
         props: T;
     };
     type RepeaterItemDefault = IContentBlock | Omit<IContentBlock, 'id'> | Props;
@@ -407,6 +443,10 @@ declare namespace types {
         description?: string;
         getDefaultProps?: () => Partial<T>;
         hideFromAddMenu?: boolean;
+        disabled?: boolean;
+        disabledIcon?: 'purchase' | 'maintenance';
+        disabledLink?: string;
+        disabledTooltip?: string;
         sideEditProps?: Array<ISideEditProp<T> | ISideGroup<T>>;
         repeaterItems?: IRepeaterItem<T>[];
         newItemMenuOpen?: boolean;
@@ -479,10 +519,11 @@ declare namespace types {
     /**
      * Option of a select sidebar prop
      */
-    export type RepeatserItems<T = RepeaterItemDefault> = Array<T>;
     export interface IOption<T = any> {
         value: T;
         label: string;
+        disabled?: boolean;
+        disabledTooltip?: string;
         [otherProps: string]: unknown;
     }
     /**
@@ -546,6 +587,7 @@ declare namespace types {
             multiple: boolean;
             embedValues?: boolean;
         };
+        onChange?: (props: T) => Partial<T>;
     }
     /**
      * Sidebar Edit Props
@@ -643,12 +685,16 @@ declare namespace types {
         editable?: boolean;
         getDefaultContent?: () => (string | IBrickStory | IContentBlock)[];
     };
-    export type RenderEnvironment = 'Frontend' | 'Preview' | 'Admin';
+    export type RenderEnvironment = 'Frontend' | 'Preview' | 'Admin' | 'Email';
     export interface IRenderWrapperArgs {
         children: React__default.ReactElement;
         page: PageValues;
         renderEnvironment: RenderEnvironment;
     }
+    export interface IRenderEmailHtmlArgs {
+        children: React__default.ReactElement;
+        page: PageValues;
+    }
     /**
      * Page type
      */
@@ -670,8 +716,9 @@ declare namespace types {
         slugPrefix?: ISlugPrefix;
         template?: Array<TemplateSlot>;
         headlessView?: boolean;
-        isEmail?: boolean;
+        isEmailMarketing?: boolean;
         renderWrapper?: (args: IRenderWrapperArgs) => React__default.ReactElement;
+        renderEmailHtml?: (args: IRenderEmailHtmlArgs) => string | Promise<string>;
     }
     /**
      * Structure returned by the cleanBlocks function
@@ -1262,6 +1309,19 @@ declare const Meta: React.FC<MetaProps>;
 
 declare const renderMeta: React.FC<types.Page>;
 
+interface SendFormSubmissionResult {
+    success: boolean;
+    statusCode: number;
+    message: string;
+}
+declare const sendFormSubmission: ({ appId, appEnv, token, formId, emailAddress, data, }: SendFormSubmissionParams) => Promise<SendFormSubmissionResult>;
+
+interface Form {
+    id: string;
+    name: string;
+}
+declare const fetchForms: () => Promise<Form[]>;
+
 declare const usePage$1: (pageId: string, language?: string) => _tanstack_react_query.UseQueryResult<types.Page, Error>;
 
 declare const usePage: (slug: string, language?: string) => _tanstack_react_query.UseQueryResult<types.Page, Error>;
@@ -1571,4 +1631,4 @@ declare const useAuth: () => {
     logoutUser: () => void;
 };
 
-export { Admin, AppSettings, Editor, File$1 as File, Icon, Image$1 as Image, JsonLd, Link, Login, MediaLibrary, Meta, PageViewer, _default as Plain, Playground, Preview, ReactBricks, Repeater, CompatibleRichText as RichText, RichText as RichTextExt, Slot, SsoLogin, SsoLoginFailure, SsoLoginSuccess, Text, blockPluginConstructor, blockWithModalPluginConstructor, cleanPage, fetchPage, fetchPages, fetchTags, getPagePlainText, getSchemaOrgData, markPluginConstructor, index as plugins, renderJsonLd, renderMeta, types, useAdminContext, useAuth, usePage$1 as usePage, usePage as usePagePublic, usePageValues, usePages, usePagesPublic, useReactBricksContext, useTagsPublic, useVisualEdit };
+export { Admin, AppSettings, Editor, File$1 as File, Icon, Image$1 as Image, JsonLd, Link, Login, MediaLibrary, Meta, PageViewer, _default as Plain, Playground, Preview, ReactBricks, Repeater, CompatibleRichText as RichText, RichText as RichTextExt, Slot, SsoLogin, SsoLoginFailure, SsoLoginSuccess, Text, blockPluginConstructor, blockWithModalPluginConstructor, cleanPage, fetchForms, fetchPage, fetchPages, fetchTags, getPagePlainText, getSchemaOrgData, markPluginConstructor, index as plugins, renderJsonLd, renderMeta, sendFormSubmission, types, useAdminContext, useAuth, usePage$1 as usePage, usePage as usePagePublic, usePageValues, usePages, usePagesPublic, useReactBricksContext, useTagsPublic, useVisualEdit };