wuying-agentbay-sdk 0.4.0 → 0.4.2

package/dist/index.d.mts

@@ -1753,6 +1753,11 @@ declare class ContextSync {
     constructor(contextId: string, path: string, policy?: SyncPolicy);
     withPolicy(policy: SyncPolicy): ContextSync;
 }
+declare function newUploadPolicy(): UploadPolicy;
+declare function newDownloadPolicy(): DownloadPolicy;
+declare function newDeletePolicy(): DeletePolicy;
+declare function newSyncPolicy(): SyncPolicy;
+declare function newContextSync(contextId: string, path: string, policy?: SyncPolicy): ContextSync;
 
 /**
  * Represents an installed application.
@@ -1913,6 +1918,10 @@ interface ContextStatusData {
     finishTime: number;
     taskType: string;
 }
+interface ContextStatusItem {
+    type: string;
+    data: string;
+}
 interface ContextInfoResult extends ApiResponse {
     contextStatusData: ContextStatusData[];
 }
@@ -1932,6 +1941,7 @@ declare class ContextManager {
     sync(): Promise<ContextSyncResult>;
     syncWithParams(contextId?: string, path?: string, mode?: string): Promise<ContextSyncResult>;
 }
+declare function newContextManager(session: SessionInterface): ContextManager;
 
 /**
  * FileInfo represents information about a file or directory
@@ -2414,9 +2424,10 @@ declare class Session {
     /**
      * Delete this session.
      *
+     * @param syncContext - Whether to sync context data (trigger file uploads) before deleting the session. Defaults to false.
      * @returns DeleteResult indicating success or failure and request ID
      */
-    delete(): Promise<DeleteResult>;
+    delete(syncContext?: boolean): Promise<DeleteResult>;
     /**
      * Sets the labels for this session.
      *
@@ -2488,7 +2499,7 @@ interface SessionListResult extends ApiResponse {
 /**
  * Parameters for creating a session.
  */
-interface CreateSessionParams {
+interface CreateSessionParams$1 {
     contextId?: string;
     labels?: Record<string, string>;
     imageId?: string;
@@ -2524,7 +2535,7 @@ declare class AgentBay {
      * @param params - Optional parameters for creating the session
      * @returns SessionResult containing the created session and request ID
      */
-    create(params?: CreateSessionParams): Promise<SessionResult>;
+    create(params?: CreateSessionParams$1): Promise<SessionResult>;
     /**
      * List all available sessions.
      *
@@ -2545,9 +2556,10 @@ declare class AgentBay {
      * Delete a session by session object.
      *
      * @param session - The session to delete.
+     * @param syncContext - Whether to sync context data (trigger file uploads) before deleting the session. Defaults to false.
      * @returns DeleteResult indicating success or failure and request ID
      */
-    delete(session: Session): Promise<DeleteResult>;
+    delete(session: Session, syncContext?: boolean): Promise<DeleteResult>;
     /**
      *
      * @param sessionId - The ID of the session to remove.
@@ -2614,6 +2626,99 @@ declare class UIError extends AgentBayError {
     constructor(message?: string, extra?: Record<string, any>);
 }
 
+/**
+ * Configuration interface for CreateSessionParams
+ */
+interface CreateSessionParamsConfig {
+    labels: Record<string, string>;
+    /**
+     * @deprecated This field is deprecated and will be removed in a future version.
+     * Please use contextSync instead for more flexible and powerful data persistence.
+     */
+    contextId?: string;
+    imageId?: string;
+    contextSync: ContextSync[];
+}
+/**
+ * CreateSessionParams provides a way to configure the parameters for creating a new session
+ * in the AgentBay cloud environment.
+ */
+declare class CreateSessionParams implements CreateSessionParamsConfig {
+    /** Custom labels for the Session. These can be used for organizing and filtering sessions. */
+    labels: Record<string, string>;
+    /**
+     * ID of the context to bind to the session.
+     * The context can include various types of persistence like file system (volume) and cookies.
+     *
+     * @deprecated This field is deprecated and will be removed in a future version.
+     * Please use contextSync instead for more flexible and powerful data persistence.
+     *
+     * Important Limitations:
+     * 1. One session at a time: A context can only be used by one session at a time.
+     *    If you try to create a session with a context ID that is already in use by another active session,
+     *    the session creation will fail.
+     *
+     * 2. OS binding: A context is bound to the operating system of the first session that uses it.
+     *    When a context is first used with a session, it becomes bound to that session's OS.
+     *    Any attempt to use the context with a session running on a different OS will fail.
+     *    For example, if a context is first used with a Linux session, it cannot later be used
+     *    with a Windows or Android session.
+     */
+    contextId?: string;
+    /** Image ID to use for the session. */
+    imageId?: string;
+    /**
+     * List of context synchronization configurations.
+     * These configurations define how contexts should be synchronized and mounted.
+     */
+    contextSync: ContextSync[];
+    constructor();
+    /**
+     * WithLabels sets the labels for the session parameters and returns the updated parameters.
+     */
+    withLabels(labels: Record<string, string>): CreateSessionParams;
+    /**
+     * WithContextID sets the context ID for the session parameters and returns the updated parameters.
+     */
+    withContextID(contextId: string): CreateSessionParams;
+    /**
+     * WithImageId sets the image ID for the session parameters and returns the updated parameters.
+     */
+    withImageId(imageId: string): CreateSessionParams;
+    /**
+     * GetLabelsJSON returns the labels as a JSON string.
+     * Returns an object with success status and result/error message to match Go version behavior.
+     */
+    getLabelsJSON(): {
+        result: string;
+        error?: string;
+    };
+    /**
+     * AddContextSync adds a context sync configuration to the session parameters.
+     */
+    addContextSync(contextId: string, path: string, policy?: SyncPolicy): CreateSessionParams;
+    /**
+     * AddContextSyncConfig adds a pre-configured context sync to the session parameters.
+     */
+    addContextSyncConfig(contextSync: ContextSync): CreateSessionParams;
+    /**
+     * WithContextSync sets the context sync configurations for the session parameters.
+     */
+    withContextSync(contextSyncs: ContextSync[]): CreateSessionParams;
+    /**
+     * Convert to plain object for JSON serialization
+     */
+    toJSON(): CreateSessionParamsConfig;
+    /**
+     * Create from plain object
+     */
+    static fromJSON(config: CreateSessionParamsConfig): CreateSessionParams;
+}
+/**
+ * NewCreateSessionParams creates a new CreateSessionParams with default values.
+ */
+declare function newCreateSessionParams(): CreateSessionParams;
+
 /**
  * Utility functions for logging in a clean format
  */
@@ -2630,4 +2735,4 @@ declare function log(message: string, ...args: any[]): void;
  */
 declare function logError(message: string, error?: any): void;
 
-export { APIError, AgentBay, AgentBayError, Application, ApplicationError, ApplyMqttTokenRequest, ApplyMqttTokenResponse, ApplyMqttTokenResponseBody, ApplyMqttTokenResponseBodyData, AuthenticationError, CallMcpToolRequest, CallMcpToolResponse, CallMcpToolResponseBody, Client, Command, CommandError, Context, ContextService, CreateMcpSessionRequest, CreateMcpSessionRequestPersistenceDataList, CreateMcpSessionResponse, CreateMcpSessionResponseBody, CreateMcpSessionResponseBodyData, CreateMcpSessionShrinkRequest, DeleteContextRequest, DeleteContextResponse, DeleteContextResponseBody, type DirectoryEntry, FileError, type FileInfo, FileSystem, GetContextInfoRequest, GetContextInfoResponse, GetContextInfoResponseBody, GetContextInfoResponseBodyData, GetContextRequest, GetContextResponse, GetContextResponseBody, GetContextResponseBodyData, GetLabelRequest, GetLabelResponse, GetLabelResponseBody, GetLabelResponseBodyData, GetLinkRequest, GetLinkResponse, GetLinkResponseBody, GetLinkResponseBodyData, GetMcpResourceRequest, GetMcpResourceResponse, GetMcpResourceResponseBody, GetMcpResourceResponseBodyData, GetMcpResourceResponseBodyDataDesktopInfo, type InstalledApp, KeyCode, ListContextsRequest, ListContextsResponse, ListContextsResponseBody, ListContextsResponseBodyData, ListMcpToolsRequest, ListMcpToolsResponse, ListMcpToolsResponseBody, type ListSessionParams, ListSessionRequest, ListSessionResponse, ListSessionResponseBody, ListSessionResponseBodyData, ModifyContextRequest, ModifyContextResponse, ModifyContextResponseBody, Oss, OssError, type Process, ReleaseMcpSessionRequest, ReleaseMcpSessionResponse, ReleaseMcpSessionResponseBody, Session, SessionError, SetLabelRequest, SetLabelResponse, SetLabelResponseBody, SyncContextRequest, SyncContextResponse, SyncContextResponseBody, UI, type UIElement, UIError, log, logError };
+export { APIError, AgentBay, AgentBayError, Application, ApplicationError, ApplyMqttTokenRequest, ApplyMqttTokenResponse, ApplyMqttTokenResponseBody, ApplyMqttTokenResponseBodyData, AuthenticationError, type BWList, CallMcpToolRequest, CallMcpToolResponse, CallMcpToolResponseBody, Client, Command, CommandError, Context, type ContextInfoResult, ContextManager, ContextService, type ContextStatusData, type ContextStatusItem, ContextSync, type ContextSyncResult, CreateMcpSessionRequest, CreateMcpSessionRequestPersistenceDataList, CreateMcpSessionResponse, CreateMcpSessionResponseBody, CreateMcpSessionResponseBodyData, CreateMcpSessionShrinkRequest, type CreateSessionParams$1 as CreateSessionParams, type CreateSessionParamsConfig, DeleteContextRequest, DeleteContextResponse, DeleteContextResponseBody, type DeletePolicy, type DirectoryEntry, type DownloadPolicy, DownloadStrategy, FileError, type FileInfo, FileSystem, GetContextInfoRequest, GetContextInfoResponse, GetContextInfoResponseBody, GetContextInfoResponseBodyData, GetContextRequest, GetContextResponse, GetContextResponseBody, GetContextResponseBodyData, GetLabelRequest, GetLabelResponse, GetLabelResponseBody, GetLabelResponseBodyData, GetLinkRequest, GetLinkResponse, GetLinkResponseBody, GetLinkResponseBodyData, GetMcpResourceRequest, GetMcpResourceResponse, GetMcpResourceResponseBody, GetMcpResourceResponseBodyData, GetMcpResourceResponseBodyDataDesktopInfo, type InstalledApp, KeyCode, ListContextsRequest, ListContextsResponse, ListContextsResponseBody, ListContextsResponseBodyData, ListMcpToolsRequest, ListMcpToolsResponse, ListMcpToolsResponseBody, type ListSessionParams, ListSessionRequest, ListSessionResponse, ListSessionResponseBody, ListSessionResponseBodyData, ModifyContextRequest, ModifyContextResponse, ModifyContextResponseBody, Oss, OssError, type Process, ReleaseMcpSessionRequest, ReleaseMcpSessionResponse, ReleaseMcpSessionResponseBody, Session, SessionError, type SessionInterface, SetLabelRequest, SetLabelResponse, SetLabelResponseBody, SyncContextRequest, SyncContextResponse, SyncContextResponseBody, type SyncPolicy, UI, type UIElement, UIError, type UploadPolicy, UploadStrategy, type WhiteList, log, logError, newContextManager, newContextSync, newCreateSessionParams, newDeletePolicy, newDownloadPolicy, newSyncPolicy, newUploadPolicy };

package/dist/index.d.ts

@@ -1753,6 +1753,11 @@ declare class ContextSync {
     constructor(contextId: string, path: string, policy?: SyncPolicy);
     withPolicy(policy: SyncPolicy): ContextSync;
 }
+declare function newUploadPolicy(): UploadPolicy;
+declare function newDownloadPolicy(): DownloadPolicy;
+declare function newDeletePolicy(): DeletePolicy;
+declare function newSyncPolicy(): SyncPolicy;
+declare function newContextSync(contextId: string, path: string, policy?: SyncPolicy): ContextSync;
 
 /**
  * Represents an installed application.
@@ -1913,6 +1918,10 @@ interface ContextStatusData {
     finishTime: number;
     taskType: string;
 }
+interface ContextStatusItem {
+    type: string;
+    data: string;
+}
 interface ContextInfoResult extends ApiResponse {
     contextStatusData: ContextStatusData[];
 }
@@ -1932,6 +1941,7 @@ declare class ContextManager {
     sync(): Promise<ContextSyncResult>;
     syncWithParams(contextId?: string, path?: string, mode?: string): Promise<ContextSyncResult>;
 }
+declare function newContextManager(session: SessionInterface): ContextManager;
 
 /**
  * FileInfo represents information about a file or directory
@@ -2414,9 +2424,10 @@ declare class Session {
     /**
      * Delete this session.
      *
+     * @param syncContext - Whether to sync context data (trigger file uploads) before deleting the session. Defaults to false.
      * @returns DeleteResult indicating success or failure and request ID
      */
-    delete(): Promise<DeleteResult>;
+    delete(syncContext?: boolean): Promise<DeleteResult>;
     /**
      * Sets the labels for this session.
      *
@@ -2488,7 +2499,7 @@ interface SessionListResult extends ApiResponse {
 /**
  * Parameters for creating a session.
  */
-interface CreateSessionParams {
+interface CreateSessionParams$1 {
     contextId?: string;
     labels?: Record<string, string>;
     imageId?: string;
@@ -2524,7 +2535,7 @@ declare class AgentBay {
      * @param params - Optional parameters for creating the session
      * @returns SessionResult containing the created session and request ID
      */
-    create(params?: CreateSessionParams): Promise<SessionResult>;
+    create(params?: CreateSessionParams$1): Promise<SessionResult>;
     /**
      * List all available sessions.
      *
@@ -2545,9 +2556,10 @@ declare class AgentBay {
      * Delete a session by session object.
      *
      * @param session - The session to delete.
+     * @param syncContext - Whether to sync context data (trigger file uploads) before deleting the session. Defaults to false.
      * @returns DeleteResult indicating success or failure and request ID
      */
-    delete(session: Session): Promise<DeleteResult>;
+    delete(session: Session, syncContext?: boolean): Promise<DeleteResult>;
     /**
      *
      * @param sessionId - The ID of the session to remove.
@@ -2614,6 +2626,99 @@ declare class UIError extends AgentBayError {
     constructor(message?: string, extra?: Record<string, any>);
 }
 
+/**
+ * Configuration interface for CreateSessionParams
+ */
+interface CreateSessionParamsConfig {
+    labels: Record<string, string>;
+    /**
+     * @deprecated This field is deprecated and will be removed in a future version.
+     * Please use contextSync instead for more flexible and powerful data persistence.
+     */
+    contextId?: string;
+    imageId?: string;
+    contextSync: ContextSync[];
+}
+/**
+ * CreateSessionParams provides a way to configure the parameters for creating a new session
+ * in the AgentBay cloud environment.
+ */
+declare class CreateSessionParams implements CreateSessionParamsConfig {
+    /** Custom labels for the Session. These can be used for organizing and filtering sessions. */
+    labels: Record<string, string>;
+    /**
+     * ID of the context to bind to the session.
+     * The context can include various types of persistence like file system (volume) and cookies.
+     *
+     * @deprecated This field is deprecated and will be removed in a future version.
+     * Please use contextSync instead for more flexible and powerful data persistence.
+     *
+     * Important Limitations:
+     * 1. One session at a time: A context can only be used by one session at a time.
+     *    If you try to create a session with a context ID that is already in use by another active session,
+     *    the session creation will fail.
+     *
+     * 2. OS binding: A context is bound to the operating system of the first session that uses it.
+     *    When a context is first used with a session, it becomes bound to that session's OS.
+     *    Any attempt to use the context with a session running on a different OS will fail.
+     *    For example, if a context is first used with a Linux session, it cannot later be used
+     *    with a Windows or Android session.
+     */
+    contextId?: string;
+    /** Image ID to use for the session. */
+    imageId?: string;
+    /**
+     * List of context synchronization configurations.
+     * These configurations define how contexts should be synchronized and mounted.
+     */
+    contextSync: ContextSync[];
+    constructor();
+    /**
+     * WithLabels sets the labels for the session parameters and returns the updated parameters.
+     */
+    withLabels(labels: Record<string, string>): CreateSessionParams;
+    /**
+     * WithContextID sets the context ID for the session parameters and returns the updated parameters.
+     */
+    withContextID(contextId: string): CreateSessionParams;
+    /**
+     * WithImageId sets the image ID for the session parameters and returns the updated parameters.
+     */
+    withImageId(imageId: string): CreateSessionParams;
+    /**
+     * GetLabelsJSON returns the labels as a JSON string.
+     * Returns an object with success status and result/error message to match Go version behavior.
+     */
+    getLabelsJSON(): {
+        result: string;
+        error?: string;
+    };
+    /**
+     * AddContextSync adds a context sync configuration to the session parameters.
+     */
+    addContextSync(contextId: string, path: string, policy?: SyncPolicy): CreateSessionParams;
+    /**
+     * AddContextSyncConfig adds a pre-configured context sync to the session parameters.
+     */
+    addContextSyncConfig(contextSync: ContextSync): CreateSessionParams;
+    /**
+     * WithContextSync sets the context sync configurations for the session parameters.
+     */
+    withContextSync(contextSyncs: ContextSync[]): CreateSessionParams;
+    /**
+     * Convert to plain object for JSON serialization
+     */
+    toJSON(): CreateSessionParamsConfig;
+    /**
+     * Create from plain object
+     */
+    static fromJSON(config: CreateSessionParamsConfig): CreateSessionParams;
+}
+/**
+ * NewCreateSessionParams creates a new CreateSessionParams with default values.
+ */
+declare function newCreateSessionParams(): CreateSessionParams;
+
 /**
  * Utility functions for logging in a clean format
  */
@@ -2630,4 +2735,4 @@ declare function log(message: string, ...args: any[]): void;
  */
 declare function logError(message: string, error?: any): void;
 
-export { APIError, AgentBay, AgentBayError, Application, ApplicationError, ApplyMqttTokenRequest, ApplyMqttTokenResponse, ApplyMqttTokenResponseBody, ApplyMqttTokenResponseBodyData, AuthenticationError, CallMcpToolRequest, CallMcpToolResponse, CallMcpToolResponseBody, Client, Command, CommandError, Context, ContextService, CreateMcpSessionRequest, CreateMcpSessionRequestPersistenceDataList, CreateMcpSessionResponse, CreateMcpSessionResponseBody, CreateMcpSessionResponseBodyData, CreateMcpSessionShrinkRequest, DeleteContextRequest, DeleteContextResponse, DeleteContextResponseBody, type DirectoryEntry, FileError, type FileInfo, FileSystem, GetContextInfoRequest, GetContextInfoResponse, GetContextInfoResponseBody, GetContextInfoResponseBodyData, GetContextRequest, GetContextResponse, GetContextResponseBody, GetContextResponseBodyData, GetLabelRequest, GetLabelResponse, GetLabelResponseBody, GetLabelResponseBodyData, GetLinkRequest, GetLinkResponse, GetLinkResponseBody, GetLinkResponseBodyData, GetMcpResourceRequest, GetMcpResourceResponse, GetMcpResourceResponseBody, GetMcpResourceResponseBodyData, GetMcpResourceResponseBodyDataDesktopInfo, type InstalledApp, KeyCode, ListContextsRequest, ListContextsResponse, ListContextsResponseBody, ListContextsResponseBodyData, ListMcpToolsRequest, ListMcpToolsResponse, ListMcpToolsResponseBody, type ListSessionParams, ListSessionRequest, ListSessionResponse, ListSessionResponseBody, ListSessionResponseBodyData, ModifyContextRequest, ModifyContextResponse, ModifyContextResponseBody, Oss, OssError, type Process, ReleaseMcpSessionRequest, ReleaseMcpSessionResponse, ReleaseMcpSessionResponseBody, Session, SessionError, SetLabelRequest, SetLabelResponse, SetLabelResponseBody, SyncContextRequest, SyncContextResponse, SyncContextResponseBody, UI, type UIElement, UIError, log, logError };
+export { APIError, AgentBay, AgentBayError, Application, ApplicationError, ApplyMqttTokenRequest, ApplyMqttTokenResponse, ApplyMqttTokenResponseBody, ApplyMqttTokenResponseBodyData, AuthenticationError, type BWList, CallMcpToolRequest, CallMcpToolResponse, CallMcpToolResponseBody, Client, Command, CommandError, Context, type ContextInfoResult, ContextManager, ContextService, type ContextStatusData, type ContextStatusItem, ContextSync, type ContextSyncResult, CreateMcpSessionRequest, CreateMcpSessionRequestPersistenceDataList, CreateMcpSessionResponse, CreateMcpSessionResponseBody, CreateMcpSessionResponseBodyData, CreateMcpSessionShrinkRequest, type CreateSessionParams$1 as CreateSessionParams, type CreateSessionParamsConfig, DeleteContextRequest, DeleteContextResponse, DeleteContextResponseBody, type DeletePolicy, type DirectoryEntry, type DownloadPolicy, DownloadStrategy, FileError, type FileInfo, FileSystem, GetContextInfoRequest, GetContextInfoResponse, GetContextInfoResponseBody, GetContextInfoResponseBodyData, GetContextRequest, GetContextResponse, GetContextResponseBody, GetContextResponseBodyData, GetLabelRequest, GetLabelResponse, GetLabelResponseBody, GetLabelResponseBodyData, GetLinkRequest, GetLinkResponse, GetLinkResponseBody, GetLinkResponseBodyData, GetMcpResourceRequest, GetMcpResourceResponse, GetMcpResourceResponseBody, GetMcpResourceResponseBodyData, GetMcpResourceResponseBodyDataDesktopInfo, type InstalledApp, KeyCode, ListContextsRequest, ListContextsResponse, ListContextsResponseBody, ListContextsResponseBodyData, ListMcpToolsRequest, ListMcpToolsResponse, ListMcpToolsResponseBody, type ListSessionParams, ListSessionRequest, ListSessionResponse, ListSessionResponseBody, ListSessionResponseBodyData, ModifyContextRequest, ModifyContextResponse, ModifyContextResponseBody, Oss, OssError, type Process, ReleaseMcpSessionRequest, ReleaseMcpSessionResponse, ReleaseMcpSessionResponseBody, Session, SessionError, type SessionInterface, SetLabelRequest, SetLabelResponse, SetLabelResponseBody, SyncContextRequest, SyncContextResponse, SyncContextResponseBody, type SyncPolicy, UI, type UIElement, UIError, type UploadPolicy, UploadStrategy, type WhiteList, log, logError, newContextManager, newContextSync, newCreateSessionParams, newDeletePolicy, newDownloadPolicy, newSyncPolicy, newUploadPolicy };