react-bricks 3.12.4 → 4.0.0-alpha.1

package/react-bricks.d.ts

@@ -3,7 +3,23 @@ import React__default from 'react';
 import { BaseEditor, Descendant, Editor as Editor$1, Node } from 'slate';
 import { HistoryEditor } from 'slate-history';
 import { ReactEditor, RenderElementProps, RenderLeafProps } from 'slate-react';
-import styleInject from '../node_modules/style-inject/dist/style-inject.es.js';
+import { ArticleSchemaOrgType, ArticleSchema } from 'admin/Editor/ContentEditor/Sidebar/EditDocument/AdvancedSeo/components/SchemaOrgForms/ArticleForm';
+import { BreadCrumbSchemaOrgType, BreadCrumbSchema } from 'admin/Editor/ContentEditor/Sidebar/EditDocument/AdvancedSeo/components/SchemaOrgForms/BreadcrumbForm';
+import { EventSchemaOrgType, EventSchema } from 'admin/Editor/ContentEditor/Sidebar/EditDocument/AdvancedSeo/components/SchemaOrgForms/EventForm';
+import { FaqSchemaOrgType, FaqSchema } from 'admin/Editor/ContentEditor/Sidebar/EditDocument/AdvancedSeo/components/SchemaOrgForms/FaqForm';
+import { HowToSchemaOrgType, HowToSchema } from 'admin/Editor/ContentEditor/Sidebar/EditDocument/AdvancedSeo/components/SchemaOrgForms/HowToForm';
+import { JobPostingSchemaOrgType, JobPostingSchema } from 'admin/Editor/ContentEditor/Sidebar/EditDocument/AdvancedSeo/components/SchemaOrgForms/JobPostingForm';
+import { LocalBusinessSchemaOrgType, LocalBusinessSchema } from 'admin/Editor/ContentEditor/Sidebar/EditDocument/AdvancedSeo/components/SchemaOrgForms/LocalBusinessForm';
+import { OrganizationSchemaOrgType, OrganizationSchema } from 'admin/Editor/ContentEditor/Sidebar/EditDocument/AdvancedSeo/components/SchemaOrgForms/OrganizationForm';
+import { PersonSchemaOrgType, PersonSchema } from 'admin/Editor/ContentEditor/Sidebar/EditDocument/AdvancedSeo/components/SchemaOrgForms/PersonForm';
+import { ProductSchemaOrgType, ProductSchema } from 'admin/Editor/ContentEditor/Sidebar/EditDocument/AdvancedSeo/components/SchemaOrgForms/ProductForm';
+import { RecipeSchemaOrgType, RecipeSchema } from 'admin/Editor/ContentEditor/Sidebar/EditDocument/AdvancedSeo/components/SchemaOrgForms/RecipeForm';
+import { ThingSchemaOrgType, ThingSchema } from 'admin/Editor/ContentEditor/Sidebar/EditDocument/AdvancedSeo/components/SchemaOrgForms/ThingForm';
+import { VideoSchemaOrgType, VideoSchema } from 'admin/Editor/ContentEditor/Sidebar/EditDocument/AdvancedSeo/components/SchemaOrgForms/VideoForm';
+import { WebsiteSchemaOrgType, WebsiteSchema } from 'admin/Editor/ContentEditor/Sidebar/EditDocument/AdvancedSeo/components/SchemaOrgForms/WebsiteForm';
+import { types as types$1 } from 'frontend';
+import { File as File$1 } from 'admin/Editor/ContentEditor/wysiwyg/File/types';
+import { Image as Image$1 } from 'admin/Editor/ContentEditor/wysiwyg/Image/types';
 import * as react_query from 'react-query';
 import { UseQueryResult } from 'react-query';
 export { v4 as uuid } from 'uuid';
@@ -472,6 +488,25 @@ declare namespace types {
         show?: (props: Props) => boolean;
         props: ISideEditProp[] | ISideEditPropPage[];
     }
+    /**
+     * Image Crop interface
+     */
+    export interface ICrop {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    }
+    /**
+     * Image Transform interface
+     */
+    export interface ITransform {
+        rotate?: number;
+        flip?: {
+            horizontal: boolean;
+            vertical: boolean;
+        };
+    }
     /**
      * Image value interface
      */
@@ -488,6 +523,9 @@ declare namespace types {
         width?: number;
         height?: number;
         highPriority?: boolean;
+        hashId?: string;
+        crop?: ICrop;
+        transform?: ITransform;
     }
     /**
      * File value interface
@@ -496,6 +534,12 @@ declare namespace types {
         name: string;
         url: string;
         size: number;
+        extension: string;
+        pagesNum: number;
+        title?: string | undefined;
+        alt?: string | undefined;
+        copyright?: string | undefined;
+        source?: string | undefined;
     }
     /**
      * A Color for a Select sidebar prop
@@ -569,6 +613,7 @@ declare namespace types {
     export interface ReactBricksConfig {
         appId: string;
         apiKey: string;
+        environment?: string;
         bricks?: types.Brick<any>[] | types.Theme[];
         pageTypes?: types.IPageType[];
         logo?: string;
@@ -579,6 +624,7 @@ declare namespace types {
         navigate: (path: string) => void;
         loginPath?: string;
         editorPath?: string;
+        mediaLibraryPath?: string;
         playgroundPath?: string;
         appSettingsPath?: string;
         previewPath?: string;
@@ -610,6 +656,7 @@ declare namespace types {
         version: string;
         appId: string;
         apiKey: string;
+        environment?: string;
         bricks: Bricks;
         themes: types.Theme[];
         pageTypes: IPageType[];
@@ -621,6 +668,7 @@ declare namespace types {
         navigate: (path: string) => void;
         loginPath: string;
         editorPath: string;
+        mediaLibraryPath: string;
         playgroundPath: string;
         appSettingsPath: string;
         previewPath: string;
@@ -658,14 +706,58 @@ declare namespace types {
         currentPage: ICurrentPage;
     }
     /**
-     * Meta fields on Page
+     * 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;
+    };
+    /** Schema.org type */
+    export type SchemaOrgType = ArticleSchemaOrgType | BreadCrumbSchemaOrgType | EventSchemaOrgType | FaqSchemaOrgType | HowToSchemaOrgType | JobPostingSchemaOrgType | LocalBusinessSchemaOrgType | OrganizationSchemaOrgType | PersonSchemaOrgType | ProductSchemaOrgType | RecipeSchemaOrgType | ThingSchemaOrgType | VideoSchemaOrgType | WebsiteSchemaOrgType;
+    /**
+     * Schema.org data
      */
-    export interface IMeta {
+    export type SchemaOrgData = ArticleSchema | BreadCrumbSchema | EventSchema | FaqSchema | HowToSchema | JobPostingSchema | LocalBusinessSchema | OrganizationSchema | PersonSchema | ProductSchema | RecipeSchema | ThingSchema | VideoSchema | WebsiteSchema;
+    /**
+     * Meta Fields type
+     * */
+    export type MetaData = {
         title?: string;
         description?: string;
+        keywords?: string;
+    };
+    /**
+     * Meta fields on Page
+     */
+    export interface IMeta extends MetaData {
         language?: string;
         featuredImage?: string;
         image?: IImageSource;
+        openGraph?: OpenGraphData;
+        twitterCard?: TwitterCardData;
+        schemaOrg?: SchemaOrgData;
     }
     /**
      * Category on categories (pageTypes)
@@ -919,6 +1011,18 @@ declare const PageViewer: React.FC<PageViewerProps>;
  */
 declare const Preview: React.FC;
 
+declare const Meta: React.FC<types$1.IMeta>;
+
+declare const renderMeta: React.FC<types$1.IMeta>;
+
+interface JsonLdProps {
+    type: types$1.SchemaOrgType;
+    values: types$1.SchemaOrgData;
+}
+declare const JsonLd: React__default.FC<JsonLdProps>;
+
+declare const renderJsonLd: React__default.FC<types$1.IMeta>;
+
 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>;
@@ -1117,8 +1221,11 @@ declare const Playground: () => React.JSX.Element;
 
 declare const AppSettings: React.FC;
 
-var css_248z = ".tippy-box[data-animation=fade][data-state=hidden]{opacity:0}[data-tippy-root]{max-width:calc(100vw - 10px)}.tippy-box{background-color:#333;border-radius:4px;color:#fff;font-size:14px;line-height:1.4;outline:0;position:relative;transition-property:transform,visibility,opacity}.tippy-box[data-placement^=top]>.tippy-arrow{bottom:0}.tippy-box[data-placement^=top]>.tippy-arrow:before{border-top-color:initial;border-width:8px 8px 0;bottom:-7px;left:0;transform-origin:center top}.tippy-box[data-placement^=bottom]>.tippy-arrow{top:0}.tippy-box[data-placement^=bottom]>.tippy-arrow:before{border-bottom-color:initial;border-width:0 8px 8px;left:0;top:-7px;transform-origin:center bottom}.tippy-box[data-placement^=left]>.tippy-arrow{right:0}.tippy-box[data-placement^=left]>.tippy-arrow:before{border-left-color:initial;border-width:8px 0 8px 8px;right:-7px;transform-origin:center left}.tippy-box[data-placement^=right]>.tippy-arrow{left:0}.tippy-box[data-placement^=right]>.tippy-arrow:before{border-right-color:initial;border-width:8px 8px 8px 0;left:-7px;transform-origin:center right}.tippy-box[data-inertia][data-state=visible]{transition-timing-function:cubic-bezier(.54,1.5,.38,1.11)}.tippy-arrow{color:#333;height:16px;width:16px}.tippy-arrow:before{border-color:transparent;border-style:solid;content:\"\";position:absolute}.tippy-content{padding:5px 9px;position:relative;z-index:1}";
-styleInject(css_248z);
+interface MediaLibraryProps {
+    onSelect?: (media: Image$1 | File$1, crop?: types$1.ICrop, transform?: types$1.ITransform) => void;
+    popup?: 'image' | 'file';
+}
+declare const MediaLibrary: React__default.FC<MediaLibraryProps>;
 
 declare const Admin: React.FC<AdminProps>;
 
@@ -1179,4 +1286,4 @@ declare const useAuth: () => {
     logoutUser: () => void;
 };
 
-export { Admin, AdminContext, AppSettings, Editor, File, Header, Image, Link, Login, 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, types, useAdminContext, useAuth, usePage$1 as usePage, usePage as usePagePublic, usePageValues, usePages, usePagesPublic, useReactBricksContext, useTagsPublic, useVisualEdit };
+export { Admin, AdminContext, AppSettings, Editor, File, Header, 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 };