@xyo-network/payload-model 3.2.0 → 3.3.1

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 (46) hide show
  1. package/dist/browser/Payload.d.ts +6 -1
  2. package/dist/browser/Payload.d.ts.map +1 -1
  3. package/dist/browser/PayloadValidationFunction.d.ts +9 -0
  4. package/dist/browser/PayloadValidationFunction.d.ts.map +1 -1
  5. package/dist/browser/PayloadValueExpression.d.ts +36 -3
  6. package/dist/browser/PayloadValueExpression.d.ts.map +1 -1
  7. package/dist/browser/Query.d.ts +4 -0
  8. package/dist/browser/Query.d.ts.map +1 -1
  9. package/dist/browser/Schema.d.ts +6 -2
  10. package/dist/browser/Schema.d.ts.map +1 -1
  11. package/dist/browser/Timestamp.d.ts +2 -0
  12. package/dist/browser/Timestamp.d.ts.map +1 -1
  13. package/dist/browser/isPayload.d.ts +4 -4
  14. package/dist/browser/isPayloadWithHash.d.ts +10 -0
  15. package/dist/browser/isPayloadWithHash.d.ts.map +1 -1
  16. package/dist/neutral/Payload.d.ts +6 -1
  17. package/dist/neutral/Payload.d.ts.map +1 -1
  18. package/dist/neutral/PayloadValidationFunction.d.ts +9 -0
  19. package/dist/neutral/PayloadValidationFunction.d.ts.map +1 -1
  20. package/dist/neutral/PayloadValueExpression.d.ts +36 -3
  21. package/dist/neutral/PayloadValueExpression.d.ts.map +1 -1
  22. package/dist/neutral/Query.d.ts +4 -0
  23. package/dist/neutral/Query.d.ts.map +1 -1
  24. package/dist/neutral/Schema.d.ts +6 -2
  25. package/dist/neutral/Schema.d.ts.map +1 -1
  26. package/dist/neutral/Timestamp.d.ts +2 -0
  27. package/dist/neutral/Timestamp.d.ts.map +1 -1
  28. package/dist/neutral/isPayload.d.ts +4 -4
  29. package/dist/neutral/isPayloadWithHash.d.ts +10 -0
  30. package/dist/neutral/isPayloadWithHash.d.ts.map +1 -1
  31. package/dist/node/Payload.d.ts +6 -1
  32. package/dist/node/Payload.d.ts.map +1 -1
  33. package/dist/node/PayloadValidationFunction.d.ts +9 -0
  34. package/dist/node/PayloadValidationFunction.d.ts.map +1 -1
  35. package/dist/node/PayloadValueExpression.d.ts +36 -3
  36. package/dist/node/PayloadValueExpression.d.ts.map +1 -1
  37. package/dist/node/Query.d.ts +4 -0
  38. package/dist/node/Query.d.ts.map +1 -1
  39. package/dist/node/Schema.d.ts +6 -2
  40. package/dist/node/Schema.d.ts.map +1 -1
  41. package/dist/node/Timestamp.d.ts +2 -0
  42. package/dist/node/Timestamp.d.ts.map +1 -1
  43. package/dist/node/isPayload.d.ts +4 -4
  44. package/dist/node/isPayloadWithHash.d.ts +10 -0
  45. package/dist/node/isPayloadWithHash.d.ts.map +1 -1
  46. package/package.json +6 -6
@@ -1,21 +1,26 @@
1
1
  import type { Hash } from '@xylabs/hex';
2
2
  import type { EmptyObject, JsonObject } from '@xylabs/object';
3
3
  import type { Schema, WithSchema } from './Schema.ts';
4
+ /** Meta fields for a payload - Either both $hash and $meta should exist or neither */
4
5
  export interface PayloadMetaFields<TAdditionalMeta extends EmptyObject | void = void> extends EmptyObject {
6
+ /** Hash of the body of the payload excluding the items in the $meta object */
5
7
  $hash: Hash;
8
+ /** Meta data that should be included in the main hash of the payload */
6
9
  $meta?: TAdditionalMeta extends void ? JsonObject : TAdditionalMeta;
7
10
  }
11
+ /** Additional fields for a payload */
8
12
  export interface PayloadFields extends EmptyObject {
9
13
  schema: Schema;
10
14
  }
11
15
  export type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>;
16
+ /** Base Type for Payloads */
12
17
  export type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema ? S extends Schema ? WithPayload<Omit<T, 'schema'> & {
13
18
  schema: S;
14
19
  } & PayloadFields> : WithPayload<T> : T extends object ? S extends Schema ? WithPayload<T & {
15
20
  schema: S;
16
21
  } & PayloadFields> : WithPayload<T & {
17
22
  schema: Schema;
18
- } & PayloadFields> : {
23
+ } & PayloadFields> : /* Either just S or neither S or T provided */ {
19
24
  schema: S extends Schema ? S : Schema;
20
25
  } & PayloadFields;
21
26
  export type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & {
@@ -1 +1 @@
1
- {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE7D,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAGrD,MAAM,WAAW,iBAAiB,CAAC,eAAe,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,CAAE,SAAQ,WAAW;IAEvG,KAAK,EAAE,IAAI,CAAA;IAEX,KAAK,CAAC,EAAE,eAAe,SAAS,IAAI,GAAG,UAAU,GAAG,eAAe,CAAA;CACpE;AAGD,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,aAAa,GAAG,CAAC,GAAG,aAAa,CAAC,CAAA;AAGpI,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAClG,CAAC,SAAS,UAAU,GAClB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAC3B,WAAW,CAAC,CAAC,CAAC,GACjD,CAAC,SAAS,MAAM,GAChB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GACT,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAExF;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEzB,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1F,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AACzE,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAE7I,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA"}
1
+ {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE7D,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,sFAAsF;AACtF,MAAM,WAAW,iBAAiB,CAAC,eAAe,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,CAAE,SAAQ,WAAW;IACvG,8EAA8E;IAC9E,KAAK,EAAE,IAAI,CAAA;IACX,wEAAwE;IACxE,KAAK,CAAC,EAAE,eAAe,SAAS,IAAI,GAAG,UAAU,GAAG,eAAe,CAAA;CACpE;AAED,sCAAsC;AACtC,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,aAAa,GAAG,CAAC,GAAG,aAAa,CAAC,CAAA;AAEpI,6BAA6B;AAC7B,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAClG,CAAC,SAAS,UAAU,GAClB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAC3B,WAAW,CAAC,CAAC,CAAC,GACjD,CAAC,SAAS,MAAM,GAChB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GACT,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAExF,AADA,8CAA8C,CAC9C;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEzB,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1F,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AACzE,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAE7I,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA"}
@@ -1,5 +1,14 @@
1
1
  import type { Payload } from './Payload.ts';
2
+ /**
3
+ * A function that validates the supplied payload synchronously
4
+ */
2
5
  export type SyncPayloadValidationFunction<T extends Payload = Payload> = (payload: T) => boolean;
6
+ /**
7
+ * A function that validates the supplied payload asynchronously
8
+ */
3
9
  export type AsyncPayloadValidationFunction<T extends Payload = Payload> = (payload: T) => Promise<boolean>;
10
+ /**
11
+ * A function that validates the supplied payload
12
+ */
4
13
  export type PayloadValidationFunction<T extends Payload = Payload> = SyncPayloadValidationFunction<T> | AsyncPayloadValidationFunction<T>;
5
14
  //# sourceMappingURL=PayloadValidationFunction.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"PayloadValidationFunction.d.ts","sourceRoot":"","sources":["../../src/PayloadValidationFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAK3C,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAA;AAKhG,MAAM,MAAM,8BAA8B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;AAK1G,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,6BAA6B,CAAC,CAAC,CAAC,GAAG,8BAA8B,CAAC,CAAC,CAAC,CAAA"}
1
+ {"version":3,"file":"PayloadValidationFunction.d.ts","sourceRoot":"","sources":["../../src/PayloadValidationFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C;;GAEG;AACH,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAA;AAEhG;;GAEG;AACH,MAAM,MAAM,8BAA8B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;AAE1G;;GAEG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,6BAA6B,CAAC,CAAC,CAAC,GAAG,8BAA8B,CAAC,CAAC,CAAC,CAAA"}
@@ -1,5 +1,38 @@
1
1
  import type { Payload } from './Payload.ts';
2
- export type PayloadProperty<T extends Payload = Payload> = keyof T;
3
- export type PayloadValue<T extends Payload = Payload, Key extends PayloadProperty<T> = PayloadProperty<T>> = T[Key];
4
- export type PayloadValueExpression<T extends Payload = Payload, Key extends PayloadProperty<T> = PayloadProperty<T>, TValue = PayloadValue<T, Key>> = (payload: T) => TValue;
2
+ /**
3
+ * Type corresponding to the properties of a payload
4
+ */
5
+ export type PayloadProperty<
6
+ /**
7
+ * The type of payload
8
+ */
9
+ T extends Payload = Payload> = keyof T;
10
+ /**
11
+ * Type corresponding to the payload values
12
+ */
13
+ export type PayloadValue<
14
+ /**
15
+ * The type of payload
16
+ */
17
+ T extends Payload = Payload,
18
+ /**
19
+ * The property of the payload to select
20
+ */
21
+ Key extends PayloadProperty<T> = PayloadProperty<T>> = T[Key];
22
+ /**
23
+ * An expressions that selects a property value from the payload
24
+ */
25
+ export type PayloadValueExpression<
26
+ /**
27
+ * The type of payload
28
+ */
29
+ T extends Payload = Payload,
30
+ /**
31
+ * The property of the payload to select
32
+ */
33
+ Key extends PayloadProperty<T> = PayloadProperty<T>,
34
+ /**
35
+ * The type of the selected property's value
36
+ */
37
+ TValue = PayloadValue<T, Key>> = (payload: T) => TValue;
5
38
  //# sourceMappingURL=PayloadValueExpression.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"PayloadValueExpression.d.ts","sourceRoot":"","sources":["../../src/PayloadValueExpression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAK3C,MAAM,MAAM,eAAe,CAIzB,CAAC,SAAS,OAAO,GAAG,OAAO,IACzB,MAAM,CAAC,CAAA;AAKX,MAAM,MAAM,YAAY,CAItB,CAAC,SAAS,OAAO,GAAG,OAAO,EAI3B,GAAG,SAAS,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,IACjD,CAAC,CAAC,GAAG,CAAC,CAAA;AAKV,MAAM,MAAM,sBAAsB,CAIhC,CAAC,SAAS,OAAO,GAAG,OAAO,EAI3B,GAAG,SAAS,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,EAInD,MAAM,GAAG,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC,IAC3B,CAAC,OAAO,EAAE,CAAC,KAAK,MAAM,CAAA"}
1
+ {"version":3,"file":"PayloadValueExpression.d.ts","sourceRoot":"","sources":["../../src/PayloadValueExpression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C;;GAEG;AACH,MAAM,MAAM,eAAe;AACzB;;GAEG;AACH,CAAC,SAAS,OAAO,GAAG,OAAO,IACzB,MAAM,CAAC,CAAA;AAEX;;GAEG;AACH,MAAM,MAAM,YAAY;AACtB;;GAEG;AACH,CAAC,SAAS,OAAO,GAAG,OAAO;AAC3B;;GAEG;AACH,GAAG,SAAS,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,IACjD,CAAC,CAAC,GAAG,CAAC,CAAA;AAEV;;GAEG;AACH,MAAM,MAAM,sBAAsB;AAChC;;GAEG;AACH,CAAC,SAAS,OAAO,GAAG,OAAO;AAC3B;;GAEG;AACH,GAAG,SAAS,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC;AACnD;;GAEG;AACH,MAAM,GAAG,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC,IAC3B,CAAC,OAAO,EAAE,CAAC,KAAK,MAAM,CAAA"}
@@ -3,9 +3,13 @@ import type { EmptyObject } from '@xylabs/object';
3
3
  import type { Payload } from './Payload.ts';
4
4
  import type { Schema, WithSchema } from './Schema.ts';
5
5
  export interface QueryFields {
6
+ /** @field The addresses of the intended handlers */
6
7
  address?: Address | Address[];
8
+ /** @field The maximum XYO that can be spent executing the query */
7
9
  budget?: number;
10
+ /** @field The frequency on which this query can be rerun */
8
11
  maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
12
+ /** @field The starting point for the bidding on the query */
9
13
  minBid?: number;
10
14
  }
11
15
  export 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 ? string : void : S>;
@@ -1 +1 @@
1
- {"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../src/Query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,MAAM,WAAW,WAAW;IAE1B,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,EAAE,CAAA;IAG7B,MAAM,CAAC,EAAE,MAAM,CAAA;IAGf,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;IAGxF,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,OAAO,CAC3G,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,CAAC,GAAG,WAAW,EAC9C,CAAC,SAAS,IAAI,GACZ,CAAC,SAAS,UAAU,GAAG,CAAC,CAAC,QAAQ,CAAC,GAC9B,CAAC,SAAS,IAAI,GAAG,MAAM,GACrB,IAAI,GACR,CAAC,CACN,CAAA"}
1
+ {"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../src/Query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,MAAM,WAAW,WAAW;IAC1B,oDAAoD;IACpD,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,EAAE,CAAA;IAE7B,mEAAmE;IACnE,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;IAExF,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,OAAO,CAC3G,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,CAAC,GAAG,WAAW,EAC9C,CAAC,SAAS,IAAI,GACZ,CAAC,SAAS,UAAU,GAAG,CAAC,CAAC,QAAQ,CAAC,GAC9B,CAAC,SAAS,IAAI,GAAG,MAAM,GACrB,IAAI,GACR,CAAC,CACN,CAAA"}
@@ -1,14 +1,18 @@
1
1
  import type { EmptyObject } from '@xylabs/object';
2
+ /** Schema type in Javascript is a string */
2
3
  export type Schema = string;
3
4
  export declare const PayloadSchema: "network.xyo.payload";
4
5
  export type PayloadSchema = typeof PayloadSchema;
5
6
  export declare const isSchema: (value: unknown) => value is Schema;
6
7
  export declare const asSchema: {
7
- <TType extends string>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
8
- <TType extends string>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<string>, config?: import("@xylabs/object").TypeCheckConfig): TType;
8
+ <TType extends string>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
9
+ <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;
9
10
  };
11
+ /** Schema fields for a Payload */
10
12
  export interface SchemaFields extends EmptyObject {
13
+ /** Schema of the object */
11
14
  schema: Schema;
12
15
  }
16
+ /** Add the Schema Fields to an object */
13
17
  export type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields;
14
18
  //# sourceMappingURL=Schema.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAIjD,MAAM,MAAM,MAAM,GAAG,MAAM,CAAA;AAE3B,eAAO,MAAM,aAAa,uBAAiC,CAAA;AAC3D,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAA;AAEhD,eAAO,MAAM,QAAQ,UAAW,OAAO,KAAG,KAAK,IAAI,MAElD,CAAA;AAED,eAAO,MAAM,QAAQ;;;CAAyC,CAAA;AAG9D,MAAM,WAAW,YAAa,SAAQ,WAAW;IAE/C,MAAM,EAAE,MAAM,CAAA;CACf;AAGD,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,WAAW,GAAG,YAAY,GAAG,CAAC,GAAG,YAAY,CAAA"}
1
+ {"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAGjD,4CAA4C;AAC5C,MAAM,MAAM,MAAM,GAAG,MAAM,CAAA;AAE3B,eAAO,MAAM,aAAa,uBAAiC,CAAA;AAC3D,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAA;AAEhD,eAAO,MAAM,QAAQ,UAAW,OAAO,KAAG,KAAK,IAAI,MAElD,CAAA;AAED,eAAO,MAAM,QAAQ;;;CAAyC,CAAA;AAE9D,kCAAkC;AAClC,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAA;CACf;AAED,yCAAyC;AACzC,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,WAAW,GAAG,YAAY,GAAG,CAAC,GAAG,YAAY,CAAA"}
@@ -1,6 +1,8 @@
1
1
  import type { EmptyObject } from '@xylabs/object';
2
+ /** Object with a timestamp */
2
3
  export interface Timestamp {
3
4
  timestamp: number;
4
5
  }
6
+ /** Add a timestamp field to any object */
5
7
  export type WithTimestamp<T extends EmptyObject = EmptyObject> = T & Timestamp;
6
8
  //# sourceMappingURL=Timestamp.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Timestamp.d.ts","sourceRoot":"","sources":["../../src/Timestamp.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAGjD,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAA;CAClB;AAGD,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,CAAC,GAAG,SAAS,CAAA"}
1
+ {"version":3,"file":"Timestamp.d.ts","sourceRoot":"","sources":["../../src/Timestamp.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,8BAA8B;AAC9B,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,0CAA0C;AAC1C,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,CAAC,GAAG,SAAS,CAAA"}
@@ -3,16 +3,16 @@ export declare const isAnyPayload: (value: unknown) => value is Payload;
3
3
  export declare const asAnyPayload: {
4
4
  <TType extends {
5
5
  schema: string;
6
- } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
6
+ } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
7
7
  <TType extends {
8
8
  schema: string;
9
- } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
9
+ } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
10
10
  schema: string;
11
11
  } & import("./Payload.ts").PayloadFields>, config?: import("@xylabs/object").TypeCheckConfig): TType;
12
12
  };
13
13
  export declare const isPayload: <T extends Payload>(schema: string[]) => (value: unknown) => value is T;
14
14
  export declare const asPayload: <T extends Payload>(schema: string[]) => {
15
- <TType extends T>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
16
- <TType extends T>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
15
+ <TType extends T>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
16
+ <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;
17
17
  };
18
18
  //# sourceMappingURL=isPayload.d.ts.map
@@ -1,5 +1,15 @@
1
1
  import type { WithMeta } from './Meta.ts';
2
2
  import type { Payload } from './Payload.ts';
3
+ /**
4
+ * Return true if the value is a payload with the required meta fields
5
+ * @param value The value to check
6
+ * @returns True if the value is a payload with the required meta fields
7
+ */
3
8
  export declare const isWithHash: <T extends Payload>(value: T) => value is WithMeta<T>;
9
+ /**
10
+ * Return true if the value is a payload with the required meta fields
11
+ * @param value The value to check
12
+ * @returns True if the value is a payload with the required meta fields
13
+ */
4
14
  export declare const isPayloadWithHash: <T extends Payload>(value: unknown) => value is WithMeta<T>;
5
15
  //# sourceMappingURL=isPayloadWithHash.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"isPayloadWithHash.d.ts","sourceRoot":"","sources":["../../src/isPayloadWithHash.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAO3C,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,OAAO,SAAS,CAAC,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAE3E,CAAA;AAOD,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,OAAO,SAAS,OAAO,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAExF,CAAA"}
1
+ {"version":3,"file":"isPayloadWithHash.d.ts","sourceRoot":"","sources":["../../src/isPayloadWithHash.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,OAAO,SAAS,CAAC,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAE3E,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,OAAO,SAAS,OAAO,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAExF,CAAA"}
@@ -1,21 +1,26 @@
1
1
  import type { Hash } from '@xylabs/hex';
2
2
  import type { EmptyObject, JsonObject } from '@xylabs/object';
3
3
  import type { Schema, WithSchema } from './Schema.ts';
4
+ /** Meta fields for a payload - Either both $hash and $meta should exist or neither */
4
5
  export interface PayloadMetaFields<TAdditionalMeta extends EmptyObject | void = void> extends EmptyObject {
6
+ /** Hash of the body of the payload excluding the items in the $meta object */
5
7
  $hash: Hash;
8
+ /** Meta data that should be included in the main hash of the payload */
6
9
  $meta?: TAdditionalMeta extends void ? JsonObject : TAdditionalMeta;
7
10
  }
11
+ /** Additional fields for a payload */
8
12
  export interface PayloadFields extends EmptyObject {
9
13
  schema: Schema;
10
14
  }
11
15
  export type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>;
16
+ /** Base Type for Payloads */
12
17
  export type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema ? S extends Schema ? WithPayload<Omit<T, 'schema'> & {
13
18
  schema: S;
14
19
  } & PayloadFields> : WithPayload<T> : T extends object ? S extends Schema ? WithPayload<T & {
15
20
  schema: S;
16
21
  } & PayloadFields> : WithPayload<T & {
17
22
  schema: Schema;
18
- } & PayloadFields> : {
23
+ } & PayloadFields> : /* Either just S or neither S or T provided */ {
19
24
  schema: S extends Schema ? S : Schema;
20
25
  } & PayloadFields;
21
26
  export type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & {
@@ -1 +1 @@
1
- {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE7D,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAGrD,MAAM,WAAW,iBAAiB,CAAC,eAAe,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,CAAE,SAAQ,WAAW;IAEvG,KAAK,EAAE,IAAI,CAAA;IAEX,KAAK,CAAC,EAAE,eAAe,SAAS,IAAI,GAAG,UAAU,GAAG,eAAe,CAAA;CACpE;AAGD,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,aAAa,GAAG,CAAC,GAAG,aAAa,CAAC,CAAA;AAGpI,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAClG,CAAC,SAAS,UAAU,GAClB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAC3B,WAAW,CAAC,CAAC,CAAC,GACjD,CAAC,SAAS,MAAM,GAChB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GACT,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAExF;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEzB,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1F,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AACzE,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAE7I,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA"}
1
+ {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE7D,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,sFAAsF;AACtF,MAAM,WAAW,iBAAiB,CAAC,eAAe,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,CAAE,SAAQ,WAAW;IACvG,8EAA8E;IAC9E,KAAK,EAAE,IAAI,CAAA;IACX,wEAAwE;IACxE,KAAK,CAAC,EAAE,eAAe,SAAS,IAAI,GAAG,UAAU,GAAG,eAAe,CAAA;CACpE;AAED,sCAAsC;AACtC,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,aAAa,GAAG,CAAC,GAAG,aAAa,CAAC,CAAA;AAEpI,6BAA6B;AAC7B,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAClG,CAAC,SAAS,UAAU,GAClB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAC3B,WAAW,CAAC,CAAC,CAAC,GACjD,CAAC,SAAS,MAAM,GAChB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GACT,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAExF,AADA,8CAA8C,CAC9C;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEzB,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1F,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AACzE,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAE7I,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA"}
@@ -1,5 +1,14 @@
1
1
  import type { Payload } from './Payload.ts';
2
+ /**
3
+ * A function that validates the supplied payload synchronously
4
+ */
2
5
  export type SyncPayloadValidationFunction<T extends Payload = Payload> = (payload: T) => boolean;
6
+ /**
7
+ * A function that validates the supplied payload asynchronously
8
+ */
3
9
  export type AsyncPayloadValidationFunction<T extends Payload = Payload> = (payload: T) => Promise<boolean>;
10
+ /**
11
+ * A function that validates the supplied payload
12
+ */
4
13
  export type PayloadValidationFunction<T extends Payload = Payload> = SyncPayloadValidationFunction<T> | AsyncPayloadValidationFunction<T>;
5
14
  //# sourceMappingURL=PayloadValidationFunction.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"PayloadValidationFunction.d.ts","sourceRoot":"","sources":["../../src/PayloadValidationFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAK3C,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAA;AAKhG,MAAM,MAAM,8BAA8B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;AAK1G,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,6BAA6B,CAAC,CAAC,CAAC,GAAG,8BAA8B,CAAC,CAAC,CAAC,CAAA"}
1
+ {"version":3,"file":"PayloadValidationFunction.d.ts","sourceRoot":"","sources":["../../src/PayloadValidationFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C;;GAEG;AACH,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAA;AAEhG;;GAEG;AACH,MAAM,MAAM,8BAA8B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;AAE1G;;GAEG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,6BAA6B,CAAC,CAAC,CAAC,GAAG,8BAA8B,CAAC,CAAC,CAAC,CAAA"}
@@ -1,5 +1,38 @@
1
1
  import type { Payload } from './Payload.ts';
2
- export type PayloadProperty<T extends Payload = Payload> = keyof T;
3
- export type PayloadValue<T extends Payload = Payload, Key extends PayloadProperty<T> = PayloadProperty<T>> = T[Key];
4
- export type PayloadValueExpression<T extends Payload = Payload, Key extends PayloadProperty<T> = PayloadProperty<T>, TValue = PayloadValue<T, Key>> = (payload: T) => TValue;
2
+ /**
3
+ * Type corresponding to the properties of a payload
4
+ */
5
+ export type PayloadProperty<
6
+ /**
7
+ * The type of payload
8
+ */
9
+ T extends Payload = Payload> = keyof T;
10
+ /**
11
+ * Type corresponding to the payload values
12
+ */
13
+ export type PayloadValue<
14
+ /**
15
+ * The type of payload
16
+ */
17
+ T extends Payload = Payload,
18
+ /**
19
+ * The property of the payload to select
20
+ */
21
+ Key extends PayloadProperty<T> = PayloadProperty<T>> = T[Key];
22
+ /**
23
+ * An expressions that selects a property value from the payload
24
+ */
25
+ export type PayloadValueExpression<
26
+ /**
27
+ * The type of payload
28
+ */
29
+ T extends Payload = Payload,
30
+ /**
31
+ * The property of the payload to select
32
+ */
33
+ Key extends PayloadProperty<T> = PayloadProperty<T>,
34
+ /**
35
+ * The type of the selected property's value
36
+ */
37
+ TValue = PayloadValue<T, Key>> = (payload: T) => TValue;
5
38
  //# sourceMappingURL=PayloadValueExpression.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"PayloadValueExpression.d.ts","sourceRoot":"","sources":["../../src/PayloadValueExpression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAK3C,MAAM,MAAM,eAAe,CAIzB,CAAC,SAAS,OAAO,GAAG,OAAO,IACzB,MAAM,CAAC,CAAA;AAKX,MAAM,MAAM,YAAY,CAItB,CAAC,SAAS,OAAO,GAAG,OAAO,EAI3B,GAAG,SAAS,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,IACjD,CAAC,CAAC,GAAG,CAAC,CAAA;AAKV,MAAM,MAAM,sBAAsB,CAIhC,CAAC,SAAS,OAAO,GAAG,OAAO,EAI3B,GAAG,SAAS,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,EAInD,MAAM,GAAG,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC,IAC3B,CAAC,OAAO,EAAE,CAAC,KAAK,MAAM,CAAA"}
1
+ {"version":3,"file":"PayloadValueExpression.d.ts","sourceRoot":"","sources":["../../src/PayloadValueExpression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C;;GAEG;AACH,MAAM,MAAM,eAAe;AACzB;;GAEG;AACH,CAAC,SAAS,OAAO,GAAG,OAAO,IACzB,MAAM,CAAC,CAAA;AAEX;;GAEG;AACH,MAAM,MAAM,YAAY;AACtB;;GAEG;AACH,CAAC,SAAS,OAAO,GAAG,OAAO;AAC3B;;GAEG;AACH,GAAG,SAAS,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,IACjD,CAAC,CAAC,GAAG,CAAC,CAAA;AAEV;;GAEG;AACH,MAAM,MAAM,sBAAsB;AAChC;;GAEG;AACH,CAAC,SAAS,OAAO,GAAG,OAAO;AAC3B;;GAEG;AACH,GAAG,SAAS,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC;AACnD;;GAEG;AACH,MAAM,GAAG,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC,IAC3B,CAAC,OAAO,EAAE,CAAC,KAAK,MAAM,CAAA"}
@@ -3,9 +3,13 @@ import type { EmptyObject } from '@xylabs/object';
3
3
  import type { Payload } from './Payload.ts';
4
4
  import type { Schema, WithSchema } from './Schema.ts';
5
5
  export interface QueryFields {
6
+ /** @field The addresses of the intended handlers */
6
7
  address?: Address | Address[];
8
+ /** @field The maximum XYO that can be spent executing the query */
7
9
  budget?: number;
10
+ /** @field The frequency on which this query can be rerun */
8
11
  maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
12
+ /** @field The starting point for the bidding on the query */
9
13
  minBid?: number;
10
14
  }
11
15
  export 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 ? string : void : S>;
@@ -1 +1 @@
1
- {"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../src/Query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,MAAM,WAAW,WAAW;IAE1B,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,EAAE,CAAA;IAG7B,MAAM,CAAC,EAAE,MAAM,CAAA;IAGf,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;IAGxF,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,OAAO,CAC3G,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,CAAC,GAAG,WAAW,EAC9C,CAAC,SAAS,IAAI,GACZ,CAAC,SAAS,UAAU,GAAG,CAAC,CAAC,QAAQ,CAAC,GAC9B,CAAC,SAAS,IAAI,GAAG,MAAM,GACrB,IAAI,GACR,CAAC,CACN,CAAA"}
1
+ {"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../src/Query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,MAAM,WAAW,WAAW;IAC1B,oDAAoD;IACpD,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,EAAE,CAAA;IAE7B,mEAAmE;IACnE,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;IAExF,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,OAAO,CAC3G,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,CAAC,GAAG,WAAW,EAC9C,CAAC,SAAS,IAAI,GACZ,CAAC,SAAS,UAAU,GAAG,CAAC,CAAC,QAAQ,CAAC,GAC9B,CAAC,SAAS,IAAI,GAAG,MAAM,GACrB,IAAI,GACR,CAAC,CACN,CAAA"}
@@ -1,14 +1,18 @@
1
1
  import type { EmptyObject } from '@xylabs/object';
2
+ /** Schema type in Javascript is a string */
2
3
  export type Schema = string;
3
4
  export declare const PayloadSchema: "network.xyo.payload";
4
5
  export type PayloadSchema = typeof PayloadSchema;
5
6
  export declare const isSchema: (value: unknown) => value is Schema;
6
7
  export declare const asSchema: {
7
- <TType extends string>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
8
- <TType extends string>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<string>, config?: import("@xylabs/object").TypeCheckConfig): TType;
8
+ <TType extends string>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
9
+ <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;
9
10
  };
11
+ /** Schema fields for a Payload */
10
12
  export interface SchemaFields extends EmptyObject {
13
+ /** Schema of the object */
11
14
  schema: Schema;
12
15
  }
16
+ /** Add the Schema Fields to an object */
13
17
  export type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields;
14
18
  //# sourceMappingURL=Schema.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAIjD,MAAM,MAAM,MAAM,GAAG,MAAM,CAAA;AAE3B,eAAO,MAAM,aAAa,uBAAiC,CAAA;AAC3D,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAA;AAEhD,eAAO,MAAM,QAAQ,UAAW,OAAO,KAAG,KAAK,IAAI,MAElD,CAAA;AAED,eAAO,MAAM,QAAQ;;;CAAyC,CAAA;AAG9D,MAAM,WAAW,YAAa,SAAQ,WAAW;IAE/C,MAAM,EAAE,MAAM,CAAA;CACf;AAGD,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,WAAW,GAAG,YAAY,GAAG,CAAC,GAAG,YAAY,CAAA"}
1
+ {"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAGjD,4CAA4C;AAC5C,MAAM,MAAM,MAAM,GAAG,MAAM,CAAA;AAE3B,eAAO,MAAM,aAAa,uBAAiC,CAAA;AAC3D,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAA;AAEhD,eAAO,MAAM,QAAQ,UAAW,OAAO,KAAG,KAAK,IAAI,MAElD,CAAA;AAED,eAAO,MAAM,QAAQ;;;CAAyC,CAAA;AAE9D,kCAAkC;AAClC,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAA;CACf;AAED,yCAAyC;AACzC,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,WAAW,GAAG,YAAY,GAAG,CAAC,GAAG,YAAY,CAAA"}
@@ -1,6 +1,8 @@
1
1
  import type { EmptyObject } from '@xylabs/object';
2
+ /** Object with a timestamp */
2
3
  export interface Timestamp {
3
4
  timestamp: number;
4
5
  }
6
+ /** Add a timestamp field to any object */
5
7
  export type WithTimestamp<T extends EmptyObject = EmptyObject> = T & Timestamp;
6
8
  //# sourceMappingURL=Timestamp.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Timestamp.d.ts","sourceRoot":"","sources":["../../src/Timestamp.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAGjD,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAA;CAClB;AAGD,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,CAAC,GAAG,SAAS,CAAA"}
1
+ {"version":3,"file":"Timestamp.d.ts","sourceRoot":"","sources":["../../src/Timestamp.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,8BAA8B;AAC9B,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,0CAA0C;AAC1C,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,CAAC,GAAG,SAAS,CAAA"}
@@ -3,16 +3,16 @@ export declare const isAnyPayload: (value: unknown) => value is Payload;
3
3
  export declare const asAnyPayload: {
4
4
  <TType extends {
5
5
  schema: string;
6
- } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
6
+ } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
7
7
  <TType extends {
8
8
  schema: string;
9
- } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
9
+ } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
10
10
  schema: string;
11
11
  } & import("./Payload.ts").PayloadFields>, config?: import("@xylabs/object").TypeCheckConfig): TType;
12
12
  };
13
13
  export declare const isPayload: <T extends Payload>(schema: string[]) => (value: unknown) => value is T;
14
14
  export declare const asPayload: <T extends Payload>(schema: string[]) => {
15
- <TType extends T>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
16
- <TType extends T>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
15
+ <TType extends T>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
16
+ <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;
17
17
  };
18
18
  //# sourceMappingURL=isPayload.d.ts.map
@@ -1,5 +1,15 @@
1
1
  import type { WithMeta } from './Meta.ts';
2
2
  import type { Payload } from './Payload.ts';
3
+ /**
4
+ * Return true if the value is a payload with the required meta fields
5
+ * @param value The value to check
6
+ * @returns True if the value is a payload with the required meta fields
7
+ */
3
8
  export declare const isWithHash: <T extends Payload>(value: T) => value is WithMeta<T>;
9
+ /**
10
+ * Return true if the value is a payload with the required meta fields
11
+ * @param value The value to check
12
+ * @returns True if the value is a payload with the required meta fields
13
+ */
4
14
  export declare const isPayloadWithHash: <T extends Payload>(value: unknown) => value is WithMeta<T>;
5
15
  //# sourceMappingURL=isPayloadWithHash.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"isPayloadWithHash.d.ts","sourceRoot":"","sources":["../../src/isPayloadWithHash.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAO3C,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,OAAO,SAAS,CAAC,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAE3E,CAAA;AAOD,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,OAAO,SAAS,OAAO,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAExF,CAAA"}
1
+ {"version":3,"file":"isPayloadWithHash.d.ts","sourceRoot":"","sources":["../../src/isPayloadWithHash.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,OAAO,SAAS,CAAC,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAE3E,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,OAAO,SAAS,OAAO,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAExF,CAAA"}
@@ -1,21 +1,26 @@
1
1
  import type { Hash } from '@xylabs/hex';
2
2
  import type { EmptyObject, JsonObject } from '@xylabs/object';
3
3
  import type { Schema, WithSchema } from './Schema.ts';
4
+ /** Meta fields for a payload - Either both $hash and $meta should exist or neither */
4
5
  export interface PayloadMetaFields<TAdditionalMeta extends EmptyObject | void = void> extends EmptyObject {
6
+ /** Hash of the body of the payload excluding the items in the $meta object */
5
7
  $hash: Hash;
8
+ /** Meta data that should be included in the main hash of the payload */
6
9
  $meta?: TAdditionalMeta extends void ? JsonObject : TAdditionalMeta;
7
10
  }
11
+ /** Additional fields for a payload */
8
12
  export interface PayloadFields extends EmptyObject {
9
13
  schema: Schema;
10
14
  }
11
15
  export type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>;
16
+ /** Base Type for Payloads */
12
17
  export type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema ? S extends Schema ? WithPayload<Omit<T, 'schema'> & {
13
18
  schema: S;
14
19
  } & PayloadFields> : WithPayload<T> : T extends object ? S extends Schema ? WithPayload<T & {
15
20
  schema: S;
16
21
  } & PayloadFields> : WithPayload<T & {
17
22
  schema: Schema;
18
- } & PayloadFields> : {
23
+ } & PayloadFields> : /* Either just S or neither S or T provided */ {
19
24
  schema: S extends Schema ? S : Schema;
20
25
  } & PayloadFields;
21
26
  export type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & {
@@ -1 +1 @@
1
- {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE7D,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAGrD,MAAM,WAAW,iBAAiB,CAAC,eAAe,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,CAAE,SAAQ,WAAW;IAEvG,KAAK,EAAE,IAAI,CAAA;IAEX,KAAK,CAAC,EAAE,eAAe,SAAS,IAAI,GAAG,UAAU,GAAG,eAAe,CAAA;CACpE;AAGD,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,aAAa,GAAG,CAAC,GAAG,aAAa,CAAC,CAAA;AAGpI,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAClG,CAAC,SAAS,UAAU,GAClB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAC3B,WAAW,CAAC,CAAC,CAAC,GACjD,CAAC,SAAS,MAAM,GAChB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GACT,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAExF;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEzB,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1F,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AACzE,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAE7I,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA"}
1
+ {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE7D,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,sFAAsF;AACtF,MAAM,WAAW,iBAAiB,CAAC,eAAe,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,CAAE,SAAQ,WAAW;IACvG,8EAA8E;IAC9E,KAAK,EAAE,IAAI,CAAA;IACX,wEAAwE;IACxE,KAAK,CAAC,EAAE,eAAe,SAAS,IAAI,GAAG,UAAU,GAAG,eAAe,CAAA;CACpE;AAED,sCAAsC;AACtC,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,aAAa,GAAG,CAAC,GAAG,aAAa,CAAC,CAAA;AAEpI,6BAA6B;AAC7B,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAClG,CAAC,SAAS,UAAU,GAClB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAC3B,WAAW,CAAC,CAAC,CAAC,GACjD,CAAC,SAAS,MAAM,GAChB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GACT,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAExF,AADA,8CAA8C,CAC9C;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEzB,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1F,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AACzE,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAE7I,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA"}
@@ -1,5 +1,14 @@
1
1
  import type { Payload } from './Payload.ts';
2
+ /**
3
+ * A function that validates the supplied payload synchronously
4
+ */
2
5
  export type SyncPayloadValidationFunction<T extends Payload = Payload> = (payload: T) => boolean;
6
+ /**
7
+ * A function that validates the supplied payload asynchronously
8
+ */
3
9
  export type AsyncPayloadValidationFunction<T extends Payload = Payload> = (payload: T) => Promise<boolean>;
10
+ /**
11
+ * A function that validates the supplied payload
12
+ */
4
13
  export type PayloadValidationFunction<T extends Payload = Payload> = SyncPayloadValidationFunction<T> | AsyncPayloadValidationFunction<T>;
5
14
  //# sourceMappingURL=PayloadValidationFunction.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"PayloadValidationFunction.d.ts","sourceRoot":"","sources":["../../src/PayloadValidationFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAK3C,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAA;AAKhG,MAAM,MAAM,8BAA8B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;AAK1G,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,6BAA6B,CAAC,CAAC,CAAC,GAAG,8BAA8B,CAAC,CAAC,CAAC,CAAA"}
1
+ {"version":3,"file":"PayloadValidationFunction.d.ts","sourceRoot":"","sources":["../../src/PayloadValidationFunction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C;;GAEG;AACH,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAA;AAEhG;;GAEG;AACH,MAAM,MAAM,8BAA8B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;AAE1G;;GAEG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,6BAA6B,CAAC,CAAC,CAAC,GAAG,8BAA8B,CAAC,CAAC,CAAC,CAAA"}
@@ -1,5 +1,38 @@
1
1
  import type { Payload } from './Payload.ts';
2
- export type PayloadProperty<T extends Payload = Payload> = keyof T;
3
- export type PayloadValue<T extends Payload = Payload, Key extends PayloadProperty<T> = PayloadProperty<T>> = T[Key];
4
- export type PayloadValueExpression<T extends Payload = Payload, Key extends PayloadProperty<T> = PayloadProperty<T>, TValue = PayloadValue<T, Key>> = (payload: T) => TValue;
2
+ /**
3
+ * Type corresponding to the properties of a payload
4
+ */
5
+ export type PayloadProperty<
6
+ /**
7
+ * The type of payload
8
+ */
9
+ T extends Payload = Payload> = keyof T;
10
+ /**
11
+ * Type corresponding to the payload values
12
+ */
13
+ export type PayloadValue<
14
+ /**
15
+ * The type of payload
16
+ */
17
+ T extends Payload = Payload,
18
+ /**
19
+ * The property of the payload to select
20
+ */
21
+ Key extends PayloadProperty<T> = PayloadProperty<T>> = T[Key];
22
+ /**
23
+ * An expressions that selects a property value from the payload
24
+ */
25
+ export type PayloadValueExpression<
26
+ /**
27
+ * The type of payload
28
+ */
29
+ T extends Payload = Payload,
30
+ /**
31
+ * The property of the payload to select
32
+ */
33
+ Key extends PayloadProperty<T> = PayloadProperty<T>,
34
+ /**
35
+ * The type of the selected property's value
36
+ */
37
+ TValue = PayloadValue<T, Key>> = (payload: T) => TValue;
5
38
  //# sourceMappingURL=PayloadValueExpression.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"PayloadValueExpression.d.ts","sourceRoot":"","sources":["../../src/PayloadValueExpression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAK3C,MAAM,MAAM,eAAe,CAIzB,CAAC,SAAS,OAAO,GAAG,OAAO,IACzB,MAAM,CAAC,CAAA;AAKX,MAAM,MAAM,YAAY,CAItB,CAAC,SAAS,OAAO,GAAG,OAAO,EAI3B,GAAG,SAAS,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,IACjD,CAAC,CAAC,GAAG,CAAC,CAAA;AAKV,MAAM,MAAM,sBAAsB,CAIhC,CAAC,SAAS,OAAO,GAAG,OAAO,EAI3B,GAAG,SAAS,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,EAInD,MAAM,GAAG,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC,IAC3B,CAAC,OAAO,EAAE,CAAC,KAAK,MAAM,CAAA"}
1
+ {"version":3,"file":"PayloadValueExpression.d.ts","sourceRoot":"","sources":["../../src/PayloadValueExpression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C;;GAEG;AACH,MAAM,MAAM,eAAe;AACzB;;GAEG;AACH,CAAC,SAAS,OAAO,GAAG,OAAO,IACzB,MAAM,CAAC,CAAA;AAEX;;GAEG;AACH,MAAM,MAAM,YAAY;AACtB;;GAEG;AACH,CAAC,SAAS,OAAO,GAAG,OAAO;AAC3B;;GAEG;AACH,GAAG,SAAS,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,IACjD,CAAC,CAAC,GAAG,CAAC,CAAA;AAEV;;GAEG;AACH,MAAM,MAAM,sBAAsB;AAChC;;GAEG;AACH,CAAC,SAAS,OAAO,GAAG,OAAO;AAC3B;;GAEG;AACH,GAAG,SAAS,eAAe,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC;AACnD;;GAEG;AACH,MAAM,GAAG,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC,IAC3B,CAAC,OAAO,EAAE,CAAC,KAAK,MAAM,CAAA"}
@@ -3,9 +3,13 @@ import type { EmptyObject } from '@xylabs/object';
3
3
  import type { Payload } from './Payload.ts';
4
4
  import type { Schema, WithSchema } from './Schema.ts';
5
5
  export interface QueryFields {
6
+ /** @field The addresses of the intended handlers */
6
7
  address?: Address | Address[];
8
+ /** @field The maximum XYO that can be spent executing the query */
7
9
  budget?: number;
10
+ /** @field The frequency on which this query can be rerun */
8
11
  maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
12
+ /** @field The starting point for the bidding on the query */
9
13
  minBid?: number;
10
14
  }
11
15
  export 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 ? string : void : S>;
@@ -1 +1 @@
1
- {"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../src/Query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,MAAM,WAAW,WAAW;IAE1B,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,EAAE,CAAA;IAG7B,MAAM,CAAC,EAAE,MAAM,CAAA;IAGf,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;IAGxF,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,OAAO,CAC3G,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,CAAC,GAAG,WAAW,EAC9C,CAAC,SAAS,IAAI,GACZ,CAAC,SAAS,UAAU,GAAG,CAAC,CAAC,QAAQ,CAAC,GAC9B,CAAC,SAAS,IAAI,GAAG,MAAM,GACrB,IAAI,GACR,CAAC,CACN,CAAA"}
1
+ {"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../src/Query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,MAAM,WAAW,WAAW;IAC1B,oDAAoD;IACpD,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,EAAE,CAAA;IAE7B,mEAAmE;IACnE,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;IAExF,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,OAAO,CAC3G,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,CAAC,GAAG,WAAW,EAC9C,CAAC,SAAS,IAAI,GACZ,CAAC,SAAS,UAAU,GAAG,CAAC,CAAC,QAAQ,CAAC,GAC9B,CAAC,SAAS,IAAI,GAAG,MAAM,GACrB,IAAI,GACR,CAAC,CACN,CAAA"}
@@ -1,14 +1,18 @@
1
1
  import type { EmptyObject } from '@xylabs/object';
2
+ /** Schema type in Javascript is a string */
2
3
  export type Schema = string;
3
4
  export declare const PayloadSchema: "network.xyo.payload";
4
5
  export type PayloadSchema = typeof PayloadSchema;
5
6
  export declare const isSchema: (value: unknown) => value is Schema;
6
7
  export declare const asSchema: {
7
- <TType extends string>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
8
- <TType extends string>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<string>, config?: import("@xylabs/object").TypeCheckConfig): TType;
8
+ <TType extends string>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
9
+ <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;
9
10
  };
11
+ /** Schema fields for a Payload */
10
12
  export interface SchemaFields extends EmptyObject {
13
+ /** Schema of the object */
11
14
  schema: Schema;
12
15
  }
16
+ /** Add the Schema Fields to an object */
13
17
  export type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields;
14
18
  //# sourceMappingURL=Schema.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAIjD,MAAM,MAAM,MAAM,GAAG,MAAM,CAAA;AAE3B,eAAO,MAAM,aAAa,uBAAiC,CAAA;AAC3D,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAA;AAEhD,eAAO,MAAM,QAAQ,UAAW,OAAO,KAAG,KAAK,IAAI,MAElD,CAAA;AAED,eAAO,MAAM,QAAQ;;;CAAyC,CAAA;AAG9D,MAAM,WAAW,YAAa,SAAQ,WAAW;IAE/C,MAAM,EAAE,MAAM,CAAA;CACf;AAGD,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,WAAW,GAAG,YAAY,GAAG,CAAC,GAAG,YAAY,CAAA"}
1
+ {"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAGjD,4CAA4C;AAC5C,MAAM,MAAM,MAAM,GAAG,MAAM,CAAA;AAE3B,eAAO,MAAM,aAAa,uBAAiC,CAAA;AAC3D,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAA;AAEhD,eAAO,MAAM,QAAQ,UAAW,OAAO,KAAG,KAAK,IAAI,MAElD,CAAA;AAED,eAAO,MAAM,QAAQ;;;CAAyC,CAAA;AAE9D,kCAAkC;AAClC,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAA;CACf;AAED,yCAAyC;AACzC,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,WAAW,GAAG,YAAY,GAAG,CAAC,GAAG,YAAY,CAAA"}
@@ -1,6 +1,8 @@
1
1
  import type { EmptyObject } from '@xylabs/object';
2
+ /** Object with a timestamp */
2
3
  export interface Timestamp {
3
4
  timestamp: number;
4
5
  }
6
+ /** Add a timestamp field to any object */
5
7
  export type WithTimestamp<T extends EmptyObject = EmptyObject> = T & Timestamp;
6
8
  //# sourceMappingURL=Timestamp.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Timestamp.d.ts","sourceRoot":"","sources":["../../src/Timestamp.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAGjD,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAA;CAClB;AAGD,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,CAAC,GAAG,SAAS,CAAA"}
1
+ {"version":3,"file":"Timestamp.d.ts","sourceRoot":"","sources":["../../src/Timestamp.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,8BAA8B;AAC9B,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,0CAA0C;AAC1C,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,CAAC,GAAG,SAAS,CAAA"}
@@ -3,16 +3,16 @@ export declare const isAnyPayload: (value: unknown) => value is Payload;
3
3
  export declare const asAnyPayload: {
4
4
  <TType extends {
5
5
  schema: string;
6
- } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
6
+ } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
7
7
  <TType extends {
8
8
  schema: string;
9
- } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
9
+ } & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
10
10
  schema: string;
11
11
  } & import("./Payload.ts").PayloadFields>, config?: import("@xylabs/object").TypeCheckConfig): TType;
12
12
  };
13
13
  export declare const isPayload: <T extends Payload>(schema: string[]) => (value: unknown) => value is T;
14
14
  export declare const asPayload: <T extends Payload>(schema: string[]) => {
15
- <TType extends T>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
16
- <TType extends T>(value: import(".store/@xylabs-promise-npm-4.1.0-cb5c924543/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
15
+ <TType extends T>(value: import(".store/@xylabs-promise-npm-4.3.2-fcbbee312a/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
16
+ <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;
17
17
  };
18
18
  //# sourceMappingURL=isPayload.d.ts.map
@@ -1,5 +1,15 @@
1
1
  import type { WithMeta } from './Meta.ts';
2
2
  import type { Payload } from './Payload.ts';
3
+ /**
4
+ * Return true if the value is a payload with the required meta fields
5
+ * @param value The value to check
6
+ * @returns True if the value is a payload with the required meta fields
7
+ */
3
8
  export declare const isWithHash: <T extends Payload>(value: T) => value is WithMeta<T>;
9
+ /**
10
+ * Return true if the value is a payload with the required meta fields
11
+ * @param value The value to check
12
+ * @returns True if the value is a payload with the required meta fields
13
+ */
4
14
  export declare const isPayloadWithHash: <T extends Payload>(value: unknown) => value is WithMeta<T>;
5
15
  //# sourceMappingURL=isPayloadWithHash.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"isPayloadWithHash.d.ts","sourceRoot":"","sources":["../../src/isPayloadWithHash.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAO3C,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,OAAO,SAAS,CAAC,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAE3E,CAAA;AAOD,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,OAAO,SAAS,OAAO,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAExF,CAAA"}
1
+ {"version":3,"file":"isPayloadWithHash.d.ts","sourceRoot":"","sources":["../../src/isPayloadWithHash.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,OAAO,SAAS,CAAC,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAE3E,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,OAAO,SAAS,OAAO,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAExF,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/payload-model",
3
- "version": "3.2.0",
3
+ "version": "3.3.1",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -37,13 +37,13 @@
37
37
  "module": "dist/neutral/index.mjs",
38
38
  "types": "dist/neutral/index.d.ts",
39
39
  "dependencies": {
40
- "@xylabs/hex": "^4.1.0",
41
- "@xylabs/object": "^4.1.0"
40
+ "@xylabs/hex": "^4.3.2",
41
+ "@xylabs/object": "^4.3.2"
42
42
  },
43
43
  "devDependencies": {
44
- "@xylabs/ts-scripts-yarn3": "^4.1.0",
45
- "@xylabs/tsconfig": "^4.1.0",
46
- "typescript": "^5.6.2"
44
+ "@xylabs/ts-scripts-yarn3": "^4.2.3",
45
+ "@xylabs/tsconfig": "^4.2.3",
46
+ "typescript": "^5.6.3"
47
47
  },
48
48
  "publishConfig": {
49
49
  "access": "public"