@xyo-network/payload-model - npm Package Compare versions

Comparing version 3.3.0 to 3.3.1

dist/browser/isPayload.d.ts

@@ -6,6 +6,6 @@ import type { Payload } from './Payload.ts';
         schema: string;
-    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
+    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
     <TType extends {
         schema: string;
-    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
+    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
         schema: string;
@@ -16,5 +16,5 @@ } & import("./Payload.ts").PayloadFields>, config?: import("@xylabs/object").TypeCheckConfig): TType;
 export declare const asPayload: <T extends Payload>(schema: string[]) => {
-    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
-    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
+    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
+    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
 };
 //# sourceMappingURL=isPayload.d.ts.map

dist/browser/isPayloadWithHash.d.ts

 import type { WithMeta } from './Meta.ts';
 import type { Payload } from './Payload.ts';
+/**
+ * Return true if the value is a payload with the required meta fields
+ * @param value The value to check
+ * @returns True if the value is a payload with the required meta fields
+ */
 export declare const isWithHash: <T extends Payload>(value: T) => value is WithMeta<T>;
+/**
+ * Return true if the value is a payload with the required meta fields
+ * @param value The value to check
+ * @returns True if the value is a payload with the required meta fields
+ */
 export declare const isPayloadWithHash: <T extends Payload>(value: unknown) => value is WithMeta<T>;
 //# sourceMappingURL=isPayloadWithHash.d.ts.map

dist/browser/Payload.d.ts

 import type { Hash } from '@xylabs/hex';
 import type { EmptyObject, JsonObject } from '@xylabs/object';
 import type { Schema, WithSchema } from './Schema.ts';
+/** Meta fields for a payload - Either both $hash and $meta should exist or neither */
 export interface PayloadMetaFields<TAdditionalMeta extends EmptyObject | void = void> extends EmptyObject {
+    /** Hash of the body of the payload excluding the items in the $meta object */
     $hash: Hash;
+    /** Meta data that should be included in the main hash of the payload */
     $meta?: TAdditionalMeta extends void ? JsonObject : TAdditionalMeta;
 }
+/** Additional fields for a payload */
 export interface PayloadFields extends EmptyObject {
@@ -12,2 +16,3 @@ schema: Schema;
 export type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>;
+/** Base Type for Payloads */
 export type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema ? S extends Schema ? WithPayload<Omit<T, 'schema'> & {
@@ -19,3 +24,3 @@ schema: S;
     schema: Schema;
-} & PayloadFields> : {
+} & PayloadFields> : /* Either just S or neither S or T provided */ {
     schema: S extends Schema ? S : Schema;
@@ -22,0 +27,0 @@ } & PayloadFields;

dist/browser/PayloadValidationFunction.d.ts

 import type { Payload } from './Payload.ts';
+/**
+ * A function that validates the supplied payload synchronously
+ */
 export type SyncPayloadValidationFunction<T extends Payload = Payload> = (payload: T) => boolean;
+/**
+ * A function that validates the supplied payload asynchronously
+ */
 export type AsyncPayloadValidationFunction<T extends Payload = Payload> = (payload: T) => Promise<boolean>;
+/**
+ * A function that validates the supplied payload
+ */
 export type PayloadValidationFunction<T extends Payload = Payload> = SyncPayloadValidationFunction<T> | AsyncPayloadValidationFunction<T>;
 //# sourceMappingURL=PayloadValidationFunction.d.ts.map

dist/browser/PayloadValueExpression.d.ts

 import type { Payload } from './Payload.ts';
-export type PayloadProperty<T extends Payload = Payload> = keyof T;
-export type PayloadValue<T extends Payload = Payload, Key extends PayloadProperty<T> = PayloadProperty<T>> = T[Key];
-export type PayloadValueExpression<T extends Payload = Payload, Key extends PayloadProperty<T> = PayloadProperty<T>, TValue = PayloadValue<T, Key>> = (payload: T) => TValue;
+/**
+ * Type corresponding to the properties of a payload
+ */
+export type PayloadProperty<
+/**
+ * The type of payload
+ */
+T extends Payload = Payload> = keyof T;
+/**
+ * Type corresponding to the payload values
+ */
+export 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
+ */
+export 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;
 //# sourceMappingURL=PayloadValueExpression.d.ts.map

dist/browser/Query.d.ts

@@ -6,5 +6,9 @@ import type { Address } from '@xylabs/hex';
 export 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;
@@ -11,0 +15,0 @@ }

dist/browser/Schema.d.ts

 import type { EmptyObject } from '@xylabs/object';
+/** Schema type in Javascript is a string */
 export type Schema = string;
@@ -7,9 +8,12 @@ export declare const PayloadSchema: "network.xyo.payload";
 export declare const asSchema: {
-    <TType extends string>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
-    <TType extends string>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<string>, config?: import("@xylabs/object").TypeCheckConfig): TType;
+    <TType extends string>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
+    <TType extends string>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<string>, config?: import("@xylabs/object").TypeCheckConfig): TType;
 };
+/** Schema fields for a Payload */
 export interface SchemaFields extends EmptyObject {
+    /**  Schema of the object */
     schema: Schema;
 }
+/** Add the Schema Fields to an object */
 export type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields;
 //# sourceMappingURL=Schema.d.ts.map

dist/browser/Timestamp.d.ts

 import type { EmptyObject } from '@xylabs/object';
+/** Object with a timestamp */
 export interface Timestamp {
     timestamp: number;
 }
+/** Add a timestamp field to any object */
 export type WithTimestamp<T extends EmptyObject = EmptyObject> = T & Timestamp;
 //# sourceMappingURL=Timestamp.d.ts.map

dist/neutral/isPayload.d.ts

@@ -6,6 +6,6 @@ import type { Payload } from './Payload.ts';
         schema: string;
-    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
+    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
     <TType extends {
         schema: string;
-    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
+    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
         schema: string;
@@ -16,5 +16,5 @@ } & import("./Payload.ts").PayloadFields>, config?: import("@xylabs/object").TypeCheckConfig): TType;
 export declare const asPayload: <T extends Payload>(schema: string[]) => {
-    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
-    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
+    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
+    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
 };
 //# sourceMappingURL=isPayload.d.ts.map

dist/neutral/isPayloadWithHash.d.ts

 import type { WithMeta } from './Meta.ts';
 import type { Payload } from './Payload.ts';
+/**
+ * Return true if the value is a payload with the required meta fields
+ * @param value The value to check
+ * @returns True if the value is a payload with the required meta fields
+ */
 export declare const isWithHash: <T extends Payload>(value: T) => value is WithMeta<T>;
+/**
+ * Return true if the value is a payload with the required meta fields
+ * @param value The value to check
+ * @returns True if the value is a payload with the required meta fields
+ */
 export declare const isPayloadWithHash: <T extends Payload>(value: unknown) => value is WithMeta<T>;
 //# sourceMappingURL=isPayloadWithHash.d.ts.map

dist/neutral/Payload.d.ts

 import type { Hash } from '@xylabs/hex';
 import type { EmptyObject, JsonObject } from '@xylabs/object';
 import type { Schema, WithSchema } from './Schema.ts';
+/** Meta fields for a payload - Either both $hash and $meta should exist or neither */
 export interface PayloadMetaFields<TAdditionalMeta extends EmptyObject | void = void> extends EmptyObject {
+    /** Hash of the body of the payload excluding the items in the $meta object */
     $hash: Hash;
+    /** Meta data that should be included in the main hash of the payload */
     $meta?: TAdditionalMeta extends void ? JsonObject : TAdditionalMeta;
 }
+/** Additional fields for a payload */
 export interface PayloadFields extends EmptyObject {
@@ -12,2 +16,3 @@ schema: Schema;
 export type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>;
+/** Base Type for Payloads */
 export type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema ? S extends Schema ? WithPayload<Omit<T, 'schema'> & {
@@ -19,3 +24,3 @@ schema: S;
     schema: Schema;
-} & PayloadFields> : {
+} & PayloadFields> : /* Either just S or neither S or T provided */ {
     schema: S extends Schema ? S : Schema;
@@ -22,0 +27,0 @@ } & PayloadFields;

dist/neutral/PayloadValidationFunction.d.ts

 import type { Payload } from './Payload.ts';
+/**
+ * A function that validates the supplied payload synchronously
+ */
 export type SyncPayloadValidationFunction<T extends Payload = Payload> = (payload: T) => boolean;
+/**
+ * A function that validates the supplied payload asynchronously
+ */
 export type AsyncPayloadValidationFunction<T extends Payload = Payload> = (payload: T) => Promise<boolean>;
+/**
+ * A function that validates the supplied payload
+ */
 export type PayloadValidationFunction<T extends Payload = Payload> = SyncPayloadValidationFunction<T> | AsyncPayloadValidationFunction<T>;
 //# sourceMappingURL=PayloadValidationFunction.d.ts.map

dist/neutral/PayloadValueExpression.d.ts

 import type { Payload } from './Payload.ts';
-export type PayloadProperty<T extends Payload = Payload> = keyof T;
-export type PayloadValue<T extends Payload = Payload, Key extends PayloadProperty<T> = PayloadProperty<T>> = T[Key];
-export type PayloadValueExpression<T extends Payload = Payload, Key extends PayloadProperty<T> = PayloadProperty<T>, TValue = PayloadValue<T, Key>> = (payload: T) => TValue;
+/**
+ * Type corresponding to the properties of a payload
+ */
+export type PayloadProperty<
+/**
+ * The type of payload
+ */
+T extends Payload = Payload> = keyof T;
+/**
+ * Type corresponding to the payload values
+ */
+export 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
+ */
+export 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;
 //# sourceMappingURL=PayloadValueExpression.d.ts.map

dist/neutral/Query.d.ts

@@ -6,5 +6,9 @@ import type { Address } from '@xylabs/hex';
 export 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;
@@ -11,0 +15,0 @@ }

dist/neutral/Schema.d.ts

 import type { EmptyObject } from '@xylabs/object';
+/** Schema type in Javascript is a string */
 export type Schema = string;
@@ -7,9 +8,12 @@ export declare const PayloadSchema: "network.xyo.payload";
 export declare const asSchema: {
-    <TType extends string>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
-    <TType extends string>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<string>, config?: import("@xylabs/object").TypeCheckConfig): TType;
+    <TType extends string>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
+    <TType extends string>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<string>, config?: import("@xylabs/object").TypeCheckConfig): TType;
 };
+/** Schema fields for a Payload */
 export interface SchemaFields extends EmptyObject {
+    /**  Schema of the object */
     schema: Schema;
 }
+/** Add the Schema Fields to an object */
 export type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields;
 //# sourceMappingURL=Schema.d.ts.map

dist/neutral/Timestamp.d.ts

 import type { EmptyObject } from '@xylabs/object';
+/** Object with a timestamp */
 export interface Timestamp {
     timestamp: number;
 }
+/** Add a timestamp field to any object */
 export type WithTimestamp<T extends EmptyObject = EmptyObject> = T & Timestamp;
 //# sourceMappingURL=Timestamp.d.ts.map

dist/node/isPayload.d.ts

@@ -6,6 +6,6 @@ import type { Payload } from './Payload.ts';
         schema: string;
-    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
+    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
     <TType extends {
         schema: string;
-    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
+    } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
         schema: string;
@@ -16,5 +16,5 @@ } & import("./Payload.ts").PayloadFields>, config?: import("@xylabs/object").TypeCheckConfig): TType;
 export declare const asPayload: <T extends Payload>(schema: string[]) => {
-    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
-    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
+    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
+    <TType extends T>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
 };
 //# sourceMappingURL=isPayload.d.ts.map

dist/node/isPayloadWithHash.d.ts

 import type { WithMeta } from './Meta.ts';
 import type { Payload } from './Payload.ts';
+/**
+ * Return true if the value is a payload with the required meta fields
+ * @param value The value to check
+ * @returns True if the value is a payload with the required meta fields
+ */
 export declare const isWithHash: <T extends Payload>(value: T) => value is WithMeta<T>;
+/**
+ * Return true if the value is a payload with the required meta fields
+ * @param value The value to check
+ * @returns True if the value is a payload with the required meta fields
+ */
 export declare const isPayloadWithHash: <T extends Payload>(value: unknown) => value is WithMeta<T>;
 //# sourceMappingURL=isPayloadWithHash.d.ts.map

dist/node/Payload.d.ts

 import type { Hash } from '@xylabs/hex';
 import type { EmptyObject, JsonObject } from '@xylabs/object';
 import type { Schema, WithSchema } from './Schema.ts';
+/** Meta fields for a payload - Either both $hash and $meta should exist or neither */
 export interface PayloadMetaFields<TAdditionalMeta extends EmptyObject | void = void> extends EmptyObject {
+    /** Hash of the body of the payload excluding the items in the $meta object */
     $hash: Hash;
+    /** Meta data that should be included in the main hash of the payload */
     $meta?: TAdditionalMeta extends void ? JsonObject : TAdditionalMeta;
 }
+/** Additional fields for a payload */
 export interface PayloadFields extends EmptyObject {
@@ -12,2 +16,3 @@ schema: Schema;
 export type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>;
+/** Base Type for Payloads */
 export type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema ? S extends Schema ? WithPayload<Omit<T, 'schema'> & {
@@ -19,3 +24,3 @@ schema: S;
     schema: Schema;
-} & PayloadFields> : {
+} & PayloadFields> : /* Either just S or neither S or T provided */ {
     schema: S extends Schema ? S : Schema;
@@ -22,0 +27,0 @@ } & PayloadFields;

dist/node/PayloadValidationFunction.d.ts

 import type { Payload } from './Payload.ts';
+/**
+ * A function that validates the supplied payload synchronously
+ */
 export type SyncPayloadValidationFunction<T extends Payload = Payload> = (payload: T) => boolean;
+/**
+ * A function that validates the supplied payload asynchronously
+ */
 export type AsyncPayloadValidationFunction<T extends Payload = Payload> = (payload: T) => Promise<boolean>;
+/**
+ * A function that validates the supplied payload
+ */
 export type PayloadValidationFunction<T extends Payload = Payload> = SyncPayloadValidationFunction<T> | AsyncPayloadValidationFunction<T>;
 //# sourceMappingURL=PayloadValidationFunction.d.ts.map

dist/node/PayloadValueExpression.d.ts

 import type { Payload } from './Payload.ts';
-export type PayloadProperty<T extends Payload = Payload> = keyof T;
-export type PayloadValue<T extends Payload = Payload, Key extends PayloadProperty<T> = PayloadProperty<T>> = T[Key];
-export type PayloadValueExpression<T extends Payload = Payload, Key extends PayloadProperty<T> = PayloadProperty<T>, TValue = PayloadValue<T, Key>> = (payload: T) => TValue;
+/**
+ * Type corresponding to the properties of a payload
+ */
+export type PayloadProperty<
+/**
+ * The type of payload
+ */
+T extends Payload = Payload> = keyof T;
+/**
+ * Type corresponding to the payload values
+ */
+export 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
+ */
+export 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;
 //# sourceMappingURL=PayloadValueExpression.d.ts.map

dist/node/Query.d.ts

@@ -6,5 +6,9 @@ import type { Address } from '@xylabs/hex';
 export 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;
@@ -11,0 +15,0 @@ }

dist/node/Schema.d.ts

 import type { EmptyObject } from '@xylabs/object';
+/** Schema type in Javascript is a string */
 export type Schema = string;
@@ -7,9 +8,12 @@ export declare const PayloadSchema: "network.xyo.payload";
 export declare const asSchema: {
-    <TType extends string>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
-    <TType extends string>(value: import(".store/@xylabs-promise-npm-4.2.2-e903abe7a5/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<string>, config?: import("@xylabs/object").TypeCheckConfig): TType;
+    <TType extends string>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
+    <TType extends string>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<string>, config?: import("@xylabs/object").TypeCheckConfig): TType;
 };
+/** Schema fields for a Payload */
 export interface SchemaFields extends EmptyObject {
+    /**  Schema of the object */
     schema: Schema;
 }
+/** Add the Schema Fields to an object */
 export type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields;
 //# sourceMappingURL=Schema.d.ts.map

dist/node/Timestamp.d.ts

 import type { EmptyObject } from '@xylabs/object';
+/** Object with a timestamp */
 export interface Timestamp {
     timestamp: number;
 }
+/** Add a timestamp field to any object */
 export type WithTimestamp<T extends EmptyObject = EmptyObject> = T & Timestamp;
 //# sourceMappingURL=Timestamp.d.ts.map

package.json

 {
   "name": "@xyo-network/payload-model",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
@@ -40,8 +40,8 @@ "homepage": "https://xyo.network",
   "dependencies": {
-    "@xylabs/hex": "^4.2.2",
-    "@xylabs/object": "^4.2.2"
+    "@xylabs/hex": "^4.3.2",
+    "@xylabs/object": "^4.3.2"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.2.1",
-    "@xylabs/tsconfig": "^4.2.1",
+    "@xylabs/ts-scripts-yarn3": "^4.2.3",
+    "@xylabs/tsconfig": "^4.2.3",
     "typescript": "^5.6.3"
@@ -48,0 +48,0 @@ },

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

113287

increased by6.29%

Lines of code

1176

increased by20.62%

Dependency changes

• Updated@xylabs/hex@^4.3.2

• Updated@xylabs/object@^4.3.2