react-bricks 3.9.0 → 3.9.1-beta.0

package/react-bricks.d.ts

@@ -33,12 +33,12 @@ interface TextProps {
 declare const Text: React.FC<TextProps>;
 
 declare namespace types {
-    const EmbedProp = "RB_PAGE_EMBED";
-    const EmbedContent = "RB_PAGE_EMBED_CONTENT";
+    export const EmbedProp = "RB_PAGE_EMBED";
+    export const EmbedContent = "RB_PAGE_EMBED_CONTENT";
     /**
      * Type of Sidebar control
      */
-    enum SideEditPropType {
+    export enum SideEditPropType {
         Text = "TEXT",
         Textarea = "TEXTAREA",
         Number = "NUMBER",
@@ -53,7 +53,7 @@ declare namespace types {
     /**
      * How to display the options
      */
-    enum OptionsDisplay {
+    export enum OptionsDisplay {
         Select = "SELECT",
         Radio = "RADIO",
         Color = "COLOR"
@@ -61,7 +61,7 @@ declare namespace types {
     /**
      * Features for RichText: see also the new RichTextExt
      */
-    enum RichTextFeatures {
+    export enum RichTextFeatures {
         Bold = "BOLD",
         Italic = "ITALIC",
         Code = "CODE",
@@ -80,14 +80,14 @@ declare namespace types {
     /**
      * Page status
      */
-    enum PageStatus {
+    export enum PageStatus {
         Draft = "DRAFT",
         Published = "PUBLISHED"
     }
     /**
      * Device type for responsive preview (for the icon)
      */
-    enum DeviceType {
+    export enum DeviceType {
         Desktop = "DESKTOP",
         Tablet = "TABLET",
         Phone = "PHONE"
@@ -95,54 +95,54 @@ declare namespace types {
     /**
      * Corner for the click-to-edit button
      */
-    enum ClickToEditSide {
+    export enum ClickToEditSide {
         BottomRight = "BOTTOM-RIGHT",
         BottomLeft = "BOTTOM-LEFT",
         TopRight = "TOP-RIGHT",
         TopLeft = "TOP-LEFT",
         None = "NONE"
     }
-    enum BlockIconsPosition {
+    export enum BlockIconsPosition {
         InsideBlock = "INSIDE-BLOCK",
         OutsideBlock = "OUTSIDE-BLOCK"
     }
     /**
      * A Brick is a type of content block
      */
-    type Brick<T = {}> = React__default.FC<T> & {
+    export type Brick<T = {}> = React__default.FC<T> & {
         schema: IBlockType<T>;
     };
     /**
      * Bricks are types of content block
      */
-    type Bricks = {
+    export type Bricks = {
         [key: string]: Brick<any>;
     };
     /**
      * A Category contains bricks
      */
-    type Category = {
+    export type Category = {
         categoryName: string;
         bricks: Brick<any>[];
     };
     /**
      * A Theme contains categories and bricks
      */
-    type Theme = {
+    export type Theme = {
         themeName: string;
         categories: Category[];
     };
     /**
      * Custom role type
      */
-    type CustomRole = {
+    export type CustomRole = {
         id: string;
         name: string;
     };
     /**
      * The type of the user passed to permission functions
      */
-    type PermissionUser = {
+    export type PermissionUser = {
         firstName: string;
         lastName: string;
         email: string;
@@ -153,7 +153,7 @@ declare namespace types {
     /**
      * The type of the page passed to permission functions
      */
-    type PermissionPage = {
+    export type PermissionPage = {
         slug: string;
         pageType: string;
         language: string;
@@ -161,7 +161,7 @@ declare namespace types {
     /**
      * The type of the brick passed to permission functions
      */
-    type PermissionBrick = {
+    export type PermissionBrick = {
         name: string;
         category: string;
         theme: string;
@@ -170,7 +170,7 @@ declare namespace types {
     /**
      * The permission functions
      */
-    type Permissions = {
+    export type Permissions = {
         canAddPage?: (user: PermissionUser, pageType: string) => boolean;
         canAddTranslation?: (user: PermissionUser, pageType: string, language: string) => boolean;
         canSeePageType?: (user: PermissionUser, pageType: string) => boolean;
@@ -183,7 +183,7 @@ declare namespace types {
     /**
      * The logged-in User
      */
-    type User = {
+    export type User = {
         id: string;
         email: string;
         firstName: string;
@@ -230,14 +230,14 @@ declare namespace types {
     /**
      * Translation for a Page
      */
-    type Translation = {
+    export type Translation = {
         language: string;
         slug: string;
     };
     /**
      * A React Bricks Page
      */
-    type Page = {
+    export type Page = {
         id: string;
         type: string;
         name: string;
@@ -262,19 +262,19 @@ declare namespace types {
     /**
      * Page fields (without content)
      */
-    type PageValues = Omit<Page, 'content'>;
+    export type PageValues = Omit<Page, 'content'>;
     /**
      * A Page with all optional fields, used for the patch
      */
-    type PartialPage = Partial<Page>;
+    export type PartialPage = Partial<Page>;
     /**
      * Page from a list (no content)
      */
-    type PageFromList = Omit<Page, 'content'>;
+    export type PageFromList = Omit<Page, 'content'>;
     /**
      * Page from a list with pagination
      */
-    type PagesFromListWithPagination = {
+    export type PagesFromListWithPagination = {
         items: PageFromList[];
         pagination: {
             page: number;
@@ -283,7 +283,7 @@ declare namespace types {
             totalPages: number;
         };
     };
-    type PageWithTranslationsIdentifier = {
+    export type PageWithTranslationsIdentifier = {
         id: string;
         name: string;
         language: string;
@@ -294,7 +294,7 @@ declare namespace types {
     /**
      * The Author of a Page
      */
-    type Author = {
+    export type Author = {
         id: string;
         email: string;
         firstName: string;
@@ -302,7 +302,7 @@ declare namespace types {
         avatarUrl?: string;
         company?: string;
     };
-    type BrickStory<T = Props> = {
+    export type BrickStory<T = Props> = {
         id: string;
         name: string;
         showAsBrick?: boolean;
@@ -312,31 +312,32 @@ declare namespace types {
     /**
      * A Language for i18n
      */
-    type Language = {
+    export type Language = {
         code: string;
         name: string;
     };
     /**
      * Render function for local links (should use the app's Router)
      */
-    type RenderLocalLink = ({ href, target, className, activeClassName, isAdmin, children, }: {
+    interface LocalLinkProps {
         href: string;
         target?: string;
         className?: string;
         activeClassName?: string;
         isAdmin?: boolean;
-        children: React__default.ReactNode;
-    }) => React__default.ReactElement;
+    }
+    type LocalLinkPropsReal = React__default.PropsWithChildren<Omit<React__default.AnchorHTMLAttributes<HTMLAnchorElement>, keyof LocalLinkProps> & LocalLinkProps>;
+    export type RenderLocalLink = ({ href, target, className, activeClassName, isAdmin, children, }: LocalLinkPropsReal) => React__default.ReactElement;
     /**
      * Props of a content block
      */
-    type Props = {
+    export type Props = {
         [key: string]: any;
     };
     /**
      * Interface for the Schema of a Brick
      */
-    interface IBlockType<T = Props> {
+    export interface IBlockType<T = Props> {
         name: string;
         label: string;
         getDefaultProps?: () => Partial<T>;
@@ -358,7 +359,7 @@ declare namespace types {
     /**
      * Item of a Repeater
      */
-    interface IRepeaterItem {
+    export interface IRepeaterItem {
         name: string;
         itemType?: string;
         itemLabel?: string;
@@ -377,7 +378,7 @@ declare namespace types {
     /**
      * The content of a block (instance of a Brick)
      */
-    interface IContentBlock {
+    export interface IContentBlock {
         id: string;
         type: string;
         props: Props;
@@ -389,14 +390,14 @@ declare namespace types {
     /**
      * Option of a select sidebar prop
      */
-    interface IOption {
+    export interface IOption {
         value: any;
         label: string;
     }
     /**
      * Interface for Props of a Custom sidebar component
      */
-    interface ICustomKnobProps {
+    export interface ICustomKnobProps {
         id: string;
         value: any;
         onChange: any;
@@ -406,7 +407,7 @@ declare namespace types {
     /**
      * Sidebar edit Props for a Page
      */
-    interface ISideEditPropPage {
+    export interface ISideEditPropPage {
         name: string;
         label: string;
         type: SideEditPropType;
@@ -440,14 +441,14 @@ declare namespace types {
     /**
      * Sidebar Edit Props
      */
-    interface ISideEditProp extends ISideEditPropPage {
+    export interface ISideEditProp extends ISideEditPropPage {
         shouldRefreshText?: boolean;
         shouldRefreshStyles?: boolean;
     }
     /**
      * A collapsible Group of sidebar Props
      */
-    interface ISideGroup {
+    export interface ISideGroup {
         groupName: string;
         defaultOpen?: boolean;
         show?: (props: Props) => boolean;
@@ -456,7 +457,7 @@ declare namespace types {
     /**
      * Image value interface
      */
-    interface IImageSource {
+    export interface IImageSource {
         src: string;
         srcSet?: string;
         type?: string;
@@ -472,7 +473,7 @@ declare namespace types {
     /**
      * File value interface
      */
-    interface IFileSource {
+    export interface IFileSource {
         name: string;
         url: string;
         size: number;
@@ -480,11 +481,11 @@ declare namespace types {
     /**
      * A Color for a Select sidebar prop
      */
-    interface IColor {
+    export interface IColor {
         color: string;
         [propName: string]: any;
     }
-    interface IBrickStory {
+    export interface IBrickStory {
         brickName: string;
         storyName: string;
         locked?: boolean;
@@ -494,7 +495,7 @@ declare namespace types {
     /**
      * Page type
      */
-    interface IPageType {
+    export interface IPageType {
         name: string;
         pluralName: string;
         isEntity?: boolean;
@@ -506,21 +507,21 @@ declare namespace types {
         defaultFeaturedImage?: string;
         getDefaultContent?: () => (string | IBrickStory | IContentBlock)[];
         customFields?: Array<ISideEditPropPage | ISideGroup>;
-        getExternalData?: (page: Page) => Promise<Props>;
+        getExternalData?: (page: Page, args?: any) => Promise<Props>;
         metaImageAspectRatio?: number;
         categories?: ICategory[];
     }
     /**
      * Structure returned by the cleanBlocks function
      */
-    interface ICleanBlocks {
+    export interface ICleanBlocks {
         blocks: IContentBlock[];
         invalidBlocksTypes: string[];
     }
     /**
      * Responsive breakpoint for preview
      */
-    interface ResponsiveBreakpoint {
+    export interface ResponsiveBreakpoint {
         type: DeviceType;
         width: number | string;
         label: string;
@@ -528,7 +529,7 @@ declare namespace types {
     /**
      * Login UI customization
      */
-    interface LoginUI {
+    export interface LoginUI {
         sideImage?: string;
         logo?: string;
         logoWidth?: number;
@@ -539,14 +540,14 @@ declare namespace types {
     /**
      * MenuItem interface
      */
-    interface IMenuItem {
+    export interface IMenuItem {
         label: string;
         path?: string;
     }
     /**
      * The ReactBricks configuration
      */
-    interface ReactBricksConfig {
+    export interface ReactBricksConfig {
         appId: string;
         apiKey: string;
         bricks?: types.Brick<any>[] | types.Theme[];
@@ -586,7 +587,7 @@ declare namespace types {
     /**
      * The ReactBricks context
      */
-    interface IReactBricksContext {
+    export interface IReactBricksContext {
         version: string;
         appId: string;
         apiKey: string;
@@ -632,7 +633,7 @@ declare namespace types {
     /**
      * The Admin context returned from useAdminContext
      */
-    interface IReadAdminContext {
+    export interface IReadAdminContext {
         isAdmin: boolean;
         previewMode: boolean;
         currentPage: ICurrentPage;
@@ -640,7 +641,7 @@ declare namespace types {
     /**
      * Meta fields on Page
      */
-    interface IMeta {
+    export interface IMeta {
         title?: string;
         description?: string;
         language?: string;
@@ -650,13 +651,13 @@ declare namespace types {
     /**
      * Category on categories (pageTypes)
      */
-    interface ICategory {
+    export interface ICategory {
         category?: string;
     }
     /**
      * A RichTextExt Plugin
      */
-    interface RichTextPlugin {
+    export interface RichTextPlugin {
         type: 'Mark' | 'Block' | 'List';
         name: string;
         isInline?: boolean;
@@ -676,7 +677,7 @@ declare namespace types {
     /**
      * Definition for a Mark plugin
      */
-    interface MarkPlugin {
+    export interface MarkPlugin {
         name: string;
         label?: string;
         hotKey?: string;
@@ -686,11 +687,11 @@ declare namespace types {
     /**
      * Constructor for a Mark plugin
      */
-    type MarkPluginConstructor = (markPlugin: MarkPlugin) => RichTextPlugin;
+    export type MarkPluginConstructor = (markPlugin: MarkPlugin) => RichTextPlugin;
     /**
      * Definition for a Block plugin
      */
-    interface BlockPlugin {
+    export interface BlockPlugin {
         name: string;
         isInline?: boolean;
         itemName?: string;
@@ -703,7 +704,8 @@ declare namespace types {
     /**
      * Constructor for a Block plugin
      */
-    type BlockPluginConstructor = (blockPlugin: BlockPlugin) => RichTextPlugin;
+    export type BlockPluginConstructor = (blockPlugin: BlockPlugin) => RichTextPlugin;
+    export {};
 }
 
 /**
@@ -836,9 +838,9 @@ interface LinkProps {
     className?: string;
     activeClassName?: string;
     simpleAnchor?: boolean;
-    children?: React.ReactNode;
 }
-declare const Link: React.FC<LinkProps>;
+declare type LinkPropsReal = React.PropsWithChildren<Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, keyof LinkProps> & LinkProps>;
+declare const Link: React.FC<LinkPropsReal>;
 
 declare const useAdminContext: () => types.IReadAdminContext;
 
@@ -950,7 +952,7 @@ declare const useTagsPublic: (page?: number, pageSize?: number) => react_query.U
 
 declare const useReactBricksContext: () => types.IReactBricksContext;
 
-declare const fetchPage: (slug: string, apiKey: string, language?: string, pageTypes?: types.IPageType[]) => Promise<types.Page>;
+declare const fetchPage: (slug: string, apiKey: string, language?: string, pageTypes?: types.IPageType[], getExternalDataArgs?: any) => Promise<types.Page>;
 
 /**
  * Values returned from fetchPages