@xyo-network/archivist-express 5.3.29 → 5.4.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.
package/README.md CHANGED
@@ -38,43 +38,6 @@ bun add {{name}}
38
38
 
39
39
  See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
40
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
76
-
77
- `Router`
78
41
 
79
42
 
80
43
  [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
@@ -1,8 +1,8 @@
1
1
  import type { ArchivistInstance } from '@xyo-network/archivist-model';
2
2
  import type { Router } from 'express';
3
- type ArchivistMiddlewareOptions = {
3
+ interface ArchivistMiddlewareOptions {
4
4
  archivist: ArchivistInstance;
5
- };
5
+ }
6
6
  export declare const archivistRestMiddleware: (options: ArchivistMiddlewareOptions) => Router;
7
7
  export {};
8
8
  //# sourceMappingURL=archivistRestMiddleware.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"archivistRestMiddleware.d.ts","sourceRoot":"","sources":["../../src/archivistRestMiddleware.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,iBAAiB,EAElB,MAAM,8BAA8B,CAAA;AAIrC,OAAO,KAAK,EAAW,MAAM,EAAE,MAAM,SAAS,CAAA;AAG9C,KAAK,0BAA0B,GAAG;IAChC,SAAS,EAAE,iBAAiB,CAAA;CAC7B,CAAA;AAED,eAAO,MAAM,uBAAuB,GAAI,SAAS,0BAA0B,KAAG,MA8C7E,CAAA"}
1
+ {"version":3,"file":"archivistRestMiddleware.d.ts","sourceRoot":"","sources":["../../src/archivistRestMiddleware.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,iBAAiB,EAElB,MAAM,8BAA8B,CAAA;AAIrC,OAAO,KAAK,EAAW,MAAM,EAAE,MAAM,SAAS,CAAA;AAG9C,UAAU,0BAA0B;IAClC,SAAS,EAAE,iBAAiB,CAAA;CAC7B;AAED,eAAO,MAAM,uBAAuB,GAAI,SAAS,0BAA0B,KAAG,MA8C7E,CAAA"}
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/archivistRestMiddleware.ts"],"sourcesContent":["import { setRawResponseFormat } from '@xylabs/express'\nimport {\n asHash, isDefined, isHash,\n} from '@xylabs/sdk-js'\nimport type {\n ArchivistInstance,\n ArchivistNextOptions, NextOptions,\n} from '@xyo-network/archivist-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type { Payload } from '@xyo-network/payload-model'\nimport { isAnyPayload, isSequence } from '@xyo-network/payload-model'\nimport type { Request, Router } from 'express'\nimport express from 'express'\n\ntype ArchivistMiddlewareOptions = {\n archivist: ArchivistInstance\n}\n\nexport const archivistRestMiddleware = (options: ArchivistMiddlewareOptions): Router => {\n const { archivist } = options\n const router = express.Router({ mergeParams: true })\n\n router.post('/insert', async (req, res) => {\n setRawResponseFormat(res)\n const body = Array.isArray(req.body) ? req.body : [req.body]\n const payloads = (await PayloadBuilder.hashPairs<Payload>(body)).map(p => p[0])\n const result = await archivist.insert(payloads)\n res.status(200).json(result)\n })\n\n router.get('/next', async (req: Request<Partial<NextOptions>>, res) => {\n setRawResponseFormat(res)\n const cursor = isSequence(req.query.cursor) ? req.query.cursor : undefined\n const limit = isDefined(req.query.limit) ? Number(req.query.limit) : undefined\n const open = isDefined(req.query.open) ? Boolean(req.query.open) : undefined\n const order = req.query.order === 'asc' ? 'asc' : 'desc'\n const options: ArchivistNextOptions = {\n limit, open, order, cursor,\n }\n const result = await archivist.next(options)\n res.status(200).json(result)\n })\n router.post('/next', async (req: Request<{}, {}, ArchivistNextOptions | undefined>, res) => {\n setRawResponseFormat(res)\n const options = req.body\n const result = await (isDefined(options) ? archivist.next(options) : archivist.next())\n res.status(200).json(result)\n })\n\n router.get('/get/:hash', async (req, res) => {\n setRawResponseFormat(res)\n const { hash: rawHash } = req.params\n const hash = asHash(rawHash)\n if (isHash(hash)) {\n const [payload] = await archivist.get([hash])\n if (isAnyPayload(payload)) {\n res.json(payload)\n return\n }\n }\n res.status(400).send()\n })\n\n return router\n}\n"],"mappings":";AAAA,SAAS,4BAA4B;AACrC;AAAA,EACE;AAAA,EAAQ;AAAA,EAAW;AAAA,OACd;AAKP,SAAS,sBAAsB;AAE/B,SAAS,cAAc,kBAAkB;AAEzC,OAAO,aAAa;AAMb,IAAM,0BAA0B,CAAC,YAAgD;AACtF,QAAM,EAAE,UAAU,IAAI;AACtB,QAAM,SAAS,QAAQ,OAAO,EAAE,aAAa,KAAK,CAAC;AAEnD,SAAO,KAAK,WAAW,OAAO,KAAK,QAAQ;AACzC,yBAAqB,GAAG;AACxB,UAAM,OAAO,MAAM,QAAQ,IAAI,IAAI,IAAI,IAAI,OAAO,CAAC,IAAI,IAAI;AAC3D,UAAM,YAAY,MAAM,eAAe,UAAmB,IAAI,GAAG,IAAI,OAAK,EAAE,CAAC,CAAC;AAC9E,UAAM,SAAS,MAAM,UAAU,OAAO,QAAQ;AAC9C,QAAI,OAAO,GAAG,EAAE,KAAK,MAAM;AAAA,EAC7B,CAAC;AAED,SAAO,IAAI,SAAS,OAAO,KAAoC,QAAQ;AACrE,yBAAqB,GAAG;AACxB,UAAM,SAAS,WAAW,IAAI,MAAM,MAAM,IAAI,IAAI,MAAM,SAAS;AACjE,UAAM,QAAQ,UAAU,IAAI,MAAM,KAAK,IAAI,OAAO,IAAI,MAAM,KAAK,IAAI;AACrE,UAAM,OAAO,UAAU,IAAI,MAAM,IAAI,IAAI,QAAQ,IAAI,MAAM,IAAI,IAAI;AACnE,UAAM,QAAQ,IAAI,MAAM,UAAU,QAAQ,QAAQ;AAClD,UAAMA,WAAgC;AAAA,MACpC;AAAA,MAAO;AAAA,MAAM;AAAA,MAAO;AAAA,IACtB;AACA,UAAM,SAAS,MAAM,UAAU,KAAKA,QAAO;AAC3C,QAAI,OAAO,GAAG,EAAE,KAAK,MAAM;AAAA,EAC7B,CAAC;AACD,SAAO,KAAK,SAAS,OAAO,KAAwD,QAAQ;AAC1F,yBAAqB,GAAG;AACxB,UAAMA,WAAU,IAAI;AACpB,UAAM,SAAS,OAAO,UAAUA,QAAO,IAAI,UAAU,KAAKA,QAAO,IAAI,UAAU,KAAK;AACpF,QAAI,OAAO,GAAG,EAAE,KAAK,MAAM;AAAA,EAC7B,CAAC;AAED,SAAO,IAAI,cAAc,OAAO,KAAK,QAAQ;AAC3C,yBAAqB,GAAG;AACxB,UAAM,EAAE,MAAM,QAAQ,IAAI,IAAI;AAC9B,UAAM,OAAO,OAAO,OAAO;AAC3B,QAAI,OAAO,IAAI,GAAG;AAChB,YAAM,CAAC,OAAO,IAAI,MAAM,UAAU,IAAI,CAAC,IAAI,CAAC;AAC5C,UAAI,aAAa,OAAO,GAAG;AACzB,YAAI,KAAK,OAAO;AAChB;AAAA,MACF;AAAA,IACF;AACA,QAAI,OAAO,GAAG,EAAE,KAAK;AAAA,EACvB,CAAC;AAED,SAAO;AACT;","names":["options"]}
1
+ {"version":3,"sources":["../../src/archivistRestMiddleware.ts"],"sourcesContent":["import { setRawResponseFormat } from '@xylabs/express'\nimport {\n asHash, isDefined, isHash,\n} from '@xylabs/sdk-js'\nimport type {\n ArchivistInstance,\n ArchivistNextOptions, NextOptions,\n} from '@xyo-network/archivist-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type { Payload } from '@xyo-network/payload-model'\nimport { isAnyPayload, isSequence } from '@xyo-network/payload-model'\nimport type { Request, Router } from 'express'\nimport express from 'express'\n\ninterface ArchivistMiddlewareOptions {\n archivist: ArchivistInstance\n}\n\nexport const archivistRestMiddleware = (options: ArchivistMiddlewareOptions): Router => {\n const { archivist } = options\n const router = express.Router({ mergeParams: true })\n\n router.post('/insert', async (req, res) => {\n setRawResponseFormat(res)\n const body = Array.isArray(req.body) ? req.body : [req.body]\n const payloads = (await PayloadBuilder.hashPairs<Payload>(body)).map(p => p[0])\n const result = await archivist.insert(payloads)\n res.status(200).json(result)\n })\n\n router.get('/next', async (req: Request<Partial<NextOptions>>, res) => {\n setRawResponseFormat(res)\n const cursor = isSequence(req.query.cursor) ? req.query.cursor : undefined\n const limit = isDefined(req.query.limit) ? Number(req.query.limit) : undefined\n const open = isDefined(req.query.open) ? Boolean(req.query.open) : undefined\n const order = req.query.order === 'asc' ? 'asc' : 'desc'\n const options: ArchivistNextOptions = {\n limit, open, order, cursor,\n }\n const result = await archivist.next(options)\n res.status(200).json(result)\n })\n router.post('/next', async (req: Request<{}, {}, ArchivistNextOptions | undefined>, res) => {\n setRawResponseFormat(res)\n const options = req.body\n const result = await (isDefined(options) ? archivist.next(options) : archivist.next())\n res.status(200).json(result)\n })\n\n router.get('/get/:hash', async (req, res) => {\n setRawResponseFormat(res)\n const { hash: rawHash } = req.params\n const hash = asHash(rawHash)\n if (isHash(hash)) {\n const [payload] = await archivist.get([hash])\n if (isAnyPayload(payload)) {\n res.json(payload)\n return\n }\n }\n res.status(400).send()\n })\n\n return router\n}\n"],"mappings":";AAAA,SAAS,4BAA4B;AACrC;AAAA,EACE;AAAA,EAAQ;AAAA,EAAW;AAAA,OACd;AAKP,SAAS,sBAAsB;AAE/B,SAAS,cAAc,kBAAkB;AAEzC,OAAO,aAAa;AAMb,IAAM,0BAA0B,CAAC,YAAgD;AACtF,QAAM,EAAE,UAAU,IAAI;AACtB,QAAM,SAAS,QAAQ,OAAO,EAAE,aAAa,KAAK,CAAC;AAEnD,SAAO,KAAK,WAAW,OAAO,KAAK,QAAQ;AACzC,yBAAqB,GAAG;AACxB,UAAM,OAAO,MAAM,QAAQ,IAAI,IAAI,IAAI,IAAI,OAAO,CAAC,IAAI,IAAI;AAC3D,UAAM,YAAY,MAAM,eAAe,UAAmB,IAAI,GAAG,IAAI,OAAK,EAAE,CAAC,CAAC;AAC9E,UAAM,SAAS,MAAM,UAAU,OAAO,QAAQ;AAC9C,QAAI,OAAO,GAAG,EAAE,KAAK,MAAM;AAAA,EAC7B,CAAC;AAED,SAAO,IAAI,SAAS,OAAO,KAAoC,QAAQ;AACrE,yBAAqB,GAAG;AACxB,UAAM,SAAS,WAAW,IAAI,MAAM,MAAM,IAAI,IAAI,MAAM,SAAS;AACjE,UAAM,QAAQ,UAAU,IAAI,MAAM,KAAK,IAAI,OAAO,IAAI,MAAM,KAAK,IAAI;AACrE,UAAM,OAAO,UAAU,IAAI,MAAM,IAAI,IAAI,QAAQ,IAAI,MAAM,IAAI,IAAI;AACnE,UAAM,QAAQ,IAAI,MAAM,UAAU,QAAQ,QAAQ;AAClD,UAAMA,WAAgC;AAAA,MACpC;AAAA,MAAO;AAAA,MAAM;AAAA,MAAO;AAAA,IACtB;AACA,UAAM,SAAS,MAAM,UAAU,KAAKA,QAAO;AAC3C,QAAI,OAAO,GAAG,EAAE,KAAK,MAAM;AAAA,EAC7B,CAAC;AACD,SAAO,KAAK,SAAS,OAAO,KAAwD,QAAQ;AAC1F,yBAAqB,GAAG;AACxB,UAAMA,WAAU,IAAI;AACpB,UAAM,SAAS,OAAO,UAAUA,QAAO,IAAI,UAAU,KAAKA,QAAO,IAAI,UAAU,KAAK;AACpF,QAAI,OAAO,GAAG,EAAE,KAAK,MAAM;AAAA,EAC7B,CAAC;AAED,SAAO,IAAI,cAAc,OAAO,KAAK,QAAQ;AAC3C,yBAAqB,GAAG;AACxB,UAAM,EAAE,MAAM,QAAQ,IAAI,IAAI;AAC9B,UAAM,OAAO,OAAO,OAAO;AAC3B,QAAI,OAAO,IAAI,GAAG;AAChB,YAAM,CAAC,OAAO,IAAI,MAAM,UAAU,IAAI,CAAC,IAAI,CAAC;AAC5C,UAAI,aAAa,OAAO,GAAG;AACzB,YAAI,KAAK,OAAO;AAChB;AAAA,MACF;AAAA,IACF;AACA,QAAI,OAAO,GAAG,EAAE,KAAK;AAAA,EACvB,CAAC;AAED,SAAO;AACT;","names":["options"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/archivist-express",
3
- "version": "5.3.29",
3
+ "version": "5.4.0",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -22,12 +22,10 @@
22
22
  "exports": {
23
23
  ".": {
24
24
  "types": "./dist/node/index.d.ts",
25
- "import": "./dist/node/index.mjs",
26
25
  "default": "./dist/node/index.mjs"
27
26
  },
28
27
  "./package.json": "./package.json"
29
28
  },
30
- "types": "dist/node/index.d.ts",
31
29
  "files": [
32
30
  "dist",
33
31
  "!**/*.bench.*",
@@ -36,36 +34,34 @@
36
34
  "README.md"
37
35
  ],
38
36
  "dependencies": {
39
- "@xyo-network/payload-model": "~5.3.29"
37
+ "@xyo-network/payload-model": "~5.4.0"
40
38
  },
41
39
  "devDependencies": {
42
40
  "@opentelemetry/api": "^1.9.1",
43
41
  "@types/express": "^5.0.6",
44
- "@xylabs/express": "^5.0.95",
45
- "@xylabs/sdk-js": "^5.0.95",
46
- "@xylabs/ts-scripts-common": "~7.8.4",
47
- "@xylabs/ts-scripts-pnpm": "~7.8.4",
48
- "@xylabs/tsconfig": "~7.8.4",
49
- "axios": "^1.14.0",
42
+ "@xylabs/express": "^5.0.97",
43
+ "@xylabs/sdk-js": "^5.0.97",
44
+ "@xylabs/toolchain": "~7.10.8",
45
+ "@xylabs/tsconfig": "~7.10.8",
50
46
  "express": "^5.2.1",
51
47
  "pako": "~2.1.0",
52
48
  "typescript": "~5.9.3",
53
49
  "zod": "^4.3.6",
54
- "@xyo-network/account-model": "~5.3.29",
55
- "@xyo-network/hash": "~5.3.29",
56
- "@xyo-network/module-model": "~5.3.29",
57
- "@xyo-network/manifest-model": "~5.3.29",
58
- "@xyo-network/archivist-model": "~5.3.29",
59
- "@xyo-network/payload-builder": "~5.3.29",
60
- "@xyo-network/wasm": "~5.3.29",
61
- "@xyo-network/previous-hash-store-model": "~5.3.29"
50
+ "@xyo-network/account-model": "~5.4.0",
51
+ "@xyo-network/hash": "~5.4.0",
52
+ "@xyo-network/manifest-model": "~5.4.0",
53
+ "@xyo-network/previous-hash-store-model": "~5.4.0",
54
+ "@xyo-network/payload-builder": "~5.4.0",
55
+ "@xyo-network/wasm": "~5.4.0",
56
+ "@xyo-network/archivist-model": "~5.4.0",
57
+ "@xyo-network/module-model": "~5.4.0"
62
58
  },
63
59
  "peerDependencies": {
64
- "@xylabs/express": "^5",
65
- "@xylabs/sdk-js": "^5",
66
- "express": "^5",
67
- "@xyo-network/archivist-model": "~5.3.29",
68
- "@xyo-network/payload-builder": "~5.3.29"
60
+ "@xylabs/express": "^5.0.97",
61
+ "@xylabs/sdk-js": "^5.0.97",
62
+ "@xyo-network/archivist-model": "~5.4",
63
+ "@xyo-network/payload-builder": "~5.4",
64
+ "express": "^5"
69
65
  },
70
66
  "publishConfig": {
71
67
  "access": "public"