@promptbook/remote-client 0.92.0-24 → 0.92.0-25

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

@@ -1,9 +1,9 @@
 /**
- * @@@
+ * Converts a title string into a normalized name.
  *
- * @param value @@@
- * @returns @@@
- * @example @@@
+ * @param value The title string to be converted to a name.
+ * @returns A normalized name derived from the input title.
+ * @example 'Hello World!' -> 'hello-world'
  * @public exported from `@promptbook/utils`
  */
 export declare function titleToName(value: string): string;

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

@@ -2,8 +2,8 @@
  * Organizational helper to better mark the place where to really use empty object `{}`
  *
  * Note: There are 2 similar types>
- * - `empty_object` @@@
- * - `just_empty_object` @@@
+ * - `empty_object` Type used for empty data objects allowing for potential future extensions
+ * - `just_empty_object` Type used when an object must remain permanently empty
  *
  * @private within the repository
  */

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

@@ -1,9 +1,9 @@
 /**
- * Organizational helper to better @@@@
+ * Organizational helper to better distinguish different empty object use cases.
  *
- * Note: There are 2 similar types>
- * - `empty_object` @@@
- * - `just_empty_object` @@@
+ * Note: There are 2 similar types:
+ * - `empty_object` Type used for empty data objects with potential extensions
+ * - `just_empty_object` Type used specifically for objects that must remain empty
  *
  * Note: In most cases, you should use `empty_object`
  *

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

@@ -14,7 +14,8 @@ 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.92.0-24`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-client",
-    "version": "0.92.0-24",
+    "version": "0.92.0-25",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -51,7 +51,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/remote-client.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-24"
+        "@promptbook/core": "0.92.0-25"
     },
     "dependencies": {
         "crypto": "1.0.1",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-24';
+    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-25';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -996,10 +996,10 @@
     */
 
     /**
-     * @@@
+     * Removes diacritic marks (accents) from characters in a string.
      *
-     * @param input @@@
-     * @returns @@@
+     * @param input The string containing diacritics to be normalized.
+     * @returns The string with diacritics removed or normalized.
      * @public exported from `@promptbook/utils`
      */
     function removeDiacritics(input) {
@@ -1013,10 +1013,10 @@
      */
 
     /**
-     * @@@
+     * Converts a given text to kebab-case format.
      *
-     * @param text @@@
-     * @returns @@@
+     * @param text The text to be converted.
+     * @returns The kebab-case formatted string.
      * @example 'hello-world'
      * @example 'i-love-promptbook'
      * @public exported from `@promptbook/utils`
@@ -2147,10 +2147,10 @@
      */
 
     /**
-     * @@@
+     * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
      *
-     * @param text @@@
-     * @returns @@@
+     * @param text The text string to be converted to SCREAMING_CASE format.
+     * @returns The normalized text in SCREAMING_CASE format.
      * @example 'HELLO_WORLD'
      * @example 'I_LOVE_PROMPTBOOK'
      * @public exported from `@promptbook/utils`
@@ -2487,11 +2487,11 @@
      */
 
     /**
-     * @@@
+     * Normalizes a given text to camelCase format.
      *
-     * @param text @@@
-     * @param _isFirstLetterCapital @@@
-     * @returns @@@
+     * @param text The text to be normalized.
+     * @param _isFirstLetterCapital Whether the first letter should be capitalized.
+     * @returns The camelCase formatted string.
      * @example 'helloWorld'
      * @example 'iLovePromptbook'
      * @public exported from `@promptbook/utils`
@@ -2995,7 +2995,7 @@
     };
 
     /**
-     * @@@
+     * Pipeline interface which is equivalent to `any`
      *
      * @see https://github.com/webgptorg/promptbook/discussions/171
      *
@@ -3325,8 +3325,7 @@
     };
 
     /**
-     * @@@
-     *
+     * @see {@link ModelVariant}
      * @public exported from `@promptbook/core`
      */
     const MODEL_VARIANTS = ['COMPLETION', 'CHAT', 'EMBEDDING' /* <- TODO [🏳] */ /* <- [🤖] */];
@@ -4331,7 +4330,7 @@
     }
 
     /**
-     * @@@
+     * Extracts the interface (input and output parameters) from a pipeline.
      *
      * @deprecated https://github.com/webgptorg/promptbook/pull/186
      * @see https://github.com/webgptorg/promptbook/discussions/171
@@ -4364,7 +4363,7 @@
     }
 
     /**
-     * @@@
+     * Checks if two pipeline interfaces are structurally identical.
      *
      * @deprecated https://github.com/webgptorg/promptbook/pull/186
      * @see https://github.com/webgptorg/promptbook/discussions/171
@@ -4396,10 +4395,11 @@
     }
 
     /**
-     * @@@
+     * Checks if a given pipeline satisfies the requirements of a specified pipeline interface.
      *
      * @deprecated https://github.com/webgptorg/promptbook/pull/186
      * @see https://github.com/webgptorg/promptbook/discussions/171
+     * @returns `true` if the pipeline implements the interface, `false` otherwise.
      *
      * @public exported from `@promptbook/core`
      */
@@ -4629,7 +4629,8 @@
     }
 
     /**
-     * @@@
+     * Utility to determine if a pipeline string is in flat format.
+     * A flat pipeline is a simple text without proper structure (headers, blocks, etc).
      *
      * @public exported from `@promptbook/editable`
      */
@@ -4650,7 +4651,10 @@
     }
 
     /**
-     * @@@
+     * Converts a pipeline structure to its string representation.
+     *
+     * Transforms a flat, simple pipeline into a properly formatted pipeline string
+     * with sections for title, prompt, and return statement.
      *
      * @public exported from `@promptbook/editable`
      */
@@ -4707,7 +4711,7 @@
      * Note: It can not work with html syntax and comments
      *
      * @param markdown any valid markdown
-     * @returns @@@
+     * @returns An array of strings, each representing an individual list item found in the markdown
      * @public exported from `@promptbook/markdown-utils`
      */
     function extractAllListItemsFromMarkdown(markdown) {
@@ -4960,11 +4964,11 @@
      */
 
     /**
-     * @@@
+     * Converts a title string into a normalized name.
      *
-     * @param value @@@
-     * @returns @@@
-     * @example @@@
+     * @param value The title string to be converted to a name.
+     * @returns A normalized name derived from the input title.
+     * @example 'Hello World!' -> 'hello-world'
      * @public exported from `@promptbook/utils`
      */
     function titleToName(value) {