@xyo-network/payload-model 4.0.3 → 4.1.0

package/{dist/types → build/neutral}/PayloadBundle.d.ts

@@ -9,5 +9,5 @@ export interface PayloadBundleFields<T extends Payload = Payload> {
 export type PayloadBundle = Payload<PayloadBundleFields, PayloadBundleSchema>;
 export declare const isPayloadBundle: (x?: unknown | null) => x is PayloadBundle;
 export declare const asPayloadBundle: import("@xylabs/object").AsTypeFunction<PayloadBundle>;
-export declare const asOptionalPayloadBundle: (value: import(".store/@xylabs-promise-npm-4.13.4-2506103e58/package").AnyNonPromise) => PayloadBundle | undefined;
+export declare const asOptionalPayloadBundle: (value: import(".store/@xylabs-promise-npm-4.13.15-8bdb7d384b/package").AnyNonPromise) => PayloadBundle | undefined;
 //# sourceMappingURL=PayloadBundle.d.ts.map

package/{dist/types → build/neutral}/PayloadBundle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PayloadBundle.d.ts","sourceRoot":"","sources":["../../src/PayloadBundle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAIvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAG3C,eAAO,MAAM,mBAAmB,EAAG,4BAAqC,CAAA;AACxE,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAA;AAE5D,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO;IAC9D,QAAQ,EAAE,CAAC,EAAE,CAAA;IACb,IAAI,EAAE,IAAI,CAAA;CACX;AAED,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAA;AAE7E,eAAO,MAAM,eAAe,4CAA4D,CAAA;AAExF,eAAO,MAAM,eAAe,wDAA0C,CAAA;AACtE,eAAO,MAAM,uBAAuB,oHAAkD,CAAA"}
+{"version":3,"file":"PayloadBundle.d.ts","sourceRoot":"","sources":["../../src/PayloadBundle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAIvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAG3C,eAAO,MAAM,mBAAmB,EAAG,4BAAqC,CAAA;AACxE,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAA;AAE5D,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO;IAC9D,QAAQ,EAAE,CAAC,EAAE,CAAA;IACb,IAAI,EAAE,IAAI,CAAA;CACX;AAED,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAA;AAE7E,eAAO,MAAM,eAAe,4CAA4D,CAAA;AAExF,eAAO,MAAM,eAAe,wDAA0C,CAAA;AACtE,eAAO,MAAM,uBAAuB,qHAAkD,CAAA"}

package/{dist/types → build/neutral}/StorageMeta/DataHash.d.ts

@@ -7,5 +7,5 @@ export type WithDataHashStorageMeta<T extends Payload = Payload> = T & DataHashS
 export type WithPartialDataHashStorageMeta<T extends Payload = Payload> = Partial<WithDataHashStorageMeta<T>>;
 export declare const isDataHashStorageMeta: (value: unknown) => value is DataHashStorageMeta;
 export declare const asDataHashStorageMeta: import("@xylabs/object").AsTypeFunction<DataHashStorageMeta>;
-export declare const asOptionalDataHashStorageMeta: (value: import(".store/@xylabs-promise-npm-4.13.4-2506103e58/package").AnyNonPromise) => DataHashStorageMeta | undefined;
+export declare const asOptionalDataHashStorageMeta: (value: import(".store/@xylabs-promise-npm-4.13.15-8bdb7d384b/package").AnyNonPromise) => DataHashStorageMeta | undefined;
 //# sourceMappingURL=DataHash.d.ts.map

package/{dist/types → build/neutral}/StorageMeta/DataHash.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DataHash.d.ts","sourceRoot":"","sources":["../../../src/StorageMeta/DataHash.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAIvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAE5C,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,mBAAmB,CAAA;AAC1F,MAAM,MAAM,8BAA8B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAA;AAE7G,eAAO,MAAM,qBAAqB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,mBAE/D,CAAA;AAED,eAAO,MAAM,qBAAqB,8DAAqE,CAAA;AACvG,eAAO,MAAM,6BAA6B,0HAA6E,CAAA"}
+{"version":3,"file":"DataHash.d.ts","sourceRoot":"","sources":["../../../src/StorageMeta/DataHash.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAIvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAE5C,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,mBAAmB,CAAA;AAC1F,MAAM,MAAM,8BAA8B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAA;AAE7G,eAAO,MAAM,qBAAqB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,mBAE/D,CAAA;AAED,eAAO,MAAM,qBAAqB,8DAAqE,CAAA;AACvG,eAAO,MAAM,6BAA6B,2HAA6E,CAAA"}

package/{dist/types → build/neutral}/StorageMeta/Hash.d.ts

@@ -8,5 +8,5 @@ export type WithHashStorageMeta<T extends Payload = Payload> = T & HashStorageMe
 export type WithPartialHashStorageMeta<T extends Payload = Payload> = Partial<WithHashStorageMeta<T>>;
 export declare const isHashStorageMeta: (value: unknown) => value is HashStorageMeta;
 export declare const asHashStorageMeta: import("@xylabs/object").AsTypeFunction<HashStorageMeta>;
-export declare const asOptionalHashStorageMeta: (value: import(".store/@xylabs-promise-npm-4.13.4-2506103e58/package").AnyNonPromise) => HashStorageMeta | undefined;
+export declare const asOptionalHashStorageMeta: (value: import(".store/@xylabs-promise-npm-4.13.15-8bdb7d384b/package").AnyNonPromise) => HashStorageMeta | undefined;
 //# sourceMappingURL=Hash.d.ts.map

package/{dist/types → build/neutral}/StorageMeta/Hash.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Hash.d.ts","sourceRoot":"","sources":["../../../src/StorageMeta/Hash.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAIvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAGxD,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IAC1D,KAAK,EAAE,IAAI,CAAA;CACZ;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,eAAe,CAAA;AAClF,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAA;AAErG,eAAO,MAAM,iBAAiB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,eAE3D,CAAA;AAED,eAAO,MAAM,iBAAiB,0DAA6D,CAAA;AAC3F,eAAO,MAAM,yBAAyB,sHAAqE,CAAA"}
+{"version":3,"file":"Hash.d.ts","sourceRoot":"","sources":["../../../src/StorageMeta/Hash.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAIvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAGxD,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IAC1D,KAAK,EAAE,IAAI,CAAA;CACZ;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,eAAe,CAAA;AAClF,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAA;AAErG,eAAO,MAAM,iBAAiB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,eAE3D,CAAA;AAED,eAAO,MAAM,iBAAiB,0DAA6D,CAAA;AAC3F,eAAO,MAAM,yBAAyB,uHAAqE,CAAA"}

package/{dist/types → build/neutral}/StorageMeta/Sequence.d.ts

@@ -7,5 +7,5 @@ export type WithSequenceStorageMeta<T extends Payload = Payload> = T & SequenceS
 export type WithPartialSequenceStorageMeta<T extends Payload = Payload> = Partial<WithSequenceStorageMeta<T>>;
 export declare const isSequenceStorageMeta: (value: unknown) => value is SequenceStorageMeta;
 export declare const asSequenceStorageMeta: import("@xylabs/object").AsTypeFunction<SequenceStorageMeta>;
-export declare const asOptionalSequenceStorageMeta: (value: import(".store/@xylabs-promise-npm-4.13.4-2506103e58/package").AnyNonPromise) => SequenceStorageMeta | undefined;
+export declare const asOptionalSequenceStorageMeta: (value: import(".store/@xylabs-promise-npm-4.13.15-8bdb7d384b/package").AnyNonPromise) => SequenceStorageMeta | undefined;
 //# sourceMappingURL=Sequence.d.ts.map

package/{dist/types → build/neutral}/StorageMeta/Sequence.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Sequence.d.ts","sourceRoot":"","sources":["../../../src/StorageMeta/Sequence.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAEnD,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,QAAQ,CAAA;CACpB;AAED,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,mBAAmB,CAAA;AAC1F,MAAM,MAAM,8BAA8B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAA;AAE7G,eAAO,MAAM,qBAAqB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,mBAE/D,CAAA;AAED,eAAO,MAAM,qBAAqB,8DAAgD,CAAA;AAClF,eAAO,MAAM,6BAA6B,0HAAwD,CAAA"}
+{"version":3,"file":"Sequence.d.ts","sourceRoot":"","sources":["../../../src/StorageMeta/Sequence.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAEnD,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,QAAQ,CAAA;CACpB;AAED,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,mBAAmB,CAAA;AAC1F,MAAM,MAAM,8BAA8B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAA;AAE7G,eAAO,MAAM,qBAAqB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,mBAE/D,CAAA;AAED,eAAO,MAAM,qBAAqB,8DAAgD,CAAA;AAClF,eAAO,MAAM,6BAA6B,2HAAwD,CAAA"}

package/{dist/types → build/neutral}/StorageMeta/StorageMeta.d.ts

@@ -7,5 +7,5 @@ export type WithStorageMeta<T extends Payload = Payload> = T & StorageMeta;
 export type WithPartialStorageMeta<T extends Payload = Payload> = T & Partial<StorageMeta>;
 export declare const isStorageMeta: (value: unknown) => value is StorageMeta;
 export declare const asStorageMeta: import("@xylabs/object").AsTypeFunction<StorageMeta>;
-export declare const asOptionalStorageMeta: (value: import(".store/@xylabs-promise-npm-4.13.4-2506103e58/package").AnyNonPromise) => StorageMeta | undefined;
+export declare const asOptionalStorageMeta: (value: import(".store/@xylabs-promise-npm-4.13.15-8bdb7d384b/package").AnyNonPromise) => StorageMeta | undefined;
 //# sourceMappingURL=StorageMeta.d.ts.map

package/{dist/types → build/neutral}/StorageMeta/StorageMeta.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StorageMeta.d.ts","sourceRoot":"","sources":["../../../src/StorageMeta/StorageMeta.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAEhD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAGxD,MAAM,WAAW,WAAY,SAAQ,mBAAmB,EAAE,eAAe;CAAG;AAE5E,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,WAAW,CAAA;AAC1E,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AAE1F,eAAO,MAAM,aAAa,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,WAEvD,CAAA;AAED,eAAO,MAAM,aAAa,sDAAwC,CAAA;AAClE,eAAO,MAAM,qBAAqB,kHAAgD,CAAA"}
+{"version":3,"file":"StorageMeta.d.ts","sourceRoot":"","sources":["../../../src/StorageMeta/StorageMeta.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAEhD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAGxD,MAAM,WAAW,WAAY,SAAQ,mBAAmB,EAAE,eAAe;CAAG;AAE5E,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,WAAW,CAAA;AAC1E,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AAE1F,eAAO,MAAM,aAAa,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,WAEvD,CAAA;AAED,eAAO,MAAM,aAAa,sDAAwC,CAAA;AAClE,eAAO,MAAM,qBAAqB,mHAAgD,CAAA"}

package/dist/neutral/index.d.ts

@@ -0,0 +1,316 @@
+import { Hash, Address, Hex } from '@xylabs/hex';
+import * as _xylabs_object from '@xylabs/object';
+import { EmptyObject, DeepRestrictToStringKeys, DeepOmitStartsWith, DeepPickStartsWith, JsonObject, JsonValue, Compare } from '@xylabs/object';
+import * as _store__xylabs_promise_npm_4_13_15_8bdb7d384b_package from '.store/@xylabs-promise-npm-4.13.15-8bdb7d384b/package';
+
+declare const SchemaRegEx: "^(?:[a-z0-9]+.)*[a-z0-9]+$";
+/** Schema type in Javascript is a string */
+type Schema = string;
+declare const PayloadSchema: "network.xyo.payload";
+type PayloadSchema = typeof PayloadSchema;
+declare const isSchema: (value: unknown) => value is Schema;
+declare const asSchema: _xylabs_object.AsTypeFunction<string>;
+/** Schema fields for a Payload */
+interface SchemaFields extends EmptyObject {
+    /**  Schema of the object */
+    schema: Schema;
+}
+/** Add the Schema Fields to an object */
+type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields;
+
+interface SchemaField<T extends Schema = Schema> {
+    schema: T;
+}
+/** Additional fields for a payload */
+interface PayloadFields extends SchemaField {
+}
+interface SourcesMetaField {
+    $sources: Hash[];
+}
+interface PayloadMetaFields extends SourcesMetaField {
+}
+type WithPayload<T extends EmptyObject | void = void> = DeepRestrictToStringKeys<WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>>;
+/** Base Type for Payloads */
+type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = (T extends WithSchema ? S extends Schema ? WithPayload<Omit<T, 'schema'> & {
+    schema: S;
+}> : WithPayload<T> : T extends object ? S extends Schema ? WithPayload<T & {
+    schema: S;
+}> : WithPayload<T & PayloadFields> : WithPayload<{
+    schema: S extends Schema ? S : Schema;
+}>) & Partial<PayloadMetaFields>;
+type OverridablePayload<T extends Payload> = WithoutMeta<Omit<T, 'schema'> & PayloadFields>;
+type WithSources<T extends EmptyObject> = T & SourcesMetaField;
+/** @deprecated optional $sources are now optional in all Payloads */
+type WithOptionalSources<T extends EmptyObject> = (T & SourcesMetaField) | T;
+type PayloadWithSources<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithSources<Payload<T, S>>;
+/** @deprecated optional $sources are now optional in all Payloads */
+type PayloadWithOptionalSources<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithOptionalSources<Payload<T, S>>;
+type WithAnySchema<T extends Payload> = OverridablePayload<T>;
+type WithoutClientMeta<T extends EmptyObject> = DeepOmitStartsWith<T, '$'>;
+type WithoutStorageMeta<T extends EmptyObject> = DeepOmitStartsWith<T, '_'>;
+type WithoutPrivateStorageMeta<T extends EmptyObject> = DeepOmitStartsWith<T, '__'>;
+type WithoutMeta<T extends EmptyObject> = WithoutClientMeta<WithoutStorageMeta<T>>;
+type WithoutSchema<T extends WithOptionalSchema<Payload>> = Omit<T, 'schema'>;
+type WithOptionalSchema<T extends EmptyObject = EmptyObject> = WithoutSchema<T> & Partial<T & SchemaField>;
+type WithOnlyClientMeta<T extends EmptyObject> = DeepPickStartsWith<T, '$'>;
+type AnyPayload = Payload<JsonObject, Schema>;
+
+declare const ModuleErrorSchema: "network.xyo.error.module";
+type ModuleErrorSchema = typeof ModuleErrorSchema;
+type ModuleError = Payload<{
+    details?: JsonValue;
+    message?: string;
+    name?: string;
+    query?: Hash;
+    schema: ModuleErrorSchema;
+}>;
+declare const isModuleError: (x?: unknown | null) => x is ModuleError;
+
+declare const isAnyPayload: (value: unknown) => value is Payload;
+declare const asAnyPayload: _xylabs_object.AsTypeFunction<Payload>;
+declare const isPayload: <T extends Payload>(schema: string[]) => (value: unknown) => value is T;
+declare const asPayload: <T extends Payload>(schema: string[]) => _xylabs_object.AsTypeFunction<T>;
+
+declare function isPayloadOfSchemaType<T extends Payload | never = never>(schema: T['schema']): (x?: unknown | null) => x is T;
+declare const isPayloadOfSchemaTypeWithSources: <T extends Payload | never = never>(schema: T["schema"]) => (x?: unknown | null) => x is WithSources<T>;
+declare const notPayloadOfSchemaType: <T extends Payload | never = never>(schema: T["schema"]) => (x?: unknown | null) => x is T;
+
+declare const PayloadBundleSchema: "network.xyo.payload.bundle";
+type PayloadBundleSchema = typeof PayloadBundleSchema;
+interface PayloadBundleFields<T extends Payload = Payload> {
+    payloads: T[];
+    root: Hash;
+}
+type PayloadBundle = Payload<PayloadBundleFields, PayloadBundleSchema>;
+declare const isPayloadBundle: (x?: unknown | null) => x is PayloadBundle;
+declare const asPayloadBundle: _xylabs_object.AsTypeFunction<PayloadBundle>;
+declare const asOptionalPayloadBundle: (value: _store__xylabs_promise_npm_4_13_15_8bdb7d384b_package.AnyNonPromise) => PayloadBundle | undefined;
+
+interface PayloadFindFilter {
+    limit?: number;
+    order?: 'desc' | 'asc';
+    schema?: string | string[];
+}
+
+interface PayloadHashMap<TPayload extends Payload = Payload, TId extends string | number | symbol = Hash> {
+    dataHash: Record<TId, TId>;
+    hash: Record<TId, TPayload>;
+}
+
+declare const PayloadSetSchema: "network.xyo.payload.set";
+type PayloadSetSchema = typeof PayloadSetSchema;
+
+interface PayloadSet {
+    optional?: Record<string, number>;
+    required?: Record<string, number>;
+}
+type PayloadSetPayload = Payload<PayloadSet, PayloadSetSchema>;
+
+/**
+ * A function that validates the supplied payload synchronously
+ */
+type SyncPayloadValidationFunction<T extends Payload = Payload> = (payload: T) => boolean;
+/**
+ * A function that validates the supplied payload asynchronously
+ */
+type AsyncPayloadValidationFunction<T extends Payload = Payload> = (payload: T) => Promise<boolean>;
+/**
+ * A function that validates the supplied payload
+ */
+type PayloadValidationFunction<T extends Payload = Payload> = SyncPayloadValidationFunction<T> | AsyncPayloadValidationFunction<T>;
+
+/**
+ * Type corresponding to the properties of a payload
+ */
+type PayloadProperty<
+/**
+ * The type of payload
+ */
+T extends Payload = Payload> = keyof T;
+/**
+ * Type corresponding to the payload values
+ */
+type PayloadValue<
+/**
+ * The type of payload
+ */
+T extends Payload = Payload, 
+/**
+ * The property of the payload to select
+ */
+Key extends PayloadProperty<T> = PayloadProperty<T>> = T[Key];
+/**
+ * An expressions that selects a property value from the payload
+ */
+type PayloadValueExpression<
+/**
+ * The type of payload
+ */
+T extends Payload = Payload, 
+/**
+ * The property of the payload to select
+ */
+Key extends PayloadProperty<T> = PayloadProperty<T>, 
+/**
+ * The type of the selected property's value
+ */
+TValue = PayloadValue<T, Key>> = (payload: T) => TValue;
+
+interface QueryFields {
+    /** @field The addresses of the intended handlers */
+    address?: Address | Address[];
+    /** @field The maximum XYO that can be spent executing the query */
+    budget?: number;
+    /** @field The frequency on which this query can be rerun */
+    maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
+    /** @field The starting point for the bidding on the query */
+    minBid?: number;
+}
+type Query<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = Payload<T extends void ? QueryFields : T & QueryFields, S extends void ? T extends WithSchema ? T['schema'] : T extends void ? Schema : void : S>;
+
+interface DataHashStorageMeta {
+    _dataHash: Hash;
+}
+type WithDataHashStorageMeta<T extends Payload = Payload> = T & DataHashStorageMeta;
+type WithPartialDataHashStorageMeta<T extends Payload = Payload> = Partial<WithDataHashStorageMeta<T>>;
+declare const isDataHashStorageMeta: (value: unknown) => value is DataHashStorageMeta;
+declare const asDataHashStorageMeta: _xylabs_object.AsTypeFunction<DataHashStorageMeta>;
+declare const asOptionalDataHashStorageMeta: (value: _store__xylabs_promise_npm_4_13_15_8bdb7d384b_package.AnyNonPromise) => DataHashStorageMeta | undefined;
+
+interface HashStorageMeta extends DataHashStorageMeta {
+    _hash: Hash;
+}
+type WithHashStorageMeta<T extends Payload = Payload> = T & HashStorageMeta;
+type WithPartialHashStorageMeta<T extends Payload = Payload> = Partial<WithHashStorageMeta<T>>;
+declare const isHashStorageMeta: (value: unknown) => value is HashStorageMeta;
+declare const asHashStorageMeta: _xylabs_object.AsTypeFunction<HashStorageMeta>;
+declare const asOptionalHashStorageMeta: (value: _store__xylabs_promise_npm_4_13_15_8bdb7d384b_package.AnyNonPromise) => HashStorageMeta | undefined;
+
+declare const SequenceComparer: {
+    local: Compare<Lowercase<string>>;
+    qualified: Compare<Lowercase<string>>;
+};
+
+type LocalSequence = Hex & Exclude<string, 'reserved-local-sequence-value'>;
+type QualifiedSequence = Hex & Exclude<string, 'reserved-qualified-sequence-value'>;
+type Sequence = LocalSequence | QualifiedSequence;
+type Epoch = Hex & Exclude<string, 'reserved-epoch-sequence-value'>;
+declare const isEpoch: (value: unknown) => value is Epoch;
+type Nonce = Hex & Exclude<string, 'reserved-nonce-sequence-value'>;
+declare const isNonce: (value: unknown) => value is Epoch;
+declare const isLocalSequence: (value: unknown) => value is Sequence;
+declare const isQualifiedSequence: (value: unknown) => value is Sequence;
+declare const isSequence: (value: unknown) => value is Sequence;
+declare const SequenceNonceComponentLengths: {
+    nonceIndexBytes: number;
+    nonceHashBytes: number;
+};
+declare const SequenceComponentLengths: {
+    epochBytes: number;
+    nonceBytes: number;
+    addressBytes: number;
+    nonceIndexBytes: number;
+    nonceHashBytes: number;
+};
+declare const SequenceComponentMinMax: {
+    minEpoch: Epoch;
+    maxEpoch: Epoch;
+    minNonce: Nonce;
+    maxNonce: Nonce;
+    minAddress: Address;
+    maxAddress: Address;
+};
+declare const LocalSequenceConstants: {
+    localSequenceBytes: number;
+    minLocalSequence: LocalSequence;
+    maxLocalSequence: LocalSequence;
+    minEpoch: Epoch;
+    maxEpoch: Epoch;
+    minNonce: Nonce;
+    maxNonce: Nonce;
+    minAddress: Address;
+    maxAddress: Address;
+    epochBytes: number;
+    nonceBytes: number;
+    addressBytes: number;
+    nonceIndexBytes: number;
+    nonceHashBytes: number;
+};
+declare const QualifiedSequenceConstants: {
+    qualifiedSequenceBytes: number;
+    minQualifiedSequence: QualifiedSequence;
+    maxQualifiedSequence: QualifiedSequence;
+};
+declare const SequenceConstants: {
+    qualifiedSequenceBytes: number;
+    minQualifiedSequence: QualifiedSequence;
+    maxQualifiedSequence: QualifiedSequence;
+    localSequenceBytes: number;
+    minLocalSequence: LocalSequence;
+    maxLocalSequence: LocalSequence;
+    minEpoch: Epoch;
+    maxEpoch: Epoch;
+    minNonce: Nonce;
+    maxNonce: Nonce;
+    minAddress: Address;
+    maxAddress: Address;
+    epochBytes: number;
+    nonceBytes: number;
+    addressBytes: number;
+    nonceIndexBytes: number;
+    nonceHashBytes: number;
+};
+
+declare class SequenceParser {
+    protected static privateConstructorKey: string;
+    private readonly data;
+    protected constructor(privateConstructorKey: string, hex: Hex);
+    get address(): Address;
+    get epoch(): Epoch;
+    get localSequence(): LocalSequence;
+    get nonce(): Nonce;
+    get qualifiedSequence(): QualifiedSequence;
+    static from(sequence: Sequence, address?: Address): SequenceParser;
+    static from(timestamp: Hex, hash: Hash, address?: Address): SequenceParser;
+    static from(timestamp: Hex, hash: Hex, address?: Address): SequenceParser;
+    static from(timestamp: Hex, nonce: Nonce, address?: Address): SequenceParser;
+    static from(timestamp: Hex, hash: Hash, index?: number, address?: Address): SequenceParser;
+    static from(timestamp: Hex, hash: Hex, index?: number, address?: Address): SequenceParser;
+    static from(timestamp: Hex, nonce: Nonce, index?: number, address?: Address): SequenceParser;
+    static from(timestamp: number, hash: Hash, address?: Address): SequenceParser;
+    static from(timestamp: number, hash: Hex, address?: Address): SequenceParser;
+    static from(timestamp: number, nonce: Nonce, address?: Address): SequenceParser;
+    static from(timestamp: number, hash: Hash, index?: number, address?: Address): SequenceParser;
+    static from(timestamp: number, hash: Hex, index?: number, address?: Address): SequenceParser;
+    static from(timestamp: number, nonce: Nonce, index?: number, address?: Address): SequenceParser;
+    static parse(value: Hex | string | ArrayBufferLike): SequenceParser;
+    static toEpoch(value: number | Hex | Epoch): Epoch;
+    static toNonce(value: Hash | Hex, index?: number): Nonce;
+}
+
+interface SequenceStorageMeta {
+    _sequence: Sequence;
+}
+type WithSequenceStorageMeta<T extends Payload = Payload> = T & SequenceStorageMeta;
+type WithPartialSequenceStorageMeta<T extends Payload = Payload> = Partial<WithSequenceStorageMeta<T>>;
+declare const isSequenceStorageMeta: (value: unknown) => value is SequenceStorageMeta;
+declare const asSequenceStorageMeta: _xylabs_object.AsTypeFunction<SequenceStorageMeta>;
+declare const asOptionalSequenceStorageMeta: (value: _store__xylabs_promise_npm_4_13_15_8bdb7d384b_package.AnyNonPromise) => SequenceStorageMeta | undefined;
+
+interface StorageMeta extends SequenceStorageMeta, HashStorageMeta {
+}
+type WithStorageMeta<T extends Payload = Payload> = T & StorageMeta;
+type WithPartialStorageMeta<T extends Payload = Payload> = T & Partial<StorageMeta>;
+declare const isStorageMeta: (value: unknown) => value is StorageMeta;
+declare const asStorageMeta: _xylabs_object.AsTypeFunction<StorageMeta>;
+declare const asOptionalStorageMeta: (value: _store__xylabs_promise_npm_4_13_15_8bdb7d384b_package.AnyNonPromise) => StorageMeta | undefined;
+
+/** Object with a timestamp */
+interface Timestamp {
+    timestamp: number;
+}
+/** Add a timestamp field to any object */
+type WithTimestamp<T extends EmptyObject = EmptyObject> = T & Timestamp;
+
+export { LocalSequenceConstants, ModuleErrorSchema, PayloadBundleSchema, PayloadSchema, PayloadSetSchema, QualifiedSequenceConstants, SchemaRegEx, SequenceComparer, SequenceComponentLengths, SequenceComponentMinMax, SequenceConstants, SequenceNonceComponentLengths, SequenceParser, asAnyPayload, asDataHashStorageMeta, asHashStorageMeta, asOptionalDataHashStorageMeta, asOptionalHashStorageMeta, asOptionalPayloadBundle, asOptionalSequenceStorageMeta, asOptionalStorageMeta, asPayload, asPayloadBundle, asSchema, asSequenceStorageMeta, asStorageMeta, isAnyPayload, isDataHashStorageMeta, isEpoch, isHashStorageMeta, isLocalSequence, isModuleError, isNonce, isPayload, isPayloadBundle, isPayloadOfSchemaType, isPayloadOfSchemaTypeWithSources, isQualifiedSequence, isSchema, isSequence, isSequenceStorageMeta, isStorageMeta, notPayloadOfSchemaType };
+export type { AnyPayload, AsyncPayloadValidationFunction, DataHashStorageMeta, Epoch, HashStorageMeta, LocalSequence, ModuleError, Nonce, OverridablePayload, Payload, PayloadBundle, PayloadBundleFields, PayloadFields, PayloadFindFilter, PayloadHashMap, PayloadMetaFields, PayloadProperty, PayloadSet, PayloadSetPayload, PayloadValidationFunction, PayloadValue, PayloadValueExpression, PayloadWithOptionalSources, PayloadWithSources, QualifiedSequence, Query, QueryFields, Schema, SchemaField, SchemaFields, Sequence, SequenceStorageMeta, SourcesMetaField, StorageMeta, SyncPayloadValidationFunction, Timestamp, WithAnySchema, WithDataHashStorageMeta, WithHashStorageMeta, WithOnlyClientMeta, WithOptionalSchema, WithOptionalSources, WithPartialDataHashStorageMeta, WithPartialHashStorageMeta, WithPartialSequenceStorageMeta, WithPartialStorageMeta, WithPayload, WithSchema, WithSequenceStorageMeta, WithSources, WithStorageMeta, WithTimestamp, WithoutClientMeta, WithoutMeta, WithoutPrivateStorageMeta, WithoutSchema, WithoutStorageMeta };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/payload-model",
-  "version": "4.0.3",
+  "version": "4.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,23 +21,23 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/neutral/index.d.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/neutral/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/arraybuffer": "^4.13.4",
-    "@xylabs/assert": "^4.13.4",
-    "@xylabs/hex": "^4.13.4",
-    "@xylabs/object": "^4.13.4"
+    "@xylabs/arraybuffer": "^4.13.15",
+    "@xylabs/assert": "^4.13.15",
+    "@xylabs/hex": "^4.13.15",
+    "@xylabs/object": "^4.13.15"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.18",
-    "@xylabs/tsconfig": "^6.5.18",
-    "@xylabs/vitest-extended": "^4.13.4",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig": "^7.0.0-rc.20",
+    "@xylabs/vitest-extended": "^4.13.15",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },