@sealpixel/ui 1.0.0-rc.0

package/dist/components/sealpixel-editor.d.ts

@@ -0,0 +1,226 @@
+import { type AnyPlugin, type AssetResolver, type EditorSession, type ExportResult, type OutputOptions, type PluginOptionsMap, type Renderer, type SessionOptions } from '@sealpixel/core';
+import { LitElement, type TemplateResult } from 'lit';
+import { type Dictionary } from '../i18n.js';
+import type { UiTool } from '../tool.js';
+export type EditorSource = File | Blob | Uint8Array | string;
+/**
+ * The default editor. Headless `EditorSession` underneath; this element adds
+ * the responsive shell, tools and events.
+ *
+ * Events: `sealpixel:ready`, `sealpixel:load`, `sealpixel:change` ({ log, index }),
+ * `sealpixel:process` (ExportResult), `sealpixel:error` (SealpixelError).
+ */
+export declare class SealpixelEditor extends LitElement {
+    static styles: import("lit").CSSResult[];
+    static properties: {
+        plugins: {
+            attribute: boolean;
+        };
+        pluginOptions: {
+            attribute: string;
+            converter: {
+                fromAttribute: (value: string | null) => Readonly<Record<string, unknown>> | null;
+                toAttribute: (value: PluginOptionsMap | null) => string | null;
+            };
+        };
+        session: {
+            attribute: boolean;
+        };
+        renderer: {
+            attribute: boolean;
+        };
+        assets: {
+            attribute: boolean;
+        };
+        server: {
+            attribute: boolean;
+        };
+        serverEndpoint: {
+            type: StringConstructor;
+            attribute: string;
+        };
+        src: {
+            attribute: boolean;
+        };
+        editLog: {
+            attribute: boolean;
+        };
+        defaultEditLog: {
+            attribute: boolean;
+        };
+        output: {
+            attribute: boolean;
+        };
+        theme: {
+            type: StringConstructor;
+            reflect: boolean;
+        };
+        locale: {
+            type: StringConstructor;
+        };
+        dictionary: {
+            attribute: boolean;
+        };
+        tools: {
+            attribute: boolean;
+        };
+        activeTool: {
+            type: StringConstructor;
+            attribute: string;
+        };
+        showExport: {
+            type: StringConstructor;
+            attribute: string;
+        };
+        showDownload: {
+            type: StringConstructor;
+            attribute: string;
+        };
+        showHistory: {
+            type: StringConstructor;
+            attribute: string;
+        };
+        downloadLabel: {
+            type: StringConstructor;
+            attribute: string;
+        };
+        _busy: {
+            state: boolean;
+        };
+        _processListeners: {
+            state: boolean;
+        };
+        _toast: {
+            state: boolean;
+        };
+        _dragover: {
+            state: boolean;
+        };
+        _wide: {
+            state: boolean;
+        };
+        _pluginTools: {
+            state: boolean;
+        };
+    };
+    plugins: readonly AnyPlugin[] | null;
+    /** `{ pluginId: partialOptions }` applied to `plugins` (or the defaults) through each plugin's `configure()`. */
+    pluginOptions: PluginOptionsMap | null;
+    session: EditorSession | null;
+    renderer: Renderer | null;
+    /** Fonts and images. Defaults to a fetch resolver over the plugins' declarations. */
+    assets: AssetResolver | null;
+    /** Server rendering configuration; `server-endpoint` is the attribute shorthand. */
+    server: SessionOptions['server'] | null;
+    serverEndpoint: string | null;
+    src: EditorSource | null;
+    /** Controlled mode: the host owns the log. */
+    editLog: unknown;
+    /** Uncontrolled: applied once on load. */
+    defaultEditLog: unknown;
+    output: OutputOptions;
+    theme: 'dark' | 'light' | 'auto';
+    locale: string;
+    /** Overrides the shipped dictionary for `locale`; shipped locales resolve automatically. */
+    dictionary: Dictionary | null;
+    tools: Record<string, UiTool> | null;
+    activeTool: string | null;
+    /**
+     * When the Export button is shown. `auto` (default) shows it only while a
+     * `sealpixel:process` listener is attached, because Export hands the result to
+     * the host and does nothing visible otherwise. Download is always shown.
+     */
+    showExport: 'auto' | 'always' | 'never';
+    /** `always` (default) or `never`. Hosts that only consume `sealpixel:process` hide the button. */
+    showDownload: 'always' | 'never';
+    /** `all` (default), `buttons` (undo and redo, no timeline) or `none` (also disables the undo/redo shortcuts). */
+    showHistory: 'all' | 'buttons' | 'none';
+    /** Custom text for the Download button; the localized label when null. */
+    downloadLabel: string | null;
+    _busy: boolean;
+    _processListeners: number;
+    _toast: {
+        text: string;
+        hash: string;
+    } | null;
+    _dragover: boolean;
+    _wide: boolean;
+    /** Tools loaded from `plugin.tool()`, keyed by plugin id. */
+    _pluginTools: Record<string, UiTool>;
+    private resizeObserver;
+    private toolLoads;
+    /**
+     * Used when no `renderer` property is set. `@sealpixel/element` installs a
+     * factory that starts the bundled worker; without it the editor renders inline.
+     */
+    static defaultRendererFactory: ((plugins: readonly AnyPlugin[]) => Renderer) | null;
+    private readonly ctl;
+    private i18n;
+    private ownsSession;
+    private lastEmittedVersion;
+    private lastAppliedControlled;
+    private hint;
+    private previousTool;
+    private loadedSrc;
+    constructor();
+    addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => unknown, options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => unknown, options?: boolean | EventListenerOptions): void;
+    removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+    /** A renderer the editor made through the factory dies with the session; a host's renderer lives on. */
+    private disposeOwnedRenderer;
+    /** `plugins` (or the defaults) with `pluginOptions` applied. Invalid options raise `sealpixel:error`. */
+    private effectivePlugins;
+    /** The live session, created on first connection when none was passed. */
+    getSession(): EditorSession;
+    getEditLog(): {
+        log: import("@sealpixel/core").EditLog;
+        index: number;
+    };
+    setEditLog(saved: unknown, index?: number): void;
+    undo(): void;
+    redo(): void;
+    timeTravel(index: number): void;
+    export(output?: OutputOptions, options?: {
+        embedEditLog?: boolean;
+    }): Promise<ExportResult>;
+    download(options?: {
+        output?: OutputOptions;
+        filename?: string;
+        embedEditLog?: boolean;
+    }): Promise<{
+        filename: string;
+        result: ExportResult | import("@sealpixel/core").ServerRenderResult;
+    }>;
+    private ensureSession;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    willUpdate(changed: Map<string, unknown>): void;
+    updated(): void;
+    private lastError;
+    private loadSource;
+    private applyControlled;
+    /** Whether the owned session was built from the current `plugins` and `renderer`. */
+    private sessionMatchesProps;
+    private sessionRenderer;
+    private sessionAssets;
+    private sessionServer;
+    private currentTools;
+    /** Plugins may ship their own tool; load each once and re-render when it arrives. */
+    private loadPluginTools;
+    private get stage();
+    private toolContext;
+    private syncActiveTool;
+    private onPointerDown;
+    private onKeydown;
+    private onExport;
+    private onDownload;
+    private announce;
+    private toastTimer;
+    /** Brief confirmation over the stage: format, size and hash of the result. */
+    private toast;
+    private onFiles;
+    render(): TemplateResult<1>;
+    private renderEmpty;
+}
+//# sourceMappingURL=sealpixel-editor.d.ts.map

package/dist/components/sealpixel-editor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sealpixel-editor.d.ts","sourceRoot":"","sources":["../../src/components/sealpixel-editor.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,SAAS,EACd,KAAK,aAAa,EAKlB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACrB,KAAK,QAAQ,EAEb,KAAK,cAAc,EAEpB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAa,UAAU,EAAW,KAAK,cAAc,EAAE,MAAM,KAAK,CAAC;AAE1E,OAAO,EAAc,KAAK,UAAU,EAAa,MAAM,YAAY,CAAC;AAGpE,OAAO,KAAK,EAAE,MAAM,EAAiB,MAAM,YAAY,CAAC;AAIxD,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG,IAAI,GAAG,UAAU,GAAG,MAAM,CAAC;AAgB7D;;;;;;GAMG;AACH,qBAAa,eAAgB,SAAQ,UAAU;IAC7C,OAAgB,MAAM,4BAsoBpB;IAEF,OAAgB,UAAU;;;;;;;uCA5pBH,MAAM,GAAG,IAAI;qCASf,gBAAgB,GAAG,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA8qB1C;IAEM,OAAO,EAAE,SAAS,SAAS,EAAE,GAAG,IAAI,CAAC;IAC7C,iHAAiH;IACzG,aAAa,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACvC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAC;IAC9B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAClC,qFAAqF;IAC7E,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;IACrC,oFAAoF;IAC5E,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IACxC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,GAAG,EAAE,YAAY,GAAG,IAAI,CAAC;IACjC,8CAA8C;IACtC,OAAO,EAAE,OAAO,CAAC;IACzB,0CAA0C;IAClC,cAAc,EAAE,OAAO,CAAC;IACxB,MAAM,EAAE,aAAa,CAAC;IACtB,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC;IACvB,4FAA4F;IACpF,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAC9B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IACrC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC;;;;OAIG;IACK,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IAChD,kGAAkG;IAC1F,YAAY,EAAE,QAAQ,GAAG,OAAO,CAAC;IACzC,iHAAiH;IACzG,WAAW,EAAE,KAAK,GAAG,SAAS,GAAG,MAAM,CAAC;IAChD,0EAA0E;IAClE,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,KAAK,EAAE,OAAO,CAAC;IACf,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAC9C,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACvB,6DAA6D;IACrD,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7C,OAAO,CAAC,cAAc,CAA+B;IACrD,OAAO,CAAC,SAAS,CAAqB;IAEtC;;;OAGG;IACH,MAAM,CAAC,sBAAsB,EAAE,CAAC,CAAC,OAAO,EAAE,SAAS,SAAS,EAAE,KAAK,QAAQ,CAAC,GAAG,IAAI,CAAQ;IAE3F,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAqC;IACzD,OAAO,CAAC,IAAI,CAA0B;IACtC,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,kBAAkB,CAAM;IAChC,OAAO,CAAC,qBAAqB,CAAM;IACnC,OAAO,CAAC,IAAI,CAAwD;IACpE,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,SAAS,CAA6B;;IAkCrC,gBAAgB,CAAC,CAAC,SAAS,MAAM,mBAAmB,EAC3D,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC,KAAK,OAAO,EACpE,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAC1C,IAAI;IACE,gBAAgB,CACvB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,kCAAkC,EAC5C,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAC1C,IAAI;IAUE,mBAAmB,CAAC,CAAC,SAAS,MAAM,mBAAmB,EAC9D,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC,KAAK,OAAO,EACpE,OAAO,CAAC,EAAE,OAAO,GAAG,oBAAoB,GACvC,IAAI;IACE,mBAAmB,CAC1B,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,kCAAkC,EAC5C,OAAO,CAAC,EAAE,OAAO,GAAG,oBAAoB,GACvC,IAAI;IAUP,wGAAwG;IACxG,OAAO,CAAC,oBAAoB;IAO5B,yGAAyG;IACzG,OAAO,CAAC,gBAAgB;IAaxB,0EAA0E;IAC1E,UAAU,IAAI,aAAa;IAI3B,UAAU;;;;IAGV,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM;IAGzC,IAAI;IAGJ,IAAI;IAGJ,UAAU,CAAC,KAAK,EAAE,MAAM;IAGlB,MAAM,CAAC,MAAM,GAAE,aAA2B,EAAE,OAAO,GAAE;QAAE,YAAY,CAAC,EAAE,OAAO,CAAA;KAAO;IAGpF,QAAQ,CACZ,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,aAAa,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,OAAO,CAAA;KAAO;;;;IAKrF,OAAO,CAAC,aAAa;IAyBZ,iBAAiB,IAAI,IAAI;IAezB,oBAAoB,IAAI,IAAI;IAa5B,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAwC/C,OAAO,IAAI,IAAI;IAoBxB,OAAO,CAAC,SAAS,CAAiB;YAEpB,UAAU;IA6BxB,OAAO,CAAC,eAAe;IAiBvB,qFAAqF;IACrF,OAAO,CAAC,mBAAmB;IAuB3B,OAAO,CAAC,eAAe,CAAyB;IAChD,OAAO,CAAC,aAAa,CAA8B;IACnD,OAAO,CAAC,aAAa,CAAyC;IAE9D,OAAO,CAAC,YAAY;IAMpB,qFAAqF;IACrF,OAAO,CAAC,eAAe;IAiBvB,OAAO,KAAK,KAAK,GAEhB;IAED,OAAO,CAAC,WAAW;IAgDnB,OAAO,CAAC,cAAc;IAWtB,OAAO,CAAC,aAAa,CAEnB;IAEF,OAAO,CAAC,SAAS,CAaf;YAEY,QAAQ;YAkBR,UAAU;IAkBxB,OAAO,CAAC,QAAQ;IAKhB,OAAO,CAAC,UAAU,CAA8C;IAEhE,8EAA8E;IAC9E,OAAO,CAAC,KAAK;IAgBb,OAAO,CAAC,OAAO;IAKN,MAAM;IAmEf,OAAO,CAAC,WAAW;CA6BpB"}