chore: add new function to register a global secret

It hides the idea of having a root keychain for external
users.

Author: kmruiz

src/common/keychain.ts

@@ -34,3 +34,7 @@ export class Keychain {
         return [...this.secrets];
     }
 }
+
+export function registerGlobalSecretToRedact(value: Secret["value"], kind: Secret["kind"]): void {
+    Keychain.root.register(value, kind);
+}

src/lib.ts

@@ -19,3 +19,5 @@ export type {
 } from "./common/connectionErrorHandler.js";
 export { ErrorCodes } from "./common/errors.js";
 export { Telemetry } from "./telemetry/telemetry.js";
+export { Keychain, registerGlobalSecretToRedact } from "./common/keychain.js";
+export type { Secret } from "./common/keychain.js";

tests/unit/common/keychain.test.ts

@@ -1,4 +1,4 @@
-import { Keychain } from "../../../src/common/keychain.js";
+import { Keychain, registerGlobalSecretToRedact } from "../../../src/common/keychain.js";
 import { describe, beforeEach, afterEach, it, expect } from "vitest";
 
 describe("Keychain", () => {
@@ -26,4 +26,11 @@ describe("Keychain", () => {
         keychain.register("654321", "user");
         expect(keychain.allSecrets).toEqual([{ value: "654321", kind: "user" }]);
     });
+
+    describe("registerGlobalSecretToRedact", () => {
+        it("registers the secret in the root keychain", () => {
+            registerGlobalSecretToRedact("123456", "password");
+            expect(keychain.allSecrets).toEqual([{ value: "123456", kind: "password" }]);
+        });
+    });
 });