react-bricks 4.0.0-beta.4 → 4.0.0-beta.5

package/react-bricks.d.ts

@@ -1,12 +1,28 @@
 import * as React from 'react';
 import React__default from 'react';
-import { BaseEditor, Descendant, Editor as Editor$1, Node } from 'slate';
+import { BaseEditor, Element, Descendant, Editor as Editor$1, Node } from 'slate';
 import { HistoryEditor } from 'slate-history';
 import { ReactEditor, RenderElementProps, RenderLeafProps } from 'slate-react';
 import * as react_query from 'react-query';
 import { UseQueryResult } from 'react-query';
 export { v4 as uuid } from 'uuid';
 
+/**
+ * CustomElement for Slate
+ */
+declare type CustomElement = {
+    type: string;
+    element?: Element;
+    children: CustomText[];
+    [key: string]: any;
+};
+/**
+ * CustomText for Slate
+ */
+declare type CustomText = {
+    text?: string;
+    [key: string]: any;
+};
 declare module 'slate' {
     interface CustomTypes {
         Editor: BaseEditor & ReactEditor & HistoryEditor;
@@ -304,14 +320,6 @@ declare namespace types {
             totalPages: number;
         };
     };
-    export type PageWithTranslationsIdentifier = {
-        id: string;
-        name: string;
-        language: string;
-        key: string;
-        slug: string;
-        slugDefaultLanguage: string;
-    };
     /**
      * The Author of a Page
      */
@@ -438,7 +446,7 @@ declare namespace types {
         type: SideEditPropType;
         component?: React__default.FC<ICustomKnobProps>;
         validate?: (value: any, props?: Props) => boolean | string;
-        show?: (props: Props) => boolean;
+        show?: (props: Props, page: Page, user: User) => boolean;
         helperText?: string;
         textareaOptions?: {
             height?: number;
@@ -461,6 +469,7 @@ declare namespace types {
             label?: string;
             references: string;
             multiple: boolean;
+            embedValues?: boolean;
         };
     }
     /**
@@ -564,6 +573,12 @@ declare namespace types {
         getExternalData?: (page: Page, args?: any) => Promise<Props>;
         metaImageAspectRatio?: number;
         categories?: ICategory[];
+        slugPrefix?: {
+            default: string;
+            translations?: {
+                [key: string]: string;
+            };
+        };
     }
     /**
      * Structure returned by the cleanBlocks function
@@ -639,6 +654,7 @@ declare namespace types {
         unsplashApiKey?: string;
         enableDefaultEmbedBrick?: boolean;
         permissions?: Permissions;
+        allowAccentsInSlugs?: boolean;
     }
     /**
      * The ReactBricks context
@@ -687,6 +703,7 @@ declare namespace types {
         unsplashApiKey?: string;
         enableDefaultEmbedBrick: boolean;
         permissions?: Permissions;
+        allowAccentsInSlugs: boolean;
     }
     /**
      * The current page in Admin
@@ -703,6 +720,35 @@ declare namespace types {
         previewMode: boolean;
         currentPage: ICurrentPage;
     }
+    /**
+     * Opengraph type
+     */
+    export type OpenGraphType = 'article' | 'website' | 'profile' | 'book' | 'video' | 'music';
+    /**
+     * OpenGraph data
+     */
+    export type OpenGraphData = {
+        url: string;
+        type: OpenGraphType;
+        title: string;
+        description: string;
+        image: types.IImageSource;
+    };
+    /**
+     * Twitter card type
+     */
+    export type TwitterCardType = 'summary' | 'summary_large_image' | 'app' | 'player';
+    /**
+     * Data for Twitter card
+     */
+    export type TwitterCardData = {
+        card: TwitterCardType;
+        site: string;
+        creator: string;
+        title: string;
+        description: string;
+        image: types.IImageSource;
+    };
     /**
      * Meta Fields type
      * */
@@ -954,12 +1000,15 @@ declare const blockPluginConstructor: types.BlockPluginConstructor;
 
 declare const markPluginConstructor: types.MarkPluginConstructor;
 
+/**
+ * Props for PageViewer
+ */
+declare const Preview: React.FC;
+
 declare const ReactBricks: React.FC<types.ReactBricksConfig & {
     children: React.ReactNode;
 }>;
 
-declare const ReactBricksContext: React.Context<types.IReactBricksContext>;
-
 /**
  * Props for PageViewer
  */
@@ -969,15 +1018,6 @@ interface PageViewerProps {
 }
 declare const PageViewer: React.FC<PageViewerProps>;
 
-/**
- * Props for PageViewer
- */
-declare const Preview: React.FC;
-
-declare const Meta: React.FC<types.IMeta>;
-
-declare const renderMeta: React.FC<types.Page>;
-
 interface JsonLdProps {
     type: types.SchemaOrgType;
     values: types.SchemaOrgData;
@@ -986,6 +1026,10 @@ declare const JsonLd: React__default.FC<JsonLdProps>;
 
 declare const renderJsonLd: React__default.FC<types.Page>;
 
+declare const Meta: React.FC<types.IMeta>;
+
+declare const renderMeta: React.FC<types.Page>;
+
 declare const usePage$1: (pageId: string, language?: string) => react_query.UseQueryResult<types.Page, unknown>;
 
 declare const usePage: (slug: string, language?: string) => react_query.UseQueryResult<types.Page, unknown>;
@@ -1071,40 +1115,71 @@ declare const useTagsPublic: (page?: number, pageSize?: number, options?: {
 
 declare const useReactBricksContext: () => types.IReactBricksContext;
 
-declare const fetchPage: (slug: string, apiKey: string, language?: string, pageTypes?: types.IPageType[], getExternalDataArgs?: any) => Promise<types.Page>;
+declare function fetchPage({ slug, language, getExternalDataArgs, config, }: {
+    slug: string;
+    language?: string;
+    getExternalDataArgs?: any;
+    config: types.ReactBricksConfig;
+}): Promise<types.Page>;
+declare function fetchPage(slug: string, apiKey: string, language?: string, pageTypes?: types.IPageType[], getExternalDataArgs?: any): Promise<types.Page>;
 
-/**
- * Values returned from fetchPages
- */
-interface FetchPagesType {
-    <T extends boolean>(apiKey: string, { type, types, tag, language, page, pageSize, sort, filterBy, usePagination, }: {
-        type?: string;
-        types?: string[];
-        tag?: string;
-        language?: string;
-        page?: number;
-        pageSize?: number;
-        sort?: string;
-        filterBy?: {
-            [key: string]: any;
-        };
-        usePagination: T;
-    }): Promise<T extends true ? types.PagesFromListWithPagination : types.PageFromList[]>;
-    (apiKey: string, { type, types, tag, language, page, pageSize, filterBy, sort, }: {
-        type?: string;
-        types?: string[];
-        tag?: string;
-        language?: string;
-        page?: number;
-        pageSize?: number;
-        sort?: string;
-        filterBy?: {
-            [key: string]: any;
-        };
-    }): Promise<types.PageFromList[]>;
-    (apiKey: string): Promise<types.PageFromList[]>;
-}
-declare const fetchPages: FetchPagesType;
+declare function fetchPages<T extends boolean>(apiKey: string, { type, types, tag, language, page, pageSize, sort, filterBy, usePagination, }: {
+    type?: string;
+    types?: string[];
+    tag?: string;
+    language?: string;
+    page?: number;
+    pageSize?: number;
+    sort?: string;
+    filterBy?: {
+        [key: string]: any;
+    };
+    usePagination: T;
+}): Promise<T extends true ? types.PagesFromListWithPagination : types.PageFromList[]>;
+declare function fetchPages(apiKey: string, { type, types, tag, language, page, pageSize, filterBy, sort, }: {
+    type?: string;
+    types?: string[];
+    tag?: string;
+    language?: string;
+    page?: number;
+    pageSize?: number;
+    sort?: string;
+    filterBy?: {
+        [key: string]: any;
+    };
+}): Promise<types.PageFromList[]>;
+declare function fetchPages(apiKey: string): Promise<types.PageFromList[]>;
+declare function fetchPages<T extends boolean>(options: {
+    type?: string;
+    types?: string[];
+    tag?: string;
+    language?: string;
+    page?: number;
+    pageSize?: number;
+    sort?: string;
+    filterBy?: {
+        [key: string]: any;
+    };
+    usePagination: T;
+    fetchExternalData?: boolean;
+    getExternalDataArgs?: any;
+    config: types.ReactBricksConfig;
+}): Promise<T extends true ? types.PagesFromListWithPagination : types.PageFromList[]>;
+declare function fetchPages<T extends boolean>(options: {
+    type?: string;
+    types?: string[];
+    tag?: string;
+    language?: string;
+    page?: number;
+    pageSize?: number;
+    sort?: string;
+    filterBy?: {
+        [key: string]: any;
+    };
+    fetchExternalData?: boolean;
+    getExternalDataArgs?: any;
+    config: types.ReactBricksConfig;
+}): Promise<types.PageFromList[]>;
 
 declare const fetchTags: (apiKey: string, page?: number, pageSize?: number, options?: {
     q?: string;
@@ -1119,10 +1194,6 @@ declare const fetchTags: (apiKey: string, page?: number, pageSize?: number, opti
     };
 }>;
 
-declare const cleanPage: (page: types.Page, pageTypes: types.IPageType[], bricks: types.Bricks) => types.Page;
-
-declare const getPagePlainText: (blocks: types.IContentBlock[]) => string[];
-
 declare const _default: {
     serialize: (nodes: Node[]) => string;
     serializeLight: (nodes: any[]) => string | any[];
@@ -1131,6 +1202,10 @@ declare const _default: {
     isSlateContent: (value: any) => boolean;
 };
 
+declare const cleanPage: (page: types.Page, pageTypes: types.IPageType[], bricks: types.Bricks) => types.Page;
+
+declare const getPagePlainText: (blocks: types.IContentBlock[]) => string[];
+
 declare const plugin$d: types.RichTextPlugin;
 
 declare const plugin$c: types.RichTextPlugin;
@@ -1233,12 +1308,16 @@ interface MediaLibraryProps {
 }
 declare const MediaLibrary: React__default.FC<MediaLibraryProps>;
 
+/**
+ * Props of Admin component
+ */
+interface AdminProps extends React.PropsWithChildren {
+    isLogin?: boolean;
+    isPublicDesignSystem?: boolean;
+    designSystemTitle?: string;
+}
 declare const Admin: React.FC<AdminProps>;
 
-declare const AdminContext: React.Context<types.IAdminContext>;
-
-declare const Header: React.FC<HeaderProps>;
-
 declare const Login: React.FC;
 
 declare const useAuth: () => {
@@ -1300,4 +1379,4 @@ declare const useAuth: () => {
     logoutUser: () => void;
 };
 
-export { Admin, AdminContext, AppSettings, Editor, File$1 as File, Header, Image$1 as Image, JsonLd, Link, Login, MediaLibrary, Meta, PageViewer, _default as Plain, Playground, Preview, ReactBricks, ReactBricksContext, Repeater, CompatibleRichText as RichText, RichText as RichTextExt, Text, blockPluginConstructor, cleanPage, fetchPage, fetchPages, fetchTags, getPagePlainText, 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, Image$1 as Image, JsonLd, Link, Login, MediaLibrary, Meta, PageViewer, _default as Plain, Playground, Preview, ReactBricks, Repeater, CompatibleRichText as RichText, RichText as RichTextExt, Text, blockPluginConstructor, cleanPage, fetchPage, fetchPages, fetchTags, getPagePlainText, markPluginConstructor, index as plugins, renderJsonLd, renderMeta, types, useAdminContext, useAuth, usePage$1 as usePage, usePage as usePagePublic, usePageValues, usePages, usePagesPublic, useReactBricksContext, useTagsPublic, useVisualEdit };