@promptbook/openai 0.103.0-4 → 0.103.0-40

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

@@ -0,0 +1,20 @@
+import type { ExecutionPromptReportJson } from '../execution/execution-report/ExecutionPromptReportJson';
+import type { string_model_name } from './typeAliases';
+/**
+ * Represents a single LLM call with its report.
+ *
+ * @see https://github.com/webgptorg/promptbook/issues/24
+ */
+export type LlmCall = {
+    /**
+     * The name of the model used for the call.
+     */
+    readonly modelName: string_model_name;
+    /**
+     * The report of the LLM execution.
+     */
+    readonly report: ExecutionPromptReportJson;
+};
+/**
+ * TODO: !!! Maybe different shape of LlmCall
+ */

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

@@ -0,0 +1,19 @@
+import { BehaviorSubject } from 'rxjs';
+/**
+ * A type that represents a value that can be updated over time:
+ *
+ * 1) It can be a static value of type `TValue`
+ * 2) Or a `BehaviorSubject` that emits values of type `TValue`
+ * 3) Or pair of `[getValue, setValue]` functions for getting and setting the value
+ */
+export type Updatable<TValue> = TValue | BehaviorSubject<TValue> | [TValue, (value: TValue) => void];
+/**
+ * Restricts an Updatable to a (2) BehaviorSubject variant
+ *
+ * @see Updatable
+ * @private internal utility <- TODO: [🧠] Maybe export from `@promptbook/types`
+ */
+export declare function asUpdatableSubject<TValue>(value: Updatable<TValue>): BehaviorSubject<TValue>;
+/**
+ * TODO: [🧠] Maybe `BehaviorSubject` is too heavy for this use case, maybe just tuple `[value,setValue]` is enough
+ */

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

@@ -323,7 +323,7 @@ export type string_css_property = string;
  *
  * For example `13px`
  */
-export type string_css_value = string;
+export type string_css_value = string | number;
 /**
  * Semantic helper
  *

package/esm/typings/src/utils/execCommand/$execCommand.d.ts

@@ -1,3 +1,4 @@
+import { $side_effect } from '../organization/$side_effect';
 import type { ExecCommandOptions } from './ExecCommandOptions';
 /**
  * Run one command in a shell
@@ -10,7 +11,7 @@ import type { ExecCommandOptions } from './ExecCommandOptions';
  *
  * @public exported from `@promptbook/node`
  */
-export declare function $execCommand(options: ExecCommandOptions): Promise<string>;
+export declare function $execCommand(options: ExecCommandOptions): Promise<$side_effect & string>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/utils/execCommand/$execCommands.d.ts

@@ -1,3 +1,4 @@
+import { $side_effect } from '../organization/$side_effect';
 /**
  * Run multiple commands in a shell in sequence
  *
@@ -8,7 +9,7 @@
  *
  * @public exported from `@promptbook/node`
  */
-export declare function $execCommands({ commands, cwd, crashOnError, }: {
+export declare function $execCommands({ commands, cwd, crashOnError, }: $side_effect & {
     readonly commands: string[];
     readonly cwd: string;
     readonly crashOnError?: boolean;

package/esm/typings/src/utils/files/$induceBookDownload.d.ts

@@ -0,0 +1,13 @@
+import { string_book } from '../../_packages/types.index';
+import { $side_effect } from '../organization/$side_effect';
+/**
+ * Download a Book in a browser
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - its purpose is to cause a side effect (download a file)
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare function $induceBookDownload(book: string_book): Promise<$side_effect>;
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

package/esm/typings/src/utils/files/$induceFileDownload.d.ts

@@ -0,0 +1,13 @@
+import { string_url } from '../../types/typeAliases';
+import { $side_effect } from '../organization/$side_effect';
+/**
+ * Download a File in a browser
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - its purpose is to cause a side effect (download a file)
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare function $induceFileDownload(fileOrBlobOrUrl: File | Blob | URL | string_url): Promise<$side_effect>;
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

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

@@ -0,0 +1,46 @@
+import { IDestroyable, Registration } from 'destroyable';
+import { string_mime_type, string_url } from '../../types/typeAliases';
+/**
+ * Converts Blob, File or MediaSource to url using URL.createObjectURL
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare class ObjectUrl extends Registration implements IDestroyable {
+    readonly src: string_url;
+    private constructor();
+    /**
+     * Creates ObjectUrl from multiple input types
+     * Note: DO NOT forget to call destroy() when you are done with it
+     */
+    static from(source: Blob | File | MediaSource | string, mimeType: string_mime_type): ObjectUrl;
+    /**
+     * Creates ObjectUrl from string
+     * Note: DO NOT forget to call destroy() when you are done with it
+     */
+    static fromString(source: string, mimeType: string_mime_type): ObjectUrl;
+    /**
+     * Creates ObjectUrl
+     * DO NOT forget to call destroy() when you are done with it
+     */
+    static fromBlob(source: Blob | File | MediaSource): ObjectUrl;
+    /**
+     * Creates ObjectUrl:
+     * 1) With functionality for Blobs, Files or MediaSources
+     * 2) Just a wrapper for string urls
+     *
+     * DO NOT forget to call destroy() when you are done with it
+     */
+    static fromBlobOrUrl(source: Blob | File | MediaSource | URL | string_url): ObjectUrl;
+    /**
+     * Gets object url as string
+     * @alias src
+     */
+    get href(): string_url;
+    /**
+     * Gets object url as URL object
+     */
+    get url(): URL;
+}
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

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/utils/misc/aboutPromptbookInformation.d.ts

@@ -0,0 +1,21 @@
+import type { string_markdown } from '../../types/typeAliases';
+export type AboutPromptbookInformationOptions = {
+    /**
+     * Include information about available servers
+     *
+     * @default true
+     */
+    isServersInfoIncluded?: boolean;
+};
+/**
+ * Provide information about Promptbook, engine version, book language version, servers, ...
+ *
+ * @param options Which information to include
+ * @returns  Information about Promptbook in markdown format
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function aboutPromptbookInformation(options?: AboutPromptbookInformationOptions): string_markdown;
+/**
+ * TODO: [🗽] Unite branding and make single place for it
+ */

package/esm/typings/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts

@@ -16,5 +16,6 @@ export type InjectCssModuleIntoShadowRootOptions = {
  *
  * @public exported from `@promptbook/components`
  *         <- TODO: [🧠] Make `@promptbook/components-utils`
+ * @deprecated This was used for BookEditor shadow DOM support, which is no longer needed
  */
 export declare function injectCssModuleIntoShadowRoot(options: InjectCssModuleIntoShadowRootOptions): void;

package/esm/typings/src/utils/misc/xAboutPromptbookInformation.d.ts

@@ -0,0 +1,13 @@
+import type { AboutPromptbookInformationOptions } from './aboutPromptbookInformation';
+type AboutPromptbookInformationProps = AboutPromptbookInformationOptions;
+/**
+ * Provide information about Promptbook, engine version, book language version, servers, ...
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function AboutPromptbookInformation(props: AboutPromptbookInformationProps): import("react/jsx-runtime").JSX.Element;
+export {};
+/**
+ * TODO: !!! Remove "x" from filename
+ * TODO: [🗽] Unite branding and make single place for it
+ */

package/esm/typings/src/utils/organization/$side_effect.d.ts

@@ -0,0 +1,7 @@
+import { really_any } from './really_any';
+/**
+ * Organizational helper to mark a function that produces side effects
+ *
+ * @private within the repository
+ */
+export type $side_effect = void | really_any;

package/esm/typings/src/utils/serialization/$deepFreeze.d.ts

@@ -1,4 +1,5 @@
 import type { ReadonlyDeep } from 'type-fest';
+import { $side_effect } from '../organization/$side_effect';
 /**
  * Freezes the given object and all its nested objects recursively
  *
@@ -8,7 +9,7 @@ import type { ReadonlyDeep } from 'type-fest';
  * @returns The same object as the input, but deeply frozen
  * @public exported from `@promptbook/utils`
  */
-export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
+export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<$side_effect & TObject>;
 /**
  * TODO: [🧠] Is there a way how to meaningfully test this utility
  */

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-3`).
+ * 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-4",
+    "version": "0.103.0-40",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -102,14 +102,15 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-4"
+        "@promptbook/core": "0.103.0-40"
     },
     "dependencies": {
-        "bottleneck": "^2.19.5",
-        "colors": "1.4.0",
+        "bottleneck": "2.19.5",
+        "colors": "^1.4.0",
         "crypto": "1.0.1",
         "openai": "4.63.0",
-        "socket.io-client": "4.7.2",
-        "spacetrim": "0.11.59"
+        "socket.io-client": "4.7.5",
+        "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-4';
+    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
@@ -71,6 +71,19 @@
      * TODO: [🎺]
      */
 
+    /**
+     * This error indicates that promptbook operation is not allowed
+     *
+     * @public exported from `@promptbook/core`
+     */
+    class NotAllowed extends Error {
+        constructor(message) {
+            super(message);
+            this.name = 'NotAllowed';
+            Object.setPrototypeOf(this, NotAllowed.prototype);
+        }
+    }
+
     /**
      * This error type indicates that some part of the code is not implemented yet
      *
@@ -1153,15 +1166,30 @@
      * @public exported from `@promptbook/core`
      */
     const PROMPTBOOK_COLOR = Color.fromHex('#79EAFD');
-    // <- TODO: [🧠] Using `Color` here increases the package size approx 3kb, maybe remove it
+    // <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
+    /**
+     * Colors for syntax highlighting in the `<BookEditor/>`
+     *
+     * TODO: [🗽] Unite branding and make single place for it
+     *
+     * @public exported from `@promptbook/core`
+     */
+    ({
+        TITLE: Color.fromHex('#244EA8'),
+        LINE: Color.fromHex('#eeeeee'),
+        COMMITMENT: Color.fromHex('#DA0F78'),
+        PARAMETER: Color.fromHex('#8e44ad'),
+    });
+    // <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
     /**
-     * Dark color of the Promptbook
+     * Chat color of the Promptbook (in chat)
      *
      * TODO: [🗽] Unite branding and make single place for it
      *
      * @public exported from `@promptbook/core`
      */
     PROMPTBOOK_COLOR.then(lighten(0.1)).then(saturate(0.9)).then(grayscale(0.9));
+    // <- TODO: [🧠][🈵] Using `Color` and `lighten`, `saturate`,... here increases the package size approx 3kb, maybe remove it
     /**
      * Color of the user (in chat)
      *
@@ -1831,10 +1859,13 @@
      * @public exported from `@promptbook/utils`
      */
     function countLines(text) {
+        if (text === '') {
+            return 0;
+        }
         text = text.replace('\r\n', '\n');
         text = text.replace('\r', '\n');
         const lines = text.split('\n');
-        return lines.reduce((count, line) => count + Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 0);
+        return lines.reduce((count, line) => count + Math.max(Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 1), 0);
     }
     /**
      * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
@@ -3601,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 {
@@ -3610,11 +3647,18 @@
          * @param options which are relevant are directly passed to the OpenAI client
          */
         constructor(options) {
+            var _a;
             if (options.isProxied) {
                 throw new NotYetImplementedError(`Proxy mode is not yet implemented for OpenAI assistants`);
             }
             super(options);
+            this.isCreatingNewAssistantsAllowed = false;
             this.assistantId = options.assistantId;
+            this.isCreatingNewAssistantsAllowed = (_a = options.isCreatingNewAssistantsAllowed) !== null && _a !== void 0 ? _a : false;
+            if (this.assistantId === null && !this.isCreatingNewAssistantsAllowed) {
+                throw new NotAllowed(`Assistant ID is null and creating new assistants is not allowed - this configuration does not make sense`);
+            }
+            // <- TODO: !!! `OpenAiAssistantExecutionToolsOptions` - Allow `assistantId: null` together with `isCreatingNewAssistantsAllowed: true`
             // TODO: [👱] Make limiter same as in `OpenAiExecutionTools`
         }
         get title() {
@@ -3673,14 +3717,13 @@
                 // TODO: [👨‍👨‍👧‍👧][🧠] What about system message for assistants, does it make sense - combination of OpenAI assistants with Promptbook Personas
                 assistant_id: this.assistantId,
                 thread: {
-                    messages: 'thread' in prompt && Array.isArray(prompt.thread)
+                    messages: 'thread' in prompt &&
+                        Array.isArray(prompt.thread)
                         ? prompt.thread.map((msg) => ({
                             role: msg.role === 'assistant' ? 'assistant' : 'user',
                             content: msg.content,
                         }))
-                        : [
-                            { role: 'user', content: rawPromptContent },
-                        ],
+                        : [{ role: 'user', content: rawPromptContent }],
                 },
                 // <- TODO: Add user identification here> user: this.options.user,
             };
@@ -3760,7 +3803,120 @@
                 },
             });
         }
+        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: !!!
+            async function downloadFile(url: string, folder = './tmp'): Promise<string> {
+                const filename = path.basename(url.split('?')[0]);
+                const filepath = path.join(folder, filename);
+
+                if (!fs.existsSync(folder)) fs.mkdirSync(folder);
+
+                const res = await fetch(url);
+                if (!res.ok) throw new Error(`Download error: ${url}`);
+                const buffer = await res.arrayBuffer();
+                fs.writeFileSync(filepath, Buffer.from(buffer));
+                console.log(`📥 File downloaded: ${filename}`);
+
+                return filepath;
+            }
+
+            async function uploadFileToOpenAI(filepath: string) {
+                const file = await client.files.create({
+                    file: fs.createReadStream(filepath),
+                    purpose: 'assistants',
+                });
+                console.log(`⬆️  File uploaded to OpenAI: ${file.filename} (${file.id})`);
+                return file;
+            }
+
+            // 🌐 URL addresses of files to upload
+            const fileUrls = [
+                'https://raw.githubusercontent.com/vercel/next.js/canary/packages/next/README.md',
+                'https://raw.githubusercontent.com/openai/openai-cookbook/main/examples/How_to_call_the_Assistants_API_with_Node.js.ipynb',
+            ];
+
+            // 1️⃣ Download files from URL
+            const localFiles = [];
+            for (const url of fileUrls) {
+                const filepath = await downloadFile(url);
+                localFiles.push(filepath);
+            }
+
+            // 2️⃣ Upload files to OpenAI
+            const uploadedFiles = [];
+            for (const filepath of localFiles) {
+                const file = await uploadFileToOpenAI(filepath);
+                uploadedFiles.push(file.id);
+            }
+            */
+            alert('!!!! Creating new OpenAI assistant');
+            // 3️⃣ Create assistant with uploaded files
+            const assistant = await client.beta.assistants.create({
+                name,
+                description: 'Assistant created via Promptbook',
+                model: 'gpt-4o',
+                instructions,
+                tools: [/* TODO: [🧠] Maybe add { type: 'code_interpreter' }, */ { type: 'file_search' }],
+                // !!!! file_ids: uploadedFiles,
+            });
+            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,
+                assistantId: assistant.id,
+            });
+        }
+        /**
+         * Discriminant for type guards
+         */
+        get discriminant() {
+            return DISCRIMINANT;
+        }
+        /**
+         * Type guard to check if given `LlmExecutionTools` are instanceof `OpenAiAssistantExecutionTools`
+         *
+         * Note: This is useful when you can possibly have multiple versions of `@promptbook/openai` installed
+         */
+        static isOpenAiAssistantExecutionTools(llmExecutionTools) {
+            return llmExecutionTools.discriminant === DISCRIMINANT;
+        }
     }
+    /**
+     * Discriminant for type guards
+     *
+     * @private const of `OpenAiAssistantExecutionTools`
+     */
+    const DISCRIMINANT = 'OPEN_AI_ASSISTANT_V1';
     /**
      * TODO: [🧠][🧙‍♂️] Maybe there can be some wizard for those who want to use just OpenAI
      * TODO: Maybe make custom OpenAiError
@@ -3996,6 +4152,7 @@
         PromptbookFetchError,
         UnexpectedError,
         WrappedError,
+        NotAllowed,
         // TODO: [🪑]> VersionMismatchError,
     };
     /**