@animaapp/anima-sdk 0.3.1 → 0.3.4

package/dist/index.d.ts

@@ -58,14 +58,14 @@ export declare class CodegenError extends Error {
     detail?: unknown;
     constructor({ name, reason, status, detail, }: {
         name: string;
-        reason: CodegenErrorReason | SDKErrorReason;
+        reason: CodegenErrorReason | CodegenRouteErrorReason | SDKErrorReason;
         status?: number;
         detail?: unknown;
     });
 }
 
 /**
- * Errors from Public API
+ * 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";
 
@@ -76,6 +76,11 @@ 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 CodegenSettings = {
     language?: "typescript" | "javascript";
     model?: string;
@@ -143,6 +148,8 @@ export declare class FigmaTokenIssue extends Error {
     });
 }
 
+export declare const findChildrenNode: (node: FigmaNode, targetNodeId: string) => FigmaNode | null;
+
 export declare const formatToFigmaLink: ({ fileKey, nodeId, duplicate, }: {
     fileKey: string;
     nodeId: string;
@@ -193,9 +200,7 @@ export declare type GetCodeParams = {
 
 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 getFigmaFile: ({ fileKey, authToken, figmaRestApi, params, }: GetFilePagesParams) => Promise<GetFileResponse>;
 
 export declare const getFileNodes: ({ fileKey, authToken, nodeIds, figmaRestApi, params, }: GetFileNodesParams) => Promise<{
     [key: string]: {
@@ -243,8 +248,15 @@ export declare const getRelatedScreenFiles: ({ files, screenPath, }: {
 
 export declare const handleFigmaApiError: (error: FigmaApiError, fileKey: string) => never;
 
+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";
+
 export declare const isFigmaTokenIssue: (error: Error) => boolean;
 
+/**
+ * Check if the pair "design" + "node id" are valid for code generation.
+ */
+export declare const isNodeCodegenCompatible: (design: GetFileResponse, nodeId: string) => ValidateNodeForCodegenResult;
+
 export declare const isNotFound: (error: Error) => boolean;
 
 export declare const isRateLimitExceeded: (error: Error) => boolean;
@@ -347,6 +359,15 @@ export declare class UnknownFigmaApiException extends Error {
     });
 }
 
+declare type ValidateNodeForCodegenResult = {
+    isValid: true;
+    node: FigmaNode;
+    note?: "Selected node is a page with a single valid children - returning it instead";
+} | {
+    isValid: false;
+    reason: InvalidNodeForCodegenReason;
+};
+
 export declare const validateSettings: (obj: unknown) => CodegenSettings;
 
 export { }