@promptbook/openai 0.72.0-9 → 0.73.0

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

@@ -350,12 +350,6 @@ export type string_uri = string;
  * For example `"9SeSQTupmQHwuSrLi"`
  */
 export type string_uri_part = string;
-/**
- * Semantic helper, ID of the board used in URL and API
- *
- * For example `"9SeSQTupmQHwuSrLi"` <- TODO: !! Update
- */
-export type string_uriid = string_uri_part;
 /**
  * Semantic helper
  *
@@ -399,9 +393,17 @@ export type string_uuid = string & {
     readonly _type: 'uuid';
 };
 /**
- * End user identifier;
+ * Application identifier
+ *
+ * @@@
+ */
+export type string_app_id = id;
+/**
+ * End user identifier
+ *
+ * @@@
  */
-export type string_user_id = string;
+export type string_user_id = id;
 /**
  * Semantic helper
  *
@@ -523,6 +525,7 @@ export type string_javascript_name = string;
  * Semantic helper; For example "unwrapResult" or "spaceTrim"
  */
 export type string_postprocessing_function_name = string;
+export type id = string | number;
 export type string_token = string;
 export type string_license_token = string_token;
 export type string_password = string;

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

@@ -34,6 +34,6 @@ export declare class $Register<TRegistered extends Registered> {
     private readonly registerName;
     private readonly storage;
     constructor(registerName: string_name);
-    list(): Array<TRegistered>;
+    list(): ReadonlyArray<TRegistered>;
     register(registered: TRegistered): Registration;
 }

package/esm/typings/src/utils/FromtoItems.d.ts

@@ -1,7 +1,7 @@
 /**
  * Represents items which are compared to each other
  */
-export type FromtoItems = Array<{
+export type FromtoItems = ReadonlyArray<{
     /**
      * The title of the item
      */

package/esm/typings/src/utils/arrayableToArray.d.ts

@@ -8,4 +8,4 @@ import type { Arrayable } from '../types/Arrayable';
  *
  * @private internal utility
  */
-export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): Array<TItem>;
+export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): ReadonlyArray<TItem>;

package/esm/typings/src/utils/emojis.d.ts

@@ -8,7 +8,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
  * @private within the repository
  * @deprecated Use /\p{Extended_Pictographic}/ instead
  */
-export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
+export declare const EMOJIS_IN_CATEGORIES: Record<string, ReadonlyArray<string_char_emoji>>;
 /**
  *
  * All possible emoji chars like "🍆", "🍡", "🍤"...

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

@@ -1,14 +1,16 @@
-import type { IExecCommandOptions } from './IExecCommandOptions';
+import type { ExecCommandOptions } from './ExecCommandOptions';
 /**
  * Run one command in a shell
  *
+ *
  * Note: There are 2 similar functions in the codebase:
  * - `$execCommand` which runs a single command
  * - `$execCommands` which runs multiple commands
+ * Note: `$` is used to indicate that this function is not a pure function - it runs a command in a shell
  *
  * @public exported from `@promptbook/node`
  */
-export declare function $execCommand(options: IExecCommandOptions): Promise<string>;
+export declare function $execCommand(options: ExecCommandOptions): Promise<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/$execCommandNormalizeOptions.d.ts

@@ -0,0 +1,12 @@
+import type { ExecCommandOptions } from './ExecCommandOptions';
+import type { ExecCommandOptionsAdvanced } from './ExecCommandOptions';
+/**
+ * Normalize options for `execCommand` and `execCommands`
+ *
+ * Note: `$` is used to indicate that this function behaves differently according to `process.platform`
+ *
+ * @private internal utility of `execCommand` and `execCommands`
+ */
+export declare function $execCommandNormalizeOptions(options: ExecCommandOptions): Pick<ExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose'> & {
+    humanReadableCommand: string;
+};

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

@@ -4,6 +4,7 @@
  * Note: There are 2 similar functions in the codebase:
  * - `$execCommand` which runs a single command
  * - `$execCommands` which runs multiple commands
+ * Note: `$` is used to indicate that this function is not a pure function - it runs a commands in a shell
  *
  * @public exported from `@promptbook/node`
  */

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

@@ -0,0 +1,45 @@
+/**
+ * @deprecated Use sth from type-fest or move this to type helpers
+ */
+type RequiredAndOptional<TBase, TRequired extends keyof TBase, TOptional extends keyof TBase> = Pick<TBase, TRequired> & Partial<Pick<TBase, TOptional>>;
+/**
+ * Simple options for `execCommand`
+ */
+export type ExecCommandOptions = string | RequiredAndOptional<ExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose'>;
+/**
+ * Advanced options for `execCommand`
+ */
+export type ExecCommandOptionsAdvanced = {
+    /**
+     * Command to run
+     */
+    readonly command: string;
+    /**
+     * Arguments for the command
+     */
+    readonly args: string[];
+    /**
+     * Current working directory
+     *
+     * @default process.cwd()
+     */
+    readonly cwd: string;
+    /**
+     * If `true` then the command will throw an error if the return code is not `0`
+     */
+    readonly crashOnError: boolean;
+    /**
+     * Timeout in milliseconds
+     */
+    readonly timeout: number;
+    /**
+     * If `true` then the command and entire CLI output will be logged to the console
+     *
+     * @default false
+     */
+    readonly isVerbose?: boolean;
+};
+export {};
+/**
+ * TODO: [⏳] Make DEFAULT_TIMEOUT_MS as global constant
+ */

package/esm/typings/src/utils/expectation-counters/countSentences.d.ts

@@ -4,7 +4,7 @@ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
  *
  * @public exported from `@promptbook/utils`
  */
-export declare function splitIntoSentences(text: string): Array<string>;
+export declare function splitIntoSentences(text: string): ReadonlyArray<string>;
 /**
  * Counts number of sentences in the text
  *

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

@@ -0,0 +1,11 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+/**
+ * Checks if the file is executable
+ *
+ * @private within the repository
+ */
+export declare function isExecutable(path: string, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🖇] What about symlinks?
+ */

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -30,7 +30,7 @@ export type CodeBlock = {
  * @throws {ParseError} if block is not closed properly
  * @public exported from `@promptbook/markdown-utils`
  */
-export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;
+export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): ReadonlyArray<CodeBlock>;
 /**
  * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
  */

package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts

@@ -5,7 +5,7 @@ import type { string_markdown_section } from '../../types/typeAliases';
  *
  * @public exported from `@promptbook/markdown-utils`
  */
-export declare function splitMarkdownIntoSections(markdown: string_markdown): Array<string_markdown_section>;
+export declare function splitMarkdownIntoSections(markdown: string_markdown): ReadonlyArray<string_markdown_section>;
 /**
  * TODO: [🏛] This can be part of markdown builder
  * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more

package/esm/typings/src/utils/normalization/IKeywords.d.ts

@@ -2,7 +2,7 @@
  * Semantic helper
  *
  * Keyword is string without diacritics in lowercase [a-z1-9]
- * Words are splitted between multiple keywords @see IKeywords
+ * Words are splitted between multiple keywords @see Keywords
  *
  * For example `"keyword"`
  *
@@ -15,7 +15,7 @@ export type string_keyword = string;
  *
  * @public exported from `@promptbook/utils`
  */
-export type IKeywords = Set<string_keyword>;
+export type Keywords = Set<string_keyword>;
 /**
  * TODO: [🌮] Keywords with weight
  */

package/esm/typings/src/utils/normalization/parseKeywords.d.ts

@@ -1,5 +1,5 @@
 import type { really_unknown } from '../organization/really_unknown';
-import type { IKeywords } from './IKeywords';
+import type { Keywords } from './IKeywords';
 /**
  * Parses keywords from any object and recursively walks through
  *
@@ -9,7 +9,7 @@ import type { IKeywords } from './IKeywords';
  * @returns {Set} of keywords without diacritics in lowercase
  * @public exported from `@promptbook/utils`
  */
-export declare function parseKeywords(input: really_unknown): IKeywords;
+export declare function parseKeywords(input: really_unknown): Keywords;
 /**
  * Note: Not using spread in input param because of keeping second parameter for options
  * TODO: [🌺] Use some intermediate util splitWords

package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts

@@ -1,4 +1,4 @@
-import type { IKeywords } from './IKeywords';
+import type { Keywords } from './IKeywords';
 /**
  * Parses keywords from a string
  *
@@ -6,4 +6,4 @@ import type { IKeywords } from './IKeywords';
  * @returns {Set} of keywords without diacritics in lowercase
  * @public exported from `@promptbook/utils`
  */
-export declare function parseKeywordsFromString(input: string): IKeywords;
+export declare function parseKeywordsFromString(input: string): Keywords;

package/esm/typings/src/utils/normalization/searchKeywords.d.ts

@@ -1,4 +1,4 @@
-import type { IKeywords } from './IKeywords';
+import type { Keywords } from './IKeywords';
 /**
  * @@@
  *
@@ -7,4 +7,4 @@ import type { IKeywords } from './IKeywords';
  * @returns
  * @public exported from `@promptbook/utils`
  */
-export declare function searchKeywords(haystack: IKeywords, needle: IKeywords): boolean;
+export declare function searchKeywords(haystack: Keywords, needle: Keywords): boolean;

package/esm/typings/src/utils/organization/TODO_USE.d.ts

@@ -9,4 +9,4 @@ import type { really_any } from './really_any';
  * @returns void
  * @private within the repository
  */
-export declare function TODO_USE(...value: Array<really_any>): void;
+export declare function TODO_USE(...value: ReadonlyArray<really_any>): void;

package/esm/typings/src/utils/organization/keepUnused.d.ts

@@ -13,4 +13,4 @@ import type { really_any } from './really_any';
  * @returns void
  * @private within the repository
  */
-export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: Array<really_any>): void;
+export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: ReadonlyArray<really_any>): void;

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

@@ -3,7 +3,7 @@ import type { number_seed } from '../../types/typeAliases';
  * Generates random seed
  *
  * 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)
+ * Warning: This function is NOT cryptographically secure (it uses Math.random internally)
  * @public exported from `@promptbook/utils`
  */
 export declare function $randomSeed(): number_seed;

package/esm/typings/src/utils/sets/intersection.d.ts

@@ -4,4 +4,4 @@
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  * @public exported from `@promptbook/utils`
  */
-export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
+export declare function intersection<TItem>(...sets: ReadonlyArray<Set<TItem>>): Set<TItem>;

package/esm/typings/src/utils/sets/union.d.ts

@@ -4,4 +4,4 @@
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  * @public exported from `@promptbook/utils`
  */
-export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
+export declare function union<TItem>(...sets: ReadonlyArray<Set<TItem>>): Set<TItem>;

package/esm/typings/src/utils/unwrapResult.d.ts

@@ -1,11 +1,11 @@
 /**
  * Additional options for `unwrapResult`
  */
-interface UnwrapResultOptions {
+type UnwrapResultOptions = {
     /**
      * If true, the text is trimmed before processing
      */
-    isTrimmed?: boolean;
+    readonly isTrimmed?: boolean;
     /**
      * If true, the introduce sentence is removed
      *
@@ -15,8 +15,8 @@ interface UnwrapResultOptions {
      *
      * @default true
      */
-    isIntroduceSentenceRemoved?: boolean;
-}
+    readonly isIntroduceSentenceRemoved?: boolean;
+};
 /**
  * Removes quotes and optional introduce text from a string
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.72.0-9",
+    "version": "0.73.0",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -11,6 +11,7 @@
     "contributors": [
         "Pavol Hejný <me@pavolhejny.com> (https://www.pavolhejny.com/)"
     ],
+    "todo-0": "TODO: [❇️] Make better list of keywords",
     "keywords": [
         "ai",
         "llm",
@@ -30,7 +31,8 @@
         "o1",
         "o1-mini",
         "o1-preview",
-        "anthropic"
+        "anthropic",
+        "LLMOps"
     ],
     "license": "CC-BY-4.0",
     "bugs": {
@@ -51,11 +53,11 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.72.0-9"
+        "@promptbook/core": "0.73.0"
     },
     "dependencies": {
         "colors": "1.4.0",
         "openai": "4.63.0",
-        "spacetrim": "0.11.39"
+        "spacetrim": "0.11.59"
     }
 }

package/umd/index.umd.js

@@ -14,7 +14,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.72.0-8';
+    var PROMPTBOOK_VERSION = '0.72.0';
     // TODO: [main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -463,10 +463,10 @@
         'content',
         'context',
         'knowledge',
-        'samples',
+        'examples',
         'modelName',
         'currentDate',
-        // <- TODO: !!!!! list here all command names
+        // <- TODO: list here all command names
         // <- TODO: Add more like 'date', 'modelName',...
         // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
     ]);
@@ -1421,7 +1421,6 @@
          * @param options which are relevant are directly passed to the OpenAI client
          */
         function OpenAiExecutionTools(options) {
-            if (options === void 0) { options = {}; }
             this.options = options;
             /**
              * OpenAI API client.
@@ -1449,8 +1448,8 @@
                     if (this.client === null) {
                         openAiOptions = __assign({}, this.options);
                         delete openAiOptions.isVerbose;
-                        delete openAiOptions.user;
-                        this.client = new OpenAI__default["default"](__assign({}, openAiOptions));
+                        delete openAiOptions.userId;
+                        this.client = new OpenAI__default["default"](openAiOptions);
                     }
                     return [2 /*return*/, this.client];
                 });
@@ -1497,11 +1496,12 @@
          * Calls OpenAI API to use a chat model.
          */
         OpenAiExecutionTools.prototype.callChatModel = function (prompt) {
+            var _a;
             return __awaiter(this, void 0, void 0, function () {
                 var content, parameters, modelRequirements, format, client, modelName, modelSettings, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
                 var _this = this;
-                return __generator(this, function (_a) {
-                    switch (_a.label) {
+                return __generator(this, function (_b) {
+                    switch (_b.label) {
                         case 0:
                             if (this.options.isVerbose) {
                                 console.info('💬 OpenAI callChatModel call', { prompt: prompt });
@@ -1509,7 +1509,7 @@
                             content = prompt.content, parameters = prompt.parameters, modelRequirements = prompt.modelRequirements, format = prompt.format;
                             return [4 /*yield*/, this.getClient()];
                         case 1:
-                            client = _a.sent();
+                            client = _b.sent();
                             // TODO: [☂] Use here more modelRequirements
                             if (modelRequirements.modelVariant !== 'CHAT') {
                                 throw new PipelineExecutionError('Use callChatModel only for CHAT variant');
@@ -1541,7 +1541,7 @@
                                         role: 'user',
                                         content: rawPromptContent,
                                     },
-                                ], false), user: this.options.user });
+                                ], false), user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString() });
                             start = getCurrentIsoDate();
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
@@ -1553,7 +1553,7 @@
                                     throw error;
                                 })];
                         case 2:
-                            rawResponse = _a.sent();
+                            rawResponse = _b.sent();
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
                             }
@@ -1592,11 +1592,12 @@
          * Calls OpenAI API to use a complete model.
          */
         OpenAiExecutionTools.prototype.callCompletionModel = function (prompt) {
+            var _a;
             return __awaiter(this, void 0, void 0, function () {
                 var content, parameters, modelRequirements, client, modelName, modelSettings, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
                 var _this = this;
-                return __generator(this, function (_a) {
-                    switch (_a.label) {
+                return __generator(this, function (_b) {
+                    switch (_b.label) {
                         case 0:
                             if (this.options.isVerbose) {
                                 console.info('🖋 OpenAI callCompletionModel call', { prompt: prompt });
@@ -1604,7 +1605,7 @@
                             content = prompt.content, parameters = prompt.parameters, modelRequirements = prompt.modelRequirements;
                             return [4 /*yield*/, this.getClient()];
                         case 1:
-                            client = _a.sent();
+                            client = _b.sent();
                             // TODO: [☂] Use here more modelRequirements
                             if (modelRequirements.modelVariant !== 'COMPLETION') {
                                 throw new PipelineExecutionError('Use callCompletionModel only for COMPLETION variant');
@@ -1619,7 +1620,7 @@
                                 // <- Note: [🧆]
                             };
                             rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
-                            rawRequest = __assign(__assign({}, modelSettings), { prompt: rawPromptContent, user: this.options.user });
+                            rawRequest = __assign(__assign({}, modelSettings), { prompt: rawPromptContent, user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString() });
                             start = getCurrentIsoDate();
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
@@ -1631,7 +1632,7 @@
                                     throw error;
                                 })];
                         case 2:
-                            rawResponse = _a.sent();
+                            rawResponse = _b.sent();
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
                             }
@@ -1857,17 +1858,16 @@
                                 assistant_id: this.assistantId,
                                 thread: {
                                     messages: [
-                                        // TODO: !!!!!! Allow threads to be passed
+                                        // TODO:  [🗯] !! Allow threads to be passed
                                         { role: 'user', content: rawPromptContent },
                                     ],
                                 },
-                                // !!!!!! user: this.options.user,
+                                // <- TODO: Add user identification here> user: this.options.user,
                             };
                             start = getCurrentIsoDate();
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                             }
-                            console.log('!!!!!! OpenAI client', client);
                             return [4 /*yield*/, client.beta.threads.createAndRunStream(rawRequest)];
                         case 2:
                             stream = _g.sent();
@@ -1885,7 +1885,7 @@
                                     messageDelta.content[0].type === 'text') {
                                     console.info('messageDelta', (_a = messageDelta.content[0].text) === null || _a === void 0 ? void 0 : _a.value);
                                 }
-                                // TODO: !!!!!! report progress
+                                // <- TODO: [🐚] Make streaming and running tasks working
                             });
                             stream.on('messageCreated', function (message) {
                                 if (_this.options.isVerbose) {
@@ -1913,18 +1913,20 @@
                                 throw new PipelineExecutionError("There is NOT 'text' BUT ".concat((_b = rawResponse[0].content[0]) === null || _b === void 0 ? void 0 : _b.type, " finalMessages content type from OpenAI"));
                             }
                             resultContent = (_c = rawResponse[0].content[0]) === null || _c === void 0 ? void 0 : _c.text.value;
-                            //                                                     <- TODO: !!!!!! There are also annotations, maybe use them
+                            //                                                     <- TODO: [🧠] There are also annotations, maybe use them
                             // eslint-disable-next-line prefer-const
                             complete = getCurrentIsoDate();
                             usage = UNCERTAIN_USAGE;
-                            // TODO: !!!!!!> = computeOpenAiUsage(content, resultContent || '', rawResponse);
+                            // <- TODO: [🥘] Compute real usage for assistant
+                            //       ?> const usage = computeOpenAiUsage(content, resultContent || '', rawResponse);
                             if (resultContent === null) {
                                 throw new PipelineExecutionError('No response message from OpenAI');
                             }
                             return [2 /*return*/, $asDeeplyFrozenSerializableJson('OpenAiAssistantExecutionTools ChatPromptResult', {
                                     content: resultContent,
                                     modelName: 'assistant',
-                                    //          <- TODO: !!!!!! Can we detect really used model: rawResponse.model || modelName,
+                                    // <- TODO: [🥘] Detect used model in assistant
+                                    //       ?> model: rawResponse.model || modelName,
                                     timing: {
                                         start: start,
                                         complete: complete,
@@ -1942,7 +1944,6 @@
         return OpenAiAssistantExecutionTools;
     }(OpenAiExecutionTools));
     /**
-     * TODO: !!!!!! DO not use colors - can be used in browser
      * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
      * TODO: Maybe make custom OpenAiError
      * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
@@ -2100,7 +2101,7 @@
             this.storage = globalScope[storageName];
         }
         $Register.prototype.list = function () {
-            // <- TODO: ReadonlyDeep<Array<TRegistered>>
+            // <- TODO: ReadonlyDeep<ReadonlyArray<TRegistered>>
             return this.storage;
         };
         $Register.prototype.register = function (registered) {