@rnsk/toolkits 0.0.6 → 0.0.8

package/dist/toolkits/figma/tools/index.d.ts

@@ -0,0 +1,629 @@
+import { addCommentToAFile } from './add-comment-to-a-file.js';
+import { addReactionToAComment } from './add-reaction-to-a-comment.js';
+import { createAWebhook } from './create-a-webhook.js';
+import { createDevResources } from './create-dev-resources.js';
+import { createModifyDeleteVariables } from './create-modify-delete-variables.js';
+import { deleteAComment } from './delete-a-comment.js';
+import { deleteAReaction } from './delete-a-reaction.js';
+import { deleteAWebhook } from './delete-a-webhook.js';
+import { deleteDevResource } from './delete-dev-resource.js';
+import { designTokensToTailwind } from './design-tokens-to-tailwind.js';
+import { detectBackground } from './detect-background.js';
+import { discoverFigmaResources } from './discover-figma-resources.js';
+import { downloadFigmaImages } from './download-figma-images.js';
+import { extractDesignTokens } from './extract-design-tokens.js';
+import { extractPrototypeInteractions } from './extract-prototype-interactions.js';
+import { getActivityLogs } from './get-activity-logs.js';
+import { getAWebhook } from './get-a-webhook.js';
+import { getCommentsInAFile } from './get-comments-in-a-file.js';
+import { getComponent2 } from './get-component2.js';
+import { getComponentSet } from './get-component-set.js';
+import { getCurrentUser } from './get-current-user.js';
+import { getDevResources } from './get-dev-resources.js';
+import { getFileComponentSets } from './get-file-component-sets.js';
+import { getFileComponents } from './get-file-components.js';
+import { getFileJson } from './get-file-json.js';
+import { getFileMetadata } from './get-file-metadata.js';
+import { getFileNodes } from './get-file-nodes.js';
+import { getFileStyles } from './get-file-styles.js';
+import { getFilesInAProject } from './get-files-in-a-project.js';
+import { getImageFills } from './get-image-fills.js';
+import { getLibraryAnalyticsComponentActionData } from './get-library-analytics-component-action-data.js';
+import { getLibraryAnalyticsComponentUsageData } from './get-library-analytics-component-usage-data.js';
+import { getLibraryAnalyticsStyleActionData } from './get-library-analytics-style-action-data.js';
+import { getLibraryAnalyticsStyleUsageData } from './get-library-analytics-style-usage-data.js';
+import { getLibraryAnalyticsVariableActionData } from './get-library-analytics-variable-action-data.js';
+import { getLibraryAnalyticsVariableUsageData } from './get-library-analytics-variable-usage-data.js';
+import { getLocalVariables } from './get-local-variables.js';
+import { getPayments } from './get-payments.js';
+import { getProjectsInATeam } from './get-projects-in-a-team.js';
+import { getPublishedVariables } from './get-published-variables.js';
+import { getReactionsForAComment } from './get-reactions-for-a-comment.js';
+import { getScimServiceProviderConfig } from './get-scim-service-provider-config.js';
+import { getStyle } from './get-style.js';
+import { getTeamComponentSets } from './get-team-component-sets.js';
+import { getTeamComponents } from './get-team-components.js';
+import { getTeamStyles } from './get-team-styles.js';
+import { getTeamWebhooks } from './get-team-webhooks.js';
+import { getVersionsOfAFile } from './get-versions-of-a-file.js';
+import { getWebhookRequests } from './get-webhook-requests.js';
+import { renderImagesOfFileNodes } from './render-images-of-file-nodes.js';
+import { updateAWebhook } from './update-a-webhook.js';
+import { updateDevResources } from './update-dev-resources.js';
+export { addCommentToAFile, addReactionToAComment, createAWebhook, createDevResources, createModifyDeleteVariables, deleteAComment, deleteAReaction, deleteAWebhook, deleteDevResource, designTokensToTailwind, detectBackground, discoverFigmaResources, downloadFigmaImages, extractDesignTokens, extractPrototypeInteractions, getActivityLogs, getAWebhook, getCommentsInAFile, getComponent2, getComponentSet, getCurrentUser, getDevResources, getFileComponentSets, getFileComponents, getFileJson, getFileMetadata, getFileNodes, getFileStyles, getFilesInAProject, getImageFills, getLibraryAnalyticsComponentActionData, getLibraryAnalyticsComponentUsageData, getLibraryAnalyticsStyleActionData, getLibraryAnalyticsStyleUsageData, getLibraryAnalyticsVariableActionData, getLibraryAnalyticsVariableUsageData, getLocalVariables, getPayments, getProjectsInATeam, getPublishedVariables, getReactionsForAComment, getScimServiceProviderConfig, getStyle, getTeamComponentSets, getTeamComponents, getTeamStyles, getTeamWebhooks, getVersionsOfAFile, getWebhookRequests, renderImagesOfFileNodes, updateAWebhook, updateDevResources, };
+export declare const figmaTools: ({
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        message: string;
+        figmaToken: string;
+        fileKey: string;
+        commentId?: string | undefined;
+        clientMeta?: Record<string, any> | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        emoji: string;
+        commentId: string;
+        figmaToken: string;
+        fileKey: string;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        eventType: "FILE_COMMENT" | "FILE_DELETE" | "FILE_UPDATE" | "FILE_VERSION_UPDATE" | "LIBRARY_PUBLISH";
+        endpoint: string;
+        figmaToken: string;
+        passcode: string;
+        status?: "ACTIVE" | "PAUSED" | undefined;
+        description?: string | undefined;
+        teamId?: string | undefined;
+        context?: "team" | "file" | "project" | undefined;
+        contextId?: string | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        devResources: {
+            url: string;
+            name: string;
+            fileKey: string;
+            nodeId: string;
+        }[];
+    }, {
+        error: string;
+        details: unknown[];
+        links_created?: undefined;
+        errors?: undefined;
+        message?: undefined;
+    } | {
+        links_created: unknown[];
+        errors: unknown[];
+        error?: undefined;
+        details?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        details?: undefined;
+        links_created?: undefined;
+        errors?: undefined;
+    }>;
+    requiredAuth: "figmaToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        fileKey: string;
+        variableCollections?: Record<string, any>[] | undefined;
+        variableModes?: Record<string, any>[] | undefined;
+        variables?: Record<string, any>[] | undefined;
+        variableModeValues?: Record<string, any>[] | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        commentId: string;
+        figmaToken: string;
+        fileKey: string;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "delete";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        emoji: string;
+        commentId: string;
+        figmaToken: string;
+        fileKey: string;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "delete";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        webhookId: string;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "delete";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        fileKey: string;
+        devResourceId: string;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "delete";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        tokens: Record<string, any>;
+        prefix?: string | undefined;
+        configFormat?: string | undefined;
+        includeFontImports?: boolean | undefined;
+    }, {
+        config_content: string;
+        globals_css: string | undefined;
+        token_summary: {
+            colors: number;
+            fontFamilies: number;
+            spacing: number;
+            borderRadius: number;
+            boxShadow: number;
+            total: number;
+        };
+        error?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        config_content?: undefined;
+        globals_css?: undefined;
+        token_summary?: undefined;
+    }>;
+    scope: "read";
+    requiredAuth?: undefined;
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        fileKey: string;
+        targetNodeIds: string[];
+        searchDepth?: number | undefined;
+    }, {
+        error: string;
+        details: any;
+        backgrounds?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        details?: undefined;
+        backgrounds?: undefined;
+        message?: undefined;
+    } | {
+        backgrounds: Record<string, Record<string, unknown>[]>;
+        error?: undefined;
+        details?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        details?: undefined;
+        backgrounds?: undefined;
+    }>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        teamId?: string | undefined;
+        projectId?: string | undefined;
+        fileKey?: string | undefined;
+        figmaUrl?: string | undefined;
+        maxDepth?: number | undefined;
+    }, {
+        extracted_ids: {
+            fileKey?: string;
+            nodeId?: string;
+            teamId?: string;
+            projectId?: string;
+        };
+        projects: Record<string, unknown>[];
+        files: Record<string, unknown>[];
+        nodes: import("./discover-figma-resources.js").NodeInfo[];
+        errors: string[];
+        instructions: string[];
+        error?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        extracted_ids?: undefined;
+        projects?: undefined;
+        files?: undefined;
+        nodes?: undefined;
+        errors?: undefined;
+        instructions?: undefined;
+    }>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        images: {
+            fileName: string;
+            nodeId: string;
+            format?: string | undefined;
+        }[];
+        figmaToken: string;
+        fileKey: string;
+        scale?: number | undefined;
+        svgIncludeId?: boolean | undefined;
+        svgOutlineText?: boolean | undefined;
+        svgSimplifyStroke?: boolean | undefined;
+    }, {
+        downloaded_images: Record<string, unknown>[];
+        successful_count: number;
+        failed_count: number;
+        error?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        downloaded_images?: undefined;
+        successful_count?: undefined;
+        failed_count?: undefined;
+    }>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        fileKey: string;
+        includeVariables?: boolean | undefined;
+        includeLocalStyles?: boolean | undefined;
+        extractFromNodes?: boolean | undefined;
+    }, {
+        error: string;
+        details: any;
+        colors?: undefined;
+        typography?: undefined;
+        spacing?: undefined;
+        border_radius?: undefined;
+        shadows?: undefined;
+        total_tokens?: undefined;
+        sources?: undefined;
+        message?: undefined;
+    } | {
+        colors: {
+            name: string;
+            value: string;
+            source: string;
+            usage_count: number;
+        }[];
+        typography: Record<string, unknown>[];
+        spacing: Record<string, unknown>[];
+        border_radius: Record<string, unknown>[];
+        shadows: Record<string, unknown>[];
+        total_tokens: number;
+        sources: Record<string, number>;
+        error?: undefined;
+        details?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        details?: undefined;
+        colors?: undefined;
+        typography?: undefined;
+        spacing?: undefined;
+        border_radius?: undefined;
+        shadows?: undefined;
+        total_tokens?: undefined;
+        sources?: undefined;
+    }>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        fileKey: string;
+        analyzeComponents?: boolean | undefined;
+        includeAnimations?: boolean | undefined;
+    }, {
+        error: string;
+        details: any;
+        interactions?: undefined;
+        component_states?: undefined;
+        prototype_flows?: undefined;
+        total_interactions?: undefined;
+        animation_types_used?: undefined;
+        message?: undefined;
+    } | {
+        interactions: Record<string, unknown>[];
+        component_states: Record<string, unknown>[];
+        prototype_flows: {
+            name: string;
+            starting_node_id: string;
+            nodes_in_flow: string[];
+        }[];
+        total_interactions: number;
+        animation_types_used: string[];
+        error?: undefined;
+        details?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        details?: undefined;
+        interactions?: undefined;
+        component_states?: undefined;
+        prototype_flows?: undefined;
+        total_interactions?: undefined;
+        animation_types_used?: undefined;
+    }>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        limit?: number | undefined;
+        order?: "asc" | "desc" | undefined;
+        events?: string | undefined;
+        startTime?: number | undefined;
+        endTime?: number | undefined;
+        cursor?: string | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        webhookId: string;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        fileKey: string;
+        asMd?: boolean | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        key: string;
+        figmaToken: string;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        fileKey: string;
+        nodeIds?: string | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        fileKey: string;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        fileKey: string;
+        version?: string | undefined;
+        ids?: string | undefined;
+        depth?: number | undefined;
+        geometry?: string | undefined;
+        branchData?: boolean | undefined;
+        pluginData?: string | undefined;
+        responseDetail?: "minimal" | "full" | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        fileKey: string;
+        ids: string | string[];
+        version?: string | undefined;
+        depth?: number | undefined;
+        geometry?: string | undefined;
+        pluginData?: string | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        projectId: string;
+        figmaToken: string;
+        branchData?: boolean | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        [x: string]: any;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        userId?: number | undefined;
+        pluginId?: number | undefined;
+        widgetId?: number | undefined;
+        communityFileId?: number | undefined;
+        pluginPaymentToken?: string | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        teamId: string;
+        figmaToken: string;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        commentId: string;
+        figmaToken: string;
+        fileKey: string;
+        cursor?: string | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        teamId: string;
+        figmaToken: string;
+        before?: number | undefined;
+        after?: number | undefined;
+        pageSize?: number | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        contextId: string;
+        context?: "team" | "file" | "project" | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        fileKey: string;
+        before?: number | undefined;
+        after?: number | undefined;
+        pageSize?: number | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        fileKey: string;
+        ids: string;
+        version?: string | undefined;
+        format?: "svg" | "png" | "jpg" | "pdf" | undefined;
+        scale?: number | undefined;
+        svgIncludeId?: boolean | undefined;
+        svgOutlineText?: boolean | undefined;
+        svgSimplifyStroke?: boolean | undefined;
+        contentsOnly?: boolean | undefined;
+        useAbsoluteBounds?: boolean | undefined;
+        svgIncludeNodeId?: boolean | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        webhookId: string;
+        status?: "ACTIVE" | "PAUSED" | undefined;
+        description?: string | undefined;
+        eventType?: "FILE_COMMENT" | "FILE_DELETE" | "FILE_UPDATE" | "FILE_VERSION_UPDATE" | "LIBRARY_PUBLISH" | "PING" | undefined;
+        endpoint?: string | undefined;
+        passcode?: string | undefined;
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        figmaToken: string;
+        fileKey: string;
+        devResources: {
+            id: string;
+            url?: string | undefined;
+            name?: string | undefined;
+        }[];
+    }, any>;
+    requiredAuth: "figmaToken";
+    scope: "write";
+})[];
+//# sourceMappingURL=index.d.ts.map