@promptbook/core 0.66.0 → 0.67.0-1

package/esm/typings/src/types/PipelineJson/KnowledgePieceJson.d.ts

@@ -11,6 +11,8 @@ import type { string_name } from '../typeAliases';
  *
  * Note: Knowledge piece is by definition prepared
  *
+ * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/41
  */
 export type KnowledgePiecePreparedJson = {

package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts

@@ -5,6 +5,8 @@ import type { string_name } from '../typeAliases';
  * Defines one source of knowledge in the pipeline
  * For example, a source of information, a fact, a quote, a definition, website, etc.
  *
+ * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/41
  */
 export type KnowledgeSourceJson = {
@@ -20,6 +22,8 @@ export type KnowledgeSourceJson = {
 /**
  * Defines one source of knowledge in the pipeline after it has been prepared
  *
+ * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/41
  */
 export type KnowledgeSourcePreparedJson = KnowledgeSourceJson & {

package/esm/typings/src/types/PipelineJson/LlmTemplateJson.d.ts

@@ -3,6 +3,8 @@ import type { string_name } from '../typeAliases';
 import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for prompt to LLM
+ *
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type LlmTemplateJson = PromptTemplateJsonCommon & {
     readonly blockType: 'PROMPT_TEMPLATE';

package/esm/typings/src/types/PipelineJson/PersonaJson.d.ts

@@ -5,6 +5,8 @@ import type { string_persona_description } from '../typeAliases';
 /**
  * Defines a persona in the pipeline
  *
+ * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/22
  */
 export type PersonaJson = {
@@ -22,6 +24,8 @@ export type PersonaJson = {
 /**
  * Defines a persona in the pipeline after it has been prepared
  *
+ * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/22
  */
 export type PersonaPreparedJson = PersonaJson & {

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

@@ -14,6 +14,8 @@ import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson'
  * Promptbook is the **core concept of this package**.
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
  *
+ * Note: [🚉] This is fully serializable as JSON
+ *
  * @see @@@ https://github.com/webgptorg/promptbook#promptbook
  */
 export type PipelineJson = {

package/esm/typings/src/types/PipelineJson/PromptDialogJson.d.ts

@@ -2,6 +2,7 @@ import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for prompt to user
  *
+ * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/76
  */
 export type PromptDialogJson = PromptTemplateJsonCommon & {

package/esm/typings/src/types/PipelineJson/PromptTemplateJson.d.ts

@@ -5,6 +5,8 @@ import type { ScriptJson } from './ScriptJson';
 import type { SimpleTemplateJson } from './SimpleTemplateJson';
 /**
  * Describes one prompt template in the promptbook
+ *
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptJson | PromptDialogJson | ___ | ___ | ___ | ___;
 /**

package/esm/typings/src/types/PipelineJson/PromptTemplateJsonCommon.d.ts

@@ -1,11 +1,11 @@
 import type { BlockType } from '../../commands/BLOCK/BlockTypes';
 import type { ExpectFormatCommand } from '../../commands/EXPECT/ExpectFormatCommand';
 import type { string_javascript } from '../typeAliases';
-import type { string_javascript_name } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';
 import type { string_markdown_text } from '../typeAliases';
 import type { string_name } from '../typeAliases';
 import type { string_parameter_name } from '../typeAliases';
+import type { string_postprocessing_function_name } from '../typeAliases';
 import type { string_prompt } from '../typeAliases';
 import type { string_template } from '../typeAliases';
 import type { Expectations } from './Expectations';
@@ -66,7 +66,7 @@ export interface PromptTemplateJsonCommon {
      *
      * @see https://github.com/webgptorg/promptbook/discussions/31
      */
-    readonly postprocessingFunctionNames?: Array<string_javascript_name>;
+    readonly postprocessingFunctionNames?: Array<string_postprocessing_function_name>;
     /**
      * Expect this amount of each unit in the answer
      *

package/esm/typings/src/types/PipelineJson/PromptTemplateParameterJson.d.ts

@@ -3,6 +3,8 @@ import type { string_parameter_name } from '../typeAliases';
 import type { string_parameter_value } from '../typeAliases';
 /**
  * Describes one parameter of the promptbook
+ *
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type PromptTemplateParameterJson = {
     /**

package/esm/typings/src/types/PipelineJson/ScriptJson.d.ts

@@ -3,6 +3,7 @@ import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for script execution
  *
+ * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/77
  */
 export type ScriptJson = PromptTemplateJsonCommon & {

package/esm/typings/src/types/PipelineJson/SimpleTemplateJson.d.ts

@@ -2,6 +2,7 @@ import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
 /**
  * Template for simple concatenation of strings
  *
+ * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/17
  */
 export type SimpleTemplateJson = PromptTemplateJsonCommon & {

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

@@ -1,5 +1,4 @@
 import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand';
-import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
 import type { ChatModelRequirements } from './ModelRequirements';
 import type { CompletionModelRequirements } from './ModelRequirements';
 import type { EmbeddingModelRequirements } from './ModelRequirements';
@@ -7,20 +6,21 @@ import type { ModelRequirements } from './ModelRequirements';
 import type { Expectations } from './PipelineJson/Expectations';
 import type { Parameters } from './typeAliases';
 import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
+import type { string_postprocessing_function_name } from './typeAliases';
 import type { string_prompt } from './typeAliases';
 import type { string_template } from './typeAliases';
 import type { string_title } from './typeAliases';
 /**
  * Prompt in a text along with model requirements, but without any execution or templating logic.
  *
- * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook#prompt
  */
 export type Prompt = CompletionPrompt | ChatPrompt | EmbeddingPrompt;
 /**
  * Completion prompt
  *
- * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type CompletionPrompt = CommonPrompt & {
     /**
@@ -31,7 +31,7 @@ export type CompletionPrompt = CommonPrompt & {
 /**
  * Chat prompt
  *
- * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type ChatPrompt = CommonPrompt & {
     /**
@@ -42,7 +42,7 @@ export type ChatPrompt = CommonPrompt & {
 /**
  * Embedding prompt
  *
- * Note: [🛫] This is NOT fully serializable as JSON, it contains functions which are not serializable
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type EmbeddingPrompt = CommonPrompt & {
     /**
@@ -53,7 +53,7 @@ export type EmbeddingPrompt = CommonPrompt & {
 /**
  * Common properties for all prompt results
  *
- * Note: This is fully serializable as JSON
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type CommonPrompt = {
     /**
@@ -75,7 +75,7 @@ export type CommonPrompt = {
     /**
      * List of postprocessing steps that are executed after the prompt
      */
-    readonly postprocessing?: Array<PostprocessingFunction>;
+    readonly postprocessingFunctionNames?: Array<string_postprocessing_function_name>;
     /**
      * Expectations for the answer
      *

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

@@ -1,6 +1,8 @@
 import type { TupleToUnion } from 'type-fest';
 /**
  * Script language
+ *
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type ScriptLanguage = TupleToUnion<typeof SUPPORTED_SCRIPT_LANGUAGES>;
 /**

package/esm/typings/src/types/execution-report/ExecutionPromptReportJson.d.ts

@@ -0,0 +1,24 @@
+import type { ErrorJson } from '../../errors/utils/ErrorJson';
+import type { PromptResult } from '../../execution/PromptResult';
+import type { Prompt } from '../Prompt';
+/**
+ * Report of single prompt execution
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ExecutionPromptReportJson = {
+    /**
+     * The prompt wich was executed
+     */
+    readonly prompt: Omit<Prompt, 'pipelineUrl'>;
+    /**
+     * Result of the prompt execution (if not failed during LLM execution)
+     */
+    readonly result?: PromptResult;
+    /**
+     * The error which occured during LLM execution or during postprocessing or expectation checking
+     *
+     * Note: It makes sense to have both error and result defined, for example when the result not pass expectations
+     */
+    readonly error?: ErrorJson;
+};

package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts

@@ -1,8 +1,7 @@
-import type { PromptResult } from '../../execution/PromptResult';
-import type { Prompt } from '../Prompt';
 import type { string_markdown_text } from '../typeAliases';
 import type { string_pipeline_url } from '../typeAliases';
 import type { string_semantic_version } from '../typeAliases';
+import type { ExecutionPromptReportJson } from './ExecutionPromptReportJson';
 /**
  * ExecutionReport is result of executing one promptbook
  * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
@@ -11,6 +10,7 @@ import type { string_semantic_version } from '../typeAliases';
  * -   **.md file** created from the **JSON** format
  * -   _(this)_ **JSON** format
  *
+ * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook#execution-report
  */
 export type ExecutionReportJson = {
@@ -37,22 +37,5 @@ export type ExecutionReportJson = {
     /**
      * Sequence of prompt templates in order which were executed
      */
-    readonly promptExecutions: Array<{
-        /**
-         * The prompt wich was executed
-         */
-        readonly prompt: Omit<Prompt, 'pipelineUrl'>;
-        /**
-         * Result of the prompt execution (if not failed during LLM execution)
-         */
-        readonly result?: PromptResult;
-        /**
-         * The error which occured during LLM execution or during postprocessing or expectation checking
-         *
-         * Note: It makes sense to have both error and result defined, for example when the result not pass expectations
-         */
-        readonly error?: {
-            readonly message: string;
-        };
-    }>;
+    readonly promptExecutions: Array<ExecutionPromptReportJson>;
 };

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

@@ -103,6 +103,7 @@ export type string_parameter_value = string;
  * - **Intermediate parameters** are used internally in the pipeline.
  * - **OUTPUT PARAMETERs** are not used internally in the pipeline, but are returned as the result of the pipeline execution.
  *
+ * Note: [🚉] This is fully serializable as JSON
  * @see https://ptbk.io/parameters
  */
 export type Parameters = Exclude<Record<string_parameter_name, string_parameter_value>, ReservedParameters>;
@@ -115,6 +116,8 @@ export type Parameters = Exclude<Record<string_parameter_name, string_parameter_
 export type string_reserved_parameter_name = TupleToUnion<typeof RESERVED_PARAMETER_NAMES>;
 /**
  * @@@
+ *
+ * Note: [🚉] This is fully serializable as JSON
  */
 export type ReservedParameters = Record<string_reserved_parameter_name, string_parameter_value>;
 /**
@@ -514,6 +517,10 @@ export type string_translate_language = 'en' | 'cs';
  * Semantic helper; For example "callbackName" or "renderMe"
  */
 export type string_javascript_name = string;
+/**
+ * Semantic helper; For example "unwrapResult" or "spaceTrim"
+ */
+export type string_postprocessing_function_name = string;
 export type string_token = string;
 export type string_license_token = string_token;
 export type string_password = string;

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

@@ -4,9 +4,6 @@ import type { really_any } from '../organization/really_any';
  *
  * Note: `$` is used to indicate that this function is not a pure function - it access global scope
  *
- * @public exported from `@promptbook/utils`
+ *  @private internal function of `$Register`
  */
 export declare function $getGlobalScope(): really_any;
-/***
- * TODO: !!!!! Make private and promptbook registry from this
- */ 

package/esm/typings/src/utils/serialization/$asDeeplyFrozenSerializableJson.d.ts

@@ -0,0 +1,17 @@
+import type { string_name } from '../../types/typeAliases';
+/**
+ * @@@
+ * @@@
+ *
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ *
+ * @param name - Name of the object for debugging purposes
+ * @param objectValue - Object to be deeply frozen
+ * @returns The same object as the input, but deeply frozen
+ * @private this is in comparison to `deepFreeze` a more specific utility and maybe not very good practice to use without specific reason and considerations
+ */
+export declare function $asDeeplyFrozenSerializableJson<TObject>(name: string_name, objectValue: TObject): TObject;
+/**
+ * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */

package/esm/typings/src/utils/{deepFreeze.d.ts → serialization/$deepFreeze.d.ts}

@@ -9,16 +9,6 @@ import type { ReadonlyDeep } from 'type-fest';
  * @public exported from `@promptbook/utils`
  */
 export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
-/**
- * @@@
- * @@@
- *
- * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
- *
- * @returns The same object as the input, but deeply frozen
- * @private this is in comparison to `deepFreeze` a more specific utility and maybe not very good practice to use without specific reason and considerations
- */
-export declare function deepFreezeWithSameType<TObject>(objectValue: TObject): TObject;
 /**
  * TODO: [🧠] Is there a way how to meaningfully test this utility
  */

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

@@ -0,0 +1,27 @@
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Checks if the value is [🚉] serializable as JSON
+ * If not, throws an UnexpectedError with a rich error message and tracking
+ *
+ * - Almost all primitives are serializable BUT:
+ * - `undefined` is not serializable
+ * - `NaN` is not serializable
+ * - Objects and arrays are serializable if all their properties are serializable
+ * - Functions are not serializable
+ * - Circular references are not serializable
+ * - `Date` objects are not serializable
+ * - `Map` and `Set` objects are not serializable
+ * - `RegExp` objects are not serializable
+ * - `Error` objects are not serializable
+ * - `Symbol` objects are not serializable
+ * - And much more...
+ *
+ * @throws UnexpectedError if the value is not serializable as JSON
+ * @public exported from `@promptbook/utils`
+ */
+export declare function checkSerializableAsJson(name: string_name, value: unknown): void;
+/**
+ * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
+ * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+ * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
+ */

package/esm/typings/src/utils/{clonePipeline.d.ts → serialization/clonePipeline.d.ts}

@@ -1,4 +1,4 @@
-import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 /**
  * @@@
  *

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

@@ -0,0 +1,24 @@
+/**
+ * Tests if the value is [🚉] serializable as JSON
+ *
+ * - Almost all primitives are serializable BUT:
+ * - `undefined` is not serializable
+ * - `NaN` is not serializable
+ * - Objects and arrays are serializable if all their properties are serializable
+ * - Functions are not serializable
+ * - Circular references are not serializable
+ * - `Date` objects are not serializable
+ * - `Map` and `Set` objects are not serializable
+ * - `RegExp` objects are not serializable
+ * - `Error` objects are not serializable
+ * - `Symbol` objects are not serializable
+ * - And much more...
+ *
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isSerializableAsJson(value: unknown): boolean;
+/**
+ * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][💺] Can be done this on type-level?
+ */

package/esm/typings/src/utils/serialization/isSerializableAsJson.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.66.0",
+    "version": "0.67.0-1",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,