@animaapp/anima-sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,270 @@
+import { Component } from '@figma/rest-api-spec';
+import { ComponentSet } from '@figma/rest-api-spec';
+import { FigmaRestApi } from '@animaapp/http-client-figma';
+import { GetFileResponse } from '@figma/rest-api-spec';
+import { Node as Node_2 } from '@figma/rest-api-spec';
+import { Style } from '@figma/rest-api-spec';
+
+export declare class Anima {
+    #private;
+    constructor({ auth, apiBaseAddress, }?: {
+        auth?: Auth;
+        apiBaseAddress?: string;
+        path?: string;
+    });
+    protected hasAuth(): boolean;
+    set auth(auth: Auth);
+    protected get headers(): Record<string, string>;
+    generateCode(params: GetCodeParams, handler?: GetCodeHandler): Promise<AnimaSDKResult>;
+}
+
+export declare type AnimaFiles = Record<string, {
+    content: string;
+    isBinary: boolean;
+}>;
+
+export declare type AnimaSDKResult = BaseResult & {
+    files: AnimaFiles;
+};
+
+export declare type Auth = {
+    token: string;
+    teamId: string;
+} | {
+    token: string;
+    userId?: string;
+};
+
+export declare type BaseResult = {
+    sessionId: string;
+    figmaFileName: string;
+    figmaSelectedFrameName: string;
+};
+
+export declare class CodegenError extends Error {
+    status?: number;
+    constructor({ name, reason, status }: {
+        name: string;
+        reason: CodegenErrorReason;
+        status?: number;
+    });
+}
+
+export declare type CodegenErrorReason = "The selected node is not a frame" | "There is no node with the given id" | "Invalid Figma token" | "Figma token expired" | "No files found" | "Connection closed before the 'done' message" | "Unknown" | "Response body is null";
+
+export declare type CodegenResult = BaseResult & {
+    files: Record<string, {
+        code: string;
+        type: "code";
+    }>;
+};
+
+export declare type CodegenSettings = {
+    language?: "typescript" | "javascript";
+    framework: "react" | "html";
+    styling: "plain_css" | "css_modules" | "styled_components" | "tailwind" | "sass" | "scss" | "inline_styles";
+    uiLibrary?: "mui" | "antd" | "radix" | "shadcn";
+    enableTranslation?: boolean;
+};
+
+export declare const convertCodegenFilesToAnimaFiles: (codegenFiles: Record<string, {
+    code: string;
+    type: "code";
+}>) => AnimaFiles;
+
+/**
+ * Creates a Server-Sent Events (SSE) `Response` that forwards all messages from the code generation stream.
+ *
+ * But, if the first message indicates an error (e.g., connection failed), the function returns a 500 response with the error message.
+ *
+ * @param {Anima} anima - The Anima instance to use for creating the data stream.
+ * @param {GetCodeParams} params - The parameters for the code generation request.
+ * @returns {Promise<Response>} - A promise that resolves to an HTTP response.
+ */
+export declare const createCodegenResponseEventStream: (anima: Anima, params: GetCodeParams) => Promise<Response>;
+
+/**
+ * Start the code generation and creates a ReadableStream to output its result.
+ *
+ * The stream is closed when the codegen ends.
+ *
+ * @param {Anima} anima - An Anima service instance to generate the code from.
+ * @param {GetCodeParams} params - Parameters required for the code generation process.
+ * @returns {ReadableStream<StreamCodgenMessage>} - A ReadableStream that emits messages related to the code generation process.
+ */
+export declare const createCodegenStream: (anima: Anima, params: GetCodeParams) => ReadableStream<StreamCodgenMessage>;
+
+export declare type FigmaApiErrorType = "FigmaTokenIssue" | "RateLimitExceeded" | "NotFound" | "UnknownFigmaApiException";
+
+export declare type FigmaNode = Node_2;
+
+export declare type FigmaPage = {
+    id: string;
+    name: string;
+};
+
+export declare class FigmaTokenIssue extends Error {
+    fileKey: string;
+    reason: string;
+    constructor({ fileKey, reason }: {
+        fileKey: string;
+        reason: string;
+    });
+}
+
+export declare const formatToFigmaLink: ({ fileKey, nodeId, }: {
+    fileKey: string;
+    nodeId: string;
+}) => URL;
+
+export declare type GetCodeHandler = ((message: SSECodgenMessage) => void) | {
+    onStart?: ({ sessionId }: {
+        sessionId: string;
+    }) => void;
+    onPreCodegen?: ({ message }: {
+        message: string;
+    }) => void;
+    onAssetsUploaded?: () => void;
+    onFigmaMetadata?: ({ figmaFileName, figmaSelectedFrameName, }: {
+        figmaFileName: string;
+        figmaSelectedFrameName: string;
+    }) => void;
+    onGeneratingCode?: ({ status, progress, files, }: {
+        status: "success" | "running" | "failure";
+        progress: number;
+        files: AnimaFiles;
+    }) => void;
+    onCodegenCompleted?: () => void;
+};
+
+export declare type GetCodeParams = {
+    fileKey: string;
+    figmaToken: string;
+    nodesId: string[];
+    settings: CodegenSettings;
+};
+
+export declare const getFigmaApiErrorType: (error: Error) => FigmaApiErrorType;
+
+export declare const getFigmaFile: ({ fileKey, authToken, figmaRestApi, params, }: GetFilePagesParams) => Promise<GetFigmaFileResult>;
+
+export declare type GetFigmaFileResult = GetFileResponse | undefined;
+
+export declare const getFileNodes: ({ fileKey, authToken, nodeIds, figmaRestApi, params, }: GetFileNodesParams) => Promise<{
+    [key: string]: {
+        document: Node_2;
+        components: {
+            [key: string]: Component;
+        };
+        componentSets: {
+            [key: string]: ComponentSet;
+        };
+        schemaVersion: number;
+        styles: {
+            [key: string]: Style;
+        };
+    };
+}>;
+
+export declare type GetFileNodesParams = {
+    fileKey: string;
+    authToken?: string;
+    nodeIds: string[];
+    figmaRestApi?: FigmaRestApi;
+    params?: Record<string, any>;
+};
+
+export declare type GetFilePagesParams = {
+    fileKey: string;
+    authToken?: string;
+    figmaRestApi?: FigmaRestApi;
+    params?: Record<string, any>;
+};
+
+export declare type GetFilePagesResult = FigmaPage[] | undefined;
+
+export declare type GetFileParams = {
+    fileKey: string;
+    authToken?: string;
+    figmaRestApi?: FigmaRestApi;
+};
+
+export declare const handleFigmaApiError: (error: any, fileKey: string) => never;
+
+export declare const isFigmaTokenIssue: (error: Error) => boolean;
+
+export declare const isNotFound: (error: Error) => boolean;
+
+export declare const isRateLimitExceeded: (error: Error) => boolean;
+
+export declare const isUnknownFigmaApiException: (error: Error) => boolean;
+
+export declare const isValidFigmaUrl: (figmaLink: string) => [hasCorrectPrefix: boolean, fileKey: string, nodeId: string];
+
+export declare class NotFound extends Error {
+    fileKey: string;
+    constructor({ fileKey }: {
+        fileKey: string;
+    });
+}
+
+export declare class RateLimitExceeded extends Error {
+    fileKey: string;
+    constructor({ fileKey }: {
+        fileKey: string;
+    });
+}
+
+export declare type SSECodgenMessage = {
+    type: "start";
+    sessionId: string;
+} | {
+    type: "pre_codegen";
+    message: string;
+} | {
+    type: "figma_metadata";
+    figmaFileName: string;
+    figmaSelectedFrameName: string;
+} | {
+    type: "generating_code";
+    payload: any;
+} | {
+    type: "codegen_completed";
+} | {
+    type: "assets_uploaded";
+} | {
+    type: "aborted";
+} | {
+    type: "error";
+    payload: SSECodgenMessageErrorPayload;
+} | {
+    type: "done";
+};
+
+export declare type SSECodgenMessageErrorPayload = {
+    errorName: string;
+    task?: string;
+    reason: CodegenErrorReason;
+};
+
+export declare type StreamCodgenMessage = Exclude<SSECodgenMessage, {
+    type: "error";
+}> | {
+    type: "error";
+    payload: {
+        message: CodegenErrorReason;
+        status?: number;
+    };
+};
+
+export declare class UnknownFigmaApiException extends Error {
+    fileKey: string;
+    constructor({ fileKey, cause }: {
+        fileKey: string;
+        cause: unknown;
+    });
+}
+
+export declare const validateSettings: (obj: unknown) => CodegenSettings;
+
+export { }