@xyo-network/boundwitness-builder 2.64.10 → 2.65.0

package/src/Builder.ts

@@ -4,9 +4,8 @@ import { AccountInstance } from '@xyo-network/account-model'
 import { BoundWitness, BoundWitnessSchema } from '@xyo-network/boundwitness-model'
 import { BoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'
 import { Data, PayloadHasher, sortFields } from '@xyo-network/core'
-import { ModuleError } from '@xyo-network/module-model'
 import { PayloadWrapper } from '@xyo-network/payload'
-import { Payload } from '@xyo-network/payload-model'
+import { ModuleError, Payload } from '@xyo-network/payload-model'
 import { Logger } from '@xyo-network/shared'
 import { Mutex } from 'async-mutex'
 

package/src/Query/QueryBoundWitness.ts

@@ -0,0 +1,13 @@
+import { BoundWitness, BoundWitnessSchema, isBoundWitness } from '@xyo-network/boundwitness-model'
+import { Payload } from '@xyo-network/payload-model'
+
+export type QueryBoundWitnessSchema = BoundWitnessSchema
+export const QueryBoundWitnessSchema: QueryBoundWitnessSchema = BoundWitnessSchema
+
+export type QueryBoundWitness = BoundWitness<{
+  query: string
+  resultSet?: string
+  schema: BoundWitnessSchema
+}>
+
+export const isQueryBoundWitness = (x?: Payload | null): x is QueryBoundWitness => isBoundWitness(x) && (x as QueryBoundWitness)?.query !== undefined

package/src/Query/QueryBoundWitnessBuilder.ts

@@ -0,0 +1,34 @@
+import { assertEx } from '@xylabs/assert'
+import { PayloadSetPayload, Query } from '@xyo-network/payload-model'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+
+import { BoundWitnessBuilder } from '../Builder'
+import { QueryBoundWitness, QueryBoundWitnessSchema } from './QueryBoundWitness'
+
+export class QueryBoundWitnessBuilder<
+  TBoundWitness extends QueryBoundWitness = QueryBoundWitness,
+  TQuery extends Query = Query,
+> extends BoundWitnessBuilder<TBoundWitness> {
+  private _query: PayloadWrapper<TQuery> | undefined
+  private _resultSet: PayloadWrapper<PayloadSetPayload> | undefined
+
+  override async hashableFields(): Promise<TBoundWitness> {
+    return {
+      ...(await super.hashableFields()),
+      query: assertEx(await this._query?.hashAsync(), 'No Query Specified'),
+      schema: QueryBoundWitnessSchema,
+    }
+  }
+
+  query<T extends TQuery | PayloadWrapper<TQuery>>(query: T) {
+    this._query = PayloadWrapper.wrap(query)
+    this.payload(this._query.payload())
+    return this
+  }
+
+  resultSet<T extends PayloadSetPayload | PayloadWrapper<PayloadSetPayload>>(payloadSet: T) {
+    this._resultSet = PayloadWrapper.wrap(payloadSet)
+    this.payload(this._resultSet.payload())
+    return this
+  }
+}

package/src/Query/QueryBoundWitnessValidator.ts

@@ -0,0 +1,51 @@
+import { assertEx } from '@xylabs/assert'
+import { BoundWitnessValidator } from '@xyo-network/boundwitness-validator'
+import { BoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'
+import { handleError } from '@xyo-network/error'
+import { PayloadSetPayload, Query } from '@xyo-network/payload-model'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+
+import { QueryBoundWitness, QueryBoundWitnessSchema } from './QueryBoundWitness'
+export class QueryBoundWitnessValidator<T extends Query = Query> extends BoundWitnessValidator<QueryBoundWitness> {
+  private _query: PayloadWrapper<T> | undefined
+
+  protected override get expectedSchema(): string {
+    return QueryBoundWitnessSchema
+  }
+
+  static isQueryBoundWitnessValidator(obj: unknown) {
+    return (obj as QueryBoundWitnessValidator)?.constructor === QueryBoundWitnessValidator
+  }
+
+  override async validate() {
+    return [
+      ...(await super.validate()),
+      // ...this.validateResultSet()
+    ]
+  }
+
+  async validateResultSet() {
+    const errors: Error[] = []
+    try {
+      const resultSetHash = assertEx(this.obj.resultSet, 'Missing ResultSet')
+      const wrapper = BoundWitnessWrapper.parse(this.obj)
+      const resultSet = PayloadWrapper.wrap<PayloadSetPayload>((await wrapper.payloadMap())[resultSetHash] as PayloadSetPayload)
+      const required = resultSet?.payload().required
+      if (required) {
+        Object.entries(required).forEach(([key, value]) => {
+          const found = wrapper.payloadSchemas.reduce((count, schema) => {
+            return count + (schema === key ? 1 : 0)
+          }, 0)
+          if (found !== value) {
+            errors.push(Error(`validateResultSet: Missing Schema [${key}:${found}:${value}]`))
+          }
+        })
+      }
+    } catch (ex) {
+      handleError(ex, (error) => {
+        errors.push(error)
+      })
+    }
+    return errors
+  }
+}

package/src/Query/QueryBoundWitnessWrapper.ts

@@ -0,0 +1,65 @@
+import { assertEx } from '@xylabs/assert'
+import { BoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'
+import { PayloadHasher } from '@xyo-network/core'
+import { Payload, PayloadSetPayload, Query } from '@xyo-network/payload-model'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+import compact from 'lodash/compact'
+
+import { QueryBoundWitness } from './QueryBoundWitness'
+import { QueryBoundWitnessValidator } from './QueryBoundWitnessValidator'
+
+export class QueryBoundWitnessWrapper<T extends Query = Query> extends BoundWitnessWrapper<QueryBoundWitness> {
+  private _payloadsWithoutQuery: PayloadWrapper<Payload>[] | undefined
+  private _query: T | undefined
+  private _resultSet: PayloadSetPayload | undefined
+
+  private isQueryBoundWitnessWrapper = true
+
+  static parseQuery<T extends Query = Query>(obj: unknown, payloads?: Payload[]): QueryBoundWitnessWrapper<T> {
+    assertEx(!Array.isArray(obj), 'Array can not be converted to QueryBoundWitnessWrapper')
+    switch (typeof obj) {
+      case 'object': {
+        const castWrapper = obj as QueryBoundWitnessWrapper<T>
+        const wrapper = castWrapper?.isQueryBoundWitnessWrapper ? castWrapper : new QueryBoundWitnessWrapper<T>(obj as QueryBoundWitness, payloads)
+        /*if (!wrapper.valid) {
+          console.warn(`Parsed invalid QueryBoundWitness ${JSON.stringify(wrapper.errors.map((error) => error.message))}`)
+        }*/
+        return wrapper
+      }
+    }
+    throw Error(`Unable to parse [${typeof obj}]`)
+  }
+
+  override getErrors() {
+    return new QueryBoundWitnessValidator(this.boundwitness).validate()
+  }
+
+  async getQuery(): Promise<T> {
+    const payloadMap = await this.allPayloadMap()
+    this._query = this._query ?? (payloadMap[this.boundwitness.query] as T | undefined)
+    return assertEx(this._query, `Missing Query [${this.boundwitness}]`)
+  }
+
+  async getResultSet() {
+    const resultSetHash = this.boundwitness.resultSet
+    const payloadMap = await this.payloadMap()
+    return assertEx(
+      (this._resultSet = this._resultSet ?? (resultSetHash ? (payloadMap[resultSetHash] as PayloadSetPayload | undefined) : undefined)),
+      `Missing resultSet [${resultSetHash}]`,
+    )
+  }
+
+  override async getWrappedPayloads(): Promise<PayloadWrapper<Payload>[]> {
+    this._payloadsWithoutQuery =
+      this._payloadsWithoutQuery ??
+      compact(
+        (
+          await PayloadHasher.filterExclude(
+            (await super.getWrappedPayloads()).map((wrapper) => wrapper.payload()),
+            this.payload().query,
+          )
+        ).map((payload) => PayloadWrapper.wrap(payload)),
+      )
+    return this._payloadsWithoutQuery
+  }
+}

package/src/Query/index.ts

@@ -0,0 +1,4 @@
+export * from './QueryBoundWitness'
+export * from './QueryBoundWitnessBuilder'
+export * from './QueryBoundWitnessValidator'
+export * from './QueryBoundWitnessWrapper'

package/src/index.ts

@@ -1 +1,2 @@
 export * from './Builder'
+export * from './Query'