@animaapp/anima-sdk 0.8.0 → 0.9.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { GetFileResponse } from '@figma/rest-api-spec';
+import { GetMeResponse } from '@figma/rest-api-spec';
 import { Node as Node_2 } from '@figma/rest-api-spec';
 
 export declare class Anima {
@@ -250,7 +251,9 @@ export declare const createLink2CodeResponseEventStream: (anima: Anima, params:
  */
 export declare const createLink2CodeStream: (anima: Anima, params: GetLink2CodeParams) => ReadableStream<StreamL2CMessage>;
 
-export declare type FigmaApiErrorType = "FigmaTokenIssue" | "RateLimitExceeded" | "NotFound" | "UnknownFigmaApiException" | "RequestTooLarge";
+export declare class ExpiredFigmaToken extends Error {
+    constructor();
+}
 
 export declare type FigmaNode = Node_2;
 
@@ -261,6 +264,7 @@ export declare type FigmaRateLimitType = "low" | "high";
 export declare class FigmaRestApi {
     #private;
     constructor({ fetch, baseAddress, defaultOptions, }?: FigmaRestApiConstructor);
+    hasDefaultToken(): boolean;
     updateDefaultOptions(options: Options): void;
     withOptions(options: Options): this;
     getHeaders(token?: string): Record<string, string>;
@@ -279,6 +283,7 @@ export declare class FigmaRestApi {
     getImageFills({ fileKey, }: {
         fileKey: string;
     }): Promise<Record<string, string>>;
+    getMe(): Promise<GetMeResponse>;
 }
 
 declare type FigmaRestApiConstructor = {
@@ -287,12 +292,6 @@ declare type FigmaRestApiConstructor = {
     defaultOptions?: Omit<Options, "abortSignal">;
 };
 
-export declare class FigmaTokenIssue extends Error {
-    constructor({ cause }: {
-        cause?: unknown;
-    });
-}
-
 export declare const findChildrenNode: (node: FigmaNode, targetNodeId: string) => FigmaNode | null;
 
 export declare const formatToFigmaLink: ({ fileKey, nodeId, duplicate, }: {
@@ -449,8 +448,6 @@ export declare type GetCodeParams = {
     }>;
 };
 
-export declare const getFigmaApiErrorType: (error: Error) => FigmaApiErrorType;
-
 export { GetFileResponse }
 
 /**
@@ -467,22 +464,15 @@ export declare type GetLink2CodeParams = {
     tracking?: TrackingInfos;
 };
 
+export { GetMeResponse }
+
 export declare const getRelatedScreenFiles: ({ files, screenPath, }: {
     files: AnimaFiles;
     screenPath?: string;
 }) => AnimaFiles;
 
-/**
- * Figma REST API Errors
- */
-export declare class InvalidFigmaAccessTokenError extends Error {
-    constructor();
-}
-
 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" is valid for code generation.
  * May recommend a node that is not the one passed as argument.
@@ -576,10 +566,21 @@ export declare type L2CParamsUrlInput = {
     url: string;
 };
 
+/**
+ * Figma REST API Errors
+ */
+export declare class MalformattedFigmaToken extends Error {
+    constructor();
+}
+
 export declare class MissingFigmaToken extends Error {
     constructor();
 }
 
+export declare class NeedsReauthFigmaToken extends Error {
+    constructor();
+}
+
 export declare class NotFound extends Error {
     constructor({ cause }: {
         cause?: unknown;
@@ -589,6 +590,11 @@ export declare class NotFound extends Error {
 export declare type Options = {
     token?: string;
     abortSignal?: AbortSignal;
+    onForbidden?: (error: NeedsReauthFigmaToken | ExpiredFigmaToken | UnknownForbiddenFigmaError) => Promise<{
+        retry: {
+            newToken: string;
+        };
+    } | void>;
     onRateLimited?: (headers: {
         retryAfter: number;
         figmaPlanTier: FigmaPlanTier;
@@ -789,6 +795,13 @@ export declare class UnknownFigmaApiException extends Error {
     });
 }
 
+export declare class UnknownForbiddenFigmaError extends Error {
+    reason: string | null;
+    constructor({ reason }: {
+        reason: string | null;
+    });
+}
+
 declare type ValidateNodeForCodegenResult = {
     isValid: true;
     node: FigmaNode;