@xyo-network/payload-builder 2.88.2 → 2.89.0-rc.1

package/src/Builder.ts

@@ -1,26 +1,24 @@
 import { assertEx } from '@xylabs/assert'
-import { deepOmitUnderscoreFields, PayloadHasher, removeEmptyFields } from '@xyo-network/hash'
-import { AnyObject } from '@xyo-network/object'
-import { Payload } from '@xyo-network/payload-model'
+import { Hash } from '@xylabs/hex'
+import { JsonObject } from '@xylabs/object'
+import { deepOmitPrefixedFields, PayloadHasher, removeEmptyFields } from '@xyo-network/hash'
+import { Payload, PayloadWithMeta, WithMeta } from '@xyo-network/payload-model'
 
-export interface PayloadBuilderOptions {
+export interface PayloadBuilderOptions<T> {
+  fields?: Partial<T>
+  meta?: JsonObject
   schema: string
 }
 
-export class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
-  private _$meta?: AnyObject
-  private _client = 'js'
+export class PayloadBuilder<T extends Payload = Payload> {
+  private _$meta?: JsonObject
   private _fields: Partial<T> = {}
   private _schema: string
-  private _timestamp = Date.now()
 
-  constructor({ schema }: PayloadBuilderOptions) {
+  constructor({ schema, fields, meta }: PayloadBuilderOptions<T>) {
     this._schema = schema
-  }
-
-  get externalMeta() {
-    const _hash = PayloadHasher.hashAsync(this.hashableFields)
-    return { _client: this._client, _hash, _timestamp: this._timestamp }
+    this._fields = fields ?? {}
+    this._$meta = meta
   }
 
   get schema() {
@@ -28,31 +26,107 @@ export class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
     return this._schema
   }
 
-  $meta(fields?: AnyObject) {
-    this._$meta = fields
-    return this
+  static async build<T extends Payload>(payload: T) {
+    const builder = new PayloadBuilder<T>({ schema: payload.schema })
+    builder.fields(payload)
+    return await builder.build()
   }
 
-  async build(withExternalMeta = false) {
-    let hashableFields = this.hashableFields()
-    if (this._$meta) {
-      const $hash = await PayloadHasher.hashAsync(hashableFields)
-      hashableFields = { ...hashableFields, $hash, $meta: this._$meta }
+  static async dataHashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]> {
+    return await Promise.all(
+      payloads.map(async (payload) => {
+        const built = await PayloadBuilder.build(payload)
+        return [built, built.$hash]
+      }),
+    )
+  }
+
+  static async dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]> {
+    return await Promise.all(
+      payloads.map(async (payload) => {
+        const built = await PayloadBuilder.build(payload)
+        return built.$hash
+      }),
+    )
+  }
+
+  static async filterExclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {
+    const hashes = Array.isArray(hash) ? hash : [hash]
+    return (await this.hashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map((pair) => pair[0])
+  }
+
+  static async filterInclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {
+    const hashes = Array.isArray(hash) ? hash : [hash]
+    return (await this.hashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map((pair) => pair[0])
+  }
+
+  static async find<T extends Payload>(payloads: T[] = [], hash: Hash): Promise<T | undefined> {
+    return (await this.hashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0]
+  }
+
+  /**
+   * Creates an array of payload/hash tuples based on the payloads passed in
+   * @param objs Any array of payloads
+   * @returns An array of payload/hash tuples
+   */
+  static async hashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]> {
+    return await Promise.all(
+      payloads.map<Promise<[WithMeta<T>, Hash]>>(async (payload) => {
+        const built = await PayloadBuilder.build(payload)
+        return [built, await PayloadHasher.hashAsync(built)]
+      }),
+    )
+  }
+
+  static async toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {
+    const result: Record<Hash, T> = {}
+    for (const pair of await this.dataHashPairs(objs)) {
+      result[pair[1]] = pair[0]
     }
-    return withExternalMeta ? { ...hashableFields, ...this.externalMeta } : hashableFields
+    return result
   }
 
-  fields(fields?: Partial<T>) {
-    if (fields) {
-      this._fields = { ...this._fields, ...removeEmptyFields(fields) }
+  /**
+   * Creates an object map of payload hashes to payloads based on the payloads passed in
+   * @param objs Any array of payloads
+   * @returns A map of hashes to payloads
+   */
+  static async toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {
+    const result: Record<Hash, T> = {}
+    for (const pair of await this.hashPairs(objs)) {
+      result[pair[1]] = pair[0]
     }
+    return result
+  }
+
+  $meta(fields?: JsonObject) {
+    this._$meta = fields
     return this
   }
 
-  hashableFields() {
+  async build(): Promise<WithMeta<T>> {
+    const dataHashableFields = this.dataHashableFields()
+    const $hash = await PayloadHasher.hashAsync(dataHashableFields)
+    const hashableFields: PayloadWithMeta = { ...dataHashableFields, $hash }
+
+    //only add $meta if it exists and has at least one field
+    if (this._$meta && Object.keys(this._$meta).length > 0) {
+      hashableFields['$meta'] = this._$meta
+    }
+    return hashableFields as WithMeta<T>
+  }
+
+  dataHashableFields() {
     return {
-      ...removeEmptyFields(deepOmitUnderscoreFields(this._fields)),
+      ...removeEmptyFields(deepOmitPrefixedFields(deepOmitPrefixedFields(this._fields, '$'), '_')),
       schema: assertEx(this.schema, 'Payload: Missing Schema'),
     } as T
   }
+
+  fields(fields?: Partial<T>) {
+    if (fields) {
+      this._fields = { ...this._fields, ...removeEmptyFields(fields) }
+    }
+    return this
+  }
 }