sfcc-dev-mcp 1.0.15 → 1.0.19

package/dist/clients/script-debugger/script-debugger-client.d.ts

@@ -0,0 +1,147 @@
+/**
+ * SFCC Script Debugger Client
+ *
+ * Provides script evaluation capabilities using the SFCC Script Debugger API.
+ * This client handles the complete workflow: creating debug sessions, setting breakpoints,
+ * triggering script execution, evaluating expressions, and cleanup.
+ *
+ * This implementation uses the existing Default-Start endpoint from app_storefront_base,
+ * eliminating the need to upload custom scripts.
+ */
+import { Logger } from '../../utils/logger.js';
+import { SFCCConfig } from '../../types/types.js';
+/**
+ * Result of a script evaluation
+ */
+export interface ScriptEvaluationResult {
+    success: boolean;
+    result?: string;
+    error?: string;
+    executionTimeMs?: number;
+    warnings?: string[];
+}
+/**
+ * SFCC Script Debugger Client
+ *
+ * Orchestrates script evaluation through the Script Debugger API workflow:
+ * 1. Create debugger client session
+ * 2. Set breakpoint on Default.js controller
+ * 3. Trigger Default-Start via HTTP
+ * 4. Wait for thread to halt at breakpoint
+ * 5. Evaluate user's expression in halted context
+ * 6. Resume thread and cleanup
+ *
+ * Supports both SFRA (app_storefront_base) and SiteGenesis (app_storefront_controllers).
+ */
+export declare class ScriptDebuggerClient {
+    private readonly config;
+    private readonly logger;
+    private readonly debuggerClientId;
+    private readonly debuggerBaseUrl;
+    private readonly protocol;
+    private cachedAuthHeader;
+    private webdavClient;
+    private isDebuggerEnabled;
+    private activeCartridgeConfig;
+    constructor(config: SFCCConfig, logger?: Logger);
+    /**
+     * Evaluate a script/expression on the SFCC instance
+     *
+     * This method handles the entire workflow automatically:
+     * - Sets up debugger session
+     * - Sets breakpoint on Default-Start (or custom file/line)
+     * - Triggers execution and captures result
+     * - Cleans up all resources
+     *
+     * @param script The JavaScript code to evaluate
+     * @param options Optional configuration for the evaluation
+     */
+    evaluateScript(script: string, options?: {
+        timeout?: number;
+        siteId?: string;
+        locale?: string;
+        breakpointFile?: string;
+        breakpointLine?: number;
+    }): Promise<ScriptEvaluationResult>;
+    /**
+     * Build and cache authentication header for debugger API
+     */
+    private getAuthHeader;
+    /**
+     * Get WebDAV client credentials
+     */
+    private getWebDAVCredentials;
+    /**
+     * Get or create WebDAV client for cartridge verification
+     */
+    private getWebDAVClient;
+    /**
+     * Check if a specific controller exists in the code version
+     */
+    private controllerExists;
+    /**
+     * Detect which storefront cartridge is available (SFRA or SiteGenesis)
+     * Returns the cartridge config to use, or null if none found
+     */
+    private detectStorefrontCartridge;
+    /**
+     * Make a request to the debugger API
+     */
+    private debuggerRequest;
+    /**
+     * Enable the debugger by creating a client session
+     */
+    private enableDebugger;
+    /**
+     * Set breakpoints on the controller.
+     * Creates multiple breakpoints (lines 1-50 by default) to ensure we catch executable code.
+     */
+    private setBreakpoints;
+    /**
+     * Normalize site ID - extract the ID from "Sites-{id}-Site" format if needed
+     */
+    private normalizeSiteId;
+    /**
+     * Normalize locale value by trimming and removing leading/trailing slashes
+     */
+    private normalizeLocale;
+    /**
+     * Trigger the Default-Start endpoint via HTTP
+     */
+    private triggerDefaultStart;
+    /**
+     * Trigger a storefront URL. Returns true if caller should retry with a fallback URL.
+     *
+     * Important: When debugging is active, the request may hang (and get aborted by timeout)
+     * after successfully hitting the breakpoint. In that case we should NOT retry.
+     */
+    private triggerStorefrontUrl;
+    /**
+     * Wait for a thread to halt at our breakpoint
+     */
+    private waitForHaltedThread;
+    /**
+     * Evaluate an expression in the context of a halted thread
+     */
+    private evaluateInContext;
+    /**
+     * Resume a halted thread
+     */
+    private resumeThread;
+    /**
+     * Cleanup: remove breakpoints, disable debugger
+     */
+    private cleanup;
+    /**
+     * Get guidance based on error message
+     */
+    private getErrorGuidance;
+    /**
+     * Test connectivity to the debugger API
+     */
+    testConnection(): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+}
+//# sourceMappingURL=script-debugger-client.d.ts.map

package/dist/clients/script-debugger/script-debugger-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"script-debugger-client.d.ts","sourceRoot":"","sources":["../../../src/clients/script-debugger/script-debugger-client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAiBlD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAsED;;;;;;;;;;;;GAYG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAwB;IACzD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,gBAAgB,CAAuB;IAC/C,OAAO,CAAC,YAAY,CAA6B;IACjD,OAAO,CAAC,iBAAiB,CAAS;IAGlC,OAAO,CAAC,qBAAqB,CAAgC;gBAEjD,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,MAAM;IAO/C;;;;;;;;;;;OAWG;IACG,cAAc,CAClB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,cAAc,CAAC,EAAE,MAAM,CAAC;KACpB,GACL,OAAO,CAAC,sBAAsB,CAAC;IAuIlC;;OAEG;IACH,OAAO,CAAC,aAAa;IAkBrB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAU5B;;OAEG;IACH,OAAO,CAAC,eAAe;IAQvB;;OAEG;YACW,gBAAgB;IAkB9B;;;OAGG;YACW,yBAAyB;IAiBvC;;OAEG;YACW,eAAe;IAmD7B;;OAEG;YACW,cAAc;IA8B5B;;;OAGG;YACW,cAAc;IAsC5B;;OAEG;IACH,OAAO,CAAC,eAAe;IAKvB;;OAEG;IACH,OAAO,CAAC,eAAe;IAMvB;;OAEG;YACW,mBAAmB;IAyBjC;;;;;OAKG;YACW,oBAAoB;IAqClC;;OAEG;YACW,mBAAmB;IAoCjC;;OAEG;YACW,iBAAiB;IAiB/B;;OAEG;YACW,YAAY;IAa1B;;OAEG;YACW,OAAO;IAuBrB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IA2BxB;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAiBvE"}