@mp3wizard/figma-console-mcp 1.14.0

package/dist/core/figma-desktop-connector.d.ts

@@ -0,0 +1,265 @@
+/**
+ * Figma Desktop Connector
+ *
+ * This service connects directly to Figma Desktop's plugin context
+ * to execute code with access to the full Figma Plugin API,
+ * including variables without Enterprise access.
+ *
+ * Uses Puppeteer's Worker API to directly access plugin workers.
+ * Note: This is a legacy connector maintained for backwards compatibility.
+ * The WebSocket Desktop Bridge plugin is the primary connection method.
+ */
+import { Page } from 'puppeteer-core';
+import type { IFigmaConnector } from './figma-connector.js';
+export declare class FigmaDesktopConnector implements IFigmaConnector {
+    private page;
+    private cachedPluginFrame;
+    private static readonly DEBUG;
+    constructor(page: Page);
+    /**
+     * Clear the cached plugin UI frame reference.
+     * Called automatically when a detached frame is detected.
+     */
+    clearFrameCache(): void;
+    /**
+     * Conditionally log to Figma's browser console (only when DEBUG is enabled).
+     * Skips the CDP roundtrip entirely in production, eliminating ~5-15ms per call.
+     */
+    private logToFigmaConsole;
+    /**
+     * Initialize connection to Figma Desktop's plugin context
+     * No setup needed - Puppeteer handles worker access automatically
+     */
+    initialize(): Promise<void>;
+    getTransportType(): 'cdp' | 'websocket';
+    /**
+     * Execute code in Figma's plugin context where the figma API is available
+     * Uses Puppeteer's direct worker access instead of CDP context enumeration
+     */
+    executeInPluginContext<T = any>(code: string): Promise<T>;
+    /**
+     * Get Figma variables from plugin UI window object
+     * This bypasses Figma's plugin sandbox security restrictions
+     * by accessing data that the plugin posted to its UI iframe
+     */
+    getVariablesFromPluginUI(fileKey?: string): Promise<any>;
+    /**
+     * Get component data by node ID from plugin UI window object
+     * This bypasses the REST API bug where descriptions are missing
+     * by accessing data from the Desktop Bridge plugin via its UI iframe
+     */
+    getComponentFromPluginUI(nodeId: string): Promise<any>;
+    /**
+     * Get Figma variables using the desktop connection
+     * This bypasses the Enterprise requirement!
+     */
+    getVariables(fileKey?: string): Promise<any>;
+    /**
+     * Clean up resources (no-op since we use Puppeteer's built-in worker management)
+     */
+    /**
+     * Get component data by node ID using Plugin API
+     * This bypasses the REST API bug where descriptions are missing
+     */
+    getComponentByNodeId(nodeId: string): Promise<any>;
+    dispose(): Promise<void>;
+    /**
+     * Find the Desktop Bridge plugin UI iframe
+     * Returns the frame that has the write operation functions
+     * Handles detached frame errors gracefully
+     */
+    private findPluginUIFrame;
+    /**
+     * Execute arbitrary code in Figma's plugin context
+     * This is the power tool that can run any Figma Plugin API code
+     * Includes retry logic for detached frame errors
+     */
+    executeCodeViaUI(code: string, timeout?: number): Promise<any>;
+    /**
+     * Update a variable's value in a specific mode
+     */
+    updateVariable(variableId: string, modeId: string, value: any): Promise<any>;
+    /**
+     * Create a new variable in a collection
+     */
+    createVariable(name: string, collectionId: string, resolvedType: 'COLOR' | 'FLOAT' | 'STRING' | 'BOOLEAN', options?: {
+        valuesByMode?: Record<string, any>;
+        description?: string;
+        scopes?: string[];
+    }): Promise<any>;
+    /**
+     * Create a new variable collection
+     */
+    createVariableCollection(name: string, options?: {
+        initialModeName?: string;
+        additionalModes?: string[];
+    }): Promise<any>;
+    /**
+     * Delete a variable
+     */
+    deleteVariable(variableId: string): Promise<any>;
+    /**
+     * Delete a variable collection
+     */
+    deleteVariableCollection(collectionId: string): Promise<any>;
+    /**
+     * Refresh variables data from Figma
+     */
+    refreshVariables(): Promise<any>;
+    /**
+     * Rename a variable
+     */
+    renameVariable(variableId: string, newName: string): Promise<any>;
+    /**
+     * Set the description on a variable (not a node — variables use a separate API)
+     */
+    setVariableDescription(variableId: string, description: string): Promise<any>;
+    /**
+     * Add a mode to a variable collection
+     */
+    addMode(collectionId: string, modeName: string): Promise<any>;
+    /**
+     * Rename a mode in a variable collection
+     */
+    renameMode(collectionId: string, modeId: string, newName: string): Promise<any>;
+    /**
+     * Get all local components for design system manifest generation
+     */
+    getLocalComponents(): Promise<{
+        success: boolean;
+        data?: {
+            components: any[];
+            componentSets: any[];
+            totalComponents: number;
+            totalComponentSets: number;
+            fileKey: string;
+            timestamp: number;
+        };
+        error?: string;
+    }>;
+    /**
+     * Instantiate a component with overrides
+     * Supports both published library components (by key) and local components (by nodeId)
+     */
+    instantiateComponent(componentKey: string, options?: {
+        nodeId?: string;
+        position?: {
+            x: number;
+            y: number;
+        };
+        size?: {
+            width: number;
+            height: number;
+        };
+        overrides?: Record<string, any>;
+        variant?: Record<string, string>;
+        parentId?: string;
+    }): Promise<{
+        success: boolean;
+        instance?: {
+            id: string;
+            name: string;
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        error?: string;
+    }>;
+    /**
+     * Set description on a component or style
+     */
+    setNodeDescription(nodeId: string, description: string, descriptionMarkdown?: string): Promise<any>;
+    /**
+     * Add a component property
+     */
+    addComponentProperty(nodeId: string, propertyName: string, type: 'BOOLEAN' | 'TEXT' | 'INSTANCE_SWAP' | 'VARIANT', defaultValue: any, options?: {
+        preferredValues?: any[];
+    }): Promise<any>;
+    /**
+     * Edit an existing component property
+     */
+    editComponentProperty(nodeId: string, propertyName: string, newValue: {
+        name?: string;
+        defaultValue?: any;
+        preferredValues?: any[];
+    }): Promise<any>;
+    /**
+     * Delete a component property
+     */
+    deleteComponentProperty(nodeId: string, propertyName: string): Promise<any>;
+    /**
+     * Resize a node
+     */
+    resizeNode(nodeId: string, width: number, height: number, withConstraints?: boolean): Promise<any>;
+    /**
+     * Move/position a node
+     */
+    moveNode(nodeId: string, x: number, y: number): Promise<any>;
+    /**
+     * Set fills (colors) on a node
+     */
+    setNodeFills(nodeId: string, fills: any[]): Promise<any>;
+    /**
+     * Set strokes on a node
+     */
+    setNodeStrokes(nodeId: string, strokes: any[], strokeWeight?: number): Promise<any>;
+    /**
+     * Set opacity on a node
+     */
+    setNodeOpacity(nodeId: string, opacity: number): Promise<any>;
+    /**
+     * Set corner radius on a node
+     */
+    setNodeCornerRadius(nodeId: string, radius: number): Promise<any>;
+    /**
+     * Clone/duplicate a node
+     */
+    cloneNode(nodeId: string): Promise<any>;
+    /**
+     * Delete a node
+     */
+    deleteNode(nodeId: string): Promise<any>;
+    /**
+     * Rename a node
+     */
+    renameNode(nodeId: string, newName: string): Promise<any>;
+    /**
+     * Set text content on a text node
+     */
+    setTextContent(nodeId: string, text: string, options?: {
+        fontSize?: number;
+    }): Promise<any>;
+    /**
+     * Create a child node
+     */
+    createChildNode(parentId: string, nodeType: 'RECTANGLE' | 'ELLIPSE' | 'FRAME' | 'TEXT' | 'LINE' | 'POLYGON' | 'STAR' | 'VECTOR', properties?: {
+        name?: string;
+        x?: number;
+        y?: number;
+        width?: number;
+        height?: number;
+        fills?: any[];
+        text?: string;
+    }): Promise<any>;
+    /**
+     * Capture screenshot via plugin's exportAsync
+     */
+    captureScreenshot(nodeId: string, options?: {
+        format?: string;
+        scale?: number;
+    }): Promise<any>;
+    /**
+     * Set component instance properties
+     */
+    setInstanceProperties(nodeId: string, properties: any): Promise<any>;
+    /**
+     * Set image fill on one or more nodes (decodes base64 in browser bridge, sends bytes to plugin)
+     */
+    setImageFill(nodeIds: string[], imageData: string, scaleMode?: string): Promise<any>;
+    /**
+     * Lint design for accessibility and quality issues via plugin UI
+     */
+    lintDesign(nodeId?: string, rules?: string[], maxDepth?: number, maxFindings?: number): Promise<any>;
+}
+//# sourceMappingURL=figma-desktop-connector.d.ts.map

package/dist/core/figma-desktop-connector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"figma-desktop-connector.d.ts","sourceRoot":"","sources":["../../src/core/figma-desktop-connector.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAEtC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D,qBAAa,qBAAsB,YAAW,eAAe;IAC3D,OAAO,CAAC,IAAI,CAAO;IACnB,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAA6D;gBAE9E,IAAI,EAAE,IAAI;IAItB;;;OAGG;IACH,eAAe,IAAI,IAAI;IAOvB;;;OAGG;YACW,iBAAiB;IAS/B;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAIjC,gBAAgB,IAAI,KAAK,GAAG,WAAW;IAIvC;;;OAGG;IACG,sBAAsB,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAkE/D;;;;OAIG;IACG,wBAAwB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAqG9D;;;;OAIG;IACG,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAuG5D;;;OAGG;IACG,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkFlD;;OAEG;IAEH;;;OAGG;IACG,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAuGlD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ9B;;;;OAIG;YACW,iBAAiB;IAiD/B;;;;OAIG;IACG,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,MAAa,GAAG,OAAO,CAAC,GAAG,CAAC;IA+D1E;;OAEG;IACG,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IA2BlF;;OAEG;IACG,cAAc,CAClB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,EACtD,OAAO,CAAC,EAAE;QACR,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnC,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,GACA,OAAO,CAAC,GAAG,CAAC;IA2Bf;;OAEG;IACG,wBAAwB,CAC5B,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;KAC5B,GACA,OAAO,CAAC,GAAG,CAAC;IA2Bf;;OAEG;IACG,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IA2BtD;;OAEG;IACG,wBAAwB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IA2BlE;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;IAgCtC;;OAEG;IACG,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAsCvE;;OAEG;IACG,sBAAsB,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IA2BnF;;OAEG;IACG,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IA2BnE;;OAEG;IACG,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IA6CrF;;OAEG;IACG,kBAAkB,IAAI,OAAO,CAAC;QAClC,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,CAAC,EAAE;YACL,UAAU,EAAE,GAAG,EAAE,CAAC;YAClB,aAAa,EAAE,GAAG,EAAE,CAAC;YACrB,eAAe,EAAE,MAAM,CAAC;YACxB,kBAAkB,EAAE,MAAM,CAAC;YAC3B,OAAO,EAAE,MAAM,CAAC;YAChB,SAAS,EAAE,MAAM,CAAC;SACnB,CAAC;QACF,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IAgCF;;;OAGG;IACG,oBAAoB,CACxB,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;QACpC,IAAI,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAC;QACzC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GACA,OAAO,CAAC;QACT,OAAO,EAAE,OAAO,CAAC;QACjB,QAAQ,CAAC,EAAE;YACT,EAAE,EAAE,MAAM,CAAC;YACX,IAAI,EAAE,MAAM,CAAC;YACb,CAAC,EAAE,MAAM,CAAC;YACV,CAAC,EAAE,MAAM,CAAC;YACV,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IA+BF;;OAEG;IACG,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBzG;;OAEG;IACG,oBAAoB,CACxB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,eAAe,GAAG,SAAS,EACtD,YAAY,EAAE,GAAG,EACjB,OAAO,CAAC,EAAE;QAAE,eAAe,CAAC,EAAE,GAAG,EAAE,CAAA;KAAE,GACpC,OAAO,CAAC,GAAG,CAAC;IAkBf;;OAEG;IACG,qBAAqB,CACzB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,GAAG,CAAC;QAAC,eAAe,CAAC,EAAE,GAAG,EAAE,CAAA;KAAE,GACvE,OAAO,CAAC,GAAG,CAAC;IAkBf;;OAEG;IACG,uBAAuB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAsBjF;;OAEG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,GAAE,OAAc,GAAG,OAAO,CAAC,GAAG,CAAC;IAkB9G;;OAEG;IACG,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBlE;;OAEG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAkB9D;;OAEG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBzF;;OAEG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBnE;;OAEG;IACG,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBvE;;OAEG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkB7C;;OAEG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkB9C;;OAEG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkB/D;;OAEG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBjG;;OAEG;IACG,eAAe,CACnB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,WAAW,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,EAC7F,UAAU,CAAC,EAAE;QACX,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,CAAC,CAAC,EAAE,MAAM,CAAC;QACX,CAAC,CAAC,EAAE,MAAM,CAAC;QACX,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,GACA,OAAO,CAAC,GAAG,CAAC;IAsBf;;OAEG;IACG,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBpG;;OAEG;IACG,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAkB1E;;OAEG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;IAkB1F;;OAEG;IACG,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAiB3G"}