@promptbook/templates 0.92.0-23 → 0.92.0-25

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

@@ -149,27 +149,29 @@ export type string_persona_description = string;
  */
 export type string_model_description = string;
 /**
- * Source of one knowledge
+ * Source of one knowledge piece.
  *
- * It can be a link, a relative path to file or direct text
+ * It can be a link, a relative path to file or direct text content.
  *
  * For example `"https://pavolhejny.com/"`
  * For example `"./pavol-hejny-cv.pdf"`
  * For example `"Pavol Hejný has web https://pavolhejny.com/"`
  * For example `"Pavol Hejný is web developer and creator of Promptbook and Collboard"`
  *
- * @@@ string_knowledge_source vs string_knowledge_source_link
+ * Note: Distinguishes between `string_knowledge_source_content` and `string_knowledge_source_link`:
+ * `string_knowledge_source_content` refers to the actual content or source of knowledge
+ * `string_knowledge_source_link` refers to a reference or link to the knowledge source
  */
 export type string_knowledge_source_content = string_knowledge_source_link | string_markdown;
 /**
- * One link to knowledge source
+ * One link to a knowledge source.
  *
- * It can be a link or relative path
+ * It can be a URL or relative path.
  *
  * For example `"https://pavolhejny.com/"`
  * For example `"./pavol-hejny-cv.pdf"`
  *
- * @@@ string_knowledge_source vs string_knowledge_source_link
+ * Note: string_knowledge_source_link refers to a reference or link to the knowledge source, while string_knowledge_source_content can be the link or the actual content.
  */
 export type string_knowledge_source_link = string_url | string_filename;
 /**

package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts

@@ -5,7 +5,7 @@ type AddPipelineCommandOptions = {
     pipelineString: PipelineString;
 };
 /**
- * @@@
+ * Adds a new command to a pipeline string in the correct format.
  *
  * @public exported from `@promptbook/editable`
  */
@@ -14,4 +14,4 @@ export {};
 /**
  * TODO: [🧠] What is the better solution - `- xxx`, - `-   xxx` or preserve (see also next TODO)
  * TODO: When existing commands 1) as 2) number 3) list, add 4) new command as next number
- */
+ */ 

package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts

@@ -1,6 +1,9 @@
 import type { PipelineString } from '../../../pipeline/PipelineString';
 /**
- * @@@
+ * 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`
  */

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

@@ -1,6 +1,7 @@
 import type { PipelineString } from '../../../pipeline/PipelineString';
 /**
- * @@@
+ * 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`
  */

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

@@ -1,6 +1,7 @@
 import type { really_any } from '../organization/really_any';
 /**
- * @@@
+ * Safely retrieves the global scope object (window in browser, global in Node.js)
+ * regardless of the JavaScript environment in which the code is running
  *
  * Note: `$` is used to indicate that this function is not a pure function - it access global scope
  *

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

@@ -9,7 +9,7 @@ import type { string_markdown_text } from '../../types/typeAliases';
  * 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`
  */
 export declare function extractAllListItemsFromMarkdown(markdown: string_markdown): string_markdown_text[];

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

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

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

@@ -1,9 +1,9 @@
 /**
- * @@@
+ * Converts a given name into URI-compatible parts.
  *
- * @param name @@@
- * @returns @@@
- * @example @@@
+ * @param name The name to be converted into URI parts.
+ * @returns An array of URI-compatible parts derived from the name.
+ * @example 'Example Name' -> ['example', 'name']
  * @public exported from `@promptbook/utils`
  */
 export declare function nameToUriParts(name: string): string[];

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

@@ -7,10 +7,10 @@
  */
 export type string_kebab_case = string;
 /**
- * @@@
+ * 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`

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

@@ -7,10 +7,10 @@
  */
 export type string_SCREAMING_CASE = string;
 /**
- * @@@
+ * 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`

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

@@ -7,11 +7,11 @@
  */
 export type string_camelCase = string;
 /**
- * @@@
+ * 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`

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

@@ -6,10 +6,10 @@
  */
 export type string_snake_case = string;
 /**
- * @@@
+ * Normalizes a text string to snake_case format.
  *
- * @param text @@@
- * @returns @@@
+ * @param text The text string to be converted to snake_case format.
+ * @returns The normalized text in snake_case format.
  * @example 'hello_world'
  * @example 'i_love_promptbook'
  * @public exported from `@promptbook/utils`

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

@@ -1,8 +1,8 @@
 /**
- * @@@
+ * 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`
  */
 export declare function removeDiacritics(input: string): string;

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

@@ -1,6 +1,6 @@
 import type { Keywords } from './IKeywords';
 /**
- * @@@
+ * Searches set of keywords for a specific keyword
  *
  * @param haystack
  * @param needle
@@ -8,3 +8,6 @@ import type { Keywords } from './IKeywords';
  * @public exported from `@promptbook/utils`
  */
 export declare function searchKeywords(haystack: Keywords, needle: Keywords): boolean;
+/**
+ * TODO: Rename to `isKeywordInKeywords`
+ */

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/templates",
-    "version": "0.92.0-23",
+    "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/templates.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-23"
+        "@promptbook/core": "0.92.0-25"
     },
     "dependencies": {
         "prettier": "2.8.1",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-23';
+    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
@@ -1316,7 +1316,7 @@
         /**
          * Constructs a pipeline collection from pipelines
          *
-         * @param pipelines @@@
+         * @param pipelines Array of pipeline JSON objects to include in the collection
          *
          * Note: During the construction logic of all pipelines are validated
          * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
@@ -1578,7 +1578,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-22",
+                        "promptbookVersion": "0.92.0-24",
                         "usage": {
                             "price": {
                                 "value": 0.016800000000000002
@@ -2079,7 +2079,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-22",
+                        "promptbookVersion": "0.92.0-24",
                         "usage": {
                             "price": {
                                 "value": 0.016800000000000002
@@ -2790,7 +2790,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-22",
+                        "promptbookVersion": "0.92.0-24",
                         "usage": {
                             "price": {
                                 "value": 0.016316999999999998
@@ -2938,7 +2938,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-22",
+                        "promptbookVersion": "0.92.0-24",
                         "usage": {
                             "price": {
                                 "value": 0.018161999999999998
@@ -3034,7 +3034,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-22",
+                        "promptbookVersion": "0.92.0-24",
                         "usage": {
                             "price": {
                                 "value": 0
@@ -3177,7 +3177,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-22",
+                        "promptbookVersion": "0.92.0-24",
                         "usage": {
                             "price": {
                                 "value": 0.017319
@@ -3339,7 +3339,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-22",
+                        "promptbookVersion": "0.92.0-24",
                         "usage": {
                             "price": {
                                 "value": 0.017994000000000003
@@ -3675,7 +3675,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-22",
+                        "promptbookVersion": "0.92.0-24",
                         "usage": {
                             "price": {
                                 "value": 0.018462
@@ -3822,7 +3822,7 @@
                 "preparations": [
                     {
                         "id": 1,
-                        "promptbookVersion": "0.92.0-22",
+                        "promptbookVersion": "0.92.0-24",
                         "usage": {
                             "price": {
                                 "value": 0.016824
@@ -3892,14 +3892,14 @@
     }
 
     /**
-     * @@@
+     * Internal cache for the `getBookTemplates` function, storing retrieved pipelines.
      *
      * @singleton
      * @private internal cache of `getBookTemplate`
      */
     let pipelines = null;
     /**
-     * Get template for new book
+     * Retrieves a collection of Promptbook templates.
      *
      * @param formfactorName - optional filter for FORMFACTOR - get only pipelines for this formfactor
      * @returns list of pipelines