@niscorp/vex 0.3.1 → 0.4.1

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 (50) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/DESIGN.md +11 -7
  3. package/DOCS.md +52 -9
  4. package/dist/adapters/express/index.cjs +1 -1
  5. package/dist/adapters/express/index.cjs.map +1 -1
  6. package/dist/adapters/express/index.d.cts +3 -2
  7. package/dist/adapters/express/index.d.ts +3 -2
  8. package/dist/adapters/express/index.js +3 -2
  9. package/dist/adapters/express/index.js.map +1 -1
  10. package/dist/adapters/hono/index.cjs +1 -1
  11. package/dist/adapters/hono/index.cjs.map +1 -1
  12. package/dist/adapters/hono/index.d.cts +3 -2
  13. package/dist/adapters/hono/index.d.ts +3 -2
  14. package/dist/adapters/hono/index.js +3 -2
  15. package/dist/adapters/hono/index.js.map +1 -1
  16. package/dist/agent/index.cjs +144 -21
  17. package/dist/agent/index.cjs.map +1 -1
  18. package/dist/agent/index.d.cts +3 -2
  19. package/dist/agent/index.d.ts +3 -2
  20. package/dist/agent/index.js +146 -22
  21. package/dist/agent/index.js.map +1 -1
  22. package/dist/{chunk-3HORTMZ7.js → chunk-AKR6HU34.js} +9 -5
  23. package/dist/chunk-AKR6HU34.js.map +1 -0
  24. package/dist/chunk-F7RDSWYF.js +7 -0
  25. package/dist/chunk-F7RDSWYF.js.map +1 -0
  26. package/dist/{chunk-J7JYKCUA.js → chunk-UPQMKAAX.js} +3 -18
  27. package/dist/chunk-UPQMKAAX.js.map +1 -0
  28. package/dist/chunk-XTOK7YOR.js +18 -0
  29. package/dist/chunk-XTOK7YOR.js.map +1 -0
  30. package/dist/{handler-B4NAi4k_.d.cts → handler-CoJxInw-.d.ts} +2 -1
  31. package/dist/{handler-BRVhWuNk.d.ts → handler-CsFbanZA.d.cts} +2 -1
  32. package/dist/index.cjs +26 -13
  33. package/dist/index.cjs.map +1 -1
  34. package/dist/index.d.cts +6 -4
  35. package/dist/index.d.ts +6 -4
  36. package/dist/index.js +30 -20
  37. package/dist/index.js.map +1 -1
  38. package/dist/migrations/index.cjs +173 -0
  39. package/dist/migrations/index.cjs.map +1 -0
  40. package/dist/migrations/index.d.cts +20 -0
  41. package/dist/migrations/index.d.ts +20 -0
  42. package/dist/migrations/index.js +23 -0
  43. package/dist/migrations/index.js.map +1 -0
  44. package/dist/query.schema-B-LVNfyX.d.cts +461 -0
  45. package/dist/query.schema-B-LVNfyX.d.ts +461 -0
  46. package/dist/{types-DUJp5B3o.d.cts → types-B2HEmyNq.d.cts} +11 -463
  47. package/dist/{types-DUJp5B3o.d.ts → types-DC68ZUuq.d.ts} +11 -463
  48. package/package.json +12 -1
  49. package/dist/chunk-3HORTMZ7.js.map +0 -1
  50. package/dist/chunk-J7JYKCUA.js.map +0 -1
@@ -1,5 +1,6 @@
1
- import { a as QueryEngine, al as ScopeValues } from '../../types-DUJp5B3o.cjs';
2
- import { V as VexHandlerConfig } from '../../handler-B4NAi4k_.cjs';
1
+ import { a as QueryEngine, aa as ScopeValues } from '../../types-B2HEmyNq.cjs';
2
+ import { V as VexHandlerConfig } from '../../handler-CsFbanZA.cjs';
3
+ import '../../query.schema-B-LVNfyX.cjs';
3
4
  import 'zod';
4
5
  import '@niscorp/prism';
5
6
  import '@niscorp/strata';
@@ -1,5 +1,6 @@
1
- import { a as QueryEngine, al as ScopeValues } from '../../types-DUJp5B3o.js';
2
- import { V as VexHandlerConfig } from '../../handler-BRVhWuNk.js';
1
+ import { a as QueryEngine, aa as ScopeValues } from '../../types-DC68ZUuq.js';
2
+ import { V as VexHandlerConfig } from '../../handler-CoJxInw-.js';
3
+ import '../../query.schema-B-LVNfyX.js';
3
4
  import 'zod';
4
5
  import '@niscorp/prism';
5
6
  import '@niscorp/strata';
@@ -1,5 +1,6 @@
1
- import { handleDiscovery, handleQuery, handleFingerprintPatch, handleFingerprintDelete } from '../../chunk-3HORTMZ7.js';
2
- import '../../chunk-J7JYKCUA.js';
1
+ import { handleDiscovery, handleQuery, handleFingerprintPatch, handleFingerprintDelete } from '../../chunk-AKR6HU34.js';
2
+ import '../../chunk-XTOK7YOR.js';
3
+ import '../../chunk-UPQMKAAX.js';
3
4
 
4
5
  // src/adapters/express/index.ts
5
6
  var fingerprintFromBody = (body) => {
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/adapters/express/index.ts"],"names":[],"mappings":";;;;AA0BA,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,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,SAAA,KAAc,MAAA,GAAY,EAAE,SAAA,EAAW,MAAA,CAAO,SAAA,EAAU,GAAI;AAAC,GAC1E;AAEA,EAAA,OAAO,OAAO,KAAW,GAAA,KAA2C;AAClE,IAAA,IAAI,GAAA,CAAI,WAAW,KAAA,EAAO;AACxB,MAAA,GAAA,CAAI,IAAA,CAAK,MAAM,eAAA,CAAgB,aAAa,CAAC,CAAA;AAC7C,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,SAAS,MAAM,WAAA,CAAY,aAAA,EAAe,GAAA,CAAI,MAAM,KAAK,CAAA;AAC/D,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 { ScopeValues } from '../../scope/scope.types.js';\nimport type { VexHandlerConfig } from '../../handler.js';\nimport { handleDiscovery, handleQuery, handleFingerprintPatch, handleFingerprintDelete } 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 getScope?: (req: TReq) => Promise<ScopeValues> | ScopeValues;\n mutations?: VexHandlerConfig['mutations'];\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 const handlerConfig = {\n engine: config.engine,\n entities: config.entities,\n ...(config.locked === true ? { locked: true } : {}),\n ...(config.mutations !== undefined ? { mutations: config.mutations } : {}),\n };\n\n return async (req: TReq, res: VexExpressResponse): Promise<void> => {\n if (req.method === 'GET') {\n res.json(await handleDiscovery(handlerConfig));\n return;\n }\n\n if (req.method === 'POST') {\n const scope = config.getScope ? await config.getScope(req) : {};\n const result = await handleQuery(handlerConfig, 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"]}
1
+ {"version":3,"sources":["../../../src/adapters/express/index.ts"],"names":[],"mappings":";;;;;AA0BA,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,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,SAAA,KAAc,MAAA,GAAY,EAAE,SAAA,EAAW,MAAA,CAAO,SAAA,EAAU,GAAI;AAAC,GAC1E;AAEA,EAAA,OAAO,OAAO,KAAW,GAAA,KAA2C;AAClE,IAAA,IAAI,GAAA,CAAI,WAAW,KAAA,EAAO;AACxB,MAAA,GAAA,CAAI,IAAA,CAAK,MAAM,eAAA,CAAgB,aAAa,CAAC,CAAA;AAC7C,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,SAAS,MAAM,WAAA,CAAY,aAAA,EAAe,GAAA,CAAI,MAAM,KAAK,CAAA;AAC/D,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 { ScopeValues } from '../../scope/scope.types.js';\nimport type { VexHandlerConfig } from '../../handler.js';\nimport { handleDiscovery, handleQuery, handleFingerprintPatch, handleFingerprintDelete } 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 getScope?: (req: TReq) => Promise<ScopeValues> | ScopeValues;\n mutations?: VexHandlerConfig['mutations'];\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 const handlerConfig = {\n engine: config.engine,\n entities: config.entities,\n ...(config.locked === true ? { locked: true } : {}),\n ...(config.mutations !== undefined ? { mutations: config.mutations } : {}),\n };\n\n return async (req: TReq, res: VexExpressResponse): Promise<void> => {\n if (req.method === 'GET') {\n res.json(await handleDiscovery(handlerConfig));\n return;\n }\n\n if (req.method === 'POST') {\n const scope = config.getScope ? await config.getScope(req) : {};\n const result = await handleQuery(handlerConfig, 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"]}
@@ -1406,7 +1406,7 @@ var runQuery = async (config, body, scope, probe, live) => {
1406
1406
  try {
1407
1407
  let entryReach;
1408
1408
  if (parsed.data.fingerprint !== void 0) {
1409
- const entry = await engine.cache.get(parsed.data.fingerprint);
1409
+ const entry = await engine.cache.get(parsed.data.fingerprint, scope);
1410
1410
  if (entry !== void 0 && entry.kind === "ok") entryReach = entry.reach;
1411
1411
  if (probe !== void 0 && entryReach !== void 0) probe.reach = entryReach;
1412
1412
  if (entry !== void 0 && entry.kind === "mutation") {