@promptbook/utils 0.41.3 → 0.41.101

package/esm/typings/execution/PromptbookExecutor.d.ts

@@ -1,39 +1,39 @@
-import type { Promisable } from 'type-fest';
-import type { TaskProgress } from '../types/TaskProgress';
-import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
-import type { string_name } from '../types/typeAliases';
-/**
- * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
- * Executor is made by combining execution tools and promptbook library.
- *
- * It can be done in two ways:
- * -   From `PromptbookLibrary.getExecutor` method
- * -   `createPromptbookExecutor` utility function
- *
- * @see https://github.com/webgptorg/promptbook#executor
- */
-export type PromptbookExecutor = {
-    (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
-        /**
-         * Whether the execution was successful
-         */
-        isSuccessful: boolean;
-        /**
-         * Errors that occured during the execution
-         */
-        errors: Array<Error>;
-        /**
-         * The report of the execution
-         */
-        executionReport: ExecutionReportJson;
-        /**
-         * Result parameters of the execution
-         *
-         * Note: If the execution was not successful, there are only some of the result parameters
-         */
-        outputParameters: Record<string_name, string>;
-    }>;
-};
-/**
- * TODO: [🧠] Should this file be in /execution or /types folder?
- */
+import type { Promisable } from 'type-fest';
+import type { TaskProgress } from '../types/TaskProgress';
+import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
+import type { string_name } from '../types/typeAliases';
+/**
+ * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
+ * Executor is made by combining execution tools and promptbook library.
+ *
+ * It can be done in two ways:
+ * -   From `PromptbookLibrary.getExecutor` method
+ * -   `createPromptbookExecutor` utility function
+ *
+ * @see https://github.com/webgptorg/promptbook#executor
+ */
+export type PromptbookExecutor = {
+    (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
+        /**
+         * Whether the execution was successful
+         */
+        isSuccessful: boolean;
+        /**
+         * Errors that occured during the execution
+         */
+        errors: Array<Error>;
+        /**
+         * The report of the execution
+         */
+        executionReport: ExecutionReportJson;
+        /**
+         * Result parameters of the execution
+         *
+         * Note: If the execution was not successful, there are only some of the result parameters
+         */
+        outputParameters: Record<string_name, string>;
+    }>;
+};
+/**
+ * TODO: [🧠] Should this file be in /execution or /types folder?
+ */

package/esm/typings/execution/ScriptExecutionTools.d.ts

@@ -1,37 +1,37 @@
-import { string_name, string_script } from '.././types/typeAliases';
-import { ScriptLanguage } from '../types/ScriptLanguage';
-/**
- * Represents all the tools needed to EXECUTE SCRIPTs
- *
- * @see https://github.com/webgptorg/promptbook#script-execution-tools
- */
-export type ScriptExecutionTools = {
-    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-};
-/**
- * Input for the script execution
- */
-export type ScriptExecutionToolsExecuteOptions = {
-    /**
-     * Language of the script
-     */
-    scriptLanguage: ScriptLanguage;
-    /**
-     * Parameters for the script
-     * Theese parameters are passed to the script as variables
-     * For example: { "name": "John" } => const name = "John";
-     */
-    parameters: Record<string_name, string>;
-    /**
-     * The content of the script to execute
-     * - It can be a single statement
-     * - It can be multiple statements separated by semicolon and return
-     * - It can be a function (but you need to call it)
-     * - It can be IIFE (immediately invoked function expression)
-     * - It can use the parameters as variables and functions from global scope
-     */
-    script: string_script;
-};
-/**
- * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
- */
+import { string_name, string_script } from '.././types/typeAliases';
+import { ScriptLanguage } from '../types/ScriptLanguage';
+/**
+ * Represents all the tools needed to EXECUTE SCRIPTs
+ *
+ * @see https://github.com/webgptorg/promptbook#script-execution-tools
+ */
+export type ScriptExecutionTools = {
+    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
+};
+/**
+ * Input for the script execution
+ */
+export type ScriptExecutionToolsExecuteOptions = {
+    /**
+     * Language of the script
+     */
+    scriptLanguage: ScriptLanguage;
+    /**
+     * Parameters for the script
+     * Theese parameters are passed to the script as variables
+     * For example: { "name": "John" } => const name = "John";
+     */
+    parameters: Record<string_name, string>;
+    /**
+     * The content of the script to execute
+     * - It can be a single statement
+     * - It can be multiple statements separated by semicolon and return
+     * - It can be a function (but you need to call it)
+     * - It can be IIFE (immediately invoked function expression)
+     * - It can use the parameters as variables and functions from global scope
+     */
+    script: string_script;
+};
+/**
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ */

package/esm/typings/execution/UserInterfaceTools.d.ts

@@ -1,45 +1,45 @@
-import { number_integer, number_positive } from '../types/typeAliases';
-/**
- * Represents all the tools needed to interact with the user.
- *
- * @see https://github.com/webgptorg/promptbook#user-interface-tools
- */
-export type UserInterfaceTools = {
-    /**
-     * Asks the user to answer a free-text (multi-line) question
-     *
-     * @param options the question to ask
-     * @returns the answer from the user
-     */
-    promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
-};
-export type UserInterfaceToolsPromptDialogOptions = {
-    /**
-     * Prompt title
-     *
-     * Note: This is not a prompt to language model but a prompt to the user
-     * @example "Your name"
-     */
-    promptTitle: string;
-    /**
-     * Prompt message
-     *
-     * Note: This is not a prompt to language model but a prompt to the user
-     * @example "Please enter your name, including your last name, title, etc."
-     */
-    promptMessage: string;
-    /**
-     * Default value for the input/textarea
-     */
-    defaultValue: string | null;
-    /**
-     * Placeholder for the input/textarea
-     */
-    placeholder?: string;
-    /**
-     * Priority of the prompt
-     *
-     * Note: This would be reflected for example into the UI z-index of the prompt modal
-     */
-    priority: number_integer & number_positive;
-};
+import { number_integer, number_positive } from '../types/typeAliases';
+/**
+ * Represents all the tools needed to interact with the user.
+ *
+ * @see https://github.com/webgptorg/promptbook#user-interface-tools
+ */
+export type UserInterfaceTools = {
+    /**
+     * Asks the user to answer a free-text (multi-line) question
+     *
+     * @param options the question to ask
+     * @returns the answer from the user
+     */
+    promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
+};
+export type UserInterfaceToolsPromptDialogOptions = {
+    /**
+     * Prompt title
+     *
+     * Note: This is not a prompt to language model but a prompt to the user
+     * @example "Your name"
+     */
+    promptTitle: string;
+    /**
+     * Prompt message
+     *
+     * Note: This is not a prompt to language model but a prompt to the user
+     * @example "Please enter your name, including your last name, title, etc."
+     */
+    promptMessage: string;
+    /**
+     * Default value for the input/textarea
+     */
+    defaultValue: string | null;
+    /**
+     * Placeholder for the input/textarea
+     */
+    placeholder?: string;
+    /**
+     * Priority of the prompt
+     *
+     * Note: This would be reflected for example into the UI z-index of the prompt modal
+     */
+    priority: number_integer & number_positive;
+};

package/esm/typings/execution/assertsExecutionSuccessful.d.ts

@@ -1,11 +1,11 @@
-import type { PromptbookExecutor } from './PromptbookExecutor';
-/**
- * Asserts that the execution of a promptnook is successful
- *
- * @param executionResult - The partial result of the promptnook execution
- * @throws Error - If the execution is not successful or if multiple errors occurred
- */
-export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PromptbookExecutor>>, 'isSuccessful' | 'errors'>): void;
-/**
- * TODO: [🧠] Can this return type be better typed than void
- */
+import type { PromptbookExecutor } from './PromptbookExecutor';
+/**
+ * Asserts that the execution of a promptnook is successful
+ *
+ * @param executionResult - The partial result of the promptnook execution
+ * @throws Error - If the execution is not successful or if multiple errors occurred
+ */
+export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PromptbookExecutor>>, 'isSuccessful' | 'errors'>): void;
+/**
+ * TODO: [🧠] Can this return type be better typed than void
+ */

package/esm/typings/execution/createPromptbookExecutor.d.ts

@@ -1,41 +1,41 @@
-import { PromptbookJson } from '../_packages/types.index';
-import { ExecutionTools } from './ExecutionTools';
-import { PromptbookExecutor } from './PromptbookExecutor';
-type CreatePromptbookExecutorSettings = {
-    /**
-     * When executor does not satisfy expectations it will be retried this amount of times
-     *
-     * @default 3
-     */
-    readonly maxExecutionAttempts: number;
-};
-/**
- * Options for creating a promptbook executor
- */
-interface CreatePromptbookExecutorOptions {
-    /**
-     * The promptbook to be executed
-     */
-    readonly promptbook: PromptbookJson;
-    /**
-     * The execution tools to be used during the execution of the PROMPTBOOK
-     */
-    readonly tools: ExecutionTools;
-    /**
-     * Optional settings for the PROMPTBOOK executor
-     */
-    readonly settings?: Partial<CreatePromptbookExecutorSettings>;
-}
-/**
- * Creates executor function from promptbook and execution tools.
- *
- * Note: Consider using getExecutor method of the library instead of using this function
- */
-export declare function createPromptbookExecutor(options: CreatePromptbookExecutorOptions): PromptbookExecutor;
-export {};
-/**
- * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
- * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
- * Note: CreatePromptbookExecutorOptions are just connected to PromptbookExecutor so do not extract to types folder
- * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
- */
+import { PromptbookJson } from '../_packages/types.index';
+import { ExecutionTools } from './ExecutionTools';
+import { PromptbookExecutor } from './PromptbookExecutor';
+type CreatePromptbookExecutorSettings = {
+    /**
+     * When executor does not satisfy expectations it will be retried this amount of times
+     *
+     * @default 3
+     */
+    readonly maxExecutionAttempts: number;
+};
+/**
+ * Options for creating a promptbook executor
+ */
+interface CreatePromptbookExecutorOptions {
+    /**
+     * The promptbook to be executed
+     */
+    readonly promptbook: PromptbookJson;
+    /**
+     * The execution tools to be used during the execution of the PROMPTBOOK
+     */
+    readonly tools: ExecutionTools;
+    /**
+     * Optional settings for the PROMPTBOOK executor
+     */
+    readonly settings?: Partial<CreatePromptbookExecutorSettings>;
+}
+/**
+ * Creates executor function from promptbook and execution tools.
+ *
+ * Note: Consider using getExecutor method of the library instead of using this function
+ */
+export declare function createPromptbookExecutor(options: CreatePromptbookExecutorOptions): PromptbookExecutor;
+export {};
+/**
+ * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
+ * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
+ * Note: CreatePromptbookExecutorOptions are just connected to PromptbookExecutor so do not extract to types folder
+ * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
+ */

package/esm/typings/execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools.d.ts

@@ -1,22 +1,22 @@
-import { Prompt } from '../../../../types/Prompt';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
-import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
-/**
- * Mocked execution Tools for just echoing the requests for testing purposes.
- */
-export declare class MockedEchoNaturalExecutionTools implements NaturalExecutionTools {
-    private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
-    /**
-     * Mocks chat model
-     */
-    gptChat(prompt: Prompt): Promise<PromptChatResult>;
-    /**
-     * Mocks completion model
-     */
-    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
-}
-/**
- * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}
- */
+import { Prompt } from '../../../../types/Prompt';
+import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+/**
+ * Mocked execution Tools for just echoing the requests for testing purposes.
+ */
+export declare class MockedEchoNaturalExecutionTools implements NaturalExecutionTools {
+    private readonly options;
+    constructor(options: CommonExecutionToolsOptions);
+    /**
+     * Mocks chat model
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Mocks completion model
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+}
+/**
+ * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}
+ */

package/esm/typings/execution/plugins/natural-execution-tools/mocked/joker.test.d.ts

@@ -1,4 +1,4 @@
-export {};
-/**
- * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPromptbookExecutor.test.ts"
- */
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPromptbookExecutor.test.ts"
+ */

package/esm/typings/execution/plugins/natural-execution-tools/mocked/mocked-chat.test.d.ts

@@ -1,4 +1,4 @@
-export {};
-/**
- * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPromptbookExecutor.test.ts"
- */
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPromptbookExecutor.test.ts"
+ */

package/esm/typings/execution/plugins/natural-execution-tools/mocked/mocked-completion.test.d.ts

@@ -1,4 +1,4 @@
-export {};
-/**
- * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPromptbookExecutor.test.ts"
- */
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPromptbookExecutor.test.ts"
+ */

package/esm/typings/execution/plugins/natural-execution-tools/openai/OpenAiExecutionTools.d.ts

@@ -1,28 +1,28 @@
-import type { Prompt } from '../../../../types/Prompt';
-import type { NaturalExecutionTools } from '../../../NaturalExecutionTools';
-import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
-import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
-/**
- * Execution Tools for calling OpenAI API.
- */
-export declare class OpenAiExecutionTools implements NaturalExecutionTools {
-    private readonly options;
-    /**
-     * OpenAI API client.
-     */
-    private readonly openai;
-    constructor(options: OpenAiExecutionToolsOptions);
-    /**
-     * Calls OpenAI API to use a chat model.
-     */
-    gptChat(prompt: Prompt): Promise<PromptChatResult>;
-    /**
-     * Calls OpenAI API to use a complete model.
-     */
-    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
-}
-/**
-
- * TODO: Maybe Create some common util for gptChat and gptComplete
- * TODO: Maybe make custom OpenaiError
- */
+import type { Prompt } from '../../../../types/Prompt';
+import type { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
+/**
+ * Execution Tools for calling OpenAI API.
+ */
+export declare class OpenAiExecutionTools implements NaturalExecutionTools {
+    private readonly options;
+    /**
+     * OpenAI API client.
+     */
+    private readonly openai;
+    constructor(options: OpenAiExecutionToolsOptions);
+    /**
+     * Calls OpenAI API to use a chat model.
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Calls OpenAI API to use a complete model.
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+}
+/**
+
+ * TODO: Maybe Create some common util for gptChat and gptComplete
+ * TODO: Maybe make custom OpenaiError
+ */

package/esm/typings/execution/plugins/natural-execution-tools/openai/OpenAiExecutionToolsOptions.d.ts

@@ -1,16 +1,16 @@
-import { string_token } from '../../../.././types/typeAliases';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-/**
- * Options for OpenAiExecutionTools
- */
-export type OpenAiExecutionToolsOptions = CommonExecutionToolsOptions & {
-    /**
-     * OpenAI API key
-     */
-    openAiApiKey: string_token;
-    /**
-     * A unique identifier representing your end-user, which can help OpenAI to monitor
-     * and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
-     */
-    user?: string_token;
-};
+import { string_token } from '../../../.././types/typeAliases';
+import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+/**
+ * Options for OpenAiExecutionTools
+ */
+export type OpenAiExecutionToolsOptions = CommonExecutionToolsOptions & {
+    /**
+     * OpenAI API key
+     */
+    openAiApiKey: string_token;
+    /**
+     * A unique identifier representing your end-user, which can help OpenAI to monitor
+     * and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
+     */
+    user?: string_token;
+};

package/esm/typings/execution/plugins/natural-execution-tools/openai/computeOpenaiUsage.d.ts

@@ -1,3 +1,3 @@
-import type OpenAI from 'openai';
-import type { PromptResult } from '../../../PromptResult';
-export declare function computeOpenaiUsage(rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResult['usage'];
+import type OpenAI from 'openai';
+import type { PromptResult } from '../../../PromptResult';
+export declare function computeOpenaiUsage(rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResult['usage'];

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

@@ -1,35 +1,35 @@
-import { Prompt } from '../../../../types/Prompt';
-import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
-import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
-import { RemoteNaturalExecutionToolsOptions } from './RemoteNaturalExecutionToolsOptions';
-/**
- * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
- *
- * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
- * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
- *
- * @see https://github.com/webgptorg/promptbook#remote-server
- */
-export declare class RemoteNaturalExecutionTools implements NaturalExecutionTools {
-    private readonly options;
-    constructor(options: RemoteNaturalExecutionToolsOptions);
-    /**
-     * Creates a connection to the remote proxy server.
-     */
-    private makeConnection;
-    /**
-     * Calls remote proxy server to use a chat model.
-     */
-    gptChat(prompt: Prompt): Promise<PromptChatResult>;
-    /**
-     * Calls remote proxy server to use a completion model.
-     */
-    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
-    /**
-     * Calls remote proxy server to use both completion or chat model.
-     */
-    private gptCommon;
-}
-/**
- * TODO: [🤹‍♂️] RemoteNaturalExecutionTools should extend Destroyable and implement IDestroyable
- */
+import { Prompt } from '../../../../types/Prompt';
+import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+import { RemoteNaturalExecutionToolsOptions } from './RemoteNaturalExecutionToolsOptions';
+/**
+ * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
+ *
+ * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
+ * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
+ *
+ * @see https://github.com/webgptorg/promptbook#remote-server
+ */
+export declare class RemoteNaturalExecutionTools implements NaturalExecutionTools {
+    private readonly options;
+    constructor(options: RemoteNaturalExecutionToolsOptions);
+    /**
+     * Creates a connection to the remote proxy server.
+     */
+    private makeConnection;
+    /**
+     * Calls remote proxy server to use a chat model.
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Calls remote proxy server to use a completion model.
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * Calls remote proxy server to use both completion or chat model.
+     */
+    private gptCommon;
+}
+/**
+ * TODO: [🤹‍♂️] RemoteNaturalExecutionTools should extend Destroyable and implement IDestroyable
+ */

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

@@ -1,23 +1,23 @@
-import type { client_id, string_uri } from '../../../.././types/typeAliases';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-/**
- * Options for RemoteNaturalExecutionTools
- */
-export type RemoteNaturalExecutionToolsOptions = CommonExecutionToolsOptions & {
-    /**
-     * URL of the remote PROMPTBOOK server
-     * On this server will be connected to the socket.io server
-     */
-    readonly remoteUrl: URL;
-    /**
-     * Path for the Socket.io server to listen
-     *
-     * @default '/socket.io'
-     * @example '/promptbook/socket.io'
-     */
-    readonly path: string_uri;
-    /**
-     * Your client ID
-     */
-    readonly clientId: client_id;
-};
+import type { client_id, string_uri } from '../../../.././types/typeAliases';
+import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+/**
+ * Options for RemoteNaturalExecutionTools
+ */
+export type RemoteNaturalExecutionToolsOptions = CommonExecutionToolsOptions & {
+    /**
+     * URL of the remote PROMPTBOOK server
+     * On this server will be connected to the socket.io server
+     */
+    readonly remoteUrl: URL;
+    /**
+     * Path for the Socket.io server to listen
+     *
+     * @default '/socket.io'
+     * @example '/promptbook/socket.io'
+     */
+    readonly path: string_uri;
+    /**
+     * Your client ID
+     */
+    readonly clientId: client_id;
+};