n8n-nodes-sudomock 0.16.0 → 0.17.0

package/README.md

@@ -287,6 +287,10 @@ Generate a mockup by filling smart objects with your designs.
     - Brightness: -150 to 150
     - Contrast: -100 to 100
     - Opacity: 0-100
+    - Custom Width and Custom Height: the artwork's own size in pixels
+    - Position Top and Position Left: offset in pixels from the top left of the smart object when Custom Width or Custom Height is set. Without a size they move the whole smart object on the template, so set them together with a size.
+    - Tile: repeat the artwork as a pattern across the whole smart object. Custom Width and Custom Height are one tile, Fit Mode places the artwork inside each tile, and Position Top and Position Left set where the grid starts. A tile needs a size.
+    - Tile Spacing: gap between tiles, 0 to 100 percent of the tile size: that percent of the tile width between columns, and of its height between rows. Used only when Tile is on.
 
 - **Hidden Layers** (optional): JSON array of up to 50 layer UUIDs from **PSD Mockup: Get Layers** to leave out of this render, including layers inside a smart object. Hiding a group hides every layer inside it. Works on its own.
 
@@ -387,9 +391,9 @@ Deletion confirmation
 Create, prepare, render, and manage reusable mockups from product images without a PSD.
 
 1. **Photo Mockup: Create** accepts a public `source_url` or `source_base64`, plus an optional name. By default it waits and returns the ready mockup detail unchanged. Enable **Run Asynchronously** to receive a 202 job with `job_id` and `status_url`, then use **Get Job** when needed.
-2. **Photo Mockup: Get** returns `draft`, `ready`, or `failed` status. Poll this operation until the mockup is `ready`. The ready response lists every printable product in `data.surfaces` (addressed by `surface_uuid`), and every print area someone has drawn in `data.quads` (addressed by `print_area_id`).
+2. **Photo Mockup: Get** returns `draft`, `ready`, or `failed` status. Poll this operation until the mockup is `ready`. The ready response lists every printable product, and the main wall of a room photo, in `data.surfaces` (addressed by `surface_uuid`), and every print area someone has drawn in `data.quads` (addressed by `print_area_id`).
 3. **Photo Mockup: List** returns your photo mockups with limit, offset, and shopper-customizable filtering.
-4. **Photo Mockup: Set Print Areas** replaces saved areas with quads made from four `[x, y]` coordinate pairs. It can also send an empty list; the API remains authoritative and accepts that only when the mockup can remain renderable without saved areas.
+4. **Photo Mockup: Set Print Areas** replaces saved areas with quads made from four `[x, y]` coordinate pairs. It can also send an empty list; the API remains authoritative and accepts that only when the mockup can remain renderable without saved areas. An area with a Print Area ID, the id of one of the mockup's print areas, keeps that id; an area without one gets a new id.
 5. **Photo Mockup: Render** accepts the mockup UUID and one or more ready render targets. Each target names exactly one address: `uuid` for a saved print area, or `surface_uuid` for a surface. Each target also includes either an artwork URL or Base64 artwork, with optional background removal (adds 25 credits per artwork), color, public adjustments, and placement. Export options support PNG, JPG, or WebP from 100 to 10000 pixels, plus quality and optional DPI. Each render costs 5 credits and returns `print_files`, where `print_files[0]` is the CDN URL.
 6. **Photo Mockup: Delete** deletes the selected photo mockup.
 
@@ -399,8 +403,9 @@ logo can both be addressed on the same product, in the same call, as two targets
 
 Placement is where the two kinds differ:
 
-- A **surface** target takes **Coverage**, a percentage from 10 to 100. Leave it out
-  and the artwork covers the whole surface.
+- A **surface** target takes either **Coverage**, a percentage from 10 to 100, or an
+  explicit **Width** and **Height** pair. Send one or the other, never both. Leave
+  both out and the artwork covers the whole surface.
 - A **print area** target takes either **Fit** (`contain`, `fill`, or `cover`), which
   always sizes the artwork to the whole area, or an explicit **Width** and **Height**
   pair when you want to choose the box yourself. Send one or the other, never both,
@@ -409,6 +414,15 @@ Placement is where the two kinds differ:
 Both kinds take position, offset, and rotation. Anything you do not set is not sent,
 so the API decides it.
 
+Both kinds also take **Tile**, which repeats the artwork as a pattern across the
+whole target. The size you set is one tile: **Fit**, or **Width** and **Height**, on
+a print area, and **Coverage**, or **Width** and **Height**, on a surface. **Position**
+with **Offset X** and **Offset Y** sets where the grid starts. **Tile Spacing** is the
+gap between tiles, 0 to 100 percent of the tile size, used only when Tile is on.
+
+Each entry in `data.surfaces` also carries a `label`, what was detected there, such
+as `pillow` or `wall`, so you can tell surfaces apart before you pick one.
+
 Create must reach `ready` through **Photo Mockup: Get** before **Photo Mockup: Render**.
 
 ---
@@ -421,7 +435,7 @@ Turn a mockup (or an existing image URL) into a short product video. Always asyn
 
 - **Input Mode**: `Render Mockup` (render a mockup with your designs first) or `Animate Image URL` (animate a public image directly)
 - **Mockup UUID** (required in Render Mockup mode): UUID of the mockup to animate
-- **Smart Objects** (required in Render Mockup mode): one or more smart objects with a Design URL and Fit Mode
+- **Smart Objects** (required in Render Mockup mode): one or more smart objects with a Design URL and Fit Mode, plus optional Custom Width, Custom Height, Position Top, Position Left, Tile and Tile Spacing, the same as in PSD Mockup: Render
 - **Image URL** (required in Animate Image URL mode): public HTTPS image (`.png`, `.jpg`, `.jpeg`, `.webp`, `.gif`, `.avif`)
 - **Webhook URL** (optional): one-off HTTPS URL notified when this job finishes
 - **Video Options**:

package/dist/nodes/SudoMock/SudoMock.node.js

@@ -5,7 +5,7 @@ const n8n_workflow_1 = require("n8n-workflow");
 const webhooks_1 = require("./webhooks");
 const resources_1 = require("./resources");
 const TERMINAL_JOB_STATUSES = ['succeeded', 'failed', 'cancelled'];
-function format2DPrintAreas(printAreas) {
+function format2DPrintAreas(printAreas, keepIds = false) {
     return printAreas.map((area) => ({
         points: [
             [area.point1X, area.point1Y],
@@ -13,8 +13,102 @@ function format2DPrintAreas(printAreas) {
             [area.point3X, area.point3Y],
             [area.point4X, area.point4Y],
         ],
+        // Only Set Print Areas keeps an id: a mockup being created has no area to keep.
+        ...(keepIds && area.printAreaId ? { print_area_id: area.printAreaId } : {}),
     }));
 }
+// The size, position and tile fields of a smart object asset. PSD Mockup: Render
+// and Render Video both offer them, so the two show the same names and descriptions.
+const ASSET_PLACEMENT_FIELDS = {
+    sizeHeight: {
+        displayName: 'Custom Height',
+        name: 'sizeHeight',
+        type: 'number',
+        typeOptions: {
+            minValue: 1,
+        },
+        default: 0,
+        description: 'Custom asset height override in pixels. 0 = use smart object bounds.',
+    },
+    sizeWidth: {
+        displayName: 'Custom Width',
+        name: 'sizeWidth',
+        type: 'number',
+        typeOptions: {
+            minValue: 1,
+        },
+        default: 0,
+        description: 'Custom asset width override in pixels. 0 = use smart object bounds.',
+    },
+    positionLeft: {
+        displayName: 'Position Left',
+        name: 'positionLeft',
+        type: 'number',
+        default: null,
+        description: 'Custom position left offset in pixels. Leave empty for the default placement; 0 is the left edge.',
+    },
+    positionTop: {
+        displayName: 'Position Top',
+        name: 'positionTop',
+        type: 'number',
+        default: null,
+        description: 'Custom position top offset in pixels. Leave empty for the default placement; 0 is the top edge.',
+    },
+    tile: {
+        displayName: 'Tile',
+        name: 'tile',
+        type: 'boolean',
+        default: false,
+        description: 'Whether to repeat the artwork as a pattern across the whole smart object. Custom Width and Custom Height are one tile, Fit Mode places the artwork inside each tile, and Position Top and Position Left set where the grid starts. Requires Custom Width or Custom Height.',
+    },
+    tileSpacing: {
+        displayName: 'Tile Spacing',
+        name: 'tileSpacing',
+        type: 'number',
+        typeOptions: {
+            minValue: 0,
+            maxValue: 100,
+        },
+        default: 0,
+        description: 'Gap between tiles as a percentage of the tile size, 0 to 100. The horizontal gap is that percent of the tile width, the vertical gap that percent of the tile height. Used only when Tile is on.',
+    },
+};
+// Puts the size, position and tile fields on a smart object asset. A field left
+// empty is not sent.
+function addAssetPlacement(asset, opts) {
+    // Custom size override
+    const size = {};
+    if (opts.sizeWidth !== undefined && opts.sizeWidth > 0) {
+        size.width = opts.sizeWidth;
+    }
+    if (opts.sizeHeight !== undefined && opts.sizeHeight > 0) {
+        size.height = opts.sizeHeight;
+    }
+    if (Object.keys(size).length > 0) {
+        asset.size = size;
+    }
+    // Custom position override (top/left, DynamicMockups compatible).
+    // An empty field holds null and is not sent, so the default
+    // placement stays. 0 is sent: it puts the artwork against that edge.
+    const position = {};
+    if (opts.positionTop !== undefined && opts.positionTop !== null) {
+        position.top = opts.positionTop;
+    }
+    if (opts.positionLeft !== undefined && opts.positionLeft !== null) {
+        position.left = opts.positionLeft;
+    }
+    if (Object.keys(position).length > 0) {
+        asset.position = position;
+    }
+    // Repeat the artwork as a pattern; asset.size is one tile
+    if (opts.tile) {
+        asset.tile = true;
+    }
+    // Gap between tiles, as a percent of the tile size
+    if (opts.tileSpacing !== undefined && opts.tileSpacing !== 0) {
+        asset.tile_spacing = opts.tileSpacing;
+    }
+}
 function parseJsonArray(value, name) {
     const parsed = typeof value === 'string' ? JSON.parse(value) : value;
     if (!Array.isArray(parsed)) {
@@ -415,7 +509,7 @@ class SudoMock {
                 },
                 default: {},
                 placeholder: 'Add Print Area',
-                description: 'Optional during creation. Set Print Areas may send an empty list; the API decides whether the mockup can remain renderable without saved areas.',
+                description: 'Optional during creation. Set Print Areas may send an empty list; the API decides whether the mockup can remain renderable without saved areas. On Set Print Areas, an area with a Print Area ID keeps that id.',
                 options: [
                     {
                         name: 'items',
@@ -485,6 +579,19 @@ class SudoMock {
                                 default: 0,
                                 description: 'Y coordinate of point 4',
                             },
+                            {
+                                displayName: 'Print Area ID',
+                                name: 'printAreaId',
+                                type: 'string',
+                                displayOptions: {
+                                    show: {
+                                        '/operation': ['set2DPrintAreas'],
+                                    },
+                                },
+                                default: '',
+                                placeholder: '19be48d4-c810-4420-86e3-7ec2a4d85571',
+                                description: 'Id of an existing print area of this mockup to keep its id. Leave it out for a new area.',
+                            },
                         ],
                     },
                 ],
@@ -710,7 +817,15 @@ class SudoMock {
                                         name: 'tile',
                                         type: 'boolean',
                                         default: false,
-                                        description: 'Whether to repeat the artwork as a pattern across the whole target. The sizing answer (coverage, fit, or width and height) is one tile, and position with offset_x and offset_y sets where the grid starts. Requires a sizing answer.',
+                                        description: 'Whether to repeat the artwork as a pattern across the whole print area. Fit, or Width and Height, sizes one tile, and Position with Offset X and Offset Y sets where the grid starts. Requires Fit, or Width and Height.',
+                                    },
+                                    {
+                                        displayName: 'Tile Spacing',
+                                        name: 'tile_spacing',
+                                        type: 'number',
+                                        typeOptions: { minValue: 0, maxValue: 100 },
+                                        default: 0,
+                                        description: 'Gap between tiles as a percentage of the tile size, 0 to 100. The horizontal gap is that percent of the tile width, the vertical gap that percent of the tile height. Used only when Tile is on.',
                                     },
                                     {
                                         displayName: 'Width',
@@ -815,7 +930,15 @@ class SudoMock {
                                         name: 'tile',
                                         type: 'boolean',
                                         default: false,
-                                        description: 'Whether to repeat the artwork as a pattern across the whole target. The sizing answer (coverage, fit, or width and height) is one tile, and position with offset_x and offset_y sets where the grid starts. Requires a sizing answer.',
+                                        description: 'Whether to repeat the artwork as a pattern across the whole surface. Coverage, or Width and Height, sizes one tile, and Position with Offset X and Offset Y sets where the grid starts. Requires Coverage, or Width and Height.',
+                                    },
+                                    {
+                                        displayName: 'Tile Spacing',
+                                        name: 'tile_spacing',
+                                        type: 'number',
+                                        typeOptions: { minValue: 0, maxValue: 100 },
+                                        default: 0,
+                                        description: 'Gap between tiles as a percentage of the tile size, 0 to 100. The horizontal gap is that percent of the tile width, the vertical gap that percent of the tile height. Used only when Tile is on.',
                                     },
                                     {
                                         displayName: 'Width',
@@ -853,7 +976,7 @@ class SudoMock {
                                     {
                                         name: 'Surface',
                                         value: 'surface',
-                                        description: 'Target a printable product returned in data.surfaces',
+                                        description: "Target a printable product, or a room's main wall, returned in data.surfaces",
                                     },
                                 ],
                                 default: 'savedPrintArea',
@@ -1132,26 +1255,8 @@ class SudoMock {
                                         default: 0,
                                         description: 'Contrast adjustment (-100 to 100)',
                                     },
-                                    {
-                                        displayName: 'Custom Height',
-                                        name: 'sizeHeight',
-                                        type: 'number',
-                                        typeOptions: {
-                                            minValue: 1,
-                                        },
-                                        default: 0,
-                                        description: 'Custom asset height override in pixels. 0 = use smart object bounds.',
-                                    },
-                                    {
-                                        displayName: 'Custom Width',
-                                        name: 'sizeWidth',
-                                        type: 'number',
-                                        typeOptions: {
-                                            minValue: 1,
-                                        },
-                                        default: 0,
-                                        description: 'Custom asset width override in pixels. 0 = use smart object bounds.',
-                                    },
+                                    ASSET_PLACEMENT_FIELDS.sizeHeight,
+                                    ASSET_PLACEMENT_FIELDS.sizeWidth,
                                     {
                                         displayName: 'Opacity',
                                         name: 'opacity',
@@ -1163,20 +1268,8 @@ class SudoMock {
                                         default: 100,
                                         description: 'Layer opacity (0-100)',
                                     },
-                                    {
-                                        displayName: 'Position Left',
-                                        name: 'positionLeft',
-                                        type: 'number',
-                                        default: null,
-                                        description: 'Custom position left offset in pixels. Leave empty for the default placement; 0 is the left edge.',
-                                    },
-                                    {
-                                        displayName: 'Position Top',
-                                        name: 'positionTop',
-                                        type: 'number',
-                                        default: null,
-                                        description: 'Custom position top offset in pixels. Leave empty for the default placement; 0 is the top edge.',
-                                    },
+                                    ASSET_PLACEMENT_FIELDS.positionLeft,
+                                    ASSET_PLACEMENT_FIELDS.positionTop,
                                     {
                                         displayName: 'Remove Background',
                                         name: 'removeBackground',
@@ -1206,13 +1299,8 @@ class SudoMock {
                                         default: 0,
                                         description: 'Saturation adjustment (-100 to 100). 0=no change, -100=grayscale.',
                                     },
-                                    {
-                                        displayName: 'Tile',
-                                        name: 'tile',
-                                        type: 'boolean',
-                                        default: false,
-                                        description: 'Whether to repeat the artwork as a pattern across the whole smart object. size is one tile, fit places the artwork inside each tile, and position sets where the grid starts. Requires size.',
-                                    },
+                                    ASSET_PLACEMENT_FIELDS.tile,
+                                    ASSET_PLACEMENT_FIELDS.tileSpacing,
                                     {
                                         displayName: 'Vibrance',
                                         name: 'vibrance',
@@ -1461,6 +1549,14 @@ class SudoMock {
                                 default: 'crop',
                                 description: 'How to fit the design in the smart object bounds',
                             },
+                            {
+                                displayName: 'Additional Options',
+                                name: 'additionalOptions',
+                                type: 'collection',
+                                placeholder: 'Add Option',
+                                default: {},
+                                options: Object.values(ASSET_PLACEMENT_FIELDS),
+                            },
                         ],
                     },
                 ],
@@ -2292,7 +2388,7 @@ class SudoMock {
                 else if (operation === 'set2DPrintAreas') {
                     const mockupUuid = this.getNodeParameter('twoDMockupUuid', i);
                     const printAreas = this.getNodeParameter('twoDSetPrintAreas.items', i, []);
-                    const body = { print_areas: format2DPrintAreas(printAreas) };
+                    const body = { print_areas: format2DPrintAreas(printAreas, true) };
                     const response = await this.helpers.httpRequestWithAuthentication.call(this, 'sudoMockApi', {
                         method: 'PUT',
                         url: `https://api.sudomock.com/api/v1/photo-mockups/${mockupUuid}/print-areas`,
@@ -2592,34 +2688,7 @@ class SudoMock {
                             if (opts.removeBackground) {
                                 asset.remove_background = true;
                             }
-                            // Custom size override
-                            const size = {};
-                            if (opts.sizeWidth !== undefined && opts.sizeWidth > 0) {
-                                size.width = opts.sizeWidth;
-                            }
-                            if (opts.sizeHeight !== undefined && opts.sizeHeight > 0) {
-                                size.height = opts.sizeHeight;
-                            }
-                            if (Object.keys(size).length > 0) {
-                                asset.size = size;
-                            }
-                            // Custom position override (top/left, DynamicMockups compatible).
-                            // An empty field holds null and is not sent, so the default
-                            // placement stays. 0 is sent: it puts the artwork against that edge.
-                            const position = {};
-                            if (opts.positionTop !== undefined && opts.positionTop !== null) {
-                                position.top = opts.positionTop;
-                            }
-                            if (opts.positionLeft !== undefined && opts.positionLeft !== null) {
-                                position.left = opts.positionLeft;
-                            }
-                            if (Object.keys(position).length > 0) {
-                                asset.position = position;
-                            }
-                            // Repeat the artwork as a pattern; asset.size is one tile
-                            if (opts.tile) {
-                                asset.tile = true;
-                            }
+                            addAssetPlacement(asset, opts);
                             // Color overlay
                             if (opts.colorHex) {
                                 smartObject.color = {
@@ -2731,10 +2800,13 @@ class SudoMock {
                         const mockupUuid = this.getNodeParameter('videoMockupUuid', i);
                         const smartObjectsData = this.getNodeParameter('videoSmartObjects.items', i, []);
                         body.mockup_uuid = mockupUuid;
-                        body.smart_objects = smartObjectsData.map((so) => ({
-                            uuid: so.uuid,
-                            asset: { url: so.assetUrl, fit: so.fit },
-                        }));
+                        body.smart_objects = smartObjectsData.map((so) => {
+                            const asset = { url: so.assetUrl, fit: so.fit };
+                            if (so.additionalOptions) {
+                                addAssetPlacement(asset, so.additionalOptions);
+                            }
+                            return { uuid: so.uuid, asset };
+                        });
                     }
                     const video = {};
                     if (videoOptions.durationSeconds !== undefined) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "n8n-nodes-sudomock",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "n8n community node for SudoMock mockup rendering API - POD automation",
   "license": "MIT",
   "homepage": "https://sudomock.com",