@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.
- package/dist/cjs/Payloads.d.ts +1 -1
- package/dist/cjs/Payloads.d.ts.map +1 -1
- package/dist/cjs/index.d.ts +5 -6
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +5 -6
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/isXyoPayloadOfSchemaType.d.ts +2 -2
- package/dist/cjs/isXyoPayloadOfSchemaType.d.ts.map +1 -1
- package/dist/esm/Payloads.d.ts +1 -1
- package/dist/esm/Payloads.d.ts.map +1 -1
- package/dist/esm/index.d.ts +5 -6
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +5 -6
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/isXyoPayloadOfSchemaType.d.ts +2 -2
- package/dist/esm/isXyoPayloadOfSchemaType.d.ts.map +1 -1
- package/package.json +7 -8
- package/src/Payloads.ts +1 -1
- package/src/index.ts +5 -6
- package/src/isXyoPayloadOfSchemaType.ts +1 -1
- package/dist/cjs/Builder/Builder.d.ts +0 -13
- package/dist/cjs/Builder/Builder.d.ts.map +0 -1
- package/dist/cjs/Builder/Builder.js +0 -27
- package/dist/cjs/Builder/Builder.js.map +0 -1
- package/dist/cjs/Builder/index.d.ts +0 -2
- package/dist/cjs/Builder/index.d.ts.map +0 -1
- package/dist/cjs/Builder/index.js +0 -5
- package/dist/cjs/Builder/index.js.map +0 -1
- package/dist/cjs/Huri/Huri.d.ts +0 -32
- package/dist/cjs/Huri/Huri.d.ts.map +0 -1
- package/dist/cjs/Huri/Huri.js +0 -111
- package/dist/cjs/Huri/Huri.js.map +0 -1
- package/dist/cjs/Huri/index.d.ts +0 -2
- package/dist/cjs/Huri/index.d.ts.map +0 -1
- package/dist/cjs/Huri/index.js +0 -5
- package/dist/cjs/Huri/index.js.map +0 -1
- package/dist/cjs/SchemaNameValidator.d.ts +0 -68
- package/dist/cjs/SchemaNameValidator.d.ts.map +0 -1
- package/dist/cjs/SchemaNameValidator.js +0 -127
- package/dist/cjs/SchemaNameValidator.js.map +0 -1
- package/dist/cjs/Test/index.d.ts +0 -2
- package/dist/cjs/Test/index.d.ts.map +0 -1
- package/dist/cjs/Test/index.js +0 -5
- package/dist/cjs/Test/index.js.map +0 -1
- package/dist/cjs/Test/testPayload.d.ts +0 -6
- package/dist/cjs/Test/testPayload.d.ts.map +0 -1
- package/dist/cjs/Test/testPayload.js +0 -16
- package/dist/cjs/Test/testPayload.js.map +0 -1
- package/dist/cjs/Validator/Validator.d.ts +0 -11
- package/dist/cjs/Validator/Validator.d.ts.map +0 -1
- package/dist/cjs/Validator/Validator.js +0 -32
- package/dist/cjs/Validator/Validator.js.map +0 -1
- package/dist/cjs/Validator/index.d.ts +0 -2
- package/dist/cjs/Validator/index.d.ts.map +0 -1
- package/dist/cjs/Validator/index.js +0 -5
- package/dist/cjs/Validator/index.js.map +0 -1
- package/dist/cjs/Wrapper/Wrapper.d.ts +0 -23
- package/dist/cjs/Wrapper/Wrapper.d.ts.map +0 -1
- package/dist/cjs/Wrapper/Wrapper.js +0 -63
- package/dist/cjs/Wrapper/Wrapper.js.map +0 -1
- package/dist/cjs/Wrapper/index.d.ts +0 -2
- package/dist/cjs/Wrapper/index.d.ts.map +0 -1
- package/dist/cjs/Wrapper/index.js +0 -5
- package/dist/cjs/Wrapper/index.js.map +0 -1
- package/dist/cjs/models/PayloadFindFilter.d.ts +0 -16
- package/dist/cjs/models/PayloadFindFilter.d.ts.map +0 -1
- package/dist/cjs/models/PayloadFindFilter.js +0 -3
- package/dist/cjs/models/PayloadFindFilter.js.map +0 -1
- package/dist/cjs/models/PayloadSet/PayloadSetPayload.d.ts +0 -8
- package/dist/cjs/models/PayloadSet/PayloadSetPayload.d.ts.map +0 -1
- package/dist/cjs/models/PayloadSet/PayloadSetPayload.js +0 -3
- package/dist/cjs/models/PayloadSet/PayloadSetPayload.js.map +0 -1
- package/dist/cjs/models/PayloadSet/PayloadSetSchema.d.ts +0 -3
- package/dist/cjs/models/PayloadSet/PayloadSetSchema.d.ts.map +0 -1
- package/dist/cjs/models/PayloadSet/PayloadSetSchema.js +0 -5
- package/dist/cjs/models/PayloadSet/PayloadSetSchema.js.map +0 -1
- package/dist/cjs/models/PayloadSet/index.d.ts +0 -3
- package/dist/cjs/models/PayloadSet/index.d.ts.map +0 -1
- package/dist/cjs/models/PayloadSet/index.js +0 -6
- package/dist/cjs/models/PayloadSet/index.js.map +0 -1
- package/dist/cjs/models/XyoPayload.d.ts +0 -21
- package/dist/cjs/models/XyoPayload.d.ts.map +0 -1
- package/dist/cjs/models/XyoPayload.js +0 -5
- package/dist/cjs/models/XyoPayload.js.map +0 -1
- package/dist/cjs/models/index.d.ts +0 -4
- package/dist/cjs/models/index.d.ts.map +0 -1
- package/dist/cjs/models/index.js +0 -7
- package/dist/cjs/models/index.js.map +0 -1
- package/dist/docs.json +0 -7103
- package/dist/esm/Builder/Builder.d.ts +0 -13
- package/dist/esm/Builder/Builder.d.ts.map +0 -1
- package/dist/esm/Builder/Builder.js +0 -27
- package/dist/esm/Builder/Builder.js.map +0 -1
- package/dist/esm/Builder/index.d.ts +0 -2
- package/dist/esm/Builder/index.d.ts.map +0 -1
- package/dist/esm/Builder/index.js +0 -2
- package/dist/esm/Builder/index.js.map +0 -1
- package/dist/esm/Huri/Huri.d.ts +0 -32
- package/dist/esm/Huri/Huri.d.ts.map +0 -1
- package/dist/esm/Huri/Huri.js +0 -104
- package/dist/esm/Huri/Huri.js.map +0 -1
- package/dist/esm/Huri/index.d.ts +0 -2
- package/dist/esm/Huri/index.d.ts.map +0 -1
- package/dist/esm/Huri/index.js +0 -2
- package/dist/esm/Huri/index.js.map +0 -1
- package/dist/esm/SchemaNameValidator.d.ts +0 -68
- package/dist/esm/SchemaNameValidator.d.ts.map +0 -1
- package/dist/esm/SchemaNameValidator.js +0 -114
- package/dist/esm/SchemaNameValidator.js.map +0 -1
- package/dist/esm/Test/index.d.ts +0 -2
- package/dist/esm/Test/index.d.ts.map +0 -1
- package/dist/esm/Test/index.js +0 -2
- package/dist/esm/Test/index.js.map +0 -1
- package/dist/esm/Test/testPayload.d.ts +0 -6
- package/dist/esm/Test/testPayload.d.ts.map +0 -1
- package/dist/esm/Test/testPayload.js +0 -12
- package/dist/esm/Test/testPayload.js.map +0 -1
- package/dist/esm/Validator/Validator.d.ts +0 -11
- package/dist/esm/Validator/Validator.d.ts.map +0 -1
- package/dist/esm/Validator/Validator.js +0 -28
- package/dist/esm/Validator/Validator.js.map +0 -1
- package/dist/esm/Validator/index.d.ts +0 -2
- package/dist/esm/Validator/index.d.ts.map +0 -1
- package/dist/esm/Validator/index.js +0 -2
- package/dist/esm/Validator/index.js.map +0 -1
- package/dist/esm/Wrapper/Wrapper.d.ts +0 -23
- package/dist/esm/Wrapper/Wrapper.d.ts.map +0 -1
- package/dist/esm/Wrapper/Wrapper.js +0 -52
- package/dist/esm/Wrapper/Wrapper.js.map +0 -1
- package/dist/esm/Wrapper/index.d.ts +0 -2
- package/dist/esm/Wrapper/index.d.ts.map +0 -1
- package/dist/esm/Wrapper/index.js +0 -2
- package/dist/esm/Wrapper/index.js.map +0 -1
- package/dist/esm/models/PayloadFindFilter.d.ts +0 -16
- package/dist/esm/models/PayloadFindFilter.d.ts.map +0 -1
- package/dist/esm/models/PayloadFindFilter.js +0 -2
- package/dist/esm/models/PayloadFindFilter.js.map +0 -1
- package/dist/esm/models/PayloadSet/PayloadSetPayload.d.ts +0 -8
- package/dist/esm/models/PayloadSet/PayloadSetPayload.d.ts.map +0 -1
- package/dist/esm/models/PayloadSet/PayloadSetPayload.js +0 -2
- package/dist/esm/models/PayloadSet/PayloadSetPayload.js.map +0 -1
- package/dist/esm/models/PayloadSet/PayloadSetSchema.d.ts +0 -3
- package/dist/esm/models/PayloadSet/PayloadSetSchema.d.ts.map +0 -1
- package/dist/esm/models/PayloadSet/PayloadSetSchema.js +0 -2
- package/dist/esm/models/PayloadSet/PayloadSetSchema.js.map +0 -1
- package/dist/esm/models/PayloadSet/index.d.ts +0 -3
- package/dist/esm/models/PayloadSet/index.d.ts.map +0 -1
- package/dist/esm/models/PayloadSet/index.js +0 -3
- package/dist/esm/models/PayloadSet/index.js.map +0 -1
- package/dist/esm/models/XyoPayload.d.ts +0 -21
- package/dist/esm/models/XyoPayload.d.ts.map +0 -1
- package/dist/esm/models/XyoPayload.js +0 -2
- package/dist/esm/models/XyoPayload.js.map +0 -1
- package/dist/esm/models/index.d.ts +0 -4
- package/dist/esm/models/index.d.ts.map +0 -1
- package/dist/esm/models/index.js +0 -4
- package/dist/esm/models/index.js.map +0 -1
- package/src/Builder/Builder.spec.ts +0 -38
- package/src/Builder/Builder.ts +0 -37
- package/src/Builder/index.ts +0 -1
- package/src/Huri/Huri.spec.ts +0 -92
- package/src/Huri/Huri.ts +0 -154
- package/src/Huri/index.ts +0 -1
- package/src/SchemaNameValidator.ts +0 -120
- package/src/Test/index.ts +0 -1
- package/src/Test/testPayload.ts +0 -16
- package/src/Validator/Validator.spec.ts +0 -52
- package/src/Validator/Validator.ts +0 -33
- package/src/Validator/index.ts +0 -1
- package/src/Wrapper/Wrapper.ts +0 -69
- package/src/Wrapper/index.ts +0 -1
- package/src/models/PayloadFindFilter.ts +0 -19
- package/src/models/PayloadSet/PayloadSetPayload.ts +0 -9
- package/src/models/PayloadSet/PayloadSetSchema.ts +0 -2
- package/src/models/PayloadSet/index.ts +0 -2
- package/src/models/XyoPayload.ts +0 -31
- 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
|
-
}
|
package/src/Validator/index.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from './Validator'
|
package/src/Wrapper/Wrapper.ts
DELETED
|
@@ -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
|
-
}
|
package/src/Wrapper/index.ts
DELETED
|
@@ -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>
|
package/src/models/XyoPayload.ts
DELETED
|
@@ -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 }>
|
package/src/models/index.ts
DELETED