@cortexkit/claustrum-client 0.16.0 → 0.17.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,14 @@ 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.
      */
     enrollPropose(input: {
         name: string;
         requestSecretHash: string;
+        displayName?: string;
     }): Promise<{
         requestId: string;
     }>;

package/dist/wire.js

@@ -296,11 +296,15 @@ 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.
      */
     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 } : {}),
         });
         const result = decodeEnrollmentResult(response, this.#logger);
         const requestId = result.request_id;

package/package.json

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