@promptbook/remote-client 0.11.0 → 0.13.0

package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Error.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Socket.io error for remote text generation
+ *
+ * This is sent from server to client when error occurs and stops the process
+ */
 export interface Ptps_Error {
+    /**
+     * The error message which caused the error
+     */
     readonly errorMessage: string;
 }

package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Progress.d.ts

@@ -1,4 +1,12 @@
 import { TaskProgress } from '../../../../../types/TaskProgress';
+/**
+ * Socket.io progress for remote text generation
+ *
+ * This is sent from server to client arbitrarily and may be sent multiple times
+ */
 export interface Ptps_Progress {
+    /**
+     * The progress of text generation
+     */
     readonly taskProgress: TaskProgress;
 }

package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Request.d.ts

@@ -1,6 +1,17 @@
 import { uuid } from '../../../../.././types/typeAliases';
 import { Prompt } from '../../../../../types/Prompt';
+/**
+ * Socket.io progress for remote text generation
+ *
+ * This is a request from client to server
+ */
 export interface Ptps_Request {
+    /**
+     * Client responsible for the requests
+     */
     readonly clientId: uuid;
+    /**
+     * The Prompt to execute
+     */
     readonly prompt: Prompt;
 }

package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Response.d.ts

@@ -1,4 +1,12 @@
 import { PromptResult } from '../../../../../execution/PromptResult';
+/**
+ * Socket.io error for remote text generation
+ *
+ * This is sent from server to client when the generated text is completed
+ */
 export interface Ptps_Response {
+    /**
+     * The result of the prompt
+     */
     promptResult: PromptResult;
 }

package/esm/typings/execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions.d.ts

@@ -1,5 +1,5 @@
 import { PromptTemplatePipelineLibrary } from '../../../../../classes/PromptTemplatePipelineLibrary';
-import { uuid } from '../../../../../types/typeAliases';
+import { string_uri, uuid } from '../../../../../types/typeAliases';
 import { CommonExecutionToolsOptions } from '../../../../CommonExecutionToolsOptions';
 import { NaturalExecutionTools } from '../../../../NaturalExecutionTools';
 export interface RemoteServerOptions extends CommonExecutionToolsOptions {
@@ -7,6 +7,13 @@ export interface RemoteServerOptions extends CommonExecutionToolsOptions {
      * Port on which the server will listen
      */
     readonly port: number;
+    /**
+     * Path for the Socket.io server to listen
+     *
+     * @default '/socket.io'
+     * @example '/promptbook/socket.io'
+     */
+    readonly path: string_uri;
     /**
      * Prompt template pipeline library to use
      *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-client",
-    "version": "0.11.0",
+    "version": "0.13.0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -37,7 +37,7 @@
         "socket.io-client": "4.7.2"
     },
     "peerDependencies": {
-        "@promptbook/core": "0.11.0"
+        "@promptbook/core": "0.13.0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Error.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Socket.io error for remote text generation
+ *
+ * This is sent from server to client when error occurs and stops the process
+ */
 export interface Ptps_Error {
+    /**
+     * The error message which caused the error
+     */
     readonly errorMessage: string;
 }

package/umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Progress.d.ts

@@ -1,4 +1,12 @@
 import { TaskProgress } from '../../../../../types/TaskProgress';
+/**
+ * Socket.io progress for remote text generation
+ *
+ * This is sent from server to client arbitrarily and may be sent multiple times
+ */
 export interface Ptps_Progress {
+    /**
+     * The progress of text generation
+     */
     readonly taskProgress: TaskProgress;
 }

package/umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Request.d.ts

@@ -1,6 +1,17 @@
 import { uuid } from '../../../../.././types/typeAliases';
 import { Prompt } from '../../../../../types/Prompt';
+/**
+ * Socket.io progress for remote text generation
+ *
+ * This is a request from client to server
+ */
 export interface Ptps_Request {
+    /**
+     * Client responsible for the requests
+     */
     readonly clientId: uuid;
+    /**
+     * The Prompt to execute
+     */
     readonly prompt: Prompt;
 }

package/umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/Ptps_Response.d.ts

@@ -1,4 +1,12 @@
 import { PromptResult } from '../../../../../execution/PromptResult';
+/**
+ * Socket.io error for remote text generation
+ *
+ * This is sent from server to client when the generated text is completed
+ */
 export interface Ptps_Response {
+    /**
+     * The result of the prompt
+     */
     promptResult: PromptResult;
 }

package/umd/typings/execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions.d.ts

@@ -1,5 +1,5 @@
 import { PromptTemplatePipelineLibrary } from '../../../../../classes/PromptTemplatePipelineLibrary';
-import { uuid } from '../../../../../types/typeAliases';
+import { string_uri, uuid } from '../../../../../types/typeAliases';
 import { CommonExecutionToolsOptions } from '../../../../CommonExecutionToolsOptions';
 import { NaturalExecutionTools } from '../../../../NaturalExecutionTools';
 export interface RemoteServerOptions extends CommonExecutionToolsOptions {
@@ -7,6 +7,13 @@ export interface RemoteServerOptions extends CommonExecutionToolsOptions {
      * Port on which the server will listen
      */
     readonly port: number;
+    /**
+     * Path for the Socket.io server to listen
+     *
+     * @default '/socket.io'
+     * @example '/promptbook/socket.io'
+     */
+    readonly path: string_uri;
     /**
      * Prompt template pipeline library to use
      *