@unlayer/types 1.386.0 → 1.386.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Unlayer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,60 @@
+# @unlayer/types
+
+TypeScript types for the [Unlayer](https://unlayer.com) email editor.
+
+## Install
+
+```sh
+npm install @unlayer/types
+```
+
+## Usage
+
+```ts
+import type {
+  UnlayerEditor,
+  UnlayerOptions,
+  JSONTemplate,
+  ButtonValues,
+  BodyValues,
+} from '@unlayer/types';
+
+// Editor options
+const options: UnlayerOptions = {
+  displayMode: 'email',
+  projectId: 12345,
+};
+
+// JSONTemplate types for each Display Mode
+type EmailDesign = JSONTemplate<'email'>; // body.values has preheaderText
+type PopupDesign = JSONTemplate<'popup'>; // body.values has popupPosition
+
+// Container and Tool types, e.g. BodyValues, RowValues, ButtonValues, etc
+type EmailBody = BodyValues<'email'>; // has preheaderText, lacks popupPosition
+type PopupBody = BodyValues<'popup'>; // has popupPosition, lacks preheaderText
+
+// Export methods accept a display mode generic that narrows the design types:
+declare const unlayer: UnlayerEditor;
+unlayer.exportHtml<'email'>((result) => {
+  const html = result.html;
+  const preheaderText = result.design.body.values.preheaderText; // typed, email-only field
+});
+
+// Example of fully typed json manipulation
+function handleDesign(design: JSONTemplate) {
+  for (const row of design.body.rows) {
+    for (const column of row.columns) {
+      for (const content of column.contents) {
+        if (content.type === 'button') {
+          // content.values type is narrowed to ButtonValues
+          console.info('Button found', content.id, content.values.buttonColors);
+        }
+      }
+    }
+  }
+}
+```
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@unlayer/types",
-  "version": "1.386.0",
+  "version": "1.386.2",
+  "license": "MIT",
   "private": false,
   "types": "./dist/index.d.ts",
   "files": [