chore: add stringify fn

src/utils.spec.ts

@@ -0,0 +1,29 @@
+import { describe, it, expect } from 'vitest'
+import { stringifyFlatObject } from './utils'
+
+describe('utils', () => {
+  describe('stringifyFlatObject', () => {
+    it('stringifies an object no matter the order of keys', () => {
+      expect(stringifyFlatObject({ a: 1, b: 2 })).toBe('{"a":1,"b":2}')
+      expect(stringifyFlatObject({ b: 2, a: 1 })).toBe('{"a":1,"b":2}')
+    })
+
+    it('works with all primitives', () => {
+      expect(stringifyFlatObject({ a: 1, b: 2 })).toBe('{"a":1,"b":2}')
+      expect(stringifyFlatObject({ a: '1', b: '2' })).toBe('{"a":"1","b":"2"}')
+      expect(stringifyFlatObject({ a: true, b: false })).toBe(
+        '{"a":true,"b":false}'
+      )
+      expect(stringifyFlatObject({ a: null })).toBe('{"a":null}')
+    })
+
+    it('works with arrays', () => {
+      expect(stringifyFlatObject({ a: [1, 2], b: [3, 4] })).toBe(
+        '{"a":[1,2],"b":[3,4]}'
+      )
+      expect(stringifyFlatObject({ b: [1, 2], a: [3, 4] })).toBe(
+        '{"a":[3,4],"b":[1,2]}'
+      )
+    })
+  })
+})

src/utils.ts

@@ -43,3 +43,19 @@ export type _MaybeArray<T> = T | T[]
  */
 export const toArray = <T>(value: _MaybeArray<T>): T[] =>
   Array.isArray(value) ? value : [value]
+
+type _JSONPrimitive = string | number | boolean | null
+
+export interface _Object {
+  [key: string]: _JSONPrimitive | Array<_JSONPrimitive>
+}
+
+/**
+ * Stringifies an object no matter the order of keys. This is used to create a hash for a given object. It only works
+ * with flat objects. It can contain arrays of primitives only.
+ *
+ * @param obj - object to stringify
+ */
+export function stringifyFlatObject(obj: _Object): string {
+  return JSON.stringify(obj, Object.keys(obj).sort())
+}