@skriptfabrik/n8n-nodes-fulfillmenttools 0.1.0 → 0.1.2

package/src/nodes/Fulfillmenttools/descriptions/OrderDescription.ts

@@ -0,0 +1,338 @@
+import type { INodeProperties } from 'n8n-workflow';
+
+export const orderOperations: INodeProperties[] = [
+  {
+    displayName: 'Operation',
+    name: 'operation',
+    type: 'options',
+    noDataExpression: true,
+    displayOptions: {
+      show: {
+        resource: ['order'],
+      },
+    },
+    options: [
+      {
+        name: 'Create',
+        value: 'create',
+        description: 'Add a new order for future fulfillment',
+        action: 'Create order',
+      },
+      {
+        name: 'Get',
+        value: 'get',
+        description: 'Get a order with the given ID',
+        action: 'Get order',
+      },
+      {
+        name: 'List',
+        value: 'list',
+        description: 'Return all orders',
+        action: 'List orders',
+      },
+    ],
+    default: 'create',
+  },
+];
+
+export const orderFields: INodeProperties[] = [
+  /* -------------------------------------------------------------------------- */
+  /*                                 order:create                               */
+  /* -------------------------------------------------------------------------- */
+  {
+    displayName: 'Order',
+    name: 'order',
+    type: 'json',
+    required: true,
+    default: JSON.stringify(
+      {
+        orderDate: '2023-03-11T08:16:07.000Z',
+        consumer: {
+          email: 'ulf.steinke@ocff.de',
+          addresses: [
+            {
+              street: 'Schanzenstr.',
+              houseNumber: '30',
+              postalCode: '51063',
+              city: 'Köln',
+              country: 'DE',
+              phoneNumbers: [
+                {
+                  value: '0177-555-6273',
+                  label: 'private',
+                  type: 'MOBILE',
+                },
+              ],
+              additionalAddressInfo: '3. Etage',
+              salutation: 'Herr',
+              firstName: 'Ulf',
+              lastName: 'Steinke',
+            },
+          ],
+        },
+        tenantOrderId: 'FC-4711-2361',
+        status: 'OPEN',
+        orderLineItems: [
+          {
+            article: {
+              tenantArticleId: '2020249',
+              title: 'T-Shirt "Am Sonnenhut"',
+              imageUrl:
+                'https://d358g9injarr4u.cloudfront.net/res/product_1000/240eadd8-8f50-479d-b0d8-74412bd4a9f9.jpg',
+              attributes: [
+                {
+                  category: 'miscellaneous',
+                  key: 'BRAND',
+                  value: 'Adidas',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 100,
+                  key: '%%subtitle%%',
+                  value: 'Neu!',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 200,
+                  key: 'Mitgliederpreis',
+                  value: '17,96 EUR',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 300,
+                  key: 'Schnitt',
+                  value: 'Frauen',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 400,
+                  key: 'Material',
+                  value: '100% Baumwolle',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 500,
+                  key: 'Artikelnummer',
+                  value: '2020249',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 600,
+                  key: 'Größe',
+                  value: 'S',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 700,
+                  key: 'Beschreibung',
+                  value:
+                    'Rotes T-Shirt mit weißen Streifen an den Ärmeln, Blockdruck mit Schriftzug auf der Brust',
+                },
+              ],
+            },
+            quantity: 1,
+            scannableCodes: ['2020249'],
+          },
+          {
+            article: {
+              tenantArticleId: '2010681',
+              title: 'Steppjacke "Mühlenbach"',
+              imageUrl:
+                'https://d358g9injarr4u.cloudfront.net/res/product_1000/9fcb7e42-7c84-4ab0-999a-869efe077e0a.jpg',
+              attributes: [
+                {
+                  category: 'descriptive',
+                  priority: 100,
+                  key: '%%subtitle%%',
+                  value: 'Neu!',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 200,
+                  key: 'Größe',
+                  value: 'L',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 300,
+                  key: 'Oberstoff',
+                  value: '100% Polyester',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 400,
+                  key: 'Futter',
+                  value: '100% Polyester',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 500,
+                  key: 'Füllung',
+                  value: '100% Polyester',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 600,
+                  key: 'Beschreibung',
+                  value:
+                    'Dreifarbige Steppjacke mit verstaubarer Kapuze, Zwei Eingriffstaschen, Gesticktes Logo auf der Brust',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 700,
+                  key: 'Artikelnummer',
+                  value: '2010681',
+                },
+              ],
+            },
+            quantity: 1,
+            scannableCodes: ['2010681'],
+          },
+          {
+            article: {
+              tenantArticleId: '5020064',
+              title: 'Wandtattoo Stadion',
+              imageUrl:
+                'https://d358g9injarr4u.cloudfront.net/res/product_1000/343f4569-66bb-4b0c-aa2b-20011a51b620.jpg',
+              attributes: [
+                {
+                  category: 'descriptive',
+                  priority: 100,
+                  key: 'Maße',
+                  value: '70 x 50 cm',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 200,
+                  key: 'Beschreibung',
+                  value:
+                    'Wandtattoo in Ziegelwand-Optik, Mit tollem Blick aufs Stadion',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 300,
+                  key: 'Anwendung',
+                  value:
+                    'Für die Beklebung sollte die Fläche staub- und fetfrei sein. Bringen Sie den Aufkleber in Position und reiben Sie diese gleichmäßig mit der flachen Hand an den Untergrund, um sie zu fixieren. Jede Stelle nochmals gest andrücken. Fertig! Für auftretende Schäden nach der Verklebung auf dem Untergrund etc. ist eine Haftung ausgeschlossen.',
+                },
+                {
+                  category: 'descriptive',
+                  priority: 400,
+                  key: 'Artikelnummer',
+                  value: '5020064',
+                },
+              ],
+            },
+            quantity: 2,
+            scannableCodes: ['5020064'],
+          },
+        ],
+        paymentInfo: {
+          currency: 'EUR',
+        },
+      },
+      undefined,
+      2,
+    ),
+    displayOptions: {
+      show: {
+        resource: ['order'],
+        operation: ['create'],
+      },
+    },
+    description: 'Order object supplied by your shop instance',
+  },
+  /* -------------------------------------------------------------------------- */
+  /*                                 order:get                                  */
+  /* -------------------------------------------------------------------------- */
+  {
+    displayName: 'Order ID',
+    name: 'orderId',
+    type: 'string',
+    required: true,
+    default: '',
+    displayOptions: {
+      show: {
+        resource: ['order'],
+        operation: ['get'],
+      },
+    },
+    description: 'ID of order you want to get',
+  },
+  /* -------------------------------------------------------------------------- */
+  /*                                 order:list                                 */
+  /* -------------------------------------------------------------------------- */
+  {
+    displayName: 'Return All',
+    name: 'returnAll',
+    type: 'boolean',
+    displayOptions: {
+      show: {
+        resource: ['order'],
+        operation: ['list'],
+      },
+    },
+    default: false,
+    description: 'Whether to return all results or only up to a given limit',
+  },
+  {
+    displayName: 'Limit',
+    name: 'limit',
+    type: 'number',
+    displayOptions: {
+      show: {
+        resource: ['order'],
+        operation: ['list'],
+        returnAll: [false],
+      },
+    },
+    typeOptions: {
+      minValue: 1,
+    },
+    default: 50,
+    description: 'Max number of results to return',
+  },
+  {
+    displayName: 'Start After ID',
+    name: 'startAfterId',
+    type: 'string',
+    displayOptions: {
+      show: {
+        resource: ['order'],
+        operation: ['list'],
+        returnAll: [false],
+      },
+    },
+    default: '',
+    description: 'All results after given ID will be returned',
+  },
+  {
+    displayName: 'Size',
+    name: 'size',
+    type: 'number',
+    displayOptions: {
+      show: {
+        resource: ['order'],
+        operation: ['list'],
+      },
+    },
+    typeOptions: {
+      minValue: 1,
+    },
+    default: 25,
+    description: 'Number of results to show',
+  },
+  {
+    displayName: 'Tenant Order ID',
+    name: 'tenantOrderId',
+    type: 'string',
+    displayOptions: {
+      show: {
+        resource: ['order'],
+        operation: ['list'],
+      },
+    },
+    default: '',
+    description: 'Allows you to filter results by tenant order ID',
+  },
+];

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

package/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"],
+  "include": ["src/**/*.ts"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "types": ["jest", "node"]
+  },
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+  ]
+}

package/src/credentials/FulfillmenttoolsApi.credentials.d.ts

@@ -1,13 +0,0 @@
-import { type IAuthenticateGeneric, type ICredentialDataDecryptedObject, type ICredentialTestRequest, type ICredentialType, type IHttpRequestHelper, type INodeProperties } from 'n8n-workflow';
-export declare class FulfillmenttoolsApi implements ICredentialType {
-    name: string;
-    displayName: string;
-    documentationUrl: string;
-    properties: INodeProperties[];
-    preAuthentication(this: IHttpRequestHelper, credentials: ICredentialDataDecryptedObject): Promise<{
-        idToken: string;
-        refreshToken: string;
-    }>;
-    authenticate: IAuthenticateGeneric;
-    test: ICredentialTestRequest;
-}

package/src/credentials/FulfillmenttoolsApi.credentials.js

@@ -1,126 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FulfillmenttoolsApi = void 0;
-const tslib_1 = require("tslib");
-const crypto_1 = require("crypto");
-class FulfillmenttoolsApi {
-    constructor() {
-        this.name = 'fulfillmenttoolsApi';
-        this.displayName = 'fulfillmenttools API';
-        this.documentationUrl = 'https://docs.fulfillmenttools.com/api-docs/getting-started/make-your-first-api-call';
-        this.properties = [
-            {
-                displayName: 'Username',
-                name: 'username',
-                type: 'string',
-                required: true,
-                default: undefined,
-            },
-            {
-                displayName: 'Password',
-                name: 'password',
-                type: 'string',
-                typeOptions: {
-                    password: true,
-                },
-                required: true,
-                default: undefined,
-            },
-            {
-                displayName: 'API Key',
-                name: 'apiKey',
-                type: 'string',
-                typeOptions: {
-                    password: true,
-                },
-                required: true,
-                default: undefined,
-            },
-            {
-                displayName: 'Sub Domain',
-                name: 'subDomain',
-                type: 'string',
-                required: true,
-                default: undefined,
-            },
-            {
-                displayName: 'Webhook Token',
-                name: 'webhookToken',
-                type: 'string',
-                typeOptions: {
-                    password: true,
-                },
-                required: true,
-                default: (0, crypto_1.randomBytes)(16).toString('hex'),
-            },
-            {
-                displayName: 'ID Token',
-                name: 'idToken',
-                type: 'hidden',
-                typeOptions: {
-                    expirable: true,
-                },
-                default: undefined,
-            },
-            {
-                displayName: 'Refresh Token',
-                name: 'refreshToken',
-                type: 'hidden',
-                default: undefined,
-            },
-        ];
-        this.authenticate = {
-            type: 'generic',
-            properties: {
-                headers: {
-                    Authorization: '=Bearer {{$credentials.idToken}}',
-                },
-            },
-        };
-        this.test = {
-            request: {
-                baseURL: '=https://{{$credentials.subDomain}}.api.fulfillmenttools.com/api',
-                url: '/health',
-            },
-        };
-    }
-    preAuthentication(credentials) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            if (!credentials['refreshToken']) {
-                const responseData = (yield this.helpers.httpRequest({
-                    method: 'POST',
-                    url: 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword',
-                    body: {
-                        email: `${credentials['username']}@${credentials['subDomain']}.com`,
-                        password: credentials['password'],
-                        returnSecureToken: true,
-                    },
-                    qs: {
-                        key: credentials['apiKey'],
-                    },
-                }));
-                return {
-                    idToken: responseData.idToken,
-                    refreshToken: responseData.refreshToken,
-                };
-            }
-            const responseData = (yield this.helpers.httpRequest({
-                method: 'POST',
-                url: 'https://securetoken.googleapis.com/v1/token',
-                body: {
-                    grant_type: 'refresh_token',
-                    refresh_token: credentials['refreshToken'],
-                },
-                qs: {
-                    key: credentials['apiKey'],
-                },
-            }));
-            return {
-                idToken: responseData.id_token,
-                refreshToken: responseData.refresh_token,
-            };
-        });
-    }
-}
-exports.FulfillmenttoolsApi = FulfillmenttoolsApi;
-//# sourceMappingURL=FulfillmenttoolsApi.credentials.js.map

package/src/credentials/FulfillmenttoolsApi.credentials.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FulfillmenttoolsApi.credentials.js","sourceRoot":"","sources":["../../../../../nodes/fulfillmenttools/src/credentials/FulfillmenttoolsApi.credentials.ts"],"names":[],"mappings":";;;;AAAA,mCAAqC;AAqCrC,MAAa,mBAAmB;IAAhC;QACE,SAAI,GAAG,qBAAqB,CAAC;QAE7B,gBAAW,GAAG,sBAAsB,CAAC;QAErC,qBAAgB,GACd,qFAAqF,CAAC;QAExF,eAAU,GAAsB;YAC9B;gBACE,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,SAAS;aACnB;YACD;gBACE,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACX,QAAQ,EAAE,IAAI;iBACf;gBACD,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,SAAS;aACnB;YACD;gBACE,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACX,QAAQ,EAAE,IAAI;iBACf;gBACD,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,SAAS;aACnB;YACD;gBACE,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,SAAS;aACnB;YACD;gBACE,WAAW,EAAE,eAAe;gBAC5B,IAAI,EAAE,cAAc;gBACpB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACX,QAAQ,EAAE,IAAI;iBACf;gBACD,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,IAAA,oBAAW,EAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;aACzC;YACD;gBACE,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACX,SAAS,EAAE,IAAI;iBAChB;gBACD,OAAO,EAAE,SAAS;aACnB;YACD;gBACE,WAAW,EAAE,eAAe;gBAC5B,IAAI,EAAE,cAAc;gBACpB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,SAAS;aACnB;SACF,CAAC;QA4CF,iBAAY,GAAyB;YACnC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACV,OAAO,EAAE;oBACP,aAAa,EAAE,kCAAkC;iBAClD;aACF;SACF,CAAC;QAEF,SAAI,GAA2B;YAC7B,OAAO,EAAE;gBACP,OAAO,EACL,kEAAkE;gBACpE,GAAG,EAAE,SAAS;aACf;SACF,CAAC;IACJ,CAAC;IA1DO,iBAAiB,CAErB,WAA2C;;YAE3C,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC;gBACjC,MAAM,YAAY,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;oBACnD,MAAM,EAAE,MAAM;oBACd,GAAG,EAAE,uEAAuE;oBAC5E,IAAI,EAAE;wBACJ,KAAK,EAAE,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,WAAW,CAAC,WAAW,CAAC,MAAM;wBACnE,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC;wBACjC,iBAAiB,EAAE,IAAI;qBACxB;oBACD,EAAE,EAAE;wBACF,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC;qBAC3B;iBACF,CAAC,CAAoB,CAAC;gBAEvB,OAAO;oBACL,OAAO,EAAE,YAAY,CAAC,OAAO;oBAC7B,YAAY,EAAE,YAAY,CAAC,YAAY;iBACxC,CAAC;YACJ,CAAC;YAED,MAAM,YAAY,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;gBACnD,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,6CAA6C;gBAClD,IAAI,EAAE;oBACJ,UAAU,EAAE,eAAe;oBAC3B,aAAa,EAAE,WAAW,CAAC,cAAc,CAAC;iBAC3C;gBACD,EAAE,EAAE;oBACF,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC;iBAC3B;aACF,CAAC,CAAyB,CAAC;YAE5B,OAAO;gBACL,OAAO,EAAE,YAAY,CAAC,QAAQ;gBAC9B,YAAY,EAAE,YAAY,CAAC,aAAa;aACzC,CAAC;QACJ,CAAC;KAAA;CAkBF;AAhID,kDAgIC"}

package/src/nodes/Fulfillmenttools/Fulfillmenttools.node.d.ts

@@ -1,5 +0,0 @@
-import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
-export declare class Fulfillmenttools implements INodeType {
-    description: INodeTypeDescription;
-    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
-}