@inkeep/agents-core 0.0.0-dev-20260122153611 → 0.0.0-dev-20260122190953

package/dist/credential-stores/keychain-store.d.ts

@@ -10,16 +10,16 @@ import { CredentialStore } from "../types/server.js";
  * - Windows: Credential Vault
  * - Linux: Secret Service API/libsecret
  *
- * Requires the 'keytar' npm package to be installed.
- * Falls back gracefully if keytar is not available.
+ * Requires the '@napi-rs/keyring' npm package to be installed.
+ * Falls back gracefully if keyring is not available.
  *
  * ## macOS Permission Handling
  *
- * On macOS, when your Node.js app first calls keytar operations:
+ * On macOS, when your Node.js app first calls keyring operations:
  * - `setPassword()` creates a new Keychain item (no prompt required)
  * - `getPassword()` may prompt the user for permission on first access
  * - Users can click "Allow", "Always Allow", or "Deny"
- * - If denied, keytar returns `null` which this implementation handles gracefully
+ * - If denied, keyring returns `null` which this implementation handles gracefully
  * - The calling binary (usually `node`) will be shown in the permission prompt
  * - For better UX in packaged apps, consider code signing and app bundling
  *
@@ -33,14 +33,22 @@ declare class KeyChainStore implements CredentialStore {
   readonly type: "keychain";
   private readonly service;
   private readonly logger;
-  private keytarAvailable;
-  private keytar;
+  private keyringAvailable;
+  private EntryClass;
   private initializationPromise;
   constructor(id: string, servicePrefix?: string);
   /**
-   * Initialize keytar dynamically to handle optional availability
+   * Initialize keyring dynamically to handle optional availability
    */
-  private initializeKeytar;
+  private initializeKeyring;
+  /**
+   * Add a key to the index
+   */
+  private addKeyToIndex;
+  /**
+   * Remove a key from the index
+   */
+  private removeKeyFromIndex;
   /**
    * Get a credential from the keychain
    */
@@ -68,6 +76,10 @@ declare class KeyChainStore implements CredentialStore {
   /**
    * Find all credentials for this service
    * Useful for debugging and listing stored credentials
+   *
+   * NOTE: @napi-rs/keyring does not have a findCredentials equivalent.
+   * This implementation uses a key index to track all stored keys.
+   * The index is maintained separately and updated during set/delete operations.
    */
   findAllCredentials(): Promise<Array<{
     account: string;

package/dist/credential-stores/keychain-store.js

@@ -10,16 +10,16 @@ import { getLogger } from "../utils/logger.js";
 * - Windows: Credential Vault
 * - Linux: Secret Service API/libsecret
 *
-* Requires the 'keytar' npm package to be installed.
-* Falls back gracefully if keytar is not available.
+* Requires the '@napi-rs/keyring' npm package to be installed.
+* Falls back gracefully if keyring is not available.
 *
 * ## macOS Permission Handling
 *
-* On macOS, when your Node.js app first calls keytar operations:
+* On macOS, when your Node.js app first calls keyring operations:
 * - `setPassword()` creates a new Keychain item (no prompt required)
 * - `getPassword()` may prompt the user for permission on first access
 * - Users can click "Allow", "Always Allow", or "Deny"
-* - If denied, keytar returns `null` which this implementation handles gracefully
+* - If denied, keyring returns `null` which this implementation handles gracefully
 * - The calling binary (usually `node`) will be shown in the permission prompt
 * - For better UX in packaged apps, consider code signing and app bundling
 *
@@ -33,34 +33,75 @@ var KeyChainStore = class {
 	type = CredentialStoreType.keychain;
 	service;
 	logger = getLogger("KeyChainStore");
-	keytarAvailable = false;
-	keytar = null;
+	keyringAvailable = false;
+	EntryClass = null;
 	initializationPromise;
 	constructor(id, servicePrefix = "inkeep-agent-framework") {
 		this.id = id;
 		this.service = `${servicePrefix}-${id}`;
-		this.initializationPromise = this.initializeKeytar();
+		this.initializationPromise = this.initializeKeyring();
 	}
 	/**
-	* Initialize keytar dynamically to handle optional availability
+	* Initialize keyring dynamically to handle optional availability
 	*/
-	async initializeKeytar() {
-		if (this.keytar) {
-			this.keytarAvailable = true;
+	async initializeKeyring() {
+		if (this.EntryClass) {
+			this.keyringAvailable = true;
 			return;
 		}
 		try {
-			this.keytar = (await import(
+			this.EntryClass = (await import(
 				/* webpackIgnore: true */
-				"keytar"
-)).default;
-			this.keytarAvailable = true;
+				"@napi-rs/keyring"
+)).Entry;
+			this.keyringAvailable = true;
 		} catch (error) {
 			this.logger.warn({
 				storeId: this.id,
 				error: error instanceof Error ? error.message : "Unknown error"
-			}, "Keytar not available - KeyChainStore will return null for all operations");
-			this.keytarAvailable = false;
+			}, "Keyring not available - KeyChainStore will return null for all operations");
+			this.keyringAvailable = false;
+		}
+	}
+	/**
+	* Add a key to the index
+	*/
+	addKeyToIndex(key) {
+		if (!this.EntryClass) return;
+		try {
+			const indexEntry = new this.EntryClass(this.service, "__key_index__");
+			const indexJson = indexEntry.getPassword();
+			const keys = indexJson ? JSON.parse(indexJson) : [];
+			if (!keys.includes(key)) {
+				keys.push(key);
+				indexEntry.setPassword(JSON.stringify(keys));
+			}
+		} catch (error) {
+			this.logger.warn({
+				storeId: this.id,
+				key,
+				error: error instanceof Error ? error.message : "Unknown error"
+			}, "Failed to update key index");
+		}
+	}
+	/**
+	* Remove a key from the index
+	*/
+	removeKeyFromIndex(key) {
+		if (!this.EntryClass) return;
+		try {
+			const indexEntry = new this.EntryClass(this.service, "__key_index__");
+			const indexJson = indexEntry.getPassword();
+			if (!indexJson) return;
+			const keys = JSON.parse(indexJson);
+			const filteredKeys = keys.filter((k) => k !== key);
+			if (filteredKeys.length !== keys.length) indexEntry.setPassword(JSON.stringify(filteredKeys));
+		} catch (error) {
+			this.logger.warn({
+				storeId: this.id,
+				key,
+				error: error instanceof Error ? error.message : "Unknown error"
+			}, "Failed to update key index");
 		}
 	}
 	/**
@@ -68,20 +109,23 @@ var KeyChainStore = class {
 	*/
 	async get(key) {
 		await this.initializationPromise;
-		if (!this.keytarAvailable || !this.keytar) {
+		if (!this.keyringAvailable || !this.EntryClass) {
 			this.logger.debug({
 				storeId: this.id,
 				key
-			}, "Keytar not available, returning null");
+			}, "Keyring not available, returning null");
 			return null;
 		}
 		try {
-			const password = await this.keytar.getPassword(this.service, key);
-			if (password === null) this.logger.debug({
-				storeId: this.id,
-				service: this.service,
-				account: key
-			}, "No credential found in keychain");
+			const password = new this.EntryClass(this.service, key).getPassword();
+			if (password === null || password === void 0) {
+				this.logger.debug({
+					storeId: this.id,
+					service: this.service,
+					account: key
+				}, "No credential found in keychain");
+				return null;
+			}
 			return password;
 		} catch (error) {
 			this.logger.error({
@@ -98,15 +142,16 @@ var KeyChainStore = class {
 	*/
 	async set(key, value, _metadata) {
 		await this.initializationPromise;
-		if (!this.keytarAvailable || !this.keytar) {
+		if (!this.keyringAvailable || !this.EntryClass) {
 			this.logger.warn({
 				storeId: this.id,
 				key
-			}, "Keytar not available, cannot set credential");
-			throw new Error("Keytar not available - cannot store credentials in system keychain");
+			}, "Keyring not available, cannot set credential");
+			throw new Error("Keyring not available - cannot store credentials in system keychain");
 		}
 		try {
-			await this.keytar.setPassword(this.service, key, value);
+			new this.EntryClass(this.service, key).setPassword(value);
+			this.addKeyToIndex(key);
 			this.logger.debug({
 				storeId: this.id,
 				service: this.service,
@@ -133,9 +178,9 @@ var KeyChainStore = class {
 	*/
 	async checkAvailability() {
 		await this.initializationPromise;
-		if (!this.keytarAvailable || !this.keytar) return {
+		if (!this.keyringAvailable || !this.EntryClass) return {
 			available: false,
-			reason: "Keytar not available - cannot store credentials in system keychain"
+			reason: "Keyring not available - cannot store credentials in system keychain"
 		};
 		return { available: true };
 	}
@@ -144,26 +189,22 @@ var KeyChainStore = class {
 	*/
 	async delete(key) {
 		await this.initializationPromise;
-		if (!this.keytarAvailable || !this.keytar) {
+		if (!this.keyringAvailable || !this.EntryClass) {
 			this.logger.warn({
 				storeId: this.id,
 				key
-			}, "Keytar not available, cannot delete credential");
+			}, "Keyring not available, cannot delete credential");
 			return false;
 		}
 		try {
-			const result = await this.keytar.deletePassword(this.service, key);
-			if (result) this.logger.debug({
+			new this.EntryClass(this.service, key).deletePassword();
+			this.removeKeyFromIndex(key);
+			this.logger.debug({
 				storeId: this.id,
 				service: this.service,
 				account: key
 			}, "Credential deleted from keychain");
-			else this.logger.debug({
-				storeId: this.id,
-				service: this.service,
-				account: key
-			}, "Credential not found in keychain for deletion");
-			return result;
+			return true;
 		} catch (error) {
 			this.logger.error({
 				storeId: this.id,
@@ -177,12 +218,29 @@ var KeyChainStore = class {
 	/**
 	* Find all credentials for this service
 	* Useful for debugging and listing stored credentials
+	*
+	* NOTE: @napi-rs/keyring does not have a findCredentials equivalent.
+	* This implementation uses a key index to track all stored keys.
+	* The index is maintained separately and updated during set/delete operations.
 	*/
 	async findAllCredentials() {
 		await this.initializationPromise;
-		if (!this.keytarAvailable || !this.keytar) return [];
+		if (!this.keyringAvailable || !this.EntryClass) return [];
 		try {
-			return await this.keytar.findCredentials(this.service) || [];
+			const indexJson = new this.EntryClass(this.service, "__key_index__").getPassword();
+			if (!indexJson) return [];
+			const keys = JSON.parse(indexJson);
+			const credentials = [];
+			for (const key of keys) try {
+				const password = new this.EntryClass(this.service, key).getPassword();
+				if (password) credentials.push({
+					account: key,
+					password
+				});
+			} catch {
+				continue;
+			}
+			return credentials;
 		} catch (error) {
 			this.logger.error({
 				storeId: this.id,
@@ -200,6 +258,14 @@ var KeyChainStore = class {
 		const credentials = await this.findAllCredentials();
 		let deletedCount = 0;
 		for (const cred of credentials) if (await this.delete(cred.account)) deletedCount++;
+		if (this.EntryClass && deletedCount > 0) try {
+			new this.EntryClass(this.service, "__key_index__").deletePassword();
+		} catch (error) {
+			this.logger.warn({
+				storeId: this.id,
+				error: error instanceof Error ? error.message : "Unknown error"
+			}, "Failed to delete key index");
+		}
 		if (deletedCount > 0) this.logger.info({
 			storeId: this.id,
 			service: this.service,

package/dist/data-access/manage/agents.d.ts

@@ -8,14 +8,15 @@ import { PgTable } from "drizzle-orm/pg-core";
 declare const getAgentById: (db: AgentsManageDatabaseClient) => (params: {
   scopes: AgentScopeConfig;
 }) => Promise<{
-  tenantId: string;
-  projectId: string;
   id: string;
   name: string;
-  description: string | null;
-  prompt: string | null;
   createdAt: string;
   updatedAt: string;
+  description: string | null;
+  projectId: string;
+  tenantId: string;
+  defaultSubAgentId: string | null;
+  contextConfigId: string | null;
   models: {
     base?: {
       model?: string | undefined;
@@ -30,11 +31,7 @@ declare const getAgentById: (db: AgentsManageDatabaseClient) => (params: {
       providerOptions?: Record<string, any> | undefined;
     } | undefined;
   } | null;
-  stopWhen: {
-    transferCountIs?: number | undefined;
-  } | null;
-  defaultSubAgentId: string | null;
-  contextConfigId: string | null;
+  prompt: string | null;
   statusUpdates: {
     enabled?: boolean | undefined;
     numEvents?: number | undefined;
@@ -50,18 +47,22 @@ declare const getAgentById: (db: AgentsManageDatabaseClient) => (params: {
       } | undefined;
     }[] | undefined;
   } | null;
+  stopWhen: {
+    transferCountIs?: number | undefined;
+  } | null;
 } | null>;
 declare const getAgentWithDefaultSubAgent: (db: AgentsManageDatabaseClient) => (params: {
   scopes: AgentScopeConfig;
 }) => Promise<{
-  tenantId: string;
-  projectId: string;
   id: string;
   name: string;
-  description: string | null;
-  prompt: string | null;
   createdAt: string;
   updatedAt: string;
+  description: string | null;
+  projectId: string;
+  tenantId: string;
+  defaultSubAgentId: string | null;
+  contextConfigId: string | null;
   models: {
     base?: {
       model?: string | undefined;
@@ -76,11 +77,7 @@ declare const getAgentWithDefaultSubAgent: (db: AgentsManageDatabaseClient) => (
       providerOptions?: Record<string, any> | undefined;
     } | undefined;
   } | null;
-  stopWhen: {
-    transferCountIs?: number | undefined;
-  } | null;
-  defaultSubAgentId: string | null;
-  contextConfigId: string | null;
+  prompt: string | null;
   statusUpdates: {
     enabled?: boolean | undefined;
     numEvents?: number | undefined;
@@ -96,16 +93,18 @@ declare const getAgentWithDefaultSubAgent: (db: AgentsManageDatabaseClient) => (
       } | undefined;
     }[] | undefined;
   } | null;
+  stopWhen: {
+    transferCountIs?: number | undefined;
+  } | null;
   defaultSubAgent: {
-    tenantId: string;
-    projectId: string;
     id: string;
     name: string;
-    description: string | null;
-    prompt: string | null;
-    agentId: string;
     createdAt: string;
     updatedAt: string;
+    description: string | null;
+    agentId: string;
+    projectId: string;
+    tenantId: string;
     models: {
       base?: {
         model?: string | undefined;
@@ -120,6 +119,7 @@ declare const getAgentWithDefaultSubAgent: (db: AgentsManageDatabaseClient) => (
         providerOptions?: Record<string, any> | undefined;
       } | undefined;
     } | null;
+    prompt: string | null;
     stopWhen: {
       stepCountIs?: number | undefined;
     } | null;
@@ -129,14 +129,15 @@ declare const getAgentWithDefaultSubAgent: (db: AgentsManageDatabaseClient) => (
 declare const listAgents: (db: AgentsManageDatabaseClient) => (params: {
   scopes: ProjectScopeConfig;
 }) => Promise<{
-  tenantId: string;
-  projectId: string;
   id: string;
   name: string;
-  description: string | null;
-  prompt: string | null;
   createdAt: string;
   updatedAt: string;
+  description: string | null;
+  projectId: string;
+  tenantId: string;
+  defaultSubAgentId: string | null;
+  contextConfigId: string | null;
   models: {
     base?: {
       model?: string | undefined;
@@ -151,11 +152,7 @@ declare const listAgents: (db: AgentsManageDatabaseClient) => (params: {
       providerOptions?: Record<string, any> | undefined;
     } | undefined;
   } | null;
-  stopWhen: {
-    transferCountIs?: number | undefined;
-  } | null;
-  defaultSubAgentId: string | null;
-  contextConfigId: string | null;
+  prompt: string | null;
   statusUpdates: {
     enabled?: boolean | undefined;
     numEvents?: number | undefined;
@@ -171,6 +168,9 @@ declare const listAgents: (db: AgentsManageDatabaseClient) => (params: {
       } | undefined;
     }[] | undefined;
   } | null;
+  stopWhen: {
+    transferCountIs?: number | undefined;
+  } | null;
 }[]>;
 declare const listAgentsPaginated: (db: AgentsManageDatabaseClient) => (params: {
   scopes: ProjectScopeConfig;
@@ -228,14 +228,15 @@ declare const listAgentsPaginated: (db: AgentsManageDatabaseClient) => (params:
   };
 }>;
 declare const createAgent: (db: AgentsManageDatabaseClient) => (data: AgentInsert) => Promise<{
-  tenantId: string;
-  projectId: string;
   id: string;
   name: string;
-  description: string | null;
-  prompt: string | null;
   createdAt: string;
   updatedAt: string;
+  description: string | null;
+  projectId: string;
+  tenantId: string;
+  defaultSubAgentId: string | null;
+  contextConfigId: string | null;
   models: {
     base?: {
       model?: string | undefined;
@@ -250,11 +251,7 @@ declare const createAgent: (db: AgentsManageDatabaseClient) => (data: AgentInser
       providerOptions?: Record<string, any> | undefined;
     } | undefined;
   } | null;
-  stopWhen: {
-    transferCountIs?: number | undefined;
-  } | null;
-  defaultSubAgentId: string | null;
-  contextConfigId: string | null;
+  prompt: string | null;
   statusUpdates: {
     enabled?: boolean | undefined;
     numEvents?: number | undefined;
@@ -270,6 +267,9 @@ declare const createAgent: (db: AgentsManageDatabaseClient) => (data: AgentInser
       } | undefined;
     }[] | undefined;
   } | null;
+  stopWhen: {
+    transferCountIs?: number | undefined;
+  } | null;
 }>;
 declare const updateAgent: (db: AgentsManageDatabaseClient) => (params: {
   scopes: AgentScopeConfig;

package/dist/data-access/manage/artifactComponents.d.ts

@@ -7,13 +7,13 @@ declare const getArtifactComponentById: (db: AgentsManageDatabaseClient) => (par
   scopes: ProjectScopeConfig;
   id: string;
 }) => Promise<{
-  tenantId: string;
-  projectId: string;
   id: string;
   name: string;
-  description: string | null;
   createdAt: string;
   updatedAt: string;
+  description: string | null;
+  projectId: string;
+  tenantId: string;
   props: Record<string, unknown> | null;
   render: {
     component: string;
@@ -49,13 +49,13 @@ declare const listArtifactComponentsPaginated: (db: AgentsManageDatabaseClient)
   };
 }>;
 declare const createArtifactComponent: (db: AgentsManageDatabaseClient) => (params: ArtifactComponentInsert) => Promise<{
-  tenantId: string;
-  projectId: string;
   id: string;
   name: string;
-  description: string | null;
   createdAt: string;
   updatedAt: string;
+  description: string | null;
+  projectId: string;
+  tenantId: string;
   props: Record<string, unknown> | null;
   render: {
     component: string;
@@ -104,11 +104,11 @@ declare const associateArtifactComponentWithAgent: (db: AgentsManageDatabaseClie
   scopes: SubAgentScopeConfig;
   artifactComponentId: string;
 }) => Promise<{
-  tenantId: string;
-  projectId: string;
   id: string;
-  agentId: string;
   createdAt: string;
+  agentId: string;
+  projectId: string;
+  tenantId: string;
   subAgentId: string;
   artifactComponentId: string;
 }>;
@@ -147,11 +147,11 @@ declare const upsertAgentArtifactComponentRelation: (db: AgentsManageDatabaseCli
   scopes: SubAgentScopeConfig;
   artifactComponentId: string;
 }) => Promise<{
-  tenantId: string;
-  projectId: string;
   id: string;
-  agentId: string;
   createdAt: string;
+  agentId: string;
+  projectId: string;
+  tenantId: string;
   subAgentId: string;
   artifactComponentId: string;
 } | null>;

package/dist/data-access/manage/contextConfigs.d.ts

@@ -8,26 +8,26 @@ declare const getContextConfigById: (db: AgentsManageDatabaseClient) => (params:
   scopes: AgentScopeConfig;
   id: string;
 }) => Promise<{
-  tenantId: string;
-  projectId: string;
   id: string;
-  agentId: string;
   createdAt: string;
   updatedAt: string;
   headersSchema: unknown;
   contextVariables: Record<string, ContextFetchDefinition> | null;
+  agentId: string;
+  projectId: string;
+  tenantId: string;
 } | undefined>;
 declare const listContextConfigs: (db: AgentsManageDatabaseClient) => (params: {
   scopes: AgentScopeConfig;
 }) => Promise<{
-  tenantId: string;
-  projectId: string;
   id: string;
-  agentId: string;
   createdAt: string;
   updatedAt: string;
   headersSchema: unknown;
   contextVariables: Record<string, ContextFetchDefinition> | null;
+  agentId: string;
+  projectId: string;
+  tenantId: string;
 }[]>;
 declare const listContextConfigsPaginated: (db: AgentsManageDatabaseClient) => (params: {
   scopes: AgentScopeConfig;
@@ -42,14 +42,14 @@ declare const listContextConfigsPaginated: (db: AgentsManageDatabaseClient) => (
   };
 }>;
 declare const createContextConfig: (db: AgentsManageDatabaseClient) => (params: ContextConfigInsert) => Promise<{
-  tenantId: string;
-  projectId: string;
   id: string;
-  agentId: string;
   createdAt: string;
   updatedAt: string;
   headersSchema: unknown;
   contextVariables: Record<string, ContextFetchDefinition> | null;
+  agentId: string;
+  projectId: string;
+  tenantId: string;
 }>;
 declare const updateContextConfig: (db: AgentsManageDatabaseClient) => (params: {
   scopes: AgentScopeConfig;
@@ -82,14 +82,14 @@ declare const countContextConfigs: (db: AgentsManageDatabaseClient) => (params:
 declare const upsertContextConfig: (db: AgentsManageDatabaseClient) => (params: {
   data: ContextConfigInsert;
 }) => Promise<{
-  tenantId: string;
-  projectId: string;
   id: string;
-  agentId: string;
   createdAt: string;
   updatedAt: string;
   headersSchema: unknown;
   contextVariables: Record<string, ContextFetchDefinition> | null;
+  agentId: string;
+  projectId: string;
+  tenantId: string;
 }>;
 //#endregion
 export { countContextConfigs, createContextConfig, deleteContextConfig, getContextConfigById, hasContextConfig, listContextConfigs, listContextConfigsPaginated, updateContextConfig, upsertContextConfig };

package/dist/data-access/manage/dataComponents.d.ts

@@ -64,11 +64,11 @@ declare const associateDataComponentWithAgent: (db: AgentsManageDatabaseClient)
   scopes: SubAgentScopeConfig;
   dataComponentId: string;
 }) => Promise<{
-  tenantId: string;
-  projectId: string;
   id: string;
-  agentId: string;
   createdAt: string;
+  agentId: string;
+  projectId: string;
+  tenantId: string;
   subAgentId: string;
   dataComponentId: string;
 }>;
@@ -106,11 +106,11 @@ declare const upsertAgentDataComponentRelation: (db: AgentsManageDatabaseClient)
   scopes: SubAgentScopeConfig;
   dataComponentId: string;
 }) => Promise<{
-  tenantId: string;
-  projectId: string;
   id: string;
-  agentId: string;
   createdAt: string;
+  agentId: string;
+  projectId: string;
+  tenantId: string;
   subAgentId: string;
   dataComponentId: string;
 } | null>;