@corsair-dev/figma 0.1.0

package/dist/endpoints/index.d.ts

@@ -0,0 +1,717 @@
+export declare const Comments: {
+    add: (ctx: import("..").FigmaContext, args: {
+        message: string;
+        file_key: string;
+        client_meta?: unknown;
+        comment_id?: string | undefined;
+    }) => Promise<{
+        id: string;
+        created_at?: string | undefined;
+        message?: string | undefined;
+        user?: {
+            id: string;
+            handle?: string | undefined;
+            img_url?: string | undefined;
+        } | undefined;
+        uuid?: string | null | undefined;
+        file_key?: string | undefined;
+        order_id?: string | null | undefined;
+        parent_id?: string | null | undefined;
+        reactions?: {
+            created_at?: string | undefined;
+            user?: {
+                id: string;
+                handle?: string | undefined;
+                img_url?: string | undefined;
+            } | undefined;
+            emoji?: string | undefined;
+        }[] | undefined;
+        client_meta?: unknown;
+        resolved_at?: string | null | undefined;
+    }>;
+    delete: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        comment_id: string;
+    }) => Promise<{
+        status?: number | undefined;
+        error?: boolean | undefined;
+    }>;
+    list: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        as_md?: boolean | undefined;
+    }) => Promise<{
+        comments?: {
+            id: string;
+            created_at?: string | undefined;
+            message?: string | undefined;
+            user?: {
+                id: string;
+                handle?: string | undefined;
+                img_url?: string | undefined;
+            } | undefined;
+            uuid?: string | null | undefined;
+            file_key?: string | undefined;
+            order_id?: string | null | undefined;
+            parent_id?: string | null | undefined;
+            reactions?: {
+                created_at?: string | undefined;
+                user?: {
+                    id: string;
+                    handle?: string | undefined;
+                    img_url?: string | undefined;
+                } | undefined;
+                emoji?: string | undefined;
+            }[] | undefined;
+            client_meta?: unknown;
+            resolved_at?: string | null | undefined;
+        }[] | undefined;
+    }>;
+    getReactions: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        comment_id: string;
+        cursor?: string | undefined;
+    }) => Promise<{
+        reactions?: {
+            created_at?: string | undefined;
+            user?: {
+                id: string;
+                handle?: string | undefined;
+                img_url?: string | undefined;
+            } | undefined;
+            emoji?: string | undefined;
+        }[] | undefined;
+        pagination?: {
+            cursor?: string | undefined;
+        } | undefined;
+    }>;
+    addReaction: (ctx: import("..").FigmaContext, args: {
+        emoji: string;
+        file_key: string;
+        comment_id: string;
+    }) => Promise<{
+        status?: number | undefined;
+        error?: boolean | undefined;
+    }>;
+    deleteReaction: (ctx: import("..").FigmaContext, args: {
+        emoji: string;
+        file_key: string;
+        comment_id: string;
+    }) => Promise<{
+        status?: number | undefined;
+        error?: boolean | undefined;
+    }>;
+};
+export declare const Webhooks: {
+    create: (ctx: import("..").FigmaContext, args: {
+        event_type: string;
+        endpoint: string;
+        passcode: string;
+        status?: "ACTIVE" | "PAUSED" | undefined;
+        description?: string | undefined;
+        context?: string | undefined;
+        team_id?: string | undefined;
+        context_id?: string | undefined;
+    }) => Promise<{
+        id: string;
+        status?: "ACTIVE" | "PAUSED" | undefined;
+        event_type?: string | undefined;
+        endpoint?: string | undefined;
+        client_id?: string | null | undefined;
+        description?: string | null | undefined;
+        context?: "team" | "project" | "file" | null | undefined;
+        team_id?: string | null | undefined;
+        passcode?: string | undefined;
+        context_id?: string | null | undefined;
+    }>;
+    delete: (ctx: import("..").FigmaContext, args: {
+        webhook_id: string;
+    }) => Promise<{
+        id?: string | undefined;
+        status?: "ACTIVE" | "PAUSED" | undefined;
+        event_type?: string | undefined;
+        endpoint?: string | undefined;
+        client_id?: string | null | undefined;
+        description?: string | null | undefined;
+        context?: "team" | "project" | "file" | null | undefined;
+        team_id?: string | null | undefined;
+        passcode?: string | undefined;
+        context_id?: string | null | undefined;
+    }>;
+    get: (ctx: import("..").FigmaContext, args: {
+        webhook_id: string;
+    }) => Promise<{
+        id: string;
+        status?: "ACTIVE" | "PAUSED" | undefined;
+        event_type?: string | undefined;
+        endpoint?: string | undefined;
+        client_id?: string | null | undefined;
+        description?: string | null | undefined;
+        context?: "team" | "project" | "file" | null | undefined;
+        team_id?: string | null | undefined;
+        passcode?: string | undefined;
+        context_id?: string | null | undefined;
+    }>;
+    list: (ctx: import("..").FigmaContext, args: {
+        context?: string | undefined;
+        context_id?: string | undefined;
+    }) => Promise<{
+        webhooks?: {
+            id: string;
+            status?: "ACTIVE" | "PAUSED" | undefined;
+            event_type?: string | undefined;
+            endpoint?: string | undefined;
+            client_id?: string | null | undefined;
+            description?: string | null | undefined;
+            context?: "team" | "project" | "file" | null | undefined;
+            team_id?: string | null | undefined;
+            passcode?: string | undefined;
+            context_id?: string | null | undefined;
+        }[] | undefined;
+    }>;
+    getRequests: (ctx: import("..").FigmaContext, args: {
+        webhook_id: string;
+    }) => Promise<{
+        requests?: {
+            id: string;
+            webhook_id: string;
+            created_at?: string | undefined;
+            status?: string | undefined;
+            error?: import("zod").objectOutputType<{}, import("zod").ZodTypeAny, "passthrough"> | undefined;
+        }[] | undefined;
+    }>;
+    update: (ctx: import("..").FigmaContext, args: {
+        webhook_id: string;
+        status?: "ACTIVE" | "PAUSED" | undefined;
+        event_type?: string | undefined;
+        endpoint?: string | undefined;
+        description?: string | undefined;
+        passcode?: string | undefined;
+    }) => Promise<{
+        id: string;
+        status?: "ACTIVE" | "PAUSED" | undefined;
+        event_type?: string | undefined;
+        endpoint?: string | undefined;
+        client_id?: string | null | undefined;
+        description?: string | null | undefined;
+        context?: "team" | "project" | "file" | null | undefined;
+        team_id?: string | null | undefined;
+        passcode?: string | undefined;
+        context_id?: string | null | undefined;
+    }>;
+};
+export declare const DevResources: {
+    create: (ctx: import("..").FigmaContext, args: {
+        dev_resources: {
+            name: string;
+            file_key: string;
+            node_id: string;
+            url: string;
+        }[];
+    }) => Promise<{
+        links_created?: {
+            id: string;
+            name: string;
+            file_key: string;
+            node_id: string;
+            url: string;
+        }[] | undefined;
+        errors?: {
+            error: string;
+            file_key?: string | undefined;
+            node_id?: string | undefined;
+        }[] | undefined;
+    }>;
+    delete: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        dev_resource_id: string;
+    }) => Promise<{}>;
+    get: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        node_ids?: string | undefined;
+    }) => Promise<{
+        dev_resources?: {
+            id: string;
+            name: string;
+            file_key: string;
+            node_id: string;
+            url: string;
+        }[] | undefined;
+    }>;
+    update: (ctx: import("..").FigmaContext, args: {
+        dev_resources: {
+            id: string;
+            name?: string | undefined;
+            url?: string | undefined;
+        }[];
+    }) => Promise<{
+        errors?: {
+            error: string;
+            dev_resource_id?: string | undefined;
+        }[] | undefined;
+        links_updated?: {
+            id: string;
+            name?: string | undefined;
+            url?: string | undefined;
+        }[] | undefined;
+    }>;
+};
+export declare const Variables: {
+    createModifyDelete: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        variables?: unknown[] | undefined;
+        variableModes?: unknown[] | undefined;
+        variableModeValues?: unknown[] | undefined;
+        variableCollections?: unknown[] | undefined;
+    }) => Promise<{
+        status?: number | undefined;
+        error?: boolean | undefined;
+        meta?: {
+            tempIdToRealId?: Record<string, string> | undefined;
+        } | undefined;
+    }>;
+    getLocal: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+    }) => Promise<{
+        status?: number | undefined;
+        error?: boolean | undefined;
+        meta?: {
+            variables?: Record<string, unknown> | undefined;
+            variableCollections?: Record<string, unknown> | undefined;
+        } | undefined;
+    }>;
+    getPublished: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+    }) => Promise<{
+        status?: number | undefined;
+        error?: boolean | undefined;
+        meta?: {
+            variables?: Record<string, unknown> | undefined;
+            variableCollections?: Record<string, unknown> | undefined;
+        } | undefined;
+    }>;
+};
+export declare const Components: {
+    get: (ctx: import("..").FigmaContext, args: {
+        key: string;
+    }) => Promise<{
+        status?: number | undefined;
+        meta?: {
+            component?: {
+                key: string;
+                created_at?: string | undefined;
+                updated_at?: string | undefined;
+                name?: string | undefined;
+                description?: string | undefined;
+                user?: {
+                    id: string;
+                    handle?: string | undefined;
+                    img_url?: string | undefined;
+                } | undefined;
+                file_key?: string | undefined;
+                node_id?: string | undefined;
+                thumbnail_url?: string | undefined;
+                containing_frame?: {
+                    name?: string | undefined;
+                    node_id?: string | undefined;
+                } | undefined;
+            } | undefined;
+        } | undefined;
+    }>;
+    getComponentSet: (ctx: import("..").FigmaContext, args: {
+        key: string;
+    }) => Promise<{
+        status?: number | undefined;
+        meta?: {
+            component_set?: {
+                key: string;
+                name?: string | undefined;
+                description?: string | undefined;
+                thumbnail_url?: string | undefined;
+            } | undefined;
+        } | undefined;
+    }>;
+    getForFile: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+    }) => Promise<{
+        status?: number | undefined;
+        meta?: {
+            components?: {
+                key: string;
+                created_at?: string | undefined;
+                updated_at?: string | undefined;
+                name?: string | undefined;
+                description?: string | undefined;
+                user?: {
+                    id: string;
+                    handle?: string | undefined;
+                    img_url?: string | undefined;
+                } | undefined;
+                file_key?: string | undefined;
+                node_id?: string | undefined;
+                thumbnail_url?: string | undefined;
+                containing_frame?: {
+                    name?: string | undefined;
+                    node_id?: string | undefined;
+                } | undefined;
+            }[] | undefined;
+        } | undefined;
+    }>;
+    getComponentSetsForFile: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+    }) => Promise<{
+        meta?: {
+            component_sets?: {
+                key: string;
+                name?: string | undefined;
+            }[] | undefined;
+        } | undefined;
+    }>;
+    getForTeam: (ctx: import("..").FigmaContext, args: {
+        team_id: string;
+        before?: number | undefined;
+        after?: number | undefined;
+        page_size?: number | undefined;
+    }) => Promise<{
+        cursor?: string | undefined;
+        meta?: {
+            components?: {
+                key: string;
+                created_at?: string | undefined;
+                updated_at?: string | undefined;
+                name?: string | undefined;
+                description?: string | undefined;
+                user?: {
+                    id: string;
+                    handle?: string | undefined;
+                    img_url?: string | undefined;
+                } | undefined;
+                file_key?: string | undefined;
+                node_id?: string | undefined;
+                thumbnail_url?: string | undefined;
+                containing_frame?: {
+                    name?: string | undefined;
+                    node_id?: string | undefined;
+                } | undefined;
+            }[] | undefined;
+        } | undefined;
+    }>;
+    getComponentSetsForTeam: (ctx: import("..").FigmaContext, args: {
+        team_id: string;
+        before?: number | undefined;
+        after?: number | undefined;
+        page_size?: number | undefined;
+    }) => Promise<{
+        cursor?: string | undefined;
+        meta?: {
+            component_sets?: {
+                key: string;
+                name?: string | undefined;
+            }[] | undefined;
+        } | undefined;
+    }>;
+};
+export declare const Files: {
+    getJSON: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        version?: string | undefined;
+        ids?: string | undefined;
+        depth?: number | undefined;
+        geometry?: string | undefined;
+        plugin_data?: string | undefined;
+        branch_data?: boolean | undefined;
+        simplify?: boolean | undefined;
+        include_raw?: boolean | undefined;
+    }) => Promise<{
+        name?: string | undefined;
+        version?: string | undefined;
+        components?: Record<string, unknown> | undefined;
+        role?: string | undefined;
+        lastModified?: string | undefined;
+        editorType?: string | undefined;
+        thumbnailUrl?: string | undefined;
+        document?: unknown;
+        styles?: Record<string, unknown> | undefined;
+    }>;
+    getMetadata: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+    }) => Promise<{
+        name?: string | undefined;
+        version?: string | undefined;
+        thumbnail_url?: string | undefined;
+        role?: string | undefined;
+        editorType?: string | undefined;
+        last_modified?: string | undefined;
+    }>;
+    getNodes: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        ids: string;
+        version?: string | undefined;
+        depth?: number | undefined;
+        geometry?: string | undefined;
+        plugin_data?: string | undefined;
+    }) => Promise<{
+        name?: string | undefined;
+        nodes?: Record<string, unknown> | undefined;
+    }>;
+    getStyles: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+    }) => Promise<{
+        meta?: {
+            styles?: {
+                key: string;
+                name?: string | undefined;
+                description?: string | undefined;
+                file_key?: string | undefined;
+                node_id?: string | undefined;
+                style_type?: string | undefined;
+            }[] | undefined;
+        } | undefined;
+    }>;
+    getImageFills: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+    }) => Promise<{
+        error?: boolean | undefined;
+        meta?: {
+            images?: Record<string, string> | undefined;
+        } | undefined;
+    }>;
+    getVersions: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        before?: number | undefined;
+        after?: number | undefined;
+        page_size?: number | undefined;
+    }) => Promise<{
+        pagination?: {
+            cursor?: string | undefined;
+        } | undefined;
+        versions?: {
+            id: string;
+            created_at?: string | undefined;
+            description?: string | null | undefined;
+            user?: {
+                id: string;
+                handle?: string | undefined;
+                img_url?: string | undefined;
+            } | undefined;
+            label?: string | null | undefined;
+        }[] | undefined;
+    }>;
+    renderImages: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        ids: string;
+        version?: string | undefined;
+        scale?: number | undefined;
+        format?: "jpg" | "png" | "svg" | "pdf" | undefined;
+        contents_only?: boolean | undefined;
+        svg_include_id?: boolean | undefined;
+        svg_outline_text?: boolean | undefined;
+        svg_include_node_id?: boolean | undefined;
+        svg_simplify_stroke?: boolean | undefined;
+        use_absolute_bounds?: boolean | undefined;
+    }) => Promise<{
+        images?: Record<string, string | null> | undefined;
+        err?: string | null | undefined;
+    }>;
+    getProjectFiles: (ctx: import("..").FigmaContext, args: {
+        project_id: string;
+        branch_data?: boolean | undefined;
+    }) => Promise<{
+        name?: string | undefined;
+        files?: {
+            key: string;
+            name?: string | undefined;
+            thumbnail_url?: string | null | undefined;
+            last_modified?: string | undefined;
+        }[] | undefined;
+    }>;
+};
+export declare const Styles: {
+    get: (ctx: import("..").FigmaContext, args: {
+        key: string;
+    }) => Promise<{
+        meta?: {
+            style?: {
+                key: string;
+                name?: string | undefined;
+                description?: string | undefined;
+                file_key?: string | undefined;
+                node_id?: string | undefined;
+                style_type?: string | undefined;
+            } | undefined;
+        } | undefined;
+    }>;
+    getForTeam: (ctx: import("..").FigmaContext, args: {
+        team_id: string;
+        before?: number | undefined;
+        after?: number | undefined;
+        page_size?: number | undefined;
+    }) => Promise<{
+        meta?: {
+            styles?: {
+                key: string;
+                name?: string | undefined;
+                style_type?: string | undefined;
+            }[] | undefined;
+        } | undefined;
+    }>;
+};
+export declare const Projects: {
+    getTeamProjects: (ctx: import("..").FigmaContext, args: {
+        team_id: string;
+    }) => Promise<{
+        name?: string | undefined;
+        projects?: {
+            id: string;
+            name?: string | undefined;
+        }[] | undefined;
+    }>;
+};
+export declare const Users: {
+    getCurrent: (ctx: import("..").FigmaContext, args: {}) => Promise<{
+        id: string;
+        handle?: string | undefined;
+        img_url?: string | undefined;
+        email?: string | undefined;
+    }>;
+};
+export declare const LibraryAnalytics: {
+    componentActions: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        cursor?: string | undefined;
+        start_date?: string | undefined;
+        end_date?: string | undefined;
+        group_by?: string | undefined;
+    }) => Promise<{
+        cursor?: string | undefined;
+        rows?: unknown[] | undefined;
+        next_page?: boolean | undefined;
+    }>;
+    componentUsages: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        cursor?: string | undefined;
+        group_by?: string | undefined;
+    }) => Promise<{
+        cursor?: string | undefined;
+        rows?: unknown[] | undefined;
+        next_page?: boolean | undefined;
+    }>;
+    styleActions: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        cursor?: string | undefined;
+        start_date?: string | undefined;
+        end_date?: string | undefined;
+        group_by?: string | undefined;
+    }) => Promise<{
+        cursor?: string | undefined;
+        rows?: unknown[] | undefined;
+        next_page?: boolean | undefined;
+    }>;
+    styleUsages: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        cursor?: string | undefined;
+        group_by?: string | undefined;
+    }) => Promise<{
+        cursor?: string | undefined;
+        rows?: unknown[] | undefined;
+        next_page?: boolean | undefined;
+    }>;
+    variableActions: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        cursor?: string | undefined;
+        start_date?: string | undefined;
+        end_date?: string | undefined;
+        group_by?: string | undefined;
+    }) => Promise<{
+        cursor?: string | undefined;
+        rows?: unknown[] | undefined;
+        next_page?: boolean | undefined;
+    }>;
+    variableUsages: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        cursor?: string | undefined;
+        group_by?: string | undefined;
+    }) => Promise<{
+        cursor?: string | undefined;
+        rows?: unknown[] | undefined;
+        next_page?: boolean | undefined;
+    }>;
+};
+export declare const ActivityLogs: {
+    list: (ctx: import("..").FigmaContext, args: {
+        limit?: number | undefined;
+        start_time?: number | undefined;
+        end_time?: number | undefined;
+        order?: string | undefined;
+        events?: string | undefined;
+    }) => Promise<{
+        cursor?: string | undefined;
+        next_page?: boolean | undefined;
+        activity_logs?: unknown[] | undefined;
+    }>;
+};
+export declare const Payments: {
+    get: (ctx: import("..").FigmaContext, args: {
+        user_id?: string | undefined;
+        plugin_id?: string | undefined;
+        widget_id?: string | undefined;
+        community_file_id?: string | undefined;
+        plugin_payment_token?: string | undefined;
+    }) => Promise<{
+        status?: number | undefined;
+        meta?: {
+            payment_information?: unknown;
+        } | undefined;
+    }>;
+};
+export declare const DesignTools: {
+    discoverResources: (ctx: import("..").FigmaContext, args: {
+        file_key?: string | undefined;
+        team_id?: string | undefined;
+        project_id?: string | undefined;
+        figma_url?: string | undefined;
+        max_depth?: number | undefined;
+    }) => Promise<{
+        teams?: unknown[] | undefined;
+        files?: unknown[] | undefined;
+        projects?: unknown[] | undefined;
+    }>;
+    extractDesignTokens: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        include_variables?: boolean | undefined;
+        include_local_styles?: boolean | undefined;
+        extract_from_nodes?: string | undefined;
+    }) => Promise<{
+        tokens?: Record<string, unknown> | undefined;
+    }>;
+    extractPrototypeInteractions: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        analyze_components?: boolean | undefined;
+        include_animations?: boolean | undefined;
+    }) => Promise<{
+        interactions?: unknown[] | undefined;
+        flows?: unknown[] | undefined;
+    }>;
+    downloadImages: (ctx: import("..").FigmaContext, args: {
+        file_key: string;
+        images: {
+            node_id: string;
+        }[];
+        scale?: number | undefined;
+        svg_include_id?: boolean | undefined;
+        svg_outline_text?: boolean | undefined;
+        svg_simplify_stroke?: boolean | undefined;
+    }) => Promise<{
+        images?: Record<string, string | null> | undefined;
+    }>;
+    designTokensToTailwind: (ctx: import("..").FigmaContext, args: {
+        tokens: Record<string, unknown>;
+        prefix?: string | undefined;
+        config_format?: string | undefined;
+        include_font_imports?: boolean | undefined;
+    }) => Promise<{
+        config?: string | undefined;
+        css?: string | undefined;
+    }>;
+};
+export * from './types';
+//# sourceMappingURL=index.d.ts.map