@emailmaker/emailmaker 1.0.92 → 1.0.93-alpha.1

package/emailmaker.d.ts

@@ -0,0 +1,1553 @@
+type MayBePromise<T> = T | Promise<T>;
+type PromiseWrap<T> = Promise<Awaited<T>>;
+type RecursivePartial<T> = {
+  [K in keyof T]?: T[K] extends number | string | boolean | bigint ? T[K] : RecursivePartial<T[K]>;
+};
+type AppListener<Value, Result = void> = (value: Value) => MayBePromise<Result>;
+type AppEvent<Listener extends AppListener<any, any>> = (
+  listener: Listener,
+  priority?: number,
+  thisArg?: any,
+) => () => void;
+
+// type UploadEventPayload = { file: File; file_url: string };
+// type UploadListener<Cancelable = true> = Listener<UploadEventPayload, Cancelable>;
+// type UploadEvent<Cancelable = true> = AppEvent<UploadEventPayload, Cancelable>;
+
+type SaveEventPayload<T> = {
+  /** source of the event */
+  source?: string;
+  /** previous value */
+  prev?: T;
+  /** changed fields */
+  patch: Partial<T>;
+  /** next value */
+  value: T;
+};
+
+type CreateEventPayload<T> = {
+  /** source of the event */
+  source?: string;
+  /** next value */
+  value: T;
+};
+
+type RemoveEventPayload<T> = {
+  /** source of the event */
+  source?: string;
+  /** removed value */
+  value: T;
+};
+
+type MergeTagGroup = {
+  type?: 'group';
+  label: string;
+  value: string;
+  children?: MergeTag[];
+};
+
+type MergeTagItem = {
+  label: string;
+  value: string;
+};
+type MergeTag = MergeTagGroup | MergeTagItem;
+
+type SaveListener<T> = AppListener<SaveEventPayload<T>, T | undefined | void>;
+type SaveEvent<T> = AppEvent<SaveListener<T>>;
+type RemoveListener<T> = AppListener<RemoveEventPayload<T>>;
+type RemoveEvent<T> = AppEvent<RemoveListener<T>>;
+type CreateListener<T> = AppListener<CreateEventPayload<T>, T | undefined | void>;
+type CreateEvent<T> = AppEvent<CreateListener<T>>;
+
+interface ParsedAMP {
+  code: string;
+  html: string;
+  ampHtml: string;
+}
+type Notify = {
+  type?: 'success' | 'info' | 'error' | 'warning';
+  message: string | HTMLElement;
+  description?: string | HTMLElement;
+  btn?: string | HTMLElement;
+  onClose?: () => void;
+  duration?: number | null;
+  icon?: string | HTMLElement;
+  placement?: 'top' | 'topLeft' | 'topRight' | 'bottom' | 'bottomLeft' | 'bottomRight';
+  style?: any;
+  className?: string;
+  onClick?: () => void;
+  closeIcon?: boolean | string | HTMLElement;
+  props?: any;
+  role?: 'alert' | 'status';
+};
+
+type EmailDesc = {
+  id?: string;
+  title?: string;
+  code?: string;
+  subject?: string;
+  preheader?: string;
+};
+
+type BlockDesc = {
+  id?: string;
+  title?: string;
+  code?: string;
+};
+
+interface ISelection {
+  selectionStartLineNumber: number;
+  selectionStartColumn: number;
+  positionLineNumber: number;
+  positionColumn: number;
+}
+interface ISingleModelEditStackData {
+  afterCursorState: ISelection[];
+  afterVersionId: number;
+  beforeCursorState: ISelection[];
+  beforeVersionId: number;
+  changes: {
+    oldPosition: number;
+    oldText: string;
+    newPosition: number;
+    newText: string;
+  }[];
+}
+
+interface IFrameErrorInfo {
+  future: ISingleModelEditStackData[];
+  past: ISingleModelEditStackData[];
+  errorResolved: boolean;
+  message: string;
+  text: string;
+  stack: string;
+  userId: string;
+  entityId: string;
+  entityType: 'email' | 'block';
+  sentryEventId: string;
+}
+
+declare namespace Notify {
+  type Error = { innerException?: any } & (
+    | { id?: ''; data?: any }
+    | { id: 'EMAIL_CREATING_ERROR'; data: EmailDesc }
+    | { id: 'EMAIL_EDITING_ERROR'; data: EmailDesc }
+    | { id: 'FOLDER_CREATE_ERROR'; data: string }
+    | { id: 'EMAIL_CLONING_ERROR'; data: EmailDesc }
+    | { id: 'TAG_CREATING_ERROR'; data: string }
+    | { id: 'EMAIL_ACCESS_TO_LOCKED_ERROR'; data: EmailDesc }
+    | { id: 'EMAIL_TOO_MANY_TAGS_ERROR'; data: EmailDesc }
+    | { id: 'BLOCK_GET_ERROR'; data: {} }
+    | { id: 'BLOCK_ACCESS_TO_LOCKED_ERROR'; data: BlockDesc }
+    | { id: 'BLOCK_TOO_MANY_TAGS_ERROR'; data: BlockDesc }
+    | { id: 'BLOCK_CLONING_ERROR'; data: BlockDesc }
+    | { id: 'AI_IMAGE_SEND_ERROR'; data: any }
+    | { id: 'AI_IMAGE_GET_ERROR'; data: any }
+    | { id: 'IMAGE_UPLOAD_WRONG_FORMAT'; data: File }
+    | { id: 'IMAGE_UPLOAD_ERROR'; data: File }
+    | { id: 'BLOCK_CREATING_ERROR'; data: BlockDesc }
+    | { id: 'BLOCK_EDITING_ERROR'; data: BlockDesc }
+    | { id: 'EMAIL_AUTOSAVE_ERROR'; data: ExportedApi.EmailRevision }
+    | { id: 'EMAIL_INIT_EVENT_ERROR'; data: EmailDesc }
+    | { id: 'SAVE_BUTTON_CLICK_EVENT_ERROR'; data: EmailDesc }
+    | { id: 'NEXT_BUTTON_CLICK_EVENT_ERROR'; data: EmailDesc }
+    | { id: 'BLOCK_REMOVING_ERROR'; data: BlockDesc }
+    | { id: 'IFRAME_ERROR'; data: IFrameErrorInfo }
+    | { id: 'GET_LOCALE_ERROR'; data: any }
+    | { id: 'GET_LOCALES_ERROR'; data: any }
+  );
+  type ErrorEvent = {
+    type: 'error';
+  } & Error;
+
+  type Success =
+    | { id?: ''; data?: any }
+    | { id: 'EMAIL_TITLE_UPDATED_FROM_AI'; data: string }
+    | { id: 'EMAIL_PREHEADER_UPDATED_FROM_AI'; data: string }
+    | { id: 'TEXT_COPIED_TO_CLIPBOARD'; data: string }
+    | { id: 'EMAIL_SAVING_SUCCESS'; data: EmailDesc }
+    | { id: 'AI_IMAGE_SEND_SUCCESS'; data: any }
+    | { id: 'IMAGE_UPLOAD_SUCCESS'; data: File }
+    | { id: 'BLOCK_CREATING_SUCCESS'; data: BlockDesc }
+    | { id: 'BLOCK_EDITING_SUCCESS'; data: BlockDesc }
+    | { id: 'EMAIL_AUTOSAVE_SUCCESS'; data: ExportedApi.EmailRevision }
+    | { id: 'BLOCK_CLONING_SUCCESS'; data: BlockDesc }
+    | { id: 'BLOCK_REMOVING_SUCCESS'; data: BlockDesc };
+
+  type SuccessEvent = {
+    type: 'success';
+  } & Success;
+
+  type Warning =
+    | { id?: ''; data?: any }
+    | { id: 'COPY_NOT_SAVED_BLOCK'; data: ExportedApi.Block }
+    | { id: 'EMAIL_TITLE_UPDATED'; data: string };
+
+  type WarningEvent = { type: 'warning' } & Warning;
+
+  type Info = { id?: ''; data?: any };
+
+  type InfoEvent = { type: 'info' } & Info;
+}
+
+type NotifyEvent = Notify.SuccessEvent | Notify.ErrorEvent | Notify.WarningEvent | Notify.InfoEvent;
+
+declare namespace ExportedApi {
+  interface Block {
+    /**
+     * Date of publication of the record (according to the time zone of the site).
+     * @format date-time
+     */
+    date?: string | null;
+    /**
+     * Date of publication of the record, GMT.
+     * @format date-time
+     */
+    date_gmt?: string | null;
+
+    /** The unique identifier of the record. */
+    id?: string;
+    /**
+     * The URL of the record.
+     * @format uri
+     */
+
+    modified?: string;
+    /**
+     * The date the record was last modified (in GMT format).
+     * @format date-time
+     */
+    modified_gmt?: string;
+    /** The name of the entry. */
+    title?: string;
+    /** ID of the author of the entry. */
+    author?: string;
+    /** An excerpt of the recording. */
+    excerpt?: string;
+
+    subject?: string;
+    description?: string;
+    code?: string;
+    project?: string | number;
+    related_email?: string;
+    type?: string;
+  }
+}
+declare namespace ExportedApi {
+  interface BlockRevision {
+    /** ID of the editorial board author. */
+    author?: string | number;
+    /**
+     * The date of publication of the record, according to the time zone of the site.
+     * @format date-time
+     */
+    date?: string;
+    /**
+     * The time of publication of the editorial office, GMT.
+     * @format date-time
+     */
+    date_gmt?: string;
+    /** The global unique identifier of the record. */
+    guid?: {
+      /** GUID to write in the form in which it exists in the database. */
+      raw?: string;
+      /** The GUID for the record, converted for display. */
+      rendered?: string;
+    };
+    /** Unique identifier of the editorial office. */
+    id?: string;
+    /**
+     * The date of the last revision, according to the time zone of the site.
+     * @format date-time
+     */
+    modified?: string;
+    /**
+     * Date of the last revision, GMT.
+     * @format date-time
+     */
+    modified_gmt?: string;
+    /** ID of the editorial parent. */
+    parent?: string;
+    /** The alphanumeric identifier of the record is unique for its type. */
+    slug?: string;
+    /** The name of the entry. */
+    title?: string;
+    /** An excerpt of the recording. */
+    excerpt?: string;
+    /**
+     * Link to preview the recording.
+     * @format uri
+     */
+    preview_link?: string;
+
+    code?: string;
+  }
+}
+declare namespace ExportedApi {
+  enum CodeErrorSeverity {
+    Hint = 1,
+    Info = 2,
+    Warning = 4,
+    Error = 8,
+  }
+
+  enum CodeErrorTag {
+    Unnecessary = 1,
+    Deprecated = 2,
+  }
+
+  interface CodeError {
+    severity: CodeErrorSeverity;
+    message: string;
+    source?: string;
+    startLineNumber: number;
+    startColumn: number;
+    endLineNumber: number;
+    endColumn: number;
+    startOffset: number;
+    endOffset: number;
+    tags?: CodeErrorTag[];
+  }
+}
+
+declare namespace ExportedApi {
+  interface Comment {
+    /** Unique identifier for the comment. */
+    id?: string;
+    /** User object ID, if the author is a user. */
+    author?: string;
+    /**
+     * The email address of the author of the comment.
+     * @format email
+     */
+    author_email?: string;
+    /**
+     * The IP address of the comment author.
+     * @format ip
+     */
+    author_ip?: string;
+    /** The display name of the comment author. */
+    author_name?: string;
+    /**
+     * URL for the author of the comment.
+     * @format uri
+     */
+    author_url?: string;
+    /** Value of the User-Agent of the comment author. */
+    author_user_agent?: string;
+    /** The content of the comment. */
+    content?: string;
+    /**
+     * Date of publication of the comment (according to the time zone of the site).
+     * @format date-time
+     */
+    date?: string;
+    /**
+     * The time of publication of the comment, GMT.
+     * @format date-time
+     */
+    date_gmt?: string;
+    /**
+     * ID of the associated record object.
+     * @default 0
+     */
+    post?: string;
+    /** Comment status. */
+    status?: string;
+    /** Comment type. */
+    type?: string;
+    /** URL of the comment author's avatar image. */
+    author_avatar_urls?: {
+      /**
+       * URL avatars with an image size of 24 pixels.
+       * @format uri
+       */
+      '24'?: string;
+      /**
+       * URL avatars with an image size of 48 pixels.
+       * @format uri
+       */
+      '48'?: string;
+      /**
+       * URL avatars with an image size of 96 pixels.
+       * @format uri
+       */
+      '96'?: string;
+    };
+    /** Meta fields. */
+    meta?: object;
+    target_id?: string;
+
+    parent?: string;
+  }
+}
+declare namespace ExportedApi {
+  type EditorOptions = {
+    fontSize?: number;
+    fontFamily?: string;
+    tabSize?: number;
+    wordWrap?: boolean;
+    minimap?: boolean;
+    insertSpaces?: boolean;
+  };
+}
+declare namespace ExportedApi {
+  interface Email {
+    /**
+     * Date of publication of the record, GMT.
+     * @format date-time
+     */
+    date_gmt?: string | null;
+    /** Unique identifier of the record. */
+    id?: string;
+    /** The name of the letter. */
+    title?: string;
+    /** Preheader of the letter. */
+    preheader?: string;
+    /** ID of the author of the entry. */
+    author?: string;
+    lock?: boolean;
+    subject?: string;
+    description?: string;
+    code?: string;
+    project?: string | number;
+    // email tag names
+    tags?: string[];
+    utm_parameters?: {
+      utm_source?: string;
+      utm_medium?: string;
+      utm_campaign?: string;
+      utm_term?: string;
+      utm_content?: string;
+    };
+    parent_email?: string;
+    common_styles?: string;
+  }
+
+  interface CompiledEmail extends Email {
+    readonly compiled: {
+      html: string;
+      ampHtml: string;
+      text: string;
+    };
+  }
+}
+declare namespace ExportedApi {
+  interface EmailRevision {
+    /** ID of the editorial board author. */
+    author?: string;
+    /**
+     * The date of publication of the record, according to the time zone of the site.
+     * @format date-time
+     */
+    date?: string;
+    /**
+     * The time of publication of the editorial office, GMT.
+     * @format date-time
+     */
+    date_gmt?: string;
+    /** Unique identifier of the editorial office. */
+    id?: string;
+    /**
+     * The date of the last revision, according to the time zone of the site.
+     * @format date-time
+     */
+    modified?: string;
+    /**
+     * Date of the last revision, GMT.
+     * @format date-time
+     */
+    modified_gmt?: string;
+    /** ID of the editorial parent. */
+    parent?: string;
+    /** The name of the entry. */
+    title?: string;
+    /** An excerpt of the recording. */
+    excerpt?: string;
+
+    code?: string;
+
+    preheader?: string;
+
+    subject?: string;
+
+    common_styles?: string;
+  }
+
+  interface CompiledEmailRevision extends EmailRevision {
+    readonly compiled: {
+      html: string;
+      ampHtml: string;
+    };
+  }
+}
+declare namespace ExportedApi {
+  export type ThemeConfig = any;
+}
+declare namespace ExportedApi {
+  export type CodeModeDirection = 'none' | 'left' | 'right' | 'bottom';
+  export type Locale = 'en_US' | 'ru_RU';
+  export type ConfigMods = 'pro' | 'editor' | 'simple' | 'freeUserBlocks';
+
+  export interface MergeTagsInfo {
+    syntax: string[];
+    items: MergeTag[];
+  }
+
+  type LimitName = 'AiImgCount' | 'AiChatCount' | 'AiGeneratorCount' | 'OptimizationCount';
+
+  type LocaleListener = AppListener<string, string>;
+  type LimitListener = AppListener<{ name: LimitName; count: number }>;
+
+  interface AdvancedConfigs {
+    [key: string]: Config;
+  }
+
+  interface Counters {
+    optimization_counter: number;
+    ai_counter: number;
+    ai_img_counter: number;
+    ai_generator_limit: number;
+  }
+
+  interface Limits {
+    optimization_limit: number;
+    ai_limit: number;
+    ai_img_limit: number;
+    ai_generator_limit: number;
+  }
+
+  interface Config {
+    /** Application mode */
+    mode?: ConfigMods;
+
+    /** Counters and limits */
+    counters?: Counters;
+    limits?: Limits;
+    /** billing page url */
+    billingPageUrl?: string;
+
+    imageInfoToolUrl?: string;
+    /** Application Styles */
+    styles: string;
+    /** Application theme */
+    theme: string;
+    /** Application theme settings */
+    themes: { [P in string]: ThemeConfig };
+    /** showing the back arrow */
+    headerArrowBackVisible: boolean;
+    /** display of the Subject field */
+    headerTitleVisible: boolean;
+    /** showing the Preheader field */
+    headerPreheaderVisible: boolean;
+    /** showing the Header field */
+    /** showing breadcrumbs in an iframe */
+    pathEnabled: boolean;
+    /** showing copy-paste of a block in an iframe */
+    copyPasteEnabled: boolean;
+    /** showing the Version History button */
+    historyEnabled: boolean;
+    /** showing the Code-mode button */
+    codeEnabled: boolean;
+    /** showing the Code-mode button in the mode when there is a desktop/mobile switch */
+    codeSideEnabled: boolean;
+    /** showing the Preview button */
+    previewIconEnabled: boolean;
+    /** Preview link */
+    previewModeEnabled: boolean;
+    /** showing the Test button in the mailers */
+    livePreviewEnabled: boolean;
+    /** showing the Send Test button */
+    sendTestEnabled: boolean;
+    /** showing the Share button */
+    sharePreviewEnabled: boolean;
+    /** displaying the message menu */
+    emailDropdownMenuEnabled: boolean;
+    /** showing the Clone item in the message menu */
+    emailDropdownMenuClone: boolean;
+    /** showing the Import item in the emails menu */
+    emailDropdownMenuImport: boolean;
+    /** showing the Import item in the emails menu like button */
+    emailDropdownMenuImportButton: boolean;
+    /** showing the Block item in the message menu */
+    emailDropdownMenuLock: boolean;
+    /** showing the Delete item in the message menu */
+    emailDropdownMenuRemove: boolean;
+    /** showing the Export button */
+    emailExportEnabled: boolean;
+    /** showing a secondary button */
+    nextButtonEnabled: boolean;
+    /** text of the secondary button */
+    nextButtonText: string;
+    /** showing the main button */
+    saveButtonEnabled: boolean;
+    /** text of the main button */
+    saveButtonText: string;
+    commandButtonsEnabled?: boolean;
+    /** displaying the email ID */
+    emailIdShow: boolean;
+    /** side panel view */
+    sidePanelFloating: boolean;
+    /** mode switching bar */
+    desktopMobileSwitchRule: boolean;
+    /** mode switching panel */
+    desktopMobileSwitchPanel: boolean;
+    /** showing the block save button */
+    saveBlockEnabled: boolean;
+    /** showing the image change button */
+    editImageControlEnabled: boolean;
+    /** ability to collapse the sidebar */
+    toggleSidePanel: boolean;
+
+    /** Sidebar location */
+    menuDirection: string;
+
+    /** default setting of the opening tab (""/"common"/"empty") */
+    defaultBuildPanel: string;
+
+    /** Sidebar */
+    commentsEnabled: boolean;
+    optimizeEnabled: boolean;
+    settingsEnabled: boolean;
+    UTMEnabled: boolean;
+    subjectEnabled: boolean;
+    preheaderEnabled: boolean;
+    descriptionEnabled: boolean;
+    tagsEnabled: boolean;
+    /** showing the mobile properties switch */
+    switchDesktopMobilePropsEnabled: boolean;
+    /** showing transition buttons to other elements */
+    stepToOtherElementEnabled: boolean;
+    /** showing the delete element button */
+    deleteButtonEnabled: boolean;
+    /** showing the Title field in the form of an image */
+    formFieldImageTitleEnabled: boolean;
+    /** showing border change fields */
+    formFieldBorderEnabled: boolean;
+    /** showing the rounding change fields */
+    formFieldBorderRadiusEnabled: boolean;
+    /** showing shadow change fields */
+    formFieldBoxShadowEnabled: boolean;
+    /** showing buttons to change the visibility of an element */
+    formFieldVisibilityEnabled: boolean;
+    /** showing the export to picture switch */
+    formFieldExportAsPictureEnabled: boolean;
+
+    /** showing the button to insert an image into the button text */
+    formButtonFieldInsertImageEnabled: boolean;
+    /** showing vertical alignment buttons */
+    formButtonFieldVerticalAlignEnabled: boolean;
+    /** showing text alignment buttons */
+    formButtonFieldTextAlignEnabled: boolean;
+    /** showing background image fields */
+    formButtonFieldBackgroundImageEnabled: boolean;
+    /** showing internal margins */
+    formButtonFieldPaddingsEnabled: boolean;
+    /** showing replacer button */
+    formButtonFieldReplacerEnabled: boolean;
+
+    /** showing vertical alignment buttons */
+    formCellFieldVerticalAlignEnabled: boolean;
+    /** showing background image fields */
+    formCellFieldBackgroundImageEnabled: boolean;
+    /** showing internal margins */
+    formCellFieldPaddingsEnabled: boolean;
+    /** showing sizes */
+    formCellFieldSizeEnabled: boolean;
+    /** showing the button to insert an image into the button text */
+    formLinkFieldInsertImageEnabled: boolean;
+    /** showing background image fields */
+    formTableFieldBackgroundImageEnabled: boolean;
+    /** showing background image fields */
+    formDivFieldBackgroundImageEnabled: boolean;
+    /** showing background image fields */
+    formEmailFieldBackgroundImageEnabled: boolean;
+    /** showing vertical alignment buttons */
+    formImageFieldVerticalAlignEnabled: boolean;
+    /** showing replacer button */
+    formImageFieldReplacerEnabled: boolean;
+    /** showing height field */
+    formImageFieldHeightEnabled: boolean;
+    /** showing typograf button */
+    formTextFieldTypografEnabled: boolean;
+    /** showing replacer button */
+    formTextFieldReplacerEnabled: boolean;
+
+    revisionService: boolean;
+
+    /** Elements */
+    elementImageEnabled: boolean;
+    elementTextEnabled: boolean;
+    elementHeaderEnabled: boolean;
+    elementButtonEnabled: boolean;
+    elementListULEnabled: boolean;
+    elementListOLEnabled: boolean;
+    elementDividerEnabled: boolean;
+    elementSpacerEnabled: boolean;
+    elementSocialEnabled: boolean;
+    elementTableEnabled: boolean;
+    elementCountdownEnabled: boolean;
+    elementVideoEnabled: boolean;
+    elementAIimageEnabled: boolean;
+    elementAItextEnabled: boolean;
+    elementCarouselEnabled: boolean;
+    elementFormEnabled: boolean;
+    elementAccordionEnabled: boolean;
+
+    /** type of image editor display  */
+    imageCenterFileManagerView: boolean;
+
+    imageCenterStockEnabled: boolean;
+    imageCenterGifEnabled: boolean;
+    imageCenterEditorEnabled: boolean;
+    compressMaxSize: number;
+    compressMaxWidthOrHeight: number;
+
+    editor: EditorOptions;
+
+    locale: Locale;
+
+    codeModeDirection: CodeModeDirection;
+
+    preventSendDataToEM?: boolean;
+
+    mergeTags?: MergeTagsInfo;
+
+    /** showing the merge tags button */
+    mergeTagsShow?: boolean;
+
+    testEmails?: string[];
+
+    /** showing the config switch */
+    configSwither?: boolean;
+    /** Auto-save timeout */
+    autosaveTimeout?: number;
+    /** Configs that are passed to plugins */
+    advancedConfigs?: AdvancedConfigs;
+    onlyCodeModeInMobile?: boolean;
+
+    pushToGTM?: boolean;
+    /** header show */
+    headerShow?: boolean;
+    /** webversion show */
+    webversionEnabled?: boolean;
+    /** common styles show */
+    commonStylesEnabled?: boolean;
+    /** adaptive control show */
+    emailResponsiveControlEnabled?: boolean;
+    /** show export to text */
+    exportTextEnabled?: boolean;
+    /** show export to HTML */
+    exportHtmlEnabled?: boolean;
+    /** show export to ZIP */
+    exportZipEnabled?: boolean;
+    /** show export to buffer */
+    exportClipboardEnabled?: boolean;
+    /** show export to webhook */
+    exportWebHookEnabled?: boolean;
+    /** show export to Outlook */
+    exportOutlookEnabled?: boolean;
+    /** show export to PDF */
+    exportPdfEnabled?: boolean;
+    /** show export to PNG */
+    exportPngEnabled?: boolean;
+    /** AI assistant show */
+    aiAssistentEnabled?: boolean;
+    /** link check display */
+    optimizeLinksEnabled?: boolean;
+    /** picture check display */
+    optimizeImagesEnabled?: boolean;
+    /** SpamAssassin check display */
+    optimizeSpamAssassinEnabled?: boolean;
+    /** code check display */
+    optimizeCheckCodeEnabled?: boolean;
+    /** Displaying a field Template */
+    isTemplateEnabled?: boolean;
+    /** block menu display */
+    blocksSectionsShow?: boolean;
+    /** empty blocks display */
+    blocksEmptyEnabled?: boolean;
+    /** display of saved blocks */
+    blocksSavedEnabled?: boolean;
+    /** common blocks display */
+    blocksCommonEnabled?: boolean;
+    /** template blocks display */
+    blocksTemplateEnabled?: boolean;
+    /** block search display */
+    blocksSearchEnabled?: boolean;
+    /** showing the panel for adding a block in the visual editor */
+    blocksAddPanelEnabled?: boolean;
+    /** turns off template editing */
+    lockEditor?: boolean;
+    /** turns off preheader and title editing */
+    lockPreheaderAndTitle?: boolean;
+    /** turns off preheader and title editing */
+    disableSideMenu?: boolean;
+    /** Showing a drop-down card with a path to the picture */
+    imagePathDropdownEnabled?: boolean;
+
+    /** Showing change visibility buttons in amp emails */
+    formFieldAmpVisibilityEnabled?: boolean;
+    /** Disable double click on next button  */
+    disableDoubleClickNextButton?: boolean;
+    /** manually change state of next button  */
+    activeNextButton?: boolean;
+  }
+
+  export interface User {
+    id?: string | number;
+    /** The login name for the user. */
+    username?: string;
+    /** User's display name */
+    user?: string;
+    /** The user's email address. @format email */
+    email?: string;
+    /** URL of the user's avatar. */
+    avatar_urls?: {
+      /** URL avatars with an image size of 24 pixels. @format uri */
+      '24'?: string;
+      '48'?: string;
+      '96'?: string;
+    };
+  }
+
+  namespace AppConfigMixin {
+    interface Options {
+      config?: Partial<Config>;
+      advancedConfigs?: AdvancedConfigs;
+      project?: string | number;
+      user?: User;
+      handleReadLocale?: LocaleListener;
+      handleLimitUsage?: LimitListener;
+    }
+
+    interface Instance {
+      setConfig(config: Partial<Config>): Promise<void>;
+      getConfig(): Partial<Config>;
+      updateConfig(config: Partial<Config>): Promise<void>;
+      handleReadLocale: AppEvent<LocaleListener>;
+      handleLimitUsage?: AppEvent<LimitListener>;
+    }
+  }
+  interface Options extends AppConfigMixin.Options {}
+
+  interface Instance extends AppConfigMixin.Instance {}
+}
+declare namespace ExportedApi {
+  namespace AppInitMixin {
+    interface Options {
+      /** base url of the app server */
+      baseUrl?: string;
+    }
+
+    interface Instance {}
+  }
+  interface Options extends AppInitMixin.Options {}
+
+  interface Instance extends AppInitMixin.Instance {}
+}
+
+declare namespace ExportedApi {
+  export type JWTAuthOptions = {
+    email: string;
+    password: string;
+    remember?: boolean;
+  };
+
+  type JWTOptions = {
+    /** JWT authorization credentials */
+    jwtAuth?: JWTAuthOptions;
+  };
+  namespace JWTMixin {
+    interface Options extends JWTOptions {}
+
+    interface Instance {}
+  }
+  interface Options extends JWTMixin.Options {}
+
+  interface Instance extends JWTMixin.Instance {}
+}
+declare namespace ExportedApi {
+  type OAuthCallback = (prevToken?: string) => MayBePromise<string>;
+
+  type OAuthOptions = {
+    /**
+     * Get token callback
+     */
+    getAuthToken?: OAuthCallback;
+  };
+  namespace OAuthMixin {
+    interface Options extends OAuthOptions {}
+
+    interface Instance {}
+  }
+  interface Options extends OAuthMixin.Options {}
+
+  interface Instance extends OAuthMixin.Instance {}
+}
+
+declare namespace ExportedApi {
+  interface CoreOptions {
+    element?: string | Element | DocumentFragment;
+    handleChunkLoaded?: () => void;
+  }
+  namespace CoreMixin {
+    interface Options extends CoreOptions {}
+
+    interface Instance {
+      getElement(): Element | DocumentFragment | undefined;
+    }
+  }
+  interface Options extends CoreMixin.Options {}
+
+  interface Instance extends CoreMixin.Instance {}
+}
+declare namespace ExportedApi {
+  namespace DataMixin {
+    type BlockShowOptions = {
+      /** block content */
+      block: Block | string;
+      /** autosaves */
+      revisions?: BlockRevision[];
+      /** comments */
+      comments?: Comment[];
+      /** blocks */
+      blocks?: Block[];
+      /** template identifier for email */
+      templateId?: string | number;
+    };
+
+    type EmailShowOptions = {
+      /** email content */
+      email: Email | string;
+      /** autosaves */
+      autosaves?: EmailRevision[];
+      /** comments */
+      comments?: Comment[];
+      /** blocks */
+      blocks?: Block[];
+      /** template identifier for block */
+      templateId?: number;
+    };
+
+    type Content = string | Email | EmailShowOptions;
+
+    type ReadEmailHandler = (id: string) => MayBePromise<Email>;
+    type ReadEmailAutosavesHandler = (emailId: string) => MayBePromise<EmailRevision[]>;
+    type ReadBlocksHandler = (project: string) => MayBePromise<Block[]>;
+    type ReadTemplateBlocksHandler = ({ emailId: string, project: string }) => MayBePromise<Block[]>;
+    type ReadCommentsHandler = (emailId: string) => MayBePromise<Comment[]>;
+
+    type EmailHandler = AppListener<Email>;
+    type HtmlHandler = AppListener<string>;
+
+    type TestEmailSendEventPayload = {
+      project?: string;
+      email_id?: string;
+      subject?: string;
+      email?: string;
+      code?: string;
+      from_name?: string;
+    };
+
+    type TestEmailSendHandler = AppListener<TestEmailSendEventPayload, false | void>;
+
+    type TestEmailModalSendHandler = AppListener<Email, false | void>;
+
+    type LivePreviewHandler = AppListener<{
+      project?: string;
+      id: string;
+      subject?: string;
+      html: string;
+    }>;
+
+    type ShareHandler = AppListener<{
+      project?: string;
+      id: string;
+    }>;
+
+    type PreviewHandler = AppListener<{
+      project?: string;
+      id: string;
+    }>;
+
+    type ValidateEvent = AppListener<CodeError[]>;
+
+    interface Events {
+      /** read email handler */
+      handleReadEmail: AppEvent<ReadEmailHandler>;
+      /** fires when email saved */
+      handleSaveEmail: SaveEvent<Email>;
+      /** fires when email delete */
+      handleRemoveEmail: RemoveEvent<Email>;
+
+      /**  read autosaves handler */
+      handleReadEmailRevisions: AppEvent<ReadEmailAutosavesHandler>;
+      /** fires when email autosave */
+      handleEmailAutosave: CreateEvent<EmailRevision>;
+      /** fires when email autosave delete */
+      handleRemoveEmailAutoSave: RemoveEvent<EmailRevision>;
+      /** read common blocks handler */
+      handleReadCommonBlocks: AppEvent<ReadBlocksHandler>;
+      /** read template blocks handler */
+      handleReadTemplateBlocks: AppEvent<ReadTemplateBlocksHandler>;
+      /** read blocks handler */
+      handleReadBlocks: AppEvent<ReadBlocksHandler>;
+      /** fires when block save */
+      handleSaveBlock: SaveEvent<Block>;
+      /** fires when block delete */
+      handleRemoveBlock: RemoveEvent<Block>;
+
+      /** read comments handler */
+      handleReadComments: AppEvent<ReadCommentsHandler>;
+      /** fires when comment save */
+      handleSaveComment: SaveEvent<Comment>;
+      /** fires when comment delete */
+      handleRemoveComment: RemoveEvent<Comment>;
+
+      /** fires when user clicked on 'save' button */
+      handleSaveButtonClick: AppEvent<EmailHandler>;
+      /** fires when user clicked on 'next' button */
+      handleNextButtonClick: AppEvent<EmailHandler>;
+      /** fires when user clicked on 'previous' button */
+      handlePreviousButtonClick: AppEvent<EmailHandler>;
+      /** fires when email iframe inited */
+      handleEmailInit: AppEvent<EmailHandler>;
+      /** fires when email changed */
+      handleEmailChanged: AppEvent<EmailHandler>;
+      /** fires when email subject inited */
+      handleSubjectChanged: (
+        listener: (subject: string) => MayBePromise<void>,
+        priority?: number,
+        thisArg?: any,
+      ) => () => void;
+      /** fires when email subject inited */
+      handlePreheaderChanged: (
+        listener: (preheader: string) => MayBePromise<void>,
+        priority?: number,
+        thisArg?: any,
+      ) => () => void;
+      /** fires when email Html changed */
+      handleHtmlChanged: AppEvent<HtmlHandler>;
+      /** fires when test email send*/
+      handleTestEmailSend: AppEvent<TestEmailSendHandler>;
+      /** fires when open test email modal */
+      handleTestEmailModal: AppEvent<TestEmailModalSendHandler>;
+      /** fires when email clone */
+      handleCloneEmail: AppEvent<EmailHandler>;
+      /** fires when email share */
+      handleShareEmail: AppEvent<ShareHandler>;
+      /** fires when open live preview */
+      handleLivePreviewEmail: AppEvent<LivePreviewHandler>;
+      /** fires when open preview */
+      handlePreviewEmail: AppEvent<PreviewHandler>;
+      /** fires when email validate */
+      handleValidate: AppEvent<ValidateEvent>;
+    }
+
+    type Listeners = { [K in keyof Events]?: Events[K] extends AppEvent<infer Listener> ? Listener : never };
+    interface Options extends Listeners {
+      /** entity content */
+      content: Content;
+    }
+
+    interface Instance extends Events {
+      /**
+       * show block or email
+       * @param content entity content
+       */
+      show(content: Content): Promise<void>;
+      /** save current  email */
+      save(): Promise<Email>;
+      /**
+       * get email from inner storage
+       */
+      getEmail(): Promise<CompiledEmail>;
+      /**
+       * get compiled email
+       */
+      compileEmail(email?: Email, all?: boolean | { text?: boolean; amp?: boolean }): Promise<CompiledEmail>;
+      /**
+       * get blocks from inner storage
+       */
+      getBlocks(): Promise<Block[]>;
+      /**
+       * get email satosaves
+       * @param emailId email identifier
+       */
+      getEmailRevisions(): Promise<EmailRevision[]>;
+      /**
+       * get email comments
+       */
+      getComments(): Promise<Comment[]>;
+      /**
+       * get current code errors
+       */
+      getCodeErrors(): CodeError[] | undefined;
+    }
+  }
+  interface Options extends DataMixin.Options {
+    standaloneKey?: string;
+  }
+
+  interface Instance extends DataMixin.Instance {}
+}
+declare namespace ExportedApi {
+  namespace DestroyableMixin {
+    type DestroyListener = AppListener<ExportedApi.Instance>;
+    interface Options {
+      handleDestroy?: DestroyListener;
+    }
+
+    interface Instance {
+      /** fires when app destroyed */
+      handleDestroy: AppEvent<DestroyListener>;
+      destroy(): void;
+    }
+  }
+  interface Options extends DestroyableMixin.Options {}
+
+  interface Instance extends DestroyableMixin.Instance {}
+}
+declare namespace ExportedApi {
+  namespace SpinMixin {
+    interface Options {
+      element?: string | Element | DocumentFragment;
+      initialSpinner?: false;
+    }
+
+    interface Instance {}
+  }
+  interface Options extends SpinMixin.Options {}
+
+  interface Instance extends SpinMixin.Instance {}
+}
+declare namespace ExportedApi {
+  namespace ImageHandlerMixin {
+    type LoadEventPayload = { file: File; project: string };
+    type FileProxyEventPayload = { url: string; project: string };
+    type LoadImageListener = AppListener<LoadEventPayload, string | void>;
+    type FileProxyListener = AppListener<FileProxyEventPayload, Blob | void>;
+    interface Options {
+      handleLoadImage?: LoadImageListener;
+      handleFileProxy?: FileProxyListener;
+    }
+
+    interface Instance {
+      /** fires when image loading */
+      handleLoadImage: AppEvent<LoadImageListener>;
+      handleFileProxy: AppEvent<FileProxyListener>;
+    }
+  }
+  interface Options extends ImageHandlerMixin.Options {}
+
+  interface Instance extends ImageHandlerMixin.Instance {}
+}
+declare namespace ExportedApi {
+  namespace LoadHandlerMixin {
+    type LoadListener = AppListener<ExportedApi.Instance>;
+    interface Options {
+      handleLoad?: LoadListener;
+    }
+
+    interface Instance {
+      /** fires when app loaded */
+      handleLoad: AppEvent<LoadListener>;
+      reset(options: ExportedApi.Options): Promise<ExportedApi.Instance>;
+    }
+  }
+  interface Options extends LoadHandlerMixin.Options {}
+
+  interface Instance extends LoadHandlerMixin.Instance {}
+}
+declare namespace ExportedApi {
+  type ConfigNotify = Notify & Partial<NotifyEvent> & { message: string | HTMLElement };
+  namespace NotificationMixin {
+    type NotifyListener = AppListener<NotifyEvent, ConfigNotify | string | false | void>;
+    type ErrorListener = AppListener<Notify.ErrorEvent, ConfigNotify | string | false | void>;
+    type SuccessListener = AppListener<Notify.SuccessEvent, ConfigNotify | string | false | void>;
+    interface Options {
+      handleNotify?: NotifyListener;
+      handleError?: ErrorListener;
+      handleSuccess?: SuccessListener;
+    }
+
+    interface Instance {
+      handleNotify: AppEvent<NotifyListener>;
+      handleError: AppEvent<ErrorListener>;
+      handleSuccess: AppEvent<SuccessListener>;
+      notify(config: ConfigNotify | string): void;
+    }
+  }
+  interface Options extends NotificationMixin.Options {}
+
+  interface Instance extends NotificationMixin.Instance {}
+}
+
+interface EditStackData {
+  serialize(): ArrayBuffer;
+}
+
+interface EditStackSnapshot {
+  resource: string;
+  elements: unknown[];
+}
+
+interface IUndoRedoService {
+  /**
+   * Undoes the last performed action, reverting the state to the previous step in history.
+   * If the history is empty, this method does nothing.
+   */
+  undo: () => void;
+
+  /**
+   * Redoes an undone action, moving the state forward in history.
+   * If there are no undone actions, this method does nothing.
+   */
+  redo: () => void;
+
+  /**
+   * Clears the entire history of changes, including both undone and redone operations.
+   * After calling this method, both the `undo` and `redo` histories will be empty.
+   */
+  clear: () => void;
+
+  /**
+   * Returns an array of all previously performed changes that can be undone.
+   * This represents the stack of actions available for `undo()`.
+   * @returns An array of `EditStackData` objects representing past changes.
+   */
+  getPast: () => EditStackData[];
+
+  /**
+   * Returns an array of changes that have been undone and can be redone.
+   * This represents the stack of actions available for `redo()`.
+   * @returns An array of `EditStackData` objects representing future changes.
+   */
+  getFuture: () => EditStackData[];
+
+  /**
+   * Checks whether there is at least one action in history that can be undone.
+   * @returns `true` if `undo()` can be performed, otherwise `false`.
+   */
+  canUndo: () => boolean;
+
+  /**
+   * Checks whether there is at least one undone action that can be redone.
+   * @returns `true` if `redo()` can be performed, otherwise `false`.
+   */
+  canRedo: () => boolean;
+
+  /**
+   * Creates a snapshot of the current state, which can be saved and restored later.
+   * Useful for serializing the change history.
+   * @returns An `EditStackSnapshot` object containing the state of the change history.
+   */
+  createSnapshot: () => EditStackSnapshot;
+
+  /**
+   * Restores the change history state from the provided snapshot.
+   * Allows loading a previously saved history.
+   * @param snapshot An `EditStackSnapshot` object containing the saved history state.
+   */
+  restoreSnapshot: (snapshot: EditStackSnapshot) => void;
+}
+
+/**
+ * Folder information.
+ */
+export interface FolderInfo {
+  /** Unique folder identifier */
+  id: string;
+  /** Folder name */
+  name: string;
+  /** Parent folder identifier (null or undefined if it's a root folder) */
+  parentId?: string | null;
+}
+
+/**
+ * File information.
+ */
+export interface FileInfo {
+  /** Unique file identifier */
+  id: string;
+  /** File name */
+  name: string;
+  /** File size as a string (e.g., "15MB") */
+  size: string;
+  /** File creation or upload date */
+  date: string;
+  /** Identifier of the folder the file belongs to */
+  folderId: string;
+  /** File MIME type */
+  type?: string;
+  /** File download URL (used if `getFile` method is not implemented) */
+  url?: string;
+  /** File thumbnail */
+  thumbnail?: string;
+  /** Alternative thumbnail URL */
+  thumbnailUrl?: string;
+  /** Image dimensions (width x height) */
+  dimensions?: string;
+  /** Aspect ratio */
+  aspectRatio?: string;
+  /** File extension */
+  extension?: string;
+  /** Whether the file is selected in the UI */
+  selected?: boolean;
+  /** Whether the item is a folder */
+  isFolder?: boolean;
+  /** Date when the file was last edited */
+  lastEdited?: string;
+}
+
+/**
+ * API response with pagination details.
+ */
+export interface ApiPaginationResponse {
+  /** Current page number */
+  page: number;
+  /** Number of items per page */
+  limit: number;
+  /** Total number of items */
+  total: number;
+  /** Total number of pages */
+  totalPages: number;
+  /** Whether there is a next page */
+  hasNext: boolean;
+  /** Whether there is a previous page */
+  hasPrev: boolean;
+}
+
+/**
+ * Sorting state.
+ */
+export interface SortState {
+  /** Field to sort by */
+  sortBy: 'name' | 'size' | 'date' | 'type';
+  /** Sort order */
+  sortOrder: 'asc' | 'desc';
+}
+
+/**
+ * Interface for storage providers.
+ * Defines the contract for different storage backends (e.g., cloud APIs).
+ */
+export interface StorageProvider {
+  /**
+   * Retrieve the file content as a binary blob.
+   *
+   * ⚠️ If this method is not implemented, the file will be downloaded
+   * using the `url` property from the `FileInfo` object.
+   *
+   * @param fileId File identifier
+   * @returns File contents as a Blob
+   */
+  getFile?: (fileId: string) => Promise<Blob>;
+
+  /**
+   * Retrieve a list of folders.
+   *
+   * @returns List of folder objects
+   */
+  getFolders: () => Promise<FolderInfo[]>;
+
+  /**
+   * Retrieve a list of files.
+   * Supports filtering, sorting, and pagination.
+   *
+   * @param options.folderId Folder identifier (default: root folder)
+   * @param options.search Search query
+   * @param options.sortBy Field to sort by
+   * @param options.sortOrder Sort direction
+   * @param options.page Page number
+   * @param options.limit Number of items per page
+   * @returns List of files and optional pagination details
+   */
+  getFiles: (options: {
+    folderId?: string;
+    search?: string;
+    sortBy?: SortState['sortBy'];
+    sortOrder?: SortState['sortOrder'];
+    page?: number;
+    limit?: number;
+  }) => Promise<{
+    files: FileInfo[];
+    pagination?: Partial<ApiPaginationResponse>;
+  }>;
+
+  /**
+   * Create a new folder.
+   *
+   * @param data.name Folder name
+   * @param data.parentId Parent folder identifier (or null/undefined for root)
+   * @returns The created folder object
+   */
+  createFolder: (data: { name: string; parentId?: string | null }) => Promise<FolderInfo>;
+
+  /**
+   * Rename a folder.
+   *
+   * @param folderId Folder identifier
+   * @param newName New folder name
+   * @returns Updated folder object
+   */
+  renameFolder: (folderId: string, newName: string) => Promise<FolderInfo>;
+
+  /**
+   * Delete a folder.
+   *
+   * @param folderId Folder identifier
+   * @returns true if deletion was successful
+   */
+  deleteFolder: (folderId: string) => Promise<boolean>;
+
+  /**
+   * Upload a file.
+   *
+   * @param file.name File name
+   * @param file.size File size
+   * @param file.type MIME type
+   * @param file.folderId Target folder identifier (or null/undefined for root)
+   * @param file.data File data (Blob or base64 string)
+   * @param file.thumbnail Thumbnail image
+   * @param file.dimensions Image dimensions
+   * @param file.aspectRatio Aspect ratio
+   * @param file.extension File extension
+   * @returns The uploaded file object
+   */
+  uploadFile: (file: {
+    name: string;
+    size: string;
+    type: string;
+    folderId?: string | null;
+    data: Blob | string;
+    thumbnail?: string;
+    dimensions?: string;
+    aspectRatio?: string;
+    extension?: string;
+  }) => Promise<FileInfo>;
+
+  /**
+   * Upload a file by URL.
+   *
+   * ⚠️ Implementation should check if the file already belongs
+   * to the current server. If it does, return the existing file object
+   * instead of uploading it again.
+   *
+   * @param data.url File URL
+   * @param data.folderId Target folder identifier (or null/undefined for root)
+   * @param data.noFolder If true, the file should be uploaded to a temporary
+   * folder (for example, when editing a file)
+   * @returns The uploaded or existing file object
+   */
+  uploadFileByUrl: (data: { url: string; folderId?: string | null; noFolder?: boolean }) => Promise<FileInfo>;
+
+  /**
+   * Delete a file.
+   *
+   * @param fileId File identifier
+   * @returns true if deletion was successful
+   */
+  deleteFile: (fileId: string) => Promise<boolean>;
+
+  /**
+   * Rename a file.
+   *
+   * @param fileId File identifier
+   * @param newName New file name
+   * @returns Updated file object
+   */
+  renameFile: (fileId: string, newName: string) => Promise<FileInfo>;
+
+  /**
+   * Move a file or folder to another location.
+   *
+   * @param options.itemId Identifier of the item to move
+   * @param options.targetFolderId Target folder identifier
+   * @param options.isFolder true if the item is a folder
+   * @returns true if the move operation was successful
+   */
+  moveItem: (options: { itemId: string; targetFolderId: string; isFolder: boolean }) => Promise<boolean>;
+
+  /**
+   * Copy a file or folder.
+   *
+   * @param options.itemId Identifier of the item to copy
+   * @param options.targetFolderId Target folder identifier
+   * @param options.isFolder true if the item is a folder
+   * @returns Object with the new item identifier (and optionally a new URL)
+   */
+  copyItem: (options: {
+    itemId: string;
+    targetFolderId: string;
+    isFolder: boolean;
+  }) => Promise<{ id: string; url?: string }>;
+
+  /**
+   * Update file metadata or content.
+   *
+   * @param fileId File identifier
+   * @param updates Object with fields to update (name, type, data, thumbnail, etc.)
+   * @returns Updated file object
+   */
+  updateFile: (
+    fileId: string,
+    updates: {
+      name?: string;
+      type?: string;
+      data?: Blob | string;
+      thumbnail?: string;
+      dimensions?: string;
+      aspectRatio?: string;
+      extension?: string;
+    },
+  ) => Promise<FileInfo>;
+}
+
+declare module ExportedApi {
+  export interface Options {
+    storageProvider?: StorageProvider;
+  }
+}
+
+declare namespace ExportedApi {
+  namespace UndoRedoMixin {
+    interface Instance {
+      /**
+       * An instance of `IUndoRedoService` that manages undo and redo operations.
+       */
+      undoRedoService: IUndoRedoService;
+    }
+  }
+
+  interface Instance extends UndoRedoMixin.Instance {}
+}
+
+declare namespace ExportedApi {
+  interface Instance {
+    /** reset app config */
+    reset(options: Options): Promise<Instance>;
+  }
+}
+
+export type Instance = ExportedApi.Instance;
+
+export type Options = ExportedApi.Options;
+
+/**
+ * initialize app instance
+ * @param {options} app options
+ * @returns app instance
+ */
+export function init(options: Options): Promise<Instance>;
+/**
+ * parse AMP email
+ * @param {code} email or code
+ * @returns object, contains pure html and AMP code
+ */
+export function parseAMP(code: string | { code: string }): Promise<ParsedAMP>;
+/**
+ * app version
+ */
+export const version: string;