@promptbook/openai 0.82.0-0 → 0.82.0-3

package/esm/typings/src/other/templates/getBookTemplates.d.ts

@@ -1,12 +1,14 @@
+import { SetRequired } from 'type-fest';
 import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { NonEmptyReadonlyArray } from '../../types/NonEmptyArray';
 /**
  * @@@
  *
  * @singleton
  * @private internal cache of `getBookTemplate`
  */
-export declare let pipelines: Array<PipelineJson> | null;
+export declare let pipelines: Array<SetRequired<PipelineJson, 'pipelineUrl'>> | null;
 /**
  * Get template for new book
  *
@@ -14,9 +16,9 @@ export declare let pipelines: Array<PipelineJson> | null;
  * @returns list of pipelines
  * @public exported from `@promptbook/templates`
  */
-export declare function getBookTemplates(formfactorName?: string_formfactor_name): ReadonlyArray<PipelineJson>;
+export declare function getBookTemplates(formfactorName?: string_formfactor_name): NonEmptyReadonlyArray<SetRequired<PipelineJson, 'pipelineUrl'>>;
 /**
- * TODO: Unit test
+ * TODO: Unit test + test that what we guarantee - always return non-empty array is true for e
  * TODO: [🧠] Which is the best place for this function
  * TODO: !!6 For GENERIC template ensure at least one pipeline is present for typescript in `getBookTemplates`
  */

package/esm/typings/src/prepare/preparePipelineOnRemoteServer.d.ts

@@ -1,5 +1,5 @@
-import type { RemoteServerOptions } from '../remote-server/interfaces/RemoteServerOptions';
 import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOptions';
 /**
  * Prepare pipeline on remote server
  *
@@ -11,4 +11,7 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
  *
  * @public exported from `@promptbook/remote-client`
  */
-export declare function preparePipelineOnRemoteServer<TCustomOptions = undefined>(pipeline: PipelineJson, options: RemoteServerOptions<TCustomOptions>): Promise<PipelineJson>;
+export declare function preparePipelineOnRemoteServer<TCustomOptions = undefined>(pipeline: PipelineJson, options: RemoteClientOptions<TCustomOptions>): Promise<PipelineJson>;
+/**
+ * TODO: !!!! Do not return Promise<PipelineJson> But PreparePipelineTask
+ */

package/esm/typings/src/remote-server/createRemoteClient.d.ts

@@ -0,0 +1,10 @@
+import type { Socket } from 'socket.io-client';
+import type { RemoteClientOptions } from './types/RemoteClientOptions';
+/**
+ * Creates a connection to the remote proxy server.
+ *
+ * Note: This function creates a connection to the remote server and returns a socket but responsibility of closing the connection is on the caller
+ *
+ * @private internal utility function
+ */
+export declare function createRemoteClient<TCustomOptions = undefined>(options: RemoteClientOptions<TCustomOptions>): Promise<Socket>;

package/esm/typings/src/remote-server/{interfaces → socket-types/_common}/PromptbookServer_Error.d.ts

@@ -1,7 +1,7 @@
-import type { ErrorJson } from '../../errors/utils/ErrorJson';
+import type { ErrorJson } from '../../../errors/utils/ErrorJson';
 /**
- * Socket.io error for remote text generation
- *
  * This is sent from server to client when error occurs and stops the process
+ *
+ * @private internal type of remote server
  */
 export type PromptbookServer_Error = ErrorJson;

package/esm/typings/src/remote-server/socket-types/_common/PromptbookServer_Progress.d.ts

@@ -0,0 +1,10 @@
+import type { TaskProgress } from '../../../types/TaskProgress';
+/**
+ * This is sent from server to client as indication of prograss arbitrarily and may be sent multiple times
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_Progress = TaskProgress;
+/**
+ * TODO: `PromptbookServer_Progress` is unused for now, but it will be used in the future
+ */

package/esm/typings/src/remote-server/socket-types/_subtypes/PromptbookServer_Identification.d.ts

@@ -0,0 +1,49 @@
+import type { LlmToolsConfiguration } from '../../../llm-providers/_common/register/LlmToolsConfiguration';
+import type { string_user_id } from '../../../types/typeAliases';
+import type { ApplicationRemoteServerClientOptions } from '../../types/RemoteServerOptions';
+/**
+ * Identification of client for Socket.io remote server
+ *
+ * @public exported from `@promptbook/remote-server`
+ * @public exported from `@promptbook/remote-client`
+ */
+export type PromptbookServer_Identification<TCustomOptions> = PromptbookServer_ApplicationIdentification<TCustomOptions> | PromptbookServer_AnonymousIdentification;
+/**
+ * Application mode is @@@!!!
+ *
+ * @public exported from `@promptbook/remote-server`
+ * @public exported from `@promptbook/remote-client`
+ */
+export type PromptbookServer_ApplicationIdentification<TCustomOptions> = ApplicationRemoteServerClientOptions<TCustomOptions> & {
+    /**
+     * Application mode
+     */
+    readonly isAnonymous: false;
+};
+/**
+ * Anonymous mode is @@@!!!
+ *
+ * @public exported from `@promptbook/remote-server`
+ * @public exported from `@promptbook/remote-client`
+ */
+export type PromptbookServer_AnonymousIdentification = {
+    /**
+     * Anonymous mode
+     */
+    readonly isAnonymous: true;
+    /**
+     * Identifier of the end user
+     *
+     * Note: this is passed to the certain model providers to identify misuse
+     * Note: In anonymous mode, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode)
+     */
+    readonly userId?: string_user_id;
+    /**
+     * Configuration for the LLM tools
+     */
+    readonly llmToolsConfiguration: LlmToolsConfiguration;
+};
+/**
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt - Pass `userId` in `PromptbookServer_ListModels_Request`
+ */

package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts

@@ -0,0 +1,17 @@
+import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+/**
+ * List models available in the server
+ *
+ * This is a request from client to server
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_ListModels_Request<TCustomOptions> = {
+    /**
+     * Identifier of the end user or application
+     */
+    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+};
+/**
+ * TODO: [🧠] Listing models inanonymous mode does not make sence - keeping only to preserve consistency
+ */

package/esm/typings/src/remote-server/{interfaces → socket-types/listModels}/PromptbookServer_ListModels_Response.d.ts

@@ -1,8 +1,10 @@
-import type { AvailableModel } from '../../execution/AvailableModel';
+import type { AvailableModel } from '../../../execution/AvailableModel';
 /**
- * Socket.io error for remote text generation
+ * Models available for use in the server
  *
  * This is sent from server to client when models are listed
+ *
+ * @private internal type of remote server
  */
 export type PromptbookServer_ListModels_Response = {
     /**

package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts

@@ -0,0 +1,17 @@
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+/**
+ * This is a request from client to server to prepare a pipeline
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_PreparePipeline_Request<TCustomOptions> = {
+    /**
+     * Identifier of the end user or application
+     */
+    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+    /**
+     * The Pipeline to prepare
+     */
+    readonly pipeline: PipelineJson;
+};

package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Response.d.ts

@@ -0,0 +1,12 @@
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+/**
+ * This is sent from server to client when the pipeline is prepared
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_PreparePipeline_Response = {
+    /**
+     * Prepared pipeline
+     */
+    readonly preparedPipeline: PipelineJson;
+};

package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts

@@ -0,0 +1,17 @@
+import type { Prompt } from '../../../types/Prompt';
+import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+/**
+ * This is a request from client to server to execute a prompt
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_Prompt_Request<TCustomOptions> = {
+    /**
+     * Identifier of the end user or application
+     */
+    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+    /**
+     * The Prompt to execute
+     */
+    readonly prompt: Prompt;
+};

package/esm/typings/src/remote-server/{interfaces → socket-types/prompt}/PromptbookServer_Prompt_Response.d.ts

@@ -1,8 +1,8 @@
-import type { PromptResult } from '../../execution/PromptResult';
+import type { PromptResult } from '../../../execution/PromptResult';
 /**
- * Socket.io error for remote text generation
- *
  * This is sent from server to client when the generated text is completed
+ *
+ * @private internal type of remote server
  */
 export type PromptbookServer_Prompt_Response = {
     /**

package/esm/typings/src/remote-server/startRemoteServer.d.ts

@@ -1,5 +1,5 @@
 import type { IDestroyable } from 'destroyable';
-import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
+import type { RemoteServerOptions } from './types/RemoteServerOptions';
 /**
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
  *
@@ -11,6 +11,7 @@ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  */
 export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): IDestroyable;
 /**
+ * TODO: Split this file into multiple functions - handler for each request
  * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
  * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
@@ -19,5 +20,5 @@ export declare function startRemoteServer<TCustomOptions = undefined>(options: R
  * TODO: [🗯] Timeout on chat to free up resources
  * TODO: [🃏] Pass here some security token to prevent malitious usage and/or DDoS
  * TODO: [0] Set unavailable models as undefined in `RemoteLlmExecutionTools` NOT throw error here
- * TODO: Constrain anonymous mode for specific models / providers
+ * TODO: Allow to constrain anonymous mode for specific models / providers
  */

package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts

@@ -0,0 +1,32 @@
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { string_base_url } from '../../types/typeAliases';
+import type { string_uri } from '../../types/typeAliases';
+import type { PromptbookServer_Identification } from '../socket-types/_subtypes/PromptbookServer_Identification';
+/**
+ * Options for `RemoteLlmExecutionTools`
+ *
+ * @public exported from `@promptbook/remote-client`
+ */
+export type RemoteClientOptions<TCustomOptions> = CommonToolsOptions & {
+    /**
+     * URL of the remote server
+     * On this server will be connected to the socket.io server
+     */
+    readonly remoteUrl: string_base_url;
+    /**
+     * Path for the Socket.io server to listen
+     *
+     * @default '/socket.io'
+     * @example '/promptbook/socket.io'
+     */
+    readonly path: string_uri;
+    /**
+     * Identification of client for Socket.io remote server
+     */
+    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+};
+/**
+ * TODO: Pass more options from Socket.io to `RemoteClientOptions` (like `transports`)
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ */

package/esm/typings/src/types/Arrayable.d.ts

@@ -5,6 +5,7 @@
  * 2) Undefined represents empty array
  * 3) Array represents itself
  *
+ * @deprecated Use `Arrayable` from `type-fest` instead
  * @private internal type
  */
 export type Arrayable<TItem> = TItem | ReadonlyArray<TItem> | undefined;

package/esm/typings/src/types/NonEmptyArray.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Represents an array that is guaranteed to have at least one element
+ */
+export type NonEmptyArray<TItem> = [TItem, ...TItem[]];
+/**
+ * Represents an array that is guaranteed to have at least one element and is readonly
+ */
+export type NonEmptyReadonlyArray<TItem> = ReadonlyArray<TItem> & NonEmptyArray<TItem>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.82.0-0",
+    "version": "0.82.0-3",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -54,7 +54,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.82.0-0"
+        "@promptbook/core": "0.82.0-3"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.81.0-23';
+    var PROMPTBOOK_ENGINE_VERSION = '0.82.0-2';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name