@xyo-network/boundwitness-builder 2.72.8 → 2.73.0

package/dist/index.d.mts

@@ -0,0 +1,93 @@
+import { AccountInstance } from '@xyo-network/account-model';
+import * as _xyo_network_boundwitness_model from '@xyo-network/boundwitness-model';
+import { BoundWitness, BoundWitnessSchema } from '@xyo-network/boundwitness-model';
+import { Data } from '@xyo-network/core';
+import * as _xyo_network_payload_model from '@xyo-network/payload-model';
+import { Payload, ModuleError, Query, PayloadSetPayload } from '@xyo-network/payload-model';
+import { Logger } from '@xyo-network/shared';
+import { BoundWitnessValidator } from '@xyo-network/boundwitness-validator';
+import { BoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper';
+import { PayloadWrapper } from '@xyo-network/payload-wrapper';
+
+interface BoundWitnessBuilderConfig {
+    /** Whether or not the payloads should be included in the metadata sent to and recorded by the ArchivistApi */
+    readonly inlinePayloads?: boolean;
+    readonly meta?: boolean;
+    readonly timestamp?: boolean;
+}
+declare class BoundWitnessBuilder<TBoundWitness extends BoundWitness<{
+    schema: string;
+}> = BoundWitness, TPayload extends Payload = Payload> {
+    readonly config: BoundWitnessBuilderConfig;
+    protected readonly logger?: Logger | undefined;
+    private static readonly _buildMutex;
+    private _accounts;
+    private _errorHashes;
+    private _errors;
+    private _payloadHashes;
+    private _payloadSchemas;
+    private _payloads;
+    private _timestamp;
+    constructor(config?: BoundWitnessBuilderConfig, logger?: Logger | undefined);
+    private get _payload_schemas();
+    build(meta?: boolean): Promise<[TBoundWitness, TPayload[], ModuleError[]]>;
+    error(payload?: ModuleError): this;
+    errors(errors?: (ModuleError | null)[]): this;
+    hashableFields(): Promise<TBoundWitness>;
+    hashes(hashes: string[], schema: string[]): this;
+    payload(payload?: TPayload): this;
+    payloads(payloads?: (TPayload | null)[]): this;
+    witness(account: AccountInstance): this;
+    witnesses(accounts: AccountInstance[]): this;
+    protected signatures(_hash: string, previousHashes: (string | Data | undefined)[]): Promise<string[]>;
+    private getPayloadHashes;
+    private inlinePayloads;
+    private missingSchemaMessage;
+}
+
+type QueryBoundWitnessSchema = BoundWitnessSchema;
+declare const QueryBoundWitnessSchema: QueryBoundWitnessSchema;
+type QueryBoundWitness = BoundWitness<{
+    query: string;
+    resultSet?: string;
+    schema: BoundWitnessSchema;
+}>;
+declare const isQueryBoundWitness: (x?: Payload | null) => x is _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_boundwitness_model.BoundWitnessFields & {
+    query: string;
+    resultSet?: string | undefined;
+    schema: BoundWitnessSchema;
+} & {
+    schema: "network.xyo.boundwitness";
+};
+
+declare class QueryBoundWitnessBuilder<TBoundWitness extends QueryBoundWitness = QueryBoundWitness, TQuery extends Query = Query> extends BoundWitnessBuilder<TBoundWitness> {
+    private _query;
+    private _resultSet;
+    hashableFields(): Promise<TBoundWitness>;
+    query<T extends TQuery>(query: T): this;
+    resultSet<T extends PayloadSetPayload>(payloadSet: T): this;
+}
+
+declare class QueryBoundWitnessValidator<T extends Query = Query> extends BoundWitnessValidator<QueryBoundWitness> {
+    private _query;
+    protected get expectedSchema(): string;
+    static isQueryBoundWitnessValidator(obj: unknown): boolean;
+    validate(): Promise<Error[]>;
+    validateResultSet(): Promise<Error[]>;
+}
+
+declare class QueryBoundWitnessWrapper<T extends Query = Query> extends BoundWitnessWrapper<QueryBoundWitness> {
+    private _payloadsWithoutQuery;
+    private _query;
+    private _resultSet;
+    private isQueryBoundWitnessWrapper;
+    static parseQuery<T extends Query = Query>(obj: unknown, payloads?: Payload[]): QueryBoundWitnessWrapper<T>;
+    getErrors(): Promise<Error[]>;
+    getQuery(): Promise<T>;
+    getResultSet(): Promise<_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_payload_model.PayloadSet & {
+        schema: "network.xyo.payload.set";
+    }>;
+    getWrappedPayloads(): Promise<PayloadWrapper<Payload>[]>;
+}
+
+export { BoundWitnessBuilder, BoundWitnessBuilderConfig, QueryBoundWitness, QueryBoundWitnessBuilder, QueryBoundWitnessSchema, QueryBoundWitnessValidator, QueryBoundWitnessWrapper, isQueryBoundWitness };

package/dist/index.d.ts

@@ -0,0 +1,93 @@
+import { AccountInstance } from '@xyo-network/account-model';
+import * as _xyo_network_boundwitness_model from '@xyo-network/boundwitness-model';
+import { BoundWitness, BoundWitnessSchema } from '@xyo-network/boundwitness-model';
+import { Data } from '@xyo-network/core';
+import * as _xyo_network_payload_model from '@xyo-network/payload-model';
+import { Payload, ModuleError, Query, PayloadSetPayload } from '@xyo-network/payload-model';
+import { Logger } from '@xyo-network/shared';
+import { BoundWitnessValidator } from '@xyo-network/boundwitness-validator';
+import { BoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper';
+import { PayloadWrapper } from '@xyo-network/payload-wrapper';
+
+interface BoundWitnessBuilderConfig {
+    /** Whether or not the payloads should be included in the metadata sent to and recorded by the ArchivistApi */
+    readonly inlinePayloads?: boolean;
+    readonly meta?: boolean;
+    readonly timestamp?: boolean;
+}
+declare class BoundWitnessBuilder<TBoundWitness extends BoundWitness<{
+    schema: string;
+}> = BoundWitness, TPayload extends Payload = Payload> {
+    readonly config: BoundWitnessBuilderConfig;
+    protected readonly logger?: Logger | undefined;
+    private static readonly _buildMutex;
+    private _accounts;
+    private _errorHashes;
+    private _errors;
+    private _payloadHashes;
+    private _payloadSchemas;
+    private _payloads;
+    private _timestamp;
+    constructor(config?: BoundWitnessBuilderConfig, logger?: Logger | undefined);
+    private get _payload_schemas();
+    build(meta?: boolean): Promise<[TBoundWitness, TPayload[], ModuleError[]]>;
+    error(payload?: ModuleError): this;
+    errors(errors?: (ModuleError | null)[]): this;
+    hashableFields(): Promise<TBoundWitness>;
+    hashes(hashes: string[], schema: string[]): this;
+    payload(payload?: TPayload): this;
+    payloads(payloads?: (TPayload | null)[]): this;
+    witness(account: AccountInstance): this;
+    witnesses(accounts: AccountInstance[]): this;
+    protected signatures(_hash: string, previousHashes: (string | Data | undefined)[]): Promise<string[]>;
+    private getPayloadHashes;
+    private inlinePayloads;
+    private missingSchemaMessage;
+}
+
+type QueryBoundWitnessSchema = BoundWitnessSchema;
+declare const QueryBoundWitnessSchema: QueryBoundWitnessSchema;
+type QueryBoundWitness = BoundWitness<{
+    query: string;
+    resultSet?: string;
+    schema: BoundWitnessSchema;
+}>;
+declare const isQueryBoundWitness: (x?: Payload | null) => x is _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_boundwitness_model.BoundWitnessFields & {
+    query: string;
+    resultSet?: string | undefined;
+    schema: BoundWitnessSchema;
+} & {
+    schema: "network.xyo.boundwitness";
+};
+
+declare class QueryBoundWitnessBuilder<TBoundWitness extends QueryBoundWitness = QueryBoundWitness, TQuery extends Query = Query> extends BoundWitnessBuilder<TBoundWitness> {
+    private _query;
+    private _resultSet;
+    hashableFields(): Promise<TBoundWitness>;
+    query<T extends TQuery>(query: T): this;
+    resultSet<T extends PayloadSetPayload>(payloadSet: T): this;
+}
+
+declare class QueryBoundWitnessValidator<T extends Query = Query> extends BoundWitnessValidator<QueryBoundWitness> {
+    private _query;
+    protected get expectedSchema(): string;
+    static isQueryBoundWitnessValidator(obj: unknown): boolean;
+    validate(): Promise<Error[]>;
+    validateResultSet(): Promise<Error[]>;
+}
+
+declare class QueryBoundWitnessWrapper<T extends Query = Query> extends BoundWitnessWrapper<QueryBoundWitness> {
+    private _payloadsWithoutQuery;
+    private _query;
+    private _resultSet;
+    private isQueryBoundWitnessWrapper;
+    static parseQuery<T extends Query = Query>(obj: unknown, payloads?: Payload[]): QueryBoundWitnessWrapper<T>;
+    getErrors(): Promise<Error[]>;
+    getQuery(): Promise<T>;
+    getResultSet(): Promise<_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_payload_model.PayloadSet & {
+        schema: "network.xyo.payload.set";
+    }>;
+    getWrappedPayloads(): Promise<PayloadWrapper<Payload>[]>;
+}
+
+export { BoundWitnessBuilder, BoundWitnessBuilderConfig, QueryBoundWitness, QueryBoundWitnessBuilder, QueryBoundWitnessSchema, QueryBoundWitnessValidator, QueryBoundWitnessWrapper, isQueryBoundWitness };