@xyo-network/value-payload-plugin 5.3.25 → 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 +146 -10
  2. package/package.json +10 -10
package/README.md CHANGED
@@ -1,23 +1,159 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/value-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:
13
+
14
+ ```sh
15
+ npm install {{name}}
16
+ ```
4
17
 
5
- Version: 5.0.2
18
+ Using yarn:
6
19
 
7
- Typescript/Javascript Plugins for XYO Platform
20
+ ```sh
21
+ yarn add {{name}}
22
+ ```
8
23
 
9
- ## Documentation
24
+ Using pnpm:
10
25
 
11
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__value-payload-plugin)
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
+ ### value
50
+
51
+ ### .temp-typedoc
52
+
53
+ ### functions
54
+
55
+ ### <a id="ValuePayloadPlugin"></a>ValuePayloadPlugin
56
+
57
+ [**@xyo-network/value-payload-plugin**](#../README)
58
+
59
+ ***
60
+
61
+ ```ts
62
+ function ValuePayloadPlugin(): PayloadPlugin<Value>;
63
+ ```
64
+
65
+ ## Returns
66
+
67
+ `PayloadPlugin`\<[`Value`](#../type-aliases/Value)\>
68
+
69
+ ### <a id="valuePayloadTemplate"></a>valuePayloadTemplate
70
+
71
+ [**@xyo-network/value-payload-plugin**](#../README)
72
+
73
+ ***
74
+
75
+ ```ts
76
+ function valuePayloadTemplate(): Value;
77
+ ```
78
+
79
+ ## Returns
80
+
81
+ [`Value`](#../type-aliases/Value)
82
+
83
+ ### type-aliases
84
+
85
+ ### <a id="Value"></a>Value
86
+
87
+ [**@xyo-network/value-payload-plugin**](#../README)
88
+
89
+ ***
90
+
91
+ ```ts
92
+ type Value<T> = Payload<{
93
+ schema: ValueSchema;
94
+ value: T;
95
+ }>;
96
+ ```
97
+
98
+ ## Type Parameters
99
+
100
+ ### T
101
+
102
+ `T` *extends* `JsonValue` = `JsonValue`
103
+
104
+ ### <a id="ValueSchema"></a>ValueSchema
105
+
106
+ [**@xyo-network/value-payload-plugin**](#../README)
107
+
108
+ ***
109
+
110
+ ```ts
111
+ type ValueSchema = typeof ValueSchema;
112
+ ```
113
+
114
+ ### variables
115
+
116
+ ### <a id="ValueSchema"></a>ValueSchema
117
+
118
+ [**@xyo-network/value-payload-plugin**](#../README)
119
+
120
+ ***
121
+
122
+ ```ts
123
+ const ValueSchema: "network.xyo.value" & object;
124
+ ```
125
+
126
+ ## Type Declaration
127
+
128
+ ### \_\_schema
129
+
130
+ ```ts
131
+ readonly __schema: true;
132
+ ```
133
+
134
+ ### <a id="isValuePayload"></a>isValuePayload
135
+
136
+ [**@xyo-network/value-payload-plugin**](#../README)
137
+
138
+ ***
139
+
140
+ ```ts
141
+ const isValuePayload: (x?) => x is Value<unknown>;
142
+ ```
143
+
144
+ ## Parameters
145
+
146
+ ### x?
147
+
148
+ `unknown`
149
+
150
+ ## Returns
18
151
 
19
- ## Credits
152
+ `x is Value<unknown>`
20
153
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
154
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
155
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
156
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/value-payload-plugin.svg
157
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/value-payload-plugin
158
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/value-payload-plugin.svg
159
+ [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/value-payload-plugin",
3
- "version": "5.3.25",
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.25",
40
- "@xyo-network/payload-plugin": "~5.3.25"
39
+ "@xyo-network/payload-plugin": "~5.3.26",
40
+ "@xyo-network/payload-model": "~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",