@unlayer/types 1.509.0 → 1.512.0

package/dist/editor/config.d.ts

@@ -36,8 +36,46 @@ export type User = {
     id?: string | number;
     name?: string | null | undefined;
     avatar?: string | null | undefined;
-    email?: string;
+    email?: string | null;
     signature?: string;
+    /**
+     * Signed feature policy generated on your server. Supersedes `signature`: it
+     * covers the same user id and additionally carries the features this
+     * particular end user may use.
+     *
+     * Build it with your project secret, never in the browser:
+     *
+     * ```js
+     * const claims  = { id, exp, features: { ai: { fullTemplateGeneration: false } } };
+     * const payload = Buffer.from(JSON.stringify(claims)).toString('base64url');
+     * const salt    = 'unlayer:end-user-policy-token:v1:salt';
+     * const info    = 'unlayer:end-user-policy-token:v1:signing-key';
+     * const key     = Buffer.from(hkdfSync('sha256', SECRET, salt, info, 32));
+     * const signed  = `v1.${payload}`;
+     * const token   = `${signed}.${createHmac('sha256', key).update(signed).digest('hex')}`;
+     * ```
+     *
+     * `features` accepts the boolean feature-flag portion of
+     * `unlayer.init({ features })`: objects are containers and every leaf must be
+     * `true` or `false`. It can only restrict; a policy cannot grant a feature
+     * the project's plan excludes.
+     */
+    featurePolicyToken?: string | null;
+    /**
+     * Your own fields. Anything beyond the properties above is stored with the
+     * end user and returned on the next session, merged into what is already
+     * stored — so a field you stop sending keeps its last value. Unlayer never
+     * interprets them.
+     *
+     * Reserved names are dropped here: the credentials above, plus `projectId`,
+     * `customId`, `consoleAttestation`, `entitlements`, `featurePolicy`,
+     * `policyExp`, `featurePolicyVerified`, `legacySignatureVerified`,
+     * `consoleSession`, `_consoleSession`, `_consoleSessionId`,
+     * `_consoleSessionProof`, `_consoleUserId`, `consoleContextVerified`,
+     * `consoleSessionExp`, `consoleSessionId`, `consoleUserId`, and
+     * `consoleSessionProof`. Prefer names specific to your application.
+     */
+    [field: string]: unknown;
 };
 
 export type JSONSchema = Record<string, unknown>;

package/dist/editor/editor.d.ts

@@ -431,12 +431,41 @@ declare class EditorClass<TClassDisplayMode extends DisplayMode | undefined = un
     setTextDirection(textDirection: TextDirection | null): void;
     setTranslations(translations: Translations): void;
     loadBlank(bodyValues?: object): void;
+    /**
+     * Loads a design JSON into the editor, replacing the current design.
+     *
+     * Get design JSON from `saveDesign()` or `exportHtml()`, or generate it from React code with
+     * `renderToJson()` from `@unlayer/react-elements` (templates written in code by developers,
+     * coding agents, or an LLM at runtime stay editable here).
+     *
+     * @see https://docs.unlayer.com/builder/load-and-save-designs
+     * @see https://docs.unlayer.com/elements
+     */
     loadDesign<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(design: JSONTemplate<TDisplayMode>): void;
+    /**
+     * Returns the current design JSON in the callback. Store it and pass it to `loadDesign()` to
+     * reopen the design for editing later.
+     *
+     * @see https://docs.unlayer.com/builder/load-and-save-designs
+     */
     saveDesign<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: JSONTemplate<TDisplayMode>) => void, options?: SaveDesignOptions): void;
+    /**
+     * Exports the current design as HTML. The callback receives `{ html, design }`: send or render
+     * the `html`, and store the `design` JSON to reopen it with `loadDesign()`.
+     *
+     * @see https://docs.unlayer.com/builder/export-html
+     */
     exportHtml<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportHtmlResult<TDisplayMode>) => void, options?: ExportHtmlOptions): void;
     exportLiveHtml<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportLiveHtmlResult<TDisplayMode>) => void, options?: ExportLiveHtmlOptions): void;
     exportPlainText<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportPlainTextResult<TDisplayMode>) => void, options?: ExportPlainTextOptions): void;
     exportImage<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportFromApiResult<TDisplayMode>) => void, options?: ExportImageFromApiOptions): void;
+    /**
+     * Exports the current design as a PDF. Unlike `exportHtml()`, the PDF is generated by Unlayer's
+     * Cloud API, uploaded to your connected file storage, and the callback receives
+     * `{ url, design }`.
+     *
+     * @see https://docs.unlayer.com/builder/export-pdf
+     */
     exportPdf<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportFromApiResult<TDisplayMode>) => void, options?: ExportPdfFromApiOptions): void;
     exportZip<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportFromApiResult<TDisplayMode>) => void, options?: ExportZipFromApiOptions): void;
     setAppearance(appearance: DeepPartial<AppearanceConfig>): void;

package/package.json

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