@promptbook/openai 0.81.0-5 → 0.81.0-6

package/esm/typings/src/high-level-abstractions/index.d.ts

@@ -18,6 +18,11 @@ export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
         readonly knowledgePieces: import("../_packages/types.index").KnowledgePiecePreparedJson[];
         readonly personas: (import("../_packages/types.index").PersonaJson | import("../_packages/types.index").PersonaPreparedJson)[];
         readonly preparations: import("../_packages/types.index").PreparationJson[];
+        readonly sources: readonly {
+            type: "BOOK";
+            path: string | null;
+            content: import("../pipeline/PipelineString").PipelineString;
+        }[];
         readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
     }>): void;
 }, {
@@ -35,6 +40,11 @@ export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
         readonly knowledgePieces: import("../_packages/types.index").KnowledgePiecePreparedJson[];
         readonly personas: (import("../_packages/types.index").PersonaJson | import("../_packages/types.index").PersonaPreparedJson)[];
         readonly preparations: import("../_packages/types.index").PreparationJson[];
+        readonly sources: readonly {
+            type: "BOOK";
+            path: string | null;
+            content: import("../pipeline/PipelineString").PipelineString;
+        }[];
         readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
     }>): void;
 }];

package/esm/typings/src/other/templates/getBookTemplate.d.ts

@@ -0,0 +1,12 @@
+import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+/**
+ * Get template for new book
+ *
+ * @public exported from `@promptbook/templates`
+ */
+export declare function getBookTemplate(formfactorName: string_formfactor_name): Promise<PipelineJson | null>;
+/**
+ * TODO: [🧠] Which is the best place for this function
+ * TODO: !!!!!! `book string template notation
+ */

package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts

@@ -0,0 +1,10 @@
+import type { PipelineCollection } from '../../collection/PipelineCollection';
+/**
+ * Get pipeline collection for Untitled Promptbook project
+ *
+ * ⚠️ WARNING: This code has been generated by `@promptbook/cli` so that any manual changes will be overwritten
+ *
+ * @generated
+ * @returns {PipelineCollection} Library of promptbooks for Untitled Promptbook project
+ */
+export declare function getTemplatesPipelineCollection(): PipelineCollection;

package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts

@@ -3,7 +3,9 @@ import type { ModelRequirements } from '../../types/ModelRequirements';
 import type { string_filename } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
 import type { string_pipeline_url } from '../../types/typeAliases';
+import type { string_relative_filename } from '../../types/typeAliases';
 import type { string_semantic_version } from '../../types/typeAliases';
+import type { PipelineString } from '../PipelineString';
 import type { KnowledgePiecePreparedJson } from './KnowledgePieceJson';
 import type { KnowledgeSourceJson } from './KnowledgeSourceJson';
 import type { KnowledgeSourcePreparedJson } from './KnowledgeSourceJson';
@@ -91,6 +93,14 @@ export type PipelineJson = {
      * @see https://github.com/webgptorg/promptbook/discussions/78
      */
     readonly preparations: Array<PreparationJson>;
+    /**
+     * Backup of the original book source
+     */
+    readonly sources: ReadonlyArray<{
+        type: 'BOOK';
+        path: string_relative_filename | null;
+        content: PipelineString;
+    }>;
 };
 /**
  * TODO: [🛳] Default PERSONA for the pipeline `defaultPersonaName` (same as `defaultModelRequirements`)

package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts

@@ -1,8 +1,6 @@
 import type { ErrorJson } from '../../../errors/utils/ErrorJson';
 import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
 import type { string_date_iso8601 } from '../../../types/typeAliases';
-import type { string_pipeline_url } from '../../../types/typeAliases';
-import type { PipelineString } from '../../../pipeline/PipelineString';
 /**
  * Represents a single pipeline in PromptbookStudio
  *
@@ -22,19 +20,6 @@ export type PipelineEditableSerialized = PipelineJson & {
      * When was the pipeline last modified
      */
     readonly updatedAt: string_date_iso8601 | null;
-    /**
-     * Unique identifier of the pipeline
-     *
-     * Note: In PromptbookStudio it is required
-     */
-    readonly pipelineUrl: string_pipeline_url;
-    /**
-     * Backup of the pipeline string
-     *
-     * Note: This is present ONLY if pipelineString can not be automatically converted into json (i.e. compilePipeline throws an error)
-     *       In other words, this is just a BACKUP of pipeline which will be deleted whener pipeline is valid again
-     */
-    readonly pipelineString: PipelineString | string | null;
     /**
      * Known errors to transfer to new PipelineEditable
      */

package/esm/typings/src/utils/parameters/numberToString.d.ts

@@ -0,0 +1,7 @@
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * Format either small or big number
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function numberToString(value: number): string_parameter_value;

package/esm/typings/src/utils/parameters/templateParameters.d.ts

@@ -1,12 +1,16 @@
-import type { Parameters } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
 import type { string_template } from '../../types/typeAliases';
+import type { really_unknown } from '../organization/really_unknown';
 /**
  * Replaces parameters in template with values from parameters object
  *
+ * Note: This function is not places strings into string,
+ *       It's more complex and can handle this operation specifically for LLM models
+ *
  * @param template the template with parameters in {curly} braces
  * @param parameters the object with parameters
  * @returns the template with replaced parameters
  * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
  * @public exported from `@promptbook/utils`
  */
-export declare function templateParameters(template: string_template, parameters: Parameters): string;
+export declare function templateParameters(template: string_template, parameters: Record<string_parameter_name, really_unknown>): string;

package/esm/typings/src/utils/parameters/valueToString.d.ts

@@ -0,0 +1,17 @@
+import type { string_parameter_value } from '../../types/typeAliases';
+import type { really_unknown } from '../organization/really_unknown';
+/**
+ * Function `valueToString` will convert the given value to string
+ * This is useful and used in the `templateParameters` function
+ *
+ * Note: This function is not just calling `toString` method
+ *       It's more complex and can handle this conversion specifically for LLM models
+ *       See `VALUE_STRINGS`
+ *
+ * Note: There are 2 similar functions
+ * - `valueToString` converts value to string for LLM models as human-readable string
+ * - `asSerializable` converts value to string to preserve full information to be able to convert it back
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function valueToString(value: really_unknown): string_parameter_value;

package/esm/typings/src/utils/parameters/valueToString.test.d.ts

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

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

@@ -6,6 +6,10 @@ import type { really_any } from '../organization/really_any';
  * For example:
  * - `Date` objects will be converted to string
  *
+ * Note: There are 2 similar functions
+ * - `valueToString` converts value to string for LLM models as human-readable string
+ * - `asSerializable` converts value to string to preserve full information to be able to convert it back
+ *
  * @private Internal helper function
  */
 export declare function asSerializable(value: really_any): really_any;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.81.0-5",
+    "version": "0.81.0-6",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -54,7 +54,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.81.0-5"
+        "@promptbook/core": "0.81.0-6"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.81.0-4';
+    var PROMPTBOOK_ENGINE_VERSION = '0.81.0-5';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -330,6 +330,26 @@
      * @private within the repository - too low-level in comparison with other `MAX_...`
      */
     var LOOP_LIMIT = 1000;
+    /**
+     * Strings to represent various values in the context of parameter values
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    var VALUE_STRINGS = {
+        empty: '(nothing; empty string)',
+        null: '(no value; null)',
+        undefined: '(unknown value; undefined)',
+        nan: '(not a number; NaN)',
+        infinity: '(infinity; ∞)',
+        negativeInfinity: '(negative infinity; -∞)',
+        unserializable: '(unserializable value)',
+    };
+    /**
+     * Small number limit
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    var SMALL_NUMBER = 0.001;
     // <- TODO: [🧜‍♂️]
     /**
      * @@@
@@ -633,9 +653,87 @@
         return LimitReachedError;
     }(Error));
 
+    /**
+     * Format either small or big number
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function numberToString(value) {
+        if (value === 0) {
+            return '0';
+        }
+        else if (Number.isNaN(value)) {
+            return VALUE_STRINGS.nan;
+        }
+        else if (value === Infinity) {
+            return VALUE_STRINGS.infinity;
+        }
+        else if (value === -Infinity) {
+            return VALUE_STRINGS.negativeInfinity;
+        }
+        for (var exponent = 0; exponent < 15; exponent++) {
+            var factor = Math.pow(10, exponent);
+            var valueRounded = Math.round(value * factor) / factor;
+            if (Math.abs(value - valueRounded) / value < SMALL_NUMBER) {
+                return valueRounded.toFixed(exponent);
+            }
+        }
+        return value.toString();
+    }
+
+    /**
+     * Function `valueToString` will convert the given value to string
+     * This is useful and used in the `templateParameters` function
+     *
+     * Note: This function is not just calling `toString` method
+     *       It's more complex and can handle this conversion specifically for LLM models
+     *       See `VALUE_STRINGS`
+     *
+     * Note: There are 2 similar functions
+     * - `valueToString` converts value to string for LLM models as human-readable string
+     * - `asSerializable` converts value to string to preserve full information to be able to convert it back
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function valueToString(value) {
+        try {
+            if (value === '') {
+                return VALUE_STRINGS.empty;
+            }
+            else if (value === null) {
+                return VALUE_STRINGS.null;
+            }
+            else if (value === undefined) {
+                return VALUE_STRINGS.undefined;
+            }
+            else if (typeof value === 'string') {
+                return value;
+            }
+            else if (typeof value === 'number') {
+                return numberToString(value);
+            }
+            else if (value instanceof Date) {
+                return value.toISOString();
+            }
+            else {
+                return JSON.stringify(value);
+            }
+        }
+        catch (error) {
+            if (!(error instanceof Error)) {
+                throw error;
+            }
+            console.error(error);
+            return VALUE_STRINGS.unserializable;
+        }
+    }
+
     /**
      * Replaces parameters in template with values from parameters object
      *
+     * Note: This function is not places strings into string,
+     *       It's more complex and can handle this operation specifically for LLM models
+     *
      * @param template the template with parameters in {curly} braces
      * @param parameters the object with parameters
      * @returns the template with replaced parameters
@@ -685,7 +783,7 @@
             if (parameterValue === undefined) {
                 throw new PipelineExecutionError("Parameter `{".concat(parameterName, "}` is not defined"));
             }
-            parameterValue = parameterValue.toString();
+            parameterValue = valueToString(parameterValue);
             if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
                 parameterValue = parameterValue
                     .split('\n')