@ottimis/jack-provider-sdk 0.4.0 → 0.9.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 +2 -2
- package/dist/cjs/host.js +38 -0
- package/dist/cjs/host.js.map +1 -0
- package/dist/cjs/index.js +10 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/profiles.js +29 -0
- package/dist/cjs/profiles.js.map +1 -0
- package/dist/cjs/sandbox.js +34 -0
- package/dist/cjs/sandbox.js.map +1 -0
- package/dist/host.d.ts +161 -0
- package/dist/host.d.ts.map +1 -0
- package/dist/host.js +37 -0
- package/dist/host.js.map +1 -0
- package/dist/index.d.ts +10 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +10 -1
- package/dist/index.js.map +1 -1
- package/dist/profiles.d.ts +130 -0
- package/dist/profiles.d.ts.map +1 -0
- package/dist/profiles.js +28 -0
- package/dist/profiles.js.map +1 -0
- package/dist/provider.d.ts +81 -0
- package/dist/provider.d.ts.map +1 -1
- package/dist/sandbox.d.ts +104 -0
- package/dist/sandbox.d.ts.map +1 -0
- package/dist/sandbox.js +33 -0
- package/dist/sandbox.js.map +1 -0
- package/dist/usage.d.ts +38 -10
- package/dist/usage.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/host.ts +159 -0
- package/src/index.ts +10 -1
- package/src/profiles.ts +142 -0
- package/src/provider.ts +81 -0
- package/src/sandbox.ts +108 -0
- package/src/usage.ts +38 -10
package/dist/provider.d.ts
CHANGED
|
@@ -16,6 +16,9 @@
|
|
|
16
16
|
* it free of provider-specific imports.
|
|
17
17
|
*/
|
|
18
18
|
import type { AgentBackend, AgentPermissionMode, AgentQueryOptions, McpServerSpec } from './backend';
|
|
19
|
+
import type { HostServices } from './host';
|
|
20
|
+
import type { ProfilesApi } from './profiles';
|
|
21
|
+
import type { SandboxApi } from './sandbox';
|
|
19
22
|
import type { UsageApi } from './usage';
|
|
20
23
|
import type { ZodType } from 'zod';
|
|
21
24
|
import type { ClientToolHandler, NormalizedMessage, NormalizedToolRef, ProviderUserContentPolicy, ToolShape } from '@ottimis/jack-chat-core';
|
|
@@ -257,6 +260,28 @@ export type CapabilityMatrix = {
|
|
|
257
260
|
* usage bars and no Connect affordance is offered.
|
|
258
261
|
*/
|
|
259
262
|
usage: boolean;
|
|
263
|
+
/**
|
|
264
|
+
* Provider supports multiple isolated config/identity directories
|
|
265
|
+
* ("profiles") — distinct accounts, login states, agent customizations,
|
|
266
|
+
* and history sets all selectable per-session at runtime. When `true`,
|
|
267
|
+
* {@link JackProvider.profiles} MUST be defined; the host renders the
|
|
268
|
+
* profile picker UI and routes spawn-time `applyProfile` calls.
|
|
269
|
+
*
|
|
270
|
+
* When `false` the provider's runtime always uses its implicit default
|
|
271
|
+
* config dir; the host hides every profile-related affordance.
|
|
272
|
+
*/
|
|
273
|
+
profiles: boolean;
|
|
274
|
+
/**
|
|
275
|
+
* Provider can run inside Jack's Docker sandbox. When `true`,
|
|
276
|
+
* {@link JackProvider.sandbox} MUST be defined; the host enables the
|
|
277
|
+
* sandbox toggle in the new-session dialog and renders an entry for this
|
|
278
|
+
* provider in `Settings → Sandbox`.
|
|
279
|
+
*
|
|
280
|
+
* When `false` (or omitted), sandbox mode is unavailable for this
|
|
281
|
+
* provider — the toggle is hidden / disabled in the UI, and a spawn-time
|
|
282
|
+
* sandbox request returns a clear error.
|
|
283
|
+
*/
|
|
284
|
+
sandbox: boolean;
|
|
260
285
|
/**
|
|
261
286
|
* Permission modes the provider actually supports. Drives the
|
|
262
287
|
* Shift-Tab cycle in the renderer (`MessageInputBar`) and any
|
|
@@ -275,6 +300,23 @@ export type CapabilityMatrix = {
|
|
|
275
300
|
* or settings); the catalog only governs UI affordances.
|
|
276
301
|
*/
|
|
277
302
|
permissionModes: readonly AgentPermissionMode[];
|
|
303
|
+
/**
|
|
304
|
+
* Suggested prompt-cache TTL in milliseconds — how long the provider's
|
|
305
|
+
* server-side prompt cache stays warm between user turns before a new
|
|
306
|
+
* cache-write is required. Optional: providers without prompt caching
|
|
307
|
+
* (or without a documented TTL) leave it undefined and the host hides
|
|
308
|
+
* the cache-countdown chip entirely for sessions on that provider.
|
|
309
|
+
*
|
|
310
|
+
* This is only the **suggested default**: the user can override per
|
|
311
|
+
* provider in `Settings → Prompt cache` and disable the chip outright.
|
|
312
|
+
* The host treats this as a UI-only countdown hint — never as a
|
|
313
|
+
* contract for actual cache eviction (the provider is the source of
|
|
314
|
+
* truth at request time).
|
|
315
|
+
*
|
|
316
|
+
* Claude declares 300_000 (5 min) per its prompt-caching docs. Codex
|
|
317
|
+
* and Gemini leave it undefined.
|
|
318
|
+
*/
|
|
319
|
+
cacheTtlMs?: number;
|
|
278
320
|
};
|
|
279
321
|
/**
|
|
280
322
|
* Re-exports of canonical wire-shape types from chat-core so consumers of
|
|
@@ -622,6 +664,45 @@ export type JackProvider = {
|
|
|
622
664
|
* decodes.
|
|
623
665
|
*/
|
|
624
666
|
usage?: UsageApi;
|
|
667
|
+
/**
|
|
668
|
+
* Multi-profile capability — multiple isolated config/identity dirs
|
|
669
|
+
* selectable per session. See {@link ProfilesApi}. Optional; when
|
|
670
|
+
* undefined `capabilities.profiles` MUST be `false` and the host hides
|
|
671
|
+
* every profile-related affordance. When defined, the host calls
|
|
672
|
+
* `applyProfile(options, profileId)` once per spawn so the provider can
|
|
673
|
+
* inject its native config-dir env var (Claude `CLAUDE_CONFIG_DIR`,
|
|
674
|
+
* Codex `CODEX_HOME`, …).
|
|
675
|
+
*/
|
|
676
|
+
profiles?: ProfilesApi;
|
|
677
|
+
/**
|
|
678
|
+
* Docker sandbox capability — provider declares the image, binary name,
|
|
679
|
+
* and config-dir mount the host needs to spawn a sandboxed session for
|
|
680
|
+
* this provider. See {@link SandboxApi}. Optional; when undefined
|
|
681
|
+
* `capabilities.sandbox` MUST be `false` and the host disables sandbox
|
|
682
|
+
* mode for this provider's sessions.
|
|
683
|
+
*/
|
|
684
|
+
sandbox?: SandboxApi;
|
|
685
|
+
/**
|
|
686
|
+
* Optional one-shot activation hook. Called once by the host during
|
|
687
|
+
* registration with a {@link HostServices} bag scoped to this
|
|
688
|
+
* provider's id (kv namespace, auth partition prefix). Providers that
|
|
689
|
+
* need host-side primitives (encrypted credential storage, child auth
|
|
690
|
+
* windows, …) store the `host` reference and use it lazily; providers
|
|
691
|
+
* that are pure (Codex, Gemini today) leave this undefined.
|
|
692
|
+
*
|
|
693
|
+
* Activation MUST be idempotent: calling `activate(host)` twice with
|
|
694
|
+
* the same host is allowed and should not duplicate state. Activation
|
|
695
|
+
* happens at registration time — well before any session spawns —
|
|
696
|
+
* but providers MUST NOT block on network or disk here. Defer all I/O
|
|
697
|
+
* to the methods that actually need it.
|
|
698
|
+
*
|
|
699
|
+
* The host calls `activate` synchronously enough that
|
|
700
|
+
* `provider.usage`, `provider.persistedPermissions`, etc. can read
|
|
701
|
+
* `host` from a closure / captured variable in subsequent invocations.
|
|
702
|
+
* Async work inside `activate` is OK but the host won't await it
|
|
703
|
+
* before exposing the provider — it's "fire and let it complete".
|
|
704
|
+
*/
|
|
705
|
+
activate?(host: HostServices): void | Promise<void>;
|
|
625
706
|
};
|
|
626
707
|
/**
|
|
627
708
|
* Provider-neutral spec for an in-process MCP server the host wants to
|
package/dist/provider.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACpG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AACvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,KAAK,CAAA;AAClC,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,yBAAyB,EACzB,SAAS,EACV,MAAM,yBAAyB,CAAA;AAEhC,MAAM,MAAM,UAAU,GAAG,MAAM,CAAA;AAE/B;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAEvF;;;GAGG;AACH,KAAK,mBAAmB,GAAG;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,eAAe,GACvB,CAAC,mBAAmB,GAAG;IAAE,KAAK,EAAE,SAAS,CAAA;CAAE,CAAC,GAC5C,CAAC,mBAAmB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,GACzC,CAAC,mBAAmB,GAAG;IAAE,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAAA;AAEzF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,yDAAyD;IACzD,QAAQ,EAAE,eAAe,EAAE,CAAA;IAC3B;;;;OAIG;IACH,YAAY,CAAC,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAC/D;;;;;OAKG;IACH,aAAa,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,mBAAmB,GAAG,IAAI,CAAA;IACxD;;;;;OAKG;IACH,eAAe,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;IACvC;;;;;OAKG;IACH,UAAU,CAAC,CAAC,GAAG,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;IAC1D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,uBAAuB,CAAC,CACtB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,CAAC,QAAQ,EAAE,eAAe,EAAE,KAAK,IAAI,GAC9C,MAAM,IAAI,CAAA;CACd,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,uGAAuG;IACvG,iBAAiB,EAAE,MAAM,CAAA;IACzB,kFAAkF;IAClF,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,4EAA4E;IAC5E,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,uEAAuE;IACvE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,CAAC,EAAE,yBAAyB,CAAA;CACxC,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,kEAAkE;IAClE,eAAe,EAAE,OAAO,CAAA;IACxB,yCAAyC;IACzC,KAAK,EAAE;QACL,UAAU,EAAE,OAAO,CAAA;QACnB,WAAW,EAAE,OAAO,CAAA;KACrB,CAAA;IACD,0DAA0D;IAC1D,QAAQ,EAAE,OAAO,CAAA;IACjB,4DAA4D;IAC5D,eAAe,EAAE,OAAO,CAAA;IACxB,2FAA2F;IAC3F,SAAS,EAAE,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAA;IACzC,mDAAmD;IACnD,GAAG,EAAE,OAAO,CAAA;IACZ,wEAAwE;IACxE,eAAe,EAAE,OAAO,CAAA;IACxB,+EAA+E;IAC/E,aAAa,EAAE,OAAO,CAAA;IACtB,8EAA8E;IAC9E,eAAe,EAAE,OAAO,CAAA;IACxB;;;;;;OAMG;IACH,gBAAgB,EAAE,OAAO,CAAA;IACzB,mDAAmD;IACnD,wBAAwB,EAAE,OAAO,CAAA;IACjC;;;;;;;;;;;;OAYG;IACH,qBAAqB,EAAE,UAAU,GAAG,cAAc,CAAA;IAClD;;;;;OAKG;IACH,KAAK,EAAE,OAAO,CAAA;IACd;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,EAAE,SAAS,mBAAmB,EAAE,CAAA;
|
|
1
|
+
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACpG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAC3C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AACvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,KAAK,CAAA;AAClC,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,yBAAyB,EACzB,SAAS,EACV,MAAM,yBAAyB,CAAA;AAEhC,MAAM,MAAM,UAAU,GAAG,MAAM,CAAA;AAE/B;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAEvF;;;GAGG;AACH,KAAK,mBAAmB,GAAG;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,eAAe,GACvB,CAAC,mBAAmB,GAAG;IAAE,KAAK,EAAE,SAAS,CAAA;CAAE,CAAC,GAC5C,CAAC,mBAAmB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,GACzC,CAAC,mBAAmB,GAAG;IAAE,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAAA;AAEzF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,yDAAyD;IACzD,QAAQ,EAAE,eAAe,EAAE,CAAA;IAC3B;;;;OAIG;IACH,YAAY,CAAC,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAC/D;;;;;OAKG;IACH,aAAa,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,mBAAmB,GAAG,IAAI,CAAA;IACxD;;;;;OAKG;IACH,eAAe,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;IACvC;;;;;OAKG;IACH,UAAU,CAAC,CAAC,GAAG,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;IAC1D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,uBAAuB,CAAC,CACtB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,CAAC,QAAQ,EAAE,eAAe,EAAE,KAAK,IAAI,GAC9C,MAAM,IAAI,CAAA;CACd,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,uGAAuG;IACvG,iBAAiB,EAAE,MAAM,CAAA;IACzB,kFAAkF;IAClF,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,4EAA4E;IAC5E,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,uEAAuE;IACvE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,CAAC,EAAE,yBAAyB,CAAA;CACxC,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,kEAAkE;IAClE,eAAe,EAAE,OAAO,CAAA;IACxB,yCAAyC;IACzC,KAAK,EAAE;QACL,UAAU,EAAE,OAAO,CAAA;QACnB,WAAW,EAAE,OAAO,CAAA;KACrB,CAAA;IACD,0DAA0D;IAC1D,QAAQ,EAAE,OAAO,CAAA;IACjB,4DAA4D;IAC5D,eAAe,EAAE,OAAO,CAAA;IACxB,2FAA2F;IAC3F,SAAS,EAAE,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAA;IACzC,mDAAmD;IACnD,GAAG,EAAE,OAAO,CAAA;IACZ,wEAAwE;IACxE,eAAe,EAAE,OAAO,CAAA;IACxB,+EAA+E;IAC/E,aAAa,EAAE,OAAO,CAAA;IACtB,8EAA8E;IAC9E,eAAe,EAAE,OAAO,CAAA;IACxB;;;;;;OAMG;IACH,gBAAgB,EAAE,OAAO,CAAA;IACzB,mDAAmD;IACnD,wBAAwB,EAAE,OAAO,CAAA;IACjC;;;;;;;;;;;;OAYG;IACH,qBAAqB,EAAE,UAAU,GAAG,cAAc,CAAA;IAClD;;;;;OAKG;IACH,KAAK,EAAE,OAAO,CAAA;IACd;;;;;;;;;OASG;IACH,QAAQ,EAAE,OAAO,CAAA;IACjB;;;;;;;;;OASG;IACH,OAAO,EAAE,OAAO,CAAA;IAChB;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,EAAE,SAAS,mBAAmB,EAAE,CAAA;IAC/C;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;;;GAIG;AACH,YAAY,EAAE,SAAS,EAAE,CAAA;AACzB,YAAY,EACV,iBAAiB,EACjB,wBAAwB,EACxB,eAAe,EACf,qBAAqB,EACrB,kBAAkB,EAClB,YAAY,EACZ,cAAc,EACd,cAAc,EACd,cAAc,EACd,cAAc,EACf,MAAM,yBAAyB,CAAA;AAEhC,MAAM,MAAM,cAAc,GAAG;IAC3B,8EAA8E;IAC9E,gBAAgB,EAAE,MAAM,CAAA;IACxB,oDAAoD;IACpD,KAAK,EAAE,SAAS,CAAA;IAChB;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;CACjC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,oBAAoB,GAC5B;IACE,SAAS,EAAE,IAAI,CAAA;IACf,uFAAuF;IACvF,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,sFAAsF;IACtF,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,0GAA0G;IAC1G,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,2EAA2E;IAC3E,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,GACD;IACE,SAAS,EAAE,KAAK,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,mEAAmE;IACnE,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAEL;;;;;;;GAOG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,YAAY,CAAA;IAC3B;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAA;CACzC,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,2DAA2D;IAC3D,UAAU,EAAE,OAAO,CAAA;CACpB,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAA;AAElD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAC1B,wEAAwE;IACxE,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAA;CACnD,CAAA;AAED;;;;;;;;;;GAUG;AACH;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GACvB,UAAU,GACV,KAAK,GACL,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,MAAM,GACN,KAAK,GACL,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAEjB,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;;;;;;OAQG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,eAAe,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,UAAU,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb;;;;OAIG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAA;IAC3B;;;OAGG;IACH,MAAM,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAA;IACvC,QAAQ,EAAE,iBAAiB,EAAE,CAAA;IAC7B,2EAA2E;IAC3E,gBAAgB,EAAE,MAAM,CAAA;IACxB,YAAY,EAAE,gBAAgB,CAAA;IAC9B;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAA;IAC3B;;;;OAIG;IACH,aAAa,EAAE,qBAAqB,CAAA;IACpC;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,SAAS,mBAAmB,EAAE,CAAA;IAC7C;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAChC;;;;;OAKG;IACH,WAAW,EAAE,cAAc,EAAE,CAAA;IAC7B;;;;;;;;OAQG;IACH,mBAAmB,CAAC,CAAC,OAAO,EAAE,iBAAiB,EAAE,GAAG,EAAE,mBAAmB,GAAG,IAAI,CAAA;IAChF;;;;;;;OAOG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,iBAAiB,CAAA;IACjD;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,CAAC,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAClF;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAA;IACvF;;;;;;;;;;;;;;;;OAgBG;IACH,wBAAwB,CAAC,CACvB,OAAO,EAAE,iBAAiB,EAC1B,IAAI,EAAE,sBAAsB,GAC3B,IAAI,CAAA;IACP;;;;;;;;;OASG;IACH,uBAAuB,CAAC,CACtB,OAAO,EAAE,iBAAiB,EAC1B,GAAG,EAAE,8BAA8B,GAClC,IAAI,CAAA;IACP;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,uBAAuB,CAAA;IAC9C;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAA;IAChB;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAA;IACtB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,UAAU,CAAA;IACpB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACpD,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,oBAAoB,EAAE,CAAA;CAC9B,CAAA;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAA;AAEzD;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,WAAW,GAAG,SAAS,GAAG,cAAc,CAAA;AAEhF;;;;;;;GAOG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,6EAA6E;IAC7E,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,uFAAuF;IACvF,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,yFAAyF;IACzF,GAAG,EAAE,MAAM,CAAA;IACX,uDAAuD;IACvD,aAAa,CAAC,EAAE,2BAA2B,CAAA;CAC5C,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,gBAAgB,CAAA;IACxB,oFAAoF;IACpF,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iDAAiD;IACjD,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,cAAc,EAAE,CAAA;IACvB,IAAI,EAAE,cAAc,EAAE,CAAA;IACtB,GAAG,EAAE,cAAc,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,sBAAsB,CAAA;IAC5B,SAAS,EAAE,sBAAsB,CAAA;IACjC,OAAO,EAAE,sBAAsB,CAAA;IAC/B,YAAY,EAAE,sBAAsB,CAAA;CACrC,CAAA;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,mBAAmB,CAAA;IAC/C,MAAM,CACJ,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAAA;IACV,GAAG,CACD,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAAA;CACX,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB;;;;;;;;;;OAUG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC/B,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC;QAClD,OAAO,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;QAC9C,OAAO,CAAC,EAAE,OAAO,CAAA;KAClB,CAAC,CAAA;CACH,CAAA"}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SandboxApi — provider-declared Docker sandbox capability.
|
|
3
|
+
*
|
|
4
|
+
* Jack runs sessions in a Docker container ("sandbox mode") to isolate the
|
|
5
|
+
* provider's CLI from the host filesystem and network. The container itself
|
|
6
|
+
* is generic — Jack owns the Docker orchestration, security policy (CapDrop,
|
|
7
|
+
* memory cap, non-privileged), project mount, and user-defined shared
|
|
8
|
+
* volumes. The PROVIDER-SPECIFIC bits live here:
|
|
9
|
+
*
|
|
10
|
+
* - which image to pull (each provider needs its own CLI installed)
|
|
11
|
+
* - which binary name to invoke inside the container (used by the host to
|
|
12
|
+
* rewrite host-resolved absolute paths like
|
|
13
|
+
* `/Users/foo/.local/bin/claude` to a bare command the container's
|
|
14
|
+
* PATH resolves)
|
|
15
|
+
* - which config dir to mount (`~/.claude`, `~/.codex`, `~/.gemini`, …)
|
|
16
|
+
* - optional env extras
|
|
17
|
+
*
|
|
18
|
+
* A provider declaring `sandbox` opts itself into sandbox mode. The
|
|
19
|
+
* matching capability flag {@link CapabilityMatrix.sandbox} MUST be `true`
|
|
20
|
+
* — the host derives it from `provider.sandbox != null` at registration.
|
|
21
|
+
*
|
|
22
|
+
* Providers that don't declare `sandbox` (or set it to `undefined`) are
|
|
23
|
+
* treated as sandbox-incompatible: the host hides the toggle in the UI and
|
|
24
|
+
* blocks spawn-time requests with a clear error.
|
|
25
|
+
*
|
|
26
|
+
* The host's distribution model expects images at
|
|
27
|
+
* `ghcr.io/ottimis/jack-sandbox-<provider-id>:<X.Y.Z>` (monorepo
|
|
28
|
+
* `github.com/ottimis/JACK-sandbox`). Providers can point `defaultImage`
|
|
29
|
+
* elsewhere — third-party plugin authors who maintain their own image are
|
|
30
|
+
* free to host wherever they like.
|
|
31
|
+
*/
|
|
32
|
+
/**
|
|
33
|
+
* Mount the provider's host-side config directory into the container.
|
|
34
|
+
* Most providers persist auth + sessions + per-user settings in a dotfile
|
|
35
|
+
* dir under `$HOME` (Claude `~/.claude`, Codex `~/.codex`, Gemini
|
|
36
|
+
* `~/.gemini`). The host mounts this dir into the container at
|
|
37
|
+
* {@link containerPath} so the CLI inside the container has access to the
|
|
38
|
+
* same auth state as the host.
|
|
39
|
+
*
|
|
40
|
+
* Read-only by default — the container shouldn't be writing back to the
|
|
41
|
+
* user's persistent config from inside the sandbox. Set `readOnly: false`
|
|
42
|
+
* only when the provider's CLI genuinely needs to mutate state inside the
|
|
43
|
+
* config dir (e.g. session JSONL append).
|
|
44
|
+
*/
|
|
45
|
+
export type SandboxConfigMount = {
|
|
46
|
+
/**
|
|
47
|
+
* Absolute host path. Provider implementations resolve this lazily — call
|
|
48
|
+
* `os.homedir()` + `path.join(...)` at the time `configMount` is read,
|
|
49
|
+
* not at module-load time, so test environments and per-process HOME
|
|
50
|
+
* overrides work correctly.
|
|
51
|
+
*/
|
|
52
|
+
hostPath: string;
|
|
53
|
+
/** Absolute container path. */
|
|
54
|
+
containerPath: string;
|
|
55
|
+
/** When `true`, the host adds `:ro` to the bind. Default: `true` recommended. */
|
|
56
|
+
readOnly: boolean;
|
|
57
|
+
};
|
|
58
|
+
/**
|
|
59
|
+
* Provider-declared Docker sandbox capability. Optional on
|
|
60
|
+
* {@link JackProvider}; when present the matching
|
|
61
|
+
* {@link CapabilityMatrix.sandbox} flag MUST be `true`.
|
|
62
|
+
*/
|
|
63
|
+
export interface SandboxApi {
|
|
64
|
+
/**
|
|
65
|
+
* Default image reference, pinned per provider release. Format:
|
|
66
|
+
* `<registry>/<repo>:<tag>`. Users can override per-provider via the host
|
|
67
|
+
* setting `sandbox.image.<providerId>`.
|
|
68
|
+
*
|
|
69
|
+
* For Jack's first-party providers the recommended location is
|
|
70
|
+
* `ghcr.io/ottimis/jack-sandbox-<providerId>:<X.Y.Z>` (monorepo built
|
|
71
|
+
* from `github.com/ottimis/JACK-sandbox`). Third-party plugins are free
|
|
72
|
+
* to host elsewhere.
|
|
73
|
+
*/
|
|
74
|
+
readonly defaultImage: string;
|
|
75
|
+
/**
|
|
76
|
+
* CLI binary name as it should be invoked inside the container (e.g.
|
|
77
|
+
* `'claude'`, `'codex'`, `'gemini'`). Used by the host's spawner to
|
|
78
|
+
* rewrite host-resolved absolute binary paths to a bare command the
|
|
79
|
+
* container's PATH resolves.
|
|
80
|
+
*
|
|
81
|
+
* The image MUST install this binary at a location reachable from
|
|
82
|
+
* `$PATH` (typically `/usr/local/bin/<binaryName>` via `npm install -g`).
|
|
83
|
+
*/
|
|
84
|
+
readonly binaryName: string;
|
|
85
|
+
/**
|
|
86
|
+
* Mount the provider's host-side config directory into the container.
|
|
87
|
+
* Optional — providers that are stateless on the host (none today)
|
|
88
|
+
* leave this undefined.
|
|
89
|
+
*/
|
|
90
|
+
readonly configMount?: SandboxConfigMount;
|
|
91
|
+
/**
|
|
92
|
+
* Optional environment extras to inject into the container. Layered AFTER
|
|
93
|
+
* the spawn-arg env so provider-specific overrides can win, but BEFORE
|
|
94
|
+
* the user can override (the user-facing override is per-provider via
|
|
95
|
+
* the host setting, not per-env-var).
|
|
96
|
+
*
|
|
97
|
+
* Most provider env is already on `SpawnArgs.env` from the backend's
|
|
98
|
+
* spawn pipeline. Use this only when the SDK contract doesn't expose a
|
|
99
|
+
* cleaner channel — e.g. forcing a CLI to disable telemetry inside the
|
|
100
|
+
* sandbox even when the user has it on globally.
|
|
101
|
+
*/
|
|
102
|
+
envExtras?(): Record<string, string>;
|
|
103
|
+
}
|
|
104
|
+
//# sourceMappingURL=sandbox.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sandbox.d.ts","sourceRoot":"","sources":["../src/sandbox.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB,+BAA+B;IAC/B,aAAa,EAAE,MAAM,CAAA;IACrB,iFAAiF;IACjF,QAAQ,EAAE,OAAO,CAAA;CAClB,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB;;;;;;;;;OASG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAE7B;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,kBAAkB,CAAA;IAEzC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACrC"}
|
package/dist/sandbox.js
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SandboxApi — provider-declared Docker sandbox capability.
|
|
3
|
+
*
|
|
4
|
+
* Jack runs sessions in a Docker container ("sandbox mode") to isolate the
|
|
5
|
+
* provider's CLI from the host filesystem and network. The container itself
|
|
6
|
+
* is generic — Jack owns the Docker orchestration, security policy (CapDrop,
|
|
7
|
+
* memory cap, non-privileged), project mount, and user-defined shared
|
|
8
|
+
* volumes. The PROVIDER-SPECIFIC bits live here:
|
|
9
|
+
*
|
|
10
|
+
* - which image to pull (each provider needs its own CLI installed)
|
|
11
|
+
* - which binary name to invoke inside the container (used by the host to
|
|
12
|
+
* rewrite host-resolved absolute paths like
|
|
13
|
+
* `/Users/foo/.local/bin/claude` to a bare command the container's
|
|
14
|
+
* PATH resolves)
|
|
15
|
+
* - which config dir to mount (`~/.claude`, `~/.codex`, `~/.gemini`, …)
|
|
16
|
+
* - optional env extras
|
|
17
|
+
*
|
|
18
|
+
* A provider declaring `sandbox` opts itself into sandbox mode. The
|
|
19
|
+
* matching capability flag {@link CapabilityMatrix.sandbox} MUST be `true`
|
|
20
|
+
* — the host derives it from `provider.sandbox != null` at registration.
|
|
21
|
+
*
|
|
22
|
+
* Providers that don't declare `sandbox` (or set it to `undefined`) are
|
|
23
|
+
* treated as sandbox-incompatible: the host hides the toggle in the UI and
|
|
24
|
+
* blocks spawn-time requests with a clear error.
|
|
25
|
+
*
|
|
26
|
+
* The host's distribution model expects images at
|
|
27
|
+
* `ghcr.io/ottimis/jack-sandbox-<provider-id>:<X.Y.Z>` (monorepo
|
|
28
|
+
* `github.com/ottimis/JACK-sandbox`). Providers can point `defaultImage`
|
|
29
|
+
* elsewhere — third-party plugin authors who maintain their own image are
|
|
30
|
+
* free to host wherever they like.
|
|
31
|
+
*/
|
|
32
|
+
export {};
|
|
33
|
+
//# sourceMappingURL=sandbox.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sandbox.js","sourceRoot":"","sources":["../src/sandbox.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG"}
|
package/dist/usage.d.ts
CHANGED
|
@@ -176,28 +176,56 @@ export type UsageConnectContext = {
|
|
|
176
176
|
* Provider-owned usage capability. Optional on {@link JackProvider};
|
|
177
177
|
* absent = host hides the chip's "Connect" affordance and the
|
|
178
178
|
* capability flag is `false`.
|
|
179
|
+
*
|
|
180
|
+
* Multi-profile contract (SDK 0.7.0):
|
|
181
|
+
* Every account-level method accepts an optional `profileId`. Providers
|
|
182
|
+
* that ALSO declare `capabilities.profiles=true` MUST honor the param —
|
|
183
|
+
* different profile = different account = different credentials, polled
|
|
184
|
+
* independently. When omitted, the provider resolves to its DEFAULT
|
|
185
|
+
* profile (back-compat with hosts that don't yet thread profileId).
|
|
186
|
+
*
|
|
187
|
+
* Providers without profiles support (`capabilities.profiles=false`)
|
|
188
|
+
* MAY ignore the param and behave as if every call were singleton —
|
|
189
|
+
* the omission stays the canonical caller behavior, the param is just
|
|
190
|
+
* ignored.
|
|
191
|
+
*
|
|
192
|
+
* `formatSessionMetrics` stays profile-agnostic: per-session metrics
|
|
193
|
+
* derive from the live process's context tokens (already pinned to the
|
|
194
|
+
* session's profile via `applyProfile` at spawn time).
|
|
179
195
|
*/
|
|
180
196
|
export type UsageApi = {
|
|
181
|
-
/**
|
|
182
|
-
|
|
197
|
+
/**
|
|
198
|
+
* Current connection state — used for chip display + gating.
|
|
199
|
+
* Profile-aware: omit `profileId` to query the default profile.
|
|
200
|
+
*/
|
|
201
|
+
status(profileId?: string): Promise<UsageStatus>;
|
|
183
202
|
/**
|
|
184
203
|
* Open the provider's connect flow. Whatever modality the provider
|
|
185
204
|
* needs (login window, API-key picker, OAuth redirect) lives here.
|
|
205
|
+
* Profile-aware: omit `profileId` to bind credentials to the default
|
|
206
|
+
* profile. Different profileIds use isolated storage AND isolated
|
|
207
|
+
* login surfaces (e.g. distinct cookie partitions for Claude) so two
|
|
208
|
+
* accounts can sign in side by side.
|
|
186
209
|
*/
|
|
187
|
-
connect(ctx: UsageConnectContext): Promise<UsageConnectResult>;
|
|
210
|
+
connect(ctx: UsageConnectContext, profileId?: string): Promise<UsageConnectResult>;
|
|
188
211
|
/**
|
|
189
212
|
* When `connect()` returned `'choose'`, host calls this with the
|
|
190
213
|
* user's pick. Optional — providers that never choose omit it.
|
|
214
|
+
* Profile-aware: pass the SAME `profileId` you used for `connect()`.
|
|
215
|
+
*/
|
|
216
|
+
selectOption?(optionId: string, profileId?: string): Promise<UsageConnectResult>;
|
|
217
|
+
/**
|
|
218
|
+
* Drop credentials and stop any provider-side polling for the
|
|
219
|
+
* specified profile. Omit `profileId` to disconnect the default profile.
|
|
191
220
|
*/
|
|
192
|
-
|
|
193
|
-
/** Drop credentials and stop any provider-side polling. */
|
|
194
|
-
disconnect(): Promise<void>;
|
|
221
|
+
disconnect(profileId?: string): Promise<void>;
|
|
195
222
|
/**
|
|
196
|
-
* Fetch one fresh account-level snapshot
|
|
197
|
-
* fine when the provider has no billing surface
|
|
198
|
-
* stays `true` for the per-session bridge.
|
|
223
|
+
* Fetch one fresh account-level snapshot for the specified profile.
|
|
224
|
+
* Empty `metrics: []` is fine when the provider has no billing surface
|
|
225
|
+
* yet — the capability stays `true` for the per-session bridge.
|
|
226
|
+
* Omit `profileId` to fetch the default profile.
|
|
199
227
|
*/
|
|
200
|
-
fetch(): Promise<UsageSnapshot>;
|
|
228
|
+
fetch(profileId?: string): Promise<UsageSnapshot>;
|
|
201
229
|
/**
|
|
202
230
|
* Recommended poll cadence (seconds). Host clamps to its bounds.
|
|
203
231
|
* Optional — host falls back to its own default if unset.
|
package/dist/usage.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../src/usage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAElD;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,gBAAgB,GAAG,sBAAsB,GAAG,kBAAkB,CAAA;AAExF;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,aAAa,CAAA;IACnB,uFAAuF;IACvF,EAAE,EAAE,MAAM,CAAA;IACV,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAA;IACb,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAA;IACnB,+DAA+D;IAC/D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,oDAAoD;IACpD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,sFAAsF;IACtF,IAAI,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;IAC5C,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAA;IAChB,8DAA8D;IAC9D,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,mBAAmB,CAAA;IACzB,yEAAyE;IACzE,EAAE,EAAE,MAAM,CAAA;IACV,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAA;IACb,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,8DAA8D;IAC9D,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,eAAe,CAAA;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,uDAAuD;IACvD,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,6CAA6C;IAC7C,UAAU,EAAE,MAAM,CAAA;IAClB,2CAA2C;IAC3C,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,WAAW,EAAE,CAAA;IACtB,kDAAkD;IAClD,UAAU,EAAE,MAAM,CAAA;IAClB;mDAC+C;IAC/C,GAAG,CAAC,EAAE,OAAO,CAAA;CACd,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,SAAS,EAAE,OAAO,CAAA;IAClB,sEAAsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,cAAc,GAAG,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;IACrD,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAC1B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GACnC;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,kBAAkB,EAAE,CAAA;CAAE,GACjD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,CAAA;AAEzB,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,mEAAmE;IACnE,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED
|
|
1
|
+
{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../src/usage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAElD;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,gBAAgB,GAAG,sBAAsB,GAAG,kBAAkB,CAAA;AAExF;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,aAAa,CAAA;IACnB,uFAAuF;IACvF,EAAE,EAAE,MAAM,CAAA;IACV,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAA;IACb,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAA;IACnB,+DAA+D;IAC/D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,oDAAoD;IACpD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,sFAAsF;IACtF,IAAI,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;IAC5C,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAA;IAChB,8DAA8D;IAC9D,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,mBAAmB,CAAA;IACzB,yEAAyE;IACzE,EAAE,EAAE,MAAM,CAAA;IACV,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAA;IACb,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,8DAA8D;IAC9D,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,eAAe,CAAA;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,uDAAuD;IACvD,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,6CAA6C;IAC7C,UAAU,EAAE,MAAM,CAAA;IAClB,2CAA2C;IAC3C,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,WAAW,EAAE,CAAA;IACtB,kDAAkD;IAClD,UAAU,EAAE,MAAM,CAAA;IAClB;mDAC+C;IAC/C,GAAG,CAAC,EAAE,OAAO,CAAA;CACd,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,SAAS,EAAE,OAAO,CAAA;IAClB,sEAAsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,cAAc,GAAG,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;IACrD,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAC1B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GACnC;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,kBAAkB,EAAE,CAAA;CAAE,GACjD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,CAAA;AAEzB,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,mEAAmE;IACnE,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;IAEhD;;;;;;;OAOG;IACH,OAAO,CAAC,GAAG,EAAE,mBAAmB,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAElF;;;;OAIG;IACH,YAAY,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAEhF;;;OAGG;IACH,UAAU,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7C;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;IAEjD;;;OAGG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAA;IAEnC;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,CAAC,GAAG,EAAE,iBAAiB,GAAG,WAAW,EAAE,CAAA;CAC7D,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ottimis/jack-provider-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.9.0",
|
|
4
4
|
"description": "Plugin contract for AI provider integrations in Jack — backend interface, capability matrix, spawner primitives, knowledge context. Consumed both by in-tree providers and external packages.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
package/src/host.ts
ADDED
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Host primitives exposed to providers — handed in via
|
|
3
|
+
* {@link JackProvider.activate} so provider code never imports `electron`,
|
|
4
|
+
* `better-sqlite3`, or any other host-internal module directly.
|
|
5
|
+
*
|
|
6
|
+
* Why this exists
|
|
7
|
+
* ---------------
|
|
8
|
+
* In Jack v0.4.x the Claude provider reached into Electron (`safeStorage`,
|
|
9
|
+
* `BrowserWindow`, `session`) and Jack's settings table (`getSetting` /
|
|
10
|
+
* `setSetting`) to persist its login cookie. That breaks two goals:
|
|
11
|
+
*
|
|
12
|
+
* 1. **Out-of-tree packages.** A future `@third-party/jack-provider-foo`
|
|
13
|
+
* installed from npm shouldn't need to know about the host's storage
|
|
14
|
+
* layer or its windowing toolkit.
|
|
15
|
+
* 2. **Testability.** Provider unit tests on plain Node want a fake host
|
|
16
|
+
* that returns canned credentials, not a real `safeStorage`.
|
|
17
|
+
*
|
|
18
|
+
* `HostServices` is the contract that satisfies both: a tiny set of
|
|
19
|
+
* primitives the host implements once (with whatever it has — Electron in
|
|
20
|
+
* Jack's case, but a CLI host could use `keytar` + headless puppeteer)
|
|
21
|
+
* and providers consume through dependency injection.
|
|
22
|
+
*
|
|
23
|
+
* Surface stays intentionally small. New capabilities grow this file as
|
|
24
|
+
* specific providers need them — but the rule is "host-side knowledge
|
|
25
|
+
* doesn't leak out the SDK". A provider that needs deep host integration
|
|
26
|
+
* is a sign that the integration belongs in the host, not in the
|
|
27
|
+
* provider.
|
|
28
|
+
*
|
|
29
|
+
* Lifecycle
|
|
30
|
+
* ---------
|
|
31
|
+
* The host calls `provider.activate(host)` once during registration. The
|
|
32
|
+
* provider stores the `host` reference and uses it lazily — no host
|
|
33
|
+
* primitive may be invoked before activation. Methods that need the host
|
|
34
|
+
* must guard accordingly (typically by deferring all work to a closure).
|
|
35
|
+
*/
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Per-provider key/value store. Keys are namespaced automatically by the
|
|
39
|
+
* calling provider's id, so `kv.set('token', x)` from `claudeProvider`
|
|
40
|
+
* lands in a different bucket than the same call from `codexProvider`.
|
|
41
|
+
*
|
|
42
|
+
* Values are strings — callers serialize JSON / numbers / booleans
|
|
43
|
+
* themselves. `null` from `get` / `getSecret` means "no value stored",
|
|
44
|
+
* not "value is null"; explicit removal goes through `remove`.
|
|
45
|
+
*
|
|
46
|
+
* `setSecret` / `getSecret` route through the host's OS-level keychain
|
|
47
|
+
* encryption when available (Electron's `safeStorage`, `keytar`, etc.).
|
|
48
|
+
* `setSecret` MUST throw when no secure storage is available so providers
|
|
49
|
+
* never silently degrade to plaintext on unsupported systems.
|
|
50
|
+
*/
|
|
51
|
+
export type HostKvScope = {
|
|
52
|
+
/** Plain (unencrypted) read. */
|
|
53
|
+
get(key: string): string | null
|
|
54
|
+
/** Plain (unencrypted) write. */
|
|
55
|
+
set(key: string, value: string): void
|
|
56
|
+
/** Remove the value at `key`. Idempotent (no-op when the key is absent). */
|
|
57
|
+
remove(key: string): void
|
|
58
|
+
/** Encrypted read. Returns `null` when the key is absent OR the host's secret store can't decrypt (e.g. user wiped keychain). */
|
|
59
|
+
getSecret(key: string): string | null
|
|
60
|
+
/** Encrypted write. Throws when secure storage isn't available — providers should surface a clear error to the user, not fall back to plaintext. */
|
|
61
|
+
setSecret(key: string, value: string): void
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Options for {@link HostAuthService.openCookieLoginWindow}.
|
|
66
|
+
*
|
|
67
|
+
* The host opens a child auth window at `url` and polls the cookie jar
|
|
68
|
+
* until `cookieName` appears on `cookieDomain`. When the cookie shows up
|
|
69
|
+
* the host returns its value and closes the window.
|
|
70
|
+
*
|
|
71
|
+
* Each provider's auth flow lives in its own session partition so two
|
|
72
|
+
* providers can be "logged in" simultaneously without their cookies
|
|
73
|
+
* colliding in the host's shared cookie store.
|
|
74
|
+
*/
|
|
75
|
+
export type CookieLoginOptions = {
|
|
76
|
+
/** URL to open in the child window. */
|
|
77
|
+
url: string
|
|
78
|
+
/** Name of the cookie the provider waits for (e.g. `'sessionKey'`). */
|
|
79
|
+
cookieName: string
|
|
80
|
+
/** Cookie domain to scope the lookup (e.g. `'https://claude.ai'`). */
|
|
81
|
+
cookieDomain: string
|
|
82
|
+
/**
|
|
83
|
+
* Storage partition string for session isolation. Convention:
|
|
84
|
+
* `persist:<provider-id>-<flow-name>` (e.g. `persist:claude-usage`).
|
|
85
|
+
* Different partition strings keep parallel logins independent.
|
|
86
|
+
*/
|
|
87
|
+
partition: string
|
|
88
|
+
/** Window title shown in the OS chrome. Default: `'Connect'`. */
|
|
89
|
+
title?: string
|
|
90
|
+
/** Hard timeout in milliseconds. Default: 5 minutes. */
|
|
91
|
+
timeoutMs?: number
|
|
92
|
+
/** Window width in pixels. Default: 520. */
|
|
93
|
+
width?: number
|
|
94
|
+
/** Window height in pixels. Default: 720. */
|
|
95
|
+
height?: number
|
|
96
|
+
/**
|
|
97
|
+
* Optional parent window the host narrows internally to attach
|
|
98
|
+
* modality. Typed as `unknown` so the SDK doesn't depend on Electron.
|
|
99
|
+
*/
|
|
100
|
+
parentWindow?: unknown
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* Result of a cookie-login flow.
|
|
105
|
+
*
|
|
106
|
+
* - `'success'` — cookie captured; `cookieValue` is the raw value.
|
|
107
|
+
* - `'cancelled'` — user closed the window before the cookie appeared.
|
|
108
|
+
* - `'timeout'` — `timeoutMs` elapsed without the cookie being set.
|
|
109
|
+
* - `'error'` — host couldn't open the window (e.g. running headless,
|
|
110
|
+
* no display server, partition rejected). Providers should surface
|
|
111
|
+
* `error` to the user as an actionable message.
|
|
112
|
+
*/
|
|
113
|
+
export type CookieLoginResult =
|
|
114
|
+
| { kind: 'success'; cookieValue: string }
|
|
115
|
+
| { kind: 'cancelled' }
|
|
116
|
+
| { kind: 'timeout' }
|
|
117
|
+
| { kind: 'error'; error: string }
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* Auth primitives the host provides. Today only cookie-based login;
|
|
121
|
+
* OAuth / device-code flows can be added as future providers need them
|
|
122
|
+
* without breaking existing implementations (`HostAuthService` is an
|
|
123
|
+
* open-shape type — additions are purely additive).
|
|
124
|
+
*/
|
|
125
|
+
export type HostAuthService = {
|
|
126
|
+
/**
|
|
127
|
+
* Open a child window at the given URL and wait for the named cookie
|
|
128
|
+
* to appear. Used by providers whose login flow is "send the user to
|
|
129
|
+
* a web page, scrape the session cookie when they sign in".
|
|
130
|
+
*
|
|
131
|
+
* The host is responsible for: opening the window, polling cookies,
|
|
132
|
+
* closing the window when the cookie shows up (or the user cancels /
|
|
133
|
+
* times out), and isolating the session partition. The provider
|
|
134
|
+
* doesn't see Electron, BrowserWindow, or any windowing detail.
|
|
135
|
+
*/
|
|
136
|
+
openCookieLoginWindow(opts: CookieLoginOptions): Promise<CookieLoginResult>
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
/**
|
|
140
|
+
* The bag of host services injected into a provider via
|
|
141
|
+
* {@link JackProvider.activate}. Providers store the reference and
|
|
142
|
+
* pull primitives lazily.
|
|
143
|
+
*
|
|
144
|
+
* Adding a new capability:
|
|
145
|
+
* 1. Define the new service interface in this file (or a sibling).
|
|
146
|
+
* 2. Add it as an optional field here so older providers that don't
|
|
147
|
+
* use it keep compiling.
|
|
148
|
+
* 3. Document the feature flag — providers that need the capability
|
|
149
|
+
* should guard with `if (!host.newCapability) return undefined`
|
|
150
|
+
* and the host implements it.
|
|
151
|
+
*
|
|
152
|
+
* Concrete services exposed today are documented in their own types.
|
|
153
|
+
*/
|
|
154
|
+
export type HostServices = {
|
|
155
|
+
/** Per-provider key/value store. Namespaced by provider id by the host. */
|
|
156
|
+
kv: HostKvScope
|
|
157
|
+
/** Auth flow primitives (cookie login today; OAuth / device-code in the future). */
|
|
158
|
+
auth: HostAuthService
|
|
159
|
+
}
|
package/src/index.ts
CHANGED
|
@@ -7,13 +7,19 @@
|
|
|
7
7
|
* (not on Jack's main process internals) and Jack stays free to evolve
|
|
8
8
|
* its host code without breaking provider authors.
|
|
9
9
|
*
|
|
10
|
-
* Re-exports cover
|
|
10
|
+
* Re-exports cover four layers:
|
|
11
11
|
* - `./backend` — neutral wire-shape contract (`AgentBackend`,
|
|
12
12
|
* `AgentQueryOptions`, `AgentSession`, …)
|
|
13
13
|
* - `./spawner` — process-spawning primitives shared by every backend
|
|
14
14
|
* (`ProcessSpawner`, `ProcessHandle`, `localSpawner`, …)
|
|
15
15
|
* - `./provider` — plugin-level contract (`JackProvider`,
|
|
16
16
|
* `CapabilityMatrix`, `ToolDescriptor`, `ProviderBranding`, …)
|
|
17
|
+
* - `./usage` — provider-owned billing/usage surface (`UsageApi`,
|
|
18
|
+
* `UsageMetric`, …)
|
|
19
|
+
* - `./host` — host primitives injected at activation
|
|
20
|
+
* (`HostServices`, `HostKvScope`, `HostAuthService`, …) — providers
|
|
21
|
+
* consume these via `JackProvider.activate(host)` instead of
|
|
22
|
+
* reaching into Electron / host internals directly.
|
|
17
23
|
*
|
|
18
24
|
* Companion runtime types from `@ottimis/jack-chat-core` (`NormalizedMessage`,
|
|
19
25
|
* `ClientToolHandler`, `ToolShape`, …) are re-exported through `./provider`
|
|
@@ -25,6 +31,9 @@ export * from './backend'
|
|
|
25
31
|
export * from './spawner'
|
|
26
32
|
export * from './provider'
|
|
27
33
|
export * from './usage'
|
|
34
|
+
export * from './host'
|
|
35
|
+
export * from './profiles'
|
|
36
|
+
export * from './sandbox'
|
|
28
37
|
|
|
29
38
|
/**
|
|
30
39
|
* Re-export of `NormalizedMessage` from chat-core so consumers don't need
|