@promptbook/openai 0.67.0-3 → 0.67.0-4

package/esm/index.es.js

@@ -6,7 +6,7 @@ import spaceTrim$1, { spaceTrim } from 'spacetrim';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.67.0-2';
+var PROMPTBOOK_VERSION = '0.67.0-3';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************

package/esm/typings/src/_packages/types.index.d.ts

@@ -157,7 +157,7 @@ import type { string_protocol } from '../types/typeAliases';
 import type { string_email } from '../types/typeAliases';
 import type { string_emails } from '../types/typeAliases';
 import type { string_uuid } from '../types/typeAliases';
-import type { client_id } from '../types/typeAliases';
+import type { string_user_id } from '../types/typeAliases';
 import type { string_sha256 } from '../types/typeAliases';
 import type { string_semantic_version } from '../types/typeAliases';
 import type { string_version_dependency } from '../types/typeAliases';
@@ -383,7 +383,7 @@ export type { string_protocol };
 export type { string_email };
 export type { string_emails };
 export type { string_uuid };
-export type { client_id };
+export type { string_user_id };
 export type { string_sha256 };
 export type { string_semantic_version };
 export type { string_version_dependency };

package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts

@@ -1,4 +1,3 @@
-import type { client_id } from '../../../types/typeAliases';
 import type { LlmToolsConfiguration } from '../../_common/LlmToolsConfiguration';
 /**
  * Socket.io progress for remote text generation
@@ -11,10 +10,6 @@ export type PromptbookServer_ListModels_CollectionRequest = {
      * Collection mode
      */
     isAnonymous: false;
-    /**
-     * Client responsible for the requests
-     */
-    readonly clientId: client_id;
 };
 export type PromptbookServer_ListModels_AnonymousRequest = {
     /**
@@ -29,6 +24,6 @@ export type PromptbookServer_ListModels_AnonymousRequest = {
 /**
  * TODO: [👡] DRY `PromptbookServer_Prompt_Request` and `PromptbookServer_ListModels_Request`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
- * TODO: [🧠][🤺] Pass `clientId` in `PromptbookServer_ListModels_Request`
+ * TODO: [🧠][🤺] Pass `userId` in `PromptbookServer_ListModels_Request`
  * TODO: [👒] Listing models (and checking configuration) probbably should go through REST API not Socket.io
  */

package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts

@@ -1,5 +1,5 @@
 import type { Prompt } from '../../../types/Prompt';
-import type { client_id } from '../../../types/typeAliases';
+import type { string_user_id } from '../../../types/typeAliases';
 import type { LlmToolsConfiguration } from '../../_common/LlmToolsConfiguration';
 /**
  * Socket.io progress for remote text generation
@@ -11,11 +11,14 @@ export type PromptbookServer_Prompt_CollectionRequest = {
     /**
      * Collection mode
      */
-    isAnonymous: false;
+    readonly isAnonymous: false;
     /**
-     * Client responsible for the requests
+     * Identifier of the end user
+     *
+     * Note: this is passed to the certain model providers to identify misuse
+     * Note: In anonymous mode it is not required to identify
      */
-    readonly clientId: client_id;
+    readonly userId: string_user_id;
     /**
      * The Prompt to execute
      */
@@ -25,7 +28,14 @@ export type PromptbookServer_Prompt_AnonymousRequest = {
     /**
      * Anonymous mode
      */
-    isAnonymous: true;
+    readonly isAnonymous: true;
+    /**
+     * Identifier of the end user
+     *
+     * Note: this is passed to the certain model providers to identify misuse
+     * Note: In anonymous mode it is not required to identify
+     */
+    readonly userId?: string_user_id;
     /**
      * Configuration for the LLM tools
      */
@@ -38,4 +48,4 @@ export type PromptbookServer_Prompt_AnonymousRequest = {
 /**
  * TODO: [👡] DRY `PromptbookServer_Prompt_Request` and `PromptbookServer_ListModels_Request`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
- */ 
+ */

package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts

@@ -1,7 +1,7 @@
 import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
-import type { client_id } from '../../../types/typeAliases';
 import type { string_base_url } from '../../../types/typeAliases';
 import type { string_uri } from '../../../types/typeAliases';
+import type { string_user_id } from '../../../types/typeAliases';
 import type { LlmToolsConfiguration } from '../../_common/LlmToolsConfiguration';
 /**
  * Options for `RemoteLlmExecutionTools`
@@ -34,15 +34,24 @@ export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
      * Configuration for the LLM tools
      */
     readonly llmToolsConfiguration: LlmToolsConfiguration;
+    /**
+     * Identifier of the end user
+     *
+     * Note: this is passed to the certain model providers to identify misuse
+     * Note: In anonymous mode it is not required to identify
+     */
+    readonly userId?: string_user_id;
 } | {
     /**
      * Use anonymous server with client identification and fixed collection
      */
     isAnonymous: false;
     /**
-     * Your client ID
+     * Identifier of the end user
+     *
+     * Note: this is passed to the certain model providers to identify misuse
      */
-    readonly clientId: client_id;
+    readonly userId: string_user_id;
 });
 /**
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`

package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts

@@ -1,8 +1,8 @@
 import type { PipelineCollection } from '../../../collection/PipelineCollection';
 import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
 import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
-import type { client_id } from '../../../types/typeAliases';
 import type { string_uri } from '../../../types/typeAliases';
+import type { string_user_id } from '../../../types/typeAliases';
 /**
  * @@@
  *
@@ -50,7 +50,7 @@ export type CollectionRemoteServerOptions = {
     /**
      * Creates llm execution tools for each client
      */
-    createLlmExecutionTools(clientId: client_id): LlmExecutionTools;
+    createLlmExecutionTools(userId: string_user_id | undefined): LlmExecutionTools;
 };
 /**
  * TODO: Constrain anonymous mode for specific models / providers

package/esm/typings/src/llm-providers/remote/playground/playground.d.ts

@@ -1,2 +1,2 @@
 #!/usr/bin/env ts-node
-export {};
+import '../../openai/register-constructor';

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

@@ -391,11 +391,9 @@ export type string_uuid = string & {
     readonly _type: 'uuid';
 };
 /**
- * Branded type client id
+ * End user identifier;
  */
-export type client_id = string & {
-    readonly _type: 'client_id';
-};
+export type string_user_id = string;
 /**
  * Semantic helper
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.67.0-3",
+    "version": "0.67.0-4",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.67.0-3"
+        "@promptbook/core": "0.67.0-4"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -14,7 +14,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.67.0-2';
+    var PROMPTBOOK_VERSION = '0.67.0-3';
     // TODO: !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************