@skriptfabrik/n8n-nodes-fulfillmenttools 0.1.0 → 0.1.2

package/src/credentials/FulfillmenttoolsApi.credentials.spec.ts

@@ -0,0 +1,101 @@
+import {
+  type IHttpRequestHelper,
+  type ICredentialDataDecryptedObject,
+} from 'n8n-workflow';
+import { mockClear, mockDeep } from 'jest-mock-extended';
+import { FulfillmenttoolsApi } from './FulfillmenttoolsApi.credentials';
+
+describe('FulfillmenttoolsApi', () => {
+  const httpRequestHelper = mockDeep<IHttpRequestHelper>({});
+
+  let credentials: ICredentialDataDecryptedObject;
+
+  let fulfillmenttoolsApi: FulfillmenttoolsApi;
+
+  beforeEach(() => {
+    credentials = {
+      username: '_email_',
+      password: '_password_',
+      apiKey: '_api_key_',
+      subDomain: '_sub_domain_',
+    };
+
+    fulfillmenttoolsApi = new FulfillmenttoolsApi();
+  });
+
+  afterEach(() => {
+    mockClear(httpRequestHelper);
+  });
+
+  it('should be defined', () => {
+    expect(fulfillmenttoolsApi).toBeDefined();
+  });
+
+  it('should retrieve idToken', async () => {
+    const requestUrl =
+      'https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword';
+
+    httpRequestHelper.helpers.httpRequest.mockResolvedValueOnce({
+      idToken: '_id_token_',
+      refreshToken: '_refresh_token_',
+      expiresIn: 3600,
+    });
+
+    const result = await fulfillmenttoolsApi.preAuthentication.call(
+      httpRequestHelper,
+      credentials,
+    );
+
+    expect(httpRequestHelper.helpers.httpRequest).toHaveBeenCalledWith({
+      method: 'POST',
+      url: requestUrl,
+      body: {
+        email: `${credentials['username']}@${credentials['subDomain']}.com`,
+        password: credentials['password'],
+        returnSecureToken: true,
+      },
+      qs: {
+        key: credentials['apiKey'],
+      },
+    });
+
+    expect(result).toEqual({
+      idToken: '_id_token_',
+      refreshToken: '_refresh_token_',
+    });
+  });
+
+  it('should refresh idToken', async () => {
+    credentials['refreshToken'] = '_refresh_token_';
+
+    const requestUrl = 'https://securetoken.googleapis.com/v1/token';
+
+    httpRequestHelper.helpers.httpRequest.mockResolvedValueOnce({
+      id_token: '_id_token_',
+      refresh_token: '_refresh_token_',
+      expires_in: 3600,
+    });
+
+    const result = await fulfillmenttoolsApi.preAuthentication.call(
+      httpRequestHelper,
+      credentials,
+    );
+
+    expect(httpRequestHelper.helpers.httpRequest).toHaveBeenCalledWith({
+      method: 'POST',
+      url: requestUrl,
+      body: {
+        grant_type: 'refresh_token',
+        refresh_token: '_refresh_token_',
+      },
+      qs: {
+        key: credentials['apiKey'],
+      },
+    });
+
+    expect(result).toEqual({
+      idToken: '_id_token_',
+      refreshToken: '_refresh_token_',
+    });
+  });
+});

package/src/credentials/FulfillmenttoolsApi.credentials.ts

@@ -0,0 +1,166 @@
+import { randomBytes } from 'crypto';
+import {
+  type IAuthenticateGeneric,
+  type ICredentialDataDecryptedObject,
+  type ICredentialTestRequest,
+  type ICredentialType,
+  type IHttpRequestHelper,
+  type INodeProperties,
+} from 'n8n-workflow';
+
+type IdTokenResponse = {
+  kind: string; // deprecated
+  localeId: string;
+  email: string;
+  displayName: string;
+  idToken: string;
+  registered: boolean; // deprecated
+  profilePicture: string;
+  oauthAccessToken: string; // deprecated
+  oauthExpireIn: number; // deprecated
+  oauthAuthorizationCode: string; // deprecated
+  refreshToken: string;
+  expiresIn: number;
+  mfaPendingCredential: string;
+  mfaInfo: object[];
+  userNotifications: object[];
+};
+
+type RefreshTokenResponse = {
+  expires_in: string;
+  token_type: string;
+  refresh_token: string;
+  id_token: string;
+  user_id: string;
+  project_id: string;
+};
+
+export class FulfillmenttoolsApi implements ICredentialType {
+  name = 'fulfillmenttoolsApi';
+
+  displayName = 'fulfillmenttools API';
+
+  documentationUrl =
+    'https://docs.fulfillmenttools.com/api-docs/getting-started/make-your-first-api-call';
+
+  properties: INodeProperties[] = [
+    {
+      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: 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,
+    },
+  ];
+
+  async preAuthentication(
+    this: IHttpRequestHelper,
+    credentials: ICredentialDataDecryptedObject,
+  ) {
+    if (!credentials['refreshToken']) {
+      const responseData = (await 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'],
+        },
+      })) as IdTokenResponse;
+
+      return {
+        idToken: responseData.idToken,
+        refreshToken: responseData.refreshToken,
+      };
+    }
+
+    const responseData = (await 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'],
+      },
+    })) as RefreshTokenResponse;
+
+    return {
+      idToken: responseData.id_token,
+      refreshToken: responseData.refresh_token,
+    };
+  }
+
+  authenticate: IAuthenticateGeneric = {
+    type: 'generic',
+    properties: {
+      headers: {
+        Authorization: '=Bearer {{$credentials.idToken}}',
+      },
+    },
+  };
+
+  test: ICredentialTestRequest = {
+    request: {
+      baseURL:
+        '=https://{{$credentials.subDomain}}.api.fulfillmenttools.com/api',
+      url: '/health',
+    },
+  };
+}