@alanszp/integrations-common 7.9.1 → 8.0.0

package/babel.config.js

@@ -0,0 +1,7 @@
+// Used by Jest
+module.exports = {
+  presets: [
+    ["@babel/preset-env", { targets: { node: "current" } }],
+    "@babel/preset-typescript",
+  ],
+};

package/dist/IntegrationExecutionResult.d.ts

@@ -2,6 +2,7 @@ import { IntegrationResultStatus, IntegrationStatus, IntegrationResultError } fr
 export interface ChangesStatus {
     updated: string[];
     created: string[];
+    removed: string[];
     errors: IntegrationResultError[];
 }
 export declare class IntegrationExecutionResult {

package/dist/IntegrationExecutionResult.js

@@ -20,11 +20,13 @@ class IntegrationExecutionResult {
             updated: changes.updated.length,
             added: changes.created.length,
             error: changes.errors.length,
+            removed: changes.removed.length,
         });
         this.setDetails({
             updated: changes.updated,
             added: changes.created,
             error: changes.errors,
+            removed: changes.removed,
         });
     }
     setContext(context) {

package/dist/IntegrationExecutionResult.js.map

@@ -1 +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,MAAyB;QACxC,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"}
+{"version":3,"file":"IntegrationExecutionResult.js","sourceRoot":"","sources":["../src/IntegrationExecutionResult.ts"],"names":[],"mappings":";;;AAAA,mCAA+B;AAiB/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;YAC5B,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM;SAChC,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;YACrB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,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,MAAyB;QACxC,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;AAxFD,gEAwFC"}

package/dist/helpers/generateChecksum.d.ts

@@ -0,0 +1 @@
+export declare function generateChecksum<T extends Record<string, unknown>>(employee: T, fieldsToIgnore?: Set<keyof T>): string;

package/dist/helpers/generateChecksum.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateChecksum = void 0;
+const crypto_1 = require("crypto");
+const lodash_1 = require("lodash");
+function generateChecksum(employee, fieldsToIgnore) {
+    const hash = (0, crypto_1.createHash)("sha1");
+    const filterFields = fieldsToIgnore || new Set();
+    const employeeString = (0, lodash_1.chain)((0, lodash_1.keys)(employee))
+        .sort()
+        .filter((key) => !filterFields.has(key))
+        .map((key) => {
+        const value = employee[key];
+        if ((0, lodash_1.isObject)(value) || (0, lodash_1.isArray)(value)) {
+            return JSON.stringify(value);
+        }
+        if ((0, lodash_1.isBoolean)(value)) {
+            return value ? "1" : "0";
+        }
+        if ((0, lodash_1.isNil)(value)) {
+            return "";
+        }
+        return value;
+    })
+        .value()
+        .join("|");
+    return hash.update(employeeString).digest("base64").slice(0, 8);
+}
+exports.generateChecksum = generateChecksum;
+//# sourceMappingURL=generateChecksum.js.map

package/dist/helpers/generateChecksum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateChecksum.js","sourceRoot":"","sources":["../../src/helpers/generateChecksum.ts"],"names":[],"mappings":";;;AAAA,mCAAoC;AACpC,mCAA0E;AAE1E,SAAgB,gBAAgB,CAC9B,QAAW,EACX,cAA6B;IAE7B,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,MAAM,CAAC,CAAC;IAChC,MAAM,YAAY,GAAG,cAAc,IAAI,IAAI,GAAG,EAAW,CAAC;IAC1D,MAAM,cAAc,GAAG,IAAA,cAAK,EAAC,IAAA,aAAI,EAAC,QAAQ,CAAgB,CAAC;SACxD,IAAI,EAAE;SACN,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACvC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,IAAA,iBAAQ,EAAC,KAAK,CAAC,IAAI,IAAA,gBAAO,EAAC,KAAK,CAAC,EAAE;YACrC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;SAC9B;QAED,IAAI,IAAA,kBAAS,EAAC,KAAK,CAAC,EAAE;YACpB,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;SAC1B;QAED,IAAI,IAAA,cAAK,EAAC,KAAK,CAAC,EAAE;YAChB,OAAO,EAAE,CAAC;SACX;QAED,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;SACD,KAAK,EAAE;SACP,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAClE,CAAC;AA5BD,4CA4BC"}

package/dist/helpers/generateChecksum.test.d.ts

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

package/dist/helpers/generateChecksum.test.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+const generateChecksum_1 = require("./generateChecksum");
+const OBJECT_ONE = {
+    id: "1",
+    email: "test@checksum.com",
+    checksum: "12345678",
+    number: 1,
+};
+const OBJECT_TWO = {
+    id: "2",
+    email: "test2@checksum.com",
+    checksum: "487654987",
+    number: 2,
+};
+describe("generateChecksum", () => {
+    it("should generate the same checksum for the same object", () => {
+        const checksumOne = (0, generateChecksum_1.generateChecksum)(OBJECT_ONE);
+        const checksumTwo = (0, generateChecksum_1.generateChecksum)(OBJECT_ONE);
+        expect(checksumOne).toEqual(checksumTwo);
+    });
+    it("should generate a different checksum for different objects", () => {
+        const checksumOne = (0, generateChecksum_1.generateChecksum)(OBJECT_ONE);
+        const checksumTwo = (0, generateChecksum_1.generateChecksum)(OBJECT_TWO);
+        expect(checksumOne).not.toEqual(checksumTwo);
+    });
+    it("should ignore some fields and produce the same checksum if its the only difference", () => {
+        const OBJECT_THREE = (0, lodash_1.clone)(OBJECT_ONE);
+        OBJECT_THREE.checksum = "NOT_THE_SAME";
+        const ignoreFields = new Set(["checksum"]);
+        const checksumOne = (0, generateChecksum_1.generateChecksum)(OBJECT_ONE, ignoreFields);
+        const checksumTwo = (0, generateChecksum_1.generateChecksum)(OBJECT_THREE, ignoreFields);
+        expect(checksumOne).toEqual(checksumTwo);
+    });
+});
+//# sourceMappingURL=generateChecksum.test.js.map

package/dist/helpers/generateChecksum.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateChecksum.test.js","sourceRoot":"","sources":["../../src/helpers/generateChecksum.test.ts"],"names":[],"mappings":";;AAAA,mCAA+B;AAC/B,yDAAsD;AAEtD,MAAM,UAAU,GAAG;IACjB,EAAE,EAAE,GAAG;IACP,KAAK,EAAE,mBAAmB;IAC1B,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,CAAC;CACV,CAAC;AAEF,MAAM,UAAU,GAAG;IACjB,EAAE,EAAE,GAAG;IACP,KAAK,EAAE,oBAAoB;IAC3B,QAAQ,EAAE,WAAW;IACrB,MAAM,EAAE,CAAC;CACV,CAAC;AAEF,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC/D,MAAM,WAAW,GAAG,IAAA,mCAAgB,EAAC,UAAU,CAAC,CAAC;QACjD,MAAM,WAAW,GAAG,IAAA,mCAAgB,EAAC,UAAU,CAAC,CAAC;QACjD,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,WAAW,GAAG,IAAA,mCAAgB,EAAC,UAAU,CAAC,CAAC;QACjD,MAAM,WAAW,GAAG,IAAA,mCAAgB,EAAC,UAAU,CAAC,CAAC;QACjD,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oFAAoF,EAAE,GAAG,EAAE;QAC5F,MAAM,YAAY,GAAG,IAAA,cAAK,EAAC,UAAU,CAAC,CAAC;QACvC,YAAY,CAAC,QAAQ,GAAG,cAAc,CAAC;QAEvC,MAAM,YAAY,GAAG,IAAI,GAAG,CAA0B,CAAC,UAAU,CAAC,CAAC,CAAC;QAEpE,MAAM,WAAW,GAAG,IAAA,mCAAgB,EAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAC/D,MAAM,WAAW,GAAG,IAAA,mCAAgB,EAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QACjE,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -2,3 +2,4 @@ export * from "./IntegrationExecutionResult";
 export * from "./models/BaseIntegrationHistory";
 export * from "./views/integrationView";
 export * from "./types";
+export * from "./helpers/generateChecksum";

package/dist/index.js

@@ -14,4 +14,5 @@ __exportStar(require("./IntegrationExecutionResult"), exports);
 __exportStar(require("./models/BaseIntegrationHistory"), exports);
 __exportStar(require("./views/integrationView"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./helpers/generateChecksum"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+DAA6C;AAC7C,kEAAgD;AAChD,0DAAwC;AACxC,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+DAA6C;AAC7C,kEAAgD;AAChD,0DAAwC;AACxC,0CAAwB;AACxB,6DAA2C"}

package/jest.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+  collectCoverageFrom: ["src/**/*.{js,jsx,ts,tsx}"],
+  roots: ["<rootDir>/src/"],
+  clearMocks: true,
+  resetMocks: true,
+  testEnvironment: "node",
+  moduleNameMapper: {
+    "@/(.*)": "<rootDir>/src/$1",
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alanszp/integrations-common",
-  "version": "7.9.1",
+  "version": "8.0.0",
   "description": "Common logic shared between integrations.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -15,24 +15,27 @@
     "compile": "rm -rf ./dist && tsc --declaration",
     "compile-watch": "tsc -w",
     "build": "yarn run compile",
+    "test": "jest",
     "prepack": "yarn run build",
     "yalc-publish": "yarn run yalc publish"
   },
   "devDependencies": {
     "@types/jest": "^29.2.3",
     "@types/node": "^15.12.3",
+    "babel-jest": "^29.0.0",
+    "eslint-plugin-jest": "^26.8.7",
     "jest": "^29.3.1",
     "ts-node": "^10.0.0",
     "tslint": "^6.1.3",
     "typescript": "^4.3.4"
   },
   "dependencies": {
-    "@alanszp/errors": "^7.0.0",
-    "@alanszp/logger": "^7.0.0",
-    "@alanszp/typeorm": "^7.0.0",
+    "@alanszp/errors": "^8.0.0",
+    "@alanszp/logger": "^8.0.0",
+    "@alanszp/typeorm": "^8.0.0",
     "class-validator": "^0.13.1",
     "lodash": "^4.17.21",
     "typeorm": "^0.2.34"
   },
-  "gitHead": "4493dd790ffb7cc775401fe64aaac8165bdf03bc"
+  "gitHead": "8ddbd6ae78e2404fb35497e18308644d3760dd17"
 }

package/src/IntegrationExecutionResult.ts

@@ -11,6 +11,7 @@ type ResultTotals = IntegrationResultStatus["totals"];
 export interface ChangesStatus {
   updated: string[];
   created: string[];
+  removed: string[];
   errors: IntegrationResultError[];
 }
 
@@ -49,12 +50,14 @@ export class IntegrationExecutionResult {
       updated: changes.updated.length,
       added: changes.created.length,
       error: changes.errors.length,
+      removed: changes.removed.length,
     });
 
     this.setDetails({
       updated: changes.updated,
       added: changes.created,
       error: changes.errors,
+      removed: changes.removed,
     });
   }
 

package/src/helpers/generateChecksum.test.ts

@@ -0,0 +1,41 @@
+import { clone } from "lodash";
+import { generateChecksum } from "./generateChecksum";
+
+const OBJECT_ONE = {
+  id: "1",
+  email: "test@checksum.com",
+  checksum: "12345678",
+  number: 1,
+};
+
+const OBJECT_TWO = {
+  id: "2",
+  email: "test2@checksum.com",
+  checksum: "487654987",
+  number: 2,
+};
+
+describe("generateChecksum", () => {
+  it("should generate the same checksum for the same object", () => {
+    const checksumOne = generateChecksum(OBJECT_ONE);
+    const checksumTwo = generateChecksum(OBJECT_ONE);
+    expect(checksumOne).toEqual(checksumTwo);
+  });
+
+  it("should generate a different checksum for different objects", () => {
+    const checksumOne = generateChecksum(OBJECT_ONE);
+    const checksumTwo = generateChecksum(OBJECT_TWO);
+    expect(checksumOne).not.toEqual(checksumTwo);
+  });
+
+  it("should ignore some fields and produce the same checksum if its the only difference", () => {
+    const OBJECT_THREE = clone(OBJECT_ONE);
+    OBJECT_THREE.checksum = "NOT_THE_SAME";
+
+    const ignoreFields = new Set<keyof typeof OBJECT_ONE>(["checksum"]);
+
+    const checksumOne = generateChecksum(OBJECT_ONE, ignoreFields);
+    const checksumTwo = generateChecksum(OBJECT_THREE, ignoreFields);
+    expect(checksumOne).toEqual(checksumTwo);
+  });
+});

package/src/helpers/generateChecksum.ts

@@ -0,0 +1,32 @@
+import { createHash } from "crypto";
+import { chain, isArray, isBoolean, isNil, isObject, keys } from "lodash";
+
+export function generateChecksum<T extends Record<string, unknown>>(
+  employee: T,
+  fieldsToIgnore?: Set<keyof T>
+): string {
+  const hash = createHash("sha1");
+  const filterFields = fieldsToIgnore || new Set<keyof T>();
+  const employeeString = chain(keys(employee) as (keyof T)[])
+    .sort()
+    .filter((key) => !filterFields.has(key))
+    .map((key) => {
+      const value = employee[key];
+      if (isObject(value) || isArray(value)) {
+        return JSON.stringify(value);
+      }
+
+      if (isBoolean(value)) {
+        return value ? "1" : "0";
+      }
+
+      if (isNil(value)) {
+        return "";
+      }
+
+      return value;
+    })
+    .value()
+    .join("|");
+  return hash.update(employeeString).digest("base64").slice(0, 8);
+}

package/src/index.ts

@@ -2,3 +2,4 @@ export * from "./IntegrationExecutionResult";
 export * from "./models/BaseIntegrationHistory";
 export * from "./views/integrationView";
 export * from "./types";
+export * from "./helpers/generateChecksum";