@xyo-network/query-payload-plugin 5.3.24 → 5.3.26

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 (2) hide show
  1. package/README.md +120 -10
  2. package/package.json +10 -10
package/README.md CHANGED
@@ -1,23 +1,133 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/query-payload-plugin
2
4
 
3
- [![logo][]](https://xyo.network)
5
+ [![npm][npm-badge]][npm-link]
6
+ [![license][license-badge]][license-link]
7
+
8
+ > Typescript/Javascript Plugins for XYO Platform
9
+
10
+ ## Install
11
+
12
+ Using npm:
4
13
 
5
- Version: 5.0.2
14
+ ```sh
15
+ npm install {{name}}
16
+ ```
6
17
 
7
- Typescript/Javascript Plugins for XYO Platform
18
+ Using yarn:
8
19
 
9
- ## Documentation
20
+ ```sh
21
+ yarn add {{name}}
22
+ ```
10
23
 
11
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__query-payload-plugin)
24
+ Using pnpm:
25
+
26
+ ```sh
27
+ pnpm add {{name}}
28
+ ```
29
+
30
+ Using bun:
31
+
32
+ ```sh
33
+ bun add {{name}}
34
+ ```
12
35
 
13
- Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
14
36
 
15
37
  ## License
16
38
 
17
- > See the [LICENSE](LICENSE) file for license details
39
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
40
+
41
+ ## Reference
42
+
43
+ ### packages
44
+
45
+ ### core-payload-plugins
46
+
47
+ ### packages
48
+
49
+ ### query
50
+
51
+ ### .temp-typedoc
52
+
53
+ ### functions
54
+
55
+ ### <a id="QueryPayloadPlugin"></a>QueryPayloadPlugin
56
+
57
+ [**@xyo-network/query-payload-plugin**](#../README)
58
+
59
+ ***
60
+
61
+ ```ts
62
+ function QueryPayloadPlugin(): PayloadPlugin<QueryPayload>;
63
+ ```
64
+
65
+ ## Returns
66
+
67
+ `PayloadPlugin`\<[`QueryPayload`](#../type-aliases/QueryPayload)\>
68
+
69
+ ### <a id="queryPayloadTemplate"></a>queryPayloadTemplate
70
+
71
+ [**@xyo-network/query-payload-plugin**](#../README)
72
+
73
+ ***
74
+
75
+ ```ts
76
+ function queryPayloadTemplate(): QueryPayload;
77
+ ```
78
+
79
+ ## Returns
80
+
81
+ [`QueryPayload`](#../type-aliases/QueryPayload)
82
+
83
+ ### type-aliases
84
+
85
+ ### <a id="QueryPayload"></a>QueryPayload
86
+
87
+ [**@xyo-network/query-payload-plugin**](#../README)
88
+
89
+ ***
90
+
91
+ ```ts
92
+ type QueryPayload = Payload<{
93
+ query: Schema;
94
+ schema: QuerySchema;
95
+ }>;
96
+ ```
97
+
98
+ ### <a id="QuerySchema"></a>QuerySchema
99
+
100
+ [**@xyo-network/query-payload-plugin**](#../README)
101
+
102
+ ***
103
+
104
+ ```ts
105
+ type QuerySchema = typeof QuerySchema;
106
+ ```
107
+
108
+ ### variables
109
+
110
+ ### <a id="QuerySchema"></a>QuerySchema
111
+
112
+ [**@xyo-network/query-payload-plugin**](#../README)
113
+
114
+ ***
115
+
116
+ ```ts
117
+ const QuerySchema: "network.xyo.query" & object;
118
+ ```
119
+
120
+ ## Type Declaration
121
+
122
+ ### \_\_schema
18
123
 
19
- ## Credits
124
+ ```ts
125
+ readonly __schema: true;
126
+ ```
20
127
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
128
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
129
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
130
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/query-payload-plugin.svg
131
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/query-payload-plugin
132
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/query-payload-plugin.svg
133
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/query-payload-plugin",
3
- "version": "5.3.24",
3
+ "version": "5.3.26",
4
4
  "description": "Typescript/Javascript Plugins for XYO Platform",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -22,11 +22,11 @@
22
22
  "exports": {
23
23
  ".": {
24
24
  "types": "./dist/neutral/index.d.ts",
25
+ "import": "./dist/neutral/index.mjs",
25
26
  "default": "./dist/neutral/index.mjs"
26
27
  },
27
28
  "./package.json": "./package.json"
28
29
  },
29
- "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "files": [
32
32
  "dist",
@@ -36,17 +36,17 @@
36
36
  "README.md"
37
37
  ],
38
38
  "dependencies": {
39
- "@xyo-network/payload-model": "~5.3.24",
40
- "@xyo-network/payload-plugin": "~5.3.24"
39
+ "@xyo-network/payload-model": "~5.3.26",
40
+ "@xyo-network/payload-plugin": "~5.3.26"
41
41
  },
42
42
  "devDependencies": {
43
43
  "@opentelemetry/api": "^1.9.1",
44
- "@types/node": "^25.5.0",
45
- "@xylabs/sdk-js": "^5.0.93",
46
- "@xylabs/ts-scripts-common": "~7.6.16",
47
- "@xylabs/ts-scripts-pnpm": "~7.6.16",
48
- "@xylabs/tsconfig": "~7.6.16",
49
- "@xylabs/vitest-extended": "~5.0.93",
44
+ "@types/node": "^25.5.2",
45
+ "@xylabs/sdk-js": "^5.0.94",
46
+ "@xylabs/ts-scripts-common": "~7.7.5",
47
+ "@xylabs/ts-scripts-pnpm": "~7.7.5",
48
+ "@xylabs/tsconfig": "~7.7.5",
49
+ "@xylabs/vitest-extended": "~5.0.94",
50
50
  "acorn": "^8.16.0",
51
51
  "axios": "^1.14.0",
52
52
  "esbuild": "^0.28.0",