@ariestools/aries-dapp-serve 0.1.15 → 0.1.17
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.
|
@@ -11,9 +11,13 @@ export declare function isDappBackingKind(value: string): value is DappBackingKi
|
|
|
11
11
|
* level rather than fit this interface.
|
|
12
12
|
*/
|
|
13
13
|
export interface DappBacking {
|
|
14
|
-
/**
|
|
14
|
+
/**
|
|
15
|
+
Human-readable label for banners and status output.
|
|
16
|
+
*/
|
|
15
17
|
readonly description: string;
|
|
16
|
-
/**
|
|
18
|
+
/**
|
|
19
|
+
Directory the S3-compatible server persists bucket objects under. Only valid after prepare().
|
|
20
|
+
*/
|
|
17
21
|
readonly directory: string;
|
|
18
22
|
cleanup(): Promise<void>;
|
|
19
23
|
prepare(): Promise<void>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DappBacking.d.ts","sourceRoot":"","sources":["../../src/DappBacking.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,aAAa,6BAA8B,CAAA;AACxD,MAAM,MAAM,eAAe,GAAG,OAAO,aAAa,CAAC,MAAM,CAAC,CAAA;AAE1D,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,eAAe,CAEzE;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B
|
|
1
|
+
{"version":3,"file":"DappBacking.d.ts","sourceRoot":"","sources":["../../src/DappBacking.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,aAAa,6BAA8B,CAAA;AACxD,MAAM,MAAM,eAAe,GAAG,OAAO,aAAa,CAAC,MAAM,CAAC,CAAA;AAE1D,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,eAAe,CAEzE;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B;;MAEE;IACF,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B;;MAEE;IACF,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACxB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,wBAAgB,mBAAmB,IAAI,WAAW,CAgBjD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW,CAchE;AAED,wBAAgB,cAAc,CAC5B,IAAI,EAAE,eAAe,EACrB,OAAO,GAAE,qBAA0B,GAClC,WAAW,CAYb"}
|
package/dist/node/index.mjs.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../src/DappBacking.ts", "../../src/startDappServer.ts"],
|
|
4
|
-
"sourcesContent": ["import { mkdirSync } from 'node:fs'\nimport { mkdtemp, rm } from 'node:fs/promises'\nimport { tmpdir } from 'node:os'\nimport path from 'node:path'\n\nexport const DAPP_BACKINGS = ['memory', 'disk'] as const\nexport type DappBackingKind = typeof DAPP_BACKINGS[number]\n\nexport function isDappBackingKind(value: string): value is DappBackingKind {\n return (DAPP_BACKINGS as readonly string[]).includes(value)\n}\n\n/**\n * Where the served dapp layout's objects live.\n *\n * - `memory` \u2014 ephemeral temp directory wiped on shutdown\n * - `disk` \u2014 caller-owned directory; survives restarts; cleanup is a no-op\n *\n * An `s3` kind would proxy a remote bucket and lift this seam to the server\n * level rather than fit this interface.\n */\nexport interface DappBacking {\n
|
|
5
|
-
"mappings": ";AAAA,SAAS,iBAAiB;AAC1B,SAAS,SAAS,UAAU;AAC5B,SAAS,cAAc;AACvB,OAAO,UAAU;AAEV,IAAM,gBAAgB,CAAC,UAAU,MAAM;AAGvC,SAAS,kBAAkB,OAAyC;AACzE,SAAQ,cAAoC,SAAS,KAAK;AAC5D;
|
|
4
|
+
"sourcesContent": ["import { mkdirSync } from 'node:fs'\nimport { mkdtemp, rm } from 'node:fs/promises'\nimport { tmpdir } from 'node:os'\nimport path from 'node:path'\n\nexport const DAPP_BACKINGS = ['memory', 'disk'] as const\nexport type DappBackingKind = typeof DAPP_BACKINGS[number]\n\nexport function isDappBackingKind(value: string): value is DappBackingKind {\n return (DAPP_BACKINGS as readonly string[]).includes(value)\n}\n\n/**\n * Where the served dapp layout's objects live.\n *\n * - `memory` \u2014 ephemeral temp directory wiped on shutdown\n * - `disk` \u2014 caller-owned directory; survives restarts; cleanup is a no-op\n *\n * An `s3` kind would proxy a remote bucket and lift this seam to the server\n * level rather than fit this interface.\n */\nexport interface DappBacking {\n /**\n Human-readable label for banners and status output.\n */\n readonly description: string\n /**\n Directory the S3-compatible server persists bucket objects under. Only valid after prepare().\n */\n readonly directory: string\n cleanup(): Promise<void>\n prepare(): Promise<void>\n}\n\nexport interface ResolveBackingOptions {\n /**\n * Required for `disk`: absolute path the S3rver root lives under.\n * Ignored for `memory`.\n */\n directory?: string\n}\n\nexport function createMemoryBacking(): DappBacking {\n let dir: string | undefined\n return {\n description: 'memory (ephemeral temp directory)',\n get directory(): string {\n if (dir === undefined) throw new Error('Memory backing not prepared')\n return dir\n },\n async prepare(): Promise<void> {\n dir ??= await mkdtemp(path.join(tmpdir(), 'aries-dapp-'))\n },\n async cleanup(): Promise<void> {\n if (dir !== undefined) await rm(dir, { recursive: true, force: true })\n dir = undefined\n },\n }\n}\n\n/**\n * Caller-owned on-disk backing. Survives process restarts. `cleanup()` is a\n * no-op so `aries dapp down` does not wipe data; use `aries dapp reset` (or\n * delete the directory) to clear.\n */\nexport function createDiskBacking(directory: string): DappBacking {\n const resolved = path.resolve(directory)\n return {\n description: `disk (${resolved})`,\n get directory(): string {\n return resolved\n },\n async prepare(): Promise<void> {\n mkdirSync(resolved, { recursive: true })\n },\n async cleanup(): Promise<void> {\n // intentionally retained\n },\n }\n}\n\nexport function resolveBacking(\n kind: DappBackingKind,\n options: ResolveBackingOptions = {},\n): DappBacking {\n switch (kind) {\n case 'memory': {\n return createMemoryBacking()\n }\n case 'disk': {\n if (options.directory === undefined || options.directory.length === 0) {\n throw new Error('disk backing requires a directory (DAPP_DATA_DIR / --data-dir)')\n }\n return createDiskBacking(options.directory)\n }\n }\n}\n", "import S3rver from 's3rver'\n\nimport type { DappBacking } from './DappBacking.ts'\n\n/**\n * The bucket-per-role split of a dapp backend's layout. Path-style\n * addressing turns each bucket into a subfolder of the one origin \u2014\n * `/state`, `/data`, `/index`:\n *\n * - `data` \u2014 immutable, append-only facts (the source of truth)\n * - `state` \u2014 mutable current derived view, rebuilt by the DappActor\n * - `index` \u2014 query-optimized derived views, rebuilt by the DappActor\n */\nexport const DAPP_BUCKETS = ['state', 'data', 'index'] as const\nexport type DappBucket = typeof DAPP_BUCKETS[number]\n\nconst DEFAULT_HOST = '127.0.0.1'\nconst DEFAULT_PORT = 8801\n\n/**\nAllow browser dapp clients to read the layout cross-origin.\n*/\nconst CORS_ALLOW_READS = `<CORSConfiguration>\n <CORSRule>\n <AllowedOrigin>*</AllowedOrigin>\n <AllowedMethod>GET</AllowedMethod>\n <AllowedMethod>HEAD</AllowedMethod>\n <AllowedHeader>*</AllowedHeader>\n </CORSRule>\n</CORSConfiguration>`\n\nexport interface DappServerOptions {\n backing: DappBacking\n host?: string\n port?: number\n publicHost?: string\n silent?: boolean\n tls?: {\n cert: string | Buffer\n key: string | Buffer\n }\n}\n\nexport interface RunningDappServer {\n baseUrl: string\n port: number\n close(): Promise<void>\n}\n\n/**\n * Boots an S3-compatible server (s3rver) pre-configured with the three dapp\n * layout buckets. Writers use the S3 API (any credentials are accepted);\n * readers fetch `/{bucket}/{layout-path}` over HTTP or optional TLS.\n *\n * DEV ONLY \u2014 this server is a local development fixture, not a production\n * dapp host. It intentionally skips the production concerns the datalake and\n * signing-pool planes carry (auth, metrics, durable multi-instance storage):\n * any S3 credentials are accepted and the only backing is an ephemeral temp\n * directory. Production dapps stay on real object storage (S3/R2) behind the\n * standard sub-domain layout.\n */\nexport async function startDappServer(options: DappServerOptions): Promise<RunningDappServer> {\n const host = options.host ?? DEFAULT_HOST\n const publicHost = options.publicHost ?? host\n await options.backing.prepare()\n const server = new S3rver({\n address: host,\n allowMismatchedSignatures: true,\n cert: options.tls?.cert,\n configureBuckets: DAPP_BUCKETS.map(name => ({ name, configs: [CORS_ALLOW_READS] })),\n directory: options.backing.directory,\n key: options.tls?.key,\n port: options.port ?? DEFAULT_PORT,\n silent: options.silent ?? false,\n vhostBuckets: false,\n })\n try {\n const { port } = await server.run()\n return {\n baseUrl: `${options.tls === undefined ? 'http' : 'https'}://${publicHost}:${port}`,\n port,\n close: async (): Promise<void> => {\n await server.close()\n await options.backing.cleanup()\n },\n }\n } catch (error) {\n await options.backing.cleanup()\n throw error\n }\n}\n"],
|
|
5
|
+
"mappings": ";AAAA,SAAS,iBAAiB;AAC1B,SAAS,SAAS,UAAU;AAC5B,SAAS,cAAc;AACvB,OAAO,UAAU;AAEV,IAAM,gBAAgB,CAAC,UAAU,MAAM;AAGvC,SAAS,kBAAkB,OAAyC;AACzE,SAAQ,cAAoC,SAAS,KAAK;AAC5D;AAgCO,SAAS,sBAAmC;AACjD,MAAI;AACJ,SAAO;AAAA,IACL,aAAa;AAAA,IACb,IAAI,YAAoB;AACtB,UAAI,QAAQ,OAAW,OAAM,IAAI,MAAM,6BAA6B;AACpE,aAAO;AAAA,IACT;AAAA,IACA,MAAM,UAAyB;AAC7B,cAAQ,MAAM,QAAQ,KAAK,KAAK,OAAO,GAAG,aAAa,CAAC;AAAA,IAC1D;AAAA,IACA,MAAM,UAAyB;AAC7B,UAAI,QAAQ,OAAW,OAAM,GAAG,KAAK,EAAE,WAAW,MAAM,OAAO,KAAK,CAAC;AACrE,YAAM;AAAA,IACR;AAAA,EACF;AACF;AAOO,SAAS,kBAAkB,WAAgC;AAChE,QAAM,WAAW,KAAK,QAAQ,SAAS;AACvC,SAAO;AAAA,IACL,aAAa,SAAS,QAAQ;AAAA,IAC9B,IAAI,YAAoB;AACtB,aAAO;AAAA,IACT;AAAA,IACA,MAAM,UAAyB;AAC7B,gBAAU,UAAU,EAAE,WAAW,KAAK,CAAC;AAAA,IACzC;AAAA,IACA,MAAM,UAAyB;AAAA,IAE/B;AAAA,EACF;AACF;AAEO,SAAS,eACd,MACA,UAAiC,CAAC,GACrB;AACb,UAAQ,MAAM;AAAA,IACZ,KAAK,UAAU;AACb,aAAO,oBAAoB;AAAA,IAC7B;AAAA,IACA,KAAK,QAAQ;AACX,UAAI,QAAQ,cAAc,UAAa,QAAQ,UAAU,WAAW,GAAG;AACrE,cAAM,IAAI,MAAM,gEAAgE;AAAA,MAClF;AACA,aAAO,kBAAkB,QAAQ,SAAS;AAAA,IAC5C;AAAA,EACF;AACF;;;AChGA,OAAO,YAAY;AAaZ,IAAM,eAAe,CAAC,SAAS,QAAQ,OAAO;AAGrD,IAAM,eAAe;AACrB,IAAM,eAAe;AAKrB,IAAM,mBAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAuCzB,eAAsB,gBAAgB,SAAwD;AAC5F,QAAM,OAAO,QAAQ,QAAQ;AAC7B,QAAM,aAAa,QAAQ,cAAc;AACzC,QAAM,QAAQ,QAAQ,QAAQ;AAC9B,QAAM,SAAS,IAAI,OAAO;AAAA,IACxB,SAAS;AAAA,IACT,2BAA2B;AAAA,IAC3B,MAAM,QAAQ,KAAK;AAAA,IACnB,kBAAkB,aAAa,IAAI,WAAS,EAAE,MAAM,SAAS,CAAC,gBAAgB,EAAE,EAAE;AAAA,IAClF,WAAW,QAAQ,QAAQ;AAAA,IAC3B,KAAK,QAAQ,KAAK;AAAA,IAClB,MAAM,QAAQ,QAAQ;AAAA,IACtB,QAAQ,QAAQ,UAAU;AAAA,IAC1B,cAAc;AAAA,EAChB,CAAC;AACD,MAAI;AACF,UAAM,EAAE,KAAK,IAAI,MAAM,OAAO,IAAI;AAClC,WAAO;AAAA,MACL,SAAS,GAAG,QAAQ,QAAQ,SAAY,SAAS,OAAO,MAAM,UAAU,IAAI,IAAI;AAAA,MAChF;AAAA,MACA,OAAO,YAA2B;AAChC,cAAM,OAAO,MAAM;AACnB,cAAM,QAAQ,QAAQ,QAAQ;AAAA,MAChC;AAAA,IACF;AAAA,EACF,SAAS,OAAO;AACd,UAAM,QAAQ,QAAQ,QAAQ;AAC9B,UAAM;AAAA,EACR;AACF;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"startDappServer.d.ts","sourceRoot":"","sources":["../../src/startDappServer.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,qCAAsC,CAAA;AAC/D,MAAM,MAAM,UAAU,GAAG,OAAO,YAAY,CAAC,MAAM,CAAC,CAAA;
|
|
1
|
+
{"version":3,"file":"startDappServer.d.ts","sourceRoot":"","sources":["../../src/startDappServer.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,qCAAsC,CAAA;AAC/D,MAAM,MAAM,UAAU,GAAG,OAAO,YAAY,CAAC,MAAM,CAAC,CAAA;AAiBpD,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,WAAW,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,GAAG,CAAC,EAAE;QACJ,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;QACrB,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KACrB,CAAA;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACvB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CA6B5F"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ariestools/aries-dapp-serve",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.17",
|
|
4
4
|
"description": "Aries dapp REST server: serves a dapp backend's S3 layout from one origin with /state, /data, /index subfolders",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ariestools",
|
|
@@ -37,12 +37,12 @@
|
|
|
37
37
|
"s3rver": "~3.7.1"
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|
|
40
|
-
"@ariestools/tsconfig": "~
|
|
41
|
-
"@aws-sdk/client-s3": "~3.
|
|
42
|
-
"@types/node": "~26.
|
|
40
|
+
"@ariestools/tsconfig": "~9.0.2",
|
|
41
|
+
"@aws-sdk/client-s3": "~3.1108.0",
|
|
42
|
+
"@types/node": "~26.2.0",
|
|
43
43
|
"@types/s3rver": "~3.7.4",
|
|
44
44
|
"typescript": "~6.0.3",
|
|
45
|
-
"vite": "~8.1
|
|
45
|
+
"vite": "~8.2.1",
|
|
46
46
|
"vitest": "~4.1.10"
|
|
47
47
|
},
|
|
48
48
|
"engines": {
|