@animaapp/anima-sdk 0.7.3 → 0.9.0

package/dist/index.d.ts

@@ -1,16 +1,14 @@
-import { Component } from '@figma/rest-api-spec';
-import { ComponentSet } from '@figma/rest-api-spec';
-import { FigmaRestApi } from '@animaapp/http-client-figma';
 import { GetFileResponse } from '@figma/rest-api-spec';
+import { GetMeResponse } from '@figma/rest-api-spec';
 import { Node as Node_2 } from '@figma/rest-api-spec';
-import { Style } from '@figma/rest-api-spec';
 
 export declare class Anima {
     #private;
-    constructor({ auth, apiBaseAddress, }?: {
+    constructor({ auth, apiBaseAddress, figmaRestApi, }?: {
         auth?: Auth;
         apiBaseAddress?: string;
         path?: string;
+        figmaRestApi?: FigmaRestApi;
     });
     protected hasAuth(): boolean;
     set auth(auth: Auth);
@@ -127,7 +125,7 @@ export declare type CodegenSettings = BaseSettings & {
     language?: "typescript" | "javascript";
     model?: string;
     framework: "react" | "html";
-    styling: "plain_css" | "css_modules" | "styled_components" | "tailwind" | "sass" | "scss" | "inline_styles";
+    styling: "plain_css" | "tailwind" | "inline_styles";
     uiLibrary?: "mui" | "antd" | "radix" | "shadcn" | "clean_react";
     responsivePages?: Array<{
         name: string;
@@ -253,35 +251,47 @@ export declare const createLink2CodeResponseEventStream: (anima: Anima, params:
  */
 export declare const createLink2CodeStream: (anima: Anima, params: GetLink2CodeParams) => ReadableStream<StreamL2CMessage>;
 
-export declare type FigmaApiError = {
-    cause: {
-        message?: string;
-        body: {
-            err: string;
-            status: number;
-        };
-    };
-};
-
-export declare type FigmaApiErrorType = "FigmaTokenIssue" | "RateLimitExceeded" | "NotFound" | "UnknownFigmaApiException" | "RequestTooLarge";
+export declare class ExpiredFigmaToken extends Error {
+    constructor();
+}
 
 export declare type FigmaNode = Node_2;
 
-export declare type FigmaPage = {
-    id: string;
-    name: string;
-};
+export declare type FigmaPlanTier = "enterprise" | "org" | "pro" | "starter" | "student";
 
-export declare class FigmaTokenIssue extends Error {
-    fileKey: string;
-    reason: string;
-    constructor({ fileKey, reason, cause, }: {
+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>;
+    getFile({ fileKey, nodeIds, depth, }: {
         fileKey: string;
-        reason: string;
-        cause?: unknown;
-    });
+        nodeIds?: string[];
+        depth?: number;
+    }): Promise<GetFileResponse>;
+    getNodeImages<As extends "links" | "arrayBuffer" = "arrayBuffer">({ fileKey, nodeIds, scale, as, format, }: {
+        fileKey: string;
+        nodeIds: string[];
+        scale?: number;
+        as?: As;
+        format?: "jpg" | "png" | "svg" | "pdf";
+    }): Promise<As extends "arrayBuffer" ? Record<string, ArrayBuffer | null> : Record<string, string | null>>;
+    getImageFills({ fileKey, }: {
+        fileKey: string;
+    }): Promise<Record<string, string>>;
+    getMe(): Promise<GetMeResponse>;
 }
 
+declare type FigmaRestApiConstructor = {
+    fetch?: typeof window.fetch;
+    baseAddress?: string;
+    defaultOptions?: Omit<Options, "abortSignal">;
+};
+
 export declare const findChildrenNode: (node: FigmaNode, targetNodeId: string) => FigmaNode | null;
 
 export declare const formatToFigmaLink: ({ fileKey, nodeId, duplicate, }: {
@@ -426,6 +436,7 @@ export declare type GetCodeHandler = ((message: SSEGetCodeFromFigmaMessage) => v
 export declare type GetCodeParams = {
     fileKey: string;
     figmaToken?: string;
+    figmaRateLimitMaxWait?: number;
     nodesId: string[];
     assetsStorage?: AssetsStorage;
     settings: CodegenSettings;
@@ -437,50 +448,7 @@ export declare type GetCodeParams = {
     }>;
 };
 
-export declare const getFigmaApiErrorType: (error: Error) => FigmaApiErrorType;
-
-export declare const getFigmaFile: ({ fileKey, authToken, figmaRestApi, params, signal, }: GetFilePagesParams) => Promise<GetFileResponse>;
-
-export declare const getFileNodes: ({ fileKey, authToken, nodeIds, figmaRestApi, params, signal, }: GetFileNodesParams) => Promise<{
-    [key: string]: {
-        document: Node_2;
-        components: {
-            [key: string]: Component;
-        };
-        componentSets: {
-            [key: string]: ComponentSet;
-        };
-        schemaVersion: number;
-        styles: {
-            [key: string]: Style;
-        };
-    };
-}>;
-
-export declare type GetFileNodesParams = {
-    fileKey: string;
-    authToken?: string;
-    nodeIds: string[];
-    figmaRestApi?: FigmaRestApi;
-    params?: Record<string, string | number>;
-    signal?: AbortSignal;
-};
-
-export declare type GetFilePagesParams = {
-    fileKey: string;
-    authToken?: string;
-    figmaRestApi?: FigmaRestApi;
-    params?: Record<string, string | number | undefined>;
-    signal?: AbortSignal;
-};
-
-export declare type GetFilePagesResult = FigmaPage[] | undefined;
-
-export declare type GetFileParams = {
-    fileKey: string;
-    authToken?: string;
-    figmaRestApi?: FigmaRestApi;
-};
+export { GetFileResponse }
 
 /**
  * @deprecated This type is deprecated and will be removed soon.
@@ -496,6 +464,8 @@ export declare type GetLink2CodeParams = {
     tracking?: TrackingInfos;
 };
 
+export { GetMeResponse }
+
 export declare const getRelatedScreenFiles: ({ files, screenPath, }: {
     files: AnimaFiles;
     screenPath?: string;
@@ -503,8 +473,6 @@ export declare const getRelatedScreenFiles: ({ files, screenPath, }: {
 
 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.
@@ -530,7 +498,7 @@ export declare type L2CParams = {
     input: L2CParamsInput;
     conventions: L2CParamsConvention;
     assetsStorage: L2CParamsAssetsStorage;
-    viewports?: Array<'desktop' | 'tablet' | 'mobile'>;
+    viewports?: Array<"desktop" | "tablet" | "mobile">;
 };
 
 /**
@@ -542,9 +510,9 @@ export declare type L2CParamsAssetsStorage = L2CParamsBundledAssetsStorage;
  * @deprecated This type is deprecated and will be removed soon.
  */
 export declare type L2CParamsBundledAssetsStorage = {
-    type: 'bundled';
+    type: "bundled";
     referencePath?: string;
-    importMode?: 'watermarked' | 'original';
+    importMode?: "watermarked" | "original";
 };
 
 /**
@@ -555,13 +523,13 @@ export declare type L2CParamsConvention = L2CParamsHtmlConvention | L2CParamsRea
 /**
  * @deprecated This type is deprecated and will be removed soon.
  */
-export declare type L2CParamsFramework = 'html' | 'react';
+export declare type L2CParamsFramework = "html" | "react";
 
 /**
  * @deprecated This type is deprecated and will be removed soon.
  */
 export declare type L2CParamsHtmlConvention = {
-    framework: 'html';
+    framework: "html";
     styling: L2CParamsStyling;
 };
 
@@ -573,13 +541,13 @@ export declare type L2CParamsInput = L2CParamsUrlInput;
 /**
  * @deprecated This type is deprecated and will be removed soon.
  */
-export declare type L2CParamsLanguage = 'typescript';
+export declare type L2CParamsLanguage = "typescript";
 
 /**
  * @deprecated This type is deprecated and will be removed soon.
  */
 export declare type L2CParamsReactConvention = {
-    framework: 'react';
+    framework: "react";
     language: L2CParamsLanguage;
     styling: L2CParamsStyling;
     enableGeneratePackageLock?: boolean;
@@ -588,7 +556,7 @@ export declare type L2CParamsReactConvention = {
 /**
  * @deprecated This type is deprecated and will be removed soon.
  */
-export declare type L2CParamsStyling = 'tailwind' | 'inline-styles';
+export declare type L2CParamsStyling = "tailwind" | "inline-styles";
 
 /**
  * @deprecated This type is deprecated and will be removed soon.
@@ -598,16 +566,45 @@ 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 {
-    fileKey: string;
-    constructor({ fileKey, cause }: {
-        fileKey: string;
+    constructor({ cause }: {
         cause?: unknown;
     });
 }
 
+export declare type Options = {
+    token?: string;
+    abortSignal?: AbortSignal;
+    onForbidden?: (error: NeedsReauthFigmaToken | ExpiredFigmaToken | UnknownForbiddenFigmaError) => Promise<{
+        retry: {
+            newToken: string;
+        };
+    } | void>;
+    onRateLimited?: (headers: {
+        retryAfter: number;
+        figmaPlanTier: FigmaPlanTier;
+        figmaRateLimitType: FigmaRateLimitType;
+    }) => Promise<boolean>;
+};
+
 export declare type ProgressMessage = {
     id: string;
+    type: "info" | "rate_limit";
     title: string;
     subtitle?: string;
     body?: string;
@@ -615,17 +612,13 @@ export declare type ProgressMessage = {
 };
 
 export declare class RateLimitExceeded extends Error {
-    fileKey: string;
-    constructor({ fileKey, cause }: {
-        fileKey: string;
+    constructor({ cause }: {
         cause?: unknown;
     });
 }
 
 export declare class RequestTooLarge extends Error {
-    fileKey: string;
-    constructor({ fileKey, cause }: {
-        fileKey: string;
+    constructor({ cause }: {
         cause?: unknown;
     });
 }
@@ -797,13 +790,18 @@ export declare type TrackingInfos = {
 };
 
 export declare class UnknownFigmaApiException extends Error {
-    fileKey: string;
-    constructor({ fileKey, cause }: {
-        fileKey: string;
+    constructor({ cause }: {
         cause: unknown;
     });
 }
 
+export declare class UnknownForbiddenFigmaError extends Error {
+    reason: string | null;
+    constructor({ reason }: {
+        reason: string | null;
+    });
+}
+
 declare type ValidateNodeForCodegenResult = {
     isValid: true;
     node: FigmaNode;
@@ -819,6 +817,4 @@ declare type ValidateNodeForCodegenResult = {
 
 export declare const validateSettings: (obj: unknown) => CodegenSettings;
 
-export declare const wrapFigmaApiError: (error: FigmaApiError, fileKey: string) => Error;
-
 export { }