@cortexkit/claustrum-client 0.16.0 → 0.18.0

package/README.md

@@ -168,6 +168,13 @@ for (;;) {
 
 ## Enrollment
 
+`enrollPropose` accepts an optional `displayName`, for example
+`{ name: 'consumer', requestSecretHash, displayName: 'Claude sign-in for Pi' }`.
+The person sees and approves the proposed label, or replaces it during approval.
+This option needs a vault build with enrollment display-name support; an older
+vault refuses the `display_name` field as `invalid_params`. Omit `displayName`
+for compatibility with older vaults.
+
 Use `newEnrollmentSecret()` to prepare an enrollment proposal. It generates 32
 random bytes as exactly 64 lowercase hex characters, plus `requestSecretHash`:
 the lowercase hex SHA-256 of the **32 decoded bytes**, not of the UTF-8 hex text.

package/dist/wire.d.ts

@@ -179,10 +179,28 @@ export declare class ClaustrumClient {
      * BEFORE calling this, and a crash costs nothing.
      *
      * A different secret on the same name is a different caller and is refused.
+     * Optional `displayName` proposes a person-facing label for operator approval. It
+     * needs a vault build with enrollment display-name support; an older vault refuses
+     * the `display_name` field as `invalid_params`. Omit it for older vaults.
+     * Optional `requestedGrants` proposes read/list permissions for operator review.
+     * Older vaults refuse `requested_grants` as `invalid_params`. Callers that want to
+     * support them must choose to retry without the field themselves; the client never
+     * silently drops permissions, since malformed grants have the same refusal code.
      */
     enrollPropose(input: {
         name: string;
         requestSecretHash: string;
+        displayName?: string;
+        requestedGrants?: ReadonlyArray<{
+            selector: {
+                category: string;
+                exact?: never;
+            } | {
+                exact: string;
+                category?: never;
+            };
+            operation: 'read' | 'list';
+        }>;
     }): Promise<{
         requestId: string;
     }>;
@@ -236,11 +254,17 @@ export declare class ClaustrumClient {
  */
 export interface ScopedInventoryRow {
     readonly id: string;
+    /** Vault catalog service key, not a routing provider id. */
+    readonly provider?: string;
+    readonly incarnation?: string;
+    /** First observation of the effective tier; absent when unknown. */
+    readonly planTierObservedAtMs?: number;
     readonly categories: readonly string[];
     readonly credentialType: string;
     readonly serves: readonly string[];
     /**
-     * Operator-assigned catalog ids; empty when none are set. Always present on this type.
+     * Stored routing ids, defaulted at creation or operator-assigned; empty when unset.
+     * Always present on this type.
      * A daemon older than the field omits it from the wire, and that decodes as empty,
      * which is also what an unmapped credential reports.
      */

package/dist/wire.js

@@ -296,11 +296,20 @@ export class ClaustrumClient {
      * BEFORE calling this, and a crash costs nothing.
      *
      * A different secret on the same name is a different caller and is refused.
+     * Optional `displayName` proposes a person-facing label for operator approval. It
+     * needs a vault build with enrollment display-name support; an older vault refuses
+     * the `display_name` field as `invalid_params`. Omit it for older vaults.
+     * Optional `requestedGrants` proposes read/list permissions for operator review.
+     * Older vaults refuse `requested_grants` as `invalid_params`. Callers that want to
+     * support them must choose to retry without the field themselves; the client never
+     * silently drops permissions, since malformed grants have the same refusal code.
      */
     async enrollPropose(input) {
         const response = await this.#call('auth.enroll_propose', {
             proposed_name: input.name,
             request_secret_hash: input.requestSecretHash,
+            ...(input.displayName !== undefined ? { display_name: input.displayName } : {}),
+            ...(input.requestedGrants !== undefined ? { requested_grants: input.requestedGrants } : {}),
         });
         const result = decodeEnrollmentResult(response, this.#logger);
         const requestId = result.request_id;
@@ -491,6 +500,14 @@ export function decodeScopedInventory(response, logUnknownClass) {
             throw asCredentialError(response, 'invalid_response', logUnknownClass);
         }
         const authMethod = row.auth_method;
+        const provider = row.provider ?? undefined;
+        const incarnation = row.incarnation ?? undefined;
+        const planTierObservedAtMs = row.plan_tier_observed_at_ms ?? undefined;
+        if (!isOptionalString(provider) || !isOptionalString(incarnation) ||
+            (planTierObservedAtMs !== undefined &&
+                (typeof planTierObservedAtMs !== 'number' || !Number.isSafeInteger(planTierObservedAtMs)))) {
+            throw asCredentialError(response, 'invalid_response', logUnknownClass);
+        }
         const planTierSource = row.plan_tier_source;
         if (planTierSource !== undefined && planTierSource !== 'operator' && planTierSource !== 'detected') {
             throw asCredentialError(response, 'invalid_response', logUnknownClass);
@@ -508,6 +525,9 @@ export function decodeScopedInventory(response, logUnknownClass) {
         }
         return {
             id: row.id,
+            provider,
+            incarnation,
+            planTierObservedAtMs,
             categories: strings(row.categories),
             credentialType: row.type,
             serves: strings(row.serves),

package/package.json

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