@animaapp/anima-sdk 0.11.0 → 0.13.0

package/dist/index.d.ts

@@ -51,7 +51,8 @@ export declare class Anima {
     /**
      * @deprecated This method will be removed soon, please use `generateCodeFromWebsite` instead.
      */
-    generateLink2Code(params: GetLink2CodeParams, handler?: GetLink2CodeHandler, signal?: AbortSignal): Promise<AnimaSDKResult>;
+    generateLink2Code(params: GetLink2CodeParams, handler?: GetCodeFromWebsiteHandler, signal?: AbortSignal): Promise<AnimaSDKResult>;
+    attachToGenerationJob<T extends SSEGetCodeFromFigmaMessage | SSEGetCodeFromWebsiteMessage | SSEGetCodeFromPromptMessage>(params: AttachToGenerationJobParams, handler?: ((message: T) => void) | Record<string, any>, signal?: AbortSignal): Promise<AnimaSDKResult>;
 }
 
 export declare type AnimaFiles = Record<string, {
@@ -74,6 +75,32 @@ export declare type AssetsStorage = {
     url: string;
 };
 
+export declare type AttachToGenerationJobParams = {
+    sessionId: string;
+};
+
+/**
+ * Creates a Server-Sent Events (SSE) `Response` that forwards all messages from the code generation stream.
+ *
+ * But, if the first message indicates an error (e.g., connection failed), the function returns a 500 response with the error message.
+ *
+ * @param {Anima} anima - The Anima instance to use for creating the data stream.
+ * @param {GetCodeFromPromptParams} params - The parameters for the code generation request.
+ * @returns {Promise<Response>} - A promise that resolves to an HTTP response.
+ */
+export declare const attachToGenerationJobResponseEventStream: (anima: Anima, params: AttachToGenerationJobParams) => Promise<Response>;
+
+/**
+ * Creates a ReadableStream to output code generation result.
+ *
+ * The stream is closed when the code generation ends.
+ *
+ * @param {Anima} anima - An Anima service instance to generate the code from.
+ * @param {GetCodeFromPromptParams} params - Parameters required for the code generation process.
+ * @returns {ReadableStream<StreamCodeFromPromptMessage>} - A ReadableStream that emits messages related to the code generation process.
+ */
+export declare const attachToGenerationJobStream: (anima: Anima, params: AttachToGenerationJobParams) => ReadableStream<StreamCodgenMessage | StreamCodeFromWebsiteMessage | StreamCodeFromPromptMessage>;
+
 export declare type Auth = {
     token: string;
     teamId: string;
@@ -153,7 +180,7 @@ export declare type CodegenSettings = BaseSettings & {
 /**
  * Errors from Anima API, common across multiple routes.
  */
-export declare type CommonApiError = "Missing Authorization header" | "Invalid Authorization header" | "Missing teamId" | "Internal server error" | "Forbidden, no team access" | "Requested Usage Exceeds Limit" | "Too many concurrent jobs" | "Invalid Anima token";
+export declare type CommonApiError = "Missing Authorization header" | "Invalid Authorization header" | "Missing teamId" | "Internal server error" | "Forbidden, no team access" | "Requested Usage Exceeds Limit" | "Too many concurrent jobs" | "Invalid Anima token" | "Job not found";
 
 /**
  * Creates a Server-Sent Events (SSE) `Response` that forwards all messages from the code generation from prompt stream.
@@ -496,6 +523,8 @@ export declare const isUnknownFigmaApiException: (error: Error) => boolean;
 
 export declare const isValidFigmaUrl: (figmaLink: string) => [hasCorrectPrefix: boolean, fileKey: string, nodeId: string];
 
+export declare type JobType = "f2c" | "l2c" | "p2c";
+
 /**
  * @deprecated This type is deprecated and will be removed soon.
  */
@@ -643,7 +672,7 @@ export declare type SDKErrorReason = "Invalid body payload" | "Connection closed
  */
 export declare type SSECodegenMessage = SSEGetCodeFromFigmaMessage;
 
-export declare type SSECommonMessage = {
+export declare type SSECommonMessage<TErrorReason extends string = string> = {
     type: "queueing";
     payload: {
         sessionId: string;
@@ -652,14 +681,30 @@ export declare type SSECommonMessage = {
     type: "progress_messages_updated";
     payload: {
         progressMessages: ProgressMessage[];
+        jobType?: string | null;
     };
 } | {
     type: "job_status_updated";
     payload: {
         jobStatus: Record<string, any>;
+        jobType?: string | null;
     };
 } | {
     type: "aborted";
+} | {
+    type: "done";
+    payload: {
+        sessionId: string;
+        tokenUsage: number;
+    };
+} | {
+    type: "error";
+    payload: SSEErrorPayload<TErrorReason>;
+} | {
+    type: "set_job_type";
+    payload: {
+        jobType: JobType;
+    };
 };
 
 export declare type SSEErrorPayload<Reason> = {
@@ -669,7 +714,7 @@ export declare type SSEErrorPayload<Reason> = {
     sentryTraceId?: string;
 };
 
-export declare type SSEGetCodeFromFigmaMessage = SSECommonMessage | {
+export declare type SSEGetCodeFromFigmaMessage = SSECommonMessage<GetCodeFromFigmaErrorReason> | {
     type: "start";
     sessionId: string;
 } | {
@@ -697,38 +742,20 @@ export declare type SSEGetCodeFromFigmaMessage = SSECommonMessage | {
             url: string;
         }>;
     };
-} | {
-    type: "error";
-    payload: SSEGetCodeFromFigmaMessageErrorPayload;
-} | {
-    type: "done";
-    payload: {
-        sessionId: string;
-        tokenUsage: number;
-    };
 };
 
 export declare type SSEGetCodeFromFigmaMessageErrorPayload = SSEErrorPayload<GetCodeFromFigmaErrorReason>;
 
-export declare type SSEGetCodeFromPromptMessage = SSECommonMessage | {
+export declare type SSEGetCodeFromPromptMessage = SSECommonMessage<GetCodeFromPromptErrorReason> | {
     type: "start";
     sessionId: string;
 } | {
     type: "generation_completed";
-} | {
-    type: "error";
-    payload: SSEGetCodeFromPromptMessageErrorPayload;
-} | {
-    type: "done";
-    payload: {
-        sessionId: string;
-        tokenUsage: number;
-    };
 };
 
 export declare type SSEGetCodeFromPromptMessageErrorPayload = SSEErrorPayload<GetCodeFromPromptErrorReason>;
 
-export declare type SSEGetCodeFromWebsiteMessage = SSECommonMessage | {
+export declare type SSEGetCodeFromWebsiteMessage = SSECommonMessage<GetCodeFromWebsiteErrorReason> | {
     type: "start";
     sessionId: string;
 } | {
@@ -749,15 +776,6 @@ export declare type SSEGetCodeFromWebsiteMessage = SSECommonMessage | {
             url: string;
         }>;
     };
-} | {
-    type: "error";
-    payload: SSEGetCodeFromWebsiteMessageErrorPayload;
-} | {
-    type: "done";
-    payload: {
-        sessionId: string;
-        tokenUsage: number;
-    };
 };
 
 export declare type SSEGetCodeFromWebsiteMessageErrorPayload = SSEErrorPayload<GetCodeFromWebsiteErrorReason>;