@oobe-protocol-labs/sap-mcp-server 0.9.2 → 0.9.3

package/dist/server/register-capabilities.js

@@ -1,12 +1,27 @@
 /**
- * Register MCP server capabilities (tools, resources, prompts)
+ * @name server/register-capabilities
+ * @description Registers all MCP server capabilities (tools, resources, and prompts) on the server instance.
+ *
+ * @flow
+ *   1. Registers SAP Protocol, Synapse AgentKit, network, and transaction tools via `registerTools`.
+ *   2. Registers on-chain resources via `registerResources`.
+ *   3. Registers interactive prompts via `registerPrompts`.
+ *
+ * @module server/register-capabilities
  */
 import { registerTools } from '../tools/register-tools.js';
 import { registerResources } from '../resources/register-resources.js';
 import { registerPrompts } from '../prompts/register-prompts.js';
 import { logger } from '../core/logger.js';
 /**
- * Register all server capabilities
+ * @name registerCapabilities
+ * @description Registers all tools, resources, and prompts on the MCP server.
+ *
+ * @param server  — The MCP `Server` instance to register capabilities on.
+ * @param context — SAP MCP runtime context shared by all capability handlers.
+ * @throws If any registration sub-call fails.
+ *
+ * @usedBy `create-server.ts:createSapMcpServer`.
  */
 export async function registerCapabilities(server, context) {
     logger.debug('Registering server capabilities');

package/dist/server/register-capabilities.js.map

@@ -1 +1 @@
-{"version":3,"file":"register-capabilities.js","sourceRoot":"","sources":["../../src/server/register-capabilities.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,MAAc,EACd,OAAsB;IAEtB,MAAM,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAEhD,2EAA2E;IAC3E,MAAM,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAE9C,qBAAqB;IACrB,MAAM,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAErC,mBAAmB;IACnB,MAAM,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;AACrC,CAAC"}
+{"version":3,"file":"register-capabilities.js","sourceRoot":"","sources":["../../src/server/register-capabilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAIH,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,MAAc,EACd,OAAsB;IAEtB,MAAM,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAEhD,2EAA2E;IAC3E,MAAM,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAE9C,qBAAqB;IACrB,MAAM,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAErC,mBAAmB;IACnB,MAAM,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;AACrC,CAAC"}

package/dist/server/server-metadata.d.ts

@@ -1,3 +1,29 @@
+/**
+ * @name server/server-metadata
+ * @description Static server metadata and capability counts for the SAP MCP server.
+ *
+ * Provides the package-level metadata (name, version, author, license, repository)
+ * and a summary of registered capability counts by category.
+ *
+ * @module server/server-metadata
+ */
+/**
+ * @name SERVER_METADATA
+ * @description Static metadata describing the SAP MCP server package.
+ *
+ * @property name        — Server identifier name.
+ * @property title       — Human-readable server title.
+ * @property version     — Semver version string.
+ * @property description — Server description for MCP clients.
+ * @property author      — Author or organization name.
+ * @property license     — SPDX license identifier.
+ * @property homepage    — Homepage URL.
+ * @property repository  — Source code repository URL.
+ * @property bugs        — Issue tracker URL.
+ * @property icon        — Icon URL for MCP client display.
+ *
+ * @usedBy `server/index.ts`, health and info endpoints.
+ */
 export declare const SERVER_METADATA: {
     name: string;
     title: string;
@@ -11,7 +37,13 @@ export declare const SERVER_METADATA: {
     icon: string;
 };
 /**
- * Shared capabilities definition used by the SAP MCP runtime.
+ * @name CAPABILITIES
+ * @description Summary of registered MCP capabilities and their category counts.
+ *
+ * @property tools.count       — Total number of registered tools.
+ * @property tools.categories  — Tool counts by category (sap, sns, agentKit, etc.).
+ *
+ * @usedBy `server/index.ts`, monitoring and health endpoints.
  */
 export declare const CAPABILITIES: {
     tools: {
@@ -26,6 +58,8 @@ export declare const CAPABILITIES: {
             profiles: number;
             skills: number;
             chat: number;
+            premium: number;
+            quickContext: number;
         };
     };
 };

package/dist/server/server-metadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server-metadata.d.ts","sourceRoot":"","sources":["../../src/server/server-metadata.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,eAAe;;;;;;;;;;;CAW3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;CAexB,CAAC"}
+{"version":3,"file":"server-metadata.d.ts","sourceRoot":"","sources":["../../src/server/server-metadata.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAWH;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;CAW3B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;CAiBxB,CAAC"}

package/dist/server/server-metadata.js

@@ -1,4 +1,30 @@
+/**
+ * @name server/server-metadata
+ * @description Static server metadata and capability counts for the SAP MCP server.
+ *
+ * Provides the package-level metadata (name, version, author, license, repository)
+ * and a summary of registered capability counts by category.
+ *
+ * @module server/server-metadata
+ */
 import { MCP_SERVER_DESCRIPTION, MCP_SERVER_ICON_URL, MCP_SERVER_NAME, MCP_SERVER_TITLE, MCP_SERVER_VERSION, MCP_SERVER_WEBSITE_URL, } from '../core/constants.js';
+/**
+ * @name SERVER_METADATA
+ * @description Static metadata describing the SAP MCP server package.
+ *
+ * @property name        — Server identifier name.
+ * @property title       — Human-readable server title.
+ * @property version     — Semver version string.
+ * @property description — Server description for MCP clients.
+ * @property author      — Author or organization name.
+ * @property license     — SPDX license identifier.
+ * @property homepage    — Homepage URL.
+ * @property repository  — Source code repository URL.
+ * @property bugs        — Issue tracker URL.
+ * @property icon        — Icon URL for MCP client display.
+ *
+ * @usedBy `server/index.ts`, health and info endpoints.
+ */
 export const SERVER_METADATA = {
     name: MCP_SERVER_NAME,
     title: MCP_SERVER_TITLE,
@@ -12,11 +38,17 @@ export const SERVER_METADATA = {
     icon: MCP_SERVER_ICON_URL,
 };
 /**
- * Shared capabilities definition used by the SAP MCP runtime.
+ * @name CAPABILITIES
+ * @description Summary of registered MCP capabilities and their category counts.
+ *
+ * @property tools.count       — Total number of registered tools.
+ * @property tools.categories  — Tool counts by category (sap, sns, agentKit, etc.).
+ *
+ * @usedBy `server/index.ts`, monitoring and health endpoints.
  */
 export const CAPABILITIES = {
     tools: {
-        count: 248,
+        count: 336,
         categories: {
             sap: 75,
             sns: 13,
@@ -27,6 +59,8 @@ export const CAPABILITIES = {
             profiles: 4,
             skills: 3,
             chat: 8,
+            premium: 17,
+            quickContext: 1,
         },
     },
 };

package/dist/server/server-metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"server-metadata.js","sourceRoot":"","sources":["../../src/server/server-metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE,eAAe;IACrB,KAAK,EAAE,gBAAgB;IACvB,OAAO,EAAE,kBAAkB;IAC3B,WAAW,EAAE,sBAAsB;IACnC,MAAM,EAAE,oBAAoB;IAC5B,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,sBAAsB;IAChC,UAAU,EAAE,0CAA0C;IACtD,IAAI,EAAE,iDAAiD;IACvD,IAAI,EAAE,mBAAmB;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,KAAK,EAAE;QACL,KAAK,EAAE,GAAG;QACV,UAAU,EAAE;YACV,GAAG,EAAE,EAAE;YACP,GAAG,EAAE,EAAE;YACP,QAAQ,EAAE,GAAG;YACb,gBAAgB,EAAE,CAAC;YACnB,YAAY,EAAE,CAAC;YACf,YAAY,EAAE,CAAC;YACf,QAAQ,EAAE,CAAC;YACX,MAAM,EAAE,CAAC;YACT,IAAI,EAAE,CAAC;SACR;KACF;CACF,CAAC"}
+{"version":3,"file":"server-metadata.js","sourceRoot":"","sources":["../../src/server/server-metadata.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EACL,sBAAsB,EACtB,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,sBAAsB,CAAC;AAE9B;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE,eAAe;IACrB,KAAK,EAAE,gBAAgB;IACvB,OAAO,EAAE,kBAAkB;IAC3B,WAAW,EAAE,sBAAsB;IACnC,MAAM,EAAE,oBAAoB;IAC5B,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,sBAAsB;IAChC,UAAU,EAAE,0CAA0C;IACtD,IAAI,EAAE,iDAAiD;IACvD,IAAI,EAAE,mBAAmB;CAC1B,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,KAAK,EAAE;QACL,KAAK,EAAE,GAAG;QACV,UAAU,EAAE;YACV,GAAG,EAAE,EAAE;YACP,GAAG,EAAE,EAAE;YACP,QAAQ,EAAE,GAAG;YACb,gBAAgB,EAAE,CAAC;YACnB,YAAY,EAAE,CAAC;YACf,YAAY,EAAE,CAAC;YACf,QAAQ,EAAE,CAAC;YACX,MAAM,EAAE,CAAC;YACT,IAAI,EAAE,CAAC;YACP,OAAO,EAAE,EAAE;YACX,YAAY,EAAE,CAAC;SAChB;KACF;CACF,CAAC"}

package/dist/session/agent-session.d.ts

@@ -1,9 +1,27 @@
 /**
- * Agent session management
+ * @name session/agent-session
+ * @description Agent session lifecycle management — creation, activation checks, and permission checks.
+ *
+ * @flow
+ *   1. `createAgentSession` generates a new session with a UUID, filtered permissions,
+ *      spending limits, and a 24-hour expiry.
+ *   2. `isSessionActive` checks whether a session is still within its expiry and budget.
+ *   3. `hasPermission` checks whether a session holds a specific permission.
+ *
+ * @module session/agent-session
  */
 import type { SapAgentSession, SapPermission } from '../core/types.js';
 /**
- * Create a new agent session
+ * @name createAgentSession
+ * @description Creates a new agent session with a unique id, filtered permissions, spending limits, and 24-hour expiry.
+ *
+ * @param data.agentId        — Unique identifier for the agent.
+ * @param data.permissions    — Array of permission strings (invalid ones are filtered out).
+ * @param data.spendingLimits — Spending limits for per-transaction, per-day, and per-session SOL amounts.
+ * @returns A `SapAgentSession` object with a generated `sessionId`, filtered permissions,
+ *          remaining session balance set to `maxPerSessionSol`, and 24-hour expiry.
+ *
+ * @usedBy `delegated-session.ts:createDelegatedSession`.
  */
 export declare function createAgentSession(data: {
     agentId: string;
@@ -15,11 +33,24 @@ export declare function createAgentSession(data: {
     };
 }): SapAgentSession;
 /**
- * Validate session is still active
+ * @name isSessionActive
+ * @description Checks whether a session is still active (not expired and has remaining budget).
+ *
+ * @param session — The agent session to check.
+ * @returns `true` if the current time is before `expiresAt` and `remainingSessionSol > 0`, `false` otherwise.
+ *
+ * @usedBy Session validation across the SAP MCP runtime.
  */
 export declare function isSessionActive(session: SapAgentSession): boolean;
 /**
- * Check if session has permission
+ * @name hasPermission
+ * @description Checks whether a session holds a specific permission.
+ *
+ * @param session    — The agent session to check.
+ * @param permission — The permission string to verify.
+ * @returns `true` if the session's permissions array includes the given permission, `false` otherwise.
+ *
+ * @usedBy Session validation across the SAP MCP runtime.
  */
 export declare function hasPermission(session: SapAgentSession, permission: SapPermission): boolean;
 //# sourceMappingURL=agent-session.d.ts.map

package/dist/session/agent-session.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"agent-session.d.ts","sourceRoot":"","sources":["../../src/session/agent-session.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGvE;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,cAAc,EAAE;QACd,oBAAoB,EAAE,MAAM,CAAC;QAC7B,YAAY,EAAE,MAAM,CAAC;QACrB,gBAAgB,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH,GAAG,eAAe,CAclB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAGjE;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,aAAa,GAAG,OAAO,CAE1F"}
+{"version":3,"file":"agent-session.d.ts","sourceRoot":"","sources":["../../src/session/agent-session.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGvE;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,cAAc,EAAE;QACd,oBAAoB,EAAE,MAAM,CAAC;QAC7B,YAAY,EAAE,MAAM,CAAC;QACrB,gBAAgB,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH,GAAG,eAAe,CAclB;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAGjE;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,aAAa,GAAG,OAAO,CAE1F"}

package/dist/session/agent-session.js

@@ -1,9 +1,27 @@
 /**
- * Agent session management
+ * @name session/agent-session
+ * @description Agent session lifecycle management — creation, activation checks, and permission checks.
+ *
+ * @flow
+ *   1. `createAgentSession` generates a new session with a UUID, filtered permissions,
+ *      spending limits, and a 24-hour expiry.
+ *   2. `isSessionActive` checks whether a session is still within its expiry and budget.
+ *   3. `hasPermission` checks whether a session holds a specific permission.
+ *
+ * @module session/agent-session
  */
 import { isValidPermission } from '../core/guards.js';
 /**
- * Create a new agent session
+ * @name createAgentSession
+ * @description Creates a new agent session with a unique id, filtered permissions, spending limits, and 24-hour expiry.
+ *
+ * @param data.agentId        — Unique identifier for the agent.
+ * @param data.permissions    — Array of permission strings (invalid ones are filtered out).
+ * @param data.spendingLimits — Spending limits for per-transaction, per-day, and per-session SOL amounts.
+ * @returns A `SapAgentSession` object with a generated `sessionId`, filtered permissions,
+ *          remaining session balance set to `maxPerSessionSol`, and 24-hour expiry.
+ *
+ * @usedBy `delegated-session.ts:createDelegatedSession`.
  */
 export function createAgentSession(data) {
     const now = Date.now();
@@ -20,14 +38,27 @@ export function createAgentSession(data) {
     };
 }
 /**
- * Validate session is still active
+ * @name isSessionActive
+ * @description Checks whether a session is still active (not expired and has remaining budget).
+ *
+ * @param session — The agent session to check.
+ * @returns `true` if the current time is before `expiresAt` and `remainingSessionSol > 0`, `false` otherwise.
+ *
+ * @usedBy Session validation across the SAP MCP runtime.
  */
 export function isSessionActive(session) {
     const now = Date.now();
     return now < session.expiresAt && session.spendingLimits.remainingSessionSol > 0;
 }
 /**
- * Check if session has permission
+ * @name hasPermission
+ * @description Checks whether a session holds a specific permission.
+ *
+ * @param session    — The agent session to check.
+ * @param permission — The permission string to verify.
+ * @returns `true` if the session's permissions array includes the given permission, `false` otherwise.
+ *
+ * @usedBy Session validation across the SAP MCP runtime.
  */
 export function hasPermission(session, permission) {
     return session.permissions.includes(permission);

package/dist/session/agent-session.js.map

@@ -1 +1 @@
-{"version":3,"file":"agent-session.js","sourceRoot":"","sources":["../../src/session/agent-session.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAQlC;IACC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAEvB,OAAO;QACL,SAAS,EAAE,MAAM,CAAC,UAAU,EAAE;QAC9B,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC;QACvD,cAAc,EAAE;YACd,GAAG,IAAI,CAAC,cAAc;YACtB,mBAAmB,EAAE,IAAI,CAAC,cAAc,CAAC,gBAAgB;SAC1D;QACD,SAAS,EAAE,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,WAAW;QACjD,SAAS,EAAE,GAAG;KACf,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,OAAwB;IACtD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,OAAO,GAAG,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,cAAc,CAAC,mBAAmB,GAAG,CAAC,CAAC;AACnF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,OAAwB,EAAE,UAAyB;IAC/E,OAAO,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AAClD,CAAC"}
+{"version":3,"file":"agent-session.js","sourceRoot":"","sources":["../../src/session/agent-session.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAQlC;IACC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAEvB,OAAO;QACL,SAAS,EAAE,MAAM,CAAC,UAAU,EAAE;QAC9B,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC;QACvD,cAAc,EAAE;YACd,GAAG,IAAI,CAAC,cAAc;YACtB,mBAAmB,EAAE,IAAI,CAAC,cAAc,CAAC,gBAAgB;SAC1D;QACD,SAAS,EAAE,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,WAAW;QACjD,SAAS,EAAE,GAAG;KACf,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAC,OAAwB;IACtD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,OAAO,GAAG,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,cAAc,CAAC,mBAAmB,GAAG,CAAC,CAAC;AACnF,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAAC,OAAwB,EAAE,UAAyB;IAC/E,OAAO,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AAClD,CAAC"}

package/dist/session/delegated-session.d.ts

@@ -1,9 +1,29 @@
 /**
- * Delegated session management
+ * @name session/delegated-session
+ * @description Delegated session management — creates and validates sessions that delegate
+ * agent capabilities to an MCP client with policy-enforced permissions.
+ *
+ * @flow
+ *   1. `createDelegatedSession` validates requested permissions against the policy engine,
+ *      then creates a new agent session via `createAgentSession`.
+ *   2. `validateDelegatedSession` checks expiry, permission, and spending limits for an
+ *      existing session before allowing a delegated action.
+ *
+ * @module session/delegated-session
  */
 import type { SapAgentSession, SapMcpContext, SapPermission } from '../core/types.js';
 /**
- * Create a delegated session
+ * @name createDelegatedSession
+ * @description Creates a delegated agent session with policy-validated permissions and spending limits.
+ *
+ * @param context        — SAP MCP runtime context with policy engine.
+ * @param agentId        — Unique identifier for the delegating agent.
+ * @param permissions    — Array of permission strings to validate and grant.
+ * @param spendingLimits — Spending limits for per-transaction, per-day, and per-session SOL amounts.
+ * @returns A `SapAgentSession` with validated permissions and configured spending limits.
+ * @throws `PolicyError` if the requested permissions fail policy validation.
+ *
+ * @usedBy Delegated session MCP tools in the SAP MCP runtime.
  */
 export declare function createDelegatedSession(context: SapMcpContext, agentId: string, permissions: string[], spendingLimits: {
     maxPerTransactionSol: number;
@@ -11,7 +31,15 @@ export declare function createDelegatedSession(context: SapMcpContext, agentId:
     maxPerSessionSol: number;
 }): Promise<SapAgentSession>;
 /**
- * Validate delegated session
+ * @name validateDelegatedSession
+ * @description Validates an existing delegated session for a given permission and optional SOL amount.
+ *
+ * @param session    — The agent session to validate.
+ * @param permission — The permission required for the action.
+ * @param amountSol  — Optional SOL amount to check against remaining session balance.
+ * @returns `{ valid: true }` if all checks pass; `{ valid: false, error }` with a reason otherwise.
+ *
+ * @usedBy Delegated session MCP tools in the SAP MCP runtime.
  */
 export declare function validateDelegatedSession(session: SapAgentSession, permission: SapPermission, amountSol?: number): {
     valid: boolean;

package/dist/session/delegated-session.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"delegated-session.d.ts","sourceRoot":"","sources":["../../src/session/delegated-session.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGtF;;GAEG;AACH,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EAAE,EACrB,cAAc,EAAE;IACd,oBAAoB,EAAE,MAAM,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,GACA,OAAO,CAAC,eAAe,CAAC,CAsB1B;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,aAAa,EACzB,SAAS,CAAC,EAAE,MAAM,GACjB;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAoBpC"}
+{"version":3,"file":"delegated-session.d.ts","sourceRoot":"","sources":["../../src/session/delegated-session.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAIH,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGtF;;;;;;;;;;;;GAYG;AACH,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EAAE,EACrB,cAAc,EAAE;IACd,oBAAoB,EAAE,MAAM,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,GACA,OAAO,CAAC,eAAe,CAAC,CAsB1B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,aAAa,EACzB,SAAS,CAAC,EAAE,MAAM,GACjB;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAoBpC"}

package/dist/session/delegated-session.js

@@ -1,11 +1,31 @@
 /**
- * Delegated session management
+ * @name session/delegated-session
+ * @description Delegated session management — creates and validates sessions that delegate
+ * agent capabilities to an MCP client with policy-enforced permissions.
+ *
+ * @flow
+ *   1. `createDelegatedSession` validates requested permissions against the policy engine,
+ *      then creates a new agent session via `createAgentSession`.
+ *   2. `validateDelegatedSession` checks expiry, permission, and spending limits for an
+ *      existing session before allowing a delegated action.
+ *
+ * @module session/delegated-session
  */
 import { logger } from '../core/logger.js';
 import { PolicyError } from '../core/errors.js';
 import { createAgentSession } from './agent-session.js';
 /**
- * Create a delegated session
+ * @name createDelegatedSession
+ * @description Creates a delegated agent session with policy-validated permissions and spending limits.
+ *
+ * @param context        — SAP MCP runtime context with policy engine.
+ * @param agentId        — Unique identifier for the delegating agent.
+ * @param permissions    — Array of permission strings to validate and grant.
+ * @param spendingLimits — Spending limits for per-transaction, per-day, and per-session SOL amounts.
+ * @returns A `SapAgentSession` with validated permissions and configured spending limits.
+ * @throws `PolicyError` if the requested permissions fail policy validation.
+ *
+ * @usedBy Delegated session MCP tools in the SAP MCP runtime.
  */
 export async function createDelegatedSession(context, agentId, permissions, spendingLimits) {
     logger.info('Creating delegated session', { agentId, permissions });
@@ -24,7 +44,15 @@ export async function createDelegatedSession(context, agentId, permissions, spen
     return session;
 }
 /**
- * Validate delegated session
+ * @name validateDelegatedSession
+ * @description Validates an existing delegated session for a given permission and optional SOL amount.
+ *
+ * @param session    — The agent session to validate.
+ * @param permission — The permission required for the action.
+ * @param amountSol  — Optional SOL amount to check against remaining session balance.
+ * @returns `{ valid: true }` if all checks pass; `{ valid: false, error }` with a reason otherwise.
+ *
+ * @usedBy Delegated session MCP tools in the SAP MCP runtime.
  */
 export function validateDelegatedSession(session, permission, amountSol) {
     // Check if session is active

package/dist/session/delegated-session.js.map

@@ -1 +1 @@
-{"version":3,"file":"delegated-session.js","sourceRoot":"","sources":["../../src/session/delegated-session.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAsB,EACtB,OAAe,EACf,WAAqB,EACrB,cAIC;IAED,MAAM,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAAC;IAEpE,sCAAsC;IACtC,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,mBAAmB,CACzE,WAAW,CACZ,CAAC;IAEF,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;QAChC,MAAM,IAAI,WAAW,CAAC,qBAAqB,EAAE,EAAE,MAAM,EAAE,oBAAoB,CAAC,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAED,iBAAiB;IACjB,MAAM,OAAO,GAAG,kBAAkB,CAAC;QACjC,OAAO;QACP,WAAW,EAAE,oBAAoB,CAAC,WAAW;QAC7C,cAAc;KACf,CAAC,CAAC;IAEH,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAE3E,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAAwB,EACxB,UAAyB,EACzB,SAAkB;IAElB,6BAA6B;IAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,IAAI,GAAG,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QAC7B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,iBAAiB,EAAE,CAAC;IACpD,CAAC;IAED,mBAAmB;IACnB,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9C,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,uBAAuB,UAAU,EAAE,EAAE,CAAC;IACtE,CAAC;IAED,uBAAuB;IACvB,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,IAAI,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC,mBAAmB,EAAE,CAAC;YAC3D,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,8BAA8B,EAAE,CAAC;QACjE,CAAC;IACH,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACzB,CAAC"}
+{"version":3,"file":"delegated-session.js","sourceRoot":"","sources":["../../src/session/delegated-session.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAsB,EACtB,OAAe,EACf,WAAqB,EACrB,cAIC;IAED,MAAM,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAAC;IAEpE,sCAAsC;IACtC,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,mBAAmB,CACzE,WAAW,CACZ,CAAC;IAEF,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;QAChC,MAAM,IAAI,WAAW,CAAC,qBAAqB,EAAE,EAAE,MAAM,EAAE,oBAAoB,CAAC,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAED,iBAAiB;IACjB,MAAM,OAAO,GAAG,kBAAkB,CAAC;QACjC,OAAO;QACP,WAAW,EAAE,oBAAoB,CAAC,WAAW;QAC7C,cAAc;KACf,CAAC,CAAC;IAEH,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAE3E,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAAwB,EACxB,UAAyB,EACzB,SAAkB;IAElB,6BAA6B;IAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,IAAI,GAAG,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QAC7B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,iBAAiB,EAAE,CAAC;IACpD,CAAC;IAED,mBAAmB;IACnB,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9C,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,uBAAuB,UAAU,EAAE,EAAE,CAAC;IACtE,CAAC;IAED,uBAAuB;IACvB,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,IAAI,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC,mBAAmB,EAAE,CAAC;YAC3D,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,8BAA8B,EAAE,CAAC;QACjE,CAAC;IACH,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACzB,CAAC"}

package/dist/session/index.d.ts

@@ -1,5 +1,11 @@
 /**
- * Session module barrel export
+ * @name session/index
+ * @description Barrel export for the SAP MCP session module.
+ *
+ * Re-exports agent session lifecycle, delegated session, session store, permissions,
+ * spending limits, and session type definitions.
+ *
+ * @module session/index
  */
 export { createAgentSession, isSessionActive, hasPermission } from './agent-session.js';
 export { sessionStore } from './session-store.js';

package/dist/session/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/session/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxF,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,YAAY,EACV,oBAAoB,EACpB,uBAAuB,EACvB,aAAa,GACd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAC1F,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/session/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxF,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,YAAY,EACV,oBAAoB,EACpB,uBAAuB,EACvB,aAAa,GACd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAC1F,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,qBAAqB,CAAC"}

package/dist/session/index.js

@@ -1,5 +1,11 @@
 /**
- * Session module barrel export
+ * @name session/index
+ * @description Barrel export for the SAP MCP session module.
+ *
+ * Re-exports agent session lifecycle, delegated session, session store, permissions,
+ * spending limits, and session type definitions.
+ *
+ * @module session/index
  */
 export { createAgentSession, isSessionActive, hasPermission } from './agent-session.js';
 export { sessionStore } from './session-store.js';

package/dist/session/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/session/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxF,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAMlD,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAC1F,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/session/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxF,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAMlD,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAC1F,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,qBAAqB,CAAC"}

package/dist/session/redis-session-store.d.ts

@@ -1,5 +1,6 @@
 /**
- * Redis-backed session store for production deployments
+ * @name session/redis-session-store
+ * @description Redis-backed persistent session store for production SAP MCP deployments.
  *
  * Features:
  * - Persistent sessions across server restarts
@@ -7,17 +8,28 @@
  * - Automatic TTL-based expiration
  * - Memory-safe (no local storage)
  *
- * Usage:
- * ```typescript
- * const store = new RedisSessionStore('redis://localhost:6379');
- * await store.set('session-123', session);
- * const session = await store.get('session-123');
- * ```
+ * @flow
+ *   1. `createSessionStore` checks `SAP_MCP_USE_REDIS` env var and creates a `RedisSessionStore`
+ *      or returns `null` for in-memory development mode.
+ *   2. `RedisSessionStore` manages session CRUD with automatic TTL based on session expiry.
+ *   3. A background cleanup interval removes expired sessions periodically.
+ *
+ * @env `SAP_MCP_USE_REDIS` — Set to `true` to enable Redis session storage.
+ * @env `SAP_MCP_REDIS_URL` — Redis connection URL (default `redis://localhost:6379`).
+ *
+ * @module session/redis-session-store
  */
 import { Redis } from 'ioredis';
 import type { SapAgentSession } from '../core/types.js';
 /**
- * Contract describing redis session store config data used by the SAP MCP runtime.
+ * @name RedisSessionStoreConfig
+ * @description Configuration for the Redis-backed session store.
+ *
+ * @property redisUrl          — Redis connection URL.
+ * @property keyPrefix         — Optional prefix for session keys in Redis (default `sap-mcp:session:`).
+ * @property cleanupIntervalMs — Optional cleanup interval in milliseconds (default 3600000 / 1 hour).
+ *
+ * @usedBy `RedisSessionStore`, `createSessionStore`
  */
 export interface RedisSessionStoreConfig {
     redisUrl: string;
@@ -25,44 +37,89 @@ export interface RedisSessionStoreConfig {
     cleanupIntervalMs?: number;
 }
 /**
- * Runtime service that implements redis session store behavior.
+ * @name RedisSessionStore
+ * @description Persistent session store backed by Redis with TTL-based expiration and periodic cleanup.
+ *
+ * @method connect   — Establish the Redis connection.
+ * @method set        — Store a session with TTL derived from its expiry.
+ * @method get        — Retrieve a session by id.
+ * @method delete     — Remove a session by id.
+ * @method getAll     — Retrieve all active sessions (for debugging/admin).
+ * @method getCount   — Get the total number of stored sessions.
+ * @method cleanup    — Manually remove expired sessions.
+ * @method getStats   — Get session statistics (total, active, expired).
+ * @method shutdown   — Gracefully close the Redis connection and cleanup interval.
+ * @method getClient  — Get the raw Redis client for advanced operations.
+ *
+ * @usedBy `createSessionStore`, distributed SAP MCP deployments.
  */
 export declare class RedisSessionStore {
     private redis;
     private keyPrefix;
     private cleanupInterval?;
     private isShuttingDown;
+    /**
+     * @name RedisSessionStore.constructor
+     * @description Creates a new Redis session store with merged config and starts the cleanup interval.
+     *
+     * @param config — Optional configuration overriding defaults.
+     */
     constructor(config?: RedisSessionStoreConfig);
     /**
-     * Connect to Redis
+     * @name RedisSessionStore.connect
+     * @description Connects to the Redis server.
+     *
+     * @usedBy `createSessionStore`.
      */
     connect(): Promise<void>;
     /**
-     * Store a session with TTL
+     * @name RedisSessionStore.set
+     * @description Stores a session in Redis with a TTL derived from its expiry timestamp.
+     *
+     * @param sessionId — Unique session identifier.
+     * @param session   — The agent session to store.
      */
     set(sessionId: string, session: SapAgentSession): Promise<void>;
     /**
-     * Get a session
+     * @name RedisSessionStore.get
+     * @description Retrieves a session by id from Redis.
+     *
+     * @param sessionId — Unique session identifier.
+     * @returns The session if found and parseable, `null` otherwise.
      */
     get(sessionId: string): Promise<SapAgentSession | null>;
     /**
-     * Delete a session
+     * @name RedisSessionStore.delete
+     * @description Deletes a session from Redis by id.
+     *
+     * @param sessionId — Unique session identifier.
+     * @returns `true` if the session was deleted, `false` if it did not exist.
      */
     delete(sessionId: string): Promise<boolean>;
     /**
-     * Get all active sessions (for debugging/admin)
+     * @name RedisSessionStore.getAll
+     * @description Retrieves all active sessions from Redis (for debugging/admin).
+     *
+     * @returns Array of all stored agent sessions.
      */
     getAll(): Promise<SapAgentSession[]>;
     /**
-     * Get session count
+     * @name RedisSessionStore.getCount
+     * @description Returns the total number of stored sessions.
+     *
+     * @returns Count of session keys in Redis.
      */
     getCount(): Promise<number>;
     /**
-     * Clean up expired sessions (manual trigger)
+     * @name RedisSessionStore.cleanup
+     * @description Manually removes expired sessions from Redis.
      */
     cleanup(): Promise<void>;
     /**
-     * Get session statistics
+     * @name RedisSessionStore.getStats
+     * @description Returns session statistics (total, active, expired).
+     *
+     * @returns Object with `totalSessions`, `activeSessions`, and `expiredSessions` counts.
      */
     getStats(): Promise<{
         totalSessions: number;
@@ -70,20 +127,36 @@ export declare class RedisSessionStore {
         expiredSessions: number;
     }>;
     /**
-     * Graceful shutdown
+     * @name RedisSessionStore.shutdown
+     * @description Gracefully shuts down the Redis connection and clears the cleanup interval.
      */
     shutdown(): Promise<void>;
     /**
-     * Get Redis client (for advanced operations)
+     * @name RedisSessionStore.getClient
+     * @description Returns the raw Redis client instance for advanced operations.
+     *
+     * @returns The underlying `ioredis` Redis instance.
      */
     getClient(): InstanceType<typeof Redis>;
+    /** @description Builds the full Redis key from the prefix and session id. */
     private getKey;
+    /** @description Starts the periodic cleanup interval for expired sessions. */
     private startCleanup;
 }
 /**
- * Create session store with environment-based configuration
+ * @name createSessionStore
+ * @description Creates a session store based on environment configuration.
+ *
+ * Uses Redis in production (when `SAP_MCP_USE_REDIS=true`) and in-memory
+ * storage in development (returns `null`).
+ *
+ * @returns A connected `RedisSessionStore` if Redis is enabled, `null` otherwise.
+ * @throws If Redis connection fails after retries.
+ *
+ * @env `SAP_MCP_USE_REDIS` — Set to `true` to enable Redis.
+ * @env `SAP_MCP_REDIS_URL` — Redis connection URL (default `redis://localhost:6379`).
  *
- * Uses Redis in production, in-memory in development
+ * @usedBy Server initialization in the SAP MCP runtime.
  */
 export declare function createSessionStore(): Promise<RedisSessionStore | null>;
 //# sourceMappingURL=redis-session-store.d.ts.map

package/dist/session/redis-session-store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"redis-session-store.d.ts","sourceRoot":"","sources":["../../src/session/redis-session-store.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAQD;;GAEG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,KAAK,CAA6B;IAC1C,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,eAAe,CAAC,CAAiB;IACzC,OAAO,CAAC,cAAc,CAAS;gBAEnB,MAAM,GAAE,uBAAwC;IA6B5D;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAK9B;;OAEG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAQrE;;OAEG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAiB7D;;OAEG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAOjD;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAkB1C;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;IAKjC;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAe9B;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC;QACxB,aAAa,EAAE,MAAM,CAAC;QACtB,cAAc,EAAE,MAAM,CAAC;QACvB,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;IA6BF;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAW/B;;OAEG;IACH,SAAS,IAAI,YAAY,CAAC,OAAO,KAAK,CAAC;IAIvC,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,YAAY;CAWrB;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,IAAI,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAa5E"}
+{"version":3,"file":"redis-session-store.d.ts","sourceRoot":"","sources":["../../src/session/redis-session-store.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD;;;;;;;;;GASG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AASD;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,KAAK,CAA6B;IAC1C,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,eAAe,CAAC,CAAiB;IACzC,OAAO,CAAC,cAAc,CAAS;IAE/B;;;;;OAKG;gBACS,MAAM,GAAE,uBAAwC;IA6B5D;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAK9B;;;;;;OAMG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAQrE;;;;;;OAMG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAiB7D;;;;;;OAMG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAOjD;;;;;OAKG;IACG,MAAM,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAkB1C;;;;;OAKG;IACG,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;IAKjC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAe9B;;;;;OAKG;IACG,QAAQ,IAAI,OAAO,CAAC;QACxB,aAAa,EAAE,MAAM,CAAC;QACtB,cAAc,EAAE,MAAM,CAAC;QACvB,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;IA6BF;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAW/B;;;;;OAKG;IACH,SAAS,IAAI,YAAY,CAAC,OAAO,KAAK,CAAC;IAIvC,6EAA6E;IAC7E,OAAO,CAAC,MAAM;IAId,8EAA8E;IAC9E,OAAO,CAAC,YAAY;CAWrB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,kBAAkB,IAAI,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAa5E"}