@promptbook/openai 0.100.4-0 → 0.101.0-1

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

@@ -0,0 +1,11 @@
+/**
+ * Removes Markdown link tags from a string.
+ *
+ * @param {string} str - The string to remove Markdown tags from.
+ * @returns {string} The input string with all Markdown tags removed.
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function removeMarkdownLinks(str: string): string;
+/**
+ * @see https://chat.openai.com/chat/bb7c3a5b-fe9c-4ccc-9057-f47e0fd66489
+ */

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

@@ -0,0 +1,4 @@
+export {};
+/**
+ * @see https://chat.openai.com/chat/bb7c3a5b-fe9c-4ccc-9057-f47e0fd66489
+ */

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

@@ -1,6 +1,8 @@
 /**
  * Makes first letter of a string uppercase
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function capitalize(word: string): string;

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

@@ -1,5 +1,7 @@
 /**
- * Makes first letter of a string uppercase
+ * Makes first letter of a string lowercase
+ *
+ * Note: [🔂] This function is idempotent.
  *
  * @public exported from `@promptbook/utils`
  */

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

@@ -9,6 +9,8 @@ export type string_SCREAMING_CASE = string;
 /**
  * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text The text string to be converted to SCREAMING_CASE format.
  * @returns The normalized text in SCREAMING_CASE format.
  * @example 'HELLO_WORLD'

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

@@ -8,6 +8,8 @@ export type string_snake_case = string;
 /**
  * Normalizes a text string to snake_case format.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text The text string to be converted to snake_case format.
  * @returns The normalized text in snake_case format.
  * @example 'hello_world'

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

@@ -1,6 +1,8 @@
 /**
  * Take every whitespace (space, new line, tab) and replace it with a single space
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function normalizeWhitespaces(sentence: string): string;

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

@@ -1,6 +1,8 @@
 /**
  * Removes diacritic marks (accents) from characters in a string.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param input The string containing diacritics to be normalized.
  * @returns The string with diacritics removed or normalized.
  * @public exported from `@promptbook/utils`

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

@@ -1,6 +1,7 @@
 /**
  * Function parseNumber will parse number from string
  *
+ * Note: [🔂] This function is idempotent.
  * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
  * Note: it also works only with decimal numbers
  *

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

@@ -1,6 +1,8 @@
 /**
  * Removes emojis from a string and fix whitespaces
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text with emojis
  * @returns text without emojis
  * @public exported from `@promptbook/utils`

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

@@ -1,6 +1,7 @@
 /**
  * Removes quotes from a string
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: This is very useful for post-processing of the result of the LLM model
  * Note: This function removes only the same quotes from the beginning and the end of the string
  * Note: There are two similar functions:

package/esm/typings/src/utils/serialization/deepClone.d.ts

@@ -2,6 +2,7 @@ import type { WritableDeep } from 'type-fest';
 /**
  * Creates a deep clone of the given object
  *
+ * Note: [🔂] This function is idempotent.
  * Note: This method only works for objects that are fully serializable to JSON and do not contain functions, Dates, or special types.
  *
  * @param objectValue The object to clone.

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

@@ -1,6 +1,7 @@
 /**
  * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
  *
+ * Note: [🔂] This function is idempotent.
  * Note: This is useful for post-processing of the result of the chat LLM model
  *       when the model wraps the result in the (markdown) code block.
  *

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

@@ -3,6 +3,7 @@ import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid URL.
  *
+ * Note: [🔂] This function is idempotent.
  * Note: Dataurl are considered perfectly valid.
  * Note: There are two similar functions:
  * - `isValidUrl` which tests any URL

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

@@ -3,6 +3,8 @@ import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Checks if value is valid uuid
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function isValidUuid(value: really_unknown): value is string_uuid;

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.100.3-0`).
+ * It follows semantic versioning (e.g., `0.101.0-0`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.100.4-0",
+    "version": "0.101.0-1",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -102,7 +102,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.100.4-0"
+        "@promptbook/core": "0.101.0-1"
     },
     "dependencies": {
         "bottleneck": "^2.19.5",

package/umd/index.umd.js

@@ -25,7 +25,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.100.4-0';
+    const PROMPTBOOK_ENGINE_VERSION = '0.101.0-1';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -600,6 +600,7 @@
     /**
      * Creates a deep clone of the given object
      *
+     * Note: [🔂] This function is idempotent.
      * Note: This method only works for objects that are fully serializable to JSON and do not contain functions, Dates, or special types.
      *
      * @param objectValue The object to clone.
@@ -937,7 +938,7 @@
     };
     /**
      * TODO: Refactor this - each profile must be alongside the provider definition
-     * TODO: [🕛] Unite `AvatarProfileProps`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`
+     * TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
@@ -957,6 +958,7 @@
     }
     /**
      * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     * TODO: [🧠][✌️] Make some Promptbook-native token system
      */
 
     /**
@@ -991,6 +993,7 @@
     }
     /**
      * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     * TODO: [🧠][✌️] Make some Promptbook-native token system
      */
 
     /**
@@ -1005,6 +1008,7 @@
     }
     /**
      * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     * TODO: [🧠][✌️] Make some Promptbook-native token system
      */
 
     /**
@@ -1017,6 +1021,7 @@
     }
     /**
      * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     * TODO: [🧠][✌️] Make some Promptbook-native token system
      */
 
     /**
@@ -1037,6 +1042,7 @@
     }
     /**
      * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     * TODO: [🧠][✌️] Make some Promptbook-native token system
      */
 
     const defaultDiacriticsRemovalMap = [
@@ -1286,6 +1292,8 @@
     /**
      * Removes diacritic marks (accents) from characters in a string.
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @param input The string containing diacritics to be normalized.
      * @returns The string with diacritics removed or normalized.
      * @public exported from `@promptbook/utils`
@@ -1314,6 +1322,8 @@
     }
     /**
      * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     * TODO: [🧠][✌️] Make some Promptbook-native token system
+     * TODO: [✌️] `countWords` should be just `splitWords(...).length`, and all other counters should use this pattern as well
      */
 
     /**
@@ -2938,6 +2948,7 @@
     /**
      * Tests if given string is valid URL.
      *
+     * Note: [🔂] This function is idempotent.
      * Note: Dataurl are considered perfectly valid.
      * Note: There are two similar functions:
      * - `isValidUrl` which tests any URL
@@ -3268,6 +3279,8 @@
     /**
      * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @param text The text string to be converted to SCREAMING_CASE format.
      * @returns The normalized text in SCREAMING_CASE format.
      * @example 'HELLO_WORLD'
@@ -3323,6 +3336,8 @@
     /**
      * Normalizes a text string to snake_case format.
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @param text The text string to be converted to snake_case format.
      * @returns The normalized text in snake_case format.
      * @example 'hello_world'