@xyo-network/diviner-payload-model 2.56.0

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 (53) hide show
  1. package/LICENSE +165 -0
  2. package/README.md +13 -0
  3. package/dist/cjs/Config.js +6 -0
  4. package/dist/cjs/Config.js.map +1 -0
  5. package/dist/cjs/Params.js +3 -0
  6. package/dist/cjs/Params.js.map +1 -0
  7. package/dist/cjs/Predicate.js +3 -0
  8. package/dist/cjs/Predicate.js.map +1 -0
  9. package/dist/cjs/Query.js +8 -0
  10. package/dist/cjs/Query.js.map +1 -0
  11. package/dist/cjs/Schema.js +5 -0
  12. package/dist/cjs/Schema.js.map +1 -0
  13. package/dist/cjs/SortDirection.js +3 -0
  14. package/dist/cjs/SortDirection.js.map +1 -0
  15. package/dist/cjs/index.js +10 -0
  16. package/dist/cjs/index.js.map +1 -0
  17. package/dist/docs.json +1000 -0
  18. package/dist/esm/Config.js +3 -0
  19. package/dist/esm/Config.js.map +1 -0
  20. package/dist/esm/Params.js +2 -0
  21. package/dist/esm/Params.js.map +1 -0
  22. package/dist/esm/Predicate.js +2 -0
  23. package/dist/esm/Predicate.js.map +1 -0
  24. package/dist/esm/Query.js +4 -0
  25. package/dist/esm/Query.js.map +1 -0
  26. package/dist/esm/Schema.js +2 -0
  27. package/dist/esm/Schema.js.map +1 -0
  28. package/dist/esm/SortDirection.js +2 -0
  29. package/dist/esm/SortDirection.js.map +1 -0
  30. package/dist/esm/index.js +7 -0
  31. package/dist/esm/index.js.map +1 -0
  32. package/dist/types/Config.d.ts +8 -0
  33. package/dist/types/Config.d.ts.map +1 -0
  34. package/dist/types/Params.d.ts +5 -0
  35. package/dist/types/Params.d.ts.map +1 -0
  36. package/dist/types/Predicate.d.ts +11 -0
  37. package/dist/types/Predicate.d.ts.map +1 -0
  38. package/dist/types/Query.d.ts +20 -0
  39. package/dist/types/Query.d.ts.map +1 -0
  40. package/dist/types/Schema.d.ts +3 -0
  41. package/dist/types/Schema.d.ts.map +1 -0
  42. package/dist/types/SortDirection.d.ts +2 -0
  43. package/dist/types/SortDirection.d.ts.map +1 -0
  44. package/dist/types/index.d.ts +7 -0
  45. package/dist/types/index.d.ts.map +1 -0
  46. package/package.json +57 -0
  47. package/src/Config.ts +10 -0
  48. package/src/Params.ts +6 -0
  49. package/src/Predicate.ts +15 -0
  50. package/src/Query.ts +11 -0
  51. package/src/Schema.ts +2 -0
  52. package/src/SortDirection.ts +1 -0
  53. package/src/index.ts +6 -0
@@ -0,0 +1,3 @@
1
+ import { PayloadDivinerSchema } from './Schema';
2
+ export const PayloadDivinerConfigSchema = `${PayloadDivinerSchema}.config`;
3
+ //# sourceMappingURL=Config.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Config.js","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAG/C,MAAM,CAAC,MAAM,0BAA0B,GAA+B,GAAG,oBAAoB,SAAS,CAAA"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=Params.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Params.js","sourceRoot":"","sources":["../../src/Params.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=Predicate.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Predicate.js","sourceRoot":"","sources":["../../src/Predicate.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ import { PayloadDivinerSchema } from './Schema';
2
+ export const PayloadDivinerQuerySchema = `${PayloadDivinerSchema}.query`;
3
+ export const isPayloadDivinerQueryPayload = (x) => x?.schema === PayloadDivinerQuerySchema;
4
+ //# sourceMappingURL=Query.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Query.js","sourceRoot":"","sources":["../../src/Query.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAG/C,MAAM,CAAC,MAAM,yBAAyB,GAA8B,GAAG,oBAAoB,QAAQ,CAAA;AAGnG,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAkB,EAAmC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,yBAAyB,CAAA"}
@@ -0,0 +1,2 @@
1
+ export const PayloadDivinerSchema = 'network.xyo.diviner.payload';
2
+ //# sourceMappingURL=Schema.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,MAAM,oBAAoB,GAAyB,6BAA6B,CAAA"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=SortDirection.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SortDirection.js","sourceRoot":"","sources":["../../src/SortDirection.ts"],"names":[],"mappings":""}
@@ -0,0 +1,7 @@
1
+ export * from './Config';
2
+ export * from './Params';
3
+ export * from './Predicate';
4
+ export * from './Query';
5
+ export * from './Schema';
6
+ export * from './SortDirection';
7
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,iBAAiB,CAAA"}
@@ -0,0 +1,8 @@
1
+ import { DivinerConfig } from '@xyo-network/diviner-model';
2
+ import { PayloadDivinerSchema } from './Schema';
3
+ export type PayloadDivinerConfigSchema = `${PayloadDivinerSchema}.config`;
4
+ export declare const PayloadDivinerConfigSchema: PayloadDivinerConfigSchema;
5
+ export type PayloadDivinerConfig = DivinerConfig<{
6
+ schema: PayloadDivinerConfigSchema;
7
+ }>;
8
+ //# sourceMappingURL=Config.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C,MAAM,MAAM,0BAA0B,GAAG,GAAG,oBAAoB,SAAS,CAAA;AACzE,eAAO,MAAM,0BAA0B,EAAE,0BAA6D,CAAA;AAEtG,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC;IAC/C,MAAM,EAAE,0BAA0B,CAAA;CACnC,CAAC,CAAA"}
@@ -0,0 +1,5 @@
1
+ import { DivinerParams } from '@xyo-network/diviner-model';
2
+ import { AnyConfigSchema } from '@xyo-network/module-model';
3
+ import { PayloadDivinerConfig } from './Config';
4
+ export type PayloadDivinerParams = DivinerParams<AnyConfigSchema<PayloadDivinerConfig>>;
5
+ //# sourceMappingURL=Params.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Params.d.ts","sourceRoot":"","sources":["../../src/Params.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAE3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC,CAAA"}
@@ -0,0 +1,11 @@
1
+ import { AnyObject } from '@xyo-network/core';
2
+ import { SortDirection } from './SortDirection';
3
+ export type PayloadDivinerPredicate<T extends AnyObject = AnyObject> = Partial<{
4
+ address: string | string[];
5
+ hash: string;
6
+ limit: number;
7
+ offset: number;
8
+ order: SortDirection;
9
+ schemas: string[];
10
+ }> & Partial<T>;
11
+ //# sourceMappingURL=Predicate.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Predicate.d.ts","sourceRoot":"","sources":["../../src/Predicate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAE7C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAI/C,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI,OAAO,CAAC;IAC7E,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,aAAa,CAAA;IACpB,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB,CAAC,GACA,OAAO,CAAC,CAAC,CAAC,CAAA"}
@@ -0,0 +1,20 @@
1
+ import { Query } from '@xyo-network/module-model';
2
+ import { Payload } from '@xyo-network/payload-model';
3
+ import { PayloadDivinerPredicate } from './Predicate';
4
+ import { PayloadDivinerSchema } from './Schema';
5
+ export type PayloadDivinerQuerySchema = `${PayloadDivinerSchema}.query`;
6
+ export declare const PayloadDivinerQuerySchema: PayloadDivinerQuerySchema;
7
+ export type PayloadDivinerQueryPayload = Query<{
8
+ schema: PayloadDivinerQuerySchema;
9
+ } & PayloadDivinerPredicate>;
10
+ export declare const isPayloadDivinerQueryPayload: (x?: Payload | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
11
+ schema: PayloadDivinerQuerySchema;
12
+ } & Partial<{
13
+ address: string | string[];
14
+ hash: string;
15
+ limit: number;
16
+ offset: number;
17
+ order: import("./SortDirection").SortDirection;
18
+ schemas: string[];
19
+ }> & Partial<import("@xyo-network/core").AnyObject> & import("@xyo-network/module-model").QueryFields;
20
+ //# sourceMappingURL=Query.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../src/Query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAA;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C,MAAM,MAAM,yBAAyB,GAAG,GAAG,oBAAoB,QAAQ,CAAA;AACvE,eAAO,MAAM,yBAAyB,EAAE,yBAA2D,CAAA;AAEnG,MAAM,MAAM,0BAA0B,GAAG,KAAK,CAAC;IAAE,MAAM,EAAE,yBAAyB,CAAA;CAAE,GAAG,uBAAuB,CAAC,CAAA;AAC/G,eAAO,MAAM,4BAA4B,OAAQ,OAAO,GAAG,IAAI;YADN,yBAAyB;;;;;;;;qGAC0D,CAAA"}
@@ -0,0 +1,3 @@
1
+ export type PayloadDivinerSchema = 'network.xyo.diviner.payload';
2
+ export declare const PayloadDivinerSchema: PayloadDivinerSchema;
3
+ //# sourceMappingURL=Schema.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,oBAAoB,GAAG,6BAA6B,CAAA;AAChE,eAAO,MAAM,oBAAoB,EAAE,oBAAoD,CAAA"}
@@ -0,0 +1,2 @@
1
+ export type SortDirection = 'asc' | 'desc';
2
+ //# sourceMappingURL=SortDirection.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SortDirection.d.ts","sourceRoot":"","sources":["../../src/SortDirection.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,CAAA"}
@@ -0,0 +1,7 @@
1
+ export * from './Config';
2
+ export * from './Params';
3
+ export * from './Predicate';
4
+ export * from './Query';
5
+ export * from './Schema';
6
+ export * from './SortDirection';
7
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,iBAAiB,CAAA"}
package/package.json ADDED
@@ -0,0 +1,57 @@
1
+ {
2
+ "name": "@xyo-network/diviner-payload-model",
3
+ "author": {
4
+ "email": "support@xyo.network",
5
+ "name": "XYO Development Team",
6
+ "url": "https://xyo.network"
7
+ },
8
+ "bugs": {
9
+ "email": "support@xyo.network",
10
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
11
+ },
12
+ "dependencies": {
13
+ "@xyo-network/core": "^2.56.0",
14
+ "@xyo-network/diviner-model": "^2.56.0",
15
+ "@xyo-network/module-model": "^2.56.0",
16
+ "@xyo-network/payload-model": "^2.56.0"
17
+ },
18
+ "devDependencies": {
19
+ "@xylabs/ts-scripts-yarn3": "^2.16.5",
20
+ "@xylabs/tsconfig": "^2.16.5",
21
+ "typescript": "^4.9.5"
22
+ },
23
+ "description": "Primary SDK for using XYO Protocol 2.0",
24
+ "browser": "dist/esm/index.js",
25
+ "docs": "dist/docs.json",
26
+ "exports": {
27
+ ".": {
28
+ "node": {
29
+ "import": "./dist/esm/index.js",
30
+ "require": "./dist/cjs/index.js"
31
+ },
32
+ "browser": {
33
+ "import": "./dist/esm/index.js",
34
+ "require": "./dist/cjs/index.js"
35
+ },
36
+ "default": "./dist/esm/index.js"
37
+ },
38
+ "./dist/docs.json": {
39
+ "default": "./dist/docs.json"
40
+ },
41
+ "./package.json": "./package.json"
42
+ },
43
+ "main": "dist/cjs/index.js",
44
+ "module": "dist/esm/index.js",
45
+ "homepage": "https://xyo.network",
46
+ "license": "LGPL-3.0",
47
+ "publishConfig": {
48
+ "access": "public"
49
+ },
50
+ "repository": {
51
+ "type": "git",
52
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
53
+ },
54
+ "sideEffects": false,
55
+ "types": "dist/types/index.d.ts",
56
+ "version": "2.56.0"
57
+ }
package/src/Config.ts ADDED
@@ -0,0 +1,10 @@
1
+ import { DivinerConfig } from '@xyo-network/diviner-model'
2
+
3
+ import { PayloadDivinerSchema } from './Schema'
4
+
5
+ export type PayloadDivinerConfigSchema = `${PayloadDivinerSchema}.config`
6
+ export const PayloadDivinerConfigSchema: PayloadDivinerConfigSchema = `${PayloadDivinerSchema}.config`
7
+
8
+ export type PayloadDivinerConfig = DivinerConfig<{
9
+ schema: PayloadDivinerConfigSchema
10
+ }>
package/src/Params.ts ADDED
@@ -0,0 +1,6 @@
1
+ import { DivinerParams } from '@xyo-network/diviner-model'
2
+ import { AnyConfigSchema } from '@xyo-network/module-model'
3
+
4
+ import { PayloadDivinerConfig } from './Config'
5
+
6
+ export type PayloadDivinerParams = DivinerParams<AnyConfigSchema<PayloadDivinerConfig>>
@@ -0,0 +1,15 @@
1
+ import { AnyObject } from '@xyo-network/core'
2
+
3
+ import { SortDirection } from './SortDirection'
4
+
5
+ /* Note: Added Omit to PayloadFindDiviner for offset until we support hash based offsets */
6
+
7
+ export type PayloadDivinerPredicate<T extends AnyObject = AnyObject> = Partial<{
8
+ address: string | string[]
9
+ hash: string
10
+ limit: number
11
+ offset: number
12
+ order: SortDirection
13
+ schemas: string[]
14
+ }> &
15
+ Partial<T>
package/src/Query.ts ADDED
@@ -0,0 +1,11 @@
1
+ import { Query } from '@xyo-network/module-model'
2
+ import { Payload } from '@xyo-network/payload-model'
3
+
4
+ import { PayloadDivinerPredicate } from './Predicate'
5
+ import { PayloadDivinerSchema } from './Schema'
6
+
7
+ export type PayloadDivinerQuerySchema = `${PayloadDivinerSchema}.query`
8
+ export const PayloadDivinerQuerySchema: PayloadDivinerQuerySchema = `${PayloadDivinerSchema}.query`
9
+
10
+ export type PayloadDivinerQueryPayload = Query<{ schema: PayloadDivinerQuerySchema } & PayloadDivinerPredicate>
11
+ export const isPayloadDivinerQueryPayload = (x?: Payload | null): x is PayloadDivinerQueryPayload => x?.schema === PayloadDivinerQuerySchema
package/src/Schema.ts ADDED
@@ -0,0 +1,2 @@
1
+ export type PayloadDivinerSchema = 'network.xyo.diviner.payload'
2
+ export const PayloadDivinerSchema: PayloadDivinerSchema = 'network.xyo.diviner.payload'
@@ -0,0 +1 @@
1
+ export type SortDirection = 'asc' | 'desc'
package/src/index.ts ADDED
@@ -0,0 +1,6 @@
1
+ export * from './Config'
2
+ export * from './Params'
3
+ export * from './Predicate'
4
+ export * from './Query'
5
+ export * from './Schema'
6
+ export * from './SortDirection'