@xyo-network/archivist-express 5.3.25 → 5.3.27
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/README.md +72 -11
- package/package.json +14 -18
package/README.md
CHANGED
|
@@ -1,23 +1,84 @@
|
|
|
1
|
-
# @xyo-network/archivist-model
|
|
2
|
-
|
|
3
1
|
[![logo][]](https://xyo.network)
|
|
4
2
|
|
|
5
|
-
|
|
3
|
+
# @xyo-network/archivist-express
|
|
4
|
+
|
|
5
|
+
[![npm][npm-badge]][npm-link]
|
|
6
|
+
[![license][license-badge]][license-link]
|
|
7
|
+
|
|
8
|
+
> Primary SDK for using XYO Protocol 2.0
|
|
9
|
+
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
Using npm:
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
npm install {{name}}
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Using yarn:
|
|
6
19
|
|
|
7
|
-
|
|
20
|
+
```sh
|
|
21
|
+
yarn add {{name}}
|
|
22
|
+
```
|
|
8
23
|
|
|
9
|
-
|
|
24
|
+
Using pnpm:
|
|
10
25
|
|
|
11
|
-
|
|
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
|
-
|
|
39
|
+
See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
|
|
40
|
+
|
|
41
|
+
## Reference
|
|
42
|
+
|
|
43
|
+
### packages
|
|
44
|
+
|
|
45
|
+
### modules
|
|
46
|
+
|
|
47
|
+
### packages
|
|
48
|
+
|
|
49
|
+
### archivist
|
|
50
|
+
|
|
51
|
+
### packages
|
|
52
|
+
|
|
53
|
+
### express
|
|
54
|
+
|
|
55
|
+
### .temp-typedoc
|
|
56
|
+
|
|
57
|
+
### functions
|
|
58
|
+
|
|
59
|
+
### <a id="archivistRestMiddleware"></a>archivistRestMiddleware
|
|
60
|
+
|
|
61
|
+
[**@xyo-network/archivist-express**](#../README)
|
|
62
|
+
|
|
63
|
+
***
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
function archivistRestMiddleware(options): Router;
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Parameters
|
|
70
|
+
|
|
71
|
+
### options
|
|
72
|
+
|
|
73
|
+
`ArchivistMiddlewareOptions`
|
|
74
|
+
|
|
75
|
+
## Returns
|
|
18
76
|
|
|
19
|
-
|
|
77
|
+
`Router`
|
|
20
78
|
|
|
21
|
-
[Made with 🔥 and ❄️ by XYO](https://xyo.network)
|
|
22
79
|
|
|
23
|
-
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
|
|
80
|
+
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
|
|
81
|
+
[npm-badge]: https://img.shields.io/npm/v/@xyo-network/archivist-express.svg
|
|
82
|
+
[npm-link]: https://www.npmjs.com/package/@xyo-network/archivist-express
|
|
83
|
+
[license-badge]: https://img.shields.io/npm/l/@xyo-network/archivist-express.svg
|
|
84
|
+
[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/archivist-express",
|
|
3
|
-
"version": "5.3.
|
|
3
|
+
"version": "5.3.27",
|
|
4
4
|
"description": "Primary SDK for using XYO Protocol 2.0",
|
|
5
5
|
"homepage": "https://xyo.network",
|
|
6
6
|
"bugs": {
|
|
@@ -22,11 +22,11 @@
|
|
|
22
22
|
"exports": {
|
|
23
23
|
".": {
|
|
24
24
|
"types": "./dist/node/index.d.ts",
|
|
25
|
+
"import": "./dist/node/index.mjs",
|
|
25
26
|
"default": "./dist/node/index.mjs"
|
|
26
27
|
},
|
|
27
28
|
"./package.json": "./package.json"
|
|
28
29
|
},
|
|
29
|
-
"module": "dist/node/index.mjs",
|
|
30
30
|
"types": "dist/node/index.d.ts",
|
|
31
31
|
"files": [
|
|
32
32
|
"dist",
|
|
@@ -36,34 +36,30 @@
|
|
|
36
36
|
"README.md"
|
|
37
37
|
],
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@xyo-network/
|
|
40
|
-
"@xyo-network/
|
|
41
|
-
"@xyo-network/payload-model": "~5.3.
|
|
39
|
+
"@xyo-network/archivist-model": "~5.3.27",
|
|
40
|
+
"@xyo-network/payload-builder": "~5.3.27",
|
|
41
|
+
"@xyo-network/payload-model": "~5.3.27"
|
|
42
42
|
},
|
|
43
43
|
"devDependencies": {
|
|
44
44
|
"@opentelemetry/api": "^1.9.1",
|
|
45
45
|
"@types/express": "^5.0.6",
|
|
46
|
-
"@
|
|
47
|
-
"@xylabs/
|
|
48
|
-
"@xylabs/
|
|
49
|
-
"@xylabs/ts-scripts-
|
|
50
|
-
"@xylabs/
|
|
51
|
-
"@xylabs/tsconfig": "~7.6.16",
|
|
52
|
-
"acorn": "^8.16.0",
|
|
46
|
+
"@xylabs/express": "^5.0.94",
|
|
47
|
+
"@xylabs/sdk-js": "^5.0.94",
|
|
48
|
+
"@xylabs/ts-scripts-common": "~7.7.15",
|
|
49
|
+
"@xylabs/ts-scripts-pnpm": "~7.7.15",
|
|
50
|
+
"@xylabs/tsconfig": "~7.7.15",
|
|
53
51
|
"axios": "^1.14.0",
|
|
54
|
-
"esbuild": "^0.28.0",
|
|
55
52
|
"express": "^5.2.1",
|
|
56
53
|
"typescript": "~5.9.3",
|
|
57
54
|
"zod": "^4.3.6",
|
|
58
|
-
"@xyo-network/payload-builder": "~5.3.
|
|
59
|
-
"@xyo-network/payload-model": "~5.3.
|
|
60
|
-
"@xyo-network/archivist-model": "~5.3.
|
|
55
|
+
"@xyo-network/payload-builder": "~5.3.27",
|
|
56
|
+
"@xyo-network/payload-model": "~5.3.27",
|
|
57
|
+
"@xyo-network/archivist-model": "~5.3.27"
|
|
61
58
|
},
|
|
62
59
|
"peerDependencies": {
|
|
63
60
|
"@xylabs/express": "^5",
|
|
64
61
|
"@xylabs/sdk-js": "^5",
|
|
65
|
-
"express": "^5"
|
|
66
|
-
"zod": "^4"
|
|
62
|
+
"express": "^5"
|
|
67
63
|
},
|
|
68
64
|
"publishConfig": {
|
|
69
65
|
"access": "public"
|