@bygga.dev/editor 1.8.4 → 1.9.4

package/element.d.ts

@@ -5,10 +5,70 @@ type BrandCustomFont = {
     fontFamily?: string;
     type?: 'file' | 'stylesheet';
 };
+type BrandBlockType = 'text' | 'header' | 'columns' | 'image' | 'button' | 'spacer' | 'divider' | 'html';
+type BrandBox = number | {
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+};
+type BrandCorners = number | {
+    topLeft: number;
+    topRight: number;
+    bottomRight: number;
+    bottomLeft: number;
+};
+type BrandBorder = {
+    width: BrandBox;
+    color?: string;
+    style?: 'solid' | 'dashed' | 'dotted';
+};
+type BrandTextStyle = {
+    font?: string;
+    fontSize?: number;
+    color?: string;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    align?: 'left' | 'center' | 'right' | 'justify';
+    background?: string;
+    padding?: BrandBox;
+    margin?: BrandBox;
+    borderRadius?: BrandCorners;
+    border?: BrandBorder;
+    paragraphSpacing?: number;
+};
+type BrandHeaderStyle = Omit<BrandTextStyle, 'paragraphSpacing'> & {
+    level?: 1 | 2 | 3;
+};
+type BrandButtonStyle = {
+    background?: string;
+    textColor?: string;
+    font?: string;
+    fontSize?: number;
+    bold?: boolean;
+    borderRadius?: BrandCorners;
+    padding?: BrandBox;
+    margin?: BrandBox;
+    border?: BrandBorder;
+    align?: 'left' | 'center' | 'right';
+};
+type BrandStyles = {
+    header?: BrandHeaderStyle;
+    text?: BrandTextStyle;
+    button?: BrandButtonStyle;
+};
 type Brand = {
     colors?: string[];
+    localColors?: string[];
+    colorsLabel?: string;
+    localColorsLabel?: string;
+    anyColor?: boolean;
     fonts?: BrandFont[];
     customFonts?: BrandCustomFont[];
+    styles?: BrandStyles;
+    custom?: Record<string, unknown>;
+    hiddenBlocks?: string[];
 };
 
 declare const brand$1: unique symbol;
@@ -18,18 +78,57 @@ type Document = {
 declare function parseDocument(json: unknown): Document;
 declare function createEmptyDocument(kind?: 'email' | 'page'): Document;
 
+type BlockPluginBrand = {
+    readonly colors: readonly string[];
+    readonly localColors: readonly string[];
+    readonly colorsLabel?: string;
+    readonly localColorsLabel?: string;
+    readonly anyColor: boolean;
+    readonly fonts: readonly BrandFont[];
+    readonly customFonts: readonly BrandCustomFont[];
+    readonly styles: BrandStyles;
+    readonly custom: Readonly<Record<string, unknown>>;
+    readonly css: {
+        readonly header?: BlockPluginStyleCss;
+        readonly text?: BlockPluginStyleCss;
+        readonly button?: BlockPluginStyleCss;
+    };
+};
+type BlockPluginStyleCss = {
+    readonly fontFamily?: string;
+    readonly fontSize?: string;
+    readonly fontWeight?: string;
+    readonly fontStyle?: string;
+    readonly textDecoration?: string;
+    readonly color?: string;
+    readonly textAlign?: string;
+    readonly backgroundColor?: string;
+    readonly padding?: string;
+    readonly margin?: string;
+    readonly borderRadius?: string;
+    readonly borderWidth?: string;
+    readonly borderStyle?: string;
+    readonly borderColor?: string;
+    readonly cssText: string;
+};
+type BlockPluginCreateContext = {
+    readonly brand: BlockPluginBrand;
+    readonly locale: string;
+};
 type BlockPluginSettingsContext<Data = unknown, Globals = unknown> = {
     readonly data: Data;
     update(data: Data): void;
     readonly globals: Globals;
     uploadImage(image: Blob): Promise<string>;
     readonly locale: string;
+    readonly brand: BlockPluginBrand;
 };
 type BlockPluginGlobalsContext<Globals = unknown> = {
     readonly globals: Globals;
     update(globals: Globals): void;
     uploadImage(image: Blob): Promise<string>;
     readonly locale: string;
+    readonly brand: BlockPluginBrand;
 };
 type BlockPluginGlobalSettings<Globals = unknown> = {
     create(): Globals;
@@ -40,7 +139,7 @@ type BlockPlugin<Data = unknown, Globals = unknown> = {
     name: string;
     label: string;
     icon?: string;
-    create(): Data;
+    create(context: BlockPluginCreateContext): Data;
     parse(data: unknown): Data;
     email(data: Data, globals: Globals): string;
     preview?(node: HTMLElement, data: Data, globals: Globals): void;
@@ -119,10 +218,19 @@ type MergeTagEntry = MergeTagLabels & {
 };
 type MergeTags = Record<string, MergeTagEntry>;
 
+type Permission = 'admin' | 'creator';
+
+declare function documentDigest(document: Document): Promise<string>;
+
 declare const EDITOR_TAG = "bygga-editor";
 declare const ByggaEditor: CustomElementConstructor;
 
+type AutosaveDetail = {
+    document: Document;
+    digest: string;
+};
 type ByggaEditorEventMap = {
+    autosave: CustomEvent<[AutosaveDetail]>;
     change: CustomEvent<[Document]>;
     dirtychange: CustomEvent<[boolean]>;
     licenseerror: CustomEvent<[LicenseError]>;
@@ -139,6 +247,7 @@ interface ByggaEditorElement extends HTMLElement {
     locale?: Locale;
     markSaved(): void;
     mergeTags?: MergeTags;
+    permission?: Permission;
     removeEventListener<K extends keyof ByggaEditorEventMap>(type: K, listener: (this: ByggaEditorElement, event: ByggaEditorEventMap[K]) => void, options?: boolean | EventListenerOptions): void;
     removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
     save(): Promise<void>;
@@ -150,5 +259,5 @@ declare global {
     }
 }
 
-export { ByggaEditor, DEFAULT_LOCALE, EDITOR_TAG, SUPPORTED_LOCALES, createEmptyDocument, parseDocument, parseSavedBlock };
-export type { AiAction, AiAssistant, AiRequest, BlockPlugin, BlockPluginGlobalSettings, BlockPluginGlobalsContext, BlockPluginSettingsContext, Brand, BrandCustomFont, BrandFont, ByggaEditorElement, ByggaEditorEventMap, Document, EditorConfig, LicenseError, LicenseErrorReason, Locale, MergeTagEntry, MergeTagLabels, MergeTagOption, MergeTags, SavedBlock, SavedBlockContent };
+export { ByggaEditor, DEFAULT_LOCALE, EDITOR_TAG, SUPPORTED_LOCALES, createEmptyDocument, documentDigest, parseDocument, parseSavedBlock };
+export type { AiAction, AiAssistant, AiRequest, AutosaveDetail, BlockPlugin, BlockPluginBrand, BlockPluginCreateContext, BlockPluginGlobalSettings, BlockPluginGlobalsContext, BlockPluginSettingsContext, BlockPluginStyleCss, Brand, BrandBlockType, BrandBorder, BrandBox, BrandButtonStyle, BrandCorners, BrandCustomFont, BrandFont, BrandHeaderStyle, BrandStyles, BrandTextStyle, ByggaEditorElement, ByggaEditorEventMap, Document, EditorConfig, LicenseError, LicenseErrorReason, Locale, MergeTagEntry, MergeTagLabels, MergeTagOption, MergeTags, Permission, SavedBlock, SavedBlockContent };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bygga.dev/editor",
-  "version": "1.8.4",
+  "version": "1.9.4",
   "description": "Visual content builder shipped as the <bygga-editor> custom element",
   "license": "UNLICENSED",
   "type": "module",

package/{providerKeys-D5U1FqVd.js → providerKeys-ZibeU1i6.js}

@@ -4772,6 +4772,6 @@ var su = !1, cu = () => {
 	withMemo: () => qs,
 	withModifiers: () => ql,
 	withScopeId: () => cr
-}), uu = () => {}, du = Symbol("editorData"), fu = Symbol("documentActions"), pu = Symbol("stackAcceptsDrop"), mu = Symbol("anchorIds"), hu = Symbol("documentFont"), gu = Symbol("documentKind"), _u = Symbol("pluginGlobals"), vu = Symbol("flyoutHost"), yu = Symbol("containingColumns"), bu = Symbol("underCondition"), xu = Symbol("columnsAcross");
+}), uu = () => {}, du = Symbol("editorData"), fu = Symbol("documentActions"), pu = Symbol("stackAcceptsDrop"), mu = Symbol("anchorIds"), hu = Symbol("documentFont"), gu = Symbol("documentKind"), _u = Symbol("pluginGlobals"), vu = Symbol("flyoutHost"), yu = Symbol("containingColumns"), bu = Symbol("underCondition"), xu = Symbol("underLock"), Su = Symbol("columnsAcross");
 //#endregion
-export { ur as $, J as A, Hi as B, Zo as C, vs as D, os as E, pr as F, sa as G, es as H, Da as I, Ja as J, ta as K, xs as L, Zr as M, Q as N, as as O, Gs as P, lr as Q, Kn as R, Fr as S, fs as T, fr as U, Ki as V, aa as W, br as X, ei as Y, _r as Z, Nl as _, hu as a, Ne as at, ql as b, vu as c, rn as ct, bu as d, ln as dt, mn as et, lu as f, _e as ft, Ll as g, t as gt, Pl as h, Ee as ht, fu as i, en as it, Oi as j, gs as k, _u as l, an as lt, tu as m, j as mt, xu as n, Me as nt, gu as o, Kt as ot, fl as p, ve as pt, Qr as q, yu as r, L as rt, du as s, Jt as st, mu as t, je as tt, pu as u, un as ut, Mc as v, Ws as w, G as x, Yl as y, Gi as z };
+export { lr as $, gs as A, Gi as B, Fr as C, os as D, fs as E, Gs as F, aa as G, Ki as H, pr as I, Qr as J, sa as K, Da as L, Oi as M, Zr as N, vs as O, Q as P, _r as Q, xs as R, G as S, Ws as T, es as U, Hi as V, fr as W, ei as X, Ja as Y, br as Z, Ll as _, t as _t, hu as a, en as at, Yl as b, vu as c, Jt as ct, bu as d, un as dt, ur as et, xu as f, ln as ft, Pl as g, Ee as gt, tu as h, j as ht, fu as i, L as it, J as j, as as k, _u as l, rn as lt, fl as m, ve as mt, Su as n, je as nt, gu as o, Ne as ot, lu as p, _e as pt, ta as q, yu as r, Me as rt, du as s, Kt as st, mu as t, mn as tt, pu as u, an as ut, Nl as v, Zo as w, ql as x, Mc as y, Kn as z };