@promptbook/vercel 0.80.0 → 0.81.0-7

package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts

@@ -1,8 +1,9 @@
+import type { PromptbookFetch } from '../../execution/PromptbookFetch';
 import type { string_name } from '../../types/typeAliases';
 /**
  * @private still in development
  */
-export declare function isGithubNameFree(name: string_name): Promise<boolean>;
+export declare function isGithubNameFree(name: string_name, fetch: PromptbookFetch): Promise<boolean>;
 /**
  * TODO: [🍓][🧠] Test and implement `isGithubNameFree`
  * TODO: Export via some (and probably new) NPM package

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/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts

@@ -8,4 +8,4 @@ import type { ScraperSourceHandler } from '../Scraper';
  *
  * @public exported from `@promptbook/core`
  */
-export declare function makeKnowledgeSourceHandler(knowledgeSource: SetOptional<KnowledgeSourceJson, 'name'>, tools: Pick<ExecutionTools, 'fs'>, options?: Pick<PrepareAndScrapeOptions, 'rootDirname' | 'isVerbose'>): Promise<ScraperSourceHandler>;
+export declare function makeKnowledgeSourceHandler(knowledgeSource: SetOptional<KnowledgeSourceJson, 'name'>, tools: Pick<ExecutionTools, 'fs' | 'fetch'>, options?: Pick<PrepareAndScrapeOptions, 'rootDirname' | 'isVerbose'>): Promise<ScraperSourceHandler>;

package/esm/typings/src/scrapers/_common/utils/scraperFetch.d.ts

@@ -0,0 +1,7 @@
+import type { PromptbookFetch } from '../../../execution/PromptbookFetch';
+/**
+ * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
+ *
+ * @private as default `fetch` function used in Promptbook scrapers
+ */
+export declare const scraperFetch: PromptbookFetch;

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

@@ -0,0 +1,27 @@
+import type { ErrorJson } from '../../../errors/utils/ErrorJson';
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { string_date_iso8601 } from '../../../types/typeAliases';
+/**
+ * Represents a single pipeline in PromptbookStudio
+ *
+ * This is simple extension of PipelineJson with additional metadata
+ * Note: There are two similar entities:
+ *       1) Type (interface) `PipelineEditableSerialized` which represents just data in database
+ *       2) Class `PipelineEditable` which implements `PipelineEditableSerialized` and adds error handling and editing capabilities
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export type PipelineEditableSerialized = PipelineJson & {
+    /**
+     * When was the pipeline created
+     */
+    readonly createdAt: string_date_iso8601;
+    /**
+     * When was the pipeline last modified
+     */
+    readonly updatedAt: string_date_iso8601 | null;
+    /**
+     * Known errors to transfer to new PipelineEditable
+     */
+    readonly knownErrors: Array<ErrorJson>;
+};

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

@@ -1,5 +1,5 @@
-import type { CommandType } from '../../commands/_common/types/CommandType';
-import type { PipelineString } from '../../pipeline/PipelineString';
+import type { CommandType } from '../../../commands/_common/types/CommandType';
+import type { PipelineString } from '../../../pipeline/PipelineString';
 /**
  * Options for `removePipelineCommand`
  */
@@ -16,7 +16,7 @@ type RemovePipelineCommandOptions = {
 /**
  * Function `removePipelineCommand` will remove one command from pipeline string
  *
- * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
+ * @public exported from `@promptbook/editable`
  */
 export declare function removePipelineCommand(options: RemovePipelineCommandOptions): PipelineString;
 export {};

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

@@ -1,5 +1,5 @@
-import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
-import type { string_name } from '../../types/typeAliases';
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { string_name } from '../../../types/typeAliases';
 type RenameParameterOptions = {
     /**
      * Pipeline to search and replace for parameters
@@ -20,7 +20,7 @@ type RenameParameterOptions = {
  * In other words, it will find all parameters that are not used in the task itseld and all its dependencies
  *
  * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
- * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
+ * @public exported from `@promptbook/editable`
  */
 export declare function renamePipelineParameter(options: RenameParameterOptions): PipelineJson;
 export {};

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

@@ -1,11 +1,11 @@
-import type { string_json } from '../../types/typeAliases';
+import type { string_json } from '../../../types/typeAliases';
 /**
  * Stringify the PipelineJson with proper formatting
  *
  * Note: [0] It can be used for more JSON types like whole collection of pipelines, single knowledge piece, etc.
  * Note: In contrast to JSON.stringify, this function ensures that **embedding index** is on single line
  *
- * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/editable`
  */
 export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
 /**

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/{replaceParameters.d.ts → 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 replaceParameters(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/esm/typings/src/version.d.ts

@@ -2,15 +2,22 @@ import type { string_semantic_version } from './types/typeAliases';
 /**
  * The version of the Book language
  *
+ * @generated
  * @see https://github.com/webgptorg/book
  */
 export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 /**
  * The version of the Promptbook engine
  *
+ * @generated
  * @see https://github.com/webgptorg/promptbook
  */
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
+/**
+ * @@@
+ *
+ * @generated
+ */
 export type string_promptbook_version = string_semantic_version;
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/vercel",
-    "version": "0.80.0",
+    "version": "0.81.0-7",
     "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/vercel.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.80.0"
+        "@promptbook/core": "0.81.0-7"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -13,15 +13,17 @@
     /**
      * The version of the Book language
      *
+     * @generated
      * @see https://github.com/webgptorg/book
      */
     var BOOK_LANGUAGE_VERSION = '1.0.0';
     /**
      * The version of the Promptbook engine
      *
+     * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.80.0-1';
+    var PROMPTBOOK_ENGINE_VERSION = '0.81.0-6';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -295,6 +297,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: [🧜‍♂️]
     /**
      * @@@
@@ -598,16 +620,94 @@
         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
      * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
      * @public exported from `@promptbook/utils`
      */
-    function replaceParameters(template, parameters) {
+    function templateParameters(template, parameters) {
         var e_1, _a;
         try {
             for (var _b = __values(Object.entries(parameters)), _c = _b.next(); !_c.done; _c = _b.next()) {
@@ -633,7 +733,7 @@
         var loopLimit = LOOP_LIMIT;
         var _loop_1 = function () {
             if (loopLimit-- < 0) {
-                throw new LimitReachedError('Loop limit reached during parameters replacement in `replaceParameters`');
+                throw new LimitReachedError('Loop limit reached during parameters replacement in `templateParameters`');
             }
             var precol = match.groups.precol;
             var parameterName = match.groups.parameterName;
@@ -650,7 +750,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')
@@ -684,6 +784,10 @@
      * 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
      */
     function asSerializable(value) {
@@ -761,7 +865,7 @@
                                 return [4 /*yield*/, vercelProvider.chat(modelName, __assign({ user: (userId === null || userId === void 0 ? void 0 : userId.toString()) || undefined }, additionalChatSettings))];
                             case 1:
                                 model = _b.sent();
-                                rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
+                                rawPromptContent = templateParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
                                 rawRequest = {
                                     // <- TODO: [☂]
                                     inputFormat: 'messages',