@animaapp/anima-sdk 0.3.7 → 0.3.12

package/dist/index.d.ts

@@ -16,6 +16,12 @@ export declare class Anima {
     set auth(auth: Auth);
     protected get headers(): Record<string, string>;
     generateCode(params: GetCodeParams, handler?: GetCodeHandler): Promise<AnimaSDKResult>;
+    /**
+     * @experimental
+     * This API is experimental and may change or be removed in future releases.
+     * Link2Code (l2c) flow.
+     */
+    generateLink2Code(params: GetLink2CodeParams, handler?: GetLink2CodeHandler): Promise<AnimaSDKResult>;
 }
 
 export declare type AnimaFiles = Record<string, {
@@ -67,7 +73,7 @@ export declare class CodegenError extends Error {
 /**
  * Codegen errors from the worker
  */
-export declare type CodegenErrorReason = "Selected node type is not supported" | "Invisible group nodes are unsupported" | "Selected node is a page with multiple children" | "There is no node with the given id" | "Invalid Figma token" | "Anima API connection error" | "Figma token expired" | "Invalid user token" | "Figma file not found" | "Figma rate limit exceeded" | "Unknown";
+export declare type CodegenErrorReason = "Selected node type is not supported" | "Invisible group nodes are unsupported" | "Selected node is a page with multiple children" | "There is no node with the given id" | "Invalid Figma token" | "Anima API connection error" | "Figma token expired" | "Invalid user token" | "Figma file not found" | "Figma rate limit exceeded" | "Figma selection too large" | "Unknown";
 
 export declare type CodegenResult = BaseResult & {
     files: Record<string, {
@@ -93,6 +99,8 @@ export declare type CodegenSettings = {
     enableAutoSplit?: boolean;
     autoSplitThreshold?: number;
     disableMarkedForExport?: boolean;
+    enableDisplayScreenModelId?: boolean;
+    enableGeneratePackageLock?: boolean;
 };
 
 /**
@@ -117,6 +125,32 @@ export declare const createCodegenResponseEventStream: (anima: Anima, params: Ge
  */
 export declare const createCodegenStream: (anima: Anima, params: GetCodeParams) => ReadableStream<StreamCodgenMessage>;
 
+/**
+ * Creates a Server-Sent Events (SSE) `Response` that forwards all messages from the URL to 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 {GetLink2CodeParams} params - The parameters for the URL to code generation request.
+ * @returns {Promise<Response>} - A promise that resolves to an HTTP response.
+ */
+export declare const createLink2CodeResponseEventStream: (anima: Anima, params: GetLink2CodeParams) => Promise<Response>;
+
+/**
+ * @experimental
+ * This API is experimental and may change or be removed in future releases.
+ * Link2Code (l2c) stream flow.
+ *
+ * Start the URL to code generation and creates a ReadableStream to output its result.
+ *
+ * The stream is closed when the URL to code generation ends.
+ *
+ * @param {Anima} anima - An Anima service instance to generate the code from.
+ * @param {GetLink2CodeParams} params - Parameters required for the URL to code generation process.
+ * @returns {ReadableStream<StreamL2CMessage>} - A ReadableStream that emits messages related to the URL to code generation process.
+ */
+export declare const createLink2CodeStream: (anima: Anima, params: GetLink2CodeParams) => ReadableStream<StreamL2CMessage>;
+
 export declare type FigmaApiError = {
     cause: {
         message?: string;
@@ -127,7 +161,7 @@ export declare type FigmaApiError = {
     };
 };
 
-export declare type FigmaApiErrorType = "FigmaTokenIssue" | "RateLimitExceeded" | "NotFound" | "UnknownFigmaApiException";
+export declare type FigmaApiErrorType = "FigmaTokenIssue" | "RateLimitExceeded" | "NotFound" | "UnknownFigmaApiException" | "RequestTooLarge";
 
 export declare type FigmaNode = Node_2;
 
@@ -239,6 +273,32 @@ export declare type GetFileParams = {
     figmaRestApi?: FigmaRestApi;
 };
 
+export declare type GetLink2CodeHandler = ((message: SSEL2CMessage) => void) | {
+    onQueueing?: () => void;
+    onStart?: ({ sessionId }: {
+        sessionId: string;
+    }) => void;
+    onAssetsUploaded?: () => void;
+    onAssetsList?: ({ assets, }: {
+        assets: Array<{
+            name: string;
+            url: string;
+        }>;
+    }) => void;
+    onGeneratingCode?: ({ status, progress, files, }: {
+        status: "success" | "running" | "failure";
+        progress: number;
+        files: AnimaFiles;
+    }) => void;
+    onCodegenCompleted?: () => void;
+};
+
+export declare type GetLink2CodeParams = {
+    params: L2CParams;
+    assetsStorage?: AssetsStorage;
+    tracking?: TrackingInfos;
+};
+
 export declare const getRelatedScreenFiles: ({ files, screenPath, }: {
     files: AnimaFiles;
     screenPath?: string;
@@ -257,10 +317,51 @@ export declare const isNotFound: (error: Error) => boolean;
 
 export declare const isRateLimitExceeded: (error: Error) => boolean;
 
+export declare const isRequestTooLarge: (error: Error) => boolean;
+
 export declare const isUnknownFigmaApiException: (error: Error) => boolean;
 
 export declare const isValidFigmaUrl: (figmaLink: string) => [hasCorrectPrefix: boolean, fileKey: string, nodeId: string];
 
+export declare type L2CParams = {
+    input: L2CParamsInput;
+    conventions: L2CParamsConvention;
+    assetsStorage: L2CParamsAssetsStorage;
+};
+
+export declare type L2CParamsAssetsStorage = L2CParamsBundledAssetsStorage;
+
+export declare type L2CParamsBundledAssetsStorage = {
+    type: 'bundled';
+    referencePath?: string;
+};
+
+export declare type L2CParamsConvention = L2CParamsHtmlConvention | L2CParamsReactConvention;
+
+export declare type L2CParamsFramework = 'html' | 'react';
+
+export declare type L2CParamsHtmlConvention = {
+    framework: 'html';
+    styling: L2CParamsStyling;
+};
+
+export declare type L2CParamsInput = L2CParamsUrlInput;
+
+export declare type L2CParamsLanguage = 'typescript';
+
+export declare type L2CParamsReactConvention = {
+    framework: 'react';
+    language: L2CParamsLanguage;
+    styling: L2CParamsStyling;
+};
+
+export declare type L2CParamsStyling = 'tailwind' | 'inline-styles';
+
+export declare type L2CParamsUrlInput = {
+    type: 'url';
+    url: string;
+};
+
 export declare class NotFound extends Error {
     fileKey: string;
     constructor({ fileKey, cause }: {
@@ -277,6 +378,14 @@ export declare class RateLimitExceeded extends Error {
     });
 }
 
+export declare class RequestTooLarge extends Error {
+    fileKey: string;
+    constructor({ fileKey, cause }: {
+        fileKey: string;
+        cause?: unknown;
+    });
+}
+
 export declare class ResponseError extends Error {
     response: Response;
     constructor(message: string, res: Response);
@@ -287,6 +396,13 @@ export declare class ResponseError extends Error {
  */
 export declare type SDKErrorReason = "Invalid body payload" | "No code generated" | "Connection closed before the 'done' message" | "Response body is null";
 
+export declare type SSECodegenMessageErrorPayload = {
+    errorName: string;
+    task?: string;
+    reason: CodegenErrorReason;
+    sentryTraceId?: string;
+};
+
 export declare type SSECodgenMessage = {
     type: "queueing";
 } | {
@@ -333,16 +449,56 @@ export declare type SSECodgenMessageErrorPayload = {
     reason: CodegenErrorReason;
 };
 
-export declare type StreamCodgenMessage = Exclude<SSECodgenMessage, {
+export declare type SSEL2CMessage = {
+    type: 'queueing';
+} | {
+    type: 'start';
+    sessionId: string;
+} | {
+    type: 'generating_code';
+    payload: GeneratingCodePayload;
+} | {
+    type: 'generation_completed';
+} | {
+    type: 'assets_uploaded';
+} | {
+    type: 'assets_list';
+    payload: {
+        assets: Array<{
+            name: string;
+            url: string;
+        }>;
+    };
+} | {
+    type: 'aborted';
+} | {
+    type: 'error';
+    payload: SSECodegenMessageErrorPayload;
+} | {
+    type: 'done';
+    payload: {
+        sessionId: string;
+        tokenUsage: number;
+    };
+};
+
+export declare type StreamCodgenMessage = StreamMessage<SSECodgenMessage>;
+
+declare type StreamErrorPayload = {
+    name: string;
+    message: CodegenErrorReason;
+    status?: number;
+    detail?: unknown;
+    errorPayload?: SSECodegenMessageErrorPayload;
+};
+
+export declare type StreamL2CMessage = StreamMessage<SSEL2CMessage>;
+
+export declare type StreamMessage<T> = Exclude<T, {
     type: "error";
 }> | {
     type: "error";
-    payload: {
-        name: string;
-        message: CodegenErrorReason;
-        status?: number;
-        detail?: unknown;
-    };
+    payload: StreamErrorPayload;
 };
 
 export declare type TrackingInfos = {