@autobe/rpc 0.8.0 → 0.9.1

package/lib/AutoBeRpcService.d.ts

@@ -1,20 +1,84 @@
 import { AutoBeAgent } from "@autobe/agent";
-import { AutoBeHistory, AutoBeUserMessageContent, IAutoBeRpcListener, IAutoBeRpcService, IAutoBeTokenUsageJson } from "@autobe/interface";
+import { AutoBeHistory, AutoBeUserMessageContent, IAutoBeGetFilesOptions, IAutoBeRpcListener, IAutoBeRpcService, IAutoBeTokenUsageJson } from "@autobe/interface";
 import { ILlmSchema } from "@samchon/openapi";
+/**
+ * WebSocket RPC service implementation that wraps AutoBeAgent for remote
+ * access.
+ *
+ * This class serves as the WebSocket RPC Provider in TGrid's paradigm, exposing
+ * AutoBeAgent functionality to remote client applications through type-safe
+ * WebSocket connections. It implements the {@link IAutoBeRpcService} interface
+ * to provide standardized remote procedure call access to the vibe coding
+ * pipeline.
+ *
+ * The service automatically bridges all agent events to the client's event
+ * listener, ensuring that remote clients receive real-time progress
+ * notifications throughout the development process. This enables responsive
+ * user interfaces that can display progress, handle artifacts, and provide
+ * feedback during the automated development workflow.
+ *
+ * By wrapping the AutoBeAgent, this service transforms local agent capabilities
+ * into a distributed system component that supports multiple concurrent client
+ * connections while maintaining the full functionality and event transparency
+ * of the underlying vibe coding system.
+ *
+ * @author Samchon
+ */
 export declare class AutoBeRpcService<Model extends ILlmSchema.Model> implements IAutoBeRpcService {
     private readonly props;
+    /**
+     * Initializes the RPC service with an AutoBeAgent and client event listener.
+     *
+     * Creates the service wrapper around the provided AutoBeAgent and establishes
+     * automatic event forwarding to the client's listener. All agent events are
+     * automatically registered and forwarded to ensure the remote client receives
+     * comprehensive real-time updates about conversation flow, development
+     * progress, and completion events.
+     *
+     * The event bridging is established during construction and remains active
+     * throughout the service lifetime, providing seamless integration between the
+     * local agent's event system and the remote client's notification handlers.
+     *
+     * @param props Configuration containing the agent instance and client
+     *   listener
+     */
     constructor(props: AgenticaRpcService.IProps<Model>);
     conversate(content: string | AutoBeUserMessageContent | AutoBeUserMessageContent[]): Promise<AutoBeHistory[]>;
-    getFiles(): Promise<Record<string, string>>;
+    getFiles(options?: Partial<IAutoBeGetFilesOptions>): Promise<Record<string, string>>;
     getHistories(): Promise<AutoBeHistory[]>;
     getTokenUsage(): Promise<IAutoBeTokenUsageJson>;
 }
 export declare namespace AgenticaRpcService {
-    /** Properties of the {@link AgenticaRpcService}. */
+    /**
+     * Configuration properties for initializing the AutoBeRpcService.
+     *
+     * Defines the required components for creating a WebSocket RPC service that
+     * exposes AutoBeAgent functionality to remote clients. The configuration
+     * establishes both the underlying agent capabilities and the event forwarding
+     * mechanism necessary for real-time client notifications.
+     *
+     * @author Samchon
+     */
     interface IProps<Model extends ILlmSchema.Model> {
-        /** Target agent to provide as RPC service. */
+        /**
+         * AutoBeAgent instance to expose through the RPC service.
+         *
+         * The core agent that provides vibe coding capabilities including
+         * conversation processing, development pipeline orchestration, and artifact
+         * generation. This agent's functionality becomes available to remote
+         * clients through the RPC service interface while maintaining full feature
+         * compatibility.
+         */
         agent: AutoBeAgent<Model>;
-        /** Listener to be binded on the agent. */
+        /**
+         * Client event listener for receiving agent events.
+         *
+         * The remote client's event listener implementation that will receive all
+         * agent events including conversation flow, development progress, and
+         * completion notifications. The service automatically forwards all agent
+         * events to this listener to ensure comprehensive real-time visibility for
+         * the remote client.
+         */
         listener: IAutoBeRpcListener;
     }
 }

package/lib/AutoBeRpcService.js

@@ -14,15 +14,54 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AutoBeRpcService = void 0;
 const typia_1 = __importDefault(require("typia"));
+/**
+ * WebSocket RPC service implementation that wraps AutoBeAgent for remote
+ * access.
+ *
+ * This class serves as the WebSocket RPC Provider in TGrid's paradigm, exposing
+ * AutoBeAgent functionality to remote client applications through type-safe
+ * WebSocket connections. It implements the {@link IAutoBeRpcService} interface
+ * to provide standardized remote procedure call access to the vibe coding
+ * pipeline.
+ *
+ * The service automatically bridges all agent events to the client's event
+ * listener, ensuring that remote clients receive real-time progress
+ * notifications throughout the development process. This enables responsive
+ * user interfaces that can display progress, handle artifacts, and provide
+ * feedback during the automated development workflow.
+ *
+ * By wrapping the AutoBeAgent, this service transforms local agent capabilities
+ * into a distributed system component that supports multiple concurrent client
+ * connections while maintaining the full functionality and event transparency
+ * of the underlying vibe coding system.
+ *
+ * @author Samchon
+ */
 class AutoBeRpcService {
+    /**
+     * Initializes the RPC service with an AutoBeAgent and client event listener.
+     *
+     * Creates the service wrapper around the provided AutoBeAgent and establishes
+     * automatic event forwarding to the client's listener. All agent events are
+     * automatically registered and forwarded to ensure the remote client receives
+     * comprehensive real-time updates about conversation flow, development
+     * progress, and completion events.
+     *
+     * The event bridging is established during construction and remains active
+     * throughout the service lifetime, providing seamless integration between the
+     * local agent's event system and the remote client's notification handlers.
+     *
+     * @param props Configuration containing the agent instance and client
+     *   listener
+     */
     constructor(props) {
         this.props = props;
         const { agent, listener } = this.props;
         for (const key of [
-            "analyzeReview",
             "analyzeComplete",
+            "analyzeReview",
             "analyzeStart",
-            "analyzeWriteDocument",
+            "analyzeWrite",
             "assistantMessage",
             "interfaceComplement",
             "interfaceComplete",
@@ -41,12 +80,12 @@ class AutoBeRpcService {
             "realizeStart",
             "realizeValidate",
             "testComplete",
+            "userMessage",
             "testCorrect",
-            "testProgress",
             "testScenario",
             "testStart",
             "testValidate",
-            "userMessage"
+            "testWrite"
         ])
             agent.on(key, (event) => {
                 listener[key](event).catch(() => { });
@@ -55,9 +94,9 @@ class AutoBeRpcService {
     conversate(content) {
         return this.props.agent.conversate(content);
     }
-    getFiles() {
+    getFiles(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.props.agent.getFiles();
+            return this.props.agent.getFiles(options);
         });
     }
     getHistories() {

package/lib/AutoBeRpcService.js.map

@@ -1 +1 @@
-{"version":3,"file":"AutoBeRpcService.js","sourceRoot":"","sources":["../src/AutoBeRpcService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AASA,kDAA0B;AAE1B,MAAa,gBAAgB;IAG3B,YAAoC,KAAuC;QAAvC,UAAK,GAAL,KAAK,CAAkC;QACzE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACvC,KAAK,MAAM,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YACZ,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE;gBACtB,QAAQ,CAAC,GAAG,CAAE,CAAC,KAAY,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,UAAU,CACf,OAAuE;QAEvE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;IAEY,QAAQ;;YACnB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,CAAC;KAAA;IAEY,YAAY;;YACvB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;QACzC,CAAC;KAAA;IAEY,aAAa;;YACxB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC,MAAM,EAAE,CAAC;QACnD,CAAC;KAAA;CACF;AA5BD,4CA4BC"}
+{"version":3,"file":"AutoBeRpcService.js","sourceRoot":"","sources":["../src/AutoBeRpcService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAUA,kDAA0B;AAE1B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,gBAAgB;IAG3B;;;;;;;;;;;;;;;OAeG;IACH,YAAoC,KAAuC;QAAvC,UAAK,GAAL,KAAK,CAAkC;QACzE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACvC,KAAK,MAAM,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YACZ,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE;gBACtB,QAAQ,CAAC,GAAG,CAAE,CAAC,KAAY,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,UAAU,CACf,OAAuE;QAEvE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;IAEY,QAAQ,CACnB,OAAyC;;YAEzC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC5C,CAAC;KAAA;IAEY,YAAY;;YACvB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;QACzC,CAAC;KAAA;IAEY,aAAa;;YACxB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC,MAAM,EAAE,CAAC;QACnD,CAAC;KAAA;CACF;AA9CD,4CA8CC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autobe/rpc",
-  "version": "0.8.0",
+  "version": "0.9.1",
   "description": "AI backend server code generator",
   "main": "lib/index.js",
   "keywords": [],
@@ -26,8 +26,8 @@
   "dependencies": {
     "@samchon/openapi": "^4.3.3",
     "typia": "^9.3.1",
-    "@autobe/agent": "^0.8.0",
-    "@autobe/interface": "^0.8.0"
+    "@autobe/agent": "^0.9.1",
+    "@autobe/interface": "^0.9.1"
   },
   "devDependencies": {
     "rimraf": "^6.0.1",

package/src/AutoBeRpcService.ts

@@ -2,6 +2,7 @@ import { AutoBeAgent } from "@autobe/agent";
 import {
   AutoBeHistory,
   AutoBeUserMessageContent,
+  IAutoBeGetFilesOptions,
   IAutoBeRpcListener,
   IAutoBeRpcService,
   IAutoBeTokenUsageJson,
@@ -9,9 +10,48 @@ import {
 import { ILlmSchema } from "@samchon/openapi";
 import typia from "typia";
 
+/**
+ * WebSocket RPC service implementation that wraps AutoBeAgent for remote
+ * access.
+ *
+ * This class serves as the WebSocket RPC Provider in TGrid's paradigm, exposing
+ * AutoBeAgent functionality to remote client applications through type-safe
+ * WebSocket connections. It implements the {@link IAutoBeRpcService} interface
+ * to provide standardized remote procedure call access to the vibe coding
+ * pipeline.
+ *
+ * The service automatically bridges all agent events to the client's event
+ * listener, ensuring that remote clients receive real-time progress
+ * notifications throughout the development process. This enables responsive
+ * user interfaces that can display progress, handle artifacts, and provide
+ * feedback during the automated development workflow.
+ *
+ * By wrapping the AutoBeAgent, this service transforms local agent capabilities
+ * into a distributed system component that supports multiple concurrent client
+ * connections while maintaining the full functionality and event transparency
+ * of the underlying vibe coding system.
+ *
+ * @author Samchon
+ */
 export class AutoBeRpcService<Model extends ILlmSchema.Model>
   implements IAutoBeRpcService
 {
+  /**
+   * Initializes the RPC service with an AutoBeAgent and client event listener.
+   *
+   * Creates the service wrapper around the provided AutoBeAgent and establishes
+   * automatic event forwarding to the client's listener. All agent events are
+   * automatically registered and forwarded to ensure the remote client receives
+   * comprehensive real-time updates about conversation flow, development
+   * progress, and completion events.
+   *
+   * The event bridging is established during construction and remains active
+   * throughout the service lifetime, providing seamless integration between the
+   * local agent's event system and the remote client's notification handlers.
+   *
+   * @param props Configuration containing the agent instance and client
+   *   listener
+   */
   public constructor(private readonly props: AgenticaRpcService.IProps<Model>) {
     const { agent, listener } = this.props;
     for (const key of typia.misc.literals<keyof IAutoBeRpcListener>())
@@ -26,8 +66,10 @@ export class AutoBeRpcService<Model extends ILlmSchema.Model>
     return this.props.agent.conversate(content);
   }
 
-  public async getFiles(): Promise<Record<string, string>> {
-    return this.props.agent.getFiles();
+  public async getFiles(
+    options?: Partial<IAutoBeGetFilesOptions>,
+  ): Promise<Record<string, string>> {
+    return this.props.agent.getFiles(options);
   }
 
   public async getHistories(): Promise<AutoBeHistory[]> {
@@ -38,13 +80,39 @@ export class AutoBeRpcService<Model extends ILlmSchema.Model>
     return this.props.agent.getTokenUsage().toJSON();
   }
 }
+
 export namespace AgenticaRpcService {
-  /** Properties of the {@link AgenticaRpcService}. */
+  /**
+   * Configuration properties for initializing the AutoBeRpcService.
+   *
+   * Defines the required components for creating a WebSocket RPC service that
+   * exposes AutoBeAgent functionality to remote clients. The configuration
+   * establishes both the underlying agent capabilities and the event forwarding
+   * mechanism necessary for real-time client notifications.
+   *
+   * @author Samchon
+   */
   export interface IProps<Model extends ILlmSchema.Model> {
-    /** Target agent to provide as RPC service. */
+    /**
+     * AutoBeAgent instance to expose through the RPC service.
+     *
+     * The core agent that provides vibe coding capabilities including
+     * conversation processing, development pipeline orchestration, and artifact
+     * generation. This agent's functionality becomes available to remote
+     * clients through the RPC service interface while maintaining full feature
+     * compatibility.
+     */
     agent: AutoBeAgent<Model>;
 
-    /** Listener to be binded on the agent. */
+    /**
+     * Client event listener for receiving agent events.
+     *
+     * The remote client's event listener implementation that will receive all
+     * agent events including conversation flow, development progress, and
+     * completion notifications. The service automatically forwards all agent
+     * events to this listener to ensure comprehensive real-time visibility for
+     * the remote client.
+     */
     listener: IAutoBeRpcListener;
   }
 }