@promptbook/openai 0.84.0 → 0.85.0-0

package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts

@@ -17,5 +17,5 @@ import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOpt
  */
 export declare function compilePipelineOnRemoteServer<TCustomOptions = undefined>(pipelineString: PipelineString, options: RemoteClientOptions<TCustomOptions>): Promise<PipelineJson>;
 /**
- * TODO: [🐚] Do not return Promise<PipelineJson> But PreparePipelineTask
+ * TODO: [🐚] Do not return `Promise<PipelineJson>` But `PreparationTask`
  */

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

@@ -0,0 +1,25 @@
+import { ReadonlyDeep } from 'type-fest';
+import type { ErrorJson } from '../errors/utils/ErrorJson';
+/**
+ * @@@
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type AbstractTaskResult = {
+    /**
+     * Whether the execution was successful, details are aviable in `executionReport`
+     */
+    readonly isSuccessful: boolean;
+    /**
+     * Errors that occured during the execution, details are aviable in `executionReport`
+     */
+    readonly errors: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
+    /**
+     * Warnings that occured during the execution, details are aviable in `executionReport`
+     */
+    readonly warnings: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
+};
+/**
+ * TODO: [🧠] Should this file be in /execution or /types folder?
+ * TODO: [🧠] Maybe constrain `ErrorJson` -> `ErrorJson & { name: 'PipelineExecutionError' | 'Error' }`
+ */

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

@@ -0,0 +1,71 @@
+import type { Observable } from 'rxjs';
+import { PartialDeep } from 'type-fest';
+import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { task_id } from '../types/typeAliases';
+import type { AbstractTaskResult } from './AbstractTaskResult';
+import type { PipelineExecutorResult } from './PipelineExecutorResult';
+/**
+ * Options for creating a new task
+ */
+type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
+    /**
+     * The type of task to create
+     */
+    readonly taskType: AbstractTask<TTaskResult>['taskType'];
+    /**
+     * 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>;
+};
+/**
+ * Helper to create a new task
+ *
+ * @private internal helper function
+ */
+export declare function createTask<TTaskResult extends AbstractTaskResult>(options: CreateTaskOptions<TTaskResult>): AbstractTask<TTaskResult>;
+/**
+ * Represents a task that executes a pipeline
+ */
+export type ExecutionTask = AbstractTask<PipelineExecutorResult> & {
+    readonly taskType: 'EXECUTION';
+    readonly taskId: `execution-${task_id}`;
+};
+/**
+ * Represents a task that prepares a pipeline
+ * @deprecated TODO: [🐚] Currently unused - use
+ */
+export type PreparationTask = AbstractTask<PipelineExecutorResult> & {
+    readonly taskType: 'PREPARATION';
+    readonly taskId: `preparation-${task_id}`;
+};
+/**
+ * Base interface for all task types
+ */
+export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
+    /**
+     * Type of the task
+     */
+    readonly taskType: string_SCREAMING_CASE;
+    /**
+     * Unique identifier for the task
+     */
+    readonly taskId: task_id;
+    /**
+     * Gets a promise that resolves with the task result
+     */
+    asPromise(options?: {
+        readonly isCrashedOnError?: boolean;
+    }): Promise<TTaskResult>;
+    /**
+     * Gets an observable stream of partial task results
+     */
+    asObservable(): Observable<PartialDeep<TTaskResult>>;
+};
+export type Task = ExecutionTask | PreparationTask;
+export {};
+/**
+ * TODO: Maybe allow to terminate the task and add getter `isFinished` or `status`
+ * TODO: [🐚] Split into more files and make `PrepareTask` & `RemoteTask` + split the function
+ */

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

@@ -1,7 +1,5 @@
-import type { Promisable } from 'type-fest';
-import type { TaskProgress } from '../types/TaskProgress';
 import type { InputParameters } from '../types/typeAliases';
-import type { PipelineExecutorResult } from './PipelineExecutorResult';
+import type { ExecutionTask } from './ExecutionTask';
 /**
  * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
  * Executor is made by combining execution tools and pipeline collection.
@@ -11,9 +9,8 @@ import type { PipelineExecutorResult } from './PipelineExecutorResult';
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export type PipelineExecutor = {
-    (inputParameters: InputParameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
+    (inputParameters: InputParameters): ExecutionTask;
 };
 /**
- * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
  * TODO: [🧠] Should this file be in /execution or /types folder?
  */

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

@@ -1,7 +1,7 @@
 import { ReadonlyDeep } from 'type-fest';
-import type { ErrorJson } from '../errors/utils/ErrorJson';
 import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { Parameters } from '../types/typeAliases';
+import type { AbstractTaskResult } from './AbstractTaskResult';
 import type { ExecutionReportJson } from './execution-report/ExecutionReportJson';
 import type { PromptResultUsage } from './PromptResultUsage';
 /**
@@ -9,29 +9,17 @@ import type { PromptResultUsage } from './PromptResultUsage';
  *
  * Note: [🚉] This is fully serializable as JSON
  */
-export type PipelineExecutorResult = {
+export type PipelineExecutorResult = AbstractTaskResult & {
     /**
      * Result parameters of the execution
      *
      * Note: If the execution was not successful, there are only some of the result parameters
      */
     readonly outputParameters: Readonly<Parameters>;
-    /**
-     * Whether the execution was successful, details are aviable in `executionReport`
-     */
-    readonly isSuccessful: boolean;
     /**
      * Added usage of whole execution, detailed usage is aviable in `executionReport`
      */
     readonly usage: ReadonlyDeep<PromptResultUsage>;
-    /**
-     * Errors that occured during the execution, details are aviable in `executionReport`
-     */
-    readonly errors: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
-    /**
-     * Warnings that occured during the execution, details are aviable in `executionReport`
-     */
-    readonly warnings: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
     /**
      * The report of the execution with all details
      */
@@ -46,5 +34,4 @@ export type PipelineExecutorResult = {
 };
 /**
  * TODO: [🧠] Should this file be in /execution or /types folder?
- * TODO: [🧠] Maybe constrain `ErrorJson` -> `ErrorJson & { name: 'PipelineExecutionError' | 'Error' }`
  */

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

@@ -1,5 +1,12 @@
 import type { string_url } from '../types/typeAliases';
 /**
- * Fetch function for fetching data from the internet used in scraping
+ * Fetch function used in Promptbook engine
+ *
+ * In most cases it is just native `fetch` function with a lightweight error handling wrapper
+ * But it can be replaced with any other fetch function, polyfill, custom implementation, security layer, etc.
+ *
+ * It is used in theese places:
+ * - Fetching knowledge sources
+ * - Callbacks from remote server ([👩🏾‍🤝‍🧑🏾] Not yet implemented)
  */
 export type PromptbookFetch = (url: string_url, init?: RequestInit) => Promise<Response>;

package/esm/typings/src/execution/{assertsExecutionSuccessful.d.ts → assertsTaskSuccessful.d.ts}

@@ -6,10 +6,9 @@ import type { PipelineExecutorResult } from './PipelineExecutorResult';
  *
  * @param executionResult - The partial result of the Promptbook execution
  * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
- * @public exported from `@promptbook/core`
+ * @private internal helper function of `asPromise` method of `ExecutionTask`
  */
-export declare function assertsExecutionSuccessful(executionResult: Pick<PipelineExecutorResult, 'isSuccessful' | 'errors' | 'warnings'>): void;
+export declare function assertsTaskSuccessful(executionResult: Pick<PipelineExecutorResult, 'isSuccessful' | 'errors' | 'warnings'>): void;
 /**
- * TODO: [🐚] This function should be removed OR changed OR be completely rewritten
  * TODO: [🧠] Can this return type be better typed than void
  */

package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts

@@ -8,6 +8,3 @@ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorO
  * @public exported from `@promptbook/core`
  */
 export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
-/**
- * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
- */

package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts

@@ -1,6 +1,5 @@
-import type { Promisable, ReadonlyDeep } from 'type-fest';
+import type { PartialDeep, Promisable, ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
-import type { TaskProgress } from '../../types/TaskProgress';
 import type { InputParameters } from '../../types/typeAliases';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
@@ -17,7 +16,7 @@ type ExecutePipelineOptions = Required<CreatePipelineExecutorOptions> & {
     /**
      * @@@
      */
-    onProgress?(taskProgress: TaskProgress): Promisable<void>;
+    onProgress?(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
     /**
      * @@@
      */
@@ -44,6 +43,3 @@ type ExecutePipelineOptions = Required<CreatePipelineExecutorOptions> & {
  */
 export declare function executePipeline(options: ExecutePipelineOptions): Promise<PipelineExecutorResult>;
 export {};
-/**
- * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
- */

package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts

@@ -1,9 +1,9 @@
-import type { Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
+import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
-import type { TaskProgress } from '../../types/TaskProgress';
 import type { Parameters } from '../../types/typeAliases';
 import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
+import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * @@@
@@ -26,7 +26,7 @@ type executeSingleTaskOptions = Required<CreatePipelineExecutorOptions> & {
     /**
      * @@@
      */
-    readonly onProgress: (taskProgress: TaskProgress) => Promisable<void>;
+    readonly onProgress: (newOngoingResult: PartialDeep<PipelineExecutorResult>) => Promisable<void>;
     /**
      * @@@
      */
@@ -46,6 +46,3 @@ export {};
 /**
  * TODO: [🤹‍♂️]
  */
-/**
- * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
- */

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

@@ -13,5 +13,5 @@ import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOpt
  */
 export declare function preparePipelineOnRemoteServer<TCustomOptions = undefined>(pipeline: PipelineJson, options: RemoteClientOptions<TCustomOptions>): Promise<PipelineJson>;
 /**
- * TODO: [🐚] Do not return Promise<PipelineJson> But PreparePipelineTask
+ * TODO: [🐚] Do not return `Promise<PipelineJson>` But `PreparationTask`
  */

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

@@ -11,6 +11,7 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
  */
 export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): IDestroyable;
 /**
+ * TODO: [👩🏾‍🤝‍🧑🏾] Allow to pass custom fetch function here - PromptbookFetch
  * TODO: Split this file into multiple functions - handler for each request
  * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`

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

@@ -556,6 +556,7 @@ export type string_javascript_name = string;
  */
 export type string_postprocessing_function_name = string;
 export type id = string | number;
+export type task_id = string;
 export type string_token = string;
 export type string_license_token = string_token;
 export type string_password = string;
@@ -588,6 +589,7 @@ export type number_tokens = number_integer & (number_positive | 0);
 export type number_positive = number;
 export type number_negative = number;
 export type number_integer = number;
+export type number_port = number_positive & number_integer;
 /**
  * Semantic helper;
  * Percentage from 0 to 1 (100%) (and bellow and above)

package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts

@@ -7,5 +7,5 @@
  */
 export declare const $isRunningInBrowser: Function;
 /**
- * TODO: [☑]
- */ 
+ * TODO: [🎺]
+ */

package/esm/typings/src/utils/environment/$isRunningInJest.d.ts

@@ -7,5 +7,5 @@
  */
 export declare const $isRunningInJest: Function;
 /**
- * TODO: [☑]
- */ 
+ * TODO: [🎺]
+ */

package/esm/typings/src/utils/environment/$isRunningInNode.d.ts

@@ -7,5 +7,5 @@
  */
 export declare const $isRunningInNode: Function;
 /**
- * TODO: [☑]
- */ 
+ * TODO: [🎺]
+ */

package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts

@@ -7,5 +7,5 @@
  */
 export declare const $isRunningInWebWorker: Function;
 /**
- * TODO: [☑]
+ * TODO: [🎺]
  */

package/esm/typings/src/utils/random/$randomSeed.d.ts

@@ -4,6 +4,7 @@ import type { number_seed } from '../../types/typeAliases';
  *
  * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
  * Warning: This function is NOT cryptographically secure (it uses Math.random internally)
- * @public exported from `@promptbook/utils`
+ *
+ * @private internal helper function
  */
 export declare function $randomSeed(): number_seed;

package/esm/typings/src/utils/random/$randomToken.d.ts

@@ -0,0 +1,13 @@
+import type { string_token } from '../../types/typeAliases';
+/**
+ * Generates random token
+ *
+ * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
+ *
+ * @private internal helper function
+ * @returns secure random token
+ */
+export declare function $randomToken(randomness: number): string_token;
+/**
+ * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
+ */

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

@@ -1,9 +1,7 @@
-import { Promisable } from 'type-fest';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { PipelineExecutorResult } from '../execution/PipelineExecutorResult';
 import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { PipelineString } from '../pipeline/PipelineString';
-import type { TaskProgress } from '../types/TaskProgress';
 import type { InputParameters } from '../types/typeAliases';
 import type { string_filename } from '../types/typeAliases';
 import type { string_parameter_value } from '../types/typeAliases';
@@ -28,7 +26,7 @@ declare class Wizzard {
      *
      * Note: This works simmilar to the `ptbk run` command
      */
-    execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
+    execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters): Promise<{
         /**
          * Simple result of the execution
          */
@@ -65,5 +63,6 @@ declare class Wizzard {
 export declare const wizzard: Wizzard;
 export {};
 /**
+ * TODO: [🧠] Maybe some way how to handle the progress and streaming?
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.84.0",
+    "version": "0.85.0-0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "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.84.0"
+        "@promptbook/core": "0.85.0-0"
     },
     "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.84.0-21';
+    var PROMPTBOOK_ENGINE_VERSION = '0.84.0';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -158,7 +158,7 @@
      */
     var $isRunningInBrowser = new Function("\n    try {\n        return this === window;\n    } catch (e) {\n        return false;\n    }\n");
     /**
-     * TODO: [☑]
+     * TODO: [🎺]
      */
 
     /**
@@ -170,7 +170,7 @@
      */
     var $isRunningInWebWorker = new Function("\n    try {\n        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {\n            return true;\n        } else {\n            return false;\n        }\n    } catch (e) {\n        return false;\n    }\n");
     /**
-     * TODO: [☑]
+     * TODO: [🎺]
      */
 
     /**