@promptbook/openai 0.103.0-37 → 0.103.0-40

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

@@ -1,17 +1,13 @@
 import type { Request, Response } from 'express';
 import type { Promisable } from 'type-fest';
-import type { PipelineCollection } from '../../collection/PipelineCollection';
+import { really_any } from '../../_packages/types.index';
+import type { PipelineCollection } from '../../collection/pipeline-collection/PipelineCollection';
 import { AuthenticationError } from '../../errors/AuthenticationError';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { string_app_id } from '../../types/typeAliases';
-import type { string_email } from '../../types/typeAliases';
-import type { string_password } from '../../types/typeAliases';
-import type { string_token } from '../../types/typeAliases';
-import type { string_user_id } from '../../types/typeAliases';
-import type { ApplicationModeIdentification } from '../socket-types/_subtypes/Identification';
-import type { Identification } from '../socket-types/_subtypes/Identification';
+import type { string_app_id, string_email, string_password, string_token, string_user_id } from '../../types/typeAliases';
+import type { ApplicationModeIdentification, Identification } from '../socket-types/_subtypes/Identification';
 /**
  * Options for configuring the Promptbook remote server.
  *
@@ -31,6 +27,24 @@ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
      * @property {number} port The port number the server will listen on.
      */
     readonly port: number;
+    /**
+     * CORS options to apply to all endpoints (REST, UI, socket.io, etc.).
+     * Accepts the same options as the `cors` npm package and socket.io's CORS config.
+     * If not provided, defaults to permissive CORS (origin: '*').
+     * @see https://www.npmjs.com/package/cors
+     * @see https://socket.io/docs/v4/server-options/#cors
+     */
+    readonly cors?: {
+        origin?: string | string[] | boolean;
+        methods?: string | string[];
+        allowedHeaders?: string | string[];
+        exposedHeaders?: string | string[];
+        credentials?: boolean;
+        maxAge?: number;
+        preflightContinue?: boolean;
+        optionsSuccessStatus?: number;
+        [key: string]: really_any;
+    };
     /**
      * Enable rich UI (React + Tailwind) at `/` path.
      * Default: true

package/esm/typings/src/transpilers/formatted-book-in-markdown/register.d.ts

@@ -7,7 +7,7 @@ import { Registration } from '../../_packages/types.index';
  * @public exported from `@promptbook/wizard`
  * @public exported from `@promptbook/cli`
  *
- * TODO: !!!! Which package should export this?
+ * TODO: !!! Which package should export this?
  */
 export declare const _FormattedBookInMarkdownTranspilerRegistration: Registration;
 /**

package/esm/typings/src/utils/files/listAllFiles.d.ts

@@ -1,13 +1,12 @@
 import type { FilesystemTools } from '../../execution/FilesystemTools';
-import type { string_dirname } from '../../types/typeAliases';
-import type { string_filename } from '../../types/typeAliases';
+import type { string_dirname, string_filename } from '../../types/typeAliases';
 /**
  * Reads all files in the directory
  *
  * @param path
  * @param isRecursive
  * @returns List of all files in the directory
- * @private internal function of `createCollectionFromDirectory`
+ * @private internal function of `AgentCollectionInDirectory` and `createPipelineCollectionFromDirectory`
  */
 export declare function listAllFiles(path: string_dirname, isRecursive: boolean, fs: FilesystemTools): Promise<Array<string_filename>>;
 /**

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.103.0-36`).
+ * It follows semantic versioning (e.g., `0.103.0-39`).
  *
  * @generated
  */

package/esm/typings/src/wizard/$getCompiledBook.d.ts

@@ -2,8 +2,7 @@ import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { PipelineString } from '../pipeline/PipelineString';
 import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
-import type { string_filename } from '../types/typeAliases';
-import type { string_pipeline_url } from '../types/typeAliases';
+import type { string_filename, string_pipeline_url } from '../types/typeAliases';
 /**
  * @see ./wizard.ts `getPipeline` method
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.103.0-37",
+    "version": "0.103.0-40",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -102,7 +102,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-37"
+        "@promptbook/core": "0.103.0-40"
     },
     "dependencies": {
         "bottleneck": "2.19.5",
@@ -110,6 +110,7 @@
         "crypto": "1.0.1",
         "openai": "4.63.0",
         "socket.io-client": "4.7.5",
-        "spacetrim": "0.11.60"
+        "spacetrim": "0.11.60",
+        "waitasecond": "1.11.160"
     }
 }

package/umd/index.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('spacetrim'), require('crypto'), require('bottleneck'), require('openai'), require('socket.io-client')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'colors', 'spacetrim', 'crypto', 'bottleneck', 'openai', 'socket.io-client'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-openai"] = {}, global.colors, global.spaceTrim, global.crypto, global.Bottleneck, global.OpenAI, global.socket_ioClient));
-})(this, (function (exports, colors, spaceTrim, crypto, Bottleneck, OpenAI, socket_ioClient) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('waitasecond'), require('spacetrim'), require('crypto'), require('bottleneck'), require('openai'), require('socket.io-client')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'colors', 'waitasecond', 'spacetrim', 'crypto', 'bottleneck', 'openai', 'socket.io-client'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-openai"] = {}, global.colors, global.waitasecond, global.spaceTrim, global.crypto, global.Bottleneck, global.OpenAI, global.socket_ioClient));
+})(this, (function (exports, colors, waitasecond, spaceTrim, crypto, Bottleneck, OpenAI, socket_ioClient) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -25,7 +25,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-37';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-40';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -3632,6 +3632,12 @@
      *
      * This is useful for calling OpenAI API with a single assistant, for more wide usage use `OpenAiExecutionTools`.
      *
+     * Note: [🦖] There are several different things in Promptbook:
+     * - `Agent` - which represents an AI Agent with its source, memories, actions, etc. Agent is a higher-level abstraction which is internally using:
+     * - `LlmExecutionTools` - which wraps one or more LLM models and provides an interface to execute them
+     * - `AgentLlmExecutionTools` - which is a specific implementation of `LlmExecutionTools` that wraps another LlmExecutionTools and applies agent-specific system prompts and requirements
+     * - `OpenAiAssistantExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities, recommended for usage in `Agent` or `AgentLlmExecutionTools`
+     *
      * @public exported from `@promptbook/openai`
      */
     class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
@@ -3797,10 +3803,32 @@
                 },
             });
         }
-        async createNewAssistant() {
+        async playground() {
+            const client = await this.getClient();
+            // List all assistants
+            const assistants = await client.beta.assistants.list();
+            console.log('!!! Assistants:', assistants);
+            // Get details of a specific assistant
+            const assistantId = 'asst_MO8fhZf4dGloCfXSHeLcIik0';
+            const assistant = await client.beta.assistants.retrieve(assistantId);
+            console.log('!!! Assistant Details:', assistant);
+            // Update an assistant
+            const updatedAssistant = await client.beta.assistants.update(assistantId, {
+                name: assistant.name + '(M)',
+                description: 'Updated description via Promptbook',
+                metadata: {
+                    [Math.random().toString(36).substring(2, 15)]: new Date().toISOString(),
+                },
+            });
+            console.log('!!! Updated Assistant:', updatedAssistant);
+            await waitasecond.forEver();
+        }
+        async createNewAssistant(options) {
             if (!this.isCreatingNewAssistantsAllowed) {
                 throw new NotAllowed(`Creating new assistants is not allowed. Set \`isCreatingNewAssistantsAllowed: true\` in options to enable this feature.`);
             }
+            await this.playground();
+            const { name, instructions } = options;
             const client = await this.getClient();
             /*
             TODO: !!!
@@ -3848,21 +3876,20 @@
                 uploadedFiles.push(file.id);
             }
             */
+            alert('!!!! Creating new OpenAI assistant');
             // 3️⃣ Create assistant with uploaded files
             const assistant = await client.beta.assistants.create({
-                name: 'Next.js documentation assistant',
-                description: 'Assistant that can answer questions about Next.js and working with APIs.',
+                name,
+                description: 'Assistant created via Promptbook',
                 model: 'gpt-4o',
-                instructions: spaceTrim__default["default"](`
-                Answer clearly and comprehensively.
-                Quote parts from uploaded files if needed.
-            `),
-                // <- TODO: !!!! Generate the `instructions` from passed `agentSource` (generate outside of this class)
-                tools: [{ type: 'code_interpreter' }, { type: 'file_search' }],
+                instructions,
+                tools: [/* TODO: [🧠] Maybe add { type: 'code_interpreter' }, */ { type: 'file_search' }],
                 // !!!! file_ids: uploadedFiles,
             });
-            // TODO: !!!! Change Czech to English
             console.log(`✅ Assistant created: ${assistant.id}`);
+            // TODO: !!!! Try listing existing assistants
+            // TODO: !!!! Try marking existing assistants by DISCRIMINANT
+            // TODO: !!!! Allow to update and reconnect to existing assistants
             return new OpenAiAssistantExecutionTools({
                 ...this.options,
                 isCreatingNewAssistantsAllowed: false,