@skriptfabrik/n8n-nodes-fulfillmenttools 0.1.2 → 0.1.3

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

@@ -1,396 +0,0 @@
-import type {
-  IDataObject,
-  IHookFunctions,
-  INodeType,
-  INodeTypeDescription,
-  IWebhookFunctions,
-  IWebhookResponseData,
-} from 'n8n-workflow';
-import type { components } from '../../api';
-import { fulfillmenttoolsApiRequest } from './GenericFunctions';
-
-type Subscription = components['schemas']['Subscription'];
-type Subscriptions = components['schemas']['Subscriptions'];
-
-type Credentials = {
-  username: string;
-  password: string;
-  apiKey: string;
-  subDomain: string;
-  webhookToken: string;
-  idToken?: string;
-  refreshToken?: string;
-};
-
-type HeaderData = {
-  'x-fulfillmenttools-event'?: string;
-  'x-fulfillmenttools-token'?: string;
-};
-
-type StaticData = {
-  subscriptionId?: string;
-};
-
-enum FulfillmenttoolsEvents {
-  ORDER_CREATED = 'ORDER_CREATED',
-  ORDER_CANCELED = 'ORDER_CANCELED',
-  ORDER_UNLOCKED = 'ORDER_UNLOCKED',
-  INVENTORY_FACILITY_STOCK_CHANGED = 'INVENTORY_FACILITY_STOCK_CHANGED',
-  INBOUND_DELIVERY_RECEIVED = 'INBOUND_DELIVERY_RECEIVED',
-  INBOUND_DELIVERY_FINISHED = 'INBOUND_DELIVERY_FINISHED',
-  INBOUND_DELIVERY_ON_HOLD = 'INBOUND_DELIVERY_ON_HOLD',
-  ROUTING_PLAN_SPLITTED = 'ROUTING_PLAN_SPLITTED',
-  ROUTING_PLAN_WAITING = 'ROUTING_PLAN_WAITING',
-  ROUTING_PLAN_FALLBACK = 'ROUTING_PLAN_FALLBACK',
-  ROUTING_PLAN_ROUTED = 'ROUTING_PLAN_ROUTED',
-  ROUTING_PLAN_REROUTEPLAN_CREATED = 'ROUTING_PLAN_REROUTEPLAN_CREATED',
-  ROUTING_PLAN_NOT_ROUTABLE = 'ROUTING_PLAN_NOT_ROUTABLE',
-  FACILITY_CREATED = 'FACILITY_CREATED',
-  FACILITY_UPDATED = 'FACILITY_UPDATED',
-  FACILITY_DELETED = 'FACILITY_DELETED',
-  PICK_JOB_CREATED = 'PICK_JOB_CREATED',
-  PICK_JOB_PICKING_COMMENCED = 'PICK_JOB_PICKING_COMMENCED',
-  PICK_JOB_PICKING_PAUSED = 'PICK_JOB_PICKING_PAUSED',
-  PICK_JOB_PICKING_FINISHED = 'PICK_JOB_PICKING_FINISHED',
-  PICK_JOB_PICK_LINE_PICKED = 'PICK_JOB_PICK_LINE_PICKED',
-  PICK_JOB_REROUTED = 'PICK_JOB_REROUTED',
-  PICK_JOB_RESET = 'PICK_JOB_RESET',
-  PICK_JOB_ABORTED = 'PICK_JOB_ABORTED',
-  PACK_JOB_CREATED = 'PACK_JOB_CREATED',
-  PACK_JOB_UPDATED = 'PACK_JOB_UPDATED',
-  HANDOVERJOB_CREATED = 'HANDOVERJOB_CREATED',
-  HANDOVERJOB_HANDED_OVER = 'HANDOVERJOB_HANDED_OVER',
-  HANDOVERJOB_REVERTED = 'HANDOVERJOB_REVERTED',
-  HANDOVERJOB_CANCELED = 'HANDOVERJOB_CANCELED',
-  PARCEL_CARRIER_REQUESTED = 'PARCEL_CARRIER_REQUESTED',
-  PARCEL_CARRIER_FAILED = 'PARCEL_CARRIER_FAILED',
-  PARCEL_CARRIER_ACKNOWLEDGED = 'PARCEL_CARRIER_ACKNOWLEDGED',
-  RETURN_CREATED = 'RETURN_CREATED',
-  RETURN_CLAIMED = 'RETURN_CLAIMED',
-  RETURN_CLOSED = 'RETURN_CLOSED',
-  RETURN_CANCELED = 'RETURN_CANCELED',
-  RETURN_UPDATED = 'RETURN_UPDATED',
-}
-
-export class FulfillmenttoolsTrigger implements INodeType {
-  description: INodeTypeDescription = {
-    name: 'fulfillmenttoolsTrigger',
-
-    displayName: 'fulfillmenttools Trigger',
-
-    icon: 'file:icons/fulfillmenttools.svg',
-
-    group: ['trigger'],
-
-    version: 1,
-
-    subtitle: '={{$parameter["event"].toLowerCase().split("_").join(" ")}}',
-
-    description: 'Listen to fulfillmenttools events',
-
-    defaults: {
-      name: 'fulfillmenttools Trigger',
-    },
-
-    inputs: [],
-
-    outputs: ['main'],
-
-    credentials: [
-      {
-        name: 'fulfillmenttoolsApi',
-        required: true,
-      },
-    ],
-
-    webhooks: [
-      {
-        name: 'default',
-        httpMethod: 'POST',
-        responseMode: 'onReceived',
-        path: 'webhook',
-      },
-    ],
-
-    properties: [
-      {
-        displayName: 'Event',
-        name: 'event',
-        type: 'options',
-        noDataExpression: true,
-        options: [
-          {
-            name: 'Order Created',
-            value: FulfillmenttoolsEvents.ORDER_CREATED,
-          },
-          {
-            name: 'Order Canceled',
-            value: FulfillmenttoolsEvents.ORDER_CANCELED,
-          },
-          {
-            name: 'Order Unlocked',
-            value: FulfillmenttoolsEvents.ORDER_UNLOCKED,
-          },
-          {
-            name: 'Inventory Facility Stock Changed',
-            value: FulfillmenttoolsEvents.INVENTORY_FACILITY_STOCK_CHANGED,
-          },
-          {
-            name: 'Inbound Delivery Received',
-            value: FulfillmenttoolsEvents.INBOUND_DELIVERY_RECEIVED,
-          },
-          {
-            name: 'Inbound Delivery Finished',
-            value: FulfillmenttoolsEvents.INBOUND_DELIVERY_FINISHED,
-          },
-          {
-            name: 'Inbound Delivery On Hold',
-            value: FulfillmenttoolsEvents.INBOUND_DELIVERY_ON_HOLD,
-          },
-          {
-            name: 'Routing Plan Splitted',
-            value: FulfillmenttoolsEvents.ROUTING_PLAN_SPLITTED,
-          },
-          {
-            name: 'Routing Plan Waiting',
-            value: FulfillmenttoolsEvents.ROUTING_PLAN_WAITING,
-          },
-          {
-            name: 'Routing Plan Fallback',
-            value: FulfillmenttoolsEvents.ROUTING_PLAN_FALLBACK,
-          },
-          {
-            name: 'Routing Plan Routed',
-            value: FulfillmenttoolsEvents.ROUTING_PLAN_ROUTED,
-          },
-          {
-            name: 'Routing Plan Rerouteplan Created',
-            value: FulfillmenttoolsEvents.ROUTING_PLAN_REROUTEPLAN_CREATED,
-          },
-          {
-            name: 'Routing Plan Not Routable',
-            value: FulfillmenttoolsEvents.ROUTING_PLAN_NOT_ROUTABLE,
-          },
-          {
-            name: 'Facility Created',
-            value: FulfillmenttoolsEvents.FACILITY_CREATED,
-          },
-          {
-            name: 'Facility Updated',
-            value: FulfillmenttoolsEvents.FACILITY_UPDATED,
-          },
-          {
-            name: 'Facility Deleted',
-            value: FulfillmenttoolsEvents.FACILITY_DELETED,
-          },
-          {
-            name: 'Pick Job Created',
-            value: FulfillmenttoolsEvents.PICK_JOB_CREATED,
-          },
-          {
-            name: 'Pick Job Picking Commenced',
-            value: FulfillmenttoolsEvents.PICK_JOB_PICKING_COMMENCED,
-          },
-          {
-            name: 'Pick Job Picking Paused',
-            value: FulfillmenttoolsEvents.PICK_JOB_PICKING_PAUSED,
-          },
-          {
-            name: 'Pick Job Picking Finished',
-            value: FulfillmenttoolsEvents.PICK_JOB_PICKING_FINISHED,
-          },
-          {
-            name: 'Pick Job Pick Line Picked',
-            value: FulfillmenttoolsEvents.PICK_JOB_PICK_LINE_PICKED,
-          },
-          {
-            name: 'Pick Job Rerouted',
-            value: FulfillmenttoolsEvents.PICK_JOB_REROUTED,
-          },
-          {
-            name: 'Pick Job Reset',
-            value: FulfillmenttoolsEvents.PICK_JOB_RESET,
-          },
-          {
-            name: 'Pick Job Aborted',
-            value: FulfillmenttoolsEvents.PICK_JOB_ABORTED,
-          },
-          {
-            name: 'Pack Job Created',
-            value: FulfillmenttoolsEvents.PACK_JOB_CREATED,
-          },
-          {
-            name: 'Pack Job Updated',
-            value: FulfillmenttoolsEvents.PACK_JOB_UPDATED,
-          },
-          {
-            name: 'Handoverjob Created',
-            value: FulfillmenttoolsEvents.HANDOVERJOB_CREATED,
-          },
-          {
-            name: 'Handoverjob Handed Over',
-            value: FulfillmenttoolsEvents.HANDOVERJOB_HANDED_OVER,
-          },
-          {
-            name: 'Handoverjob Reverted',
-            value: FulfillmenttoolsEvents.HANDOVERJOB_REVERTED,
-          },
-          {
-            name: 'Handoverjob Canceled',
-            value: FulfillmenttoolsEvents.HANDOVERJOB_CANCELED,
-          },
-          {
-            name: 'Parcel Carrier Requested',
-            value: FulfillmenttoolsEvents.PARCEL_CARRIER_REQUESTED,
-          },
-          {
-            name: 'Parcel Carrier Failed',
-            value: FulfillmenttoolsEvents.PARCEL_CARRIER_FAILED,
-          },
-          {
-            name: 'Parcel Carrier Acknowledged',
-            value: FulfillmenttoolsEvents.PARCEL_CARRIER_ACKNOWLEDGED,
-          },
-          {
-            name: 'Return Created',
-            value: FulfillmenttoolsEvents.RETURN_CREATED,
-          },
-          {
-            name: 'Return Claimed',
-            value: FulfillmenttoolsEvents.RETURN_CLAIMED,
-          },
-          {
-            name: 'Return Closed',
-            value: FulfillmenttoolsEvents.RETURN_CLOSED,
-          },
-          {
-            name: 'Return Canceled',
-            value: FulfillmenttoolsEvents.RETURN_CANCELED,
-          },
-          {
-            name: 'Return Updated',
-            value: FulfillmenttoolsEvents.RETURN_UPDATED,
-          },
-        ],
-        default: FulfillmenttoolsEvents.ORDER_CREATED.toString(),
-      },
-    ],
-  };
-
-  webhookMethods = {
-    default: {
-      async checkExists(this: IHookFunctions): Promise<boolean> {
-        const callbackUrl = this.getNodeWebhookUrl('default') as string;
-        const staticData = this.getWorkflowStaticData('node') as StaticData;
-
-        const responseData = (await fulfillmenttoolsApiRequest.call(
-          this,
-          'GET',
-          '/subscriptions',
-        )) as Subscriptions;
-
-        for (const subscription of responseData.subscriptions as Subscription[]) {
-          if (subscription.callbackUrl === callbackUrl) {
-            staticData.subscriptionId = subscription.id;
-            return true;
-          }
-        }
-
-        return false;
-      },
-      async create(this: IHookFunctions): Promise<boolean> {
-        const callbackUrl = this.getNodeWebhookUrl('default') as string;
-        const event = this.getNodeParameter('event') as string;
-        const credentials = (await this.getCredentials(
-          'fulfillmenttoolsApi',
-        )) as Credentials;
-        const staticData = this.getWorkflowStaticData('node') as StaticData;
-
-        const responseData = (await fulfillmenttoolsApiRequest.call(
-          this,
-          'POST',
-          '/subscriptions',
-          {
-            callbackUrl,
-            event,
-            name: `${event}`.split('_').join(' ').toLowerCase(),
-            headers: [
-              {
-                key: 'user-agent',
-                value: `${credentials.subDomain}/1.0`,
-              },
-              {
-                key: 'x-fulfillmenttools-event',
-                value: event,
-              },
-              {
-                key: 'x-fulfillmenttools-token',
-                value: credentials.webhookToken,
-              },
-            ],
-          },
-        )) as Subscription;
-
-        if (responseData.id === undefined) {
-          return false;
-        }
-
-        staticData.subscriptionId = responseData.id;
-
-        return true;
-      },
-      async delete(this: IHookFunctions): Promise<boolean> {
-        const staticData = this.getWorkflowStaticData('node') as StaticData;
-
-        if (staticData.subscriptionId === undefined) {
-          return true;
-        }
-
-        try {
-          await fulfillmenttoolsApiRequest.call(
-            this,
-            'DELETE',
-            `/subscriptions/${staticData.subscriptionId}`,
-          );
-        } catch (error) {
-          return false;
-        }
-
-        delete staticData.subscriptionId;
-
-        return true;
-      },
-    },
-  };
-
-  async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
-    const headerData = this.getHeaderData() as HeaderData;
-
-    if (
-      headerData['x-fulfillmenttools-event'] === undefined ||
-      headerData['x-fulfillmenttools-token'] === undefined
-    ) {
-      return {};
-    }
-
-    const event = this.getNodeParameter('event') as string;
-
-    if (headerData['x-fulfillmenttools-event'] !== event) {
-      return {};
-    }
-
-    const credentials = (await this.getCredentials(
-      'fulfillmenttoolsApi',
-    )) as Credentials;
-
-    if (headerData['x-fulfillmenttools-token'] !== credentials.webhookToken) {
-      return {};
-    }
-
-    const req = this.getRequestObject();
-
-    return {
-      workflowData: [this.helpers.returnJsonArray(req.body as IDataObject)],
-    };
-  }
-}

package/src/nodes/Fulfillmenttools/GenericFunctions.spec.ts

@@ -1,279 +0,0 @@
-import { mockClear, mockDeep } from 'jest-mock-extended';
-import type { IExecuteFunctions } from 'n8n-workflow';
-import { NodeApiError, sleep } from 'n8n-workflow';
-import {
-  fulfillmenttoolsApiRequest,
-  fulfillmenttoolsApiRequestAllItems,
-} from './GenericFunctions';
-
-jest.mock('n8n-workflow');
-
-describe('GenericFunctions', () => {
-  const executeFunctions = mockDeep<IExecuteFunctions>();
-  const mockedSleep = jest.mocked(sleep);
-
-  afterEach(() => {
-    mockClear(executeFunctions);
-    mockClear(mockedSleep);
-  });
-
-  it('should make a simple API request', () => {
-    const body = {
-      status: 'UP',
-      dependencies: [
-        {
-          name: 'database',
-          status: 'UP',
-        },
-      ],
-    };
-
-    const responses = [{ body, statusCode: 200 }];
-
-    executeFunctions.getCredentials
-      .calledWith('fulfillmenttoolsApi')
-      .mockResolvedValue({ subDomain: '_example_' });
-    executeFunctions.helpers.httpRequestWithAuthentication
-      .calledWith('fulfillmenttoolsApi', expect.any(Object))
-      .mockImplementation(() => Promise.resolve(responses.shift()));
-
-    expect(
-      fulfillmenttoolsApiRequest.call(executeFunctions, 'GET', '/health'),
-    ).resolves.toEqual(body);
-  });
-
-  it('should make a second API request because of version missmatch', () => {
-    const body = {
-      version: 3,
-    };
-
-    const responses = [
-      { body: [{ version: 2 }], statusCode: 409 },
-      { body, statusCode: 200 },
-    ];
-
-    executeFunctions.getCredentials
-      .calledWith('fulfillmenttoolsApi')
-      .mockResolvedValue({ subDomain: '_example_' });
-    executeFunctions.helpers.httpRequestWithAuthentication
-      .calledWith('fulfillmenttoolsApi', expect.any(Object))
-      .mockImplementation(() => Promise.resolve(responses.shift()));
-
-    expect(
-      fulfillmenttoolsApiRequest.call(executeFunctions, 'POST', '/example', {
-        version: 1,
-      }),
-    ).resolves.toEqual(body);
-  });
-
-  it('should make a second API request because of too many requests', () => {
-    const body = {
-      version: 3,
-    };
-
-    const responses = [
-      { body: [], statusCode: 429 },
-      { body, statusCode: 200 },
-    ];
-
-    executeFunctions.getCredentials
-      .calledWith('fulfillmenttoolsApi')
-      .mockResolvedValue({ subDomain: '_example_' });
-    executeFunctions.helpers.httpRequestWithAuthentication
-      .calledWith('fulfillmenttoolsApi', expect.any(Object))
-      .mockImplementation(() => Promise.resolve(responses.shift()));
-
-    expect(
-      fulfillmenttoolsApiRequest.call(executeFunctions, 'POST', '/example', {
-        version: 1,
-      }),
-    ).resolves.toEqual(body);
-  });
-
-  it('should throw immediatly because of invalid input', () => {
-    const responses = [
-      { body: [{ summary: 'Invalid input' }], statusCode: 400 },
-    ];
-
-    executeFunctions.getCredentials
-      .calledWith('fulfillmenttoolsApi')
-      .mockResolvedValue({ subDomain: '_example_' });
-    executeFunctions.helpers.httpRequestWithAuthentication
-      .calledWith('fulfillmenttoolsApi', expect.any(Object))
-      .mockImplementation(() => Promise.resolve(responses.shift()));
-
-    expect(
-      fulfillmenttoolsApiRequest.call(executeFunctions, 'POST', '/example', {
-        version: 1,
-      }),
-    ).rejects.toBeInstanceOf(NodeApiError);
-  });
-
-  it('should throw immediatly because of version missmatch without version in response', () => {
-    const responses = [
-      {
-        body: [{ summary: 'Conflict while processing something' }],
-        statusCode: 409,
-      },
-    ];
-
-    executeFunctions.getCredentials
-      .calledWith('fulfillmenttoolsApi')
-      .mockResolvedValue({ subDomain: '_example_' });
-    executeFunctions.helpers.httpRequestWithAuthentication
-      .calledWith('fulfillmenttoolsApi', expect.any(Object))
-      .mockImplementation(() => Promise.resolve(responses.shift()));
-
-    expect(
-      fulfillmenttoolsApiRequest.call(executeFunctions, 'POST', '/example', {
-        version: 1,
-      }),
-    ).rejects.toBeInstanceOf(NodeApiError);
-  });
-
-  it('should throw after 2 retries because of version missmatch', () => {
-    const responses = [
-      { body: [{ version: 2 }], statusCode: 409 },
-      { body: [{ version: 2 }], statusCode: 409 },
-    ];
-
-    executeFunctions.getCredentials
-      .calledWith('fulfillmenttoolsApi')
-      .mockResolvedValue({ subDomain: '_example_' });
-    executeFunctions.helpers.httpRequestWithAuthentication
-      .calledWith('fulfillmenttoolsApi', expect.any(Object))
-      .mockImplementation(() => Promise.resolve(responses.shift()));
-
-    expect(
-      fulfillmenttoolsApiRequest.call(executeFunctions, 'POST', '/example', {
-        version: 1,
-      }),
-    ).rejects.toBeInstanceOf(NodeApiError);
-  });
-
-  it('should throw after 9 retries because of too many requests', () => {
-    const responses = [
-      { body: [], statusCode: 429 },
-      { body: [], statusCode: 429 },
-      { body: [], statusCode: 429 },
-      { body: [], statusCode: 429 },
-      { body: [], statusCode: 429 },
-      { body: [], statusCode: 429 },
-      { body: [], statusCode: 429 },
-      { body: [], statusCode: 429 },
-      { body: [], statusCode: 429 },
-    ];
-
-    executeFunctions.getCredentials
-      .calledWith('fulfillmenttoolsApi')
-      .mockResolvedValue({ subDomain: '_example_' });
-    executeFunctions.helpers.httpRequestWithAuthentication
-      .calledWith('fulfillmenttoolsApi', expect.any(Object))
-      .mockImplementation(() => Promise.resolve(responses.shift()));
-
-    expect(
-      fulfillmenttoolsApiRequest.call(executeFunctions, 'POST', '/example', {
-        version: 1,
-      }),
-    ).rejects.toBeInstanceOf(NodeApiError);
-  });
-
-  it('should make an API request to get all items', () => {
-    const body = [
-      {
-        id: '005319a3-29d0-4de0-ab4a-e7c1f0dc8877',
-        created: '2023-11-02T13:14:22.443Z',
-        lastModified: '2023-11-02T13:14:22.443Z',
-        orderDate: '2023-11-02T13:14:20.631Z',
-        version: 1,
-        status: 'OPEN',
-        orderLineItems: [
-          {
-            quantity: 1,
-            title: 'Longsleeve in mehrfarbigem Streifendesign',
-          },
-        ],
-      },
-    ];
-
-    const responses = [
-      { body, statusCode: 200 },
-      { body: [], statusCode: 200 },
-    ];
-
-    executeFunctions.getCredentials
-      .calledWith('fulfillmenttoolsApi')
-      .mockResolvedValue({ subDomain: '_example_' });
-    executeFunctions.helpers.httpRequestWithAuthentication
-      .calledWith('fulfillmenttoolsApi', expect.any(Object))
-      .mockImplementation(() => Promise.resolve(responses.shift()));
-
-    expect(
-      fulfillmenttoolsApiRequestAllItems.call(
-        executeFunctions,
-        undefined,
-        'GET',
-        '/orders',
-      ),
-    ).resolves.toEqual(body);
-  });
-
-  it('should make an API request to get some items', () => {
-    const body = {
-      orders: [
-        {
-          id: '005319a3-29d0-4de0-ab4a-e7c1f0dc8877',
-          created: '2023-11-02T13:14:22.443Z',
-          lastModified: '2023-11-02T13:14:22.443Z',
-          orderDate: '2023-11-02T13:14:20.631Z',
-          version: 1,
-          status: 'OPEN',
-          orderLineItems: [
-            {
-              quantity: 1,
-              title: 'Longsleeve in mehrfarbigem Streifendesign',
-            },
-          ],
-        },
-        {
-          id: '005319a3-29d0-4de0-ab4a-e7c1f0dc8877',
-          created: '2023-11-02T13:14:22.443Z',
-          lastModified: '2023-11-02T13:14:22.443Z',
-          orderDate: '2023-11-02T13:14:20.631Z',
-          version: 1,
-          status: 'OPEN',
-          orderLineItems: [
-            {
-              quantity: 1,
-              title: 'Longsleeve in mehrfarbigem Streifendesign',
-            },
-          ],
-        },
-      ],
-      total: 2,
-    };
-
-    const responses = [
-      { body, statusCode: 200 },
-      { body: { orders: [], total: 0 }, statusCode: 200 },
-    ];
-
-    executeFunctions.getCredentials
-      .calledWith('fulfillmenttoolsApi')
-      .mockResolvedValue({ subDomain: '_example_' });
-    executeFunctions.helpers.httpRequestWithAuthentication
-      .calledWith('fulfillmenttoolsApi', expect.any(Object))
-      .mockImplementation(() => Promise.resolve(responses.shift()));
-
-    expect(
-      fulfillmenttoolsApiRequestAllItems.call(
-        executeFunctions,
-        'orders',
-        'GET',
-        '/orders',
-        undefined,
-        { limit: 1 },
-      ),
-    ).resolves.toEqual([body.orders[0]]);
-  });
-});