@alanszp/integrations-common 7.8.3

package/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+*.log
+dist

package/.npmignore

@@ -0,0 +1,3 @@
+node_modules
+src
+*.log

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Alan Szpigiel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/IntegrationExecutionResult.d.ts

@@ -0,0 +1,27 @@
+import { IntegrationResultStatus, CommunicationIntegrationStatus, IntegrationResultError } from "./types";
+export interface ChangesStatus {
+    updated: string[];
+    created: string[];
+    errors: IntegrationResultError[];
+}
+export declare class IntegrationExecutionResult {
+    private totals;
+    private details;
+    private integrationId;
+    private organizationReference;
+    private status;
+    private executedBy;
+    private context?;
+    constructor(integrationId: string, organizationReference: string, executedBy?: string);
+    setResults(changes: ChangesStatus): void;
+    setContext(context: Record<string, unknown>): void;
+    getContext(): Record<string, unknown> | undefined;
+    getIntegrationId(): string;
+    getOrganizationReference(): string;
+    setStatus(status: CommunicationIntegrationStatus): void;
+    getStatus(): CommunicationIntegrationStatus;
+    getExecutedBy(): string | undefined;
+    getResults(): IntegrationResultStatus;
+    private setTotals;
+    private setDetails;
+}

package/dist/IntegrationExecutionResult.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IntegrationExecutionResult = void 0;
+const lodash_1 = require("lodash");
+class IntegrationExecutionResult {
+    constructor(integrationId, organizationReference, executedBy) {
+        this.totals = { added: 0, removed: 0, updated: 0, error: 0 };
+        this.details = {
+            added: [],
+            removed: [],
+            updated: [],
+            error: [],
+        };
+        this.integrationId = integrationId;
+        this.organizationReference = organizationReference;
+        this.executedBy = executedBy;
+    }
+    setResults(changes) {
+        this.setTotals({
+            updated: changes.updated.length,
+            added: changes.created.length,
+            error: changes.errors.length,
+        });
+        this.setDetails({
+            updated: changes.updated,
+            added: changes.created,
+            error: changes.errors,
+        });
+    }
+    setContext(context) {
+        this.context = context;
+    }
+    getContext() {
+        return this.context;
+    }
+    getIntegrationId() {
+        return this.integrationId;
+    }
+    getOrganizationReference() {
+        return this.organizationReference;
+    }
+    setStatus(status) {
+        this.status = status;
+    }
+    getStatus() {
+        return this.status;
+    }
+    getExecutedBy() {
+        return this.executedBy;
+    }
+    getResults() {
+        return {
+            totals: this.totals,
+            details: this.details,
+        };
+    }
+    setTotals(totals) {
+        this.totals = (0, lodash_1.merge)(this.totals, totals);
+    }
+    setDetails(details) {
+        this.details = (0, lodash_1.merge)(this.details, details);
+    }
+}
+exports.IntegrationExecutionResult = IntegrationExecutionResult;
+//# sourceMappingURL=IntegrationExecutionResult.js.map

package/dist/IntegrationExecutionResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntegrationExecutionResult.js","sourceRoot":"","sources":["../src/IntegrationExecutionResult.ts"],"names":[],"mappings":";;;AAAA,mCAA+B;AAgB/B,MAAa,0BAA0B;IAoBrC,YACE,aAAqB,EACrB,qBAA6B,EAC7B,UAAmB;QAtBb,WAAM,GAAiB,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QAEtE,YAAO,GAAkB;YAC/B,KAAK,EAAE,EAAE;YACT,OAAO,EAAE,EAAE;YACX,OAAO,EAAE,EAAE;YACX,KAAK,EAAE,EAAE;SACV,CAAC;QAiBA,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAEM,UAAU,CAAC,OAAsB;QACtC,IAAI,CAAC,SAAS,CAAC;YACb,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM;YAC/B,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM;YAC7B,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM;SAC7B,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC;YACd,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,KAAK,EAAE,OAAO,CAAC,OAAO;YACtB,KAAK,EAAE,OAAO,CAAC,MAAM;SACtB,CAAC,CAAC;IACL,CAAC;IAEM,UAAU,CAAC,OAAgC;QAChD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEM,gBAAgB;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEM,wBAAwB;QAC7B,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACpC,CAAC;IAEM,SAAS,CAAC,MAAsC;QACrD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEM,SAAS;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEM,aAAa;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAEM,UAAU;QACf,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;IACJ,CAAC;IAEO,SAAS,CAAC,MAA6B;QAC7C,IAAI,CAAC,MAAM,GAAG,IAAA,cAAK,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEO,UAAU,CAAC,OAA+B;QAChD,IAAI,CAAC,OAAO,GAAG,IAAA,cAAK,EAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;CACF;AAtFD,gEAsFC"}

package/dist/IntegrationExecutionResult.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/IntegrationExecutionResult.test.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const types_1 = require("./types");
+const IntegrationExecutionResult_1 = require("./IntegrationExecutionResult");
+const MOCK_INTEGRATION_ID = "1";
+const MOCK_ORGANIZATION_REFERENCE = "test";
+const MOCK_EXECUTED_BY = "1";
+describe("IntegrationHistory", () => {
+    describe("setResults", () => {
+        it("should return value with default values", () => {
+            const i = new IntegrationExecutionResult_1.IntegrationExecutionResult(MOCK_INTEGRATION_ID, MOCK_ORGANIZATION_REFERENCE, MOCK_EXECUTED_BY);
+            const pc = {
+                created: ["1"],
+                updated: ["1"],
+                errors: [
+                    {
+                        type: types_1.SyncError.MISSING_FIELDS,
+                        userReference: "1",
+                        metadata: ["missingFieldName"],
+                    },
+                ],
+            };
+            i.setResults(pc);
+            expect(i.getResults()).toStrictEqual({
+                totals: { added: 1, removed: 0, updated: 1, error: 1 },
+                details: {
+                    added: ["1"],
+                    removed: [],
+                    updated: ["1"],
+                    error: [
+                        {
+                            type: types_1.SyncError.MISSING_FIELDS,
+                            userReference: "1",
+                            metadata: ["missingFieldName"],
+                        },
+                    ],
+                },
+            });
+        });
+    });
+    describe("getters", () => {
+        it("should return correct values", () => {
+            const i = new IntegrationExecutionResult_1.IntegrationExecutionResult(MOCK_INTEGRATION_ID, MOCK_ORGANIZATION_REFERENCE, MOCK_EXECUTED_BY);
+            expect(i.getExecutedBy()).toStrictEqual(MOCK_EXECUTED_BY);
+            expect(i.getOrganizationReference()).toStrictEqual(MOCK_ORGANIZATION_REFERENCE);
+            expect(i.getExecutedBy()).toStrictEqual(MOCK_EXECUTED_BY);
+        });
+    });
+});
+//# sourceMappingURL=IntegrationExecutionResult.test.js.map

package/dist/IntegrationExecutionResult.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntegrationExecutionResult.test.js","sourceRoot":"","sources":["../src/IntegrationExecutionResult.test.ts"],"names":[],"mappings":";;AAAA,mCAAoC;AACpC,6EAGsC;AAEtC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAChC,MAAM,2BAA2B,GAAG,MAAM,CAAC;AAC3C,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAE7B,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,CAAC,GAAG,IAAI,uDAA0B,CACtC,mBAAmB,EACnB,2BAA2B,EAC3B,gBAAgB,CACjB,CAAC;YACF,MAAM,EAAE,GAAkB;gBACxB,OAAO,EAAE,CAAC,GAAG,CAAC;gBACd,OAAO,EAAE,CAAC,GAAG,CAAC;gBACd,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,iBAAS,CAAC,cAAc;wBAC9B,aAAa,EAAE,GAAG;wBAClB,QAAQ,EAAE,CAAC,kBAAkB,CAAC;qBAC/B;iBACF;aACF,CAAC;YAEF,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAEjB,MAAM,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC;gBACnC,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;gBACtD,OAAO,EAAE;oBACP,KAAK,EAAE,CAAC,GAAG,CAAC;oBACZ,OAAO,EAAE,EAAE;oBACX,OAAO,EAAE,CAAC,GAAG,CAAC;oBACd,KAAK,EAAE;wBACL;4BACE,IAAI,EAAE,iBAAS,CAAC,cAAc;4BAC9B,aAAa,EAAE,GAAG;4BAClB,QAAQ,EAAE,CAAC,kBAAkB,CAAC;yBAC/B;qBACF;iBACF;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACvB,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACtC,MAAM,CAAC,GAAG,IAAI,uDAA0B,CACtC,mBAAmB,EACnB,2BAA2B,EAC3B,gBAAgB,CACjB,CAAC;YACF,MAAM,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;YAC1D,MAAM,CAAC,CAAC,CAAC,wBAAwB,EAAE,CAAC,CAAC,aAAa,CAChD,2BAA2B,CAC5B,CAAC;YACF,MAAM,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,28 @@
+export declare enum CommunicationIntegrationStatus {
+    SUCCESS = "success",
+    ERROR = "error"
+}
+export declare enum SyncError {
+    MISSING_FIELDS = "missing",
+    VALIDATION = "validation",
+    VALIDATION_SERVER = "validation_server"
+}
+export declare type IntegrationResultError = {
+    type: SyncError;
+    userReference: string;
+    metadata: string[];
+};
+export interface IntegrationResultStatus {
+    totals: {
+        added: number;
+        updated: number;
+        removed: number;
+        error: number;
+    };
+    details: {
+        added: string[];
+        updated: string[];
+        removed: string[];
+        error: IntegrationResultError[];
+    };
+}

package/dist/types.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SyncError = exports.CommunicationIntegrationStatus = void 0;
+var CommunicationIntegrationStatus;
+(function (CommunicationIntegrationStatus) {
+    CommunicationIntegrationStatus["SUCCESS"] = "success";
+    CommunicationIntegrationStatus["ERROR"] = "error";
+})(CommunicationIntegrationStatus = exports.CommunicationIntegrationStatus || (exports.CommunicationIntegrationStatus = {}));
+var SyncError;
+(function (SyncError) {
+    SyncError["MISSING_FIELDS"] = "missing";
+    SyncError["VALIDATION"] = "validation";
+    SyncError["VALIDATION_SERVER"] = "validation_server";
+})(SyncError = exports.SyncError || (exports.SyncError = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAAA,IAAY,8BAGX;AAHD,WAAY,8BAA8B;IACxC,qDAAmB,CAAA;IACnB,iDAAe,CAAA;AACjB,CAAC,EAHW,8BAA8B,GAA9B,sCAA8B,KAA9B,sCAA8B,QAGzC;AAED,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,uCAA0B,CAAA;IAC1B,sCAAyB,CAAA;IACzB,oDAAuC,CAAA;AACzC,CAAC,EAJW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAIpB"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@alanszp/integrations-common",
+  "version": "7.8.3",
+  "description": "Common logic shared between integrations.",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "license": "MIT",
+  "files": [
+    "**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "compile": "rm -rf ./dist && tsc --declaration",
+    "compile-watch": "tsc -w",
+    "build": "yarn run compile",
+    "prepack": "yarn run build",
+    "yalc-publish": "yarn run yalc publish"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.2.3",
+    "@types/node": "^15.12.3",
+    "jest": "^29.3.1",
+    "ts-node": "^10.0.0",
+    "tslint": "^6.1.3",
+    "typescript": "^4.3.4"
+  },
+  "dependencies": {
+    "@alanszp/errors": "^7.0.0",
+    "lodash": "^4.17.21"
+  },
+  "gitHead": "8e8ec3adbd5590caec41913371e3eea8aa745024"
+}

package/src/IntegrationExecutionResult.test.ts

@@ -0,0 +1,64 @@
+import { SyncError } from "./types";
+import {
+  ChangesStatus,
+  IntegrationExecutionResult,
+} from "./IntegrationExecutionResult";
+
+const MOCK_INTEGRATION_ID = "1";
+const MOCK_ORGANIZATION_REFERENCE = "test";
+const MOCK_EXECUTED_BY = "1";
+
+describe("IntegrationHistory", () => {
+  describe("setResults", () => {
+    it("should return value with default values", () => {
+      const i = new IntegrationExecutionResult(
+        MOCK_INTEGRATION_ID,
+        MOCK_ORGANIZATION_REFERENCE,
+        MOCK_EXECUTED_BY
+      );
+      const pc: ChangesStatus = {
+        created: ["1"],
+        updated: ["1"],
+        errors: [
+          {
+            type: SyncError.MISSING_FIELDS,
+            userReference: "1",
+            metadata: ["missingFieldName"],
+          },
+        ],
+      };
+
+      i.setResults(pc);
+
+      expect(i.getResults()).toStrictEqual({
+        totals: { added: 1, removed: 0, updated: 1, error: 1 },
+        details: {
+          added: ["1"],
+          removed: [],
+          updated: ["1"],
+          error: [
+            {
+              type: SyncError.MISSING_FIELDS,
+              userReference: "1",
+              metadata: ["missingFieldName"],
+            },
+          ],
+        },
+      });
+    });
+  });
+  describe("getters", () => {
+    it("should return correct values", () => {
+      const i = new IntegrationExecutionResult(
+        MOCK_INTEGRATION_ID,
+        MOCK_ORGANIZATION_REFERENCE,
+        MOCK_EXECUTED_BY
+      );
+      expect(i.getExecutedBy()).toStrictEqual(MOCK_EXECUTED_BY);
+      expect(i.getOrganizationReference()).toStrictEqual(
+        MOCK_ORGANIZATION_REFERENCE
+      );
+      expect(i.getExecutedBy()).toStrictEqual(MOCK_EXECUTED_BY);
+    });
+  });
+});

package/src/IntegrationExecutionResult.ts

@@ -0,0 +1,103 @@
+import { merge } from "lodash";
+import {
+  IntegrationResultStatus,
+  CommunicationIntegrationStatus,
+  IntegrationResultError,
+} from "./types";
+
+type ResultDetails = IntegrationResultStatus["details"];
+type ResultTotals = IntegrationResultStatus["totals"];
+
+export interface ChangesStatus {
+  updated: string[];
+  created: string[];
+  errors: IntegrationResultError[];
+}
+
+export class IntegrationExecutionResult {
+  private totals: ResultTotals = { added: 0, removed: 0, updated: 0, error: 0 };
+
+  private details: ResultDetails = {
+    added: [],
+    removed: [],
+    updated: [],
+    error: [],
+  };
+
+  private integrationId: string;
+
+  private organizationReference: string;
+
+  private status: CommunicationIntegrationStatus;
+
+  private executedBy: string | undefined;
+
+  private context?: Record<string, unknown>;
+
+  constructor(
+    integrationId: string,
+    organizationReference: string,
+    executedBy?: string
+  ) {
+    this.integrationId = integrationId;
+    this.organizationReference = organizationReference;
+    this.executedBy = executedBy;
+  }
+
+  public setResults(changes: ChangesStatus): void {
+    this.setTotals({
+      updated: changes.updated.length,
+      added: changes.created.length,
+      error: changes.errors.length,
+    });
+
+    this.setDetails({
+      updated: changes.updated,
+      added: changes.created,
+      error: changes.errors,
+    });
+  }
+
+  public setContext(context: Record<string, unknown>): void {
+    this.context = context;
+  }
+
+  public getContext(): Record<string, unknown> | undefined {
+    return this.context;
+  }
+
+  public getIntegrationId(): string {
+    return this.integrationId;
+  }
+
+  public getOrganizationReference(): string {
+    return this.organizationReference;
+  }
+
+  public setStatus(status: CommunicationIntegrationStatus): void {
+    this.status = status;
+  }
+
+  public getStatus(): CommunicationIntegrationStatus {
+    return this.status;
+  }
+
+  public getExecutedBy(): string | undefined {
+    return this.executedBy;
+  }
+
+  public getResults(): IntegrationResultStatus {
+    return {
+      totals: this.totals,
+      details: this.details,
+    };
+  }
+
+  private setTotals(totals: Partial<ResultTotals>): void {
+    this.totals = merge(this.totals, totals);
+  }
+
+  private setDetails(details: Partial<ResultDetails>): void {
+    this.details = merge(this.details, details);
+  }
+}

package/src/types.ts

@@ -0,0 +1,31 @@
+export enum CommunicationIntegrationStatus {
+  SUCCESS = "success",
+  ERROR = "error",
+}
+
+export enum SyncError {
+  MISSING_FIELDS = "missing",
+  VALIDATION = "validation",
+  VALIDATION_SERVER = "validation_server",
+}
+
+export type IntegrationResultError = {
+  type: SyncError;
+  userReference: string;
+  metadata: string[];
+};
+
+export interface IntegrationResultStatus {
+  totals: {
+    added: number;
+    updated: number;
+    removed: number;
+    error: number;
+  };
+  details: {
+    added: string[];
+    updated: string[];
+    removed: string[];
+    error: IntegrationResultError[];
+  };
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist",
+    "module": "commonjs",
+    "target": "es6",
+    "types": ["node", "jest"],
+    "esModuleInterop": true,
+    "sourceMap": true,
+    "experimentalDecorators": true,
+
+    "alwaysStrict": true,
+    "strictNullChecks": true
+  },
+  "exclude": ["node_modules"]
+}