@getdraft/plugin 1.16.0 → 1.17.0

package/dist/types/index.d.ts

@@ -1,16 +1,343 @@
-import { PluginInstance } from './plugin';
-import { PluginConfig } from './types';
-declare class PluginWrapper {
-    version: string;
-    create(config: PluginConfig): PluginInstance;
-}
-declare const DraftPlugin: PluginWrapper;
-declare global {
-    interface Window {
-        DraftPlugin: PluginWrapper;
-    }
-}
-export default DraftPlugin;
-export type { PluginInstance } from './plugin';
-export * from './types';
-//# sourceMappingURL=index.d.ts.map
+export declare type AnalyticsParams = DuplicateEvent | DestroyEvent | EditEvent | HistoryEvent | PreviewEvent | ToolbarMoveEvent | BlockInsertEvent | BlockSaveEvent | BlockDestroyEvent | DropEvent;
+
+export declare type AsyncEventHandler<P, R> = (params: P) => Promise<R>;
+
+export declare interface AutosaveParams {
+    json: TemplateJSON;
+}
+
+export declare interface BlockDestroyEvent {
+    name: 'block-destroy';
+}
+
+export declare interface BlockInsertEvent {
+    name: 'block-insert';
+    context: 'double-click';
+    blockType: BlockType;
+    blockName: string;
+    blockCategory: string | number;
+    blockId: string | number;
+}
+
+export declare interface BlockSaveEvent {
+    name: 'block-save';
+    blockType: 'user';
+    blockName: string;
+    blockCategory: string | number;
+    blockId: string | number;
+    elements: Record<string, number> & {
+        sum: number;
+    };
+}
+
+export declare type BlockType = 'system' | 'user';
+
+export declare interface DestroyEvent {
+    name: 'destroy';
+    context: HotkeyContext | ToolbarContext | UnitSettingsContext;
+    unitType: string;
+}
+
+export declare type DndDragContext = 'canvas' | 'list' | 'palette';
+
+export declare type DndDropContext = 'dropline' | 'placeholder' | 'empty-placeholder';
+
+export declare type DndDropTarget = 'root' | 'section' | 'column' | 'element';
+
+export declare class DraftError extends Error {
+    readonly code: string;
+    constructor(code: string, message: string);
+}
+
+declare const DraftPlugin: PluginWrapper;
+export default DraftPlugin;
+
+export declare interface DropEvent {
+    name: 'drop';
+    drag?: DropEventDragMeta;
+    dropzone?: DropEventDropzoneMeta;
+}
+
+export declare interface DropEventDragMeta {
+    context?: DndDragContext;
+    layer?: 'element' | 'section' | 'column' | 'root';
+    type?: string | string[];
+    blockCategory?: string | number;
+    blockId?: string | number;
+    blockName?: string;
+    blockType?: BlockType;
+    alt?: boolean;
+    dropKind?: 'create' | 'move';
+}
+
+export declare interface DropEventDropzoneMeta {
+    context?: DndDropContext;
+    dropTarget?: DndDropTarget;
+}
+
+export declare interface DuplicateEvent {
+    name: 'duplicate';
+    context: HotkeyContext | ToolbarContext | UnitSettingsContext;
+    unitType: string;
+}
+
+export declare interface EditEvent {
+    name: 'edit';
+    context: OverlayContext | ToolbarContext;
+    unitType: string;
+}
+
+export declare enum EditorMenu {
+    Audit = "audit",
+    Guide = "guide",
+    Style = "style",
+    Blocks = "blocks"
+}
+
+export declare interface ErrorParams {
+    message: string;
+    code?: string;
+    details?: unknown;
+}
+
+export declare type EventHandler<T> = (data: T) => void;
+
+export declare interface ExitParams extends SaveParams {
+}
+
+export declare interface ExportAsFileParams {
+    blob: Blob;
+    fileName: string;
+}
+
+export declare type HandlerParams<H> = H extends EventHandler<infer P> | AsyncEventHandler<infer P, unknown> ? P : never;
+
+export declare interface Handlers {
+    ready: EventHandler<ReadyParams>;
+    error: EventHandler<ErrorParams>;
+    save: EventHandler<SaveParams>;
+    exit: EventHandler<ExitParams>;
+    notification: EventHandler<NotificationParams>;
+    autosave: EventHandler<AutosaveParams>;
+    toggleGrid: EventHandler<ToggleGridParams>;
+    toggleInvisibleCharacters: EventHandler<ToggleInvisibleCharactersParams>;
+    togglePreview: EventHandler<TogglePreviewParams>;
+    toggleViewMode: EventHandler<ToggleViewModeParams>;
+    toggleMenu: EventHandler<ToggleMenuParams>;
+    history: EventHandler<HistoryParams>;
+    analytics: EventHandler<AnalyticsParams>;
+    openGallery: EventHandler<(url?: string) => Promise<void>>;
+    uploadImage: AsyncEventHandler<UploadImageParams, string>;
+    loadPersonalization: AsyncEventHandler<void, PersonalizationDictionary>;
+}
+
+export declare interface HistoryEvent {
+    name: 'history';
+    type: 'undo' | 'redo';
+    context: HotkeyContext;
+}
+
+export declare interface HistoryParams {
+    hasUndos: boolean;
+    hasRedos: boolean;
+    currentStep: number;
+}
+
+export declare type HotkeyContext = 'hotkey';
+
+export declare interface ImageParams {
+    url: string;
+    originalWidth: number;
+    originalHeight: number;
+    ratio: number;
+    fileSize: number;
+}
+
+export declare type MessageData = {
+    source: string;
+    event: string;
+    ok?: boolean;
+    code?: string;
+    message?: string;
+    action?: string;
+};
+
+declare interface Notification_2 {
+    intent: 'error' | 'info' | 'success' | 'warning';
+    errorDetails?: object;
+    message?: string;
+    title: string;
+}
+export { Notification_2 as Notification }
+
+export declare type NotificationParams = Notification_2;
+
+export declare type OnInitParams = MessageEvent<{
+    source: string;
+    event: 'loaded' | unknown;
+}>;
+
+export declare interface OpenGalleryParams {
+    id: string;
+}
+
+export declare type OverlayContext = 'overlay-click' | 'overlay-double-click';
+
+export declare type PersonalizationDictionary = PersonalizationDictionaryItems;
+
+declare type PersonalizationDictionaryEntry = {
+    name: string;
+    value: string;
+} | {
+    groupName: string;
+    items: Array<{
+        name: string;
+        value: string;
+    }>;
+};
+
+export declare type PersonalizationDictionaryItems = PersonalizationDictionaryEntry[];
+
+export declare interface PluginConfig {
+    container: string;
+    locale?: string;
+    autosave?: boolean | {
+        interval: number;
+    };
+    token: string;
+    authData?: {
+        orgId: number;
+        projectId?: number;
+    };
+    pluginId: string;
+    apiUrl: string;
+    disableHotkeysPassing?: boolean;
+    __config?: object;
+    on: Partial<Handlers>;
+}
+
+export declare class PluginInstance {
+    config: PluginConfig;
+    iframe: HTMLIFrameElement | null;
+    private hotkeysAttached;
+    private iframeOrigin;
+    constructor(config: PluginConfig);
+    private captureHotkeysEnabled;
+    private onHostHotkey;
+    private static HEARTBEAT_TIMEOUT;
+    private promisedIframeMethod;
+    private postEvent;
+    private onImageUpload;
+    private onLoadPersonalization;
+    private onGalleryOpen;
+    private triggerEvent;
+    private onMessage;
+    start({ template, templateName, uid, }: {
+        template: string | TemplateJSON;
+        uid: string | number;
+        templateName?: string;
+    }): void;
+    destroy: () => void;
+    changeTemplate(template: string | TemplateJSON, options?: {
+        templateName?: string;
+        uid?: string;
+    }): void;
+    toggleGrid(state?: boolean): void;
+    toggleInvisibleCharacters(state?: boolean): void;
+    togglePreview(state?: boolean): void;
+    toggleMenu(menu?: EditorMenu | null): void;
+    toggleViewMode(viewMode: ViewMode): void;
+    undo(): void;
+    undoToStep(targetStep: number): void;
+    redo(): void;
+    save(): Promise<SaveParams>;
+    exit(): Promise<ExitParams>;
+    exportContent(): Promise<SaveParams>;
+    exportAsFile(): Promise<ExportAsFileParams>;
+}
+
+declare class PluginWrapper {
+    version: string;
+    create(config: PluginConfig): PluginInstance;
+}
+
+export declare interface PreviewEvent {
+    name: 'preview';
+    context: HotkeyContext;
+}
+
+export declare interface ReadyParams extends SaveParams {
+    lastSavedTemplate?: {
+        template: TemplateJSON;
+        date: Date;
+    };
+}
+
+export declare interface SaveParams {
+    json: TemplateJSON;
+    html: string;
+}
+
+export declare interface SerializedTemplate {
+    [key: string]: unknown;
+    parentId: string | null;
+    id: string;
+    parameters: object;
+    layer: string;
+    type: string;
+    children?: SerializedTemplate[];
+    meta?: {
+        [key: string]: unknown;
+        version: string;
+    };
+}
+
+export declare type TemplateJSON = SerializedTemplate;
+
+export declare interface ToggleGridParams extends ToggleParams {
+}
+
+export declare interface ToggleInvisibleCharactersParams extends ToggleParams {
+}
+
+export declare interface ToggleMenuParams {
+    menu: EditorMenu | null;
+}
+
+declare interface ToggleParams {
+    state: boolean;
+}
+
+export declare interface TogglePreviewParams extends ToggleParams {
+    json: TemplateJSON;
+    html: string;
+    darkHTML: string;
+}
+
+export declare interface ToggleViewModeParams {
+    mode: ViewMode;
+}
+
+export declare type ToolbarActionName = 'duplicate' | 'destroy' | 'edit' | 'up' | 'down';
+
+export declare type ToolbarContext = 'toolbar';
+
+export declare interface ToolbarMoveEvent {
+    name: 'up' | 'down';
+    context: ToolbarContext;
+    unitType: string;
+}
+
+export declare type UnitSettingsContext = 'unit-settings';
+
+export declare interface UploadImageParams {
+    file: string;
+    name: string;
+}
+
+export declare enum ViewMode {
+    Desktop = "desktop",
+    Mobile = "mobile"
+}
+
+export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getdraft/plugin",
-  "version": "1.16.0",
+  "version": "1.17.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
   "types": "dist/types/index.d.ts",
@@ -11,11 +11,10 @@
       "require": "./dist/index.cjs.js"
     }
   },
-  "dependencies": {
-    "@getdraft/types": "^1.0.0"
-  },
+  "dependencies": {},
   "devDependencies": {
     "vite-plugin-dts": "4.5.4",
+    "@getdraft/types": "^1.0.0",
     "@getdraft/eslint-config-ts": "^1.0.0",
     "@getdraft/prettier": "^1.0.0"
   },
@@ -26,7 +25,8 @@
     "dev-tsc": "tsc-check",
     "eslint": "npx eslint src",
     "eslint:fix": "pnpm eslint --fix",
-    "prettify": "npx prettier -w ./",
+    "prettify": "npx prettier --check src",
+    "prettify:fix": "npx prettier -w src",
     "prepublish": "pnpm build",
     "watch": "NODE_ENV=development vite build --watch",
     "start": "NODE_ENV=development npx vite"

package/src/plugin.ts

@@ -389,6 +389,10 @@ export class PluginInstance {
     this.postEvent('toggleGrid', { state });
   }
 
+  toggleInvisibleCharacters(state?: boolean) {
+    this.postEvent('toggleInvisibleCharacters', { state });
+  }
+
   togglePreview(state?: boolean) {
     this.postEvent('togglePreview', { state });
   }
@@ -405,6 +409,10 @@ export class PluginInstance {
     this.postEvent('undo');
   }
 
+  undoToStep(targetStep: number) {
+    this.postEvent('undoToStep', { targetStep });
+  }
+
   redo() {
     this.postEvent('redo');
   }

package/src/types.ts

@@ -1,10 +1,38 @@
-import {
-  EditorMenu,
-  ViewMode,
-  type Notification,
-  type PersonalizationDictionaryItems,
-  type SerializedTemplate,
-} from '@getdraft/types';
+export enum EditorMenu {
+  Audit = 'audit',
+  Guide = 'guide',
+  Style = 'style',
+  Blocks = 'blocks',
+}
+
+export enum ViewMode {
+  Desktop = 'desktop',
+  Mobile = 'mobile',
+}
+
+export interface Notification {
+  intent: 'error' | 'info' | 'success' | 'warning';
+  errorDetails?: object;
+  message?: string;
+  title: string;
+}
+
+type PersonalizationDictionaryEntry =
+  | { name: string; value: string }
+  | { groupName: string; items: Array<{ name: string; value: string }> };
+
+export type PersonalizationDictionaryItems = PersonalizationDictionaryEntry[];
+
+export interface SerializedTemplate {
+  [key: string]: unknown;
+  parentId: string | null;
+  id: string;
+  parameters: object;
+  layer: string;
+  type: string;
+  children?: SerializedTemplate[];
+  meta?: { [key: string]: unknown; version: string };
+}
 
 export type EventHandler<T> = (data: T) => void;
 
@@ -44,8 +72,6 @@ export type OnInitParams = MessageEvent<{
   event: 'loaded' | unknown;
 }>;
 
-export { EditorMenu, ViewMode };
-
 export interface ReadyParams extends SaveParams {
   lastSavedTemplate?: {
     template: TemplateJSON;
@@ -90,6 +116,8 @@ interface ToggleParams {
 
 export interface ToggleGridParams extends ToggleParams {}
 
+export interface ToggleInvisibleCharactersParams extends ToggleParams {}
+
 export interface TogglePreviewParams extends ToggleParams {
   json: TemplateJSON;
   html: string;
@@ -229,6 +257,7 @@ export interface Handlers {
   notification: EventHandler<NotificationParams>;
   autosave: EventHandler<AutosaveParams>;
   toggleGrid: EventHandler<ToggleGridParams>;
+  toggleInvisibleCharacters: EventHandler<ToggleInvisibleCharactersParams>;
   togglePreview: EventHandler<TogglePreviewParams>;
   toggleViewMode: EventHandler<ToggleViewModeParams>;
   toggleMenu: EventHandler<ToggleMenuParams>;