@animaapp/anima-sdk 0.3.12 → 0.4.4

package/dist/index.d.ts

@@ -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" | "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, {
@@ -85,7 +85,7 @@ export declare type CodegenResult = BaseResult & {
 /**
  * Codegen errors from the "/codegen" route
  */
-export declare type CodegenRouteErrorReason = "Missing Authorization header" | "Invalid Authorization header" | "Missing teamId" | "Internal server error" | "Forbidden, no team access" | "Requested Usage Exceeds Limit" | "Invalid Anima token";
+export declare type CodegenRouteErrorReason = "Missing Authorization header" | "Invalid Authorization header" | "Missing teamId" | "Internal server error" | "Forbidden, no team access" | "Requested Usage Exceeds Limit" | "Not all frames id from responsive pages are mentioned on the nodes id list" | "Too many screens to import" | "Invalid Anima token";
 
 export declare type CodegenSettings = {
     language?: "typescript" | "javascript";
@@ -93,12 +93,17 @@ export declare type CodegenSettings = {
     framework: "react" | "html";
     styling: "plain_css" | "css_modules" | "styled_components" | "tailwind" | "sass" | "scss" | "inline_styles";
     uiLibrary?: "mui" | "antd" | "radix" | "shadcn";
+    responsivePages?: Array<{
+        name: string;
+        framesId: string[];
+    }>;
     enableTranslation?: boolean;
     enableUILibraryTheming?: boolean;
     enableCompactStructure?: boolean;
     enableAutoSplit?: boolean;
     autoSplitThreshold?: number;
     disableMarkedForExport?: boolean;
+    allowAutoSelectFirstNode?: boolean;
     enableDisplayScreenModelId?: boolean;
     enableGeneratePackageLock?: boolean;
 };
@@ -304,14 +309,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;
 
@@ -517,6 +525,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;