@limetech/n8n-nodes-lime 2.3.1-dev.1 → 2.5.0-dev.1

package/nodes/lime-crm/utils/files.ts

@@ -5,7 +5,7 @@ import {
     LoggerProxy as Logger,
 } from 'n8n-workflow';
 import { createFile, getFileContent, getFileMetadata } from '../transport';
-import { FileResponse } from '../../response';
+import { APIResponse, FileAPIResponse } from '../../response';
 import { LimetypeProperty } from '../models';
 
 /**
@@ -121,7 +121,7 @@ export async function setFileProperties(
     i: number,
     fileProperties: Set<string>,
     definedProperties: IDataObject
-): Promise<IDataObject> {
+): Promise<APIResponse<IDataObject>> {
     for (const fileProperty of fileProperties) {
         if (!(fileProperty in definedProperties)) continue;
         let binaryData: IBinaryData;
@@ -146,9 +146,14 @@ export async function setFileProperties(
             definedProperties[fileProperty] as string
         );
 
-        definedProperties[fileProperty] = response.id;
+        if (response.success) {
+            definedProperties[fileProperty] = response.data.id;
+        } else return response;
     }
-    return definedProperties;
+    return {
+        success: true,
+        data: definedProperties,
+    };
 }
 
 /**
@@ -159,7 +164,7 @@ export async function setFileProperties(
  * @param data - The record data containing property values to process
  * @param includeFileContent - Whether to include the actual file content in the response. Defaults to `false`
  *
- * @returns A {@link FileResponse} object containing updated JSON data and, if requested, the associated binary files.
+ * @returns A {@link FileAPIResponse} object containing updated JSON data and, if requested, the associated binary files.
  *
  * @public
  * @group Utils
@@ -169,7 +174,7 @@ export async function processFileResponse<T extends Record<string, unknown>>(
     fileProperties: Set<string>,
     data: T,
     includeFileContent: boolean = false
-): Promise<FileResponse<T>> {
+): Promise<FileAPIResponse<T>> {
     let updatedData = { ...data };
     const binaryData: Record<string, IBinaryData> = {};
     for (const fileProperty of fileProperties) {
@@ -178,21 +183,33 @@ export async function processFileResponse<T extends Record<string, unknown>>(
             nodeContext,
             data[fileProperty] as string
         );
+        if (!fileMetadataResponse.success)
+            return {
+                json: fileMetadataResponse,
+            };
 
         updatedData = {
             ...updatedData,
-            [fileProperty]: fileMetadataResponse,
+            [fileProperty]: fileMetadataResponse.data,
         };
 
         if (includeFileContent) {
-            binaryData[fileProperty] = await getFileContent(
+            const fileContentResponse = await getFileContent(
                 nodeContext,
-                fileMetadataResponse.id
+                fileMetadataResponse.data.id
             );
+            if (fileContentResponse.success) {
+                binaryData[fileProperty] = fileContentResponse.data;
+            } else {
+                return { json: fileContentResponse };
+            }
         }
     }
     return {
-        json: updatedData,
+        json: {
+            success: true,
+            data: updatedData,
+        },
         binary: binaryData,
     };
 }

package/nodes/lime-crm/utils/index.ts

@@ -7,4 +7,4 @@ export {
 } from './files';
 export { verifyHmac } from './hmac';
 export { getWebhook } from './webhook';
-export { adaptProperty, getPropertyType } from './propertyAdapters';
+export { handleWorkflowError, WorkflowErrorContext } from '../../errorHandling';

package/nodes/response.ts

@@ -1,16 +1,54 @@
 import { IBinaryData } from 'n8n-workflow';
+import { ErrorResponse, WorkflowErrorContext } from './errorHandling';
+
+/**
+ * Wrapper for successful response
+ */
+export type SuccessResponse<T> = {
+    success: true;
+    data: T;
+};
+
+/**
+ * Generic wrapper used for describing the data we are returning from workflow
+ * execution for the user
+ */
+export type WorkflowResponse<T> = T | { error: WorkflowErrorContext };
+
+/**
+ * Generic wrapper used for describing the data we are getting from the
+ * external API layer
+ */
+export type APIResponse<T> = SuccessResponse<T> | ErrorResponse;
+
+/**
+ * Response object that includes both JSON data and optional binary file content.
+ * Works in communication layer
+ *
+ * @typeParam T - The shape of the JSON data returned in the response
+ * @property json -  The {@link APIResponse} object, containing structured JSON data.
+ * @property binary - An optional record of binary file data
+ *
+ * @public
+ * @group Response
+ */
+export type FileAPIResponse<T> = {
+    json: APIResponse<T>;
+    binary?: Record<string, IBinaryData>;
+};
 
 /**
  * Response object that includes both JSON data and optional binary file content.
+ * Works in user interface layer
  *
  * @typeParam T - The shape of the JSON data returned in the response
- * @property json -  The n8n node response, containing structured JSON data.
+ * @property json -  The {@link WorflowResponse} object, containing structured JSON data.
  * @property binary - An optional record of binary file data
  *
  * @public
  * @group Response
  */
-export type FileResponse<T> = {
-    json: T;
+export type WorkflowFileResponse<T> = {
+    json: WorkflowResponse<T>;
     binary?: Record<string, IBinaryData>;
 };

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@limetech/n8n-nodes-lime",
-  "version": "2.3.1-dev.1",
+  "version": "2.5.0-dev.1",
   "description": "n8n node to connect to Lime CRM",
-  "license": "MIT",
   "main": "nodes/index.ts",
   "scripts": {
     "build": "tsc && copyfiles \"nodes/**/*.svg\" dist",
@@ -63,5 +62,8 @@
   },
   "peerDependencies": {
     "n8n-workflow": "^1.109.0"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }

package/tests/nodes/lime-crm/methods.spec.ts

@@ -0,0 +1,91 @@
+import {
+    getCreateMappingColumns,
+    getUpdateMappingColumns,
+    LimetypeProperty,
+    SuccessResponse,
+} from '../../../nodes';
+import { ILoadOptionsFunctions } from 'n8n-workflow';
+import * as transport from '../../../nodes/lime-crm/transport';
+
+const mockILoadOptionFunctions = {
+    getNodeParameter: jest.fn().mockReturnValue('company'),
+} as unknown as ILoadOptionsFunctions;
+
+const propertiesResponseMock = {
+    success: true,
+    data: [
+        { name: 'p1', localname: 'Property 1', type: 'yesno', required: true },
+        {
+            name: 'p2',
+            localname: 'Property 2',
+            type: 'string',
+            required: false,
+            length: 2137,
+        },
+        {
+            name: 'p3',
+            localname: 'Property 3',
+            type: 'option',
+            required: true,
+            options: [
+                { key: 'op1', text: 'Option 1', inactive: false },
+                { key: 'op2', text: 'Option 2', inactive: false },
+                { key: 'op3', text: 'Option 3', inactive: true },
+            ],
+        },
+    ],
+} as SuccessResponse<LimetypeProperty[]>;
+
+describe('resourceMapping', () => {
+    beforeEach(() => {
+        jest.spyOn(transport, 'getProperties').mockResolvedValue(
+            propertiesResponseMock
+        );
+    });
+    it('gets valid resource mapping for create', async () => {
+        const columns = await getCreateMappingColumns.call(
+            mockILoadOptionFunctions
+        );
+        const property1 = columns.fields.find((p) => p.id == 'p1')!;
+
+        expect(property1.displayName).toBe('Property 1 [yesno]');
+        expect(property1.required).toBe(true);
+        expect(property1.defaultMatch).toBe(false);
+        expect(property1.display).toBe(true);
+        expect(property1.type).toBe('boolean');
+        expect(property1.options).toBe(undefined);
+
+        const property2 = columns.fields.find((p) => p.id == 'p2')!;
+        expect(property2.displayName).toBe('Property 2 [string(2137)]');
+        expect(property2.required).toBe(false);
+        expect(property2.defaultMatch).toBe(false);
+        expect(property2.display).toBe(true);
+        expect(property2.type).toBe('string');
+        expect(property2.options).toBe(undefined);
+
+        const property3 = columns.fields.find((p) => p.id == 'p3')!;
+        expect(property3.displayName).toBe('Property 3 [option]');
+        expect(property3.required).toBe(true);
+        expect(property3.defaultMatch).toBe(false);
+        expect(property3.display).toBe(true);
+        expect(property3.type).toBe('options');
+
+        const options = property3.options!;
+        expect(options).toContainEqual({
+            value: 'op1',
+            name: 'Option 1',
+        });
+        expect(options).toContainEqual({
+            value: 'op2',
+            name: 'Option 2',
+        });
+        expect(options.length).toBe(2);
+    });
+    it('gets proper required values for update', async () => {
+        const columns = await getUpdateMappingColumns.call(
+            mockILoadOptionFunctions
+        );
+        const requiredValues = columns.fields.map((p) => p.required);
+        expect(requiredValues).toEqual([false, false, false]);
+    });
+});

package/tests/nodes/lime-crm/utils.spec.ts

@@ -1,12 +1,19 @@
 jest.mock('../../../nodes/lime-crm/transport', () => ({
     createFile: jest.fn().mockResolvedValue({
-        id: 1,
+        success: true,
+        data: { id: 1 },
     }),
     getFileMetadata: jest.fn().mockResolvedValue({
-        id: '123',
-        name: 'file.txt',
+        success: true,
+        data: {
+            id: '123',
+            name: 'file.txt',
+        },
+    }),
+    getFileContent: jest.fn().mockResolvedValue({
+        success: true,
+        data: 'some binary data',
     }),
-    getFileContent: jest.fn().mockResolvedValue('some binary data'),
     getTasks: jest.fn(),
 }));
 
@@ -63,10 +70,30 @@ describe('files', () => {
 
     describe('getFilePropertiesNames', () => {
         const limetypes = [
-            { name: 'company', type: 'belongsto', localname: 'company' },
-            { name: 'name', type: 'string', localname: 'name' },
-            { name: 'document', type: 'file', localname: 'document' },
-            { name: 'photo', type: 'file', localname: 'photo' },
+            {
+                name: 'company',
+                type: 'belongsto',
+                localname: 'company',
+                required: false,
+            },
+            {
+                name: 'name',
+                type: 'string',
+                localname: 'name',
+                required: false,
+            },
+            {
+                name: 'document',
+                type: 'file',
+                localname: 'document',
+                required: false,
+            },
+            {
+                name: 'photo',
+                type: 'file',
+                localname: 'photo',
+                required: false,
+            },
         ];
         it('returns all file property names', async () => {
             const result = getFilePropertiesNames(limetypes);
@@ -112,8 +139,10 @@ describe('files', () => {
                 new Set(['document']),
                 definedProperties
             );
-
-            expect(result.document).toBe(1);
+            expect(result.success).toBe(true);
+            if (result.success) {
+                expect(result.data.document).toBe(1);
+            }
         });
 
         it('sets file ID if assertBinaryData throws an error', async () => {
@@ -127,7 +156,10 @@ describe('files', () => {
                 new Set(['document']),
                 definedProperties
             );
-            expect(result.document).toBe(2);
+            expect(result.success).toBe(true);
+            if (result.success) {
+                expect(result.data.document).toBe(2);
+            }
         });
     });
 
@@ -141,33 +173,36 @@ describe('files', () => {
 
         it('returns file metadata without file content', async () => {
             const data = { document: 1 };
-            const result = await processFileResponse(
+            const result = await processFileResponse<{ document: number }>(
                 mockNodeContext as any,
                 new Set(['document']),
                 data
             );
-
-            expect(result.json.document).toEqual({
-                id: '123',
-                name: 'file.txt',
-            });
-            expect(result.binary).toEqual({});
+            expect(result.json.success).toBe(true);
+            if (result.json.success) {
+                expect(result.json.data.document).toEqual({
+                    id: '123',
+                    name: 'file.txt',
+                });
+                expect(result.binary).toEqual({});
+            }
         });
 
         it('returns file metadata with file content', async () => {
             const data = { document: 1 };
-            const result = await processFileResponse(
+            const result = await processFileResponse<{ document: number }>(
                 mockNodeContext as any,
                 new Set(['document']),
                 data,
                 true
             );
-
-            expect(result.json.document).toEqual({
-                id: '123',
-                name: 'file.txt',
-            });
-            expect(result.binary?.document).toEqual('some binary data');
+            if (result.json.success) {
+                expect(result.json.data.document).toEqual({
+                    id: '123',
+                    name: 'file.txt',
+                });
+                expect(result.binary?.document).toEqual('some binary data');
+            }
         });
     });
 });

package/nodes/lime-crm/utils/propertyAdapters.ts

@@ -1,75 +0,0 @@
-/**
- * Set of helper functions, classes and types used for adapting the data from
- * N8N's simple fields to Lime CRM format
- */
-
-import { LimetypeProperty } from '../models';
-import { YES_NO_PROPERTY_TYPE, PropertyTypeMap } from '../models';
-
-/**
- * Base inteface for Property Adapter class
- */
-interface PropertyAdapter<T> {
-    adapt(value: string): T | string;
-}
-
-/**
- * Adapter which takes a string from user input and parses it into boolean to
- * conform to Lime CRM's YesNo type
- */
-class YesNoPropertyAdapter implements PropertyAdapter<boolean> {
-    adapt(value: string): boolean | string {
-        if (value == 'true') {
-            return true;
-        } else if (value == 'false') {
-            return false;
-        }
-        return value;
-    }
-}
-
-/**
- * Factory class which returns the proper adapter based on data type
- * @param propertyType
- */
-function getPropertyAdapter(
-    propertyType: string
-): PropertyAdapter<PropertyTypeMap[keyof PropertyTypeMap]> | null {
-    if (propertyType == YES_NO_PROPERTY_TYPE) {
-        return new YesNoPropertyAdapter();
-    }
-    return null;
-}
-
-/**
- * Main function which takes the value from simple fields mode and the type of
- * property and parses it accordingly to what Lime CRM expects
- * @param propertyValue - user input, always string
- * @param propertyType - type of property from Lime CRM
- *
- * @public
- * @group Utils
- */
-export function adaptProperty(propertyValue: string, propertyType: string) {
-    const adapter = getPropertyAdapter(propertyType);
-    return adapter === null ? propertyValue : adapter.adapt(propertyValue);
-}
-
-/**
- * Given the name of the property and the set of Limetype properties, return the
- * property type
- * @param propertyName - name of the property we want to get the type of
- * @param properties - list of {@link LimetypeProperty} entries
- *
- * @public
- * @group Utils
- */
-export function getPropertyType(
-    propertyName: string,
-    properties: LimetypeProperty[]
-): string {
-    return (
-        properties.find((property) => property.name === propertyName)?.type ||
-        'string'
-    );
-}

package/restore_script/README

@@ -1,42 +0,0 @@
-### n8n Scripts
-
-Utility scripts to batch upload, download and transfer workflows as JSON data to and from an n8n instance via
-its REST API.
-
-=========================================================================================
-### Features
-- download: Fetch items workflows from n8n and store locally.
-- upload: Push local workflows to n8n.
-- transfer: Combine download then upload for migrating between two instances without local storage
-- cli: Unified command line entrypoint wrapping the download and upload operations.
-
-=========================================================================================
-### Installation
-```bash
-poetry install
-```
-
-=========================================================================================
-### Usage
-
-#### Interactive Mode
-```bash
-poetry run python ./main.py
-```
-
-The api_key can also be provided in files [root directory]:
-- `api_key_download.txt` for download operations
-- `api_key_upload.txt` for upload operations
-
-#### CLI Mode
-Download
-```bash
-poetry run python ./cli.py download --instance_url <INSTANCE_URL> --api_key <API_KEY> --folder_path <FOLDER_PATH>
-```
-
-Upload
-```bash
-poetry run python ./cli.py upload --instance_url <INSTANCE_URL> --api_key <API_KEY> --folder_path <FOLDER_PATH>
-```
-
-The api_key can also be provided via the N8N_API_KEY environment variable.

package/restore_script/cli.py

@@ -1,73 +0,0 @@
-import argparse
-import os
-import sys
-
-
-from download import create_workflows_endpoint, fetch_workflows, save_workflows
-from upload import upload_workflows
-
-
-def _get_api_key(parser_args):
-    api_key = parser_args.api_key or os.getenv("N8N_API_KEY")
-    if not api_key:
-        print("Error: No api_key provided. Use --api_key argument or set N8N_API_KEY environment variable.",
-              file=sys.stderr)
-        sys.exit(1)
-
-    return api_key
-
-
-def download(instance_url, folder_path, parser_args):
-    api_key = _get_api_key(parser_args)
-    url = create_workflows_endpoint(instance_url, active=False, pinned_data=True)
-
-    if workflows:= fetch_workflows(url, api_key):
-        os.makedirs(os.path.normpath(folder_path), exist_ok=True)
-        save_workflows(folder_path, workflows)
-
-
-def upload(instance_url, folder_path, parser_args):
-    api_key = _get_api_key(parser_args)
-    url = f"{instance_url}/api/v1/workflows"
-
-    upload_workflows(
-        url=url, api_key=api_key, folder_path=os.path.normpath(folder_path))
-
-
-def download_cmd(subparsers):
-    download_parser = subparsers.add_parser("download", help="Download workflows from an n8n instance")
-    download_parser.add_argument("--instance_url", required=True,
-                                 help="n8n instance URL (e.g., https://n8n.example.com)")
-    download_parser.add_argument("--folder_path", required=True,
-                                 help="Path to save downloaded workflows")
-    download_parser.add_argument("--api_key",
-                                 help="Your n8n API key the default is read from N8N_API_KEY env variable")
-
-
-def upload_cmd(subparsers):
-    upload_parser = subparsers.add_parser("upload", help="Upload workflows to an n8n instance")
-    upload_parser.add_argument("--instance_url", required=True,
-                               help="n8n instance URL (e.g., https://n8n.example.com)")
-    upload_parser.add_argument("--folder_path", required=True,
-                               help="Path to the folder containing workflows to upload")
-    upload_parser.add_argument("--api_key",
-                               help="Your n8n API key the default is read from N8N_API_KEY env variable")
-
-
-def main():
-    parser = argparse.ArgumentParser(description="A simple CLI tool for n8n workflows restore.")
-    subparsers = parser.add_subparsers(dest="command", required=True)
-
-    download_cmd(subparsers)
-    upload_cmd(subparsers)
-
-    args = parser.parse_args()
-
-    if args.command == "download":
-        download(parser_args=args, instance_url=args.instance_url, folder_path=args.folder_path)
-    elif args.command == "upload":
-        upload(parser_args=args, instance_url=args.instance_url, folder_path=args.folder_path)
-
-
-if __name__ == "__main__":
-    main()

package/restore_script/download.py

@@ -1,73 +0,0 @@
-import datetime
-import os
-
-import requests
-import json
-
-from utils import get_api_key, create_headers
-
-
-def main():
-    print("n8n Workflow Downloader")
-    instance_url = input("Enter n8n instance URL (e.g., https://n8n.example.com): ").strip().rstrip("/")
-    api_key = input("Enter your n8n API key: ").strip() or get_api_key("api_key_download.txt")
-    active = input("Do you want to download only active workflows? (y/n, default n): ").strip().lower() == 'y'
-    pinned_data = input("Do you want to download pinned data also? (y/n, default n): ").strip().lower() == 'y'
-
-    url = create_workflows_endpoint(instance_url, active, pinned_data)
-    if workflows:= fetch_workflows(url, api_key):
-        folder_path = create_folder(folder_path="./workflows/", instance_url=instance_url)
-        save_workflows(folder_path, workflows)
-
-
-def create_workflows_endpoint(instance_url: str, active: bool, pinned_data: bool):
-    base_url = f"{instance_url}/api/v1/workflows"
-    active = "true" if active else "false"
-    pinned_data = "true" if not pinned_data else "false"
-
-    return f"{base_url}?active={active}&excludePinnedData={pinned_data}"
-
-
-def fetch_workflows(url, api_key):
-    headers = create_headers(api_key)
-    workflows = []
-    next_cursor = None
-    while True:
-        full_url = f"{url}&limit=100" + (f"&cursor={next_cursor}" if next_cursor else "")
-        try:
-            resp = requests.get(full_url, headers=headers)
-            resp.raise_for_status()
-        except requests.RequestException as e:
-            print(f"Error: {e}")
-            return []
-
-        data = resp.json()
-        workflows.extend(data.get("data", []))
-        next_cursor = data.get("nextCursor")
-        if not next_cursor:
-            break
-
-    return workflows
-
-
-def create_folder(folder_path, instance_url):
-    name = (f"{datetime.datetime.now().strftime('%Y_%m_%d-%H_%M')}-"
-            f"{instance_url.replace('https://', '').replace('http://', '').replace('/', '_')}"
-            )
-    path = os.path.join(folder_path, name)
-    os.makedirs(path, exist_ok=True)
-
-    return path
-
-
-def save_workflows(folder_path, workflows):
-    for workflow in workflows:
-        filename = f"{workflow['name']}.json"
-        with open(f"{folder_path}/{filename}", "w") as f:
-            json.dump(workflow, f, indent=2)
-        print(f"{filename} - saved")
-    print(f"All workflows has been saved to {folder_path}")
-
-
-if __name__ == "__main__":
-    main()

package/restore_script/main.py

@@ -1,19 +0,0 @@
-from utils import select_option
-
-
-def main():
-    options = ["Download", "Upload", "Transfer"]
-    selected = select_option(options)
-    match selected:
-        case "Download":
-            from download import main
-        case "Upload":
-            from upload import main
-        case "Transfer":
-            from transfer import main
-
-    main()
-
-
-if __name__ == "__main__":
-    main()