@cortexkit/claustrum-client 0.4.0 → 0.6.0

package/README.md

@@ -16,6 +16,11 @@ credential caching, refresh, account scheduling, and retry policy.
   by design (the vault cannot enumerate which). Treat it as gone either way: re-run
   `ck auth migrate-opencode` to mint a fresh handle; the prior record, if any, is kept.
 • `auth_required` means the record is latched and needs reauthentication.
+• `statusCredential` on an unknown or revoked handle RESOLVES, it does not throw: it
+  returns `ready: false, lastErrorCode: 'not_found'` with `recordVersion`, `credentialId`
+  and `stalePending` absent. Since 0.5.0 `CredentialStatus.recordVersion` is optional for
+  that reason; handle `undefined` rather than defaulting it to a number, which would read
+  as a version older than every real one.
 • Unknown server error classes are bounded to `transient`; callers must retry them
   rather than treating a forward-compatible class as permanent.
 

package/dist/detect.d.ts

@@ -13,6 +13,7 @@ export type ClaustrumDetection = {
     path: string;
     reason: string;
 };
+export declare function userConnectionToken(getuid?: (() => number) | null, env?: NodeJS.ProcessEnv): string;
 export declare function getDefaultClaustrumConnectionPath(): string;
 export declare function resolveClaustrumConnectionPath(explicit?: string): string;
 export declare function detectClaustrumConnection(explicitPath?: string): Promise<ClaustrumDetection>;

package/dist/detect.js

@@ -6,36 +6,15 @@ import { PROTOCOL_VERSION, readConnectionFile, } from '@cortexkit/subc-client';
 const PRODUCTION_FILE_NAME = 'subc-connection.json';
 const TEMP_PREFIX = 'subc-';
 const TEMP_SUFFIX = '.connection.json';
-// The default discovery order MUST mirror `ck` / the daemon, because a client that picks a
-// different file ends up talking to the wrong daemon. The Rust source of truth (sibling
-// pin, NOT regenerated here) is:
-//
-//   crates/credentials-module/src/bin/credentials_cli.rs :: discover_subc_connection_file
-//     -> XDG_RUNTIME_DIR/subc-connection.json, else
-//        ~/.local/share/cortexkit/run/subc-connection.json, else
-//        <tempdir>/subc-<token>.connection.json  (glob; ambiguity REFUSES)
-//
-//   crates/subc-core/src/bootstrap.rs :: connection_file_path_with_source
-//     -> XDG_RUNTIME_DIR/subc-connection.json, else
-//        <tempdir>/subc-<user_connection_token()>.connection.json
-//     where user_connection_token() is the UID on unix (via a probe-file UID read),
-//     else a sanitized USER/USERNAME/HOME/USERPROFILE value, else "unknown".
-//
-// The OLD client derived `${uid}` itself via `process.getuid()`, but the daemon may
-// produce a different token (sanitized user on macOS, the literal "unknown" if all of
-// the lookups miss). The glob is the only way to mirror the daemon without re-deriving
-// the token (which is filesystem-side-effecting per the Rust side comment).
-// The home tier resolves from `$HOME` byte-for-byte, mirroring `non_empty_env("HOME")`
-// in `discover_subc_connection_file`: only the empty string is absent, and whitespace
-// is not trimmed. The Rust code does NOT fall back to a `getpwuid`-style lookup; the
-// client must not either, or an operator who points HOME at a per-test fixture loses
-// the daemon they started there.
+// Keep discovery in the CLI's order: exclusive SUBC_CONNECTION_FILE, runtime,
+// HOME, exact per-user temp name, then an unambiguous temp glob. The glob supports
+// daemons whose token derivation differs without guessing between other users.
 function homeTierPath() {
     const homeEnv = process.env.HOME;
     return homeEnv ? join(homeEnv, '.local', 'share', 'cortexkit', 'run', PRODUCTION_FILE_NAME) : undefined;
 }
 function highestPriorityAbsentMarker() {
-    const runtime = process.env.XDG_RUNTIME_DIR?.trim();
+    const runtime = process.env.XDG_RUNTIME_DIR;
     if (runtime)
         return join(runtime, PRODUCTION_FILE_NAME);
     const home = homeTierPath();
@@ -47,7 +26,9 @@ function highestPriorityAbsentMarker() {
     return join(userInfo().homedir, '.local', 'share', 'cortexkit', 'run', PRODUCTION_FILE_NAME);
 }
 function findExistingConnectionPath() {
-    const runtime = process.env.XDG_RUNTIME_DIR?.trim();
+    if (process.env.SUBC_CONNECTION_FILE)
+        return process.env.SUBC_CONNECTION_FILE;
+    const runtime = process.env.XDG_RUNTIME_DIR;
     if (runtime) {
         const p = join(runtime, PRODUCTION_FILE_NAME);
         if (safeIsFile(p))
@@ -56,17 +37,31 @@ function findExistingConnectionPath() {
     const home = homeTierPath();
     if (home && safeIsFile(home))
         return home;
+    const exact = join(tmpdir(), `${TEMP_PREFIX}${userConnectionToken()}${TEMP_SUFFIX}`);
+    if (safeIsFile(exact))
+        return exact;
     const matches = listSubcConnectionFiles(tmpdir());
     // A single matching file IS the daemon; multiple matches mean different OS users
     // happened to share the temp dir. Picking one would route credential-bearing
     // requests at another user's daemon, so REFUSE both picks and the absent path.
     return matches.length === 1 ? matches[0] : undefined;
 }
+export function userConnectionToken(getuid = process.getuid ?? null, env = process.env) {
+    if (getuid)
+        return String(getuid());
+    for (const key of ['USER', 'USERNAME', 'HOME', 'USERPROFILE']) {
+        const value = env[key];
+        if (value)
+            return Array.from(value, (character) => /^[a-zA-Z0-9_-]$/.test(character) ? character : '_').join('');
+    }
+    return 'unknown';
+}
 export function getDefaultClaustrumConnectionPath() {
     return findExistingConnectionPath() ?? highestPriorityAbsentMarker();
 }
 export function resolveClaustrumConnectionPath(explicit) {
     return (explicit?.trim() ||
+        process.env.SUBC_CONNECTION_FILE ||
         process.env.CLAUSTRUM_SUBC_CONNECTION?.trim() ||
         getDefaultClaustrumConnectionPath());
 }

package/dist/manifest-lock.js

@@ -1,5 +1,5 @@
 import { constants as fsConstants } from 'node:fs';
-import { chmod, lstat, mkdir, open, readFile, readdir, rename, rm, stat, unlink } from 'node:fs/promises';
+import { chmod, lstat, mkdir, open, readFile, readdir, realpath, rename, rm, stat, unlink } from 'node:fs/promises';
 import { randomBytes, randomInt } from 'node:crypto';
 import { basename as pathBasename, dirname, join } from 'node:path';
 import { HANDLE_FILE_CONTRACT, parseHandleFile } from './handles.js';
@@ -128,6 +128,28 @@ async function withLockCommit(path, tenant, fn) {
             if (code(error) !== 'ENOENT' && Date.now() >= deadline)
                 throw code(error) === 'owner_invalid' ? error : lockError('lock_busy', 'manifest lock busy');
         }
+        if (!observed && code(ownerReadError) === 'ENOENT') {
+            const metadata = await lstat(lock).catch(() => undefined);
+            if (metadata?.isDirectory() && Date.now() - metadata.mtimeMs >= ttl) {
+                await testOptions?.beforeEvict?.();
+                const stale = `${lock}.stale-${Math.floor(metadata.mtimeMs)}-${token()}`;
+                try {
+                    await rename(lock, stale);
+                    // A claimant may have published its owner while the eviction was pending.
+                    const moved = await lstat(stale);
+                    const ownerExists = await lstat(join(stale, 'owner')).then(() => true, (error) => code(error) !== 'ENOENT');
+                    if (!ownerExists && moved.mtimeMs === metadata.mtimeMs) {
+                        testOptions?.afterEvict?.();
+                        continue;
+                    }
+                    await rename(stale, lock).catch(() => { });
+                }
+                catch (error) {
+                    if (!['ENOENT', 'EEXIST', 'ENOTEMPTY'].includes(code(error) ?? ''))
+                        throw error;
+                }
+            }
+        }
         if (observed && Date.now() - observed.claimed_at_ms >= ttl) {
             await testOptions?.beforeEvict?.();
             // The owner record remains because the quarantine is the ABA guard, not an audit log;
@@ -226,10 +248,47 @@ async function readManifest(path) {
     return parseHandleFile(JSON.parse(source.toString('utf8')));
 }
 const foreign = (file, tenant) => file.providers.filter((provider) => provider.serve !== tenant).map((provider) => JSON.stringify(provider));
-async function prepareParent(path) { const parent = dirname(path); await mkdir(parent, { recursive: true, mode: 0o700 }); const metadata = await stat(parent); if (!metadata.isDirectory())
-    throw new Error('handle file parent must be a directory'); if ((metadata.mode & 0o002) !== 0 && (metadata.mode & 0o1000) === 0)
-    throw new Error('handle file parent is world-writable without sticky bit'); if ((metadata.mode & 0o022) !== 0)
-    throw new Error('handle file parent must not be group- or other-writable'); }
+async function refuseWritableAncestors(parent) {
+    let component;
+    try {
+        component = await realpath(parent);
+    }
+    catch (error) {
+        if (code(error) !== 'ENOENT')
+            throw error;
+        const next = dirname(parent);
+        if (next !== parent)
+            await refuseWritableAncestors(next);
+        return;
+    }
+    for (;;) {
+        const metadata = await stat(component);
+        if ((metadata.mode & 0o022) !== 0 && (metadata.mode & 0o1000) === 0)
+            throw new Error('handle file ancestor is group- or world-writable without sticky bit');
+        const next = dirname(component);
+        if (next === component)
+            return;
+        component = next;
+    }
+}
+async function prepareParent(path) {
+    const parent = dirname(path);
+    // Check existing ancestors before creating directories under a replaceable tree.
+    if (process.platform !== 'win32')
+        await refuseWritableAncestors(parent);
+    const existing = await stat(parent).catch((error) => { if (code(error) !== 'ENOENT')
+        throw error; return undefined; });
+    if (existing && typeof process.getuid === 'function' && existing.uid !== process.getuid())
+        throw new Error('handle file parent is not owned by the current uid');
+    await mkdir(parent, { recursive: true, mode: 0o700 });
+    const metadata = await stat(parent);
+    if (!metadata.isDirectory())
+        throw new Error('handle file parent must be a directory');
+    if (typeof process.getuid === 'function' && metadata.uid !== process.getuid())
+        throw new Error('handle file parent is not owned by the current uid');
+    if (process.platform !== 'win32')
+        await refuseWritableAncestors(parent);
+}
 async function writeAtomic(path, file, commit) {
     const bytes = Buffer.from(JSON.stringify(file));
     if (bytes.byteLength > HANDLE_FILE_CONTRACT.maxBytes)

package/dist/wire.d.ts

@@ -15,6 +15,14 @@ export type ClaustrumClientOptions = {
 /**
  * Credential material plus optional non-secret identity metadata. Missing wire fields remain
  * `undefined`; a present non-string identity value rejects the response as invalid.
+ *
+ * An absent identity field means the vault had nothing to assert — NOT that identity failed.
+ * Consumers must not collapse absence into mismatch: assert on presence, refuse on a present
+ * difference, and serve (log, if it matters) when the field is missing. Absence proves neither
+ * the right identity nor the wrong one, so treating it as a failure converts a vault that could
+ * not answer into a consumer that cannot serve. The vault records no per-read success (at most
+ * the first scoped read per principal), and nothing at all when a consumer declines to serve, so
+ * an outage caused that way is visible only to the consumer that caused it.
  */
 export type ServedCredential = {
     material: string;
@@ -30,6 +38,12 @@ export type ServedCredential = {
     /**
      * Provider account identity the served token executes under. Account-scoped routing joins this
      * value with `recordVersion`; it is neither the operator's credential label nor the bearer handle.
+     *
+     * BEST-EFFORT, NEVER GUARANTEED, including for JWT providers. The vault parses the claim live
+     * from the served access token and falls back to stored login-time identity; both legs can be
+     * empty, and the serve path yields nothing rather than fabricating an id. It is absent when the
+     * provider has no known claim, the token does not carry one, or no identity was captured at
+     * login. Do not gate serving on its presence.
      */
     accountId?: string;
     /** Non-secret account display metadata captured at login. */
@@ -37,14 +51,43 @@ export type ServedCredential = {
     /** Non-secret organization or workspace display metadata captured at login. */
     orgName?: string;
 };
+/**
+ * Non-secret health for one handle, read without minting anything.
+ *
+ * An unresolved handle (unknown or revoked) is an ordinary answer, not an error: it decodes
+ * as `ready: false, lastErrorCode: 'not_found'` with `credentialId`, `recordVersion` and
+ * `stalePending` all absent. The vault omits them on purpose so a probe learns nothing about
+ * what exists and no placeholder value is asserted about a record it never saw.
+ */
 export type CredentialStatus = {
     ready: boolean;
     lastErrorCode: string | null;
     leaseHeld: boolean;
-    recordVersion: number;
+    /**
+     * Operator-chosen record label the handle resolved to, for verifying a binding the caller
+     * already holds. Not a routing key. Absent when the handle did not resolve.
+     */
+    credentialId?: string;
+    /**
+     * The record's change cursor, present only when the handle resolved to a record.
+     *
+     * Optional, and OMITTED from the object rather than defaulted, because there is no honest
+     * default: 0 or -1 would compare as older than every real version, so a poller would read a
+     * revoked handle as a change it had yet to see, forever. With the key absent, TypeScript
+     * refuses arithmetic or ordering on it until the caller has handled `undefined`, and
+     * `'recordVersion' in status` is false. Never replace absence with a number (`?? 0`).
+     */
+    recordVersion?: number;
     stalePending?: boolean;
 };
 export type ClaustrumReporterSource = 'direct' | 'relay_status_field' | 'relay_message_parse';
+/**
+ * Exported for the golden-reply test only; `index.ts` re-exports by name, so this does not
+ * widen the published surface.
+ */
+export declare function decodeCredential(response: unknown, logUnknownClass: (errorClass: string) => void): ServedCredential;
+/** Exported for the golden-reply test only, like `decodeCredential`. */
+export declare function decodeStatus(response: unknown, logUnknownClass: (errorClass: string) => void): CredentialStatus;
 export declare class ClaustrumClient {
     #private;
     private constructor();
@@ -143,26 +186,29 @@ export declare class ClaustrumClient {
 /**
  * A row from the caller's own grant-covered inventory.
  *
- * TWO SELECTION AXES, AND THEY ANSWER DIFFERENT QUESTIONS. Pick by what you are about
+ * Selection fields answer different questions. Pick by what you are about
  * to do with the token:
  *
+ * - `providerIds` — operator-assigned catalog provider ids; match exactly, with no fallback.
+ * - `authMethod` — the closed authentication method derived from the unsealed record,
+ *   not the id spelling. Absent on sign/open-only rows or when no method is defined.
+ *
  * - `refreshAdapter` — whose PROTOCOL the credential speaks. Use it when the token
  *   goes to a provider's own endpoints. Anything else is invalid there.
  * - `serves` — which model VENDORS are reachable through it. Use it when choosing
  *   where a model can be served from, and the protocol is not yours to care about.
  *
- * Never the id spelling, in either case: on a live vault 8 rows serve Anthropic models
- * and 3 of them contain no "anthropic" anywhere in their id.
- *
- * An earlier version of this comment called `serves` "the routing axis" full stop. That
- * was written before `refreshAdapter` existed and is wrong for the protocol-native case:
- * it would send a Claude OAuth request to `apikey:openrouter`.
+ * Never infer these fields from the id spelling. A credential reaching Anthropic models
+ * through OpenRouter still speaks OpenRouter's protocol, not Anthropic's.
  */
 export interface ScopedInventoryRow {
     readonly id: string;
     readonly categories: readonly string[];
     readonly credentialType: string;
     readonly serves: readonly string[];
+    /** Operator-assigned catalog ids, always present, including an empty set. */
+    readonly providerIds: readonly string[];
+    readonly authMethod?: 'apikey' | 'chatgpt' | 'antigravity' | 'oauth';
     /**
      * Which provider protocol this credential speaks. Absent for static keys.
      *

package/dist/wire.js

@@ -15,7 +15,11 @@ function asRecordVersion(value) {
 function isOptionalString(value) {
     return value === undefined || typeof value === 'string';
 }
-function decodeCredential(response, logUnknownClass) {
+/**
+ * Exported for the golden-reply test only; `index.ts` re-exports by name, so this does not
+ * widen the published surface.
+ */
+export function decodeCredential(response, logUnknownClass) {
     if (hasCredentialError(response))
         throw asCredentialError(response, 'invalid_response', logUnknownClass);
     const result = isRecord(response) && isRecord(response.result) ? response.result : undefined;
@@ -50,8 +54,15 @@ function decodeCredential(response, logUnknownClass) {
         !isOptionalString(orgName)) {
         throw asCredentialError(response, 'invalid_response', logUnknownClass);
     }
+    let material;
+    try {
+        material = new TextDecoder('utf-8', { fatal: true }).decode(Uint8Array.from(payload));
+    }
+    catch {
+        throw asCredentialError(response, 'invalid_response', logUnknownClass);
+    }
     return {
-        material: new TextDecoder().decode(Uint8Array.from(payload)),
+        material,
         recordVersion,
         expiresAtMs,
         credentialId,
@@ -61,15 +72,22 @@ function decodeCredential(response, logUnknownClass) {
         orgName,
     };
 }
-function decodeStatus(response, logUnknownClass) {
+/** Exported for the golden-reply test only, like `decodeCredential`. */
+export function decodeStatus(response, logUnknownClass) {
     if (hasCredentialError(response))
         throw asCredentialError(response, 'invalid_response', logUnknownClass);
     const result = isRecord(response) && isRecord(response.result) ? response.result : undefined;
-    const recordVersion = asRecordVersion(result?.record_version);
+    // Absent is a valid reply (the handle did not resolve); a PRESENT value that is not a
+    // non-negative integer is malformed. The producer omits the key rather than nulling it,
+    // so an explicit null is refused too.
+    const rawRecordVersion = result?.record_version;
+    const recordVersion = rawRecordVersion === undefined ? undefined : asRecordVersion(rawRecordVersion);
+    const credentialId = result?.credential_id;
     if (typeof result?.ready !== 'boolean' ||
         (result?.last_error_code !== undefined && result?.last_error_code !== null && typeof result?.last_error_code !== 'string') ||
         typeof result?.lease_held !== 'boolean' ||
-        recordVersion === undefined ||
+        (rawRecordVersion !== undefined && recordVersion === undefined) ||
+        !isOptionalString(credentialId) ||
         (result?.stale_pending !== undefined && typeof result.stale_pending !== 'boolean')) {
         throw asCredentialError(response, 'invalid_status', logUnknownClass);
     }
@@ -77,7 +95,8 @@ function decodeStatus(response, logUnknownClass) {
         ready: result.ready,
         lastErrorCode: result.last_error_code ?? null,
         leaseHeld: result.lease_held,
-        recordVersion,
+        ...(credentialId === undefined ? {} : { credentialId }),
+        ...(recordVersion === undefined ? {} : { recordVersion }),
         ...(result.stale_pending === undefined ? {} : { stalePending: result.stale_pending }),
     };
 }
@@ -238,7 +257,7 @@ export class ClaustrumClient {
         const result = decodeEnrollmentResult(response, this.#logger);
         const token = result.token;
         const generation = result.token_generation;
-        if (typeof token !== 'string' || token.length === 0 || typeof generation !== 'number') {
+        if (typeof token !== 'string' || token.length === 0 || typeof generation !== 'number' || !Number.isInteger(generation) || generation < 0) {
             throw asCredentialError(response, 'invalid_response', this.#logger);
         }
         return { token, tokenGeneration: generation };
@@ -248,8 +267,9 @@ export class ClaustrumClient {
         this.#client.close();
     }
     async #call(method, params) {
+        const sentClient = this.#client;
         try {
-            return await this.#client.call(CLAUSTRUM_MODULE_ID, method, params, {
+            return await sentClient.call(CLAUSTRUM_MODULE_ID, method, params, {
                 identity: this.#identity,
                 consumerIdentity: null,
             });
@@ -257,7 +277,8 @@ export class ClaustrumClient {
         catch (error) {
             if (this.#shouldReconnect(error)) {
                 try {
-                    await this.#reconnect();
+                    if (this.#client === sentClient)
+                        await this.#reconnect();
                 }
                 catch (reconnectError) {
                     throw this.#asTransportError(reconnectError);
@@ -380,6 +401,12 @@ export function decodeScopedInventory(response, logUnknownClass) {
                 : undefined;
         if (createdAtMs === undefined)
             throw asCredentialError(response, 'invalid_response', logUnknownClass);
+        const authMethod = row.auth_method;
+        if (authMethod !== undefined &&
+            authMethod !== 'apikey' && authMethod !== 'chatgpt' &&
+            authMethod !== 'antigravity' && authMethod !== 'oauth') {
+            throw asCredentialError(response, 'invalid_response', logUnknownClass);
+        }
         if (!isOptionalString(row.refresh_adapter)) {
             throw asCredentialError(response, 'invalid_response', logUnknownClass);
         }
@@ -391,6 +418,8 @@ export function decodeScopedInventory(response, logUnknownClass) {
             categories: strings(row.categories),
             credentialType: row.type,
             serves: strings(row.serves),
+            providerIds: strings(row.provider_ids),
+            authMethod,
             state: row.state,
             refreshAdapter: row.refresh_adapter,
             recordVersion,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cortexkit/claustrum-client",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "license": "MIT",
   "repository": {
     "type": "git",