feat(util): md5

paulrobertlloyd · paulrobertlloyd · commit b09a8c444b92 · 2024-10-08T20:54:46.000+01:00
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 { randomString, slugify, supplant } from "./lib/string.js";
+export { md5, randomString, 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
@@ -1,6 +1,13 @@
-import { randomBytes } from "node:crypto";
+import { randomBytes, createHash } from "node:crypto";
 import slugifyString from "@sindresorhus/slugify";
 
+/**
+ * Generate MD5 hashed string
+ * @param {string} string - String
+ * @returns {string} MD5 hashed string
+ */
+export const md5 = (string) => createHash("md5").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,9 +1,15 @@
 import { strict as assert } from "node:assert";
 import { Buffer } from "node:buffer";
 import { describe, it } from "node:test";
-import { randomString, slugify, supplant } from "../../lib/string.js";
+import { md5, randomString, slugify, supplant } from "../../lib/string.js";
 
 describe("util/lib/string", () => {
+  it("Generates MD5 hashed string", () => {
+    const result = md5("foo");
+
+    assert.equal(result, "acbd18db4cc2f85cedef654fccc4a4d8");
+  });
+
   it("Generates cryptographically random string", () => {
     const result = randomString(8);
 
