@webiny/website-builder-sdk 0.0.0-unstable.06b2ede40f

package/types.d.ts

@@ -0,0 +1,295 @@
+import type * as CSS from "csstype";
+import type { BindingsApi } from "./BindingsApi";
+import type { ShorthandCssProperties } from "./types/ShorthandCssProperties";
+export type { WebsiteBuilderTheme, Breakpoint } from "./types/WebsiteBuilderTheme";
+interface CSSProperties extends CSS.Properties<string | number> {
+}
+export type ElementMap = Record<string, DocumentElement>;
+export type DocumentState = Record<string, any>;
+export type InputValueBinding<T = any> = ValueBinding<T> & {
+    id: string;
+    type: string;
+    translatable?: boolean;
+    list?: boolean;
+};
+export type StyleValueBinding<T = any> = ValueBinding<T>;
+export type ValueBinding<T = any> = {
+    static?: T;
+    expression?: string;
+};
+export type RepeatValueBinding = {
+    expression: string;
+};
+export type CssProperties = Omit<CSSProperties, ShorthandCssProperties>;
+export type DocumentElementStyleBindings = Partial<{
+    [K in keyof CssProperties]: StyleValueBinding<CssProperties[K]>;
+}>;
+export type DocumentElementInputBindings = {
+    [inputName: string]: InputValueBinding;
+};
+export type DocumentElementBindings = {
+    $repeat?: RepeatValueBinding;
+    inputs?: DocumentElementInputBindings;
+    styles?: DocumentElementStyleBindings;
+    metadata?: Record<string, any>;
+    overrides?: {
+        [key: string]: {
+            inputs?: DocumentElementInputBindings;
+            styles?: DocumentElementStyleBindings;
+        };
+    };
+};
+export type DocumentBindings = {
+    [elementId: string]: DocumentElementBindings;
+};
+export type ResolvedComponent<TComponent = any> = {
+    component: TComponent;
+    inputs: Record<string, any>;
+    manifest: ComponentManifest;
+    styles: SerializableCSSStyleDeclaration;
+};
+export type ResolvedElement = {
+    id: string;
+    inputs: Record<string, any>;
+    styles: SerializableCSSStyleDeclaration;
+};
+export type Component = {
+    component: any;
+    manifest: ComponentManifest;
+};
+export type ComponentGroupItem = {
+    name: string;
+    item?: DocumentElementTemplate;
+};
+export type SerializedComponentGroup = ComponentGroup & {
+    filter?: string;
+};
+export type ComponentGroupFilterContext = {
+    document: EditorDocument;
+};
+export type ComponentGroup = {
+    name: string;
+    label: string;
+    description?: string;
+    filter?: (component: ComponentManifest, context: ComponentGroupFilterContext) => boolean;
+};
+export type ResponsiveStyles = {
+    [key: string]: SerializableCSSStyleDeclaration;
+};
+export type ComponentManifest = {
+    name: string;
+    group?: string;
+    label?: string;
+    image?: string;
+    inputs?: ComponentInput[];
+    canDrag?: boolean;
+    canDelete?: boolean;
+    acceptsChildren?: boolean;
+    hideFromToolbar?: boolean;
+    hideStyleSettings?: string[];
+    autoApplyStyles?: boolean;
+    tags?: string[];
+    defaults?: {
+        inputs?: Record<string, any>;
+        styles?: SerializableCSSStyleDeclaration;
+        overrides?: {
+            [breakpoint: string]: {
+                inputs?: Record<string, any>;
+                styles?: SerializableCSSStyleDeclaration;
+            };
+        };
+    };
+};
+export type DocumentElementTemplate = Omit<DocumentElement, "id">;
+export type ElementComponent = {
+    name: string;
+};
+export type DocumentElement = {
+    type: "Webiny/Element";
+    id: string;
+    component: ElementComponent;
+    parent?: {
+        id: string;
+        slot: string;
+    };
+    styles?: ResponsiveStyles;
+};
+export type SerializableCSSStyleDeclaration = {
+    [K in keyof CssProperties]?: CssProperties[K];
+};
+export type Document = {
+    id: string;
+    state: DocumentState;
+    version: number;
+    properties: Record<string, any>;
+    bindings: DocumentBindings;
+    elements: ElementMap;
+};
+export type PublicPage = Pick<Page, "id" | "version" | "properties" | "bindings" | "elements" | "state">;
+export type PublicRedirect = {
+    id: string;
+    from: string;
+    to: string;
+    permanent: boolean;
+};
+export type EditorPage = EditorDocument & Pick<Page, "properties" | "status" | "location">;
+export type EditorDocument = Document & {
+    metadata: Record<string, any>;
+};
+export type Page = Document & {
+    id: string;
+    status: string;
+    version: number;
+    location: {
+        folderId: string;
+    };
+    properties: {
+        title: string;
+        snippet: string;
+        path: string;
+        tags: string[];
+        seo: {
+            title: string;
+            description: string;
+            metaTags: Array<{
+                name: string;
+                content: string;
+            }>;
+        };
+        social: {
+            title: string;
+            description: string;
+            metaTags: Array<{
+                property: string;
+                content: string;
+            }>;
+        };
+    };
+};
+export type Box = {
+    depth: number;
+    parentId: string;
+    parentSlot: string;
+    parentIndex: number;
+    width: number;
+    height: number;
+    top: number;
+    left: number;
+};
+export type ElementBoxData = Box & {
+    type: "element";
+};
+export type ElementSlotBoxData = Box & {
+    type: "element-slot";
+};
+export type BoxData = ElementBoxData | ElementSlotBoxData;
+export type EditorViewportInfo = PreviewViewportInfo & {
+    top: number;
+    left: number;
+};
+export type PreviewViewportInfo = {
+    width: number;
+    height: number;
+    scrollX: number;
+    scrollY: number;
+};
+export type BoxesData = Record<string, BoxData>;
+export type EditorViewportData = {
+    boxes: BoxesData;
+    viewport: EditorViewportInfo;
+};
+export type PreviewViewportData = {
+    boxes: BoxesData;
+    viewport: PreviewViewportInfo;
+};
+export type ApiOptions = Record<string, any>;
+export type GetPageOptions = ApiOptions;
+export type ListPagesOptions = ApiOptions;
+export interface IDataProvider {
+    getPageByPath(path: string, options?: GetPageOptions): Promise<PublicPage | null>;
+    getPageById(id: string, options?: GetPageOptions): Promise<PublicPage | null>;
+    listPages(options?: ListPagesOptions): Promise<PublicPage[]>;
+}
+export interface IEnvironment {
+    isClient(): boolean;
+    isServer(): boolean;
+    isPreview(): boolean;
+}
+export interface IContentSdk {
+    getPage(path: string): Promise<PublicPage | null>;
+    listPages(options?: ListPagesOptions): Promise<PublicPage[]>;
+}
+export type BaseInput<T = any> = {
+    name: string;
+    type: string;
+    onChange?: (bindings: ReturnType<BindingsApi["getPublicApi"]>, context: {
+        breakpoint: string;
+    }) => void;
+    label?: string;
+    description?: string;
+    helperText?: string;
+    defaultValue?: T;
+    responsive?: boolean;
+    required?: boolean;
+    hideFromUi?: boolean;
+    renderer?: string;
+    list?: boolean;
+    translatable?: boolean;
+};
+export type TextInput = BaseInput<string> & {
+    type: "text";
+};
+export type SlotInput = BaseInput<any> & {
+    type: "slot";
+    components?: string[];
+};
+export type TagsInput = BaseInput<string[]> & {
+    type: "text";
+};
+export type LongTextInput = BaseInput<string> & {
+    type: "longText";
+};
+export type NumberInput = BaseInput<number> & {
+    type: "number";
+    minValue?: number;
+};
+export type BooleanInput = BaseInput<boolean> & {
+    type: "boolean";
+};
+export type ColorInput = BaseInput<string> & {
+    type: "color";
+};
+export type FileInput = BaseInput<string> & {
+    type: "file";
+    allowedFileTypes: string[];
+};
+export type DateTimeInput = BaseInput<string> & {
+    type: "datetime";
+};
+export type LexicalInput = BaseInput<string> & {
+    type: "lexical";
+};
+export type SelectInput = BaseInput<string> & {
+    type: "select";
+    options: {
+        label: string;
+        value: string;
+    }[];
+    showResetAction?: boolean;
+};
+export type RadioInput = BaseInput<string> & {
+    type: "radio";
+    options: {
+        label: string;
+        value: string;
+    }[];
+};
+export type ObjectInput = BaseInput<Record<string, any>> & {
+    type: "object";
+    fields: ComponentInput[];
+};
+export type CustomInput = BaseInput<any> & {
+    type: string;
+    fields: ComponentInput[];
+};
+export type ComponentInput = TextInput | LongTextInput | NumberInput | BooleanInput | ColorInput | FileInput | DateTimeInput | LexicalInput | SelectInput | RadioInput | TagsInput | ObjectInput | SlotInput | CustomInput;

package/types.js

@@ -0,0 +1,3 @@
+export {};
+
+//# sourceMappingURL=types.js.map

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import type * as CSS from \"csstype\";\nimport type { BindingsApi } from \"~/BindingsApi\";\nimport type { ShorthandCssProperties } from \"./types/ShorthandCssProperties\";\nexport type { WebsiteBuilderTheme, Breakpoint } from \"./types/WebsiteBuilderTheme\";\n\ninterface CSSProperties extends CSS.Properties<string | number> {}\n\nexport type ElementMap = Record<string, DocumentElement>;\n\nexport type DocumentState = Record<string, any>;\n\nexport type InputValueBinding<T = any> = ValueBinding<T> & {\n    id: string;\n    type: string;\n    translatable?: boolean;\n    list?: boolean;\n};\n\nexport type StyleValueBinding<T = any> = ValueBinding<T>;\n\nexport type ValueBinding<T = any> = {\n    static?: T;\n    expression?: string;\n};\n\nexport type RepeatValueBinding = {\n    expression: string;\n};\n\nexport type CssProperties = Omit<CSSProperties, ShorthandCssProperties>;\n\nexport type DocumentElementStyleBindings = Partial<{\n    [K in keyof CssProperties]: StyleValueBinding<CssProperties[K]>;\n}>;\n\nexport type DocumentElementInputBindings = {\n    [inputName: string]: InputValueBinding;\n};\n\nexport type DocumentElementBindings = {\n    $repeat?: RepeatValueBinding;\n    inputs?: DocumentElementInputBindings;\n    styles?: DocumentElementStyleBindings;\n    metadata?: Record<string, any>;\n    overrides?: {\n        [key: string]: {\n            inputs?: DocumentElementInputBindings;\n            styles?: DocumentElementStyleBindings;\n        };\n    };\n};\n\nexport type DocumentBindings = {\n    [elementId: string]: DocumentElementBindings;\n};\n\nexport type ResolvedComponent<TComponent = any> = {\n    component: TComponent;\n    inputs: Record<string, any>;\n    manifest: ComponentManifest;\n    styles: SerializableCSSStyleDeclaration;\n};\n\nexport type ResolvedElement = {\n    id: string;\n    inputs: Record<string, any>;\n    styles: SerializableCSSStyleDeclaration;\n};\n\nexport type Component = {\n    component: any;\n    manifest: ComponentManifest;\n};\n\nexport type ComponentGroupItem = {\n    // Name of the component.\n    name: string;\n    // Optionally, define an exact element to insert.\n    item?: DocumentElementTemplate;\n};\n\nexport type SerializedComponentGroup = ComponentGroup & {\n    filter?: string;\n};\n\nexport type ComponentGroupFilterContext = {\n    document: EditorDocument;\n};\n\nexport type ComponentGroup = {\n    name: string;\n    label: string;\n    description?: string;\n    filter?: (component: ComponentManifest, context: ComponentGroupFilterContext) => boolean;\n};\n\nexport type ResponsiveStyles = {\n    [key: string]: SerializableCSSStyleDeclaration;\n};\n\nexport type ComponentManifest = {\n    name: string;\n    group?: string;\n    label?: string;\n    image?: string;\n    inputs?: ComponentInput[];\n    canDrag?: boolean;\n    canDelete?: boolean;\n    acceptsChildren?: boolean;\n    hideFromToolbar?: boolean;\n    hideStyleSettings?: string[];\n    autoApplyStyles?: boolean;\n    tags?: string[];\n    defaults?: {\n        inputs?: Record<string, any>;\n        styles?: SerializableCSSStyleDeclaration;\n        overrides?: {\n            [breakpoint: string]: {\n                inputs?: Record<string, any>;\n                styles?: SerializableCSSStyleDeclaration;\n            };\n        };\n    };\n};\n\nexport type DocumentElementTemplate = Omit<DocumentElement, \"id\">;\n\nexport type ElementComponent = {\n    name: string;\n};\n\nexport type DocumentElement = {\n    type: \"Webiny/Element\";\n    id: string;\n    component: ElementComponent;\n    parent?: {\n        id: string;\n        slot: string;\n    };\n    styles?: ResponsiveStyles;\n};\n\nexport type SerializableCSSStyleDeclaration = {\n    [K in keyof CssProperties]?: CssProperties[K];\n};\n\nexport type Document = {\n    id: string;\n    state: DocumentState;\n    version: number;\n    properties: Record<string, any>;\n    bindings: DocumentBindings;\n    elements: ElementMap;\n};\n\nexport type PublicPage = Pick<\n    Page,\n    \"id\" | \"version\" | \"properties\" | \"bindings\" | \"elements\" | \"state\"\n>;\n\nexport type PublicRedirect = {\n    id: string;\n    from: string;\n    to: string;\n    permanent: boolean;\n};\n\nexport type EditorPage = EditorDocument & Pick<Page, \"properties\" | \"status\" | \"location\">;\n\nexport type EditorDocument = Document & {\n    metadata: Record<string, any>;\n};\n\nexport type Page = Document & {\n    id: string;\n    status: string;\n    version: number;\n    location: {\n        folderId: string;\n    };\n    properties: {\n        title: string;\n        snippet: string;\n        /*image: {\n            id: string;\n            name: string;\n            size: number;\n            mimeType: string;\n            src: string;\n        };*/\n        path: string;\n        tags: string[];\n        seo: {\n            title: string;\n            description: string;\n            metaTags: Array<{ name: string; content: string }>;\n        };\n        social: {\n            title: string;\n            description: string;\n            /*image: {\n                id: string;\n                name: string;\n                size: number;\n                mimeType: string;\n                src: string;\n            };*/\n            metaTags: Array<{ property: string; content: string }>;\n        };\n    };\n};\n\nexport type Box = {\n    depth: number;\n    parentId: string;\n    parentSlot: string;\n    parentIndex: number;\n    width: number;\n    height: number;\n    top: number;\n    left: number;\n};\n\nexport type ElementBoxData = Box & {\n    type: \"element\";\n};\n\nexport type ElementSlotBoxData = Box & {\n    type: \"element-slot\";\n};\n\nexport type BoxData = ElementBoxData | ElementSlotBoxData;\n\nexport type EditorViewportInfo = PreviewViewportInfo & {\n    top: number;\n    left: number;\n};\n\nexport type PreviewViewportInfo = {\n    width: number;\n    height: number;\n    scrollX: number;\n    scrollY: number;\n};\n\nexport type BoxesData = Record<string, BoxData>;\n\nexport type EditorViewportData = {\n    boxes: BoxesData;\n    viewport: EditorViewportInfo;\n};\n\nexport type PreviewViewportData = {\n    boxes: BoxesData;\n    viewport: PreviewViewportInfo;\n};\n\nexport type ApiOptions = Record<string, any>;\n\nexport type GetPageOptions = ApiOptions;\nexport type ListPagesOptions = ApiOptions;\n\nexport interface IDataProvider {\n    getPageByPath(path: string, options?: GetPageOptions): Promise<PublicPage | null>;\n    getPageById(id: string, options?: GetPageOptions): Promise<PublicPage | null>;\n    listPages(options?: ListPagesOptions): Promise<PublicPage[]>;\n}\n\nexport interface IEnvironment {\n    isClient(): boolean;\n    isServer(): boolean;\n    isPreview(): boolean;\n}\n\nexport interface IContentSdk {\n    getPage(path: string): Promise<PublicPage | null>;\n    listPages(options?: ListPagesOptions): Promise<PublicPage[]>;\n}\n\n// Input types\n\n// inputTypes.ts\nexport type BaseInput<T = any> = {\n    name: string;\n    type: string;\n    onChange?: (\n        bindings: ReturnType<BindingsApi[\"getPublicApi\"]>,\n        context: { breakpoint: string }\n    ) => void;\n    label?: string;\n    description?: string;\n    helperText?: string;\n    defaultValue?: T;\n    responsive?: boolean;\n    required?: boolean;\n    hideFromUi?: boolean;\n    renderer?: string;\n    list?: boolean;\n    translatable?: boolean;\n};\n\n// Discriminated union per input type\nexport type TextInput = BaseInput<string> & {\n    type: \"text\";\n};\n\nexport type SlotInput = BaseInput<any> & {\n    type: \"slot\";\n    components?: string[];\n};\n\nexport type TagsInput = BaseInput<string[]> & {\n    type: \"text\";\n};\n\nexport type LongTextInput = BaseInput<string> & {\n    type: \"longText\";\n};\n\nexport type NumberInput = BaseInput<number> & {\n    type: \"number\";\n    minValue?: number;\n};\n\nexport type BooleanInput = BaseInput<boolean> & {\n    type: \"boolean\";\n};\n\nexport type ColorInput = BaseInput<string> & {\n    type: \"color\";\n};\n\nexport type FileInput = BaseInput<string> & {\n    type: \"file\";\n    allowedFileTypes: string[];\n};\n\nexport type DateTimeInput = BaseInput<string> & {\n    type: \"datetime\";\n};\n\nexport type LexicalInput = BaseInput<string> & {\n    type: \"lexical\";\n};\n\nexport type SelectInput = BaseInput<string> & {\n    type: \"select\";\n    options: { label: string; value: string }[];\n    showResetAction?: boolean;\n};\n\nexport type RadioInput = BaseInput<string> & {\n    type: \"radio\";\n    options: { label: string; value: string }[];\n};\n\nexport type ObjectInput = BaseInput<Record<string, any>> & {\n    type: \"object\";\n    fields: ComponentInput[];\n};\n\nexport type CustomInput = BaseInput<any> & {\n    type: string;\n    fields: ComponentInput[];\n};\n\n// Union of all input types\nexport type ComponentInput =\n    | TextInput\n    | LongTextInput\n    | NumberInput\n    | BooleanInput\n    | ColorInput\n    | FileInput\n    | DateTimeInput\n    | LexicalInput\n    | SelectInput\n    | RadioInput\n    | TagsInput\n    | ObjectInput\n    | SlotInput\n    | CustomInput;\n"],"mappings":"","ignoreList":[]}