@bygga.dev/editor 0.1.0

package/element.d.ts

@@ -0,0 +1,56 @@
+declare const brand: unique symbol;
+type Document = {
+    readonly [brand]: 'Document';
+};
+declare function parseDocument(json: unknown): Document;
+declare function createEmptyDocument(): Document;
+
+type EditorConfig = {
+    uploadImage(image: Blob): Promise<string>;
+    saveDocument?(document: Document): Promise<void>;
+    onImageError?(error: unknown): void;
+};
+
+declare const SUPPORTED_LOCALES: readonly ["en", "sv"];
+type Locale = (typeof SUPPORTED_LOCALES)[number];
+declare const DEFAULT_LOCALE: Locale;
+
+type LicenseErrorReason = 'key' | 'domain' | 'origin' | 'malformed' | 'unreachable' | 'invalid' | 'insecure-context';
+type LicenseError = {
+    reason: LicenseErrorReason;
+};
+
+type MergeTagLabels = Partial<Record<Locale, string>>;
+type MergeTags = Record<string, MergeTagLabels>;
+
+declare const EDITOR_TAG = "bygga-editor";
+declare const ByggaEditor: CustomElementConstructor;
+
+type ByggaEditorEventMap = {
+    change: CustomEvent<[Document]>;
+    dirtychange: CustomEvent<[boolean]>;
+    licenseerror: CustomEvent<[LicenseError]>;
+};
+interface ByggaEditorElement extends HTMLElement {
+    addEventListener<K extends keyof ByggaEditorEventMap>(type: K, listener: (this: ByggaEditorElement, event: ByggaEditorEventMap[K]) => void, options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+    config: EditorConfig;
+    document?: Document | null;
+    getDocument(): Document;
+    isDirty(): boolean;
+    licenseKey?: string;
+    locale?: Locale;
+    markSaved(): void;
+    mergeTags?: MergeTags;
+    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>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'bygga-editor': ByggaEditorElement;
+    }
+}
+
+export { ByggaEditor, DEFAULT_LOCALE, EDITOR_TAG, SUPPORTED_LOCALES, createEmptyDocument, parseDocument };
+export type { ByggaEditorElement, ByggaEditorEventMap, Document, EditorConfig, LicenseError, LicenseErrorReason, Locale, MergeTagLabels, MergeTags };

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@bygga.dev/editor",
+  "version": "0.1.0",
+  "description": "Visual content builder shipped as the <bygga-editor> custom element",
+  "license": "UNLICENSED",
+  "type": "module",
+  "sideEffects": true,
+  "exports": {
+    ".": {
+      "types": "./element.d.ts",
+      "default": "./bygga-editor.js"
+    }
+  }
+}