Add: New package JSON hash added

.gitignore

@@ -41,6 +41,8 @@ yarn-error.log*
 
 .vscode
 
+.eslintcache
+
 packages/automatic-versioning/tmp
 
 p*/**/dist/
@@ -51,4 +53,8 @@ p*/**/jest.config.js
 p*/**/LICENSE
 
 p*/**/node_modules/
-p*/**/logs/.turbo
+p*/**/logs/.turbo
+
+#non-pnpm lock files
+yarn.lock
+package-lock.json

.prettierrc

@@ -1,4 +1,6 @@
 {
     "printWidth": 120,
-    "trailingComma": "none"
+    "trailingComma": "none",
+    "semi": true,
+    "quoteProps": "consistent"
 }

lefthook.yaml

@@ -0,0 +1,14 @@
+pre-commit:
+  parallel: true
+  commands:
+    format:
+      glob: "*.{css,html,json,less,md,scss,yaml,yml,js,jsx,ts,tsx}"
+      run: npx prettier --write --cache {staged_files} && git add {staged_files}
+    lint:
+      glob: "*.{js,jsx,ts,tsx}"
+      run: npm run lint && git add {staged_files}
+
+commit-msg:
+  commands:
+    commitlint:
+      run: npx commitlint --edit --color

package.json

@@ -12,7 +12,7 @@
     "dev": "turbo run dev",
     "lint": "turbo run lint",
     "format": "prettier --write \"**/*.{js,ts,tsx,md}\" --cache",
-    "prepare": "husky install",
+    "prepare": "lefthook install",
     "release": "turbo run release",
     "submodules:load": "git submodule update --init",
     "submodules:sync": "git submodule update --recursive --remote",
@@ -31,17 +31,17 @@
     "turbo": "1.7.3"
   },
   "devDependencies": {
-    "@commitlint/cli": "17.4.2",
-    "@commitlint/config-conventional": "17.4.2",
+    "@commitlint/cli": "19.2.1",
+    "@commitlint/config-conventional": "19.1.0",
     "@sliit-foss/eslint-config-internal": "workspace:*",
     "eslint": "8.33.0",
     "eslint-config-turbo": "0.0.7",
-    "husky": "8.0.3",
+    "lefthook": "1.6.10",
     "nodemon": "2.0.21",
-    "prettier": "2.8.3"
+    "prettier": "3.2.5"
   },
   "engines": {
-    "node": ">=14.0.0"
-  },
-  "packageManager": "[email protected]"
+    "node": ">=14.0.0",
+    "pnpm": ">=7.5.0"
+  }
 }

packages/actions-exec-wrapper/package.json

@@ -1,32 +1,33 @@
-{
-  "name": "@sliit-foss/actions-exec-wrapper",
-  "version": "1.1.1",
-  "description": "A wrapper around the @actions/exec module which promisifies the console output of a command",
-  "main": "dist/index.js",
-  "scripts": {
-    "build": "node ../../scripts/esbuild.config.js",
-    "build:watch": "bash ../../scripts/esbuild.watch.sh",
-    "bump-version": "bash ../../scripts/bump-version.sh --name=@sliit-foss/actions-exec-wrapper",
-    "lint": "bash ../../scripts/lint.sh",
-    "release": "bash ../../scripts/release.sh",
-    "test": "bash ../../scripts/test/test.sh"
-  },
-  "dependencies": {
-    "@actions/exec": "1.1.1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/sliit-foss/npm-catalogue.git"
-  },
-  "keywords": [
-    "@actions/exec",
-    "actions-exec-wrapper",
-    "console-output"
-  ],
-  "author": "SLIIT FOSS",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/sliit-foss/npm-catalogue/issues"
-  },
-  "homepage": "https://github.com/sliit-foss/npm-catalogue/blob/main/packages/actions-exec-wrapper/readme.md"
-}
+{
+  "name": "@sliit-foss/actions-exec-wrapper",
+  "version": "1.1.2",
+  "description": "A wrapper around the @actions/exec module which promisifies the console output of a command",
+  "main": "dist/index.js",
+  "types": "types/index.d.ts",
+  "scripts": {
+    "build": "node ../../scripts/esbuild.config.js",
+    "build:watch": "bash ../../scripts/esbuild.watch.sh",
+    "bump-version": "bash ../../scripts/bump-version.sh --name=@sliit-foss/actions-exec-wrapper",
+    "lint": "bash ../../scripts/lint.sh",
+    "release": "bash ../../scripts/release.sh",
+    "test": "bash ../../scripts/test/test.sh"
+  },
+  "dependencies": {
+    "@actions/exec": "1.1.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sliit-foss/npm-catalogue.git"
+  },
+  "keywords": [
+    "@actions/exec",
+    "actions-exec-wrapper",
+    "console-output"
+  ],
+  "author": "SLIIT FOSS",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/sliit-foss/npm-catalogue/issues"
+  },
+  "homepage": "https://github.com/sliit-foss/npm-catalogue/blob/main/packages/actions-exec-wrapper/readme.md"
+}

packages/actions-exec-wrapper/types/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @description Runs a given CLI command and return's it's standard output(stdout)
+ * @param command The command to be run
+ * @returns Command output wrapped around a promise
+ * @example
+ * exec("npm --version")
+ * .then((result) => {
+ *   console.log(result);
+ * })
+ * .catch((error) => {
+ *   console.log(error);
+ * });
+ */
+export default function execute(command: string): Promise<string>;

packages/http-logger/readme.md

@@ -18,7 +18,7 @@ yarn add @sliit-foss/http-logger
 
 ```js
 # using require
-const httpLogger = require("@sliit-foss/http-logger");
+const httpLogger = require("@sliit-foss/http-logger").default;
 
 # using import
 import httpLogger from "@sliit-foss/http-logger";

packages/json-hash/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "json-hash",
+  "version": "1.0.0",
+  "description": "Hash JS objects reliablly on both Node.js and browser",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "node ../../scripts/esbuild.config.js",
+    "build:watch": "bash ../../scripts/esbuild.watch.sh",
+    "bump-version": "bash ../../scripts/bump-version.sh --name=@sliit-foss/json-hash",
+    "lint": "bash ../../scripts/lint.sh",
+    "release": "bash ../../scripts/release.sh",
+    "test": "bash ../../scripts/test/test.sh"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sliit-foss/npm-catalogue.git"
+  },
+  "dependencies": {
+    "json-stable-stringify": "1.1.1"
+  },
+  "keywords": [
+    "json",
+    "hash",
+    "hashing",
+    "object-hash"
+  ],
+  "author": "SLIIT FOSS",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/sliit-foss/npm-catalogue/issues"
+  }
+}

packages/json-hash/src/index.js

@@ -0,0 +1,46 @@
+export const getNodeJSAlgoName = (algorithm) => {
+  const algos = {
+    "SHA-1": "sha1",
+    "SHA-256": "sha256",
+    "SHA-384": "sha384",
+    "SHA-512": "sha512"
+  };
+
+  return algos[algorithm];
+};
+
+export const computeHash = async (obj, { algorithm = "SHA-1", sort = false }) => {
+  const nodeJSAlgoName = getNodeJSAlgoName(algorithm);
+
+  if (nodeJSAlgoName === undefined) {
+    throw new Error("Provided algorithm is not available");
+  }
+
+  if (typeof obj !== "string") {
+    if (sort) {
+      const { default: stringify } = await import("json-stable-stringify");
+      obj = stringify(obj);
+    } else {
+      obj = JSON.stringify(obj);
+    }
+  }
+
+  // For browser
+  // eslint-disable-next-line no-undef
+  if (typeof window !== "undefined" && window.crypto && window.crypto.subtle) {
+    const msgUint8 = new TextEncoder().encode(obj); // encode as (utf-8) Uint8Array
+
+    // eslint-disable-next-line no-undef
+    const hashBuffer = await window.crypto.subtle.digest(algorithm, msgUint8); // hash data
+    const hashArray = Array.from(new Uint8Array(hashBuffer)); // convert buffer to byte array
+    const hashHex = hashArray.map((b) => b.toString(16).padStart(2, "0")).join(""); // convert bytes to hex string
+    return hashHex;
+  }
+
+  // For Node.js
+  if (typeof global !== "undefined" && global.crypto) {
+    const { createHash } = await import("crypto");
+    const hash = createHash(nodeJSAlgoName).update(obj).digest("hex");
+    return hash;
+  }
+};

packages/json-hash/test/index.test.js

@@ -0,0 +1,96 @@
+import { computeHash, getNodeJSAlgoName } from "../src";
+
+describe("json-hash-node-js", () => {
+  beforeAll(() => {
+    console.log("Running tests for json-hash on Node.js");
+  });
+
+  afterAll(() => {
+    console.log("Ending tests for json-hash on Node.js");
+  });
+
+  const objectToHash = { name: "Siri", age: 30, country: "Sri Lanka" };
+
+  //tests for getNodeJSAlgoName
+  it("should-get-node-js-algo-name", () => {
+    expect(getNodeJSAlgoName("SHA-1")).toBe("sha1");
+    expect(getNodeJSAlgoName("SHA-256")).toBe("sha256");
+    expect(getNodeJSAlgoName("SHA-384")).toBe("sha384");
+    expect(getNodeJSAlgoName("SHA-512")).toBe("sha512");
+  });
+
+  it("should-not-throw-error-for-invalid-algo-name", () => {
+    expect(getNodeJSAlgoName("NIKE")).toBe(undefined);
+    expect(getNodeJSAlgoName("")).toBe(undefined);
+  });
+
+  // tests for computeHash begins
+
+  it("should-throw-error-for-invalid-algo-name", async () => {
+    expect.assertions(1);
+
+    try {
+      await computeHash(objectToHash, { algorithm: "Sock" });
+    } catch (error) {
+      expect(error).toMatchObject(new Error("Provided algorithm is not available"));
+    }
+  });
+
+  // without sorting
+  it("should-compute-hash-with-SHA-1", async () => {
+    expect.assertions(1);
+    const hash = await computeHash(objectToHash, { algorithm: "SHA-1" });
+    expect(hash).toBe("9edcbfaaba0af491b8f73961416a250655bf483c");
+  });
+
+  it("should-compute-hash-with-SHA-256", async () => {
+    expect.assertions(1);
+    const hash = await computeHash(objectToHash, { algorithm: "SHA-256" });
+    expect(hash).toBe("f17f5b4a7b8d4f7258cfedff4b78982f6d472d856d1fc1a9da3562d633ffff72");
+  });
+
+  it("should-compute-hash-with-SHA-384", async () => {
+    expect.assertions(1);
+    const hash = await computeHash(objectToHash, { algorithm: "SHA-384" });
+    expect(hash).toBe(
+      "8096ba11adb69941ad3ff5cbfc8c4b00d9b8d092de640e8abf8b54e1fcb7ddfdeaa3f5df0f03af50ca2648e76ed704b5"
+    );
+  });
+
+  it("should-compute-hash-with-SHA-512", async () => {
+    expect.assertions(1);
+    const hash = await computeHash(objectToHash, { algorithm: "SHA-512" });
+    expect(hash).toBe(
+      "e6dc6e4edb2de44db04a6611ce3bb7127d9c5e93d8cc8c2092fca748db04d676ebf12dd06f6819eb6b7b20f957025e2da490918511adf34775e869e17619180e"
+    );
+  });
+
+  // with sorting
+  it("should-sort-and-compute-hash-with-SHA-1", async () => {
+    expect.assertions(1);
+    const hash = await computeHash(objectToHash, { algorithm: "SHA-1", sort: true });
+    expect(hash).toBe("10e3e5df394451377f778d7402b62b5134dca39a");
+  });
+
+  it("should-sort-and-compute-hash-with-SHA-256", async () => {
+    expect.assertions(1);
+    const hash = await computeHash(objectToHash, { algorithm: "SHA-256", sort: true });
+    expect(hash).toBe("37d0042f1f11c95c8563b530cc8769d4229ef48b5a31f763e2f841783216d6f2");
+  });
+
+  it("should-sort-and-compute-hash-with-SHA-384", async () => {
+    expect.assertions(1);
+    const hash = await computeHash(objectToHash, { algorithm: "SHA-384", sort: true });
+    expect(hash).toBe(
+      "f43ccfc81ea4e92fc11bed100e7cd82a665ad359faf91ff666e51a947cba8a7c5e3931ed6e7cebaef1a66b4b3c0c5d41"
+    );
+  });
+
+  it("should-sort-and-compute-hash-with-SHA-512", async () => {
+    expect.assertions(1);
+    const hash = await computeHash(objectToHash, { algorithm: "SHA-512", sort: true });
+    expect(hash).toBe(
+      "f6a03a2a8cf61713c4c2fc3bae86736f6f8322d5271d1c2b3046268871f3d6ca434b1414b910990c9ba2f13cbe629f54646b7430880f1e60a4a899c94f45b6b1"
+    );
+  });
+});