@howone/sdk 0.7.0 → 0.7.1

package/dist/index.d.mts

@@ -56,6 +56,23 @@ interface BatchUploadResponse {
     total: number;
 }
 
+type LimitExceededSource = "axios-response" | "workflow-executor-sse" | "workflow-executor-rest" | "sse-executor" | "ai-workflow";
+interface LimitExceededContext {
+    source: LimitExceededSource;
+    message: string;
+    status?: number;
+    eventType?: string;
+    rawData?: unknown;
+}
+interface LimitExceededHandlerOptions {
+    onLimitExceeded?: (context: LimitExceededContext) => void;
+    showUpgradeToast?: boolean;
+    upgradeUrl?: string;
+}
+declare const DEFAULT_LIMIT_EXCEEDED_MESSAGE = "Your credits are exhausted. Please upgrade your plan to continue generating projects.";
+declare function handleLimitExceeded(context: LimitExceededContext, options?: LimitExceededHandlerOptions): void;
+declare function mergeLimitExceededOptions(base?: LimitExceededHandlerOptions, override?: LimitExceededHandlerOptions): LimitExceededHandlerOptions | undefined;
+
 /**
  * 统一的 SSE 工作流执行模块
  *
@@ -67,6 +84,7 @@ interface BatchUploadResponse {
  *
  * 提供统一的 API 给 client 使用
  */
+
 interface SSEEventPayload {
     type: string;
     data?: Record<string, unknown>;
@@ -103,6 +121,7 @@ interface SSEExecutionOptions {
     onError?: (error: Error) => void;
     onComplete?: (result: ExecutionResult) => void;
     signal?: AbortSignal;
+    limitExceeded?: LimitExceededHandlerOptions;
 }
 interface SSEWorkflowRequestInit {
     url: string;
@@ -158,6 +177,7 @@ interface SSEClientConfig {
     baseUrl: string;
     projectId?: string;
     getAuthToken?: () => string | null;
+    limitExceeded?: LimitExceededHandlerOptions;
 }
 interface SSEClient {
     /**
@@ -608,8 +628,9 @@ declare function getGlobalEnvironment(): Environment | null;
  * - POST /workflow/{projectId}/{workflowId}/execute (返回 SSE 流)
  * - 发送 JSON 格式的事件: data: {"type": "...", "data": {...}}
  */
+
 interface WorkflowStreamEvent {
-    type: 'start' | 'progress' | 'stream' | 'log' | 'complete' | 'error';
+    type: 'start' | 'progress' | 'stream' | 'log' | 'complete' | 'error' | 'key_limit_exceed';
     data?: any;
     message?: string;
     progress?: number;
@@ -623,6 +644,7 @@ interface WorkflowStreamOptions {
     onLog?: (message: string) => void;
     onError?: (error: Error) => void;
     signal?: AbortSignal;
+    limitExceeded?: LimitExceededHandlerOptions;
 }
 interface WorkflowStreamResponse {
     success: boolean;
@@ -645,6 +667,7 @@ interface WorkflowStreamResponse {
  * - 统一的错误处理
  * - 支持所有事件类型
  */
+
 interface ExecutionLogData {
     log_type: 'node_start' | 'cost_update' | 'execution_complete' | 'stream' | 'log' | string;
     workflow_id: string;
@@ -695,6 +718,7 @@ interface WorkflowExecutorOptions {
     onComplete?: (result: ParsedWorkflowResult) => void;
     onError?: (error: Error) => void;
     signal?: AbortSignal;
+    limitExceeded?: LimitExceededHandlerOptions;
 }
 /**
  * 工作流执行器类
@@ -706,7 +730,8 @@ declare class WorkflowExecutor {
     private baseUrl;
     private projectId;
     private authToken?;
-    constructor(baseUrl: string, projectId: string, authToken?: string);
+    private limitExceeded?;
+    constructor(baseUrl: string, projectId: string, authToken?: string, limitExceeded?: LimitExceededHandlerOptions);
     /**
      * 执行工作流 (SSE 模式)
      *
@@ -778,6 +803,7 @@ declare function createClient(opts: {
     env?: 'local' | 'dev' | 'prod';
     baseUrl?: string;
     authRequired?: boolean;
+    limitExceeded?: LimitExceededHandlerOptions;
     mode?: "auto" | "standalone" | "embedded";
     auth?: {
         mode?: "none" | "managed" | "headless";
@@ -1351,4 +1377,4 @@ declare const elementSelector: {
     isActive: () => boolean;
 };
 
-export { type AIWorkflowClientOptions, type AIWorkflowResponse, AUTH_TOKEN_KEY, type AccessContext, type Artifact, type ArtifactCreateInput, type ArtifactListQuery, type AxiosAIWorkflowOptions, type BatchUploadOptions, type BatchUploadResponse, ClayxButton, ClayxToast, type CostUpdate, DefaultErrorFallback, type ElementSelectionData, ElementSelector, ElementSelectorProvider, type EmailLoginRequest, type EmailLoginResponse, type Environment, ErrorBoundary, type ExecutionResult, FloatingButton, type GenerateImageOptions, type GenerateImageResponse, GlobalToastContainer, HowOneProvider, type HowOneProviderProps, Loading, LoadingSpinner, LoginForm, type NodeExecution, type SSEClient, type SSEClientConfig, type SSEEventPayload, type SSEExecutionOptions, type SSERequest, type SSESession, type SSEStreamConfig, type SSEWorkflowOptions, type SSEWorkflowRequestInit, type SendCodeRequest, type SendCodeResponse, type SourceLocation, ThemeProvider, ThemeToggle, type ToastParams, type ToastType, type UploadOptions, type UploadResponse, type UseElementSelectorReturn, type UseWorkflowStreamState, type Visibility, aiWorkflow, canAccessArtifact, createAIWorkflowClient, createAIWorkflowClientAxios, createArtifactsClient, createClient, createSSEClient, createSSERequest, createUploadClient, elementSelector, type envs, executeSSEWorkflow, getCodeStatus, getDefaultProjectId, getEnvironment, getEnvs, getGlobalEnvironment, getToken, howone, iframeNavigation, initIframeNavigation, isTokenValid, loginWithEmailCode, onAuthStateChanged, parseUserFromToken, sendElementSelectionToParent, sendEmailVerificationCode, setDefaultProjectId, setEnvironment, setToken, showLimitUpgradeToast, unifiedAuth, unifiedOAuth, useAuth, useDebounce, useElementSelector, useHowoneContext, useIsMobile, useTheme, useWorkflowStream };
+export { type AIWorkflowClientOptions, type AIWorkflowResponse, AUTH_TOKEN_KEY, type AccessContext, type Artifact, type ArtifactCreateInput, type ArtifactListQuery, type AxiosAIWorkflowOptions, type BatchUploadOptions, type BatchUploadResponse, ClayxButton, ClayxToast, type CostUpdate, DEFAULT_LIMIT_EXCEEDED_MESSAGE, DefaultErrorFallback, type ElementSelectionData, ElementSelector, ElementSelectorProvider, type EmailLoginRequest, type EmailLoginResponse, type Environment, ErrorBoundary, type ExecutionResult, FloatingButton, type GenerateImageOptions, type GenerateImageResponse, GlobalToastContainer, HowOneProvider, type HowOneProviderProps, type LimitExceededContext, type LimitExceededHandlerOptions, type LimitExceededSource, Loading, LoadingSpinner, LoginForm, type NodeExecution, type SSEClient, type SSEClientConfig, type SSEEventPayload, type SSEExecutionOptions, type SSERequest, type SSESession, type SSEStreamConfig, type SSEWorkflowOptions, type SSEWorkflowRequestInit, type SendCodeRequest, type SendCodeResponse, type SourceLocation, ThemeProvider, ThemeToggle, type ToastParams, type ToastType, type UploadOptions, type UploadResponse, type UseElementSelectorReturn, type UseWorkflowStreamState, type Visibility, aiWorkflow, canAccessArtifact, createAIWorkflowClient, createAIWorkflowClientAxios, createArtifactsClient, createClient, createSSEClient, createSSERequest, createUploadClient, elementSelector, type envs, executeSSEWorkflow, getCodeStatus, getDefaultProjectId, getEnvironment, getEnvs, getGlobalEnvironment, getToken, handleLimitExceeded, howone, iframeNavigation, initIframeNavigation, isTokenValid, loginWithEmailCode, mergeLimitExceededOptions, onAuthStateChanged, parseUserFromToken, sendElementSelectionToParent, sendEmailVerificationCode, setDefaultProjectId, setEnvironment, setToken, showLimitUpgradeToast, unifiedAuth, unifiedOAuth, useAuth, useDebounce, useElementSelector, useHowoneContext, useIsMobile, useTheme, useWorkflowStream };

package/dist/index.d.ts

@@ -56,6 +56,23 @@ interface BatchUploadResponse {
     total: number;
 }
 
+type LimitExceededSource = "axios-response" | "workflow-executor-sse" | "workflow-executor-rest" | "sse-executor" | "ai-workflow";
+interface LimitExceededContext {
+    source: LimitExceededSource;
+    message: string;
+    status?: number;
+    eventType?: string;
+    rawData?: unknown;
+}
+interface LimitExceededHandlerOptions {
+    onLimitExceeded?: (context: LimitExceededContext) => void;
+    showUpgradeToast?: boolean;
+    upgradeUrl?: string;
+}
+declare const DEFAULT_LIMIT_EXCEEDED_MESSAGE = "Your credits are exhausted. Please upgrade your plan to continue generating projects.";
+declare function handleLimitExceeded(context: LimitExceededContext, options?: LimitExceededHandlerOptions): void;
+declare function mergeLimitExceededOptions(base?: LimitExceededHandlerOptions, override?: LimitExceededHandlerOptions): LimitExceededHandlerOptions | undefined;
+
 /**
  * 统一的 SSE 工作流执行模块
  *
@@ -67,6 +84,7 @@ interface BatchUploadResponse {
  *
  * 提供统一的 API 给 client 使用
  */
+
 interface SSEEventPayload {
     type: string;
     data?: Record<string, unknown>;
@@ -103,6 +121,7 @@ interface SSEExecutionOptions {
     onError?: (error: Error) => void;
     onComplete?: (result: ExecutionResult) => void;
     signal?: AbortSignal;
+    limitExceeded?: LimitExceededHandlerOptions;
 }
 interface SSEWorkflowRequestInit {
     url: string;
@@ -158,6 +177,7 @@ interface SSEClientConfig {
     baseUrl: string;
     projectId?: string;
     getAuthToken?: () => string | null;
+    limitExceeded?: LimitExceededHandlerOptions;
 }
 interface SSEClient {
     /**
@@ -608,8 +628,9 @@ declare function getGlobalEnvironment(): Environment | null;
  * - POST /workflow/{projectId}/{workflowId}/execute (返回 SSE 流)
  * - 发送 JSON 格式的事件: data: {"type": "...", "data": {...}}
  */
+
 interface WorkflowStreamEvent {
-    type: 'start' | 'progress' | 'stream' | 'log' | 'complete' | 'error';
+    type: 'start' | 'progress' | 'stream' | 'log' | 'complete' | 'error' | 'key_limit_exceed';
     data?: any;
     message?: string;
     progress?: number;
@@ -623,6 +644,7 @@ interface WorkflowStreamOptions {
     onLog?: (message: string) => void;
     onError?: (error: Error) => void;
     signal?: AbortSignal;
+    limitExceeded?: LimitExceededHandlerOptions;
 }
 interface WorkflowStreamResponse {
     success: boolean;
@@ -645,6 +667,7 @@ interface WorkflowStreamResponse {
  * - 统一的错误处理
  * - 支持所有事件类型
  */
+
 interface ExecutionLogData {
     log_type: 'node_start' | 'cost_update' | 'execution_complete' | 'stream' | 'log' | string;
     workflow_id: string;
@@ -695,6 +718,7 @@ interface WorkflowExecutorOptions {
     onComplete?: (result: ParsedWorkflowResult) => void;
     onError?: (error: Error) => void;
     signal?: AbortSignal;
+    limitExceeded?: LimitExceededHandlerOptions;
 }
 /**
  * 工作流执行器类
@@ -706,7 +730,8 @@ declare class WorkflowExecutor {
     private baseUrl;
     private projectId;
     private authToken?;
-    constructor(baseUrl: string, projectId: string, authToken?: string);
+    private limitExceeded?;
+    constructor(baseUrl: string, projectId: string, authToken?: string, limitExceeded?: LimitExceededHandlerOptions);
     /**
      * 执行工作流 (SSE 模式)
      *
@@ -778,6 +803,7 @@ declare function createClient(opts: {
     env?: 'local' | 'dev' | 'prod';
     baseUrl?: string;
     authRequired?: boolean;
+    limitExceeded?: LimitExceededHandlerOptions;
     mode?: "auto" | "standalone" | "embedded";
     auth?: {
         mode?: "none" | "managed" | "headless";
@@ -1351,4 +1377,4 @@ declare const elementSelector: {
     isActive: () => boolean;
 };
 
-export { type AIWorkflowClientOptions, type AIWorkflowResponse, AUTH_TOKEN_KEY, type AccessContext, type Artifact, type ArtifactCreateInput, type ArtifactListQuery, type AxiosAIWorkflowOptions, type BatchUploadOptions, type BatchUploadResponse, ClayxButton, ClayxToast, type CostUpdate, DefaultErrorFallback, type ElementSelectionData, ElementSelector, ElementSelectorProvider, type EmailLoginRequest, type EmailLoginResponse, type Environment, ErrorBoundary, type ExecutionResult, FloatingButton, type GenerateImageOptions, type GenerateImageResponse, GlobalToastContainer, HowOneProvider, type HowOneProviderProps, Loading, LoadingSpinner, LoginForm, type NodeExecution, type SSEClient, type SSEClientConfig, type SSEEventPayload, type SSEExecutionOptions, type SSERequest, type SSESession, type SSEStreamConfig, type SSEWorkflowOptions, type SSEWorkflowRequestInit, type SendCodeRequest, type SendCodeResponse, type SourceLocation, ThemeProvider, ThemeToggle, type ToastParams, type ToastType, type UploadOptions, type UploadResponse, type UseElementSelectorReturn, type UseWorkflowStreamState, type Visibility, aiWorkflow, canAccessArtifact, createAIWorkflowClient, createAIWorkflowClientAxios, createArtifactsClient, createClient, createSSEClient, createSSERequest, createUploadClient, elementSelector, type envs, executeSSEWorkflow, getCodeStatus, getDefaultProjectId, getEnvironment, getEnvs, getGlobalEnvironment, getToken, howone, iframeNavigation, initIframeNavigation, isTokenValid, loginWithEmailCode, onAuthStateChanged, parseUserFromToken, sendElementSelectionToParent, sendEmailVerificationCode, setDefaultProjectId, setEnvironment, setToken, showLimitUpgradeToast, unifiedAuth, unifiedOAuth, useAuth, useDebounce, useElementSelector, useHowoneContext, useIsMobile, useTheme, useWorkflowStream };
+export { type AIWorkflowClientOptions, type AIWorkflowResponse, AUTH_TOKEN_KEY, type AccessContext, type Artifact, type ArtifactCreateInput, type ArtifactListQuery, type AxiosAIWorkflowOptions, type BatchUploadOptions, type BatchUploadResponse, ClayxButton, ClayxToast, type CostUpdate, DEFAULT_LIMIT_EXCEEDED_MESSAGE, DefaultErrorFallback, type ElementSelectionData, ElementSelector, ElementSelectorProvider, type EmailLoginRequest, type EmailLoginResponse, type Environment, ErrorBoundary, type ExecutionResult, FloatingButton, type GenerateImageOptions, type GenerateImageResponse, GlobalToastContainer, HowOneProvider, type HowOneProviderProps, type LimitExceededContext, type LimitExceededHandlerOptions, type LimitExceededSource, Loading, LoadingSpinner, LoginForm, type NodeExecution, type SSEClient, type SSEClientConfig, type SSEEventPayload, type SSEExecutionOptions, type SSERequest, type SSESession, type SSEStreamConfig, type SSEWorkflowOptions, type SSEWorkflowRequestInit, type SendCodeRequest, type SendCodeResponse, type SourceLocation, ThemeProvider, ThemeToggle, type ToastParams, type ToastType, type UploadOptions, type UploadResponse, type UseElementSelectorReturn, type UseWorkflowStreamState, type Visibility, aiWorkflow, canAccessArtifact, createAIWorkflowClient, createAIWorkflowClientAxios, createArtifactsClient, createClient, createSSEClient, createSSERequest, createUploadClient, elementSelector, type envs, executeSSEWorkflow, getCodeStatus, getDefaultProjectId, getEnvironment, getEnvs, getGlobalEnvironment, getToken, handleLimitExceeded, howone, iframeNavigation, initIframeNavigation, isTokenValid, loginWithEmailCode, mergeLimitExceededOptions, onAuthStateChanged, parseUserFromToken, sendElementSelectionToParent, sendEmailVerificationCode, setDefaultProjectId, setEnvironment, setToken, showLimitUpgradeToast, unifiedAuth, unifiedOAuth, useAuth, useDebounce, useElementSelector, useHowoneContext, useIsMobile, useTheme, useWorkflowStream };