@aigne/secrets 0.1.1-beta.1 → 0.1.1-beta.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.1.1-beta.3](https://github.com/AIGNE-io/aigne-framework/compare/secrets-v0.1.1-beta.2...secrets-v0.1.1-beta.3) (2025-11-27)
+
+
+### Bug Fixes
+
+* **secrets:** simplify default item handling in KeyringStore ([#780](https://github.com/AIGNE-io/aigne-framework/issues/780)) ([4c1ff51](https://github.com/AIGNE-io/aigne-framework/commit/4c1ff51e982ed5787df37b127a381276537ec92f))
+
+## [0.1.1-beta.2](https://github.com/AIGNE-io/aigne-framework/compare/secrets-v0.1.1-beta.1...secrets-v0.1.1-beta.2) (2025-11-27)
+
+
+### Bug Fixes
+
+* **secrets:** improve keyring availability detection with environment checks ([#778](https://github.com/AIGNE-io/aigne-framework/issues/778)) ([75dceab](https://github.com/AIGNE-io/aigne-framework/commit/75dceabeb7d6fd8c057759f003e703a2ebb41afd))
+
 ## [0.1.1-beta.1](https://github.com/AIGNE-io/aigne-framework/compare/secrets-v0.1.1-beta...secrets-v0.1.1-beta.1) (2025-11-26)
 
 

package/lib/cjs/keytar.d.ts

@@ -3,8 +3,9 @@ import type { CredentialEntry, ItemInfo, StoreOptions } from "./types.js";
 export declare class KeyringStore extends BaseSecretStore {
     private _impl;
     private serviceName;
-    private defaultAccount;
     private _forceUnavailable;
+    private _environmentChecked;
+    private _environmentReady;
     constructor(options: StoreOptions);
     available(): Promise<boolean>;
     setItem(key: string, value: ItemInfo): Promise<any>;

package/lib/cjs/keytar.js

@@ -34,24 +34,38 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyringStore = void 0;
+const logger_js_1 = require("@aigne/core/utils/logger.js");
 const base_js_1 = require("./base.js");
-const DEFAULT_SERVICE_NAME = "-secrets";
-const DEFAULT_ACCOUNT_NAME_FOR_DEFAULT = "-default";
+const util_js_1 = require("./util.js");
+const DEFAULT_SERVICE_NAME = "-api-key";
+const DEFAULT_ACCOUNT_NAME_FOR_DEFAULT = "default";
 class KeyringStore extends base_js_1.BaseSecretStore {
     _impl = null;
     serviceName;
-    defaultAccount;
     _forceUnavailable;
+    _environmentChecked = false;
+    _environmentReady = false;
     constructor(options) {
         super();
         const { serviceName, forceKeytarUnavailable = false } = options;
         this.serviceName = `${serviceName}${DEFAULT_SERVICE_NAME}`;
-        this.defaultAccount = `${serviceName}${DEFAULT_ACCOUNT_NAME_FOR_DEFAULT}`;
         this._forceUnavailable = !!forceKeytarUnavailable;
     }
     async available() {
         if (this._forceUnavailable)
             return false;
+        // Check environment prerequisites before attempting to load the module
+        if (!this._environmentChecked) {
+            const { ready, reason } = (0, util_js_1.isKeyringEnvironmentReady)();
+            this._environmentReady = ready;
+            if (!ready) {
+                logger_js_1.logger.warn(`Keyring environment not ready: ${reason}`);
+            }
+            this._environmentChecked = true;
+        }
+        if (!this._environmentReady) {
+            return false;
+        }
         try {
             if (!this._impl) {
                 const module = await Promise.resolve().then(() => __importStar(require("@zowe/secrets-for-zowe-sdk")));
@@ -62,7 +76,8 @@ class KeyringStore extends base_js_1.BaseSecretStore {
                 typeof this._impl.setPassword === "function" &&
                 typeof this._impl.deletePassword === "function");
         }
-        catch {
+        catch (error) {
+            logger_js_1.logger.error(`Failed to load keyring: ${error.message}`);
             return false;
         }
     }
@@ -109,7 +124,9 @@ class KeyringStore extends base_js_1.BaseSecretStore {
         try {
             if (typeof this._impl.findCredentials === "function") {
                 const list = await this._impl.findCredentials(this.serviceName);
-                return Array.isArray(list) && list.length > 0 ? list : null;
+                return Array.isArray(list) && list.length > 0
+                    ? list.filter((c) => c.account !== DEFAULT_ACCOUNT_NAME_FOR_DEFAULT)
+                    : null;
             }
             return null;
         }
@@ -148,33 +165,21 @@ class KeyringStore extends base_js_1.BaseSecretStore {
             throw new Error("Keyring not available");
         if (!this._impl)
             throw new Error("Keyring not loaded");
-        const account = this.defaultAccount;
-        return this._impl.setPassword(account, account, JSON.stringify(value));
+        return this.setItem(DEFAULT_ACCOUNT_NAME_FOR_DEFAULT, value);
     }
     async getDefaultItem() {
         if (!(await this.available()))
             return null;
         if (!this._impl)
             return null;
-        const account = this.defaultAccount;
-        try {
-            const value = await this._impl.getPassword(account, account);
-            if (!value)
-                return null;
-            return this.parseKey(value);
-        }
-        catch {
-            // ignore
-        }
-        return null;
+        return this.getItem(DEFAULT_ACCOUNT_NAME_FOR_DEFAULT);
     }
     async deleteDefaultItem() {
         if (!(await this.available()))
             throw new Error("Keyring not available");
         if (!this._impl)
             throw new Error("Keyring not loaded");
-        const account = this.defaultAccount;
-        await this._impl.deletePassword(account, account);
+        await this.deleteItem(DEFAULT_ACCOUNT_NAME_FOR_DEFAULT);
     }
 }
 exports.KeyringStore = KeyringStore;

package/lib/cjs/util.d.ts

@@ -0,0 +1,4 @@
+export declare function isKeyringEnvironmentReady(): {
+    ready: boolean;
+    reason?: string;
+};

package/lib/cjs/util.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isKeyringEnvironmentReady = isKeyringEnvironmentReady;
+const node_fs_1 = require("node:fs");
+function isWSL() {
+    if (process.platform !== "linux")
+        return false;
+    // env checks
+    if (process.env.WSL_DISTRO_NAME || process.env.WSL_INTEROP)
+        return true;
+    try {
+        const v = (0, node_fs_1.readFileSync)("/proc/version", "utf8").toLowerCase();
+        if (v.includes("microsoft") || v.includes("wsl"))
+            return true;
+    }
+    catch { }
+    try {
+        const r = (0, node_fs_1.readFileSync)("/proc/sys/kernel/osrelease", "utf8").toLowerCase();
+        if (r.includes("microsoft") || r.includes("wsl"))
+            return true;
+    }
+    catch { }
+    // some WSL setups have /run/WSL or other hints
+    if ((0, node_fs_1.existsSync)("/run/WSL") || (0, node_fs_1.existsSync)("/run/WSL/"))
+        return true;
+    return false;
+}
+function isDBusAvailable() {
+    return !!process.env.DBUS_SESSION_BUS_ADDRESS;
+}
+function isDisplayAvailable() {
+    return !!(process.env.DISPLAY || process.env.WAYLAND_DISPLAY);
+}
+function isKeyringEnvironmentReady() {
+    if (process.platform === "win32")
+        return { ready: true };
+    if (process.platform === "darwin")
+        return { ready: true };
+    if (process.platform === "linux") {
+        if (!process.env.CI) {
+            if (isWSL()) {
+                return { ready: false, reason: "Detected WSL (no GNOME keyring by default)" };
+            }
+            // Check for D-Bus (required for libsecret)
+            if (!isDBusAvailable()) {
+                return { ready: false, reason: "D-Bus not available" };
+            }
+            // Check for display server (most keyring services need it)
+            if (!isDisplayAvailable()) {
+                return { ready: false, reason: "Display not available" };
+            }
+        }
+        return { ready: true };
+    }
+    // Unknown platform
+    return { ready: false, reason: `Unsupported platform: ${process.platform}` };
+}

package/lib/esm/keytar.d.ts

@@ -3,8 +3,9 @@ import type { CredentialEntry, ItemInfo, StoreOptions } from "./types.js";
 export declare class KeyringStore extends BaseSecretStore {
     private _impl;
     private serviceName;
-    private defaultAccount;
     private _forceUnavailable;
+    private _environmentChecked;
+    private _environmentReady;
     constructor(options: StoreOptions);
     available(): Promise<boolean>;
     setItem(key: string, value: ItemInfo): Promise<any>;

package/lib/esm/keytar.js

@@ -1,21 +1,35 @@
+import { logger } from "@aigne/core/utils/logger.js";
 import { BaseSecretStore } from "./base.js";
-const DEFAULT_SERVICE_NAME = "-secrets";
-const DEFAULT_ACCOUNT_NAME_FOR_DEFAULT = "-default";
+import { isKeyringEnvironmentReady } from "./util.js";
+const DEFAULT_SERVICE_NAME = "-api-key";
+const DEFAULT_ACCOUNT_NAME_FOR_DEFAULT = "default";
 export class KeyringStore extends BaseSecretStore {
     _impl = null;
     serviceName;
-    defaultAccount;
     _forceUnavailable;
+    _environmentChecked = false;
+    _environmentReady = false;
     constructor(options) {
         super();
         const { serviceName, forceKeytarUnavailable = false } = options;
         this.serviceName = `${serviceName}${DEFAULT_SERVICE_NAME}`;
-        this.defaultAccount = `${serviceName}${DEFAULT_ACCOUNT_NAME_FOR_DEFAULT}`;
         this._forceUnavailable = !!forceKeytarUnavailable;
     }
     async available() {
         if (this._forceUnavailable)
             return false;
+        // Check environment prerequisites before attempting to load the module
+        if (!this._environmentChecked) {
+            const { ready, reason } = isKeyringEnvironmentReady();
+            this._environmentReady = ready;
+            if (!ready) {
+                logger.warn(`Keyring environment not ready: ${reason}`);
+            }
+            this._environmentChecked = true;
+        }
+        if (!this._environmentReady) {
+            return false;
+        }
         try {
             if (!this._impl) {
                 const module = await import("@zowe/secrets-for-zowe-sdk");
@@ -26,7 +40,8 @@ export class KeyringStore extends BaseSecretStore {
                 typeof this._impl.setPassword === "function" &&
                 typeof this._impl.deletePassword === "function");
         }
-        catch {
+        catch (error) {
+            logger.error(`Failed to load keyring: ${error.message}`);
             return false;
         }
     }
@@ -73,7 +88,9 @@ export class KeyringStore extends BaseSecretStore {
         try {
             if (typeof this._impl.findCredentials === "function") {
                 const list = await this._impl.findCredentials(this.serviceName);
-                return Array.isArray(list) && list.length > 0 ? list : null;
+                return Array.isArray(list) && list.length > 0
+                    ? list.filter((c) => c.account !== DEFAULT_ACCOUNT_NAME_FOR_DEFAULT)
+                    : null;
             }
             return null;
         }
@@ -112,33 +129,21 @@ export class KeyringStore extends BaseSecretStore {
             throw new Error("Keyring not available");
         if (!this._impl)
             throw new Error("Keyring not loaded");
-        const account = this.defaultAccount;
-        return this._impl.setPassword(account, account, JSON.stringify(value));
+        return this.setItem(DEFAULT_ACCOUNT_NAME_FOR_DEFAULT, value);
     }
     async getDefaultItem() {
         if (!(await this.available()))
             return null;
         if (!this._impl)
             return null;
-        const account = this.defaultAccount;
-        try {
-            const value = await this._impl.getPassword(account, account);
-            if (!value)
-                return null;
-            return this.parseKey(value);
-        }
-        catch {
-            // ignore
-        }
-        return null;
+        return this.getItem(DEFAULT_ACCOUNT_NAME_FOR_DEFAULT);
     }
     async deleteDefaultItem() {
         if (!(await this.available()))
             throw new Error("Keyring not available");
         if (!this._impl)
             throw new Error("Keyring not loaded");
-        const account = this.defaultAccount;
-        await this._impl.deletePassword(account, account);
+        await this.deleteItem(DEFAULT_ACCOUNT_NAME_FOR_DEFAULT);
     }
 }
 export default KeyringStore;

package/lib/esm/util.d.ts

@@ -0,0 +1,4 @@
+export declare function isKeyringEnvironmentReady(): {
+    ready: boolean;
+    reason?: string;
+};

package/lib/esm/util.js

@@ -0,0 +1,54 @@
+import { existsSync, readFileSync } from "node:fs";
+function isWSL() {
+    if (process.platform !== "linux")
+        return false;
+    // env checks
+    if (process.env.WSL_DISTRO_NAME || process.env.WSL_INTEROP)
+        return true;
+    try {
+        const v = readFileSync("/proc/version", "utf8").toLowerCase();
+        if (v.includes("microsoft") || v.includes("wsl"))
+            return true;
+    }
+    catch { }
+    try {
+        const r = readFileSync("/proc/sys/kernel/osrelease", "utf8").toLowerCase();
+        if (r.includes("microsoft") || r.includes("wsl"))
+            return true;
+    }
+    catch { }
+    // some WSL setups have /run/WSL or other hints
+    if (existsSync("/run/WSL") || existsSync("/run/WSL/"))
+        return true;
+    return false;
+}
+function isDBusAvailable() {
+    return !!process.env.DBUS_SESSION_BUS_ADDRESS;
+}
+function isDisplayAvailable() {
+    return !!(process.env.DISPLAY || process.env.WAYLAND_DISPLAY);
+}
+export function isKeyringEnvironmentReady() {
+    if (process.platform === "win32")
+        return { ready: true };
+    if (process.platform === "darwin")
+        return { ready: true };
+    if (process.platform === "linux") {
+        if (!process.env.CI) {
+            if (isWSL()) {
+                return { ready: false, reason: "Detected WSL (no GNOME keyring by default)" };
+            }
+            // Check for D-Bus (required for libsecret)
+            if (!isDBusAvailable()) {
+                return { ready: false, reason: "D-Bus not available" };
+            }
+            // Check for display server (most keyring services need it)
+            if (!isDisplayAvailable()) {
+                return { ready: false, reason: "Display not available" };
+            }
+        }
+        return { ready: true };
+    }
+    // Unknown platform
+    return { ready: false, reason: `Unsupported platform: ${process.platform}` };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/secrets",
-  "version": "0.1.1-beta.1",
+  "version": "0.1.1-beta.3",
   "description": "Secure credential storage for AIGNE Hub API keys with system keyring and file-based fallback",
   "publishConfig": {
     "access": "public"
@@ -44,6 +44,7 @@
     }
   },
   "dependencies": {
+    "@aigne/core": "^1.69.0",
     "@zowe/secrets-for-zowe-sdk": "^8.29.4",
     "yaml": "^2.8.1"
   },