@xyo-network/payload-builder 3.6.0-rc.4 → 3.6.0-rc.6

package/src/BuilderBase.ts

@@ -1,23 +1,31 @@
 import { assertEx } from '@xylabs/assert'
-import type { AnyObject } from '@xylabs/object'
+import type { AnyObject, EmptyObject } from '@xylabs/object'
 import {
   isJsonObject, omitBy, toJson,
 } from '@xylabs/object'
 import type { Promisable } from '@xylabs/promise'
 import { removeEmptyFields } from '@xyo-network/hash'
-import type { Payload, Schema } from '@xyo-network/payload-model'
+import type {
+  DeepOmitStartsWith,
+  Payload, Schema,
+  WithOptionalSchema,
+  WithoutClientMeta,
+  WithoutMeta,
+  WithoutPrivateStorageMeta,
+  WithoutSchema,
+  WithoutStorageMeta,
+} from '@xyo-network/payload-model'
 
-import { PayloadBuilder } from './Builder.ts'
 import type { PayloadBuilderOptions } from './Options.ts'
 
-export type WithOptionalSchema<T extends Payload> = Omit<T, 'schema'> & Partial<T>
-
-export type WithoutSchema<T extends WithOptionalSchema<Payload>> = Omit<T, 'schema'>
+export const omitByPrefix = <T extends EmptyObject, P extends string>(payload: T, prefix: P, maxDepth = 100): DeepOmitStartsWith<T, P> => {
+  return omitBy(payload, omitByPrefixPredicate(prefix), maxDepth) as unknown as DeepOmitStartsWith<T, P>
+}
 
-export const removeMetaAndSchema = <T extends Payload>(payload: Partial<WithOptionalSchema<T>>): WithoutSchema<T> => {
-  const { ...result } = PayloadBuilder.omitMeta(payload as T) as WithOptionalSchema<T>
+export const omitSchema = <T extends WithOptionalSchema>(payload: T): WithoutSchema<T> => {
+  const result = structuredClone(payload)
   delete result.schema
-  return result as Omit<T, 'schema'>
+  return result
 }
 
 const omitByPrefixPredicate = (prefix: string) => (_: unknown, key: string) => {
@@ -25,78 +33,75 @@ const omitByPrefixPredicate = (prefix: string) => (_: unknown, key: string) => {
   return key.startsWith(prefix)
 }
 
-export class PayloadBuilderBase<T extends Payload = Payload<AnyObject>, O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {
-  protected _fields?: Partial<WithoutSchema<T>>
+export class PayloadBuilderBase<T extends Payload = Payload<AnyObject>,
+  O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {
+  protected _fields?: WithoutMeta<WithoutSchema<T>>
   protected _schema: Schema
 
   constructor(readonly options: O) {
     const { schema, fields } = options
     this._schema = schema
-    this._fields = removeMetaAndSchema(removeEmptyFields(structuredClone(fields ?? {})))
+    if (fields) {
+      this.fields(fields)
+    }
   }
 
   static dataHashableFields<T extends Payload>(
     schema: Schema,
     payload: WithoutSchema<T>,
 
-  ): Promisable<Payload> {
+  ): Promisable<WithoutMeta<T>> {
     const cleanFields = removeEmptyFields({ ...payload, schema })
     assertEx(
       cleanFields === undefined || isJsonObject(cleanFields),
       () => `Fields must be JsonObject: ${JSON.stringify(toJson(cleanFields), null, 2)}`,
     )
-    return this.omitMeta(cleanFields) as T
+    return this.omitMeta(cleanFields) as WithoutMeta<T>
   }
 
-  static omitClientMeta<T extends Payload>(payload: T, maxDepth?: number): T
-  static omitClientMeta<T extends Payload>(payloads: T[], maxDepth?: number): T[]
-  static omitClientMeta<T extends Payload>(payloads: T | T[], maxDepth = 100): T | T[] {
+  static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>
+  static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[]
+  static omitClientMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutClientMeta<T> | WithoutClientMeta<T>[] {
     return Array.isArray(payloads)
-      ? payloads.map(payload => this.omitClientMeta(payload, maxDepth)) as T[]
-      : omitBy(payloads, omitByPrefixPredicate('$'), maxDepth) as T
+      ? payloads.map(payload => this.omitClientMeta(payload, maxDepth))
+      : omitByPrefix(payloads, '$', maxDepth)
   }
 
-  static omitMeta<T extends Payload>(payload: T, maxDepth?: number): T
-  static omitMeta<T extends Payload>(payloads: T[], maxDepth?: number): T[]
-  static omitMeta<T extends Payload>(payloads: T | T[], maxDepth = 100): T | T[] {
+  static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>
+  static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[]
+  static omitMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutMeta<T> | WithoutMeta<T>[] {
     return Array.isArray(payloads)
-      ? this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth)
-      : this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth)
+      ? payloads.map(payload => this.omitMeta(payload, maxDepth))
+      : this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth) as unknown as WithoutMeta<T>
   }
 
-  static omitPrivateStorageMeta<T extends Payload>(payload: T, maxDepth?: number): T
-  static omitPrivateStorageMeta<T extends Payload>(payloads: T[], maxDepth?: number): T[]
-  static omitPrivateStorageMeta<T extends Payload>(payloads: T | T[], maxDepth = 100): T | T[] {
+  static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>
+  static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[]
+  static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutPrivateStorageMeta<T> | WithoutPrivateStorageMeta<T>[] {
     return Array.isArray(payloads)
-      ? payloads.map(payload => this.omitPrivateStorageMeta(payload, maxDepth)) as T[]
-      : omitBy(payloads, omitByPrefixPredicate('_'), maxDepth) as T
+      ? payloads.map(payload => this.omitPrivateStorageMeta(payload, maxDepth))
+      : omitByPrefix(payloads, '__', maxDepth)
   }
 
-  static omitStorageMeta<T extends Payload>(payload: T, maxDepth?: number): T
-  static omitStorageMeta<T extends Payload>(payloads: T[], maxDepth?: number): T[]
-  static omitStorageMeta<T extends Payload>(payloads: T | T[], maxDepth = 100): T | T[] {
+  static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>
+  static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[]
+  static omitStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutStorageMeta<T> | WithoutStorageMeta<T>[] {
     return Array.isArray(payloads)
-      ? payloads.map(payload => this.omitStorageMeta(payload, maxDepth)) as T[]
-      : omitBy(payloads, omitByPrefixPredicate('_'), maxDepth) as T
+      ? payloads.map(payload => this.omitStorageMeta(payload, maxDepth))
+      : omitByPrefix(payloads, '_', maxDepth)
   }
 
   async dataHashableFields() {
     return await PayloadBuilderBase.dataHashableFields(
       assertEx(this._schema, () => 'Payload: Missing Schema'),
       // TDOD: Add verification that required fields are present
-      this._fields as T,
+      this._fields as WithoutSchema<T>,
     )
   }
 
-  fields(fields: WithOptionalSchema<T>) {
-    if (fields) {
-      const fieldsClone = structuredClone(fields)
-      const { schema } = fieldsClone
-      if (schema) {
-        this.schema(schema)
-      }
-      this._fields = removeEmptyFields(removeMetaAndSchema<T>(fieldsClone))
-    }
+  fields(fields: WithoutMeta<WithoutSchema<T>>) {
+    // we need to do the cast here since ts seems to not like nested, yet same, generics
+    this._fields = omitSchema(PayloadBuilderBase.omitMeta(removeEmptyFields(structuredClone(fields)))) as unknown as WithoutMeta<WithoutSchema<T>>
     return this
   }
 

package/src/Options.ts

@@ -1,9 +1,11 @@
 import type { Logger } from '@xylabs/logger'
-import type { JsonObject } from '@xylabs/object'
-import type { Schema } from '@xyo-network/payload-model'
+import type { EmptyObject, JsonObject } from '@xylabs/object'
+import type {
+  Schema, WithoutMeta, WithoutSchema,
+} from '@xyo-network/payload-model'
 
-export interface PayloadBuilderOptions<T> {
-  readonly fields?: Partial<T>
+export interface PayloadBuilderOptions<T extends EmptyObject = EmptyObject> {
+  readonly fields?: WithoutMeta<WithoutSchema<T>>
   readonly logger?: Logger
   readonly meta?: JsonObject
   readonly schema: Schema