@promptbook/openai 0.61.0-14 → 0.61.0-16

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

@@ -5,10 +5,10 @@ import type { CompletionModelRequirements } from './ModelRequirements';
 import type { EmbeddingModelRequirements } from './ModelRequirements';
 import type { ModelRequirements } from './ModelRequirements';
 import type { Expectations } from './PipelineJson/Expectations';
-import type { string_parameter_name } from './typeAliases';
-import type { string_parameter_value } from './typeAliases';
+import type { Parameters } from './typeAliases';
 import type { string_pipeline_url_with_hashtemplate } 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.
@@ -63,12 +63,11 @@ export type CommonPrompt = {
      */
     readonly title: string_title;
     /**
-     * The text of the prompt
+     * The text of the prompt with placeholders for parameters
      *
-     * Note: This is not a template, this is exactly the text that will be sent to the model
-     * @example "What is the capital of France?"
+     * @example "What is the capital of {country}?"
      */
-    readonly content: string_prompt;
+    readonly content: string_prompt & string_template;
     /**
      * Requirements for the model
      */
@@ -98,11 +97,9 @@ export type CommonPrompt = {
      */
     readonly pipelineUrl?: string_pipeline_url_with_hashtemplate;
     /**
-     * Parameters used in the prompt
-     *
-     * Note: This is redundant (same information is in pipelineUrl+content) but useful for logging and debugging
+     * Parameters used in the `content`
      */
-    readonly parameters: Record<string_parameter_name, string_parameter_value>;
+    readonly parameters: Parameters;
 };
 /**
  * TODO: [🔼] !!!! Export all from `@promptbook/types`

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

@@ -1,3 +1,4 @@
+import { RESERVED_PARAMETER_NAMES } from '../config';
 /**
  * Semantic helper
  */
@@ -17,7 +18,7 @@ export type string_prompt = string;
 /**
  * Semantic helper
  *
- * For example `"A cat wearing a {ITEM}"`
+ * For example `"A cat wearing a {item}"`
  */
 export type string_template = string;
 /**
@@ -85,14 +86,36 @@ export type string_name = string;
  *
  * For example `"eventName"`
  */
-export type string_parameter_name = string;
+export type string_parameter_name = string_name;
 /**
  * Semantic helper
- * Unique identifier of anything
+ * Unique identifier of parameter
  *
  * For example `"DevConf 2024"`
  */
 export type string_parameter_value = string;
+/**
+ * Parameters of the pipeline
+ *
+ * There are three types of parameters:
+ * - **INPUT PARAMETERs** are required to execute the pipeline.
+ * - **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.
+ *
+ * @see https://ptbk.io/parameters
+ */
+export type Parameters = Exclude<Record<string_parameter_name, string_parameter_value>, ReservedParameters>;
+/**
+ * Semantic helper
+ * Unique identifier of reserved parameter
+ *
+ * For example `"context"`
+ */
+export type string_reserved_parameter_name = typeof RESERVED_PARAMETER_NAMES[number];
+/**
+ * @@@
+ */
+export type ReservedParameters = Record<string_reserved_parameter_name, string_parameter_value>;
 /**
  * Semantic helper
  * Title of anything
@@ -115,8 +138,21 @@ export type string_persona_description = string;
  * 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
+ */
+export type string_knowledge_source = string_knowledge_source_link | string_markdown;
+/**
+ * One link to knowledge source
+ *
+ * It can be a link or relative path
+ *
+ * For example `"https://pavolhejny.com/"`
+ * For example `"./pavol-hejny-cv.pdf"`
+ *
+ * @@@ string_knowledge_source vs string_knowledge_source_link
  */
-export type string_knowledge_source = string_url | string_file_path | string;
+export type string_knowledge_source_link = string_url | string_file_path;
 /**
  * Semantic helper
  *
@@ -160,6 +196,10 @@ export type string_markdown_section_content = string;
  * For example `"**Hello** World!"`
  */
 export type string_markdown_text = string;
+/**
+ * @@@
+ */
+export type string_promptbook_documentation_url = `https://github.com/webgptorg/promptbook/discussions/${number | '@@'}`;
 /**
  * Semantic helper
  *

package/umd/typings/src/utils/deepFreeze.d.ts

@@ -4,9 +4,18 @@ import type { ReadonlyDeep } from 'type-fest';
  *
  * @returns The same object as the input, but deeply frozen
  *
- * Note: This function mutates the object
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
  */
 export declare function deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
+/**
+ * @@@
+ * @@@
+ *
+ * @returns The same object as the input, but deeply frozen
+ *
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ */
+export declare function deepFreezeWithSameType<TObject>(objectValue: TObject): TObject;
 /**
  * TODO: [🔼] Export from `@promptbook/utils`
  * TODO: [🧠] Is there a way how to meaningfully test this utility

package/umd/typings/src/utils/extractParameters.d.ts

@@ -1,4 +1,4 @@
-import type { string_name } from '../types/typeAliases';
+import type { string_parameter_name } from '../types/typeAliases';
 import type { string_template } from '../types/typeAliases';
 /**
  * Parses the template and returns the list of all parameter names
@@ -6,4 +6,4 @@ import type { string_template } from '../types/typeAliases';
  * @param template the template with parameters in {curly} braces
  * @returns the list of parameter names
  */
-export declare function extractParameters(template: string_template): Set<string_name>;
+export declare function extractParameters(template: string_template): Set<string_parameter_name>;

package/umd/typings/src/{execution/utils → utils}/replaceParameters.d.ts

@@ -1,5 +1,5 @@
-import type { Parameters } from '../../types/Parameters';
-import type { string_template } from '../../types/typeAliases';
+import type { Parameters } from '../types/typeAliases';
+import type { string_template } from '../types/typeAliases';
 /**
  * Replaces parameters in template with values from parameters object
  *
@@ -7,7 +7,5 @@ import type { string_template } from '../../types/typeAliases';
  * @param parameters the object with parameters
  * @returns the template with replaced parameters
  * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
- *
- * @private within the createPipelineExecutor
  */
 export declare function replaceParameters(template: string_template, parameters: Parameters): string;

package/umd/typings/src/utils/replaceParameters.test.d.ts

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

package/umd/typings/src/utils/sets/difference.d.ts

@@ -4,3 +4,6 @@
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  */
 export declare function difference<TItem>(a: Set<TItem>, b: Set<TItem>, isEqual?: (a: TItem, b: TItem) => boolean): Set<TItem>;
+/**
+ * TODO: [🧠][💯] Maybe also implement symmetricDifference
+ */

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

@@ -1,14 +0,0 @@
-/**
- * Parameters of the pipeline
- *
- * There are three types of parameters:
- * - **INPUT PARAMETERs** are required to execute the pipeline.
- * - **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.
- *
- * @see https://github.com/webgptorg/promptbook#parameters
- */
-export type Parameters = object;
-/**
- * TODO: Constrain type to Simple key-value object, only string keys and string values and no index signature + only camelCase keys and spaceTrimmed values
- */

package/umd/typings/src/types/Parameters.d.ts

@@ -1,14 +0,0 @@
-/**
- * Parameters of the pipeline
- *
- * There are three types of parameters:
- * - **INPUT PARAMETERs** are required to execute the pipeline.
- * - **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.
- *
- * @see https://github.com/webgptorg/promptbook#parameters
- */
-export type Parameters = object;
-/**
- * TODO: Constrain type to Simple key-value object, only string keys and string values and no index signature + only camelCase keys and spaceTrimmed values
- */