@promptbook/legacy-documents 0.92.0-32 → 0.92.0-33

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

@@ -134,6 +134,7 @@ import type { JavascriptExecutionToolsOptions } from '../scripting/javascript/Ja
 import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
 import type { PromptbookStorage } from '../storage/_common/PromptbookStorage';
 import type { FileCacheStorageOptions } from '../storage/file-cache-storage/FileCacheStorageOptions';
+import type { IndexedDbStorageOptions } from '../storage/local-storage/utils/IndexedDbStorageOptions';
 import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
 import type { ModelRequirements } from '../types/ModelRequirements';
 import type { CompletionModelRequirements } from '../types/ModelRequirements';
@@ -431,6 +432,7 @@ export type { JavascriptExecutionToolsOptions };
 export type { PostprocessingFunction };
 export type { PromptbookStorage };
 export type { FileCacheStorageOptions };
+export type { IndexedDbStorageOptions };
 export type { IntermediateFilesStrategy };
 export type { ModelRequirements };
 export type { CompletionModelRequirements };

package/esm/typings/src/execution/ExecutionTask.d.ts

@@ -2,6 +2,7 @@ import type { Observable } from 'rxjs';
 import { PartialDeep } from 'type-fest';
 import type { task_id } from '../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { string_promptbook_version } from '../version';
 import type { AbstractTaskResult } from './AbstractTaskResult';
 import type { PipelineExecutorResult } from './PipelineExecutorResult';
 /**
@@ -12,12 +13,21 @@ type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
      * The type of task to create
      */
     readonly taskType: AbstractTask<TTaskResult>['taskType'];
+    /**
+     * Human-readable title of the task - used for displaying in the UI
+     */
+    readonly title: AbstractTask<TTaskResult>['title'];
     /**
      * Callback that processes the task and updates the ongoing result
      * @param ongoingResult The partial result of the task processing
      * @returns The final task result
      */
-    taskProcessCallback(updateOngoingResult: (newOngoingResult: PartialDeep<TTaskResult>) => void): Promise<TTaskResult>;
+    taskProcessCallback(updateOngoingResult: (newOngoingResult: PartialDeep<TTaskResult> & {
+        /**
+         * Optional update of the task title
+         */
+        readonly title?: AbstractTask<TTaskResult>['title'];
+    }) => void): Promise<TTaskResult>;
 };
 /**
  * Helper to create a new task
@@ -52,10 +62,18 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * Type of the task
      */
     readonly taskType: string_SCREAMING_CASE;
+    /**
+     * Version of the promptbook used to run the task
+     */
+    readonly promptbookVersion: string_promptbook_version;
     /**
      * Unique identifier for the task
      */
     readonly taskId: task_id;
+    /**
+     * Human-readable title of the task - used for displaying in the UI
+     */
+    readonly title: string;
     /**
      * Status of the task
      */

package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts

@@ -9,6 +9,10 @@ import type { string_user_id } from '../../types/typeAliases';
  * @public exported from `@promptbook/azure-openai`
  */
 export type AzureOpenAiExecutionToolsOptions = CommonToolsOptions & {
+    /**
+     * The API key of the Azure OpenAI resource
+     */
+    readonly apiKey: string_token;
     /**
      * The resource name of the Azure OpenAI resource
      *
@@ -23,10 +27,6 @@ export type AzureOpenAiExecutionToolsOptions = CommonToolsOptions & {
      * Note: Typically you have one resource and multiple deployments.
      */
     readonly deploymentName: string_name;
-    /**
-     * The API key of the Azure OpenAI resource
-     */
-    readonly apiKey: string_token;
     /**
      * A unique identifier representing your end-user, which can help Azure OpenAI to monitor
      * and detect abuse.

package/esm/typings/src/storage/local-storage/getIndexedDbStorage.d.ts

@@ -1,10 +1,11 @@
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import type { IndexedDbStorageOptions } from './utils/IndexedDbStorageOptions';
 /**
  * Gets wrapper around IndexedDB which can be used as PromptbookStorage
  *
  * @public exported from `@promptbook/browser`
  */
-export declare function getIndexedDbStorage<TItem>(): PromptbookStorage<TItem>;
+export declare function getIndexedDbStorage<TItem>(options: IndexedDbStorageOptions): PromptbookStorage<TItem>;
 /**
  * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
  */

package/esm/typings/src/storage/local-storage/utils/IndexedDbStorageOptions.d.ts

@@ -0,0 +1,14 @@
+import type { string_name } from '../../../types/typeAliases';
+/**
+ * Options for IndexedDB storage
+ */
+export type IndexedDbStorageOptions = {
+    /**
+     * Name of the database
+     */
+    databaseName: string_name;
+    /**
+     * Name of the object store (table) in the database
+     */
+    storeName: string_name;
+};

package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts

@@ -1,7 +1,8 @@
 import type { PromptbookStorage } from '../../_common/PromptbookStorage';
+import type { IndexedDbStorageOptions } from './IndexedDbStorageOptions';
 /**
  * Creates a PromptbookStorage backed by IndexedDB.
  * Uses a single object store named 'promptbook'.
  * @private for `getIndexedDbStorage`
  */
-export declare function makePromptbookStorageFromIndexedDb<TValue>(dbName?: string, storeName?: string): PromptbookStorage<TValue>;
+export declare function makePromptbookStorageFromIndexedDb<TValue>(options: IndexedDbStorageOptions): PromptbookStorage<TValue>;

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.92.0-31`).
+ * It follows semantic versioning (e.g., `0.92.0-32`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/legacy-documents",
-    "version": "0.92.0-32",
+    "version": "0.92.0-33",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -51,7 +51,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/legacy-documents.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-32"
+        "@promptbook/core": "0.92.0-33"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -26,7 +26,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-32';
+    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-33';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2673,6 +2673,7 @@
      */
     function createTask(options) {
         const { taskType, taskProcessCallback } = options;
+        let { title } = options;
         // TODO: [🐙] DRY
         const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts   */)}`;
         let status = 'RUNNING';
@@ -2684,6 +2685,10 @@
         const partialResultSubject = new rxjs.Subject();
         // <- Note: Not using `BehaviorSubject` because on error we can't access the last value
         const finalResultPromise = /* not await */ taskProcessCallback((newOngoingResult) => {
+            if (newOngoingResult.title) {
+                title = newOngoingResult.title;
+            }
+            updatedAt = new Date();
             Object.assign(currentValue, newOngoingResult);
             // <- TODO: assign deep
             partialResultSubject.next(newOngoingResult);
@@ -2729,17 +2734,24 @@
         return {
             taskType,
             taskId,
+            get promptbookVersion() {
+                return PROMPTBOOK_ENGINE_VERSION;
+            },
+            get title() {
+                return title;
+                // <- Note: [1] Theese must be getters to allow changing the value in the future
+            },
             get status() {
                 return status;
-                // <- Note: [1] Theese must be getters to allow changing the value in the future
+                // <- Note: [1] --||--
             },
             get createdAt() {
                 return createdAt;
-                // <- Note: [1]
+                // <- Note: [1] --||--
             },
             get updatedAt() {
                 return updatedAt;
-                // <- Note: [1]
+                // <- Note: [1] --||--
             },
             asPromise,
             asObservable() {
@@ -2747,15 +2759,15 @@
             },
             get errors() {
                 return errors;
-                // <- Note: [1]
+                // <- Note: [1] --||--
             },
             get warnings() {
                 return warnings;
-                // <- Note: [1]
+                // <- Note: [1] --||--
             },
             get currentValue() {
                 return currentValue;
-                // <- Note: [1]
+                // <- Note: [1] --||--
             },
         };
     }
@@ -5513,7 +5525,7 @@
             });
             const knowledgePiecesSorted = knowledgePiecesWithRelevance.sort((a, b) => a.relevance - b.relevance);
             const knowledgePiecesLimited = knowledgePiecesSorted.slice(0, 5);
-            console.log('!!! Embedding', {
+            console.log('!!! `getKnowledgeForTask` Embedding', {
                 task,
                 taskEmbeddingPrompt,
                 taskEmbeddingResult,
@@ -5549,6 +5561,7 @@
      */
     async function getReservedParametersForTask(options) {
         const { tools, preparedPipeline, task, parameters, pipelineIdentification } = options;
+        console.log('!!! getReservedParametersForTask', options);
         const context = await getContextForTask(); // <- [🏍]
         const knowledge = await getKnowledgeForTask({ tools, preparedPipeline, task, parameters });
         const examples = await getExamplesForTask();
@@ -5585,6 +5598,7 @@
      */
     async function executeTask(options) {
         const { currentTask, preparedPipeline, parametersToPass, tools, onProgress, $executionReport, pipelineIdentification, maxExecutionAttempts, maxParallelCount, csvSettings, isVerbose, rootDirname, cacheDirname, intermediateFilesStrategy, isAutoInstalled, isNotPreparedWarningSupressed, } = options;
+        console.log('!!! executeTask', options);
         const priority = preparedPipeline.tasks.length - preparedPipeline.tasks.indexOf(currentTask);
         // Note: Check consistency of used and dependent parameters which was also done in `validatePipeline`, but it’s good to doublecheck
         const usedParameterNames = extractParameterNamesFromTask(currentTask);
@@ -5608,14 +5622,15 @@
 
                 `));
         }
+        const reservedParameters = await getReservedParametersForTask({
+            tools,
+            preparedPipeline,
+            task: currentTask,
+            pipelineIdentification,
+            parameters: parametersToPass,
+        });
         const definedParameters = Object.freeze({
-            ...(await getReservedParametersForTask({
-                tools,
-                preparedPipeline,
-                task: currentTask,
-                pipelineIdentification,
-                parameters: parametersToPass,
-            })),
+            ...reservedParameters,
             ...parametersToPass,
         });
         const definedParameterNames = new Set(Object.keys(definedParameters));
@@ -6062,6 +6077,7 @@
         };
         const pipelineExecutor = (inputParameters) => createTask({
             taskType: 'EXECUTION',
+            title: pipeline.title,
             taskProcessCallback(updateOngoingResult) {
                 return pipelineExecutorWithCallback(inputParameters, async (newOngoingResult) => {
                     updateOngoingResult(newOngoingResult);