@animaapp/anima-sdk 0.6.4 → 0.6.9

package/dist/index.d.ts

@@ -16,10 +16,9 @@ export declare class Anima {
     set auth(auth: Auth);
     protected get headers(): Record<string, string>;
     generateCode(params: GetCodeParams, handler?: GetCodeHandler, signal?: AbortSignal): Promise<AnimaSDKResult>;
+    generateCodeFromWebsite(params: GetCodeFromWebsiteParams, handler?: GetCodeFromWebsiteHandler, signal?: AbortSignal): Promise<AnimaSDKResult>;
     /**
-     * @experimental
-     * This API is experimental and may change or be removed in future releases.
-     * Link2Code (l2c) flow.
+     * @deprecated This method will be removed soon, please use `generateCodeFromWebsite` instead.
      */
     generateLink2Code(params: GetLink2CodeParams, handler?: GetLink2CodeHandler, signal?: AbortSignal): Promise<AnimaSDKResult>;
 }
@@ -64,7 +63,7 @@ export declare class CodegenError extends Error {
     detail?: unknown;
     constructor({ name, reason, status, detail, }: {
         name: string;
-        reason: CodegenErrorReason | CodegenRouteErrorReason | SDKErrorReason;
+        reason: CodegenErrorReason | CodegenRouteErrorReason | SDKErrorReason | GetCodeFromWebsiteErrorReason;
         status?: number;
         detail?: unknown;
     });
@@ -110,6 +109,28 @@ export declare type CodegenSettings = {
     codegenSettings?: Record<string, unknown>;
 };
 
+/**
+ * Creates a Server-Sent Events (SSE) `Response` that forwards all messages from the code generation from website 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 {GetCodeFromWebsiteParams} params - The parameters for the code generation request.
+ * @returns {Promise<Response>} - A promise that resolves to an HTTP response.
+ */
+export declare const createCodeFromWebsiteResponseEventStream: (anima: Anima, params: GetCodeFromWebsiteParams) => Promise<Response>;
+
+/**
+ * Start the code generation from website and creates a ReadableStream to output its result.
+ *
+ * The stream is closed when the code generation ends.
+ *
+ * @param {Anima} anima - An Anima service instance to generate the code from.
+ * @param {GetCodeFromWebsiteParams} params - Parameters required for the code generation process.
+ * @returns {ReadableStream<StreamCodeFromWebsiteMessage>} - A ReadableStream that emits messages related to the code generation process.
+ */
+export declare const createCodeFromWebsiteStream: (anima: Anima, params: GetCodeFromWebsiteParams) => ReadableStream<StreamCodeFromWebsiteMessage>;
+
 /**
  * Creates a Server-Sent Events (SSE) `Response` that forwards all messages from the code generation stream.
  *
@@ -133,6 +154,7 @@ export declare const createCodegenResponseEventStream: (anima: Anima, params: Ge
 export declare const createCodegenStream: (anima: Anima, params: GetCodeParams) => ReadableStream<StreamCodgenMessage>;
 
 /**
+ * @deprecated This function will be removed soon, please use `createCodeFromWebsiteResponseEventStream` instead.
  * Creates a Server-Sent Events (SSE) `Response` that forwards all messages from the URL to 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.
@@ -144,6 +166,7 @@ export declare const createCodegenStream: (anima: Anima, params: GetCodeParams)
 export declare const createLink2CodeResponseEventStream: (anima: Anima, params: GetLink2CodeParams) => Promise<Response>;
 
 /**
+ * @deprecated This function will be removed soon, please use `createCodeFromWebsiteStream` instead.
  * @experimental
  * This API is experimental and may change or be removed in future releases.
  * Link2Code (l2c) stream flow.
@@ -201,6 +224,45 @@ export declare type GeneratingCodePayload = {
     files: AnimaFiles;
 };
 
+/**
+ * Errors from the Website To Code Flow
+ */
+export declare type GetCodeFromWebsiteErrorReason = "Scraping is blocked" | "Unknown";
+
+export declare type GetCodeFromWebsiteHandler = ((message: SSEGetCodeFromWebsiteMessage) => void) | {
+    onQueueing?: () => void;
+    onStart?: ({ sessionId }: {
+        sessionId: string;
+    }) => void;
+    onAssetsUploaded?: () => void;
+    onAssetsList?: ({ assets, }: {
+        assets: Array<{
+            name: string;
+            url: string;
+        }>;
+    }) => void;
+    onGeneratingCode?: ({ status, progress, files, }: {
+        status: "success" | "running" | "failure";
+        progress: number;
+        files: AnimaFiles;
+    }) => void;
+    onCodegenCompleted?: () => void;
+};
+
+export declare type GetCodeFromWebsiteParams = {
+    url: string;
+    assetsStorage?: AssetsStorage;
+    settings: GetCodeFromWebsiteSettings;
+    tracking?: TrackingInfos;
+};
+
+export declare type GetCodeFromWebsiteSettings = {
+    language?: "typescript";
+    framework: "react" | "html";
+    styling: "tailwind" | "inline_styles";
+    uiLibrary?: "shadcn";
+};
+
 export declare type GetCodeHandler = ((message: SSECodgenMessage) => void) | {
     onQueueing?: () => void;
     onStart?: ({ sessionId }: {
@@ -282,26 +344,14 @@ export declare type GetFileParams = {
     figmaRestApi?: FigmaRestApi;
 };
 
-export declare type GetLink2CodeHandler = ((message: SSEL2CMessage) => void) | {
-    onQueueing?: () => void;
-    onStart?: ({ sessionId }: {
-        sessionId: string;
-    }) => void;
-    onAssetsUploaded?: () => void;
-    onAssetsList?: ({ assets, }: {
-        assets: Array<{
-            name: string;
-            url: string;
-        }>;
-    }) => void;
-    onGeneratingCode?: ({ status, progress, files, }: {
-        status: "success" | "running" | "failure";
-        progress: number;
-        files: AnimaFiles;
-    }) => void;
-    onCodegenCompleted?: () => void;
-};
+/**
+ * @deprecated This type is deprecated and will be removed soon.
+ */
+export declare type GetLink2CodeHandler = GetCodeFromWebsiteHandler;
 
+/**
+ * @deprecated This type is deprecated and will be removed soon.
+ */
 export declare type GetLink2CodeParams = {
     params: L2CParams;
     assetsStorage?: AssetsStorage;
@@ -335,6 +385,9 @@ export declare const isUnknownFigmaApiException: (error: Error) => boolean;
 
 export declare const isValidFigmaUrl: (figmaLink: string) => [hasCorrectPrefix: boolean, fileKey: string, nodeId: string];
 
+/**
+ * @deprecated This type is deprecated and will be removed soon.
+ */
 export declare type L2CParams = {
     input: L2CParamsInput;
     conventions: L2CParamsConvention;
@@ -342,27 +395,51 @@ export declare type L2CParams = {
     viewports?: Array<'desktop' | 'tablet' | 'mobile'>;
 };
 
+/**
+ * @deprecated This type is deprecated and will be removed soon.
+ */
 export declare type L2CParamsAssetsStorage = L2CParamsBundledAssetsStorage;
 
+/**
+ * @deprecated This type is deprecated and will be removed soon.
+ */
 export declare type L2CParamsBundledAssetsStorage = {
     type: 'bundled';
     referencePath?: string;
     importMode?: 'watermarked' | 'original';
 };
 
+/**
+ * @deprecated This type is deprecated and will be removed soon.
+ */
 export declare type L2CParamsConvention = L2CParamsHtmlConvention | L2CParamsReactConvention;
 
+/**
+ * @deprecated This type is deprecated and will be removed soon.
+ */
 export declare type L2CParamsFramework = 'html' | 'react';
 
+/**
+ * @deprecated This type is deprecated and will be removed soon.
+ */
 export declare type L2CParamsHtmlConvention = {
     framework: 'html';
     styling: L2CParamsStyling;
 };
 
+/**
+ * @deprecated This type is deprecated and will be removed soon.
+ */
 export declare type L2CParamsInput = L2CParamsUrlInput;
 
+/**
+ * @deprecated This type is deprecated and will be removed soon.
+ */
 export declare type L2CParamsLanguage = 'typescript';
 
+/**
+ * @deprecated This type is deprecated and will be removed soon.
+ */
 export declare type L2CParamsReactConvention = {
     framework: 'react';
     language: L2CParamsLanguage;
@@ -370,8 +447,14 @@ export declare type L2CParamsReactConvention = {
     enableGeneratePackageLock?: boolean;
 };
 
+/**
+ * @deprecated This type is deprecated and will be removed soon.
+ */
 export declare type L2CParamsStyling = 'tailwind' | 'inline-styles';
 
+/**
+ * @deprecated This type is deprecated and will be removed soon.
+ */
 export declare type L2CParamsUrlInput = {
     type: 'url';
     url: string;
@@ -464,7 +547,7 @@ export declare type SSECodgenMessageErrorPayload = {
     reason: CodegenErrorReason;
 };
 
-export declare type SSEL2CMessage = {
+export declare type SSEGetCodeFromWebsiteMessage = {
     type: 'queueing';
 } | {
     type: 'start';
@@ -488,7 +571,7 @@ export declare type SSEL2CMessage = {
     type: 'aborted';
 } | {
     type: 'error';
-    payload: SSECodegenMessageErrorPayload;
+    payload: SSEGetCodeFromWebsiteMessageErrorPayload;
 } | {
     type: 'done';
     payload: {
@@ -497,6 +580,20 @@ export declare type SSEL2CMessage = {
     };
 };
 
+export declare type SSEGetCodeFromWebsiteMessageErrorPayload = {
+    errorName: string;
+    task?: string;
+    reason: GetCodeFromWebsiteErrorReason;
+    sentryTraceId?: string;
+};
+
+/**
+ * @deprecated This type is deprecated and will be removed soon.
+ */
+export declare type SSEL2CMessage = SSEGetCodeFromWebsiteMessage;
+
+export declare type StreamCodeFromWebsiteMessage = StreamMessage<SSEGetCodeFromWebsiteMessage>;
+
 export declare type StreamCodgenMessage = StreamMessage<SSECodgenMessage>;
 
 declare type StreamErrorPayload = {