@xyo-network/payload 2.42.13 → 2.42.14

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 (177) hide show
  1. package/dist/cjs/Payloads.d.ts +1 -1
  2. package/dist/cjs/Payloads.d.ts.map +1 -1
  3. package/dist/cjs/index.d.ts +5 -6
  4. package/dist/cjs/index.d.ts.map +1 -1
  5. package/dist/cjs/index.js +5 -6
  6. package/dist/cjs/index.js.map +1 -1
  7. package/dist/cjs/isXyoPayloadOfSchemaType.d.ts +2 -2
  8. package/dist/cjs/isXyoPayloadOfSchemaType.d.ts.map +1 -1
  9. package/dist/esm/Payloads.d.ts +1 -1
  10. package/dist/esm/Payloads.d.ts.map +1 -1
  11. package/dist/esm/index.d.ts +5 -6
  12. package/dist/esm/index.d.ts.map +1 -1
  13. package/dist/esm/index.js +5 -6
  14. package/dist/esm/index.js.map +1 -1
  15. package/dist/esm/isXyoPayloadOfSchemaType.d.ts +2 -2
  16. package/dist/esm/isXyoPayloadOfSchemaType.d.ts.map +1 -1
  17. package/package.json +7 -8
  18. package/src/Payloads.ts +1 -1
  19. package/src/index.ts +5 -6
  20. package/src/isXyoPayloadOfSchemaType.ts +1 -1
  21. package/dist/cjs/Builder/Builder.d.ts +0 -13
  22. package/dist/cjs/Builder/Builder.d.ts.map +0 -1
  23. package/dist/cjs/Builder/Builder.js +0 -27
  24. package/dist/cjs/Builder/Builder.js.map +0 -1
  25. package/dist/cjs/Builder/index.d.ts +0 -2
  26. package/dist/cjs/Builder/index.d.ts.map +0 -1
  27. package/dist/cjs/Builder/index.js +0 -5
  28. package/dist/cjs/Builder/index.js.map +0 -1
  29. package/dist/cjs/Huri/Huri.d.ts +0 -32
  30. package/dist/cjs/Huri/Huri.d.ts.map +0 -1
  31. package/dist/cjs/Huri/Huri.js +0 -111
  32. package/dist/cjs/Huri/Huri.js.map +0 -1
  33. package/dist/cjs/Huri/index.d.ts +0 -2
  34. package/dist/cjs/Huri/index.d.ts.map +0 -1
  35. package/dist/cjs/Huri/index.js +0 -5
  36. package/dist/cjs/Huri/index.js.map +0 -1
  37. package/dist/cjs/SchemaNameValidator.d.ts +0 -68
  38. package/dist/cjs/SchemaNameValidator.d.ts.map +0 -1
  39. package/dist/cjs/SchemaNameValidator.js +0 -127
  40. package/dist/cjs/SchemaNameValidator.js.map +0 -1
  41. package/dist/cjs/Test/index.d.ts +0 -2
  42. package/dist/cjs/Test/index.d.ts.map +0 -1
  43. package/dist/cjs/Test/index.js +0 -5
  44. package/dist/cjs/Test/index.js.map +0 -1
  45. package/dist/cjs/Test/testPayload.d.ts +0 -6
  46. package/dist/cjs/Test/testPayload.d.ts.map +0 -1
  47. package/dist/cjs/Test/testPayload.js +0 -16
  48. package/dist/cjs/Test/testPayload.js.map +0 -1
  49. package/dist/cjs/Validator/Validator.d.ts +0 -11
  50. package/dist/cjs/Validator/Validator.d.ts.map +0 -1
  51. package/dist/cjs/Validator/Validator.js +0 -32
  52. package/dist/cjs/Validator/Validator.js.map +0 -1
  53. package/dist/cjs/Validator/index.d.ts +0 -2
  54. package/dist/cjs/Validator/index.d.ts.map +0 -1
  55. package/dist/cjs/Validator/index.js +0 -5
  56. package/dist/cjs/Validator/index.js.map +0 -1
  57. package/dist/cjs/Wrapper/Wrapper.d.ts +0 -23
  58. package/dist/cjs/Wrapper/Wrapper.d.ts.map +0 -1
  59. package/dist/cjs/Wrapper/Wrapper.js +0 -63
  60. package/dist/cjs/Wrapper/Wrapper.js.map +0 -1
  61. package/dist/cjs/Wrapper/index.d.ts +0 -2
  62. package/dist/cjs/Wrapper/index.d.ts.map +0 -1
  63. package/dist/cjs/Wrapper/index.js +0 -5
  64. package/dist/cjs/Wrapper/index.js.map +0 -1
  65. package/dist/cjs/models/PayloadFindFilter.d.ts +0 -16
  66. package/dist/cjs/models/PayloadFindFilter.d.ts.map +0 -1
  67. package/dist/cjs/models/PayloadFindFilter.js +0 -3
  68. package/dist/cjs/models/PayloadFindFilter.js.map +0 -1
  69. package/dist/cjs/models/PayloadSet/PayloadSetPayload.d.ts +0 -8
  70. package/dist/cjs/models/PayloadSet/PayloadSetPayload.d.ts.map +0 -1
  71. package/dist/cjs/models/PayloadSet/PayloadSetPayload.js +0 -3
  72. package/dist/cjs/models/PayloadSet/PayloadSetPayload.js.map +0 -1
  73. package/dist/cjs/models/PayloadSet/PayloadSetSchema.d.ts +0 -3
  74. package/dist/cjs/models/PayloadSet/PayloadSetSchema.d.ts.map +0 -1
  75. package/dist/cjs/models/PayloadSet/PayloadSetSchema.js +0 -5
  76. package/dist/cjs/models/PayloadSet/PayloadSetSchema.js.map +0 -1
  77. package/dist/cjs/models/PayloadSet/index.d.ts +0 -3
  78. package/dist/cjs/models/PayloadSet/index.d.ts.map +0 -1
  79. package/dist/cjs/models/PayloadSet/index.js +0 -6
  80. package/dist/cjs/models/PayloadSet/index.js.map +0 -1
  81. package/dist/cjs/models/XyoPayload.d.ts +0 -21
  82. package/dist/cjs/models/XyoPayload.d.ts.map +0 -1
  83. package/dist/cjs/models/XyoPayload.js +0 -5
  84. package/dist/cjs/models/XyoPayload.js.map +0 -1
  85. package/dist/cjs/models/index.d.ts +0 -4
  86. package/dist/cjs/models/index.d.ts.map +0 -1
  87. package/dist/cjs/models/index.js +0 -7
  88. package/dist/cjs/models/index.js.map +0 -1
  89. package/dist/docs.json +0 -7103
  90. package/dist/esm/Builder/Builder.d.ts +0 -13
  91. package/dist/esm/Builder/Builder.d.ts.map +0 -1
  92. package/dist/esm/Builder/Builder.js +0 -27
  93. package/dist/esm/Builder/Builder.js.map +0 -1
  94. package/dist/esm/Builder/index.d.ts +0 -2
  95. package/dist/esm/Builder/index.d.ts.map +0 -1
  96. package/dist/esm/Builder/index.js +0 -2
  97. package/dist/esm/Builder/index.js.map +0 -1
  98. package/dist/esm/Huri/Huri.d.ts +0 -32
  99. package/dist/esm/Huri/Huri.d.ts.map +0 -1
  100. package/dist/esm/Huri/Huri.js +0 -104
  101. package/dist/esm/Huri/Huri.js.map +0 -1
  102. package/dist/esm/Huri/index.d.ts +0 -2
  103. package/dist/esm/Huri/index.d.ts.map +0 -1
  104. package/dist/esm/Huri/index.js +0 -2
  105. package/dist/esm/Huri/index.js.map +0 -1
  106. package/dist/esm/SchemaNameValidator.d.ts +0 -68
  107. package/dist/esm/SchemaNameValidator.d.ts.map +0 -1
  108. package/dist/esm/SchemaNameValidator.js +0 -114
  109. package/dist/esm/SchemaNameValidator.js.map +0 -1
  110. package/dist/esm/Test/index.d.ts +0 -2
  111. package/dist/esm/Test/index.d.ts.map +0 -1
  112. package/dist/esm/Test/index.js +0 -2
  113. package/dist/esm/Test/index.js.map +0 -1
  114. package/dist/esm/Test/testPayload.d.ts +0 -6
  115. package/dist/esm/Test/testPayload.d.ts.map +0 -1
  116. package/dist/esm/Test/testPayload.js +0 -12
  117. package/dist/esm/Test/testPayload.js.map +0 -1
  118. package/dist/esm/Validator/Validator.d.ts +0 -11
  119. package/dist/esm/Validator/Validator.d.ts.map +0 -1
  120. package/dist/esm/Validator/Validator.js +0 -28
  121. package/dist/esm/Validator/Validator.js.map +0 -1
  122. package/dist/esm/Validator/index.d.ts +0 -2
  123. package/dist/esm/Validator/index.d.ts.map +0 -1
  124. package/dist/esm/Validator/index.js +0 -2
  125. package/dist/esm/Validator/index.js.map +0 -1
  126. package/dist/esm/Wrapper/Wrapper.d.ts +0 -23
  127. package/dist/esm/Wrapper/Wrapper.d.ts.map +0 -1
  128. package/dist/esm/Wrapper/Wrapper.js +0 -52
  129. package/dist/esm/Wrapper/Wrapper.js.map +0 -1
  130. package/dist/esm/Wrapper/index.d.ts +0 -2
  131. package/dist/esm/Wrapper/index.d.ts.map +0 -1
  132. package/dist/esm/Wrapper/index.js +0 -2
  133. package/dist/esm/Wrapper/index.js.map +0 -1
  134. package/dist/esm/models/PayloadFindFilter.d.ts +0 -16
  135. package/dist/esm/models/PayloadFindFilter.d.ts.map +0 -1
  136. package/dist/esm/models/PayloadFindFilter.js +0 -2
  137. package/dist/esm/models/PayloadFindFilter.js.map +0 -1
  138. package/dist/esm/models/PayloadSet/PayloadSetPayload.d.ts +0 -8
  139. package/dist/esm/models/PayloadSet/PayloadSetPayload.d.ts.map +0 -1
  140. package/dist/esm/models/PayloadSet/PayloadSetPayload.js +0 -2
  141. package/dist/esm/models/PayloadSet/PayloadSetPayload.js.map +0 -1
  142. package/dist/esm/models/PayloadSet/PayloadSetSchema.d.ts +0 -3
  143. package/dist/esm/models/PayloadSet/PayloadSetSchema.d.ts.map +0 -1
  144. package/dist/esm/models/PayloadSet/PayloadSetSchema.js +0 -2
  145. package/dist/esm/models/PayloadSet/PayloadSetSchema.js.map +0 -1
  146. package/dist/esm/models/PayloadSet/index.d.ts +0 -3
  147. package/dist/esm/models/PayloadSet/index.d.ts.map +0 -1
  148. package/dist/esm/models/PayloadSet/index.js +0 -3
  149. package/dist/esm/models/PayloadSet/index.js.map +0 -1
  150. package/dist/esm/models/XyoPayload.d.ts +0 -21
  151. package/dist/esm/models/XyoPayload.d.ts.map +0 -1
  152. package/dist/esm/models/XyoPayload.js +0 -2
  153. package/dist/esm/models/XyoPayload.js.map +0 -1
  154. package/dist/esm/models/index.d.ts +0 -4
  155. package/dist/esm/models/index.d.ts.map +0 -1
  156. package/dist/esm/models/index.js +0 -4
  157. package/dist/esm/models/index.js.map +0 -1
  158. package/src/Builder/Builder.spec.ts +0 -38
  159. package/src/Builder/Builder.ts +0 -37
  160. package/src/Builder/index.ts +0 -1
  161. package/src/Huri/Huri.spec.ts +0 -92
  162. package/src/Huri/Huri.ts +0 -154
  163. package/src/Huri/index.ts +0 -1
  164. package/src/SchemaNameValidator.ts +0 -120
  165. package/src/Test/index.ts +0 -1
  166. package/src/Test/testPayload.ts +0 -16
  167. package/src/Validator/Validator.spec.ts +0 -52
  168. package/src/Validator/Validator.ts +0 -33
  169. package/src/Validator/index.ts +0 -1
  170. package/src/Wrapper/Wrapper.ts +0 -69
  171. package/src/Wrapper/index.ts +0 -1
  172. package/src/models/PayloadFindFilter.ts +0 -19
  173. package/src/models/PayloadSet/PayloadSetPayload.ts +0 -9
  174. package/src/models/PayloadSet/PayloadSetSchema.ts +0 -2
  175. package/src/models/PayloadSet/index.ts +0 -2
  176. package/src/models/XyoPayload.ts +0 -31
  177. package/src/models/index.ts +0 -3
@@ -1,33 +0,0 @@
1
- import { Validator, XyoValidatorBase } from '@xyo-network/core'
2
-
3
- import { XyoPayload } from '../models'
4
- import { XyoSchemaNameValidator } from '../SchemaNameValidator'
5
-
6
- export class PayloadValidator<T extends XyoPayload = XyoPayload> extends XyoValidatorBase<T> implements Validator<T> {
7
- private _schemaValidator?: XyoSchemaNameValidator
8
-
9
- constructor(payload: T) {
10
- super(payload)
11
- }
12
-
13
- get schemaValidator() {
14
- this._schemaValidator = this._schemaValidator ?? new XyoSchemaNameValidator(this.obj.schema ?? '')
15
- return this._schemaValidator
16
- }
17
-
18
- public schemaName() {
19
- const errors: Error[] = []
20
- if (this.obj.schema === undefined) {
21
- errors.push(Error('schema missing'))
22
- } else {
23
- errors.push(...this.schemaValidator.all())
24
- }
25
- return errors
26
- }
27
-
28
- public validate() {
29
- const errors: Error[] = []
30
- errors.push(...this.schemaName())
31
- return errors
32
- }
33
- }
@@ -1 +0,0 @@
1
- export * from './Validator'
@@ -1,69 +0,0 @@
1
- import { assertEx } from '@xylabs/assert'
2
- import { DataLike, deepOmitUnderscoreFields, Hasher } from '@xyo-network/core'
3
- import { Promisable } from '@xyo-network/promise'
4
-
5
- import { Huri } from '../Huri'
6
- import { XyoPayload } from '../models'
7
- import { PayloadValidator } from '../Validator'
8
-
9
- export abstract class PayloadWrapperBase<TPayload extends XyoPayload = XyoPayload> extends Hasher<TPayload> {
10
- public get body() {
11
- return deepOmitUnderscoreFields<TPayload>(this.obj)
12
- }
13
-
14
- get errors() {
15
- return new PayloadValidator(this.payload).validate()
16
- }
17
-
18
- public get payload() {
19
- return assertEx(this.obj, 'Missing payload object')
20
- }
21
-
22
- public get previousHash() {
23
- return null
24
- }
25
-
26
- public get schema() {
27
- return this.payload.schema
28
- }
29
-
30
- //intentionally not naming this 'schema' so that the wrapper is not confused for a XyoPayload
31
- public get schemaName() {
32
- return assertEx(this.obj.schema, 'Missing payload schema')
33
- }
34
-
35
- get valid() {
36
- return this.errors.length === 0
37
- }
38
-
39
- public static load(_address: DataLike | Huri): Promisable<PayloadWrapperBase | null> {
40
- throw Error('Not implemented')
41
- }
42
-
43
- public static parse(_obj: unknown): PayloadWrapperBase {
44
- throw Error('Not implemented')
45
- }
46
- }
47
-
48
- export class PayloadWrapper<TPayload extends XyoPayload = XyoPayload> extends PayloadWrapperBase<TPayload> {
49
- private isPayloadWrapper = true
50
-
51
- public static override async load(address: DataLike | Huri) {
52
- const payload = await new Huri(address).fetch()
53
- return payload ? new PayloadWrapper(payload) : null
54
- }
55
-
56
- public static override parse<T extends XyoPayload = XyoPayload>(obj: unknown): PayloadWrapper<T> {
57
- assertEx(!Array.isArray(obj), 'Array can not be converted to PayloadWrapper')
58
- switch (typeof obj) {
59
- case 'object': {
60
- const castWrapper = obj as PayloadWrapper<T>
61
- return assertEx(
62
- castWrapper?.isPayloadWrapper ? castWrapper : (obj as XyoPayload).schema ? new PayloadWrapper(obj as T) : null,
63
- 'Unable to parse payload object',
64
- )
65
- }
66
- }
67
- throw Error(`Unable to parse [${typeof obj}]`)
68
- }
69
- }
@@ -1 +0,0 @@
1
- export * from './Wrapper'
@@ -1,19 +0,0 @@
1
- /** @deprecated use offset as a string (hash) instead */
2
- export interface PayloadFindFilterTimeOffset {
3
- offset?: number
4
- }
5
-
6
- export interface PayloadFindFilterHashOffset {
7
- offset?: string
8
- }
9
-
10
- // eslint-disable-next-line deprecation/deprecation
11
- export type PayloadFindFilterOffset = PayloadFindFilterTimeOffset | PayloadFindFilterHashOffset
12
-
13
- export type PayloadFindFilter = {
14
- limit?: number
15
- order?: 'desc' | 'asc'
16
- schema?: string | string[]
17
- /** @deprecated use offset instead */
18
- timestamp?: number
19
- } & PayloadFindFilterOffset
@@ -1,9 +0,0 @@
1
- import { XyoPayload } from '../XyoPayload'
2
- import { PayloadSetSchema } from './PayloadSetSchema'
3
-
4
- export interface PayloadSet {
5
- optional?: Record<string, number>
6
- required?: Record<string, number>
7
- }
8
-
9
- export type PayloadSetPayload = XyoPayload<PayloadSet, PayloadSetSchema>
@@ -1,2 +0,0 @@
1
- export type PayloadSetSchema = 'network.xyo.payload.set'
2
- export const PayloadSetSchema: PayloadSetSchema = 'network.xyo.payload.set'
@@ -1,2 +0,0 @@
1
- export * from './PayloadSetPayload'
2
- export * from './PayloadSetSchema'
@@ -1,31 +0,0 @@
1
- import { EmptyObject } from '@xyo-network/core'
2
-
3
- export type WithTimestamp<T extends EmptyObject = EmptyObject> = T & { timestamp: number }
4
-
5
- export type XyoPayloadSchema = 'network.xyo.payload'
6
- export const XyoPayloadSchema: XyoPayloadSchema = 'network.xyo.payload'
7
-
8
- export type SchemaFields = {
9
- schema: string
10
- }
11
-
12
- export type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields
13
-
14
- export type PayloadFields = {
15
- sources?: string[]
16
- timestamp?: number
17
- }
18
-
19
- export type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>
20
-
21
- export type XyoPayload<
22
- T extends void | EmptyObject | WithSchema = void,
23
- S extends string = T extends WithSchema ? T['schema'] : string,
24
- > = T extends WithSchema
25
- ? /* Type sent is an XyoPayload */
26
- WithPayload<T>
27
- : T extends EmptyObject
28
- ? /* Type sent is an Object */
29
- WithPayload<T & { schema: S }>
30
- : /* Type sent is void */
31
- WithPayload<{ schema: S }>
@@ -1,3 +0,0 @@
1
- export * from './PayloadFindFilter'
2
- export * from './PayloadSet'
3
- export * from './XyoPayload'