@promptbook/openai 0.84.0-9 → 0.85.0-0

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/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts

@@ -1,4 +1,13 @@
+import type { string_filename } from '../../../types/typeAliases';
 import type { string_markdown } from '../../../types/typeAliases';
+/**
+ * Pass the `.env` file which was used to configure LLM tools
+ *
+ * Note: `$` is used to indicate that this variable is making side effect
+ *
+ * @private internal log of `$provideLlmToolsConfigurationFromEnv` and `$registeredLlmToolsMessage`
+ */
+export declare function $setUsedEnvFilename(filepath: string_filename): void;
 /**
  * Creates a message with all registered LLM tools
  *

package/esm/typings/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts

@@ -0,0 +1,9 @@
+import type { createDeepSeek } from '@ai-sdk/deepseek';
+import type { VercelExecutionToolsOptions } from '../vercel/VercelExecutionToolsOptions';
+/**
+ * Options for `DeepseekExecutionTools`
+ *
+ * This combines options for Promptbook, Deepseek and Vercel together
+ * @public exported from `@promptbook/deepseek`
+ */
+export type DeepseekExecutionToolsOptions = Omit<VercelExecutionToolsOptions, 'title' | 'description' | 'vercelProvider' | 'availableModels'> & Parameters<typeof createDeepSeek>[0];

package/esm/typings/src/llm-providers/deepseek/createDeepseekExecutionTools.d.ts

@@ -0,0 +1,14 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { DeepseekExecutionToolsOptions } from './DeepseekExecutionToolsOptions';
+/**
+ * Execution Tools for calling Deepseek API.
+ *
+ * @public exported from `@promptbook/deepseek`
+ */
+export declare const createDeepseekExecutionTools: ((options: DeepseekExecutionToolsOptions) => LlmExecutionTools) & {
+    packageName: string;
+    className: string;
+};
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/llm-providers/deepseek/register-configuration.d.ts

@@ -0,0 +1,14 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _DeepseekMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/llm-providers/deepseek/register-constructor.d.ts

@@ -0,0 +1,15 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/deepseek`
+ * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _DeepseekRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/pipeline/book-notation.d.ts

@@ -2,9 +2,10 @@ import type { PipelineString } from './PipelineString';
 /**
  * Tag function for notating a pipeline with a book\`...\ notation as template literal
  *
- * Note: There are 2 similar functions:
+ * Note: There are 3 similar functions:
  * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
- * 1) `book` for notating and validating entire books exported from `@promptbook/utils`
+ * 2) `promptTemplate` alias for `prompt`
+ * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
  *
  * @param strings @@@
  * @param values @@@

package/esm/typings/src/pipeline/prompt-notation.d.ts

@@ -2,16 +2,29 @@ import type { string_prompt } from '../types/typeAliases';
 /**
  * Tag function for notating a prompt as template literal
  *
- * Note: There are 2 similar functions:
+ * Note: There are 3 similar functions:
  * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
- * 1) `book` for notating and validating entire books exported from `@promptbook/utils`
+ * 2) `promptTemplate` alias for `prompt`
+ * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
  *
- * @param strings @@@
- * @param values @@@
- * @returns the pipeline string
+ * @param strings
+ * @param values
+ * @returns the prompt string
  * @public exported from `@promptbook/utils`
  */
 export declare function prompt(strings: TemplateStringsArray, ...values: Array<string>): string_prompt;
+/**
+ * Tag function for notating a prompt as template literal
+ *
+ * Note: There are 3 similar functions:
+ * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
+ * 2) `promptTemplate` alias for `prompt`
+ * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
+ *
+ * @alias prompt
+ * @public exported from `@promptbook/utils`
+ */
+export declare const promptTemplate: typeof prompt;
 /**
  * TODO: [🧠][🈴] Where is the best location for this file
  * Note: [💞] Ignore a discrepancy between file name and entity name

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/socket-types/_subtypes/PromptbookServer_Identification.d.ts

@@ -9,7 +9,7 @@ import type { ApplicationRemoteServerClientOptions } from '../../types/RemoteSer
  */
 export type PromptbookServer_Identification<TCustomOptions> = PromptbookServer_ApplicationIdentification<TCustomOptions> | PromptbookServer_AnonymousIdentification;
 /**
- * Application mode is @@@!!!
+ * Application mode is situation when you run known and well-defined books with your own api keys
  *
  * @public exported from `@promptbook/remote-server`
  * @public exported from `@promptbook/remote-client`
@@ -21,7 +21,10 @@ export type PromptbookServer_ApplicationIdentification<TCustomOptions> = Applica
     readonly isAnonymous: false;
 };
 /**
- * Anonymous mode is @@@!!!
+ * Anonymous mode is when you run arbitrary user books without api keys from user
+ *
+ * Note: This is useful in situations when the LLM provider does not allow to call the API requests from the client side
+ *       It is kind of a proxy mode
  *
  * @public exported from `@promptbook/remote-server`
  * @public exported from `@promptbook/remote-client`

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/editable/edit-pipeline-string/deflatePipeline.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/editable/utils/isFlatPipeline.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -6,3 +6,6 @@
  * @public exported from `@promptbook/utils`
  */
 export declare const $isRunningInBrowser: Function;
+/**
+ * TODO: [🎺]
+ */

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

@@ -6,3 +6,6 @@
  * @public exported from `@promptbook/utils`
  */
 export declare const $isRunningInJest: Function;
+/**
+ * TODO: [🎺]
+ */

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

@@ -6,3 +6,6 @@
  * @public exported from `@promptbook/utils`
  */
 export declare const $isRunningInNode: Function;
+/**
+ * TODO: [🎺]
+ */

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

@@ -6,3 +6,6 @@
  * @public exported from `@promptbook/utils`
  */
 export declare const $isRunningInWebWorker: Function;
+/**
+ * TODO: [🎺]
+ */

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

@@ -0,0 +1,10 @@
+import type { string_file_extension } from '../../types/typeAliases';
+import type { string_mime_type } from '../../types/typeAliases';
+/**
+ * Convert mime type to file extension
+ *
+ * Note: If the mime type is invalid, `null` is returned
+ *
+ * @private within the repository
+ */
+export declare function mimeTypeToExtension(value: string_mime_type): string_file_extension | null;

package/esm/typings/src/utils/files/mimeTypeToExtension.test.d.ts

@@ -0,0 +1 @@
+export {};

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,11 +1,10 @@
-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';
 import type { string_pipeline_url } from '../types/typeAliases';
 /**
  * Wizzard for simple usage of the Promptbook
@@ -27,7 +26,12 @@ 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<PipelineExecutorResult>;
+    execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters): Promise<{
+        /**
+         * Simple result of the execution
+         */
+        result: string_parameter_value;
+    } & PipelineExecutorResult>;
     private executionTools;
     /**
      * Provides the tools automatically for the Node.js environment
@@ -59,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,18 +1,18 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.84.0-9",
+    "version": "0.85.0-0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
-    "--note-0": "    <- [🐊]",
     "private": false,
     "sideEffects": false,
     "repository": {
         "type": "git",
         "url": "https://github.com/webgptorg/promptbook"
     },
+    "author": "Pavol Hejný <pavol@ptbk.io> (https://www.pavolhejny.com/)",
     "contributors": [
-        "Pavol Hejný <pavol@ptbk.io> (https://www.pavolhejny.com/)"
+        "Pavol Hejný <pavol@ptbk.io> (https://www.pavolhejny.com/)",
+        "Jiří Jahn <jiri@ptbk.io> (https://www.ptbk.io/)"
     ],
-    "--todo-0": "TODO: [❇️] Make better list of keywords",
     "keywords": [
         "ai",
         "llm",
@@ -25,6 +25,9 @@
         "natural-language-processing",
         "nlp",
         "openai",
+        "o3",
+        "o3-mini",
+        "deepseek",
         "gpt-3",
         "gpt-4",
         "gpt-4o",
@@ -35,26 +38,16 @@
         "anthropic",
         "LLMOps"
     ],
-    "license": "CC-BY-4.0",
+    "license": "BUSL-1.1",
     "bugs": {
         "url": "https://github.com/webgptorg/promptbook/issues"
     },
     "homepage": "https://www.npmjs.com/package/@promptbook/core",
-    "funding": [
-        {
-            "type": "individual",
-            "url": "https://buymeacoffee.com/hejny"
-        },
-        {
-            "type": "github",
-            "url": "https://github.com/webgptorg/promptbook/blob/main/README.md#%EF%B8%8F-contributing"
-        }
-    ],
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.84.0-9"
+        "@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-8';
+    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
@@ -157,6 +157,9 @@
      * @public exported from `@promptbook/utils`
      */
     var $isRunningInBrowser = new Function("\n    try {\n        return this === window;\n    } catch (e) {\n        return false;\n    }\n");
+    /**
+     * TODO: [🎺]
+     */
 
     /**
      * Detects if the code is running in a web worker
@@ -166,6 +169,9 @@
      * @public exported from `@promptbook/utils`
      */
     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: [🎺]
+     */
 
     /**
      * This error type indicates that some part of the code is not implemented yet
@@ -1575,6 +1581,30 @@
             },
             /**/
             /**/
+            {
+                modelVariant: 'CHAT',
+                modelTitle: 'o1',
+                modelName: 'o1',
+                pricing: {
+                    prompt: computeUsage("$3.00 / 1M tokens"),
+                    output: computeUsage("$12.00 / 1M tokens"),
+                    // <- TODO: !!! Unsure, check the pricing
+                },
+            },
+            /**/
+            /**/
+            {
+                modelVariant: 'CHAT',
+                modelTitle: 'o3-mini',
+                modelName: 'o3-mini',
+                pricing: {
+                    prompt: computeUsage("$3.00 / 1M tokens"),
+                    output: computeUsage("$12.00 / 1M tokens"),
+                    // <- TODO: !!! Unsure, check the pricing
+                },
+            },
+            /**/
+            /**/
             {
                 modelVariant: 'CHAT',
                 modelTitle: 'o1-mini-2024-09-12',