react-bricks 5.0.0-alpha.1 → 5.0.0-alpha.10

package/react-bricks.d.ts

@@ -4,7 +4,6 @@ import { Descendant, Editor as Editor$1, BaseEditor, Element, Node } from 'slate
 import { RenderElementProps, RenderLeafProps, ReactEditor } from 'slate-react';
 import { HistoryEditor } from 'slate-history';
 import { Props } from 'react-inlinesvg';
-import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseQueryResult } from '@tanstack/react-query';
 export { v4 as uuid } from 'uuid';
 
@@ -229,6 +228,7 @@ declare namespace types {
             deployHookStaging: boolean;
             deployHookDev: boolean;
             scheduledPublishing: boolean;
+            abTesting: boolean;
             embedPages: boolean;
             lockBlocks: boolean;
             flexibleRoles: boolean;
@@ -271,6 +271,17 @@ declare namespace types {
         isLocked: boolean;
         scheduledForPublishingOn: string;
     };
+    /**
+     * Variant for a Page
+     */
+    export type Variant = {
+        name: string;
+        weight: number;
+        status: PageStatus;
+        scheduledForPublishingOn: string;
+        scheduledForUnpublishingOn: string;
+        isLive: boolean;
+    };
     /**
      * The page editing User
      */
@@ -324,6 +335,8 @@ declare namespace types {
         type: string;
         name: string;
         slug: string;
+        variantName: string;
+        variantWeight: number;
         meta: IMeta;
         customValues?: Props;
         externalData?: Props;
@@ -342,8 +355,10 @@ declare namespace types {
         createdAt: string;
         publishedAt?: string;
         scheduledForPublishingOn?: string;
+        scheduledForUnpublishingOn?: string;
         language: string;
         translations: Translation[];
+        variants: Variant[];
         lastEditedBy: LastEditedBy;
         app?: AppOnPage;
     };
@@ -429,6 +444,7 @@ declare namespace types {
      * Options passed to the fetch function
      */
     export type FetchOptions = {
+        apiPrefix?: string;
         cache?: string;
         next?: {
             [key: string]: any;
@@ -793,10 +809,12 @@ declare namespace types {
         enableUnsplash?: boolean;
         unsplashApiKey?: string;
         enableDefaultEmbedBrick?: boolean;
+        checkUnsavedChanges?: boolean;
         permissions?: Permissions;
         allowAccentsInSlugs?: boolean;
         warningIfLowBattery?: boolean;
         rtlLanguages?: Array<string>;
+        apiPrefix?: string;
     }
     /**
      * The ReactBricks context
@@ -844,6 +862,7 @@ declare namespace types {
         enableUnsplash: boolean;
         unsplashApiKey?: string;
         enableDefaultEmbedBrick: boolean;
+        checkUnsavedChanges: boolean;
         permissions?: Permissions;
         allowAccentsInSlugs: boolean;
         warningIfLowBattery: boolean;
@@ -851,6 +870,7 @@ declare namespace types {
             language: string;
         }) => boolean;
         rtlLanguages: string[];
+        apiPrefix?: string;
     }
     /**
      * The current page in Admin
@@ -858,6 +878,7 @@ declare namespace types {
     export interface ICurrentPage {
         pageId: string;
         language?: string;
+        variantName?: string;
     }
     /**
      * The Admin context returned from useAdminContext
@@ -992,9 +1013,9 @@ declare namespace types {
         name: string;
         svg: string;
         url: string;
-        set: string;
+        set: IconSets;
     };
-    export {  };
+    export {};
 }
 
 declare const useAdminContext: () => types.IReadAdminContext;
@@ -1273,7 +1294,7 @@ declare const ReactBricks: React.FC<types.ReactBricksConfig & {
  * Icon Props
  */
 interface IconProps extends Omit<Props, 'src'> {
-    icon: types.Icon;
+    icon?: types.Icon;
 }
 /**
  * Component to render an Icon from an IconSelector sideEditProp
@@ -1314,17 +1335,13 @@ interface SendFormSubmissionResult {
     statusCode: number;
     message: string;
 }
-declare const sendFormSubmission: ({ appId, appEnv, token, formId, emailAddress, data, }: SendFormSubmissionParams) => Promise<SendFormSubmissionResult>;
+declare const sendFormSubmission: ({ appId, appEnv, token, formId, emailAddress, data, fetchOptions, }: SendFormSubmissionParams) => Promise<SendFormSubmissionResult>;
 
-interface Form {
-    id: string;
-    name: string;
-}
-declare const fetchForms: () => Promise<Form[]>;
+declare const fetchForms: (fetchOptions?: types.FetchOptions) => Promise<any>;
 
-declare const usePage$1: (pageId: string, language?: string) => _tanstack_react_query.UseQueryResult<types.Page, Error>;
+declare const usePage$1: (pageId: string, language?: string, variantName?: string) => QueryObserverResult<TData, TError>;
 
-declare const usePage: (slug: string, language?: string) => _tanstack_react_query.UseQueryResult<types.Page, Error>;
+declare const usePage: (slug: string, language?: string, variantName?: string) => QueryObserverResult<TData, TError>;
 
 /**
  * Values returned from usePages
@@ -1395,23 +1412,17 @@ declare const usePagesPublic: UsePagesPublicType;
 declare const useTagsPublic: (page?: number, pageSize?: number, options?: {
     q?: string;
     language?: string;
-}) => _tanstack_react_query.UseQueryResult<{
-    items: string[];
-    pagination: {
-        page: number;
-        pageSize: number;
-        totalItems: number;
-        totalPages: number;
-    };
-}, Error>;
+}) => QueryObserverResult<TData, TError>;
 
 declare const useReactBricksContext: () => types.IReactBricksContext;
 
-declare function fetchPage({ slug, language, getExternalDataArgs, config, }: {
+declare function fetchPage({ slug, language, variantName, getExternalDataArgs, config, }: {
     slug: string;
     language?: string;
+    variantName?: string;
     getExternalDataArgs?: any;
     config: types.ReactBricksConfig;
+    fetchOptions?: types.FetchOptions;
 }): Promise<types.Page>;
 declare function fetchPage(slug: string, apiKey: string, language?: string, pageTypes?: types.IPageType[], getExternalDataArgs?: any): Promise<types.Page>;
 
@@ -1473,10 +1484,7 @@ declare function fetchPages<T extends boolean>(options: {
     config: types.ReactBricksConfig;
 }): Promise<types.PageFromList[]>;
 
-declare const fetchTags: (apiKey: string, page?: number, pageSize?: number, options?: {
-    q?: string;
-    language?: string;
-}) => Promise<{
+type FetchTagsResult = {
     items: string[];
     pagination: {
         page: number;
@@ -1484,7 +1492,21 @@ declare const fetchTags: (apiKey: string, page?: number, pageSize?: number, opti
         totalItems: number;
         totalPages: number;
     };
-}>;
+};
+declare function fetchTags(apiKey: string, page?: number, pageSize?: number, options?: {
+    q?: string;
+    language?: string;
+}, fetchOptions?: types.FetchOptions): Promise<FetchTagsResult>;
+declare function fetchTags(options: {
+    page?: number;
+    pageSize?: number;
+    filterBy?: {
+        q?: string;
+        language?: string;
+    };
+    config: types.ReactBricksConfig;
+    fetchOptions?: types.FetchOptions;
+}): Promise<FetchTagsResult>;
 
 declare const _default: {
     serialize: (nodes: Node[]) => string;
@@ -1531,7 +1553,24 @@ declare const plugin$1: types.RichTextPlugin;
 declare const plugin: types.RichTextPlugin;
 
 declare namespace index {
-  export { plugin$f as bold, plugin$d as code, plugin$8 as heading1, plugin$7 as heading2, plugin$6 as heading3, plugin$5 as heading4, plugin$4 as heading5, plugin$3 as heading6, plugin$c as highlight, plugin$e as italic, plugin$9 as link, plugin$1 as orderedList, plugin$2 as quote, plugin$b as sub, plugin$a as sup, plugin as unorderedList };
+  export {
+    plugin$f as bold,
+    plugin$d as code,
+    plugin$8 as heading1,
+    plugin$7 as heading2,
+    plugin$6 as heading3,
+    plugin$5 as heading4,
+    plugin$4 as heading5,
+    plugin$3 as heading6,
+    plugin$c as highlight,
+    plugin$e as italic,
+    plugin$9 as link,
+    plugin$1 as orderedList,
+    plugin$2 as quote,
+    plugin$b as sub,
+    plugin$a as sup,
+    plugin as unorderedList,
+  };
 }
 
 declare const AppSettings: React.FC;
@@ -1622,12 +1661,9 @@ declare const useAuth: () => {
         type: "error";
         error: string;
     }>;
-    isLoggingIn: boolean;
-    ssoStartLogin: (uniqueAppIdentifier: string) => Promise<{
-        result: "OK" | "KO";
-        redirectUrl: string;
-    } | null>;
-    isLogginInSso: boolean;
+    isLoggingIn: any;
+    ssoStartLogin: (uniqueAppIdentifier: string) => Promise<any>;
+    isLogginInSso: any;
     logoutUser: () => void;
 };