@animaapp/anima-sdk 0.4.3 → 0.4.6

package/dist/index.d.ts

@@ -15,13 +15,13 @@ export declare class Anima {
     protected hasAuth(): boolean;
     set auth(auth: Auth);
     protected get headers(): Record<string, string>;
-    generateCode(params: GetCodeParams, handler?: GetCodeHandler): Promise<AnimaSDKResult>;
+    generateCode(params: GetCodeParams, handler?: GetCodeHandler, signal?: AbortSignal): 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>;
+    generateLink2Code(params: GetLink2CodeParams, handler?: GetLink2CodeHandler, signal?: AbortSignal): Promise<AnimaSDKResult>;
 }
 
 export declare type AnimaFiles = Record<string, {
@@ -73,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" | "Figma selection too large" | "Invalid responsive page node type" | "Unknown";
+export declare type CodegenErrorReason = "Selected node type is not supported" | "Invisible group nodes are unsupported" | "Selected node is a page with multiple children" | "Selected node is a page with no valid 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" | "Invalid responsive page node type" | "Unknown";
 
 export declare type CodegenResult = BaseResult & {
     files: Record<string, {
@@ -103,6 +103,7 @@ export declare type CodegenSettings = {
     enableAutoSplit?: boolean;
     autoSplitThreshold?: number;
     disableMarkedForExport?: boolean;
+    allowAutoSelectFirstNode?: boolean;
     enableDisplayScreenModelId?: boolean;
     enableGeneratePackageLock?: boolean;
 };
@@ -236,9 +237,9 @@ export declare type GetCodeParams = {
 
 export declare const getFigmaApiErrorType: (error: Error) => FigmaApiErrorType;
 
-export declare const getFigmaFile: ({ fileKey, authToken, figmaRestApi, params, }: GetFilePagesParams) => Promise<GetFileResponse>;
+export declare const getFigmaFile: ({ fileKey, authToken, figmaRestApi, params, signal, }: GetFilePagesParams) => Promise<GetFileResponse>;
 
-export declare const getFileNodes: ({ fileKey, authToken, nodeIds, figmaRestApi, params, }: GetFileNodesParams) => Promise<{
+export declare const getFileNodes: ({ fileKey, authToken, nodeIds, figmaRestApi, params, signal, }: GetFileNodesParams) => Promise<{
     [key: string]: {
         document: Node_2;
         components: {
@@ -260,6 +261,7 @@ export declare type GetFileNodesParams = {
     nodeIds: string[];
     figmaRestApi?: FigmaRestApi;
     params?: Record<string, string | number>;
+    signal?: AbortSignal;
 };
 
 export declare type GetFilePagesParams = {
@@ -267,6 +269,7 @@ export declare type GetFilePagesParams = {
     authToken?: string;
     figmaRestApi?: FigmaRestApi;
     params?: Record<string, string | number | undefined>;
+    signal?: AbortSignal;
 };
 
 export declare type GetFilePagesResult = FigmaPage[] | undefined;
@@ -308,14 +311,17 @@ export declare const getRelatedScreenFiles: ({ files, screenPath, }: {
     screenPath?: string;
 }) => AnimaFiles;
 
-declare type InvalidNodeForCodegenReason = "Selected node is a page with multiple children" | "There is no node with the given id" | "Selected node type is not supported";
+declare type InvalidNodeForCodegenReason = "Selected node is a page with multiple children" | "Selected node is a page with no valid children" | "There is no node with the given id" | "Selected node type is not supported";
 
 export declare const isFigmaTokenIssue: (error: Error) => boolean;
 
 /**
- * Check if the pair "design" + "node id" are valid for code generation.
+ * Check if the pair "design" + "node id" is valid for code generation.
+ * May recommend a node that is not the one passed as argument.
  */
-export declare const isNodeCodegenCompatible: (design: GetFileResponse, nodeId: string) => ValidateNodeForCodegenResult;
+export declare const isNodeCodegenCompatible: (design: GetFileResponse, nodeId: string, options?: {
+    allowAutoSelectFirstNode: boolean;
+}) => ValidateNodeForCodegenResult;
 
 export declare const isNotFound: (error: Error) => boolean;
 
@@ -357,6 +363,7 @@ export declare type L2CParamsReactConvention = {
     framework: 'react';
     language: L2CParamsLanguage;
     styling: L2CParamsStyling;
+    enableGeneratePackageLock?: boolean;
 };
 
 export declare type L2CParamsStyling = 'tailwind' | 'inline-styles';
@@ -521,6 +528,10 @@ declare type ValidateNodeForCodegenResult = {
     isValid: true;
     node: FigmaNode;
     note?: "Selected node is a page with a single valid children - returning it instead";
+} | {
+    isValid: true;
+    node: FigmaNode;
+    note?: "Selected node is a page with multiple valid children - returning the first one instead";
 } | {
     isValid: false;
     reason: InvalidNodeForCodegenReason;