@promptbook/types 0.81.0-5 → 0.81.0-8

package/esm/typings/books/index.d.ts

@@ -20,6 +20,11 @@ declare const _default: ({
     preparations: never[];
     knowledgeSources: never[];
     knowledgePieces: never[];
+    sources: {
+        type: string;
+        path: null;
+        content: string;
+    }[];
     sourceFile: string;
 } | {
     title: string;
@@ -49,6 +54,11 @@ declare const _default: ({
     preparations: never[];
     knowledgeSources: never[];
     knowledgePieces: never[];
+    sources: {
+        type: string;
+        path: null;
+        content: string;
+    }[];
     sourceFile: string;
 } | {
     title: string;
@@ -73,6 +83,11 @@ declare const _default: ({
     preparations: never[];
     knowledgeSources: never[];
     knowledgePieces: never[];
+    sources: {
+        type: string;
+        path: null;
+        content: string;
+    }[];
     sourceFile: string;
 })[];
 export default _default;

package/esm/typings/src/_packages/core.index.d.ts

@@ -27,6 +27,7 @@ import { DEFAULT_CSV_SETTINGS } from '../config';
 import { DEFAULT_IS_VERBOSE } from '../config';
 import { SET_IS_VERBOSE } from '../config';
 import { DEFAULT_IS_AUTO_INSTALLED } from '../config';
+import { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME } from '../config';
 import { ORDER_OF_PIPELINE_JSON } from '../constants';
 import { RESERVED_PARAMETER_NAMES } from '../constants';
 import { compilePipeline } from '../conversion/compilePipeline';
@@ -145,6 +146,7 @@ export { DEFAULT_CSV_SETTINGS };
 export { DEFAULT_IS_VERBOSE };
 export { SET_IS_VERBOSE };
 export { DEFAULT_IS_AUTO_INSTALLED };
+export { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME };
 export { ORDER_OF_PIPELINE_JSON };
 export { RESERVED_PARAMETER_NAMES };
 export { compilePipeline };

package/esm/typings/src/_packages/node.index.d.ts

@@ -9,6 +9,7 @@ import { $provideScrapersForNode } from '../scrapers/_common/register/$provideSc
 import { FileCacheStorage } from '../storage/file-cache-storage/FileCacheStorage';
 import { $execCommand } from '../utils/execCommand/$execCommand';
 import { $execCommands } from '../utils/execCommand/$execCommands';
+import { wizzard } from '../wizzard/wizzard';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createCollectionFromDirectory };
 export { $provideExecutablesForNode };
@@ -20,3 +21,4 @@ export { $provideScrapersForNode };
 export { FileCacheStorage };
 export { $execCommand };
 export { $execCommands };
+export { wizzard };

package/esm/typings/src/_packages/templates.index.d.ts

@@ -1,4 +1,4 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
-import { getBookTemplate } from '../utils/getBookTemplate';
+import { getBookTemplate } from '../other/templates/getBookTemplate';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { getBookTemplate };

package/esm/typings/src/_packages/utils.index.d.ts

@@ -1,4 +1,6 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { VALUE_STRINGS } from '../config';
+import { SMALL_NUMBER } from '../config';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMermaidOptions';
 import { extractVariablesFromScript } from '../conversion/utils/extractVariablesFromScript';
 import { deserializeError } from '../errors/utils/deserializeError';
@@ -46,7 +48,9 @@ import { searchKeywords } from '../utils/normalization/searchKeywords';
 import { titleToName } from '../utils/normalization/titleToName';
 import { spaceTrim } from '../utils/organization/spaceTrim';
 import { extractParameterNames } from '../utils/parameters/extractParameterNames';
+import { numberToString } from '../utils/parameters/numberToString';
 import { templateParameters } from '../utils/parameters/templateParameters';
+import { valueToString } from '../utils/parameters/valueToString';
 import { parseNumber } from '../utils/parseNumber';
 import { $randomSeed } from '../utils/random/$randomSeed';
 import { removeEmojis } from '../utils/removeEmojis';
@@ -74,6 +78,8 @@ import { isValidPipelineUrl } from '../utils/validators/url/isValidPipelineUrl';
 import { isValidUrl } from '../utils/validators/url/isValidUrl';
 import { isValidUuid } from '../utils/validators/uuid/isValidUuid';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { VALUE_STRINGS };
+export { SMALL_NUMBER };
 export { renderPromptbookMermaid };
 export { extractVariablesFromScript };
 export { deserializeError };
@@ -121,7 +127,9 @@ export { searchKeywords };
 export { titleToName };
 export { spaceTrim };
 export { extractParameterNames };
+export { numberToString };
 export { templateParameters };
+export { valueToString };
 export { parseNumber };
 export { $randomSeed };
 export { removeEmojis };

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

@@ -77,6 +77,26 @@ export declare const LOOP_LIMIT = 1000;
  * @private within the repository - too low-level in comparison with other `MAX_...`
  */
 export declare const CHARACTER_LOOP_LIMIT = 100000;
+/**
+ * Strings to represent various values in the context of parameter values
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const VALUE_STRINGS: {
+    readonly empty: "(nothing; empty string)";
+    readonly null: "(no value; null)";
+    readonly undefined: "(unknown value; undefined)";
+    readonly nan: "(not a number; NaN)";
+    readonly infinity: "(infinity; ∞)";
+    readonly negativeInfinity: "(negative infinity; -∞)";
+    readonly unserializable: "(unserializable value)";
+};
+/**
+ * Small number limit
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const SMALL_NUMBER = 0.001;
 /**
  * Timeout for the connections in milliseconds
  *
@@ -209,6 +229,12 @@ export declare function SET_IS_VERBOSE(isVerbose: boolean): void;
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_IS_AUTO_INSTALLED = false;
+/**
+ * Function name for generated function via `ptbk make` to get the pipeline collection
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME = "getPipelineCollection";
 /**
  * @@@
  *

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,21 @@
+import type { PipelineCollection } from '../../collection/PipelineCollection';
+import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+/**
+ * @@@
+ *
+ * @singleton
+ * @private internal cache of `getBookTemplate`
+ */
+export declare let templatesPipelineCollection: PipelineCollection | null;
+/**
+ * Get template for new book
+ *
+ * @public exported from `@promptbook/templates`
+ */
+export declare function getBookTemplate(formfactorName: string_formfactor_name): PipelineJson;
+/**
+ * TODO: !!!!!! Test
+ * 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/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/esm/typings/src/wizzard/wizzard.d.ts

@@ -0,0 +1,19 @@
+import { Promisable } from 'type-fest';
+import type { PipelineExecutorResult } from '../execution/PipelineExecutorResult';
+import type { TaskProgress } from '../types/TaskProgress';
+import type { Parameters } from '../types/typeAliases';
+import type { string_pipeline_url } from '../types/typeAliases';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare const wizzard: {
+    /**
+     * @@@!!!!!!
+     */
+    run(book: string_pipeline_url, inputParameters: Parameters, onProgress?: ((taskProgress: TaskProgress) => Promisable<void>) | undefined): Promise<PipelineExecutorResult>;
+};
+/**
+ * TODO: !!!!!! Add to readmes - one markdown here imported in all packages
+ */

package/package.json

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

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

@@ -1,6 +0,0 @@
-/**
- * Format either small or big number
- *
- * @private within the repository
- */
-export declare function formatNumber(value: number): string;

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

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