n8n-nodes-sudomock 0.5.0 → 0.7.0

package/README.md

@@ -31,11 +31,12 @@ n8n community node for the SudoMock API. Integrate mockup rendering into your n8
 
 - **Render Mockup**: Generate mockups with artwork, personalized text, or both. Text overrides support styled segments, fonts, size, color, stroke color, and overflow, shrink, or clip fitting. Optionally run asynchronously with the **Run Asynchronously** toggle, which returns a `job_id` to track with **Get Job**.
 - **Render Video**: Turn a mockup (or an existing image URL) into a short product video (always asynchronous). Choose a supported duration, optional audio/motion, an optional one-off webhook, and optionally **Wait for Completion** to return the finished clip.
+- **Remove Background**: Isolate the subject of an image onto a transparent background. The cutout remains stored, and the returned signed PNG URL is valid for 7 days. Costs 25 credits, refunded automatically if processing fails. The same cleanup is available inline on both render operations with the per-artwork **Remove Background** toggle.
 
 ### Fonts and Order Artwork
 
 - **Fonts**: List available fonts, fetch one by UUID, upload a custom TTF or OTF from a public URL, and delete your custom fonts
-- **Order Artwork**: Store customer artwork and previews for fulfillment, then delete them by URL or mockup UUID when needed
+- **Artwork: Delete Stored Files**: Delete stored order artwork by URL or mockup UUID
 
 ### Async Jobs
 
@@ -238,6 +239,7 @@ Generate a mockup by filling smart objects with your designs.
   - Fit Mode: `fill`, `contain`, or `cover` (recommended)
   - **Additional Options** (optional):
     - Rotation: -360 to 360 degrees
+    - Remove Background: clean the artwork before placing it (adds 25 credits per artwork)
     - Color Overlay: Hex color code
     - Color Blend Mode: Various blend modes
     - Brightness: -150 to 150
@@ -284,6 +286,38 @@ Export Options:
 
 ---
 
+### Remove Background
+
+Isolate the subject of an image onto a transparent background. The cutout remains stored, and the returned signed PNG URL is valid for 7 days.
+
+**Parameters:**
+
+- **Image URL** (required): public URL of the image to process
+
+**Example:**
+
+```
+Image URL: https://cdn.example.com/product-photo.jpg
+```
+
+**Output:**
+
+```json
+{
+  "success": true,
+  "data": {
+    "url": "https://cdn.sudomock.com/bg-cutouts/abc123.png",
+    "width": 2000,
+    "height": 2000,
+    "credits_charged": 25
+  }
+}
+```
+
+The returned signed URL is valid for 7 days and can be fed straight into **Render Mockup** or **2D: Render Mockup** as artwork during that window. The cutout remains stored. Processing costs 25 credits per image and is refunded automatically if it fails. To clean artwork as part of a render instead, use the per-artwork **Remove Background** toggle on either render operation.
+
+---
+
 ### Delete Mockup
 
 Delete a specific mockup template.
@@ -307,11 +341,11 @@ Deletion confirmation
 
 Create, prepare, render, and manage reusable mockups from product images without a PSD.
 
-1. **2D: Create Mockup** accepts a public `source_url` or `source_base64`, plus an optional name. Creation is asynchronous and returns the 202 response with `mockup_uuid`, `status_url`, and job details unchanged. Use the job ID with **Get Job** when needed.
-2. **2D: Get Mockup** returns `draft`, `ready`, or `failed` status. Poll this operation until the mockup is `ready`; the ready response includes each print area's UUID and points.
-3. **2D: List Mockups** returns your 2D mockups.
-4. **2D: Set Print Areas** accepts one or more print areas. Each print area is a quad with four `[x, y]` coordinate pairs.
-5. **2D: Render Mockup** accepts the mockup UUID and one or more ready print area UUIDs. Each print area includes either an artwork URL or Base64 artwork, with optional color, adjustments, and placement. Export options support PNG or JPG at 1024, 2048, or 4096 pixels, plus quality and DPI. Each render costs 5 credits and returns `print_files`, where `print_files[0]` is the CDN URL.
+1. **2D: Create Mockup** 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. **2D: Get Mockup** returns `draft`, `ready`, or `failed` status. Poll this operation until the mockup is `ready`. The ready response keeps saved areas in `data.quads` (addressed by `print_area_id`) and full surfaces in `data.surfaces` (addressed by `surface_uuid`).
+3. **2D: List Mockups** returns your 2D mockups with limit, offset, and shopper-customizable filtering.
+4. **2D: 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.
+5. **2D: Render Mockup** accepts the mockup UUID and one or more ready render targets. Each target sends exactly one identifier: `uuid` for a saved area or `surface_uuid` for a full 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. **2D: Delete Mockup** deletes the selected 2D mockup.
 
 Create must reach `ready` through **2D: Get Mockup** before **2D: Render Mockup**.
@@ -330,7 +364,7 @@ Turn a mockup (or an existing image URL) into a short product video. Always asyn
 - **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**:
-  - **Duration (Seconds)**: clip length (default 4; must be an allowed duration for the chosen model — the default model `veo-3.1-fast` allows 4, 6, or 8; max 15)
+  - **Duration (Seconds)**: clip length (default 4; must be an allowed duration for the chosen model — the default model `veo-3.1-fast` allows 4 or 6; max 15)
   - **Audio**: include a generated audio track (default false; may cost extra credits depending on model)
   - **Motion**: `ambient` (default) or `showcase`
   - **Advanced Model**: optional override pinning a roster model (`veo-3.1-fast`, `kling-v3-pro`, `kling-2.6-pro`, `seedance-2.0`, `wan-2.5`); leave empty to auto-pick by plan tier

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

@@ -84,7 +84,7 @@ class SudoMock {
                     {
                         name: '2D: Get Mockup',
                         value: 'get2DMockup',
-                        description: 'Get the status and print areas of a 2D mockup',
+                        description: 'Get the status and addressable render targets of a 2D mockup',
                         action: 'Get a 2D mockup',
                     },
                     {
@@ -96,7 +96,7 @@ class SudoMock {
                     {
                         name: '2D: Set Print Areas',
                         value: 'set2DPrintAreas',
-                        description: 'Define print area quads for a 2D mockup',
+                        description: 'Replace or clear the saved print area quads for a 2D mockup',
                         action: 'Set 2D print areas',
                     },
                     {
@@ -117,12 +117,6 @@ class SudoMock {
                         description: 'Delete stored order artwork by URL or mockup UUID',
                         action: 'Delete stored artwork',
                     },
-                    {
-                        name: 'Artwork: Store Files',
-                        value: 'storeArtworks',
-                        description: 'Store customer artwork and an optional preview for order fulfillment',
-                        action: 'Store artwork',
-                    },
                     {
                         name: 'Delete Mockup',
                         value: 'deleteMockup',
@@ -183,6 +177,12 @@ class SudoMock {
                         description: 'List your async render, upload, and video jobs',
                         action: 'List jobs',
                     },
+                    {
+                        name: 'Remove Background',
+                        value: 'removeBackground',
+                        description: 'Remove the background from an image and get a transparent-PNG cutout through a signed URL valid for 7 days. The cutout remains stored. Costs 25 credits; auto-refunded on failure.',
+                        action: 'Remove an image background',
+                    },
                     {
                         name: 'Render Mockup',
                         value: 'render',
@@ -353,6 +353,32 @@ class SudoMock {
                 default: false,
                 description: 'Whether to queue creation and return a job_id (kind: 2d_create) immediately',
             },
+            {
+                displayName: 'Limit',
+                name: 'twoDListLimit',
+                type: 'number',
+                typeOptions: { minValue: 1, maxValue: 100 },
+                displayOptions: { show: { operation: ['list2DMockups'] } },
+                default: 20,
+                description: 'Number of 2D mockups to return from 1 to 100',
+            },
+            {
+                displayName: 'Offset',
+                name: 'twoDListOffset',
+                type: 'number',
+                typeOptions: { minValue: 0 },
+                displayOptions: { show: { operation: ['list2DMockups'] } },
+                default: 0,
+                description: 'Number of 2D mockups to skip',
+            },
+            {
+                displayName: 'Customizable Only',
+                name: 'twoDListCustomizableOnly',
+                type: 'boolean',
+                displayOptions: { show: { operation: ['list2DMockups'] } },
+                default: false,
+                description: 'Whether to return only mockups ready for shopper customization',
+            },
             {
                 displayName: 'Mockup UUID',
                 name: 'twoDMockupUuid',
@@ -381,7 +407,7 @@ class SudoMock {
                 },
                 default: {},
                 placeholder: 'Add Print Area',
-                description: "Optional during creation; required when replacing a mockup's print 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.',
                 options: [
                     {
                         name: 'items',
@@ -456,7 +482,7 @@ class SudoMock {
                 ],
             },
             {
-                displayName: 'Print Areas',
+                displayName: 'Render Targets',
                 name: 'twoDRenderPrintAreas',
                 type: 'fixedCollection',
                 typeOptions: {
@@ -469,20 +495,57 @@ class SudoMock {
                     },
                 },
                 default: {},
-                placeholder: 'Add Print Area',
-                description: 'Artwork and options for each saved print area',
+                placeholder: 'Add Render Target',
+                description: 'Artwork and options for each target. Select exactly one saved print area UUID or full-surface UUID.',
                 options: [
                     {
                         name: 'items',
-                        displayName: 'Print Area',
+                        displayName: 'Render Target',
                         values: [
                             {
-                                displayName: 'Print Area UUID',
+                                displayName: 'Target Type',
+                                name: 'targetType',
+                                type: 'options',
+                                options: [
+                                    {
+                                        name: 'Saved Print Area',
+                                        value: 'savedPrintArea',
+                                        description: 'Target a saved print area returned in data.quads',
+                                    },
+                                    {
+                                        name: 'Full Surface',
+                                        value: 'fullSurface',
+                                        description: 'Target a full surface returned in data.surfaces',
+                                    },
+                                ],
+                                default: 'savedPrintArea',
+                                description: 'Whether this artwork targets a saved area or a full surface',
+                            },
+                            {
+                                displayName: 'Saved Print Area UUID',
                                 name: 'uuid',
                                 type: 'string',
                                 required: true,
+                                displayOptions: {
+                                    show: {
+                                        targetType: ['savedPrintArea'],
+                                    },
+                                },
+                                default: '',
+                                description: 'The print_area_id returned in data.quads by 2D: Get Mockup',
+                            },
+                            {
+                                displayName: 'Full-Surface UUID',
+                                name: 'surfaceUuid',
+                                type: 'string',
+                                required: true,
+                                displayOptions: {
+                                    show: {
+                                        targetType: ['fullSurface'],
+                                    },
+                                },
                                 default: '',
-                                description: 'UUID returned by 2D: Get Mockup when status is ready',
+                                description: 'The surface_uuid returned in data.surfaces by 2D: Get Mockup',
                             },
                             {
                                 displayName: 'Artwork Type',
@@ -530,6 +593,13 @@ class SudoMock {
                                 default: '',
                                 description: 'Base64 artwork data for this print area',
                             },
+                            {
+                                displayName: 'Remove Background',
+                                name: 'removeBackground',
+                                type: 'boolean',
+                                default: false,
+                                description: 'Whether to remove the artwork background before placing it. Adds 25 credits per artwork.',
+                            },
                             {
                                 displayName: 'Color',
                                 name: 'color',
@@ -605,30 +675,6 @@ class SudoMock {
                                         default: 'multiply',
                                         description: 'Artwork blend mode for the product surface',
                                     },
-                                    {
-                                        displayName: 'Warp Strength',
-                                        name: 'warp_strength',
-                                        type: 'number',
-                                        typeOptions: { minValue: 0, maxValue: 2 },
-                                        default: 1.5,
-                                        description: 'Surface warp strength from 0 to 2',
-                                    },
-                                    {
-                                        displayName: 'Edge Expand',
-                                        name: 'edge_expand',
-                                        type: 'number',
-                                        typeOptions: { minValue: 0, maxValue: 50 },
-                                        default: 0,
-                                        description: 'Artwork edge expansion from 0 to 50',
-                                    },
-                                    {
-                                        displayName: 'Texture Strength',
-                                        name: 'texture_strength',
-                                        type: 'number',
-                                        typeOptions: { minValue: 0, maxValue: 100 },
-                                        default: 0,
-                                        description: 'Product texture strength from 0 to 100',
-                                    },
                                 ],
                             },
                             {
@@ -965,6 +1011,13 @@ class SudoMock {
                                         default: 0,
                                         description: 'Custom position left offset in pixels',
                                     },
+                                    {
+                                        displayName: 'Remove Background',
+                                        name: 'removeBackground',
+                                        type: 'boolean',
+                                        default: false,
+                                        description: 'Whether to remove the artwork background before placing it. Adds 25 credits per artwork.',
+                                    },
                                     {
                                         displayName: 'Color Overlay (Hex)',
                                         name: 'colorHex',
@@ -1318,7 +1371,7 @@ class SudoMock {
                             maxValue: 15,
                         },
                         default: 4,
-                        description: "Length of the clip in seconds. Must be one of the chosen model's allowed durations (the default model veo-3.1-fast allows 4, 6, or 8). Longer clips cost more credits.",
+                        description: "Length of the clip in seconds. Must be one of the chosen model's allowed durations (the default model veo-3.1-fast allows 4 or 6). Longer clips cost more credits.",
                     },
                     {
                         displayName: 'Audio',
@@ -1564,58 +1617,21 @@ class SudoMock {
                 ],
             },
             // ============================================
-            // ARTWORK PARAMETERS
+            // BACKGROUND REMOVAL PARAMETERS
             // ============================================
             {
-                displayName: 'Mockup UUID',
-                name: 'artworkMockupUuid',
+                displayName: 'Image URL',
+                name: 'removeBackgroundImageUrl',
                 type: 'string',
                 required: true,
-                displayOptions: { show: { operation: ['storeArtworks'] } },
+                displayOptions: { show: { operation: ['removeBackground'] } },
                 default: '',
-                description: 'Mockup UUID the stored artwork belongs to',
-            },
-            {
-                displayName: 'Artwork Items',
-                name: 'artworkItems',
-                type: 'fixedCollection',
-                typeOptions: { multipleValues: true },
-                displayOptions: { show: { operation: ['storeArtworks'] } },
-                default: {},
-                placeholder: 'Add Artwork',
-                description: 'Up to 10 artwork files to keep for order fulfillment',
-                options: [
-                    {
-                        name: 'items',
-                        displayName: 'Artwork',
-                        values: [
-                            {
-                                displayName: 'Smart Object UUID',
-                                name: 'smartObjectUuid',
-                                type: 'string',
-                                required: true,
-                                default: '',
-                            },
-                            {
-                                displayName: 'Base64 Artwork',
-                                name: 'base64',
-                                type: 'string',
-                                required: true,
-                                default: '',
-                                description: 'Raw base64 image bytes without a data URL prefix',
-                            },
-                        ],
-                    },
-                ],
-            },
-            {
-                displayName: 'Preview URL',
-                name: 'artworkPreviewUrl',
-                type: 'string',
-                displayOptions: { show: { operation: ['storeArtworks'] } },
-                default: '',
-                description: 'Optional render URL to keep with the order',
+                placeholder: 'https://cdn.example.com/product-photo.jpg',
+                description: 'Public URL of the image to isolate onto a transparent background',
             },
+            // ============================================
+            // ARTWORK PARAMETERS
+            // ============================================
             {
                 displayName: 'Delete By',
                 name: 'artworkDeleteMode',
@@ -2101,9 +2117,17 @@ class SudoMock {
                 // 2D: LIST MOCKUPS
                 // ========================================
                 else if (operation === 'list2DMockups') {
+                    const limit = this.getNodeParameter('twoDListLimit', i, 20);
+                    const offset = this.getNodeParameter('twoDListOffset', i, 0);
+                    const customizableOnly = this.getNodeParameter('twoDListCustomizableOnly', i, false);
                     const response = await this.helpers.httpRequestWithAuthentication.call(this, 'sudoMockApi', {
                         method: 'GET',
                         url: 'https://api.sudomock.com/api/v1/sudoai/2d-mockups',
+                        qs: {
+                            limit,
+                            offset,
+                            customizable_only: customizableOnly,
+                        },
                         json: true,
                     });
                     returnData.push({
@@ -2117,9 +2141,6 @@ class SudoMock {
                 else if (operation === 'set2DPrintAreas') {
                     const mockupUuid = this.getNodeParameter('twoDMockupUuid', i);
                     const printAreas = this.getNodeParameter('twoDSetPrintAreas.items', i, []);
-                    if (printAreas.length === 0) {
-                        throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'Add at least one print area');
-                    }
                     const body = { print_areas: format2DPrintAreas(printAreas) };
                     const response = await this.helpers.httpRequestWithAuthentication.call(this, 'sudoMockApi', {
                         method: 'PUT',
@@ -2139,18 +2160,37 @@ class SudoMock {
                     const mockupUuid = this.getNodeParameter('twoDMockupUuid', i);
                     const printAreasData = this.getNodeParameter('twoDRenderPrintAreas.items', i, []);
                     const printAreas = printAreasData.map((area) => {
-                        const printArea = { uuid: area.uuid };
+                        const targetType = area.targetType ?? 'savedPrintArea';
+                        const targetValue = targetType === 'fullSurface' ? area.surfaceUuid : area.uuid;
+                        if (!targetValue) {
+                            throw new n8n_workflow_1.NodeOperationError(this.getNode(), targetType === 'fullSurface'
+                                ? 'Full-Surface UUID is required for a full-surface render target'
+                                : 'Saved Print Area UUID is required for a saved print-area render target');
+                        }
+                        const printArea = targetType === 'fullSurface' ? { surface_uuid: targetValue } : { uuid: targetValue };
                         if (area.artworkSource === 'base64') {
                             printArea.base64 = area.base64;
                         }
                         else {
                             printArea.artwork_url = area.artworkUrl;
                         }
+                        if (area.removeBackground) {
+                            printArea.remove_background = true;
+                        }
                         if (area.color) {
                             printArea.color = area.color;
                         }
                         if (area.adjustments && Object.keys(area.adjustments).length > 0) {
-                            printArea.adjustments = area.adjustments;
+                            const { brightness, contrast, opacity, saturation, vibrance, blur, blend_mode } = area.adjustments;
+                            printArea.adjustments = Object.fromEntries(Object.entries({
+                                brightness,
+                                contrast,
+                                opacity,
+                                saturation,
+                                vibrance,
+                                blur,
+                                blend_mode,
+                            }).filter(([, value]) => value !== undefined));
                         }
                         if (area.placement && Object.keys(area.placement).length > 0) {
                             printArea.placement = area.placement;
@@ -2269,30 +2309,15 @@ class SudoMock {
                     });
                 }
                 // ========================================
-                // ARTWORKS
+                // BACKGROUND REMOVAL
                 // ========================================
-                else if (operation === 'storeArtworks') {
-                    const items = this.getNodeParameter('artworkItems.items', i, []);
-                    const previewUrl = this.getNodeParameter('artworkPreviewUrl', i, '');
-                    if (items.length === 0 && !previewUrl) {
-                        throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'Add at least one artwork item or a preview URL');
-                    }
-                    if (items.length > 10) {
-                        throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'Artwork Items supports up to 10 files');
-                    }
-                    const body = {
-                        mockup_uuid: this.getNodeParameter('artworkMockupUuid', i),
-                        items: items.map((item) => ({
-                            smart_object_uuid: item.smartObjectUuid,
-                            base64: item.base64,
-                        })),
-                    };
-                    if (previewUrl)
-                        body.preview_url = previewUrl;
+                else if (operation === 'removeBackground') {
                     const response = await this.helpers.httpRequestWithAuthentication.call(this, 'sudoMockApi', {
                         method: 'POST',
-                        url: 'https://api.sudomock.com/api/v1/artworks',
-                        body,
+                        url: 'https://api.sudomock.com/api/v1/remove-background',
+                        body: {
+                            url: this.getNodeParameter('removeBackgroundImageUrl', i),
+                        },
                         json: true,
                     });
                     returnData.push({
@@ -2300,6 +2325,9 @@ class SudoMock {
                         pairedItem: { item: i },
                     });
                 }
+                // ========================================
+                // ARTWORKS
+                // ========================================
                 else if (operation === 'deleteArtworks') {
                     const mode = this.getNodeParameter('artworkDeleteMode', i);
                     const body = {};
@@ -2356,6 +2384,10 @@ class SudoMock {
                                     asset.content_type = opts.contentType;
                                 }
                             }
+                            // Background removal surcharge, billed per unique artwork source
+                            if (opts.removeBackground) {
+                                asset.remove_background = true;
+                            }
                             // Custom size override
                             const size = {};
                             if (opts.sizeWidth !== undefined && opts.sizeWidth > 0) {
@@ -2984,7 +3016,9 @@ class SudoMock {
                         itemIndex: i,
                     });
                 }
-                throw new n8n_workflow_1.NodeOperationError(this.getNode(), error instanceof Error ? error : new Error('Unknown error'), { itemIndex: i });
+                throw new n8n_workflow_1.NodeOperationError(this.getNode(), error instanceof Error ? error : new Error('Unknown error'), {
+                    itemIndex: i,
+                });
             }
         }
         return [returnData];

package/package.json

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