@figma/code-connect/dist/connect/figma_rest_api.d.ts

A tool for connecting your design system components in code with your design system in Figma

export declare function getApiUrl(figmaNode: string, apiUrlOverride?: string): string;
export declare function getHeaders(accessToken: string): {
    'X-Figma-Token': string;
    'Content-Type': string;
    'User-Agent': string;
};
export declare namespace FigmaRestApi {
    enum ComponentPropertyType {
        Boolean = "BOOLEAN",
        InstanceSwap = "INSTANCE_SWAP",
        Text = "TEXT",
        Variant = "VARIANT"
    }
    interface ComponentPropertyDefinition {
        defaultValue: boolean | string;
        type: ComponentPropertyType;
        /**
         * All possible values for this property. Only exists on VARIANT properties
         */
        variantOptions?: string[];
        /**
         * Only exists on INSTANCE_SWAP  properties
         */
        preferredValues?: {
            type: string;
            key: string;
        }[];
    }
    interface Node {
        type: 'COMPONENT' | 'COMPONENT_SET' | 'OTHER' | 'CANVAS';
        name: string;
        id: string;
        children: Node[];
    }
    interface NodeWithPageInfo extends Node {
        pageId: string;
        pageName: string;
    }
    interface Component extends NodeWithPageInfo {
        type: 'COMPONENT' | 'COMPONENT_SET';
        componentPropertyDefinitions: Record<string, ComponentPropertyDefinition>;
    }
}
export declare function getDocument(url: string, accessToken: string): Promise<FigmaRestApi.Node>;
//# sourceMappingURL=figma_rest_api.d.ts.map