@xyo-network/hash 2.82.0-rc.1 → 2.83.0

package/src/PayloadHasher.ts

@@ -1,6 +1,6 @@
-import { asHash, Hash } from '@xylabs/hex'
+import { asHash, Hash, hexFromArrayBuffer } from '@xylabs/hex'
 import { subtle } from '@xylabs/platform'
-import { AnyObject, ObjectWrapper } from '@xyo-network/object'
+import { EmptyObject, ObjectWrapper } from '@xyo-network/object'
 import { WasmSupport } from '@xyo-network/wasm'
 import { sha256 } from 'hash-wasm'
 import shajs from 'sha.js'
@@ -8,42 +8,40 @@ import shajs from 'sha.js'
 import { removeEmptyFields } from './removeEmptyFields'
 import { deepOmitUnderscoreFields } from './removeFields'
 import { sortFields } from './sortFields'
-import { toUint8Array } from './toUint8Array'
 
 const wasmSupportStatic = new WasmSupport(['bigInt'])
 
-export class PayloadHasher<T extends AnyObject = AnyObject> extends ObjectWrapper<T> {
+export class PayloadHasher<T extends EmptyObject = EmptyObject> extends ObjectWrapper<T> {
   static allowSubtle = true
   static readonly wasmInitialized = wasmSupportStatic.initialize()
   static readonly wasmSupport = wasmSupportStatic
 
-  static async filterExclude<T extends AnyObject>(objs: T[] = [], hash: Hash[] | Hash): Promise<T[]> {
+  static async filterExclude<T extends EmptyObject>(objs: T[] = [], hash: Hash[] | Hash): Promise<T[]> {
     const hashes = Array.isArray(hash) ? hash : [hash]
     return (await this.hashPairs(objs)).filter(([_, objHash]) => !hashes.includes(objHash))?.map((pair) => pair[0])
   }
 
-  static async filterInclude<T extends AnyObject>(objs: T[] = [], hash: Hash[] | Hash): Promise<T[]> {
+  static async filterInclude<T extends EmptyObject>(objs: T[] = [], hash: Hash[] | Hash): Promise<T[]> {
     const hashes = Array.isArray(hash) ? hash : [hash]
     return (await this.hashPairs(objs)).filter(([_, objHash]) => hashes.includes(objHash))?.map((pair) => pair[0])
   }
 
-  static async find<T extends AnyObject>(objs: T[] = [], hash: Hash): Promise<T | undefined> {
+  static async find<T extends EmptyObject>(objs: T[] = [], hash: Hash): Promise<T | undefined> {
     return (await this.hashPairs(objs)).find(([_, objHash]) => objHash === hash)?.[0]
   }
 
-  static async hashAsync<T extends AnyObject>(obj: T, encoding?: undefined): Promise<Hash>
-  static async hashAsync<T extends AnyObject>(obj: T, encoding: 'buffer'): Promise<ArrayBuffer>
-  static async hashAsync<T extends AnyObject>(obj: T, encoding: 'hex'): Promise<Hash>
-  static async hashAsync<T extends AnyObject>(obj: T, encoding?: 'buffer' | 'hex'): Promise<Hash | ArrayBuffer> {
+  static async hashAsync<T extends EmptyObject>(obj: T): Promise<Hash> {
     if (PayloadHasher.allowSubtle) {
       try {
         const enc = new TextEncoder()
         const stringToHash = this.stringifyHashFields(obj)
         const b = enc.encode(stringToHash)
         const hashArray = await subtle.digest('SHA-256', b)
-        return encoding === 'buffer' ? hashArray : asHash(hashArray, 256, true)
+        return hexFromArrayBuffer(hashArray, { bitLength: 256 })
       } catch (ex) {
-        console.log('Setting allowSubtle to false')
+        const error = ex as Error
+        console.error(`Setting allowSubtle to false [${error.message}]`)
+        console.log(error.stack)
         PayloadHasher.allowSubtle = false
       }
     }
@@ -52,8 +50,7 @@ export class PayloadHasher<T extends AnyObject = AnyObject> extends ObjectWrappe
     if (this.wasmSupport.canUseWasm) {
       const stringToHash = this.stringifyHashFields(obj)
       try {
-        const hash = asHash(await sha256(stringToHash), 256, true)
-        return encoding === 'buffer' ? toUint8Array(hash) : hash
+        return asHash(await sha256(stringToHash), true)
       } catch (ex) {
         this.wasmSupport.allowWasm = false
       }
@@ -61,34 +58,24 @@ export class PayloadHasher<T extends AnyObject = AnyObject> extends ObjectWrappe
     return this.hashSync(obj)
   }
 
-  static hashFields<T extends AnyObject>(obj: T): T {
+  static hashFields<T extends EmptyObject>(obj: T): T {
     return sortFields(removeEmptyFields(deepOmitUnderscoreFields(obj)))
   }
 
-  static async hashPairs<T extends AnyObject>(objs: T[]): Promise<[T, Hash][]> {
-    return await Promise.all(objs.map<Promise<[T, string]>>(async (obj) => [obj, await PayloadHasher.hashAsync(obj, 'hex')]))
+  static async hashPairs<T extends EmptyObject>(objs: T[]): Promise<[T, Hash][]> {
+    return await Promise.all(objs.map<Promise<[T, string]>>(async (obj) => [obj, await PayloadHasher.hashAsync(obj)]))
   }
 
-  /** @deprecated pass encoding [hex,buffer] */
-  static hashSync<T extends AnyObject>(obj: T, encoding?: undefined): Hash
-  static hashSync<T extends AnyObject>(obj: T, encoding: 'buffer'): ArrayBuffer
-  static hashSync<T extends AnyObject>(obj: T, encoding: 'hex'): Hash
-  static hashSync<T extends AnyObject>(obj: T, encoding?: 'buffer' | 'hex'): Hash | ArrayBuffer {
-    const buffer = shajs('sha256').update(this.stringifyHashFields(obj)).digest()
-    switch (encoding) {
-      case 'buffer':
-        return buffer.buffer
-      default:
-        return asHash(buffer.toString('hex'), 256, true)
-    }
+  static hashSync<T extends EmptyObject>(obj: T): Hash {
+    return asHash(shajs('sha256').update(this.stringifyHashFields(obj)).digest().toString('hex'), true)
   }
 
-  static async hashes<T extends AnyObject>(objs: T[]): Promise<Hash[]> {
-    return await Promise.all(objs.map((obj) => this.hashAsync(obj, 'hex')))
+  static async hashes<T extends EmptyObject>(objs: T[]): Promise<Hash[]> {
+    return await Promise.all(objs.map((obj) => this.hashAsync(obj)))
   }
 
   /** @function jsonPayload Returns a clone of the payload that is JSON safe */
-  static jsonPayload<T extends AnyObject>(
+  static jsonPayload<T extends EmptyObject>(
     /** @param payload The payload to process */
     payload: T,
     /** @param meta Keeps underscore (meta) fields if set to true */
@@ -97,44 +84,22 @@ export class PayloadHasher<T extends AnyObject = AnyObject> extends ObjectWrappe
     return sortFields(removeEmptyFields(meta ? payload : deepOmitUnderscoreFields(payload)))
   }
 
-  static stringifyHashFields<T extends AnyObject>(obj: T) {
+  static stringifyHashFields<T extends EmptyObject>(obj: T) {
     return JSON.stringify(this.hashFields(obj))
   }
 
-  static async toMap<T extends AnyObject>(objs: T[]): Promise<Record<Hash, T>> {
+  static async toMap<T extends EmptyObject>(objs: T[]): Promise<Record<Hash, T>> {
     const result: Record<string, T> = {}
-    await Promise.all(objs.map(async (obj) => (result[await PayloadHasher.hashAsync(obj, 'hex')] = obj)))
+    await Promise.all(objs.map(async (obj) => (result[await PayloadHasher.hashAsync(obj)] = obj)))
     return result
   }
 
-  /** @deprecated pass encoding [hex,buffer] */
-  async hashAsync(encoding?: undefined): Promise<Hash>
-  async hashAsync(encoding: 'buffer'): Promise<ArrayBuffer>
-  async hashAsync(encoding: 'hex'): Promise<Hash>
-  async hashAsync(encoding?: 'buffer' | 'hex'): Promise<Hash | ArrayBuffer> {
-    switch (encoding) {
-      case 'buffer':
-        return await PayloadHasher.hashAsync(this.obj, encoding)
-      case 'hex':
-        return await PayloadHasher.hashAsync(this.obj, encoding)
-      default:
-        return await PayloadHasher.hashAsync(this.obj, encoding)
-    }
+  async hashAsync(): Promise<Hash> {
+    return await PayloadHasher.hashAsync(this.obj)
   }
 
-  /** @deprecated pass encoding [hex,buffer] */
-  hashSync(encoding?: undefined): Hash
-  hashSync(encoding: 'buffer'): ArrayBuffer
-  hashSync(encoding: 'hex'): Hash
-  hashSync(encoding?: 'hex' | 'buffer'): Hash | ArrayBuffer {
-    switch (encoding) {
-      case 'hex':
-        return PayloadHasher.hashSync(this.obj, encoding)
-      case 'buffer':
-        return PayloadHasher.hashSync(this.obj, encoding)
-      default:
-        return PayloadHasher.hashSync(this.obj, encoding)
-    }
+  hashSync(): Hash {
+    return PayloadHasher.hashSync(this.obj)
   }
 
   /** @function jsonPayload Returns a clone of the payload that is JSON safe */

package/src/index.ts

@@ -3,4 +3,3 @@ export * from './PayloadHasher'
 export * from './removeEmptyFields'
 export * from './removeFields'
 export * from './sortFields'
-export * from './toUint8Array'

package/src/removeEmptyFields.ts

@@ -1,9 +1,10 @@
+import { AnyObject, EmptyObject } from '@xyo-network/object'
 import { typeOf } from '@xyo-network/typeof'
 
-export const removeEmptyFields = <T extends Record<string, unknown>>(obj: T) => {
+export const removeEmptyFields = <T extends EmptyObject>(obj: T): T => {
   if (obj === null || Array.isArray(obj)) return obj
 
-  const newObject: Record<string, unknown> = {}
+  const newObject: AnyObject = {}
   Object.entries(obj).forEach(([key, value]) => {
     if (typeOf(value) === 'object') {
       newObject[key] = removeEmptyFields(value as Record<string, unknown>)

package/src/removeFields.ts

@@ -1,9 +1,9 @@
 import { isObject, mapValues, merge, omitBy, pickBy } from '@xylabs/lodash'
-import { AnyObject } from '@xyo-network/object'
+import { EmptyObject } from '@xyo-network/object'
 // eslint-disable-next-line no-restricted-imports
 import type { ValueKeyIteratee } from 'lodash'
 
-export const deepBy = <T extends AnyObject>(obj: T, predicate: ValueKeyIteratee<T>, func: typeof omitBy | typeof pickBy): T => {
+export const deepBy = <T extends EmptyObject>(obj: T, predicate: ValueKeyIteratee<T>, func: typeof omitBy | typeof pickBy): T => {
   if (Array.isArray(obj)) {
     return obj
   }
@@ -22,10 +22,10 @@ export const deepBy = <T extends AnyObject>(obj: T, predicate: ValueKeyIteratee<
   return merge({}, pickedNonObjects, processedObjects) as T
 }
 
-export const deepOmitUnderscoreFields = <T extends AnyObject>(obj: T) => {
+export const deepOmitUnderscoreFields = <T extends EmptyObject>(obj: T): T => {
   return deepBy(obj, (_, key) => key.startsWith('_'), omitBy)
 }
 
-export const deepPickUnderscoreFields = <T extends AnyObject>(obj: T) => {
+export const deepPickUnderscoreFields = <T extends EmptyObject>(obj: T): T => {
   return deepBy(obj, (_, key) => key.startsWith('_'), pickBy)
 }

package/src/sortFields.ts

@@ -1,18 +1,15 @@
-import { AnyObject, isObject, StringKeyObject } from '@xyo-network/object'
+import { AnyObject, EmptyObject, isObject } from '@xyo-network/object'
 
 //if an object, sub-sort
 const subSort = (value: unknown) => {
   return isObject(value) ? sortFields(value) : value
 }
 
-export const sortFields = <T extends AnyObject = AnyObject>(obj: T) => {
-  const stringyObj = obj as StringKeyObject
-
-  const result: StringKeyObject = {}
-  Object.keys(obj)
-    .sort()
-    .forEach((key) => {
-      result[key] = subSort(stringyObj[key])
-    })
+export const sortFields = <T extends EmptyObject>(obj: T) => {
+  const result: AnyObject = {}
+  const keys = Object.keys(obj) as (keyof T)[]
+  keys.sort().forEach((key: keyof T) => {
+    result[key] = subSort(obj[key])
+  })
   return result as T
 }

package/dist/browser/toUint8Array.d.cts

@@ -1,4 +0,0 @@
-export declare function toUint8Array(value: undefined, padLength?: number, base?: number): undefined;
-export declare function toUint8Array(value: ArrayBuffer | string, padLength?: number, base?: number): Uint8Array;
-export declare function toUint8Array(value: ArrayBuffer | string | undefined, padLength?: number, base?: number): Uint8Array | undefined;
-//# sourceMappingURL=toUint8Array.d.ts.map

package/dist/browser/toUint8Array.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"toUint8Array.d.ts","sourceRoot":"","sources":["../../src/toUint8Array.ts"],"names":[],"mappings":"AAeA,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;AAC5F,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;AACxG,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA"}

package/dist/browser/toUint8Array.d.mts

@@ -1,4 +0,0 @@
-export declare function toUint8Array(value: undefined, padLength?: number, base?: number): undefined;
-export declare function toUint8Array(value: ArrayBuffer | string, padLength?: number, base?: number): Uint8Array;
-export declare function toUint8Array(value: ArrayBuffer | string | undefined, padLength?: number, base?: number): Uint8Array | undefined;
-//# sourceMappingURL=toUint8Array.d.ts.map

package/dist/browser/toUint8Array.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"toUint8Array.d.ts","sourceRoot":"","sources":["../../src/toUint8Array.ts"],"names":[],"mappings":"AAeA,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;AAC5F,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;AACxG,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA"}

package/dist/browser/toUint8Array.d.ts

@@ -1,4 +0,0 @@
-export declare function toUint8Array(value: undefined, padLength?: number, base?: number): undefined;
-export declare function toUint8Array(value: ArrayBuffer | string, padLength?: number, base?: number): Uint8Array;
-export declare function toUint8Array(value: ArrayBuffer | string | undefined, padLength?: number, base?: number): Uint8Array | undefined;
-//# sourceMappingURL=toUint8Array.d.ts.map

package/dist/browser/toUint8Array.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"toUint8Array.d.ts","sourceRoot":"","sources":["../../src/toUint8Array.ts"],"names":[],"mappings":"AAeA,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;AAC5F,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;AACxG,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA"}

package/dist/node/toUint8Array.d.cts

@@ -1,4 +0,0 @@
-export declare function toUint8Array(value: undefined, padLength?: number, base?: number): undefined;
-export declare function toUint8Array(value: ArrayBuffer | string, padLength?: number, base?: number): Uint8Array;
-export declare function toUint8Array(value: ArrayBuffer | string | undefined, padLength?: number, base?: number): Uint8Array | undefined;
-//# sourceMappingURL=toUint8Array.d.ts.map

package/dist/node/toUint8Array.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"toUint8Array.d.ts","sourceRoot":"","sources":["../../src/toUint8Array.ts"],"names":[],"mappings":"AAeA,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;AAC5F,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;AACxG,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA"}

package/dist/node/toUint8Array.d.mts

@@ -1,4 +0,0 @@
-export declare function toUint8Array(value: undefined, padLength?: number, base?: number): undefined;
-export declare function toUint8Array(value: ArrayBuffer | string, padLength?: number, base?: number): Uint8Array;
-export declare function toUint8Array(value: ArrayBuffer | string | undefined, padLength?: number, base?: number): Uint8Array | undefined;
-//# sourceMappingURL=toUint8Array.d.ts.map

package/dist/node/toUint8Array.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"toUint8Array.d.ts","sourceRoot":"","sources":["../../src/toUint8Array.ts"],"names":[],"mappings":"AAeA,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;AAC5F,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;AACxG,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA"}

package/dist/node/toUint8Array.d.ts

@@ -1,4 +0,0 @@
-export declare function toUint8Array(value: undefined, padLength?: number, base?: number): undefined;
-export declare function toUint8Array(value: ArrayBuffer | string, padLength?: number, base?: number): Uint8Array;
-export declare function toUint8Array(value: ArrayBuffer | string | undefined, padLength?: number, base?: number): Uint8Array | undefined;
-//# sourceMappingURL=toUint8Array.d.ts.map

package/dist/node/toUint8Array.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"toUint8Array.d.ts","sourceRoot":"","sources":["../../src/toUint8Array.ts"],"names":[],"mappings":"AAeA,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;AAC5F,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;AACxG,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA"}

package/src/toUint8Array.ts

@@ -1,35 +0,0 @@
-import { base16, base58 } from '@scure/base'
-import { assertEx } from '@xylabs/assert'
-import { ifTypeOf } from '@xyo-network/typeof'
-
-const stringToUint8Array = (value: string, base = 16) => {
-  switch (base) {
-    case 16:
-      return base16.decode((value.startsWith('0x') ? value.slice(2) : value).toUpperCase())
-    case 58:
-      return base58.decode(value)
-    default:
-      throw Error(`Unsupported base [${base}]`)
-  }
-}
-
-export function toUint8Array(value: undefined, padLength?: number, base?: number): undefined
-export function toUint8Array(value: ArrayBuffer | string, padLength?: number, base?: number): Uint8Array
-export function toUint8Array(value: ArrayBuffer | string | undefined, padLength?: number, base?: number): Uint8Array | undefined
-export function toUint8Array(value?: ArrayBuffer | string, padLength?: number, base?: number): Uint8Array | undefined {
-  if (value === undefined) return undefined
-
-  let result: Uint8Array | undefined =
-    ifTypeOf<string, Uint8Array>('string', value as string, (value) => stringToUint8Array(value, base)) ?? (value as Uint8Array)
-
-  if (result === undefined) {
-    throw Error(`toUint8Array - Unknown type: ${typeof value}`)
-  }
-
-  if (padLength && result.length < padLength) {
-    result = new Uint8Array([...new Uint8Array(padLength - result.length), ...result])
-    assertEx(result?.length <= padLength, 'Resulting length is greater than padLength')
-  }
-
-  return result
-}