@mcp-abap-adt/connection 0.1.0

package/dist/config/sapConfig.d.ts

@@ -0,0 +1,43 @@
+export type SapAuthType = "basic" | "jwt";
+export interface SapConfig {
+    url: string;
+    client?: string;
+    authType: SapAuthType;
+    username?: string;
+    password?: string;
+    jwtToken?: string;
+    refreshToken?: string;
+    uaaUrl?: string;
+    uaaClientId?: string;
+    uaaClientSecret?: string;
+}
+/**
+ * Produces a stable string signature for a SAP configuration.
+ * Used internally for caching connection instances when configuration changes.
+ */
+/**
+ * Load .env file if dotenv is available and file exists
+ * @param envPath - Path to .env file (default: .env in current working directory or project root)
+ * @returns true if .env was loaded, false otherwise
+ */
+export declare function loadEnvFile(envPath?: string): boolean;
+/**
+ * Get SAP configuration from environment variables
+ * Used by tests and applications to create connection config
+ *
+ * Automatically detects auth type:
+ * - If SAP_JWT_TOKEN is present → uses 'jwt'
+ * - If SAP_AUTH_TYPE is set → uses that value
+ * - Otherwise → uses 'basic'
+ */
+export declare function getConfigFromEnv(): SapConfig;
+/**
+ * Load .env file and get SAP configuration from environment variables
+ * Convenience function that combines loadEnvFile() and getConfigFromEnv()
+ *
+ * @param envPath - Optional path to .env file (default: auto-detect)
+ * @returns SAP configuration
+ */
+export declare function loadConfigFromEnvFile(envPath?: string): SapConfig;
+export declare function sapConfigSignature(config: SapConfig): string;
+//# sourceMappingURL=sapConfig.d.ts.map

package/dist/config/sapConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sapConfig.d.ts","sourceRoot":"","sources":["../../src/config/sapConfig.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,KAAK,CAAC;AAE1C,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,WAAW,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAuDrD;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,IAAI,SAAS,CAyD5C;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAGjE;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAmB5D"}

package/dist/config/sapConfig.js

@@ -0,0 +1,202 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadEnvFile = loadEnvFile;
+exports.getConfigFromEnv = getConfigFromEnv;
+exports.loadConfigFromEnvFile = loadConfigFromEnvFile;
+exports.sapConfigSignature = sapConfigSignature;
+const path = __importStar(require("path"));
+const fs = __importStar(require("fs"));
+/**
+ * Produces a stable string signature for a SAP configuration.
+ * Used internally for caching connection instances when configuration changes.
+ */
+/**
+ * Load .env file if dotenv is available and file exists
+ * @param envPath - Path to .env file (default: .env in current working directory or project root)
+ * @returns true if .env was loaded, false otherwise
+ */
+function loadEnvFile(envPath) {
+    // Determine .env file path
+    let resolvedPath;
+    if (envPath) {
+        resolvedPath = path.resolve(envPath);
+    }
+    else {
+        // Try current directory first
+        const currentDirEnv = path.resolve(process.cwd(), '.env');
+        if (fs.existsSync(currentDirEnv)) {
+            resolvedPath = currentDirEnv;
+        }
+        else {
+            // Try project root (go up from node_modules or dist)
+            const projectRoot = path.resolve(__dirname, '../../..');
+            resolvedPath = path.resolve(projectRoot, '.env');
+        }
+    }
+    if (!fs.existsSync(resolvedPath)) {
+        return false;
+    }
+    // Try to use dotenv if available
+    try {
+        const dotenv = require('dotenv');
+        const result = dotenv.config({ path: resolvedPath, override: false });
+        if (!result.error) {
+            return true;
+        }
+    }
+    catch (error) {
+        // dotenv not available - fallback to manual parsing
+    }
+    // Manual fallback parser (supports KEY=VALUE, ignores comments)
+    try {
+        const content = fs.readFileSync(resolvedPath, 'utf8');
+        const lines = content.split(/\r?\n/);
+        for (const line of lines) {
+            const trimmed = line.trim();
+            if (!trimmed || trimmed.startsWith('#')) {
+                continue;
+            }
+            const eqIndex = trimmed.indexOf('=');
+            if (eqIndex === -1) {
+                continue;
+            }
+            const key = trimmed.substring(0, eqIndex).trim();
+            const value = trimmed.substring(eqIndex + 1).trim();
+            if (!process.env[key]) {
+                process.env[key] = value;
+            }
+        }
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}
+/**
+ * Get SAP configuration from environment variables
+ * Used by tests and applications to create connection config
+ *
+ * Automatically detects auth type:
+ * - If SAP_JWT_TOKEN is present → uses 'jwt'
+ * - If SAP_AUTH_TYPE is set → uses that value
+ * - Otherwise → uses 'basic'
+ */
+function getConfigFromEnv() {
+    const rawUrl = process.env.SAP_URL;
+    const url = rawUrl ? rawUrl.split('#')[0].trim() : rawUrl;
+    const rawClient = process.env.SAP_CLIENT;
+    const client = rawClient ? rawClient.split('#')[0].trim() : rawClient;
+    // Auto-detect auth type: if JWT token is present, use JWT; otherwise check SAP_AUTH_TYPE or default to basic
+    // Priority: SAP_JWT_TOKEN presence > SAP_AUTH_TYPE > default to basic
+    let rawAuthType = process.env.SAP_AUTH_TYPE;
+    if (process.env.SAP_JWT_TOKEN) {
+        rawAuthType = 'jwt'; // Auto-detect JWT if token is present (overrides SAP_AUTH_TYPE)
+    }
+    rawAuthType = rawAuthType || 'basic';
+    const authType = rawAuthType.split('#')[0].trim();
+    if (!url || !/^https?:\/\//.test(url)) {
+        throw new Error(`Missing or invalid SAP_URL: ${url}`);
+    }
+    const config = {
+        url,
+        authType: authType === 'xsuaa' ? 'jwt' : authType,
+    };
+    if (client) {
+        config.client = client;
+    }
+    if (authType === 'jwt' || authType === 'xsuaa') {
+        const jwtToken = process.env.SAP_JWT_TOKEN;
+        if (!jwtToken) {
+            throw new Error('Missing SAP_JWT_TOKEN for JWT authentication');
+        }
+        config.jwtToken = jwtToken;
+        // Refresh token is optional but recommended for automatic token renewal
+        const refreshToken = process.env.SAP_REFRESH_TOKEN;
+        if (refreshToken) {
+            config.refreshToken = refreshToken;
+        }
+        // UAA credentials for token refresh (optional but recommended)
+        const uaaUrl = process.env.SAP_UAA_URL || process.env.UAA_URL;
+        const uaaClientId = process.env.SAP_UAA_CLIENT_ID || process.env.UAA_CLIENT_ID;
+        const uaaClientSecret = process.env.SAP_UAA_CLIENT_SECRET || process.env.UAA_CLIENT_SECRET;
+        if (uaaUrl)
+            config.uaaUrl = uaaUrl;
+        if (uaaClientId)
+            config.uaaClientId = uaaClientId;
+        if (uaaClientSecret)
+            config.uaaClientSecret = uaaClientSecret;
+    }
+    else {
+        const username = process.env.SAP_USERNAME;
+        const password = process.env.SAP_PASSWORD;
+        if (!username || !password) {
+            throw new Error('Missing SAP_USERNAME or SAP_PASSWORD for basic authentication');
+        }
+        config.username = username;
+        config.password = password;
+    }
+    return config;
+}
+/**
+ * Load .env file and get SAP configuration from environment variables
+ * Convenience function that combines loadEnvFile() and getConfigFromEnv()
+ *
+ * @param envPath - Optional path to .env file (default: auto-detect)
+ * @returns SAP configuration
+ */
+function loadConfigFromEnvFile(envPath) {
+    loadEnvFile(envPath);
+    return getConfigFromEnv();
+}
+function sapConfigSignature(config) {
+    // Include token preview (first 10 and last 10 chars) to detect token changes
+    // This allows connection recreation when token is updated via HTTP headers
+    const jwtTokenPreview = config.jwtToken
+        ? `${config.jwtToken.substring(0, 10)}...${config.jwtToken.substring(Math.max(0, config.jwtToken.length - 10))}`
+        : null;
+    const refreshTokenPreview = config.refreshToken
+        ? `${config.refreshToken.substring(0, 10)}...${config.refreshToken.substring(Math.max(0, config.refreshToken.length - 10))}`
+        : null;
+    return JSON.stringify({
+        url: config.url,
+        client: config.client ?? null,
+        authType: config.authType,
+        username: config.username ?? null,
+        password: config.password ? "set" : null,
+        jwtToken: jwtTokenPreview,
+        refreshToken: refreshTokenPreview
+    });
+}

package/dist/connection/AbapConnection.d.ts

@@ -0,0 +1,22 @@
+import { AxiosResponse } from "axios";
+import { SapConfig } from "../config/sapConfig.js";
+import { SessionState } from "../logger.js";
+export interface AbapRequestOptions {
+    url: string;
+    method: string;
+    timeout: number;
+    data?: any;
+    params?: any;
+    headers?: Record<string, string>;
+}
+export interface AbapConnection {
+    getConfig(): SapConfig;
+    getBaseUrl(): Promise<string>;
+    getAuthHeaders(): Promise<Record<string, string>>;
+    makeAdtRequest(options: AbapRequestOptions): Promise<AxiosResponse>;
+    connect(): Promise<void>;
+    reset(): void;
+    getSessionState(): SessionState | null;
+    setSessionState(state: SessionState): void;
+}
+//# sourceMappingURL=AbapConnection.d.ts.map

package/dist/connection/AbapConnection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbapConnection.d.ts","sourceRoot":"","sources":["../../src/connection/AbapConnection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,IAAI,SAAS,CAAC;IACvB,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAClD,cAAc,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACpE,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,KAAK,IAAI,IAAI,CAAC;IACd,eAAe,IAAI,YAAY,GAAG,IAAI,CAAC;IACvC,eAAe,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,CAAC;CAC5C"}

package/dist/connection/AbapConnection.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/connection/AbstractAbapConnection.d.ts

@@ -0,0 +1,115 @@
+import { AxiosResponse } from "axios";
+import { ILogger, ISessionStorage, SessionState } from "../logger.js";
+import { SapConfig } from "../config/sapConfig.js";
+import { AbapConnection, AbapRequestOptions } from "./AbapConnection.js";
+declare abstract class AbstractAbapConnection implements AbapConnection {
+    private readonly config;
+    protected readonly logger: ILogger;
+    private axiosInstance;
+    private csrfToken;
+    private cookies;
+    private cookieStore;
+    private cachedBaseUrl;
+    private sessionId;
+    private sessionStorage;
+    private sessionMode;
+    protected constructor(config: SapConfig, logger: ILogger, sessionStorage?: ISessionStorage, sessionId?: string);
+    /**
+     * Enable stateful session mode with storage
+     * @param sessionId - Unique session identifier
+     * @param storage - Storage implementation for persisting session state
+     */
+    enableStatefulSession(sessionId: string, storage: ISessionStorage): Promise<void>;
+    /**
+     * Disable stateful session mode (switch to stateless)
+     * Optionally saves current state before switching
+     */
+    disableStatefulSession(saveBeforeDisable?: boolean): Promise<void>;
+    /**
+     * Get current session mode
+     */
+    getSessionMode(): "stateless" | "stateful";
+    /**
+     * Set session ID for stateful operations
+     * When session ID is set, session state (cookies, CSRF token) will be persisted
+     * @deprecated Use enableStatefulSession() instead
+     */
+    setSessionId(sessionId: string): void;
+    /**
+     * Get current session ID
+     */
+    getSessionId(): string | null;
+    /**
+     * Set session storage (can be changed at runtime)
+     */
+    setSessionStorage(storage: ISessionStorage | null): void;
+    /**
+     * Get current session storage
+     */
+    getSessionStorage(): ISessionStorage | null;
+    /**
+     * Load session state from storage
+     */
+    loadSessionState(): Promise<void>;
+    /**
+     * Save session state to storage
+     * Only saves if in stateful mode
+     */
+    saveSessionState(): Promise<void>;
+    /**
+     * Get current session state
+     * Returns cookies, CSRF token, and cookie store for manual persistence
+     * @returns Current session state or null if no session data
+     */
+    getSessionState(): SessionState | null;
+    /**
+     * Set session state manually
+     * Allows user to restore session from custom storage (e.g., database, Redis)
+     * @param state - Session state with cookies, CSRF token, and cookie store
+     */
+    setSessionState(state: SessionState): void;
+    /**
+     * Clear session state from storage
+     */
+    clearSessionState(): Promise<void>;
+    getConfig(): SapConfig;
+    reset(): void;
+    getBaseUrl(): Promise<string>;
+    getAuthHeaders(): Promise<Record<string, string>>;
+    /**
+     * Connect to SAP system and initialize session (get CSRF token and cookies)
+     * This should be called explicitly before making the first request to ensure
+     * proper authentication and session initialization.
+     *
+     * Concrete implementations must provide auth-specific connection logic:
+     * - BaseAbapConnection: Basic auth with CSRF token fetch
+     * - JwtAbapConnection: JWT auth with token refresh on 401/403
+     */
+    abstract connect(): Promise<void>;
+    makeAdtRequest(options: AbapRequestOptions): Promise<AxiosResponse>;
+    protected abstract buildAuthorizationHeader(): string;
+    /**
+     * Fetch CSRF token from SAP system
+     * Protected method for use by concrete implementations in their connect() method
+     */
+    protected fetchCsrfToken(url: string, retryCount?: number, retryDelay?: number): Promise<string>;
+    /**
+     * Get CSRF token (protected for use by subclasses)
+     */
+    protected getCsrfToken(): string | null;
+    /**
+     * Set CSRF token (protected for use by subclasses)
+     */
+    protected setCsrfToken(token: string | null): void;
+    /**
+     * Get cookies (protected for use by subclasses)
+     */
+    protected getCookies(): string | null;
+    private updateCookiesFromResponse;
+    private getAxiosInstance;
+    private normalizeRequestUrl;
+    private ensureFreshCsrfToken;
+    private shouldRetryCsrf;
+}
+export { AbstractAbapConnection };
+//# sourceMappingURL=AbstractAbapConnection.d.ts.map

package/dist/connection/AbstractAbapConnection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractAbapConnection.d.ts","sourceRoot":"","sources":["../../src/connection/AbstractAbapConnection.ts"],"names":[],"mappings":"AAAA,OAAc,EAAiD,aAAa,EAAE,MAAM,OAAO,CAAC;AAE5F,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEtE,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEzE,uBAAe,sBAAuB,YAAW,cAAc;IAW3D,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO;IAXpC,OAAO,CAAC,aAAa,CAA8B;IACnD,OAAO,CAAC,SAAS,CAAuB;IACxC,OAAO,CAAC,OAAO,CAAuB;IACtC,OAAO,CAAC,WAAW,CAAkC;IACrD,OAAO,CAAC,aAAa,CAAuB;IAC5C,OAAO,CAAC,SAAS,CAAuB;IACxC,OAAO,CAAC,cAAc,CAAgC;IACtD,OAAO,CAAC,WAAW,CAAyC;IAE5D,SAAS,aACU,MAAM,EAAE,SAAS,EACf,MAAM,EAAE,OAAO,EAClC,cAAc,CAAC,EAAE,eAAe,EAChC,SAAS,CAAC,EAAE,MAAM;IAOpB;;;;OAIG;IACG,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAcvF;;;OAGG;IACG,sBAAsB,CAAC,iBAAiB,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB/E;;OAEG;IACH,cAAc,IAAI,WAAW,GAAG,UAAU;IAI1C;;;;OAIG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IASrC;;OAEG;IACH,YAAY,IAAI,MAAM,GAAG,IAAI;IAI7B;;OAEG;IACH,iBAAiB,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI,GAAG,IAAI;IASxD;;OAEG;IACH,iBAAiB,IAAI,eAAe,GAAG,IAAI;IAI3C;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBvC;;;OAGG;IACG,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBvC;;;;OAIG;IACH,eAAe,IAAI,YAAY,GAAG,IAAI;IAYtC;;;;OAIG;IACH,eAAe,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAY1C;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAkBxC,SAAS,IAAI,SAAS;IAItB,KAAK,IAAI,IAAI;IAYP,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAkB7B,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAevD;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAE3B,cAAc,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IAwMzE,SAAS,CAAC,QAAQ,CAAC,wBAAwB,IAAI,MAAM;IAErD;;;OAGG;cACa,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,SAAI,EAAE,UAAU,SAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAgL/F;;OAEG;IACH,SAAS,CAAC,YAAY,IAAI,MAAM,GAAG,IAAI;IAIvC;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAIlD;;OAEG;IACH,SAAS,CAAC,UAAU,IAAI,MAAM,GAAG,IAAI;IAIrC,OAAO,CAAC,yBAAyB;IAuDjC,OAAO,CAAC,gBAAgB;IAqBxB,OAAO,CAAC,mBAAmB;YAOb,oBAAoB;IAwBlC,OAAO,CAAC,eAAe;CAyBxB;AAGD,OAAO,EAAE,sBAAsB,EAAE,CAAC"}