feat(util): sha1 hash

paulrobertlloyd · paulrobertlloyd · commit e146fe2e5d65 · 2024-11-17T11:39:40.000Z
diff --git a/packages/util/index.js b/packages/util/index.js
@@ -10,6 +10,6 @@ export {
 } from "./lib/date.js";
 export { sanitise } from "./lib/object.js";
 export { ISO_6709_RE } from "./lib/regex.js";
-export { md5, randomString, slugify, supplant } from "./lib/string.js";
+export { md5, randomString, sha1, slugify, supplant } from "./lib/string.js";
 export { getCanonicalUrl, isSameOrigin } from "./lib/url.js";
 export { isRequired } from "./lib/validation-schema.js";
diff --git a/packages/util/lib/string.js b/packages/util/lib/string.js
@@ -8,6 +8,13 @@ import slugifyString from "@sindresorhus/slugify";
  */
 export const md5 = (string) => createHash("md5").update(string).digest("hex");
 
+/**
+ * Generate SHA1 hashed string
+ * @param {string} string - String
+ * @returns {string} SHA1 hashed string
+ */
+export const sha1 = (string) => createHash("sha1").update(string).digest("hex");
+
 /**
  * Generate cryptographically random string
  * @param {number} [length] - Length of string
diff --git a/packages/util/test/unit/string.js b/packages/util/test/unit/string.js
@@ -1,7 +1,13 @@
 import { strict as assert } from "node:assert";
 import { Buffer } from "node:buffer";
 import { describe, it } from "node:test";
-import { md5, randomString, slugify, supplant } from "../../lib/string.js";
+import {
+  md5,
+  randomString,
+  sha1,
+  slugify,
+  supplant,
+} from "../../lib/string.js";
 
 describe("util/lib/string", () => {
   it("Generates MD5 hashed string", () => {
@@ -10,6 +16,12 @@ describe("util/lib/string", () => {
     assert.equal(result, "acbd18db4cc2f85cedef654fccc4a4d8");
   });
 
+  it("Generates SHA1 hashed string", () => {
+    const result = sha1("foo");
+
+    assert.equal(result, "0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33");
+  });
+
   it("Generates cryptographically random string", () => {
     const result = randomString(8);
 
