hippo-memory 0.35.0 → 0.37.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 +25 -0
- package/dist/api.d.ts +183 -0
- package/dist/api.d.ts.map +1 -0
- package/dist/api.js +343 -0
- package/dist/api.js.map +1 -0
- package/dist/benchmarks/e1.3/incident-recall-eval.js +74 -0
- package/dist/benchmarks/e1.3/incident-recall-eval.js.map +1 -0
- package/dist/benchmarks/e1.3/scenarios.json +2587 -0
- package/dist/benchmarks/e1.3/slack-1000-event-smoke.js +102 -0
- package/dist/benchmarks/e1.3/slack-1000-event-smoke.js.map +1 -0
- package/dist/cli.js +222 -34
- package/dist/cli.js.map +1 -1
- package/dist/client.d.ts +54 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +181 -0
- package/dist/client.js.map +1 -0
- package/dist/connectors/slack/backfill.d.ts +42 -0
- package/dist/connectors/slack/backfill.d.ts.map +1 -0
- package/dist/connectors/slack/backfill.js +76 -0
- package/dist/connectors/slack/backfill.js.map +1 -0
- package/dist/connectors/slack/deletion.d.ts +14 -0
- package/dist/connectors/slack/deletion.d.ts.map +1 -0
- package/dist/connectors/slack/deletion.js +46 -0
- package/dist/connectors/slack/deletion.js.map +1 -0
- package/dist/connectors/slack/dlq.d.ts +21 -0
- package/dist/connectors/slack/dlq.d.ts.map +1 -0
- package/dist/connectors/slack/dlq.js +23 -0
- package/dist/connectors/slack/dlq.js.map +1 -0
- package/dist/connectors/slack/idempotency.d.ts +5 -0
- package/dist/connectors/slack/idempotency.d.ts.map +1 -0
- package/dist/connectors/slack/idempotency.js +13 -0
- package/dist/connectors/slack/idempotency.js.map +1 -0
- package/dist/connectors/slack/ingest.d.ts +27 -0
- package/dist/connectors/slack/ingest.d.ts.map +1 -0
- package/dist/connectors/slack/ingest.js +48 -0
- package/dist/connectors/slack/ingest.js.map +1 -0
- package/dist/connectors/slack/ratelimit.d.ts +9 -0
- package/dist/connectors/slack/ratelimit.d.ts.map +1 -0
- package/dist/connectors/slack/ratelimit.js +18 -0
- package/dist/connectors/slack/ratelimit.js.map +1 -0
- package/dist/connectors/slack/scope.d.ts +16 -0
- package/dist/connectors/slack/scope.d.ts.map +1 -0
- package/dist/connectors/slack/scope.js +13 -0
- package/dist/connectors/slack/scope.js.map +1 -0
- package/dist/connectors/slack/signature.d.ts +12 -0
- package/dist/connectors/slack/signature.d.ts.map +1 -0
- package/dist/connectors/slack/signature.js +20 -0
- package/dist/connectors/slack/signature.js.map +1 -0
- package/dist/connectors/slack/tenant-routing.d.ts +13 -0
- package/dist/connectors/slack/tenant-routing.d.ts.map +1 -0
- package/dist/connectors/slack/tenant-routing.js +17 -0
- package/dist/connectors/slack/tenant-routing.js.map +1 -0
- package/dist/connectors/slack/transform.d.ts +20 -0
- package/dist/connectors/slack/transform.d.ts.map +1 -0
- package/dist/connectors/slack/transform.js +31 -0
- package/dist/connectors/slack/transform.js.map +1 -0
- package/dist/connectors/slack/types.d.ts +35 -0
- package/dist/connectors/slack/types.d.ts.map +1 -0
- package/dist/connectors/slack/types.js +23 -0
- package/dist/connectors/slack/types.js.map +1 -0
- package/dist/connectors/slack/web-client.d.ts +12 -0
- package/dist/connectors/slack/web-client.d.ts.map +1 -0
- package/dist/connectors/slack/web-client.js +43 -0
- package/dist/connectors/slack/web-client.js.map +1 -0
- package/dist/db.d.ts.map +1 -1
- package/dist/db.js +46 -1
- package/dist/db.js.map +1 -1
- package/dist/importers.js +3 -3
- package/dist/importers.js.map +1 -1
- package/dist/mcp/server.d.ts +46 -1
- package/dist/mcp/server.d.ts.map +1 -1
- package/dist/mcp/server.js +74 -26
- package/dist/mcp/server.js.map +1 -1
- package/dist/server-detect.d.ts +26 -0
- package/dist/server-detect.d.ts.map +1 -0
- package/dist/server-detect.js +70 -0
- package/dist/server-detect.js.map +1 -0
- package/dist/server.d.ts +29 -0
- package/dist/server.d.ts.map +1 -0
- package/dist/server.js +784 -0
- package/dist/server.js.map +1 -0
- package/dist/shared.d.ts +3 -1
- package/dist/shared.d.ts.map +1 -1
- package/dist/shared.js +2 -2
- package/dist/shared.js.map +1 -1
- package/dist/src/ambient.js +147 -0
- package/dist/src/ambient.js.map +1 -0
- package/dist/src/api.js +343 -0
- package/dist/src/api.js.map +1 -0
- package/dist/src/audit.js +152 -0
- package/dist/src/audit.js.map +1 -0
- package/dist/src/auth.js +65 -0
- package/dist/src/auth.js.map +1 -0
- package/dist/src/autolearn.js +143 -0
- package/dist/src/autolearn.js.map +1 -0
- package/dist/src/capture.js +512 -0
- package/dist/src/capture.js.map +1 -0
- package/dist/src/cli.js +4971 -0
- package/dist/src/cli.js.map +1 -0
- package/dist/src/client.js +181 -0
- package/dist/src/client.js.map +1 -0
- package/dist/src/config.js +108 -0
- package/dist/src/config.js.map +1 -0
- package/dist/src/connectors/slack/backfill.js +76 -0
- package/dist/src/connectors/slack/backfill.js.map +1 -0
- package/dist/src/connectors/slack/deletion.js +46 -0
- package/dist/src/connectors/slack/deletion.js.map +1 -0
- package/dist/src/connectors/slack/dlq.js +23 -0
- package/dist/src/connectors/slack/dlq.js.map +1 -0
- package/dist/src/connectors/slack/idempotency.js +13 -0
- package/dist/src/connectors/slack/idempotency.js.map +1 -0
- package/dist/src/connectors/slack/ingest.js +48 -0
- package/dist/src/connectors/slack/ingest.js.map +1 -0
- package/dist/src/connectors/slack/ratelimit.js +18 -0
- package/dist/src/connectors/slack/ratelimit.js.map +1 -0
- package/dist/src/connectors/slack/scope.js +13 -0
- package/dist/src/connectors/slack/scope.js.map +1 -0
- package/dist/src/connectors/slack/signature.js +20 -0
- package/dist/src/connectors/slack/signature.js.map +1 -0
- package/dist/src/connectors/slack/tenant-routing.js +17 -0
- package/dist/src/connectors/slack/tenant-routing.js.map +1 -0
- package/dist/src/connectors/slack/transform.js +31 -0
- package/dist/src/connectors/slack/transform.js.map +1 -0
- package/dist/src/connectors/slack/types.js +23 -0
- package/dist/src/connectors/slack/types.js.map +1 -0
- package/dist/src/connectors/slack/web-client.js +43 -0
- package/dist/src/connectors/slack/web-client.js.map +1 -0
- package/dist/src/consolidate.js +517 -0
- package/dist/src/consolidate.js.map +1 -0
- package/dist/src/dag.js +104 -0
- package/dist/src/dag.js.map +1 -0
- package/dist/src/dashboard.js +409 -0
- package/dist/src/dashboard.js.map +1 -0
- package/dist/src/db.js +584 -0
- package/dist/src/db.js.map +1 -0
- package/dist/src/embeddings.js +344 -0
- package/dist/src/embeddings.js.map +1 -0
- package/dist/src/eval-suite.js +289 -0
- package/dist/src/eval-suite.js.map +1 -0
- package/dist/src/eval.js +187 -0
- package/dist/src/eval.js.map +1 -0
- package/dist/src/extract.js +87 -0
- package/dist/src/extract.js.map +1 -0
- package/dist/src/handoff.js +30 -0
- package/dist/src/handoff.js.map +1 -0
- package/dist/src/hooks.js +582 -0
- package/dist/src/hooks.js.map +1 -0
- package/dist/src/importers.js +399 -0
- package/dist/src/importers.js.map +1 -0
- package/dist/src/index.js +25 -0
- package/dist/src/index.js.map +1 -0
- package/dist/src/invalidation.js +94 -0
- package/dist/src/invalidation.js.map +1 -0
- package/dist/src/mcp/framing.js +45 -0
- package/dist/src/mcp/framing.js.map +1 -0
- package/dist/src/mcp/server.js +510 -0
- package/dist/src/mcp/server.js.map +1 -0
- package/dist/src/memory.js +280 -0
- package/dist/src/memory.js.map +1 -0
- package/dist/src/multihop.js +32 -0
- package/dist/src/multihop.js.map +1 -0
- package/dist/src/path-context.js +32 -0
- package/dist/src/path-context.js.map +1 -0
- package/dist/src/physics-config.js +26 -0
- package/dist/src/physics-config.js.map +1 -0
- package/dist/src/physics-state.js +163 -0
- package/dist/src/physics-state.js.map +1 -0
- package/dist/src/physics.js +361 -0
- package/dist/src/physics.js.map +1 -0
- package/dist/src/postinstall.js +68 -0
- package/dist/src/postinstall.js.map +1 -0
- package/dist/src/raw-archive.js +72 -0
- package/dist/src/raw-archive.js.map +1 -0
- package/dist/src/refine-llm.js +147 -0
- package/dist/src/refine-llm.js.map +1 -0
- package/dist/src/replay.js +117 -0
- package/dist/src/replay.js.map +1 -0
- package/dist/src/salience.js +74 -0
- package/dist/src/salience.js.map +1 -0
- package/dist/src/scheduler.js +67 -0
- package/dist/src/scheduler.js.map +1 -0
- package/dist/src/scope.js +35 -0
- package/dist/src/scope.js.map +1 -0
- package/dist/src/search.js +801 -0
- package/dist/src/search.js.map +1 -0
- package/dist/src/server-detect.js +70 -0
- package/dist/src/server-detect.js.map +1 -0
- package/dist/src/server.js +784 -0
- package/dist/src/server.js.map +1 -0
- package/dist/src/shared.js +309 -0
- package/dist/src/shared.js.map +1 -0
- package/dist/src/sso.js +22 -0
- package/dist/src/sso.js.map +1 -0
- package/dist/src/store.js +1390 -0
- package/dist/src/store.js.map +1 -0
- package/dist/src/tenant.js +17 -0
- package/dist/src/tenant.js.map +1 -0
- package/dist/src/trace.js +64 -0
- package/dist/src/trace.js.map +1 -0
- package/dist/src/working-memory.js +149 -0
- package/dist/src/working-memory.js.map +1 -0
- package/dist/src/yaml.js +98 -0
- package/dist/src/yaml.js.map +1 -0
- package/dist/store.d.ts +25 -4
- package/dist/store.d.ts.map +1 -1
- package/dist/store.js +50 -11
- package/dist/store.js.map +1 -1
- package/extensions/openclaw-plugin/openclaw.plugin.json +1 -1
- package/extensions/openclaw-plugin/package.json +1 -1
- package/openclaw.plugin.json +1 -1
- package/package.json +2 -2
- package/dist/import.d.ts +0 -31
- package/dist/import.d.ts.map +0 -1
- package/dist/import.js +0 -307
- package/dist/import.js.map +0 -1
package/README.md
CHANGED
|
@@ -60,6 +60,23 @@ hippo recall "data pipeline issues" --budget 2000
|
|
|
60
60
|
|
|
61
61
|
---
|
|
62
62
|
|
|
63
|
+
### What's new in v0.37.0
|
|
64
|
+
|
|
65
|
+
- **Slack ingestion (E1.3).** First end-to-end ingestion connector. `POST /v1/connectors/slack/events` accepts HMAC-signed Events API webhooks; messages land as `kind='raw'` memories with `slack://team/channel/ts` provenance and a `slack:public:*` or `slack:private:*` scope. Source deletions route through `archiveRawMemory` (GDPR). Backfill via `hippo slack backfill --channel <id>`; malformed events to `hippo slack dlq list`.
|
|
66
|
+
- **Schema v17.** New tables: `slack_event_log` (idempotency), `slack_cursors` (backfill resume), `slack_dlq` (parse failures), `slack_workspaces` (team_id to tenant_id routing).
|
|
67
|
+
- **PUBLIC_ROUTES allow-list + HIPPO_REQUIRE_AUTH knob.** Slack webhook is the first explicit public `/v1/*` route (HMAC-signed, no Bearer). Every other `/v1/*` route returns 401 without auth when `HIPPO_REQUIRE_AUTH=1`.
|
|
68
|
+
- **Recall default-deny on private scopes.** No-scope queries cannot see `slack:private:*` memories. Frontend callers passing undefined scope no longer leak private content.
|
|
69
|
+
- **api.remember afterWrite hook.** Connectors stamp idempotency rows atomically with the memory row via a SAVEPOINT-scoped callback.
|
|
70
|
+
|
|
71
|
+
### What's new in v0.36.0
|
|
72
|
+
|
|
73
|
+
- **`hippo serve` daemon.** Persistent HTTP server on 127.0.0.1:6789. CLI auto-detects and becomes a thin client; one process owns the SQLite DB.
|
|
74
|
+
- **MCP-over-HTTP.** MCP clients can now connect over HTTP/SSE in addition to stdio. Same tool surface.
|
|
75
|
+
- **Bearer-token auth + loopback trust.** Set HIPPO_API_KEY for remote calls; loopback connections work without a key. Server refuses to bind to non-loopback host without auth.
|
|
76
|
+
- **Audit log fix.** Mutations on non-default tenants are now correctly attributed in the audit log (was using HIPPO_TENANT env, now uses the row's tenant_id).
|
|
77
|
+
- **Tenant deny on archive/forget.** A valid Bearer for tenant A can no longer affect tenant B's memories, cross-tenant requests return "memory not found".
|
|
78
|
+
- **Known issue:** p99 recall latency is 58.4ms on a 10k store, target is 50ms. Architecture ships; latency hardening in v0.37.0.
|
|
79
|
+
|
|
63
80
|
### What's new in v0.35.0
|
|
64
81
|
|
|
65
82
|
- **Stub auth landed.** API keys + audit log + per-tenant data isolation. `hippo auth create` mints a scrypt-hashed key shown plaintext exactly once. `hippo audit list` exposes the mutation trail.
|
|
@@ -353,6 +370,14 @@ hippo capture --file conversation.md
|
|
|
353
370
|
hippo capture --file conversation.md --dry-run
|
|
354
371
|
```
|
|
355
372
|
|
|
373
|
+
### Slack ingestion (E1.3)
|
|
374
|
+
|
|
375
|
+
Hippo accepts Slack Events API webhooks at `POST /v1/connectors/slack/events`. Configure `SLACK_SIGNING_SECRET` (validated on every request) and point Slack at `https://<your-host>/v1/connectors/slack/events`. Messages land as `kind='raw'` memories with `slack://team/channel/ts` provenance and a `slack:public:Cxxx` or `slack:private:Cxxx` scope. Source deletions are honored (GDPR).
|
|
376
|
+
|
|
377
|
+
Backfill an existing channel: `SLACK_BOT_TOKEN=xoxb-... hippo slack backfill --channel C0000`. Inspect malformed events: `hippo slack dlq list`.
|
|
378
|
+
|
|
379
|
+
Multi-workspace deployments populate `slack_workspaces (team_id, tenant_id)` to route events per tenant; single-workspace falls back to `HIPPO_TENANT`.
|
|
380
|
+
|
|
356
381
|
### Active task snapshots
|
|
357
382
|
|
|
358
383
|
Long-running work needs short-term continuity, not just long-term memory. Hippo can persist the current in-flight task so a later `continue` has something concrete to recover.
|
package/dist/api.d.ts
ADDED
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Domain API layer for Hippo.
|
|
3
|
+
*
|
|
4
|
+
* Pure functions taking a Context (hippoRoot + tenantId + actor) plus
|
|
5
|
+
* operation options. Both the CLI (direct mode) and the HTTP server
|
|
6
|
+
* (`hippo serve`, A1) call into this module so the business logic lives
|
|
7
|
+
* in exactly one place.
|
|
8
|
+
*/
|
|
9
|
+
import { type DatabaseSyncLike } from './db.js';
|
|
10
|
+
import { type MemoryKind } from './memory.js';
|
|
11
|
+
import { type AuditEvent, type AuditOp } from './audit.js';
|
|
12
|
+
import { type ApiKeyListItem } from './auth.js';
|
|
13
|
+
export interface Context {
|
|
14
|
+
hippoRoot: string;
|
|
15
|
+
tenantId: string;
|
|
16
|
+
/** 'cli' | 'localhost:cli' | 'api_key:<key_id>' | 'mcp' */
|
|
17
|
+
actor: string;
|
|
18
|
+
}
|
|
19
|
+
export interface RememberOpts {
|
|
20
|
+
content: string;
|
|
21
|
+
kind?: MemoryKind;
|
|
22
|
+
scope?: string;
|
|
23
|
+
owner?: string;
|
|
24
|
+
artifactRef?: string;
|
|
25
|
+
tags?: string[];
|
|
26
|
+
/**
|
|
27
|
+
* Optional hook invoked inside the same transaction as the underlying
|
|
28
|
+
* memories INSERT. Used by ingestion connectors (E1.3+) to stamp
|
|
29
|
+
* idempotency / cursor rows atomically with the memory row, so a crash
|
|
30
|
+
* mid-write cannot produce a memory without its corresponding side-effect
|
|
31
|
+
* log row (or vice versa). If the callback throws, the INSERT is rolled
|
|
32
|
+
* back and the error is rethrown.
|
|
33
|
+
*/
|
|
34
|
+
afterWrite?: (db: DatabaseSyncLike, memoryId: string) => void;
|
|
35
|
+
}
|
|
36
|
+
export interface RememberResult {
|
|
37
|
+
id: string;
|
|
38
|
+
kind: MemoryKind;
|
|
39
|
+
tenantId: string;
|
|
40
|
+
}
|
|
41
|
+
export declare function remember(ctx: Context, opts: RememberOpts): RememberResult;
|
|
42
|
+
export interface RecallOpts {
|
|
43
|
+
query: string;
|
|
44
|
+
limit?: number;
|
|
45
|
+
mode?: 'bm25' | 'hybrid' | 'physics';
|
|
46
|
+
/**
|
|
47
|
+
* Restrict results to memories whose `scope` equals this value exactly.
|
|
48
|
+
*
|
|
49
|
+
* When `scope` is undefined or empty, recall applies a DEFAULT-DENY rule:
|
|
50
|
+
* any memory whose scope starts with `'slack:private:'` is filtered out so
|
|
51
|
+
* a frontend caller passing `undefined` cannot accidentally surface
|
|
52
|
+
* private-channel content. Memories with scope=null (the common case for
|
|
53
|
+
* non-Slack content) are still returned.
|
|
54
|
+
*/
|
|
55
|
+
scope?: string;
|
|
56
|
+
}
|
|
57
|
+
export interface RecallResultItem {
|
|
58
|
+
id: string;
|
|
59
|
+
content: string;
|
|
60
|
+
score: number;
|
|
61
|
+
layer: string;
|
|
62
|
+
strength: number;
|
|
63
|
+
}
|
|
64
|
+
export interface RecallResult {
|
|
65
|
+
results: RecallResultItem[];
|
|
66
|
+
total: number;
|
|
67
|
+
tokens: number;
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Domain-level recall. Loads BM25-ranked candidates from SQLite scoped to
|
|
71
|
+
* `ctx.tenantId`. The `mode` flag is accepted for forward compatibility (the
|
|
72
|
+
* CLI exposes hybrid/physics paths) but Task 2 wires only the BM25 candidate
|
|
73
|
+
* loader; later tasks can extend this to call the physics/hybrid scorer.
|
|
74
|
+
*/
|
|
75
|
+
export declare function recall(ctx: Context, opts: RecallOpts): RecallResult;
|
|
76
|
+
/**
|
|
77
|
+
* Delete a memory by id. `deleteEntry` threads ctx.actor into its internal
|
|
78
|
+
* audit hook, so exactly one 'forget' event lands with the supplied actor.
|
|
79
|
+
*
|
|
80
|
+
* Tenant scope: deleteEntry looks up the row by id alone, so without an
|
|
81
|
+
* explicit tenant guard a Bearer for tenant A could delete tenant B's row
|
|
82
|
+
* by guessing or leaking the id. Pre-check the row's tenant_id and deny
|
|
83
|
+
* cross-tenant access with a not-found error (no info leak about whether
|
|
84
|
+
* the id exists in another tenant).
|
|
85
|
+
*/
|
|
86
|
+
export declare function forget(ctx: Context, id: string): {
|
|
87
|
+
ok: true;
|
|
88
|
+
id: string;
|
|
89
|
+
};
|
|
90
|
+
/**
|
|
91
|
+
* Copy a local memory into the global store. Mirrors `cmdPromote` in cli.ts:
|
|
92
|
+
* the `writeEntry` inside `promoteToGlobal` emits a 'remember' on the global
|
|
93
|
+
* db; we add a 'promote' audit event on the global db so the user-facing
|
|
94
|
+
* intent stays distinct from the underlying upsert.
|
|
95
|
+
*
|
|
96
|
+
* Note: `promoteToGlobal` does not currently take a tenantId override — it
|
|
97
|
+
* reads the entry from the local root via `readEntry` (no tenant filter) and
|
|
98
|
+
* preserves the entry's existing tenantId on the global side. Task 4 may
|
|
99
|
+
* tighten this once writeEntry/readEntry thread tenant context.
|
|
100
|
+
*/
|
|
101
|
+
export declare function promote(ctx: Context, id: string): {
|
|
102
|
+
ok: true;
|
|
103
|
+
sourceId: string;
|
|
104
|
+
globalId: string;
|
|
105
|
+
};
|
|
106
|
+
/**
|
|
107
|
+
* Replace an old memory with new content, chaining old.superseded_by = new.id.
|
|
108
|
+
* Mirrors `cmdSupersede` in cli.ts (without flag-driven layer/tag/pin overrides
|
|
109
|
+
* — A1 keeps the API minimal; the CLI handler will continue to handle those
|
|
110
|
+
* flags and pass the resolved values once Task 4 lands).
|
|
111
|
+
*/
|
|
112
|
+
export declare function supersede(ctx: Context, oldId: string, newContent: string): {
|
|
113
|
+
ok: true;
|
|
114
|
+
oldId: string;
|
|
115
|
+
newId: string;
|
|
116
|
+
};
|
|
117
|
+
/**
|
|
118
|
+
* Archive a kind='raw' memory: snapshot into raw_archive, mark archived, delete.
|
|
119
|
+
*
|
|
120
|
+
* `archiveRawMemory` audits the operation internally (op='archive_raw') using the
|
|
121
|
+
* row's own tenant_id. We DO NOT emit a second audit event here to avoid double-
|
|
122
|
+
* emitting the archive_raw op (unlike Task 1 remember/forget where the underlying
|
|
123
|
+
* helpers hardcode actor='cli'). Instead we pass `ctx.actor` through as `who`,
|
|
124
|
+
* and raw-archive.ts uses that for the audit row.
|
|
125
|
+
*/
|
|
126
|
+
export declare function archiveRaw(ctx: Context, id: string, reason: string): {
|
|
127
|
+
ok: true;
|
|
128
|
+
archivedAt: string;
|
|
129
|
+
};
|
|
130
|
+
export interface AuthCreateOpts {
|
|
131
|
+
label?: string;
|
|
132
|
+
/** Override the calling tenant (e.g. admin minting a key for tenant B). */
|
|
133
|
+
tenantId?: string;
|
|
134
|
+
}
|
|
135
|
+
export interface AuthCreateResult {
|
|
136
|
+
keyId: string;
|
|
137
|
+
plaintext: string;
|
|
138
|
+
tenantId: string;
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Mint a new API key. Per A5 v2 follow-ups (TODOS.md), `auth_create` is currently
|
|
142
|
+
* unaudited — we intentionally match that behavior here for consistency. When A5
|
|
143
|
+
* v2 lands and adds the audit op, this function should mirror the cli handler.
|
|
144
|
+
*/
|
|
145
|
+
export declare function authCreate(ctx: Context, opts: AuthCreateOpts): AuthCreateResult;
|
|
146
|
+
/**
|
|
147
|
+
* List API keys visible to the calling tenant.
|
|
148
|
+
*
|
|
149
|
+
* Divergence from `cmdAuthList` in src/cli.ts: the CLI today returns ALL keys
|
|
150
|
+
* regardless of tenant (single-tenant deployments). The API surface is tenant-
|
|
151
|
+
* scoped because future multi-tenant deployments will share a hippoRoot, and
|
|
152
|
+
* tenant A must not see tenant B's keys. Read-only — no audit emit (matches A5).
|
|
153
|
+
*/
|
|
154
|
+
export declare function authList(ctx: Context, opts: {
|
|
155
|
+
active: boolean;
|
|
156
|
+
}): ApiKeyListItem[];
|
|
157
|
+
/**
|
|
158
|
+
* Revoke an API key.
|
|
159
|
+
*
|
|
160
|
+
* Security: the key must belong to `ctx.tenantId`. Cross-tenant revoke is
|
|
161
|
+
* rejected with the same "not found" message used for missing keys, so that a
|
|
162
|
+
* caller cannot probe which key_ids exist on other tenants.
|
|
163
|
+
*
|
|
164
|
+
* Audit: emits 'auth_revoke' with `tenantId` set to the KEY ROW's tenant_id
|
|
165
|
+
* (M1 fix from A5 review, mirrors src/cli.ts:cmdAuthRevoke). Skipped on no-op
|
|
166
|
+
* revoke (already revoked) so re-running doesn't pad the audit log.
|
|
167
|
+
*/
|
|
168
|
+
export declare function authRevoke(ctx: Context, keyId: string): {
|
|
169
|
+
ok: true;
|
|
170
|
+
revokedAt: string;
|
|
171
|
+
};
|
|
172
|
+
export interface AuditListOpts {
|
|
173
|
+
op?: AuditOp;
|
|
174
|
+
/** ISO timestamp lower bound. */
|
|
175
|
+
since?: string;
|
|
176
|
+
limit?: number;
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* Read audit events scoped to `ctx.tenantId`. Read-only — no audit emit (matches
|
|
180
|
+
* A5: cmdAuditList does not record a 'recall'-style read event).
|
|
181
|
+
*/
|
|
182
|
+
export declare function auditList(ctx: Context, opts: AuditListOpts): AuditEvent[];
|
|
183
|
+
//# sourceMappingURL=api.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAA6B,KAAK,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAQ3E,OAAO,EAEL,KAAK,UAAU,EAGhB,MAAM,aAAa,CAAC;AACrB,OAAO,EAGL,KAAK,UAAU,EACf,KAAK,OAAO,EACb,MAAM,YAAY,CAAC;AAGpB,OAAO,EAIL,KAAK,cAAc,EACpB,MAAM,WAAW,CAAC;AAEnB,MAAM,WAAW,OAAO;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,CAAC,EAAE,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/D;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,GAAG,cAAc,CAczE;AAMD,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IACrC;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,GAAG,YAAY,CAgDnE;AAMD;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAiBzE;AAMD;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CACrB,GAAG,EAAE,OAAO,EACZ,EAAE,EAAE,MAAM,GACT;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAqBlD;AAMD;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,GAAG,EAAE,OAAO,EACZ,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,GACjB;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAuC5C;AAMD;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CACxB,GAAG,EAAE,OAAO,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,GACb;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CA6BlC;AAMD,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,GAAG,gBAAgB,CAS/E;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE;IAAE,MAAM,EAAE,OAAO,CAAA;CAAE,GACxB,cAAc,EAAE,CAQlB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,GAAG,EAAE,OAAO,EACZ,KAAK,EAAE,MAAM,GACZ;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CA8CjC;AAMD,MAAM,WAAW,aAAa;IAC5B,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,iCAAiC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,GAAG,UAAU,EAAE,CAYzE"}
|
package/dist/api.js
ADDED
|
@@ -0,0 +1,343 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Domain API layer for Hippo.
|
|
3
|
+
*
|
|
4
|
+
* Pure functions taking a Context (hippoRoot + tenantId + actor) plus
|
|
5
|
+
* operation options. Both the CLI (direct mode) and the HTTP server
|
|
6
|
+
* (`hippo serve`, A1) call into this module so the business logic lives
|
|
7
|
+
* in exactly one place.
|
|
8
|
+
*/
|
|
9
|
+
import { openHippoDb, closeHippoDb } from './db.js';
|
|
10
|
+
import { writeEntry, readEntry, deleteEntry, loadSearchEntries, removeEntryMirrors, } from './store.js';
|
|
11
|
+
import { createMemory, Layer, } from './memory.js';
|
|
12
|
+
import { appendAuditEvent, queryAuditEvents, } from './audit.js';
|
|
13
|
+
import { promoteToGlobal, getGlobalRoot } from './shared.js';
|
|
14
|
+
import { archiveRawMemory } from './raw-archive.js';
|
|
15
|
+
import { createApiKey, listApiKeys, revokeApiKey, } from './auth.js';
|
|
16
|
+
export function remember(ctx, opts) {
|
|
17
|
+
const entry = createMemory(opts.content, {
|
|
18
|
+
kind: opts.kind ?? 'distilled',
|
|
19
|
+
scope: opts.scope ?? null,
|
|
20
|
+
owner: opts.owner ?? null,
|
|
21
|
+
artifact_ref: opts.artifactRef ?? null,
|
|
22
|
+
tags: opts.tags,
|
|
23
|
+
tenantId: ctx.tenantId,
|
|
24
|
+
});
|
|
25
|
+
// writeEntry threads ctx.actor into its internal audit hook, so exactly
|
|
26
|
+
// one 'remember' event lands in the log with the supplied actor.
|
|
27
|
+
writeEntry(ctx.hippoRoot, entry, { actor: ctx.actor, afterWrite: opts.afterWrite });
|
|
28
|
+
return { id: entry.id, kind: entry.kind, tenantId: ctx.tenantId };
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Domain-level recall. Loads BM25-ranked candidates from SQLite scoped to
|
|
32
|
+
* `ctx.tenantId`. The `mode` flag is accepted for forward compatibility (the
|
|
33
|
+
* CLI exposes hybrid/physics paths) but Task 2 wires only the BM25 candidate
|
|
34
|
+
* loader; later tasks can extend this to call the physics/hybrid scorer.
|
|
35
|
+
*/
|
|
36
|
+
export function recall(ctx, opts) {
|
|
37
|
+
const limit = opts.limit ?? 10;
|
|
38
|
+
const all = loadSearchEntries(ctx.hippoRoot, opts.query, undefined, ctx.tenantId);
|
|
39
|
+
// Scope filtering runs AFTER the tenant filter inside loadSearchEntries, so
|
|
40
|
+
// a tenant-mismatched scope cannot surface another tenant's row even when
|
|
41
|
+
// both share the same scope string (e.g. 'slack:private:CSHARED').
|
|
42
|
+
let entries;
|
|
43
|
+
if (opts.scope !== undefined && opts.scope !== '') {
|
|
44
|
+
entries = all.filter((e) => e.scope === opts.scope);
|
|
45
|
+
}
|
|
46
|
+
else {
|
|
47
|
+
// Default-deny: a no-scope caller cannot see private slack channels. This
|
|
48
|
+
// is load-bearing because frontend callers will pass `undefined` and must
|
|
49
|
+
// not see `slack:private:*` rows by default.
|
|
50
|
+
entries = all.filter((e) => !(e.scope ?? '').startsWith('slack:private:'));
|
|
51
|
+
}
|
|
52
|
+
// BM25 ordering already comes from loadSearchEntries; cap to `limit`.
|
|
53
|
+
// Score is a placeholder — the physics/hybrid scorers in src/search.ts
|
|
54
|
+
// produce richer breakdowns and will replace this when wired up.
|
|
55
|
+
const ranked = entries.slice(0, limit).map((entry, idx) => ({
|
|
56
|
+
id: entry.id,
|
|
57
|
+
content: entry.content,
|
|
58
|
+
score: Math.max(0, 1 - idx / Math.max(1, limit)),
|
|
59
|
+
layer: entry.layer,
|
|
60
|
+
strength: entry.strength,
|
|
61
|
+
}));
|
|
62
|
+
const tokens = ranked.reduce((acc, r) => acc + Math.ceil(r.content.length / 4), 0);
|
|
63
|
+
// TODO(a1-task-4): emit via the shared audit hook in store.ts so we don't
|
|
64
|
+
// double-emit. Recall does not currently write through writeEntry, so no
|
|
65
|
+
// duplicate exists today, but we keep the same shape for symmetry.
|
|
66
|
+
const db = openHippoDb(ctx.hippoRoot);
|
|
67
|
+
try {
|
|
68
|
+
appendAuditEvent(db, {
|
|
69
|
+
tenantId: ctx.tenantId,
|
|
70
|
+
actor: ctx.actor,
|
|
71
|
+
op: 'recall',
|
|
72
|
+
metadata: { query: opts.query.slice(0, 200), results: ranked.length },
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
finally {
|
|
76
|
+
closeHippoDb(db);
|
|
77
|
+
}
|
|
78
|
+
return { results: ranked, total: entries.length, tokens };
|
|
79
|
+
}
|
|
80
|
+
// ---------------------------------------------------------------------------
|
|
81
|
+
// forget
|
|
82
|
+
// ---------------------------------------------------------------------------
|
|
83
|
+
/**
|
|
84
|
+
* Delete a memory by id. `deleteEntry` threads ctx.actor into its internal
|
|
85
|
+
* audit hook, so exactly one 'forget' event lands with the supplied actor.
|
|
86
|
+
*
|
|
87
|
+
* Tenant scope: deleteEntry looks up the row by id alone, so without an
|
|
88
|
+
* explicit tenant guard a Bearer for tenant A could delete tenant B's row
|
|
89
|
+
* by guessing or leaking the id. Pre-check the row's tenant_id and deny
|
|
90
|
+
* cross-tenant access with a not-found error (no info leak about whether
|
|
91
|
+
* the id exists in another tenant).
|
|
92
|
+
*/
|
|
93
|
+
export function forget(ctx, id) {
|
|
94
|
+
const db = openHippoDb(ctx.hippoRoot);
|
|
95
|
+
try {
|
|
96
|
+
const row = db
|
|
97
|
+
.prepare(`SELECT tenant_id FROM memories WHERE id = ?`)
|
|
98
|
+
.get(id);
|
|
99
|
+
if (!row || row.tenant_id !== ctx.tenantId) {
|
|
100
|
+
throw new Error(`memory not found: ${id}`);
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
finally {
|
|
104
|
+
closeHippoDb(db);
|
|
105
|
+
}
|
|
106
|
+
const removed = deleteEntry(ctx.hippoRoot, id, { actor: ctx.actor });
|
|
107
|
+
if (!removed) {
|
|
108
|
+
throw new Error(`memory not found: ${id}`);
|
|
109
|
+
}
|
|
110
|
+
return { ok: true, id };
|
|
111
|
+
}
|
|
112
|
+
// ---------------------------------------------------------------------------
|
|
113
|
+
// promote
|
|
114
|
+
// ---------------------------------------------------------------------------
|
|
115
|
+
/**
|
|
116
|
+
* Copy a local memory into the global store. Mirrors `cmdPromote` in cli.ts:
|
|
117
|
+
* the `writeEntry` inside `promoteToGlobal` emits a 'remember' on the global
|
|
118
|
+
* db; we add a 'promote' audit event on the global db so the user-facing
|
|
119
|
+
* intent stays distinct from the underlying upsert.
|
|
120
|
+
*
|
|
121
|
+
* Note: `promoteToGlobal` does not currently take a tenantId override — it
|
|
122
|
+
* reads the entry from the local root via `readEntry` (no tenant filter) and
|
|
123
|
+
* preserves the entry's existing tenantId on the global side. Task 4 may
|
|
124
|
+
* tighten this once writeEntry/readEntry thread tenant context.
|
|
125
|
+
*/
|
|
126
|
+
export function promote(ctx, id) {
|
|
127
|
+
// promoteToGlobal threads ctx.actor into the writeEntry call on the global
|
|
128
|
+
// db, which emits a 'remember' audit row. We then add the user-facing
|
|
129
|
+
// 'promote' event on the global db so the audit trail keeps the intent
|
|
130
|
+
// distinct from the underlying upsert.
|
|
131
|
+
const globalEntry = promoteToGlobal(ctx.hippoRoot, id, { actor: ctx.actor });
|
|
132
|
+
const db = openHippoDb(getGlobalRoot());
|
|
133
|
+
try {
|
|
134
|
+
appendAuditEvent(db, {
|
|
135
|
+
tenantId: ctx.tenantId,
|
|
136
|
+
actor: ctx.actor,
|
|
137
|
+
op: 'promote',
|
|
138
|
+
targetId: globalEntry.id,
|
|
139
|
+
metadata: { sourceId: id },
|
|
140
|
+
});
|
|
141
|
+
}
|
|
142
|
+
finally {
|
|
143
|
+
closeHippoDb(db);
|
|
144
|
+
}
|
|
145
|
+
return { ok: true, sourceId: id, globalId: globalEntry.id };
|
|
146
|
+
}
|
|
147
|
+
// ---------------------------------------------------------------------------
|
|
148
|
+
// supersede
|
|
149
|
+
// ---------------------------------------------------------------------------
|
|
150
|
+
/**
|
|
151
|
+
* Replace an old memory with new content, chaining old.superseded_by = new.id.
|
|
152
|
+
* Mirrors `cmdSupersede` in cli.ts (without flag-driven layer/tag/pin overrides
|
|
153
|
+
* — A1 keeps the API minimal; the CLI handler will continue to handle those
|
|
154
|
+
* flags and pass the resolved values once Task 4 lands).
|
|
155
|
+
*/
|
|
156
|
+
export function supersede(ctx, oldId, newContent) {
|
|
157
|
+
const old = readEntry(ctx.hippoRoot, oldId, ctx.tenantId);
|
|
158
|
+
if (!old) {
|
|
159
|
+
throw new Error(`Memory not found: ${oldId}`);
|
|
160
|
+
}
|
|
161
|
+
if (old.superseded_by) {
|
|
162
|
+
throw new Error(`Memory ${oldId} is already superseded by ${old.superseded_by}. Supersede that one instead.`);
|
|
163
|
+
}
|
|
164
|
+
const newEntry = createMemory(newContent, {
|
|
165
|
+
layer: old.layer ?? Layer.Episodic,
|
|
166
|
+
tags: [...old.tags],
|
|
167
|
+
pinned: old.pinned,
|
|
168
|
+
source: old.source,
|
|
169
|
+
confidence: 'verified',
|
|
170
|
+
tenantId: ctx.tenantId,
|
|
171
|
+
});
|
|
172
|
+
old.superseded_by = newEntry.id;
|
|
173
|
+
writeEntry(ctx.hippoRoot, old, { actor: ctx.actor });
|
|
174
|
+
writeEntry(ctx.hippoRoot, newEntry, { actor: ctx.actor });
|
|
175
|
+
// The two writeEntry calls above emit 'remember' audit rows; the 'supersede'
|
|
176
|
+
// event below carries the user-facing intent and the chained newId.
|
|
177
|
+
const db = openHippoDb(ctx.hippoRoot);
|
|
178
|
+
try {
|
|
179
|
+
appendAuditEvent(db, {
|
|
180
|
+
tenantId: ctx.tenantId,
|
|
181
|
+
actor: ctx.actor,
|
|
182
|
+
op: 'supersede',
|
|
183
|
+
targetId: oldId,
|
|
184
|
+
metadata: { newId: newEntry.id },
|
|
185
|
+
});
|
|
186
|
+
}
|
|
187
|
+
finally {
|
|
188
|
+
closeHippoDb(db);
|
|
189
|
+
}
|
|
190
|
+
return { ok: true, oldId, newId: newEntry.id };
|
|
191
|
+
}
|
|
192
|
+
// ---------------------------------------------------------------------------
|
|
193
|
+
// archive_raw
|
|
194
|
+
// ---------------------------------------------------------------------------
|
|
195
|
+
/**
|
|
196
|
+
* Archive a kind='raw' memory: snapshot into raw_archive, mark archived, delete.
|
|
197
|
+
*
|
|
198
|
+
* `archiveRawMemory` audits the operation internally (op='archive_raw') using the
|
|
199
|
+
* row's own tenant_id. We DO NOT emit a second audit event here to avoid double-
|
|
200
|
+
* emitting the archive_raw op (unlike Task 1 remember/forget where the underlying
|
|
201
|
+
* helpers hardcode actor='cli'). Instead we pass `ctx.actor` through as `who`,
|
|
202
|
+
* and raw-archive.ts uses that for the audit row.
|
|
203
|
+
*/
|
|
204
|
+
export function archiveRaw(ctx, id, reason) {
|
|
205
|
+
const db = openHippoDb(ctx.hippoRoot);
|
|
206
|
+
try {
|
|
207
|
+
// Tenant scope: archiveRawMemory looks up the row by id alone, so a
|
|
208
|
+
// Bearer for tenant A could archive tenant B's raw row without this
|
|
209
|
+
// pre-check. Deny cross-tenant access with the same not-found message
|
|
210
|
+
// archiveRawMemory itself would throw on a missing row, so we don't
|
|
211
|
+
// leak whether the id exists in another tenant.
|
|
212
|
+
const row = db
|
|
213
|
+
.prepare(`SELECT tenant_id FROM memories WHERE id = ?`)
|
|
214
|
+
.get(id);
|
|
215
|
+
if (!row || row.tenant_id !== ctx.tenantId) {
|
|
216
|
+
throw new Error(`memory not found: ${id}`);
|
|
217
|
+
}
|
|
218
|
+
archiveRawMemory(db, id, { reason, who: ctx.actor });
|
|
219
|
+
}
|
|
220
|
+
finally {
|
|
221
|
+
closeHippoDb(db);
|
|
222
|
+
}
|
|
223
|
+
// archiveRawMemory deletes the memories row but leaves any legacy markdown
|
|
224
|
+
// mirror in <root>/{buffer,episodic,semantic}/<id>.md untouched. If we left
|
|
225
|
+
// the mirror in place, a subsequent initStore() on an empty memories table
|
|
226
|
+
// would silently re-import the row via bootstrapLegacyStore — defeating the
|
|
227
|
+
// archive (and the GDPR right-to-be-forgotten promise on raw rows). Mirror
|
|
228
|
+
// forget() at src/store.ts:1046, which uses the same removeEntryMirrors call.
|
|
229
|
+
removeEntryMirrors(ctx.hippoRoot, id);
|
|
230
|
+
// archiveRawMemory does not return the archive_at timestamp it wrote. We
|
|
231
|
+
// emit a fresh ISO timestamp here for the API response. Within a millisecond
|
|
232
|
+
// of the actual write, fine for a server response shape.
|
|
233
|
+
return { ok: true, archivedAt: new Date().toISOString() };
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* Mint a new API key. Per A5 v2 follow-ups (TODOS.md), `auth_create` is currently
|
|
237
|
+
* unaudited — we intentionally match that behavior here for consistency. When A5
|
|
238
|
+
* v2 lands and adds the audit op, this function should mirror the cli handler.
|
|
239
|
+
*/
|
|
240
|
+
export function authCreate(ctx, opts) {
|
|
241
|
+
const tenantId = opts.tenantId ?? ctx.tenantId;
|
|
242
|
+
const db = openHippoDb(ctx.hippoRoot);
|
|
243
|
+
try {
|
|
244
|
+
const result = createApiKey(db, { tenantId, label: opts.label });
|
|
245
|
+
return { keyId: result.keyId, plaintext: result.plaintext, tenantId };
|
|
246
|
+
}
|
|
247
|
+
finally {
|
|
248
|
+
closeHippoDb(db);
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
/**
|
|
252
|
+
* List API keys visible to the calling tenant.
|
|
253
|
+
*
|
|
254
|
+
* Divergence from `cmdAuthList` in src/cli.ts: the CLI today returns ALL keys
|
|
255
|
+
* regardless of tenant (single-tenant deployments). The API surface is tenant-
|
|
256
|
+
* scoped because future multi-tenant deployments will share a hippoRoot, and
|
|
257
|
+
* tenant A must not see tenant B's keys. Read-only — no audit emit (matches A5).
|
|
258
|
+
*/
|
|
259
|
+
export function authList(ctx, opts) {
|
|
260
|
+
const db = openHippoDb(ctx.hippoRoot);
|
|
261
|
+
try {
|
|
262
|
+
const all = listApiKeys(db, opts);
|
|
263
|
+
return all.filter((k) => k.tenantId === ctx.tenantId);
|
|
264
|
+
}
|
|
265
|
+
finally {
|
|
266
|
+
closeHippoDb(db);
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
/**
|
|
270
|
+
* Revoke an API key.
|
|
271
|
+
*
|
|
272
|
+
* Security: the key must belong to `ctx.tenantId`. Cross-tenant revoke is
|
|
273
|
+
* rejected with the same "not found" message used for missing keys, so that a
|
|
274
|
+
* caller cannot probe which key_ids exist on other tenants.
|
|
275
|
+
*
|
|
276
|
+
* Audit: emits 'auth_revoke' with `tenantId` set to the KEY ROW's tenant_id
|
|
277
|
+
* (M1 fix from A5 review, mirrors src/cli.ts:cmdAuthRevoke). Skipped on no-op
|
|
278
|
+
* revoke (already revoked) so re-running doesn't pad the audit log.
|
|
279
|
+
*/
|
|
280
|
+
export function authRevoke(ctx, keyId) {
|
|
281
|
+
const db = openHippoDb(ctx.hippoRoot);
|
|
282
|
+
try {
|
|
283
|
+
const row = db
|
|
284
|
+
.prepare(`SELECT key_id, tenant_id, revoked_at FROM api_keys WHERE key_id = ?`)
|
|
285
|
+
.get(keyId);
|
|
286
|
+
if (!row) {
|
|
287
|
+
throw new Error(`Unknown key_id: ${keyId}`);
|
|
288
|
+
}
|
|
289
|
+
// Cross-tenant access denied: same message as missing key, no info leak.
|
|
290
|
+
if (row.tenant_id !== ctx.tenantId) {
|
|
291
|
+
throw new Error(`Unknown key_id: ${keyId}`);
|
|
292
|
+
}
|
|
293
|
+
let revokedAt;
|
|
294
|
+
let alreadyRevoked = false;
|
|
295
|
+
if (row.revoked_at) {
|
|
296
|
+
alreadyRevoked = true;
|
|
297
|
+
revokedAt = row.revoked_at;
|
|
298
|
+
}
|
|
299
|
+
else {
|
|
300
|
+
revokeApiKey(db, keyId);
|
|
301
|
+
const updated = db
|
|
302
|
+
.prepare(`SELECT revoked_at FROM api_keys WHERE key_id = ?`)
|
|
303
|
+
.get(keyId);
|
|
304
|
+
revokedAt = updated?.revoked_at ?? new Date().toISOString();
|
|
305
|
+
}
|
|
306
|
+
if (!alreadyRevoked) {
|
|
307
|
+
try {
|
|
308
|
+
appendAuditEvent(db, {
|
|
309
|
+
tenantId: row.tenant_id, // M1: KEY's tenant, not ctx.tenantId.
|
|
310
|
+
actor: ctx.actor,
|
|
311
|
+
op: 'auth_revoke',
|
|
312
|
+
targetId: keyId,
|
|
313
|
+
});
|
|
314
|
+
}
|
|
315
|
+
catch {
|
|
316
|
+
// Audit must not crash a successful revoke.
|
|
317
|
+
}
|
|
318
|
+
}
|
|
319
|
+
return { ok: true, revokedAt };
|
|
320
|
+
}
|
|
321
|
+
finally {
|
|
322
|
+
closeHippoDb(db);
|
|
323
|
+
}
|
|
324
|
+
}
|
|
325
|
+
/**
|
|
326
|
+
* Read audit events scoped to `ctx.tenantId`. Read-only — no audit emit (matches
|
|
327
|
+
* A5: cmdAuditList does not record a 'recall'-style read event).
|
|
328
|
+
*/
|
|
329
|
+
export function auditList(ctx, opts) {
|
|
330
|
+
const db = openHippoDb(ctx.hippoRoot);
|
|
331
|
+
try {
|
|
332
|
+
return queryAuditEvents(db, {
|
|
333
|
+
tenantId: ctx.tenantId,
|
|
334
|
+
op: opts.op,
|
|
335
|
+
since: opts.since,
|
|
336
|
+
limit: opts.limit,
|
|
337
|
+
});
|
|
338
|
+
}
|
|
339
|
+
finally {
|
|
340
|
+
closeHippoDb(db);
|
|
341
|
+
}
|
|
342
|
+
}
|
|
343
|
+
//# sourceMappingURL=api.js.map
|
package/dist/api.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,WAAW,EAAE,YAAY,EAAyB,MAAM,SAAS,CAAC;AAC3E,OAAO,EACL,UAAU,EACV,SAAS,EACT,WAAW,EACX,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,YAAY,EAGZ,KAAK,GACN,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,gBAAgB,EAChB,gBAAgB,GAGjB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EACL,YAAY,EACZ,WAAW,EACX,YAAY,GAEb,MAAM,WAAW,CAAC;AAiCnB,MAAM,UAAU,QAAQ,CAAC,GAAY,EAAE,IAAkB;IACvD,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE;QACvC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,WAAW;QAC9B,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI;QACzB,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI;QACzB,YAAY,EAAE,IAAI,CAAC,WAAW,IAAI,IAAI;QACtC,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,QAAQ,EAAE,GAAG,CAAC,QAAQ;KACvB,CAAC,CAAC;IACH,wEAAwE;IACxE,iEAAiE;IACjE,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IAEpF,OAAO,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC;AACpE,CAAC;AAoCD;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CAAC,GAAY,EAAE,IAAgB;IACnD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;IAC/B,MAAM,GAAG,GAAG,iBAAiB,CAC3B,GAAG,CAAC,SAAS,EACb,IAAI,CAAC,KAAK,EACV,SAAS,EACT,GAAG,CAAC,QAAQ,CACb,CAAC;IACF,4EAA4E;IAC5E,0EAA0E;IAC1E,mEAAmE;IACnE,IAAI,OAAmB,CAAC;IACxB,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,EAAE,EAAE,CAAC;QAClD,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC;IACtD,CAAC;SAAM,CAAC;QACN,0EAA0E;QAC1E,0EAA0E;QAC1E,6CAA6C;QAC7C,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC7E,CAAC;IACD,sEAAsE;IACtE,uEAAuE;IACvE,iEAAiE;IACjE,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QAC1D,EAAE,EAAE,KAAK,CAAC,EAAE;QACZ,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAChD,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,QAAQ,EAAE,KAAK,CAAC,QAAQ;KACzB,CAAC,CAAC,CAAC;IACJ,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAEnF,0EAA0E;IAC1E,yEAAyE;IACzE,mEAAmE;IACnE,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACtC,IAAI,CAAC;QACH,gBAAgB,CAAC,EAAE,EAAE;YACnB,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,EAAE,EAAE,QAAQ;YACZ,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE;SACtE,CAAC,CAAC;IACL,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;AAC5D,CAAC;AAED,8EAA8E;AAC9E,SAAS;AACT,8EAA8E;AAE9E;;;;;;;;;GASG;AACH,MAAM,UAAU,MAAM,CAAC,GAAY,EAAE,EAAU;IAC7C,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACtC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,EAAE;aACX,OAAO,CAAC,6CAA6C,CAAC;aACtD,GAAG,CAAC,EAAE,CAAuC,CAAC;QACjD,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,QAAQ,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC;IACD,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;IACrE,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;AAC1B,CAAC;AAED,8EAA8E;AAC9E,UAAU;AACV,8EAA8E;AAE9E;;;;;;;;;;GAUG;AACH,MAAM,UAAU,OAAO,CACrB,GAAY,EACZ,EAAU;IAEV,2EAA2E;IAC3E,sEAAsE;IACtE,uEAAuE;IACvE,uCAAuC;IACvC,MAAM,WAAW,GAAG,eAAe,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;IAE7E,MAAM,EAAE,GAAG,WAAW,CAAC,aAAa,EAAE,CAAC,CAAC;IACxC,IAAI,CAAC;QACH,gBAAgB,CAAC,EAAE,EAAE;YACnB,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,EAAE,EAAE,SAAS;YACb,QAAQ,EAAE,WAAW,CAAC,EAAE;YACxB,QAAQ,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC3B,CAAC,CAAC;IACL,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC;AAC9D,CAAC;AAED,8EAA8E;AAC9E,YAAY;AACZ,8EAA8E;AAE9E;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CACvB,GAAY,EACZ,KAAa,EACb,UAAkB;IAElB,MAAM,GAAG,GAAuB,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9E,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,qBAAqB,KAAK,EAAE,CAAC,CAAC;IAChD,CAAC;IACD,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CACb,UAAU,KAAK,6BAA6B,GAAG,CAAC,aAAa,+BAA+B,CAC7F,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,YAAY,CAAC,UAAU,EAAE;QACxC,KAAK,EAAE,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ;QAClC,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC;QACnB,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,UAAU,EAAE,UAAU;QACtB,QAAQ,EAAE,GAAG,CAAC,QAAQ;KACvB,CAAC,CAAC;IACH,GAAG,CAAC,aAAa,GAAG,QAAQ,CAAC,EAAE,CAAC;IAChC,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;IACrD,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;IAE1D,6EAA6E;IAC7E,oEAAoE;IACpE,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACtC,IAAI,CAAC;QACH,gBAAgB,CAAC,EAAE,EAAE;YACnB,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,EAAE,EAAE,WAAW;YACf,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;SACjC,CAAC,CAAC;IACL,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC;AACjD,CAAC;AAED,8EAA8E;AAC9E,cAAc;AACd,8EAA8E;AAE9E;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CACxB,GAAY,EACZ,EAAU,EACV,MAAc;IAEd,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACtC,IAAI,CAAC;QACH,oEAAoE;QACpE,oEAAoE;QACpE,sEAAsE;QACtE,oEAAoE;QACpE,gDAAgD;QAChD,MAAM,GAAG,GAAG,EAAE;aACX,OAAO,CAAC,6CAA6C,CAAC;aACtD,GAAG,CAAC,EAAE,CAAuC,CAAC;QACjD,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,QAAQ,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;QAC7C,CAAC;QACD,gBAAgB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;IACvD,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC;IACD,2EAA2E;IAC3E,4EAA4E;IAC5E,2EAA2E;IAC3E,4EAA4E;IAC5E,2EAA2E;IAC3E,8EAA8E;IAC9E,kBAAkB,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IACtC,yEAAyE;IACzE,6EAA6E;IAC7E,yDAAyD;IACzD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;AAC5D,CAAC;AAkBD;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,GAAY,EAAE,IAAoB;IAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC;IAC/C,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACtC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,YAAY,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QACjE,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAC;IACxE,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CACtB,GAAY,EACZ,IAAyB;IAEzB,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACtC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAClC,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,GAAG,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CACxB,GAAY,EACZ,KAAa;IAEb,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACtC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,EAAE;aACX,OAAO,CAAC,qEAAqE,CAAC;aAC9E,GAAG,CAAC,KAAK,CAEC,CAAC;QACd,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,KAAK,CAAC,mBAAmB,KAAK,EAAE,CAAC,CAAC;QAC9C,CAAC;QACD,yEAAyE;QACzE,IAAI,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,QAAQ,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,mBAAmB,KAAK,EAAE,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,SAAiB,CAAC;QACtB,IAAI,cAAc,GAAG,KAAK,CAAC;QAC3B,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;YACnB,cAAc,GAAG,IAAI,CAAC;YACtB,SAAS,GAAG,GAAG,CAAC,UAAU,CAAC;QAC7B,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;YACxB,MAAM,OAAO,GAAG,EAAE;iBACf,OAAO,CAAC,kDAAkD,CAAC;iBAC3D,GAAG,CAAC,KAAK,CAA8C,CAAC;YAC3D,SAAS,GAAG,OAAO,EAAE,UAAU,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC9D,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,IAAI,CAAC;gBACH,gBAAgB,CAAC,EAAE,EAAE;oBACnB,QAAQ,EAAE,GAAG,CAAC,SAAS,EAAE,sCAAsC;oBAC/D,KAAK,EAAE,GAAG,CAAC,KAAK;oBAChB,EAAE,EAAE,aAAa;oBACjB,QAAQ,EAAE,KAAK;iBAChB,CAAC,CAAC;YACL,CAAC;YAAC,MAAM,CAAC;gBACP,4CAA4C;YAC9C,CAAC;QACH,CAAC;QAED,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IACjC,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC;AACH,CAAC;AAaD;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,GAAY,EAAE,IAAmB;IACzD,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACtC,IAAI,CAAC;QACH,OAAO,gBAAgB,CAAC,EAAE,EAAE;YAC1B,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC,CAAC;IACL,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* E1.3 incident-recall eval (Task 17).
|
|
3
|
+
*
|
|
4
|
+
* ROADMAP success criterion: recall surfaces incident context faster than
|
|
5
|
+
* transcript replay on at least 7 of 10 staged scenarios.
|
|
6
|
+
*
|
|
7
|
+
* Approach (review patch #8): stamp a per-message sentinel
|
|
8
|
+
* `[s:<scenario.id>:<m.ts>]` into the ingested text. Sentinels are unique
|
|
9
|
+
* across the corpus, so checking sentinel substring presence in
|
|
10
|
+
* `RecallResultItem.content` is a deterministic equality test — no false
|
|
11
|
+
* positives from ambient phrase repetition, no need to extend the recall
|
|
12
|
+
* response shape with artifact_ref.
|
|
13
|
+
*
|
|
14
|
+
* Baseline: take the last 10 messages of the raw transcript (the
|
|
15
|
+
* "transcript replay" a human would do by scrolling to the bottom). Answers
|
|
16
|
+
* are buried mid-transcript so the baseline misses them. Recall must beat
|
|
17
|
+
* that on >=7/10 scenarios.
|
|
18
|
+
*/
|
|
19
|
+
import { readFileSync } from 'fs';
|
|
20
|
+
import { join, dirname } from 'path';
|
|
21
|
+
import { fileURLToPath } from 'url';
|
|
22
|
+
import { ingestMessage } from '../../src/connectors/slack/ingest.js';
|
|
23
|
+
import { recall } from '../../src/api.js';
|
|
24
|
+
export async function runIncidentRecallEval(opts) {
|
|
25
|
+
const here = dirname(fileURLToPath(import.meta.url));
|
|
26
|
+
const scenarios = JSON.parse(readFileSync(join(here, 'scenarios.json'), 'utf-8'));
|
|
27
|
+
const ctx = {
|
|
28
|
+
hippoRoot: opts.hippoRoot,
|
|
29
|
+
tenantId: 'default',
|
|
30
|
+
actor: 'eval:slack',
|
|
31
|
+
};
|
|
32
|
+
const results = [];
|
|
33
|
+
for (const sc of scenarios) {
|
|
34
|
+
const sentinel = (m) => `[s:${sc.id}:${m.ts}]`;
|
|
35
|
+
for (const m of sc.transcript) {
|
|
36
|
+
ingestMessage(ctx, {
|
|
37
|
+
teamId: 'T1',
|
|
38
|
+
channel: { id: sc.channel, is_private: false },
|
|
39
|
+
message: {
|
|
40
|
+
type: 'message',
|
|
41
|
+
channel: sc.channel,
|
|
42
|
+
user: m.user,
|
|
43
|
+
text: `${m.text} ${sentinel(m)}`,
|
|
44
|
+
ts: m.ts,
|
|
45
|
+
},
|
|
46
|
+
eventId: `${sc.id}:${m.ts}`,
|
|
47
|
+
});
|
|
48
|
+
}
|
|
49
|
+
const r = recall(ctx, {
|
|
50
|
+
query: sc.query,
|
|
51
|
+
limit: 10,
|
|
52
|
+
scope: `slack:public:${sc.channel}`,
|
|
53
|
+
});
|
|
54
|
+
const recallHit = sc.answer_ts.filter((ts) => r.results.some((res) => res.content.includes(sentinel({ ts })))).length;
|
|
55
|
+
const recallPrecision = recallHit / sc.answer_ts.length;
|
|
56
|
+
// Baseline: linear transcript scan returning the last 10 messages — what a
|
|
57
|
+
// human does when they scroll to the bottom of a Slack channel. Direct
|
|
58
|
+
// ts equality is enough; sentinels are not in the raw transcript.
|
|
59
|
+
const tail = sc.transcript.slice(-10);
|
|
60
|
+
const baselineHit = sc.answer_ts.filter((ts) => tail.some((m) => m.ts === ts)).length;
|
|
61
|
+
const baselinePrecision = baselineHit / sc.answer_ts.length;
|
|
62
|
+
results.push({
|
|
63
|
+
id: sc.id,
|
|
64
|
+
recallPrecision,
|
|
65
|
+
baselinePrecision,
|
|
66
|
+
beat: recallPrecision > baselinePrecision,
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
return {
|
|
70
|
+
scenarios: results,
|
|
71
|
+
scenariosBeaten: results.filter((r) => r.beat).length,
|
|
72
|
+
};
|
|
73
|
+
}
|
|
74
|
+
//# sourceMappingURL=incident-recall-eval.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"incident-recall-eval.js","sourceRoot":"","sources":["../../../benchmarks/e1.3/incident-recall-eval.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,MAAM,EAAgB,MAAM,kBAAkB,CAAC;AA4BxD,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,IAE3C;IACC,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACrD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAC1B,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC,EAAE,OAAO,CAAC,CACtC,CAAC;IAChB,MAAM,GAAG,GAAY;QACnB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,QAAQ,EAAE,SAAS;QACnB,KAAK,EAAE,YAAY;KACpB,CAAC;IACF,MAAM,OAAO,GAAqB,EAAE,CAAC;IAErC,KAAK,MAAM,EAAE,IAAI,SAAS,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAG,CAAC,CAAiB,EAAU,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC;QAEvE,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC;YAC9B,aAAa,CAAC,GAAG,EAAE;gBACjB,MAAM,EAAE,IAAI;gBACZ,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE;gBAC9C,OAAO,EAAE;oBACP,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,EAAE,CAAC,OAAO;oBACnB,IAAI,EAAE,CAAC,CAAC,IAAI;oBACZ,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE;oBAChC,EAAE,EAAE,CAAC,CAAC,EAAE;iBACT;gBACD,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,EAAE;aAC5B,CAAC,CAAC;QACL,CAAC;QAED,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,EAAE;YACpB,KAAK,EAAE,EAAE,CAAC,KAAK;YACf,KAAK,EAAE,EAAE;YACT,KAAK,EAAE,gBAAgB,EAAE,CAAC,OAAO,EAAE;SACpC,CAAC,CAAC;QACH,MAAM,SAAS,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAC3C,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAChE,CAAC,MAAM,CAAC;QACT,MAAM,eAAe,GAAG,SAAS,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC;QAExD,2EAA2E;QAC3E,uEAAuE;QACvE,kEAAkE;QAClE,MAAM,IAAI,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;QACtC,MAAM,WAAW,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAC7C,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAC9B,CAAC,MAAM,CAAC;QACT,MAAM,iBAAiB,GAAG,WAAW,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC;QAE5D,OAAO,CAAC,IAAI,CAAC;YACX,EAAE,EAAE,EAAE,CAAC,EAAE;YACT,eAAe;YACf,iBAAiB;YACjB,IAAI,EAAE,eAAe,GAAG,iBAAiB;SAC1C,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,SAAS,EAAE,OAAO;QAClB,eAAe,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM;KACtD,CAAC;AACJ,CAAC"}
|