@promptbook/openai 0.60.1 → 0.61.0-0

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

@@ -4,5 +4,6 @@ import type { string_html } from '../../types/typeAliases';
  *
  * @param content raw html code
  * @returns formatted html code
+ * @private withing the package because of HUGE size of prettier dependency
  */
 export declare function prettifyMarkdown<TContent extends string_html>(content: TContent): TContent;

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

@@ -0,0 +1,12 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_section } from '../../types/typeAliases';
+/**
+ * Splits the markdown into sections by headings
+ */
+export declare function splitMarkdownIntoSections(markdown: string_markdown): Array<string_markdown_section>;
+/**
+ * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
+ *       sophisticated implementation of this function through parsing markdown into JSON structure
+ *       and flattening the actual structure
+ *       NOW we are working just with markdown string and its good enough
+ */

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

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

package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts

@@ -1 +1,8 @@
-export declare function normalizeToKebabCase(sentence: string): string;
+/**
+ * Semantic helper for kebab-case strings
+ *
+ * @example 'hello-world'
+ * @example 'i-love-promptbook'
+ */
+export type string_kebab_case = string;
+export declare function normalizeToKebabCase(text: string): string_kebab_case;

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

@@ -1 +1,8 @@
-export declare function normalizeTo_PascalCase(sentence: string): string;
+/**
+ * Semantic helper for PascalCase strings
+ *
+ * @example 'HelloWorld'
+ * @example 'ILovePromptbook'
+ */
+export type string_PascalCase = string;
+export declare function normalizeTo_PascalCase(text: string): string_PascalCase;

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

@@ -1,4 +1,16 @@
-export declare function normalizeTo_SCREAMING_CASE(sentence: string): string;
 /**
+ * Semantic helper for SCREAMING_CASE strings
+ *
+ * @example 'HELLO_WORLD'
+ * @example 'I_LOVE_PROMPTBOOK'
+ */
+export type string_SCREAMING_CASE = string;
+export declare function normalizeTo_SCREAMING_CASE(text: string): string_SCREAMING_CASE;
+/**
+ * TODO: Tests
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'Moje tabule' })).toEqual('/VtG7sR9rRJqwNEdM2/Moje tabule');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'ěščřžžýáíúů' })).toEqual('/VtG7sR9rRJqwNEdM2/escrzyaieuu');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj_ahojAhoj    ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj-ahoj-ahoj-ahoj');
  * TODO: [🌺] Use some intermediate util splitWords
  */

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

@@ -1,4 +1,11 @@
-export declare function normalizeTo_camelCase(sentence: string, __firstLetterCapital?: boolean): string;
+/**
+ * Semantic helper for camelCase strings
+ *
+ * @example 'helloWorld'
+ * @example 'iLovePromptbook'
+ */
+export type string_camelCase = string;
+export declare function normalizeTo_camelCase(text: string, _isFirstLetterCapital?: boolean): string_camelCase;
 /**
  * TODO: [🌺] Use some intermediate util splitWords
  */

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

@@ -1 +1,8 @@
-export declare function normalizeTo_snake_case(sentence: string): string;
+/**
+ * Semantic helper for snake_case strings
+ *
+ * @example 'hello_world'
+ * @example 'i_love_promptbook'
+ */
+export type string_snake_case = string;
+export declare function normalizeTo_snake_case(text: string): string_snake_case;

package/esm/typings/src/{conversion/utils → utils}/parseNumber.d.ts

@@ -5,7 +5,7 @@
  * Note: it also works only with decimal numbers
  *
  * @returns parsed number
- * @throws {SyntaxError} if the value is not a number
+ * @throws {ParsingError} if the value is not a number
  *
  * @private within the parseCommand
  */

package/esm/typings/src/utils/parseNumber.test.d.ts

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

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

@@ -1,4 +1,6 @@
 /**
  * Create difference set of two sets.
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  */
 export declare function difference<TItem>(a: Set<TItem>, b: Set<TItem>, isEqual?: (a: TItem, b: TItem) => boolean): Set<TItem>;

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

@@ -1,4 +1,6 @@
 /**
  * Creates a new set with all elements that are present in all sets
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  */
 export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

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

@@ -1,4 +1,6 @@
 /**
  * Creates a new set with all elements that are present in either set
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  */
 export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/esm/typings/src/utils/validators/email/isValidEmail.d.ts

@@ -0,0 +1,5 @@
+import type { string_email } from '../../../types/typeAliases';
+/**
+ * Checks if value is valid email
+ */
+export declare function isValidEmail(email: unknown): email is string_email;

package/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts

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

package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts

@@ -0,0 +1,7 @@
+import type { string_file_path } from '../../../types/typeAliases';
+/**
+ * Tests if given string is valid URL.
+ *
+ * Note: This does not check if the file exists only if the path is valid
+ */
+export declare function isValidFilePath(filePath: unknown): filePath is string_file_path;

package/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts

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

package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts

@@ -0,0 +1,2 @@
+import type { string_javascript_name } from '../../../types/typeAliases';
+export declare function isValidJavascriptName(javascriptName: unknown): javascriptName is string_javascript_name;

package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts

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

package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts

@@ -0,0 +1,12 @@
+import type { string_promptbook_version } from '../../../version';
+/**
+ * Tests if given string is valid promptbook version
+ * It looks into list of known promptbook versions.
+ *
+ * @see https://www.npmjs.com/package/promptbook?activeTab=versions
+ * Note: When you are using for example promptbook 2.0.0 and there already is promptbook 3.0.0 it don`t know about it.
+ * Note: There are two simmilar functions:
+ * - `isValidSemanticVersion` which tests any semantic version
+ * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
+ */
+export declare function isValidPromptbookVersion(version: unknown): version is string_promptbook_version;

package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts

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

package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts

@@ -0,0 +1,9 @@
+import type { string_semantic_version } from '../../../types/typeAliases';
+/**
+ * Tests if given string is valid semantic version
+ *
+ * Note: There are two simmilar functions:
+ * - `isValidSemanticVersion` which tests any semantic version
+ * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
+ */
+export declare function isValidSemanticVersion(version: unknown): version is string_semantic_version;

package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts

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

package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts

@@ -0,0 +1,9 @@
+import type { string_hostname } from '../../../types/typeAliases';
+/**
+ * Checks if an URL is reserved for private networks or localhost.
+ *
+ * Note: There are two simmilar functions:
+ * - `isUrlOnPrivateNetwork` which tests full URL
+ * - `isHostnameOnPrivateNetwork` *(this one)* which tests just hostname
+ */
+export declare function isHostnameOnPrivateNetwork(hostname: string_hostname): boolean;

package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts

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

package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts

@@ -0,0 +1,12 @@
+import type { string_url } from '../../../types/typeAliases';
+/**
+ * Checks if an IP address or hostname is reserved for private networks or localhost.
+ *
+ * Note: There are two simmilar functions:
+ * - `isUrlOnPrivateNetwork` *(this one)* which tests full URL
+ * - `isHostnameOnPrivateNetwork` which tests just hostname
+ *
+ * @param {string} ipAddress - The IP address to check.
+ * @returns {boolean} Returns true if the IP address is reserved for private networks or localhost, otherwise false.
+ */
+export declare function isUrlOnPrivateNetwork(url: URL | string_url): boolean;

package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts

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

package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts

@@ -0,0 +1,12 @@
+import type { string_pipeline_url } from '../../../types/typeAliases';
+/**
+ * Tests if given string is valid pipeline URL URL.
+ *
+ * Note: There are two simmilar functions:
+ * - `isValidUrl` which tests any URL
+ * - `isValidPipelineUrl` *(this one)* which tests just pipeline URL
+ */
+export declare function isValidPipelineUrl(url: unknown): url is string_pipeline_url;
+/**
+ * TODO: [🐠] Maybe more info why the URL is invalid
+ */

package/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts

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

package/esm/typings/src/utils/validators/url/isValidUrl.d.ts

@@ -3,5 +3,8 @@ import type { string_url } from '../../../types/typeAliases';
  * Tests if given string is valid URL.
  *
  * Note: Dataurl are considered perfectly valid.
+ * Note: There are two simmilar functions:
+ * - `isValidUrl` which tests any URL
+ * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
  */
 export declare function isValidUrl(url: unknown): url is string_url;

package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts

@@ -0,0 +1,5 @@
+import type { string_uuid } from '../../../types/typeAliases';
+/**
+ * Checks if value is valid uuid
+ */
+export declare function isValidUuid(value: unknown): value is string_uuid;

package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts

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

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

@@ -1,5 +1,6 @@
-import type { string_version } from './types/typeAliases';
+import type { string_semantic_version } from './types/typeAliases';
 /**
  * The version of the Promptbook library
  */
-export declare const PROMPTBOOK_VERSION: string_version;
+export declare const PROMPTBOOK_VERSION: string_promptbook_version;
+export type string_promptbook_version = string_semantic_version;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.60.1",
+    "version": "0.61.0-0",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -49,7 +49,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.60.1"
+        "@promptbook/core": "0.61.0-0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -455,6 +455,7 @@
         /**/
     ];
     /**
+     * Note: [🤖] Add models of new variant
      * TODO: [🧠] Some mechanism to propagate unsureness
      * TODO: [🕚][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
      * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
@@ -468,15 +469,15 @@
     /**
      * This error indicates errors during the execution of the pipeline
      */
-    var ExecutionError = /** @class */ (function (_super) {
-        __extends(ExecutionError, _super);
-        function ExecutionError(message) {
+    var PipelineExecutionError = /** @class */ (function (_super) {
+        __extends(PipelineExecutionError, _super);
+        function PipelineExecutionError(message) {
             var _this = _super.call(this, message) || this;
-            _this.name = 'ExecutionError';
-            Object.setPrototypeOf(_this, ExecutionError.prototype);
+            _this.name = 'PipelineExecutionError';
+            Object.setPrototypeOf(_this, PipelineExecutionError.prototype);
             return _this;
         }
-        return ExecutionError;
+        return PipelineExecutionError;
     }(Error));
 
     /**
@@ -855,17 +856,17 @@
      * @param promptContent The content of the prompt
      * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
      * @param rawResponse The raw response from OpenAI API
-     * @throws {ExecutionError} If the usage is not defined in the response from OpenAI
+     * @throws {PipelineExecutionError} If the usage is not defined in the response from OpenAI
      * @private internal util of `OpenAiExecutionTools`
      */
     function computeOpenaiUsage(promptContent, // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
     resultContent, rawResponse) {
         var _a, _b;
         if (rawResponse.usage === undefined) {
-            throw new ExecutionError('The usage is not defined in the response from OpenAI');
+            throw new PipelineExecutionError('The usage is not defined in the response from OpenAI');
         }
         if (((_a = rawResponse.usage) === null || _a === void 0 ? void 0 : _a.prompt_tokens) === undefined) {
-            throw new ExecutionError('In OpenAI response `usage.prompt_tokens` not defined');
+            throw new PipelineExecutionError('In OpenAI response `usage.prompt_tokens` not defined');
         }
         var inputTokens = rawResponse.usage.prompt_tokens;
         var outputTokens = ((_b = rawResponse.usage) === null || _b === void 0 ? void 0 : _b.completion_tokens) || 0;
@@ -902,6 +903,20 @@
             delete openAiOptions.user;
             this.client = new OpenAI__default["default"](__assign({}, openAiOptions));
         }
+        Object.defineProperty(OpenAiExecutionTools.prototype, "title", {
+            get: function () {
+                return 'OpenAI';
+            },
+            enumerable: false,
+            configurable: true
+        });
+        Object.defineProperty(OpenAiExecutionTools.prototype, "description", {
+            get: function () {
+                return 'Use all models provided by OpenAI';
+            },
+            enumerable: false,
+            configurable: true
+        });
         /**
          * Calls OpenAI API to use a chat model.
          */
@@ -917,7 +932,7 @@
                             content = prompt.content, modelRequirements = prompt.modelRequirements, expectFormat = prompt.expectFormat;
                             // TODO: [☂] Use here more modelRequirements
                             if (modelRequirements.modelVariant !== 'CHAT') {
-                                throw new ExecutionError('Use callChatModel only for CHAT variant');
+                                throw new PipelineExecutionError('Use callChatModel only for CHAT variant');
                             }
                             model = modelRequirements.modelName || this.getDefaultChatModel().modelName;
                             modelSettings = {
@@ -947,18 +962,18 @@
                                 console.info(colors__default["default"].bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
                             }
                             if (!rawResponse.choices[0]) {
-                                throw new ExecutionError('No choises from OpenAI');
+                                throw new PipelineExecutionError('No choises from OpenAI');
                             }
                             if (rawResponse.choices.length > 1) {
                                 // TODO: This should be maybe only warning
-                                throw new ExecutionError('More than one choise from OpenAI');
+                                throw new PipelineExecutionError('More than one choise from OpenAI');
                             }
                             resultContent = rawResponse.choices[0].message.content;
                             // eslint-disable-next-line prefer-const
                             complete = getCurrentIsoDate();
                             usage = computeOpenaiUsage(content, resultContent || '', rawResponse);
                             if (resultContent === null) {
-                                throw new ExecutionError('No response message from OpenAI');
+                                throw new PipelineExecutionError('No response message from OpenAI');
                             }
                             return [2 /*return*/, {
                                     content: resultContent,
@@ -990,7 +1005,7 @@
                             content = prompt.content, modelRequirements = prompt.modelRequirements;
                             // TODO: [☂] Use here more modelRequirements
                             if (modelRequirements.modelVariant !== 'COMPLETION') {
-                                throw new ExecutionError('Use callCompletionModel only for COMPLETION variant');
+                                throw new PipelineExecutionError('Use callCompletionModel only for COMPLETION variant');
                             }
                             model = modelRequirements.modelName || this.getDefaultCompletionModel().modelName;
                             modelSettings = {
@@ -1010,11 +1025,11 @@
                                 console.info(colors__default["default"].bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
                             }
                             if (!rawResponse.choices[0]) {
-                                throw new ExecutionError('No choises from OpenAI');
+                                throw new PipelineExecutionError('No choises from OpenAI');
                             }
                             if (rawResponse.choices.length > 1) {
                                 // TODO: This should be maybe only warning
-                                throw new ExecutionError('More than one choise from OpenAI');
+                                throw new PipelineExecutionError('More than one choise from OpenAI');
                             }
                             resultContent = rawResponse.choices[0].text;
                             // eslint-disable-next-line prefer-const
@@ -1038,7 +1053,7 @@
         /**
          * Calls OpenAI API to use a embedding model
          */
-        OpenAiExecutionTools.prototype.embed = function (prompt) {
+        OpenAiExecutionTools.prototype.callEmbeddingModel = function (prompt) {
             return __awaiter(this, void 0, void 0, function () {
                 var content, modelRequirements, model, rawRequest, start, complete, rawResponse, resultContent, usage;
                 return __generator(this, function (_a) {
@@ -1050,7 +1065,7 @@
                             content = prompt.content, modelRequirements = prompt.modelRequirements;
                             // TODO: [☂] Use here more modelRequirements
                             if (modelRequirements.modelVariant !== 'EMBEDDING') {
-                                throw new ExecutionError('Use embed only for EMBEDDING variant');
+                                throw new PipelineExecutionError('Use embed only for EMBEDDING variant');
                             }
                             model = modelRequirements.modelName || this.getDefaultEmbeddingModel().modelName;
                             rawRequest = {
@@ -1069,7 +1084,7 @@
                                 console.info(colors__default["default"].bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
                             }
                             if (rawResponse.data.length !== 1) {
-                                throw new ExecutionError("Expected exactly 1 data item in response, got ".concat(rawResponse.data.length));
+                                throw new PipelineExecutionError("Expected exactly 1 data item in response, got ".concat(rawResponse.data.length));
                             }
                             resultContent = rawResponse.data[0].embedding;
                             // eslint-disable-next-line prefer-const
@@ -1090,6 +1105,7 @@
                 });
             });
         };
+        // <- Note: [🤖] callXxxModel
         /**
          * Get the model that should be used as default
          */
@@ -1126,6 +1142,7 @@
         OpenAiExecutionTools.prototype.getDefaultEmbeddingModel = function () {
             return this.getDefaultModel('text-embedding-3-large');
         };
+        // <- Note: [🤖] getDefaultXxxModel
         /**
          * List all available OpenAI models that can be used
          */
@@ -1151,6 +1168,7 @@
      * The version of the Promptbook library
      */
     var PROMPTBOOK_VERSION = '0.60.0';
+    // TODO: !!!! List here all the versions and annotate + put into script
 
     exports.OPENAI_MODELS = OPENAI_MODELS;
     exports.OpenAiExecutionTools = OpenAiExecutionTools;