@niscorp/vex 0.4.5 → 0.5.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/CHANGELOG.md +78 -0
- package/DESIGN.md +72 -45
- package/DOCS.md +130 -21
- package/README.md +17 -0
- package/dist/adapters/express/index.cjs +606 -173
- package/dist/adapters/express/index.cjs.map +1 -1
- package/dist/adapters/express/index.d.cts +6 -2
- package/dist/adapters/express/index.d.ts +6 -2
- package/dist/adapters/express/index.js +16 -3
- package/dist/adapters/express/index.js.map +1 -1
- package/dist/adapters/hono/index.cjs +597 -173
- package/dist/adapters/hono/index.cjs.map +1 -1
- package/dist/adapters/hono/index.d.cts +5 -2
- package/dist/adapters/hono/index.d.ts +5 -2
- package/dist/adapters/hono/index.js +7 -3
- package/dist/adapters/hono/index.js.map +1 -1
- package/dist/agent/index.cjs +12 -12
- package/dist/agent/index.cjs.map +1 -1
- package/dist/agent/index.d.cts +1 -1
- package/dist/agent/index.d.ts +1 -1
- package/dist/agent/index.js +12 -12
- package/dist/agent/index.js.map +1 -1
- package/dist/{chunk-W5MYFJKT.js → chunk-F7OXXJIH.js} +562 -192
- package/dist/chunk-F7OXXJIH.js.map +1 -0
- package/dist/{chunk-F7RDSWYF.js → chunk-VHNCSQPO.js} +2 -2
- package/dist/{chunk-F7RDSWYF.js.map → chunk-VHNCSQPO.js.map} +1 -1
- package/dist/{handler-O6XslV-S.d.ts → handler-DdfaWN_J.d.ts} +7 -1
- package/dist/{handler-CB0BqKsY.d.cts → handler-kvZkxwaN.d.cts} +7 -1
- package/dist/index.cjs +493 -232
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +5 -3
- package/dist/index.d.ts +5 -3
- package/dist/index.js +118 -221
- package/dist/index.js.map +1 -1
- package/dist/migrations/index.cjs.map +1 -1
- package/dist/migrations/index.js +1 -1
- package/dist/{types-BmHuPfPS.d.cts → types-BxkRxTTx.d.cts} +5 -0
- package/dist/{types-D5CCaqcd.d.ts → types-DgUZNKii.d.ts} +5 -0
- package/package.json +8 -8
- package/dist/chunk-W5MYFJKT.js.map +0 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { a as QueryEngine, ab as ScopeValues } from '../../types-
|
|
2
|
-
import { V as VexHandlerConfig } from '../../handler-
|
|
1
|
+
import { a as QueryEngine, ab as ScopeValues, S as ScopePolicy } from '../../types-BxkRxTTx.cjs';
|
|
2
|
+
import { V as VexHandlerConfig, E as ExecuteRecord } from '../../handler-kvZkxwaN.cjs';
|
|
3
3
|
import '../../query.schema-B-LVNfyX.cjs';
|
|
4
4
|
import 'zod';
|
|
5
5
|
import '@niscorp/prism';
|
|
@@ -18,8 +18,12 @@ type VexExpressConfig<TReq extends VexExpressRequest = VexExpressRequest> = {
|
|
|
18
18
|
engine: QueryEngine;
|
|
19
19
|
entities?: string[];
|
|
20
20
|
locked?: boolean;
|
|
21
|
+
manageFingerprints?: boolean;
|
|
21
22
|
getScope?: (req: TReq) => Promise<ScopeValues> | ScopeValues;
|
|
23
|
+
getPolicy?: (req: TReq) => Promise<ScopePolicy | undefined> | ScopePolicy | undefined;
|
|
24
|
+
getPolicyForReach?: (req: TReq, reach: string) => Promise<ScopePolicy | undefined> | ScopePolicy | undefined;
|
|
22
25
|
mutations?: VexHandlerConfig['mutations'];
|
|
26
|
+
onExecute?: (record: ExecuteRecord) => void;
|
|
23
27
|
};
|
|
24
28
|
declare const vex: <TReq extends VexExpressRequest = VexExpressRequest>(config: VexExpressConfig<TReq>) => ((req: TReq, res: VexExpressResponse) => Promise<void>);
|
|
25
29
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { a as QueryEngine, ab as ScopeValues } from '../../types-
|
|
2
|
-
import { V as VexHandlerConfig } from '../../handler-
|
|
1
|
+
import { a as QueryEngine, ab as ScopeValues, S as ScopePolicy } from '../../types-DgUZNKii.js';
|
|
2
|
+
import { V as VexHandlerConfig, E as ExecuteRecord } from '../../handler-DdfaWN_J.js';
|
|
3
3
|
import '../../query.schema-B-LVNfyX.js';
|
|
4
4
|
import 'zod';
|
|
5
5
|
import '@niscorp/prism';
|
|
@@ -18,8 +18,12 @@ type VexExpressConfig<TReq extends VexExpressRequest = VexExpressRequest> = {
|
|
|
18
18
|
engine: QueryEngine;
|
|
19
19
|
entities?: string[];
|
|
20
20
|
locked?: boolean;
|
|
21
|
+
manageFingerprints?: boolean;
|
|
21
22
|
getScope?: (req: TReq) => Promise<ScopeValues> | ScopeValues;
|
|
23
|
+
getPolicy?: (req: TReq) => Promise<ScopePolicy | undefined> | ScopePolicy | undefined;
|
|
24
|
+
getPolicyForReach?: (req: TReq, reach: string) => Promise<ScopePolicy | undefined> | ScopePolicy | undefined;
|
|
22
25
|
mutations?: VexHandlerConfig['mutations'];
|
|
26
|
+
onExecute?: (record: ExecuteRecord) => void;
|
|
23
27
|
};
|
|
24
28
|
declare const vex: <TReq extends VexExpressRequest = VexExpressRequest>(config: VexExpressConfig<TReq>) => ((req: TReq, res: VexExpressResponse) => Promise<void>);
|
|
25
29
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { handleDiscovery, handleQuery, handleFingerprintPatch, handleFingerprintDelete } from '../../chunk-
|
|
1
|
+
import { warnOfOpenManagement, handleDiscovery, handleQuery, handleFingerprintPatch, handleFingerprintDelete } from '../../chunk-F7OXXJIH.js';
|
|
2
2
|
import '../../chunk-XTOK7YOR.js';
|
|
3
3
|
import '../../chunk-UPQMKAAX.js';
|
|
4
4
|
|
|
@@ -9,20 +9,33 @@ var fingerprintFromBody = (body) => {
|
|
|
9
9
|
return typeof fp === "string" && fp.length > 0 ? fp : void 0;
|
|
10
10
|
};
|
|
11
11
|
var vex = (config) => {
|
|
12
|
+
warnOfOpenManagement(config);
|
|
12
13
|
const handlerConfig = {
|
|
13
14
|
engine: config.engine,
|
|
14
15
|
entities: config.entities,
|
|
15
16
|
...config.locked === true ? { locked: true } : {},
|
|
17
|
+
...config.manageFingerprints === false ? { manageFingerprints: false } : {},
|
|
16
18
|
...config.mutations !== void 0 ? { mutations: config.mutations } : {}
|
|
17
19
|
};
|
|
20
|
+
const requestConfig = async (req) => {
|
|
21
|
+
const policy = config.getPolicy ? await config.getPolicy(req) : void 0;
|
|
22
|
+
const { getPolicyForReach } = config;
|
|
23
|
+
return {
|
|
24
|
+
...handlerConfig,
|
|
25
|
+
...policy !== void 0 ? { scopePolicy: policy } : {},
|
|
26
|
+
...getPolicyForReach !== void 0 ? { policyForReach: (reach) => getPolicyForReach(req, reach) } : {},
|
|
27
|
+
...config.onExecute !== void 0 ? { onExecute: config.onExecute } : {},
|
|
28
|
+
...config.mutations !== void 0 ? { mutations: { ...config.mutations, policy: policy ?? config.mutations.policy } } : {}
|
|
29
|
+
};
|
|
30
|
+
};
|
|
18
31
|
return async (req, res) => {
|
|
19
32
|
if (req.method === "GET") {
|
|
20
|
-
res.json(await handleDiscovery(
|
|
33
|
+
res.json(await handleDiscovery(await requestConfig(req)));
|
|
21
34
|
return;
|
|
22
35
|
}
|
|
23
36
|
if (req.method === "POST") {
|
|
24
37
|
const scope = config.getScope ? await config.getScope(req) : {};
|
|
25
|
-
const result = await handleQuery(
|
|
38
|
+
const result = await handleQuery(await requestConfig(req), req.body, scope);
|
|
26
39
|
res.status(result.status).json(result.body);
|
|
27
40
|
return;
|
|
28
41
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/adapters/express/index.ts"],"names":[],"mappings":";;;;;
|
|
1
|
+
{"version":3,"sources":["../../../src/adapters/express/index.ts"],"names":[],"mappings":";;;;;AA8BA,IAAM,mBAAA,GAAsB,CAAC,IAAA,KAAsC;AACjE,EAAA,IAAI,IAAA,KAAS,IAAA,IAAQ,OAAO,IAAA,KAAS,UAAU,OAAO,MAAA;AACtD,EAAA,MAAM,EAAA,GAAM,KAAiC,aAAa,CAAA;AAC1D,EAAA,OAAO,OAAO,EAAA,KAAO,QAAA,IAAY,EAAA,CAAG,MAAA,GAAS,IAAI,EAAA,GAAK,MAAA;AACxD,CAAA;AAEO,IAAM,GAAA,GAAM,CACjB,MAAA,KAC4D;AAC5D,EAAA,oBAAA,CAAqB,MAAM,CAAA;AAC3B,EAAA,MAAM,aAAA,GAAgB;AAAA,IACpB,QAAQ,MAAA,CAAO,MAAA;AAAA,IACf,UAAU,MAAA,CAAO,QAAA;AAAA,IACjB,GAAI,OAAO,MAAA,KAAW,IAAA,GAAO,EAAE,MAAA,EAAQ,IAAA,KAAS,EAAC;AAAA,IACjD,GAAI,OAAO,kBAAA,KAAuB,KAAA,GAAQ,EAAE,kBAAA,EAAoB,KAAA,KAAU,EAAC;AAAA,IAC3E,GAAI,OAAO,SAAA,KAAc,MAAA,GAAY,EAAE,SAAA,EAAW,MAAA,CAAO,SAAA,EAAU,GAAI;AAAC,GAC1E;AAIA,EAAA,MAAM,aAAA,GAAgB,OAAO,GAAA,KAAyC;AACpE,IAAA,MAAM,SAAS,MAAA,CAAO,SAAA,GAAY,MAAM,MAAA,CAAO,SAAA,CAAU,GAAG,CAAA,GAAI,MAAA;AAChE,IAAA,MAAM,EAAE,mBAAkB,GAAI,MAAA;AAC9B,IAAA,OAAO;AAAA,MACL,GAAG,aAAA;AAAA,MACH,GAAI,MAAA,KAAW,MAAA,GAAY,EAAE,WAAA,EAAa,MAAA,KAAW,EAAC;AAAA,MACtD,GAAI,iBAAA,KAAsB,MAAA,GAAY,EAAE,cAAA,EAAgB,CAAC,KAAA,KAAkB,iBAAA,CAAkB,GAAA,EAAK,KAAK,CAAA,EAAE,GAAI,EAAC;AAAA,MAC9G,GAAI,OAAO,SAAA,KAAc,MAAA,GAAY,EAAE,SAAA,EAAW,MAAA,CAAO,SAAA,EAAU,GAAI,EAAC;AAAA,MACxE,GAAI,MAAA,CAAO,SAAA,KAAc,MAAA,GAAY,EAAE,WAAW,EAAE,GAAG,MAAA,CAAO,SAAA,EAAW,QAAQ,MAAA,IAAU,MAAA,CAAO,UAAU,MAAA,EAAO,KAAM;AAAC,KAC5H;AAAA,EACF,CAAA;AAEA,EAAA,OAAO,OAAO,KAAW,GAAA,KAA2C;AAClE,IAAA,IAAI,GAAA,CAAI,WAAW,KAAA,EAAO;AACxB,MAAA,GAAA,CAAI,KAAK,MAAM,eAAA,CAAgB,MAAM,aAAA,CAAc,GAAG,CAAC,CAAC,CAAA;AACxD,MAAA;AAAA,IACF;AAEA,IAAA,IAAI,GAAA,CAAI,WAAW,MAAA,EAAQ;AACzB,MAAA,MAAM,KAAA,GAAQ,OAAO,QAAA,GAAW,MAAM,OAAO,QAAA,CAAS,GAAG,IAAI,EAAC;AAC9D,MAAA,MAAM,MAAA,GAAS,MAAM,WAAA,CAAY,MAAM,cAAc,GAAG,CAAA,EAAG,GAAA,CAAI,IAAA,EAAM,KAAK,CAAA;AAC1E,MAAA,GAAA,CAAI,OAAO,MAAA,CAAO,MAAM,CAAA,CAAE,IAAA,CAAK,OAAO,IAAI,CAAA;AAC1C,MAAA;AAAA,IACF;AAEA,IAAA,IAAI,GAAA,CAAI,WAAW,OAAA,EAAS;AAC1B,MAAA,MAAM,WAAA,GAAc,mBAAA,CAAoB,GAAA,CAAI,IAAI,CAAA;AAChD,MAAA,IAAI,gBAAgB,MAAA,EAAW;AAC7B,QAAA,GAAA,CAAI,MAAA,CAAO,GAAG,CAAA,CAAE,IAAA,CAAK,EAAE,KAAA,EAAO,iBAAA,EAAmB,OAAA,EAAS,mCAAA,EAAqC,CAAA;AAC/F,QAAA;AAAA,MACF;AACA,MAAA,MAAM,MAAA,GAAU,GAAA,CAAI,IAAA,CAAiC,WAAW,CAAA;AAChE,MAAA,MAAM,MAAA,GAAS,MAAM,sBAAA,CAAuB,aAAA,EAAe,WAAA,EAAa;AAAA,QACtE,GAAI,OAAO,MAAA,KAAW,SAAA,GAAY,EAAE,SAAA,EAAW,MAAA,KAAW;AAAC,OAC5D,CAAA;AACD,MAAA,GAAA,CAAI,OAAO,MAAA,CAAO,MAAM,CAAA,CAAE,IAAA,CAAK,OAAO,IAAI,CAAA;AAC1C,MAAA;AAAA,IACF;AAEA,IAAA,IAAI,GAAA,CAAI,WAAW,QAAA,EAAU;AAC3B,MAAA,MAAM,WAAA,GAAc,mBAAA,CAAoB,GAAA,CAAI,IAAI,CAAA;AAChD,MAAA,IAAI,gBAAgB,MAAA,EAAW;AAC7B,QAAA,GAAA,CAAI,MAAA,CAAO,GAAG,CAAA,CAAE,IAAA,CAAK,EAAE,KAAA,EAAO,iBAAA,EAAmB,OAAA,EAAS,mCAAA,EAAqC,CAAA;AAC/F,QAAA;AAAA,MACF;AACA,MAAA,MAAM,MAAA,GAAS,MAAM,uBAAA,CAAwB,aAAA,EAAe,WAAW,CAAA;AACvE,MAAA,GAAA,CAAI,OAAO,MAAA,CAAO,MAAM,CAAA,CAAE,IAAA,CAAK,OAAO,IAAI,CAAA;AAC1C,MAAA;AAAA,IACF;AAEA,IAAA,GAAA,CAAI,MAAA,CAAO,GAAG,CAAA,CAAE,IAAA,CAAK;AAAA,MACnB,KAAA,EAAO,oBAAA;AAAA,MACP,OAAA,EAAS;AAAA,KACV,CAAA;AAAA,EACH,CAAA;AACF","file":"index.js","sourcesContent":["import type { QueryEngine } from '../../types.js';\nimport type { ScopePolicy, ScopeValues } from '../../scope/scope.types.js';\nimport type { VexHandlerConfig, ExecuteRecord } from '../../handler.js';\nimport { handleDiscovery, handleQuery, handleFingerprintPatch, handleFingerprintDelete, warnOfOpenManagement } from '../../handler.js';\n\nexport type VexExpressRequest = {\n method: string;\n body: unknown;\n query: Record<string, unknown>;\n};\n\nexport type VexExpressResponse = {\n json(body: unknown): unknown;\n status(code: number): VexExpressResponse;\n};\n\nexport type VexExpressConfig<TReq extends VexExpressRequest = VexExpressRequest> = {\n engine: QueryEngine;\n entities?: string[];\n locked?: boolean;\n manageFingerprints?: boolean;\n getScope?: (req: TReq) => Promise<ScopeValues> | ScopeValues;\n getPolicy?: (req: TReq) => Promise<ScopePolicy | undefined> | ScopePolicy | undefined;\n getPolicyForReach?: (req: TReq, reach: string) => Promise<ScopePolicy | undefined> | ScopePolicy | undefined;\n mutations?: VexHandlerConfig['mutations'];\n onExecute?: (record: ExecuteRecord) => void;\n};\n\n// A fingerprint may contain '/' (a named slot such as \"deals/table\"), so it\n// travels in the request body, not the path.\nconst fingerprintFromBody = (body: unknown): string | undefined => {\n if (body === null || typeof body !== 'object') return undefined;\n const fp = (body as Record<string, unknown>)['fingerprint'];\n return typeof fp === 'string' && fp.length > 0 ? fp : undefined;\n};\n\nexport const vex = <TReq extends VexExpressRequest = VexExpressRequest>(\n config: VexExpressConfig<TReq>,\n): ((req: TReq, res: VexExpressResponse) => Promise<void>) => {\n warnOfOpenManagement(config);\n const handlerConfig = {\n engine: config.engine,\n entities: config.entities,\n ...(config.locked === true ? { locked: true } : {}),\n ...(config.manageFingerprints === false ? { manageFingerprints: false } : {}),\n ...(config.mutations !== undefined ? { mutations: config.mutations } : {}),\n };\n\n // Fingerprint management (PATCH, DELETE) is an operator's surface: it keeps\n // `handlerConfig` and carries no per-request policy.\n const requestConfig = async (req: TReq): Promise<VexHandlerConfig> => {\n const policy = config.getPolicy ? await config.getPolicy(req) : undefined;\n const { getPolicyForReach } = config;\n return {\n ...handlerConfig,\n ...(policy !== undefined ? { scopePolicy: policy } : {}),\n ...(getPolicyForReach !== undefined ? { policyForReach: (reach: string) => getPolicyForReach(req, reach) } : {}),\n ...(config.onExecute !== undefined ? { onExecute: config.onExecute } : {}),\n ...(config.mutations !== undefined ? { mutations: { ...config.mutations, policy: policy ?? config.mutations.policy } } : {}),\n };\n };\n\n return async (req: TReq, res: VexExpressResponse): Promise<void> => {\n if (req.method === 'GET') {\n res.json(await handleDiscovery(await requestConfig(req)));\n return;\n }\n\n if (req.method === 'POST') {\n const scope = config.getScope ? await config.getScope(req) : {};\n const result = await handleQuery(await requestConfig(req), req.body, scope);\n res.status(result.status).json(result.body);\n return;\n }\n\n if (req.method === 'PATCH') {\n const fingerprint = fingerprintFromBody(req.body);\n if (fingerprint === undefined) {\n res.status(400).json({ error: 'invalid_request', message: 'Body must include { fingerprint }' });\n return;\n }\n const wanted = (req.body as Record<string, unknown>)['protected'];\n const result = await handleFingerprintPatch(handlerConfig, fingerprint, {\n ...(typeof wanted === 'boolean' ? { protected: wanted } : {}),\n });\n res.status(result.status).json(result.body);\n return;\n }\n\n if (req.method === 'DELETE') {\n const fingerprint = fingerprintFromBody(req.body);\n if (fingerprint === undefined) {\n res.status(400).json({ error: 'invalid_request', message: 'Body must include { fingerprint }' });\n return;\n }\n const result = await handleFingerprintDelete(handlerConfig, fingerprint);\n res.status(result.status).json(result.body);\n return;\n }\n\n res.status(405).json({\n error: 'method_not_allowed',\n message: 'GET discovery · POST query · PATCH/DELETE fingerprint management',\n });\n };\n};\n"]}
|