@animaapp/anima-sdk-react 0.6.34 → 0.7.0

package/dist/index.d.ts

@@ -1,41 +1,60 @@
+import { AnimaFiles } from '@animaapp/anima-sdk';
 import { AnimaSDKResult } from '@animaapp/anima-sdk';
 import { CodegenError } from '@animaapp/anima-sdk';
+import { Context } from 'react';
 import { GetCodeFromWebsiteParams } from '@animaapp/anima-sdk';
 import { GetCodeParams } from '@animaapp/anima-sdk';
 import { GetFileResponse } from '@figma/rest-api-spec';
 import { GetLink2CodeParams } from '@animaapp/anima-sdk';
+import { JSX } from 'react/jsx-runtime';
 import { ProgressMessage } from '@animaapp/anima-sdk';
+import { ReactNode } from 'react';
 
-export declare type CodegenState = {
-    status: Status;
-    error: CodegenError | null;
-    result: AnimaSDKResult | null;
-    progressMessages: ProgressMessage[];
-    tasks: {
-        fetchDesign: {
-            status: TaskStatus;
-        };
-        codeGeneration: {
-            status: TaskStatus;
-            progress: number;
-        };
-        uploadAssets: {
-            status: TaskStatus;
-        };
-    };
-    jobSessionId: string | null;
-    jobStatus: Record<string, any>;
+export declare const AnimaSdkContext: Context<AnimaSdkContextType | null>;
+
+declare type AnimaSdkContextType = {
+    createJob: <T extends UseAnimaParams = UseAnimaParams>(type: JobType, params: T) => Promise<void>;
+    job: Job;
 };
 
-export declare const createJob: <T extends UseAnimaParams = UseAnimaParams>(url: string, method: string, params: T, stateUpdated: (state: CodegenState) => void) => Promise<{
-    result: null;
-    error: CodegenError;
+export declare function AnimaSdkProvider({ f2cUrl, l2cUrl, p2cUrl, children }: Props): JSX.Element;
+
+export declare class CreateJobError extends Error {
+    constructor(message: string, cause: unknown);
+}
+
+declare type Job = {
+    status: 'idle';
 } | {
-    result: AnimaSDKResult | null;
-    error: null;
-}>;
+    status: 'error';
+    type: JobType;
+    params: Record<string, any>;
+    error: CreateJobError;
+    sessionId: string | null;
+    payload: Record<string, any>;
+    progressMessages: ProgressMessage[];
+} | {
+    status: 'pending';
+    type: JobType;
+    params: Record<string, any>;
+    sessionId: string | null;
+    payload: Record<string, any>;
+    progressMessages: ProgressMessage[];
+} | {
+    status: 'success';
+    type: JobType;
+    params: Record<string, any>;
+    sessionId: string;
+    payload: Record<string, any>;
+    assets?: Array<{
+        name: string;
+        url: string;
+    }>;
+    files: AnimaFiles;
+    progressMessages: ProgressMessage[];
+};
 
-export declare const initialProgress: CodegenState;
+declare type JobType = 'f2c' | 'l2c' | 'p2c';
 
 declare type LocalAssetsStorage = {
     strategy: "local";
@@ -46,10 +65,20 @@ declare type LocalAssetsStorage = {
     referencePath: string;
 };
 
-declare type Status = "idle" | "pending" | "success" | "aborted" | "error";
+declare type Props = {
+    f2cUrl: string;
+    l2cUrl: string;
+    p2cUrl: string;
+    children: ReactNode;
+};
 
-declare type TaskStatus = "pending" | "running" | "finished";
+export declare class UnknownCodegenError extends Error {
+    constructor();
+}
 
+/**
+ * @deprecated use `createJob` from `AnimaSdkProvider` instead
+ */
 export declare const useAnimaCodegen: ({ url, method, }: {
     url: string;
     method?: string;
@@ -81,7 +110,7 @@ export declare const useAnimaCodegen: ({ url, method, }: {
     result: AnimaSDKResult | null;
 };
 
-export declare type UseAnimaParams = (Omit<GetCodeParams, "assetsStorage"> & {
+declare type UseAnimaParams = (Omit<GetCodeParams, "assetsStorage"> & {
     assetsStorage?: GetCodeParams["assetsStorage"] | LocalAssetsStorage;
 }) | (Omit<GetCodeFromWebsiteParams, "assetsStorage"> & {
     assetsStorage?: GetCodeFromWebsiteParams["assetsStorage"] | LocalAssetsStorage;
@@ -89,6 +118,8 @@ export declare type UseAnimaParams = (Omit<GetCodeParams, "assetsStorage"> & {
     assetsStorage?: GetLink2CodeParams["assetsStorage"] | LocalAssetsStorage;
 });
 
+export declare function useAnimaSDK(): AnimaSdkContextType;
+
 export declare const useFigmaFile: ({ fileKey, authToken, enabled, params, }: {
     fileKey: string;
     authToken: string;