@unlayer/types 1.526.0 → 1.529.0

package/dist/editor/editor.d.ts

@@ -4,7 +4,7 @@ import type { Audit, Validator } from './audit';
 import type { EditorSettings, InferSchemaType, SafeHtmlOptions, Tabs, User, WidgetConfig, WidgetMountFn, WidgetRenderFn } from './config';
 import type { DesignMode, DesignTags, DesignTagsConfig, JSONTemplate } from './design';
 import type { DisplayConditions } from './display-conditions';
-import type { ExportFromApiResult, ExportHtmlOptions, ExportHtmlResult, ExportImageFromApiOptions, ExportLiveHtmlOptions, ExportLiveHtmlResult, ExportPdfFromApiOptions, ExportPlainTextOptions, ExportPlainTextResult, ExportZipFromApiOptions, SaveDesignOptions } from './export';
+import type { ExportFromApiResult, ExportHtmlOptions, ExportHtmlResult, ExportImageFromApiOptions, ExportLiveHtmlOptions, ExportLiveHtmlResult, ExportPdfFromApiOptions, ExportPlainTextOptions, ExportPlainTextResult, ExportZipFromApiOptions, PdfWatermarkOptions, SaveDesignOptions } from './export';
 import type { ColorPicker, Features } from './features';
 import type { Fonts } from './font';
 import type { Language, Locale, TextDirection, Translations, UnlayerLocale, UnlayerTranslations } from './intl';
@@ -337,6 +337,16 @@ interface Config {
     agentApi?: boolean;
 }
 
+export type PdfWatermarkPosition =
+  | 'diagonal'
+  | 'center'
+  | 'top'
+  | 'bottom';
+/**
+ * Custom watermark drawn over every page of a document-mode PDF preview or
+ * export. Requires a plan that includes Document Watermarks.
+ */
+
 export interface AgentTarget {
     /** Index into `describe().editors`. Defaults to the first editor. */
     editor?: number;
@@ -607,6 +617,12 @@ declare class EditorClass<TClassDisplayMode extends DisplayMode | undefined = un
     showPreview(payload: {
         device?: Device;
         resolution?: number;
+        /**
+         * Watermark for the document PDF preview and its Download PDF
+         * button. Overrides the `features.watermark` init option; `false` turns
+         * it off for this preview.
+         */
+        watermark?: PdfWatermarkOptions | false;
     } | Device): void;
     hidePreview(): void;
     canUndo(callback: (result: boolean) => void): void;

package/dist/editor/export.d.ts

@@ -1,6 +1,7 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
 import type { JSONTemplate } from './design';
+import type { PdfWatermarkPosition } from './editor';
 import type { FontList } from './font';
 import type { TextDirection } from './intl';
 import type { MergeTagsValues } from './merge-tags';
@@ -116,9 +117,28 @@ export type PdfPageSize =
   | 'A5'
   | 'A6';
 
+export interface PdfWatermarkOptions {
+    /** Plain text, printed literally on one line (1-100 characters, no HTML). */
+    text: string;
+    /** Where the watermark sits on each page. Defaults to `'diagonal'`. */
+    position?: PdfWatermarkPosition;
+    /** Opacity from 0.05 to 1. Defaults to 0.2. */
+    opacity?: number;
+    /**
+     * Color as `#RGB`, `#RRGGBB` or `rgb(r, g, b)` with 0-255 channels.
+     * Defaults to `#808080`.
+     */
+    color?: string;
+}
+
 export interface ExportPdfFromApiOptions extends BaseExportFromApiOptions {
     documentOrientation?: DocumentOrientation;
     pageSize?: PdfPageSize;
+    /**
+     * Watermark for this export. Overrides the `features.watermark` init option;
+     * `false` turns the init default off for this call.
+     */
+    watermark?: PdfWatermarkOptions | false;
 }
 
 export interface ExportZipFromApiOptions extends BaseExportFromApiOptions {

package/dist/editor/features.d.ts

@@ -1,6 +1,7 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
 import type { AIImageProvider, AIProvider, ImageSource, InboxPreviewClientId } from './editor';
+import type { PdfWatermarkOptions } from './export';
 import type { Language } from './intl';
 import type { Resolution } from './types';
 
@@ -356,6 +357,13 @@ export interface Features {
     syncedBlocks?: boolean;
     minimap?: boolean;
     normalizeEmailLineHeights?: boolean;
+    /**
+     * Default watermark for every document PDF preview and `exportPdf` call,
+     * also drawn on each page of the document canvas and its minimap. A call's
+     * own `watermark` option overrides it. Requires a plan that includes
+     * Document Watermarks.
+     */
+    watermark?: PdfWatermarkOptions;
 }
 
 // ───────────────────────────────────────────────────────────────────────────

package/dist/editor/intl.d.ts

@@ -798,6 +798,16 @@ export type EditorTranslationKey =
   | 'modals.preview.download_pdf.downloading'
   | 'modals.preview.download_pdf.not_downloaded'
   | 'modals.preview.download_pdf.subscription_expired'
+  | 'modals.preview.download_pdf.watermark_invalid'
+  | 'modals.preview.download_pdf.watermark_not_confirmed'
+  | 'modals.preview.download_pdf.watermark_not_included'
+  | 'modals.preview.download_pdf.watermark_problem_color'
+  | 'modals.preview.download_pdf.watermark_problem_opacity'
+  | 'modals.preview.download_pdf.watermark_problem_options'
+  | 'modals.preview.download_pdf.watermark_problem_position'
+  | 'modals.preview.download_pdf.watermark_problem_shape'
+  | 'modals.preview.download_pdf.watermark_problem_text'
+  | 'modals.preview.download_pdf.watermark_problem_text_too_long'
   | 'modals.preview.exit_preview'
   | 'modals.preview.inbox_preview.button.check_status'
   | 'modals.preview.inbox_preview.button.generate_again'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unlayer/types",
-  "version": "1.526.0",
+  "version": "1.529.0",
   "license": "MIT",
   "private": false,
   "types": "./dist/index.d.ts",