npm - @xyo-network/payload-builder - Versions diffs - 3.6.0-rc.9 → 3.6.0 - Mend

@xyo-network/payload-builder 3.6.0-rc.9 → 3.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (35) hide show

package/dist/browser/Builder.d.ts +29 -11
package/dist/browser/Builder.d.ts.map +1 -1
package/dist/browser/Options.d.ts +2 -5
package/dist/browser/Options.d.ts.map +1 -1
package/dist/browser/index.d.ts +1 -1
package/dist/browser/index.d.ts.map +1 -1
package/dist/browser/index.mjs +84 -90
package/dist/browser/index.mjs.map +1 -1
package/dist/neutral/Builder.d.ts +29 -11
package/dist/neutral/Builder.d.ts.map +1 -1
package/dist/neutral/Options.d.ts +2 -5
package/dist/neutral/Options.d.ts.map +1 -1
package/dist/neutral/index.d.ts +1 -1
package/dist/neutral/index.d.ts.map +1 -1
package/dist/neutral/index.mjs +84 -90
package/dist/neutral/index.mjs.map +1 -1
package/dist/node/Builder.d.ts +29 -11
package/dist/node/Builder.d.ts.map +1 -1
package/dist/node/Options.d.ts +2 -5
package/dist/node/Options.d.ts.map +1 -1
package/dist/node/index.d.ts +1 -1
package/dist/node/index.d.ts.map +1 -1
package/dist/node/index.mjs +84 -90
package/dist/node/index.mjs.map +1 -1
package/package.json +12 -13
package/src/Builder.ts +152 -50
package/src/Options.ts +2 -7
package/src/index.ts +1 -1
package/dist/browser/BuilderBase.d.ts +0 -26
package/dist/browser/BuilderBase.d.ts.map +0 -1
package/dist/neutral/BuilderBase.d.ts +0 -26
package/dist/neutral/BuilderBase.d.ts.map +0 -1
package/dist/node/BuilderBase.d.ts +0 -26
package/dist/node/BuilderBase.d.ts.map +0 -1
package/src/BuilderBase.ts +0 -109

package/dist/browser/BuilderBase.d.ts DELETED Viewed

@@ -1,26 +0,0 @@
-import type { AnyObject, EmptyObject } from '@xylabs/object';
-import type { Promisable } from '@xylabs/promise';
-import type { Payload, Schema, WithOnlyClientMeta, WithOptionalSchema, WithoutClientMeta, WithoutMeta, WithoutPrivateStorageMeta, WithoutSchema, WithoutStorageMeta } from '@xyo-network/payload-model';
-import type { PayloadBuilderOptions } from './Options.ts';
-export declare const omitSchema: <T extends WithOptionalSchema>(payload: T) => WithoutSchema<T>;
-export declare class PayloadBuilderBase<T extends Payload = Payload<AnyObject>, O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {
-    readonly options: O;
-    protected _fields?: WithoutMeta<WithoutSchema<T>>;
-    protected _meta?: WithOnlyClientMeta<T>;
-    protected _schema: Schema;
-    constructor(options: O);
-    static dataHashableFields<T extends Payload>(schema: Schema, payload: WithoutSchema<T>): Promisable<WithoutMeta<T>>;
-    static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>;
-    static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[];
-    static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>;
-    static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[];
-    static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>;
-    static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[];
-    static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>;
-    static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[];
-    dataHashableFields(): Promise<import("@xylabs/object").DeepOmitStartsWith<import("@xylabs/object").DeepOmitStartsWith<T, "_">, "$">>;
-    fields(fields: WithoutMeta<WithoutSchema<T>>): this;
-    meta(meta: WithOnlyClientMeta<T>): this;
-    schema(value: Schema): void;
-}
-//# sourceMappingURL=BuilderBase.d.ts.map

package/dist/browser/BuilderBase.d.ts.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"file":"BuilderBase.d.ts","sourceRoot":"","sources":["../../src/BuilderBase.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAI5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EACf,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,WAAW,EACX,yBAAyB,EACzB,aAAa,EACb,kBAAkB,EACnB,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAEzD,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,kBAAkB,WAAW,CAAC,KAAG,aAAa,CAAC,CAAC,CAIpF,CAAA;AAED,qBAAa,kBAAkB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,EACpE,CAAC,SAAS,qBAAqB,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC;IAKjD,QAAQ,CAAC,OAAO,EAAE,CAAC;IAJ/B,SAAS,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;IACjD,SAAS,CAAC,KAAK,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAA;IACvC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAA;gBAEJ,OAAO,EAAE,CAAC;IAQ/B,MAAM,CAAC,kBAAkB,CAAC,CAAC,SAAS,OAAO,EACzC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,GAExB,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAS7B,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC;IACjG,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC,EAAE;IAOtG,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC;IACrF,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE;IAO1F,MAAM,CAAC,sBAAsB,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,yBAAyB,CAAC,CAAC,CAAC;IACjH,MAAM,CAAC,sBAAsB,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,yBAAyB,CAAC,CAAC,CAAC,EAAE;IAOtH,MAAM,CAAC,eAAe,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC;IACnG,MAAM,CAAC,eAAe,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC,EAAE;IAOlG,kBAAkB;IAQxB,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAM5C,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAMhC,MAAM,CAAC,KAAK,EAAE,MAAM;CAGrB"}

package/dist/neutral/BuilderBase.d.ts DELETED Viewed

@@ -1,26 +0,0 @@
-import type { AnyObject, EmptyObject } from '@xylabs/object';
-import type { Promisable } from '@xylabs/promise';
-import type { Payload, Schema, WithOnlyClientMeta, WithOptionalSchema, WithoutClientMeta, WithoutMeta, WithoutPrivateStorageMeta, WithoutSchema, WithoutStorageMeta } from '@xyo-network/payload-model';
-import type { PayloadBuilderOptions } from './Options.ts';
-export declare const omitSchema: <T extends WithOptionalSchema>(payload: T) => WithoutSchema<T>;
-export declare class PayloadBuilderBase<T extends Payload = Payload<AnyObject>, O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {
-    readonly options: O;
-    protected _fields?: WithoutMeta<WithoutSchema<T>>;
-    protected _meta?: WithOnlyClientMeta<T>;
-    protected _schema: Schema;
-    constructor(options: O);
-    static dataHashableFields<T extends Payload>(schema: Schema, payload: WithoutSchema<T>): Promisable<WithoutMeta<T>>;
-    static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>;
-    static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[];
-    static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>;
-    static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[];
-    static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>;
-    static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[];
-    static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>;
-    static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[];
-    dataHashableFields(): Promise<import("@xylabs/object").DeepOmitStartsWith<import("@xylabs/object").DeepOmitStartsWith<T, "_">, "$">>;
-    fields(fields: WithoutMeta<WithoutSchema<T>>): this;
-    meta(meta: WithOnlyClientMeta<T>): this;
-    schema(value: Schema): void;
-}
-//# sourceMappingURL=BuilderBase.d.ts.map

package/dist/neutral/BuilderBase.d.ts.map DELETED Viewed

@@ -1 +0,0 @@

package/dist/node/BuilderBase.d.ts DELETED Viewed

@@ -1,26 +0,0 @@
-import type { AnyObject, EmptyObject } from '@xylabs/object';
-import type { Promisable } from '@xylabs/promise';
-import type { Payload, Schema, WithOnlyClientMeta, WithOptionalSchema, WithoutClientMeta, WithoutMeta, WithoutPrivateStorageMeta, WithoutSchema, WithoutStorageMeta } from '@xyo-network/payload-model';
-import type { PayloadBuilderOptions } from './Options.ts';
-export declare const omitSchema: <T extends WithOptionalSchema>(payload: T) => WithoutSchema<T>;
-export declare class PayloadBuilderBase<T extends Payload = Payload<AnyObject>, O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {
-    readonly options: O;
-    protected _fields?: WithoutMeta<WithoutSchema<T>>;
-    protected _meta?: WithOnlyClientMeta<T>;
-    protected _schema: Schema;
-    constructor(options: O);
-    static dataHashableFields<T extends Payload>(schema: Schema, payload: WithoutSchema<T>): Promisable<WithoutMeta<T>>;
-    static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>;
-    static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[];
-    static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>;
-    static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[];
-    static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>;
-    static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[];
-    static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>;
-    static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[];
-    dataHashableFields(): Promise<import("@xylabs/object").DeepOmitStartsWith<import("@xylabs/object").DeepOmitStartsWith<T, "_">, "$">>;
-    fields(fields: WithoutMeta<WithoutSchema<T>>): this;
-    meta(meta: WithOnlyClientMeta<T>): this;
-    schema(value: Schema): void;
-}
-//# sourceMappingURL=BuilderBase.d.ts.map

package/dist/node/BuilderBase.d.ts.map DELETED Viewed

@@ -1 +0,0 @@

package/src/BuilderBase.ts DELETED Viewed

@@ -1,109 +0,0 @@
-import { assertEx } from '@xylabs/assert'
-import type { AnyObject, EmptyObject } from '@xylabs/object'
-import {
-  isJsonObject, omitByPrefix, pickByPrefix, toJson,
-} from '@xylabs/object'
-import type { Promisable } from '@xylabs/promise'
-import { removeEmptyFields } from '@xyo-network/hash'
-import type {
-  Payload, Schema,
-  WithOnlyClientMeta,
-  WithOptionalSchema,
-  WithoutClientMeta,
-  WithoutMeta,
-  WithoutPrivateStorageMeta,
-  WithoutSchema,
-  WithoutStorageMeta,
-} from '@xyo-network/payload-model'
-import type { PayloadBuilderOptions } from './Options.ts'
-export const omitSchema = <T extends WithOptionalSchema>(payload: T): WithoutSchema<T> => {
-  const result = structuredClone(payload)
-  delete result.schema
-  return result
-}
-export class PayloadBuilderBase<T extends Payload = Payload<AnyObject>,
-  O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {
-  protected _fields?: WithoutMeta<WithoutSchema<T>>
-  protected _meta?: WithOnlyClientMeta<T>
-  protected _schema: Schema
-  constructor(readonly options: O) {
-    const { schema, fields } = options
-    this._schema = schema
-    if (fields) {
-      this.fields(fields)
-    }
-  }
-  static dataHashableFields<T extends Payload>(
-    schema: Schema,
-    payload: WithoutSchema<T>,
-  ): 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 WithoutMeta<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))
-      : omitByPrefix(payloads, '$', maxDepth)
-  }
-  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)
-      ? payloads.map(payload => this.omitMeta(payload, maxDepth))
-      : this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth) as unknown as WithoutMeta<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))
-      : omitByPrefix(payloads, '__', maxDepth)
-  }
-  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))
-      : omitByPrefix(payloads, '_', maxDepth)
-  }
-  async dataHashableFields() {
-    return await PayloadBuilderBase.dataHashableFields(
-      assertEx(this._schema, () => 'Payload: Missing Schema'),
-      // TODO: Add verification that required fields are present
-      this._fields as WithoutSchema<T>,
-    )
-  }
-  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
-  }
-  meta(meta: WithOnlyClientMeta<T>) {
-    // we need to do the cast here since ts seems to not like nested, yet same, generics
-    this._meta = pickByPrefix(meta, '$') as WithOnlyClientMeta<T>
-    return this
-  }
-  schema(value: Schema) {
-    this._schema = value
-  }
-}