@promptbook/javascript 0.112.0-34 → 0.112.0-35

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

@@ -0,0 +1,31 @@
+import type { InputParameters_private } from './InputParameters_private';
+import type { Parameters_private } from './Parameters_private';
+import type { ReservedParameters_private } from './ReservedParameters_private';
+/**
+ * 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.
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ *
+ * @see https://ptbk.io/parameters
+ */
+export type Parameters = Parameters_private;
+/**
+ * Parameters to pass to execution of the pipeline
+ *
+ * Note: [🚉] This should be fully serializable as JSON
+ *
+ * @see https://ptbk.io/parameters
+ */
+export type InputParameters = InputParameters_private;
+/**
+ * Represents a mapping of reserved parameter names to their values.
+ * Reserved parameters are used internally by the pipeline and should not be set by users.
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ReservedParameters = ReservedParameters_private;

package/esm/src/types/Parameters_private.d.ts

@@ -1,5 +1,5 @@
 import type { ReservedParameters_private } from './ReservedParameters_private';
-import type { string_parameter_name } from './string_parameter_name';
+import type { string_parameter_name } from './string_name';
 import type { string_parameter_value_private } from './string_parameter_value_private';
 /**
  * Parameters of the pipeline
@@ -10,7 +10,9 @@ import type { string_parameter_value_private } from './string_parameter_value_pr
  * - **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
- * @private internal utility of `string_parameter_name.ts`
+ *
+ * @private internal utility of `Parameters.ts`
  */
 export type Parameters_private = Exclude<Record<string_parameter_name, string_parameter_value_private>, ReservedParameters_private>;

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

@@ -17,6 +17,7 @@ import type { string_title } from './typeAliases';
  * Prompt in a text along with model requirements, but without any execution or templating logic.
  *
  * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook#prompt
  */
 export type Prompt = CompletionPrompt | ChatPrompt | ImagePrompt | EmbeddingPrompt;
@@ -145,9 +146,3 @@ export type CommonPrompt = {
      */
     readonly parameters: Parameters;
 };
-/**
- * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
- * TODO: [✔] Check ModelRequirements in runtime
- * TODO: [🏳] Add options for translation - maybe create `TranslationPrompt`
- * TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt
- */

package/esm/src/types/ReservedParameters_private.d.ts

@@ -5,6 +5,7 @@ import type { string_parameter_value_private } from './string_parameter_value_pr
  * Reserved parameters are used internally by the pipeline and should not be set by users.
  *
  * Note: [🚉] This is fully serializable as JSON
- * @private internal utility of `string_parameter_name.ts`
+ *
+ * @private internal utility of `Parameters.ts`
  */
 export type ReservedParameters_private = Record<string_reserved_parameter_name_private, string_parameter_value_private>;

package/esm/src/types/ToolCall.d.ts

@@ -70,8 +70,6 @@ export type ToolCall = {
     readonly state?: ToolCallState;
     /**
      * Idempotency identifier that should not change between partial updates of the same tool call.
-     *
-     * @public exported from `@promptbook/types`
      */
     readonly idempotencyKey?: string;
     /**

package/esm/src/types/Updatable.d.ts

@@ -11,9 +11,7 @@ export type Updatable<TValue> = TValue | BehaviorSubject<TValue> | [TValue, (val
  * Restricts an Updatable to a (2) BehaviorSubject variant
  *
  * @see Updatable
+ *
  * @private internal utility <- TODO: [🧠] Maybe export from `@promptbook/types`
  */
 export declare function asUpdatableSubject<TValue>(value: Updatable<TValue>): BehaviorSubject<TValue>;
-/**
- * TODO: [🧠] Maybe `BehaviorSubject` is too heavy for this use case, maybe just tuple `[value,setValue]` is enough
- */

package/esm/src/types/string_agent_hash_private.d.ts

@@ -4,6 +4,6 @@ import type { string_sha256 } from './string_sha256';
  *
  * For example `"b126926439c5fcb83609888a11283723c1ef137c0ad599a77a1be81812bd221d"`
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_agent_name.ts`
  */
 export type string_agent_hash_private = string_sha256;

package/esm/src/types/string_agent_name.d.ts

@@ -0,0 +1,32 @@
+import type { string_agent_hash_private } from './string_agent_hash_private';
+import type { string_agent_name_in_book_private } from './string_agent_name_in_book_private';
+import type { string_agent_name_private } from './string_agent_name_private';
+import type { string_agent_permanent_id_private } from './string_agent_permanent_id_private';
+/**
+ * Semantic helper
+ *
+ * For example `"My AI Assistant"`
+ *
+ * TODO: !!!! Brand the type
+ */
+export type string_agent_name = string_agent_name_private;
+/**
+ * Semantic helper
+ *
+ * For example `"My AI Assistant"`
+ */
+export type string_agent_name_in_book = string_agent_name_in_book_private;
+/**
+ * Semantic helper
+ *
+ * For example `"b126926439c5fcb83609888a11283723c1ef137c0ad599a77a1be81812bd221d"`
+ */
+export type string_agent_hash = string_agent_hash_private;
+/**
+ * Semantic helper
+ *
+ * For example `"3mJr7AoUXx2Wqd"`
+ *
+ * TODO: !!!! Brand the type
+ */
+export type string_agent_permanent_id = string_agent_permanent_id_private;

package/esm/src/types/string_agent_name_in_book_private.d.ts

@@ -3,6 +3,6 @@
  *
  * For example `"My AI Assistant"`
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_agent_name.ts`
  */
 export type string_agent_name_in_book_private = string;

package/esm/src/types/string_agent_name_private.d.ts

@@ -4,6 +4,7 @@
  * For example `"My AI Assistant"`
  *
  * TODO: !!!! Brand the type
- * @private internal utility of `string_parameter_name.ts`
+ *
+ * @private internal utility of `string_agent_name.ts`
  */
 export type string_agent_name_private = string;

package/esm/src/types/string_agent_permanent_id_private.d.ts

@@ -5,6 +5,7 @@ import type { string_base_58 } from './string_sha256';
  * For example `"3mJr7AoUXx2Wqd"`
  *
  * TODO: !!!! Brand the type
- * @private internal utility of `string_parameter_name.ts`
+ *
+ * @private internal utility of `string_agent_name.ts`
  */
 export type string_agent_permanent_id_private = string_base_58;

package/esm/src/types/string_business_category_name.d.ts

@@ -0,0 +1,5 @@
+import type { string_business_category_name_private } from './string_business_category_name_private';
+/**
+ * Semantic helper
+ */
+export type string_business_category_name = string_business_category_name_private;

package/esm/src/types/string_business_category_name_private.d.ts

@@ -1,6 +1,6 @@
 /**
  * Semantic helper
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_business_category_name.ts`
  */
 export type string_business_category_name_private = 'restaurant' | 'grocery' | 'person' | 'conference' | string;

package/esm/src/types/string_char_private.d.ts

@@ -3,6 +3,6 @@
  *
  * For example `"a"`
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_page.ts`
  */
 export type string_char_private = string;

package/esm/src/types/string_chat_prompt_private.d.ts

@@ -4,6 +4,6 @@ import type { string_text_prompt_private } from './string_text_prompt_private';
  *
  * For example `"How many hats does the cat wear?"`
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_prompt.ts`
  */
 export type string_chat_prompt_private = string_text_prompt_private;

package/esm/src/types/string_completion_prompt_private.d.ts

@@ -4,6 +4,6 @@ import type { string_text_prompt_private } from './string_text_prompt_private';
  *
  * For example `"Following is a text about cats: Once upon a time there was a cat"`
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_prompt.ts`
  */
 export type string_completion_prompt_private = string_text_prompt_private;

package/esm/src/types/string_markdown.d.ts

@@ -9,7 +9,6 @@ export type string_html = string;
  *
  * For example `"<foo>bar</foo>"`
  *
- *
  * TODO: [🎞️] Probably use some object-based method for working with XMLs
  */
 export type string_xml = string;

package/esm/src/types/string_mime_type_private.d.ts

@@ -12,6 +12,7 @@ export type string_mime_type_private = string;
  * For example `"text/*"` or `"image/*"`
  *
  * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#unique_file_type_specifiers
+ *
  * @private internal utility of `string_url.ts`
  */
 export type string_mime_type_with_wildcard_private = string;

package/esm/src/types/string_model_description_private.d.ts

@@ -3,6 +3,6 @@
  *
  * For example `"Model with logical reasoning and creative mindset"`
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_persona_description.ts`
  */
 export type string_model_description_private = string;

package/esm/src/types/string_model_name.d.ts

@@ -0,0 +1,7 @@
+import type { string_model_name_private } from './string_model_name_private';
+/**
+ * Semantic helper
+ *
+ * For example `"gpt-4"`
+ */
+export type string_model_name = string_model_name_private;

package/esm/src/types/string_model_name_private.d.ts

@@ -3,6 +3,6 @@
  *
  * For example `"gpt-4"`
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_model_name.ts`
  */
 export type string_model_name_private = 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-16k-0613' | string;

package/esm/src/types/string_name.d.ts

@@ -0,0 +1,31 @@
+import type { string_name_private } from './string_name_private';
+import type { string_parameter_value_private } from './string_parameter_value_private';
+import type { string_reserved_parameter_name_private } from './string_reserved_parameter_name_private';
+/**
+ * Semantic helper
+ * Unique identifier of anything
+ *
+ * For example `"ainautes"`
+ */
+export type string_name = string_name_private;
+/**
+ * Semantic helper
+ * Unique identifier of anything
+ *
+ * For example `"eventTitle"`
+ */
+export type string_parameter_name = string_name;
+/**
+ * Semantic helper
+ * Unique identifier of parameter
+ *
+ * For example `"DevConf 2024"`
+ */
+export type string_parameter_value = string_parameter_value_private;
+/**
+ * Semantic helper
+ * Unique identifier of reserved parameter
+ *
+ * For example `"context"`
+ */
+export type string_reserved_parameter_name = string_reserved_parameter_name_private;

package/esm/src/types/string_name_private.d.ts

@@ -4,6 +4,6 @@
  *
  * For example `"ainautes"`
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_name.ts`
  */
 export type string_name_private = string;

package/esm/src/types/string_page.d.ts

@@ -0,0 +1,15 @@
+import type { string_char_private } from './string_char_private';
+import type { string_page_private } from './string_page_private';
+/**
+ * Semantic helper
+ *
+ * For example `"index"` or `"explanation"`
+ * Always in kebab-case
+ */
+export type string_page = string_page_private;
+/**
+ * Semantic helper
+ *
+ * For example `"a"`
+ */
+export type string_char = string_char_private;

package/esm/src/types/string_page_private.d.ts

@@ -4,6 +4,6 @@
  * For example `"index"` or `"explanation"`
  * Always in kebab-case
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_page.ts`
  */
 export type string_page_private = 'index' | string;

package/esm/src/types/string_parameter_name.d.ts

@@ -1,213 +1,14 @@
-import type { InputParameters_private } from './InputParameters_private';
-import type { Parameters_private } from './Parameters_private';
-import type { ReservedParameters_private } from './ReservedParameters_private';
-import type { string_agent_hash_private } from './string_agent_hash_private';
-import type { string_agent_name_private } from './string_agent_name_private';
-import type { string_agent_name_in_book_private } from './string_agent_name_in_book_private';
-import type { string_agent_permanent_id_private } from './string_agent_permanent_id_private';
-import type { string_business_category_name_private } from './string_business_category_name_private';
-import type { string_char_private } from './string_char_private';
-import type { string_chat_prompt_private } from './string_chat_prompt_private';
-import type { string_completion_prompt_private } from './string_completion_prompt_private';
-import type { string_model_description_private } from './string_model_description_private';
-import type { string_model_name_private } from './string_model_name_private';
-import type { string_name_private } from './string_name_private';
-import type { string_page_private } from './string_page_private';
-import type { string_parameter_value_private } from './string_parameter_value_private';
-import type { string_persona_description_private } from './string_persona_description_private';
-import type { string_prompt_private } from './string_prompt_private';
-import type { string_prompt_image_private } from './string_prompt_image_private';
-import type { string_reserved_parameter_name_private } from './string_reserved_parameter_name_private';
-import type { string_system_message_private } from './string_system_message_private';
-import type { string_template_private } from './string_template_private';
-import type { string_text_prompt_private } from './string_text_prompt_private';
-import type { string_title_private } from './string_title_private';
 /**
- * Semantic helper
+ * Compatibility facade for semantic parameter-related type aliases.
  *
+ * The concrete type declarations live in focused modules under `src/types`.
  */
-export type string_business_category_name = string_business_category_name_private;
-/**
- * Semantic helper
- *
- * For example `"gpt-4"`
- *
- */
-export type string_model_name = string_model_name_private;
-/**
- * Semantic helper
- *
- * For example `"How many eyes does a cat have?"`
- *
- */
-export type string_prompt = string_prompt_private;
-/**
- * Semantic helper
- *
- * For example `"A cat wearing a hat"`
- *
- */
-export type string_prompt_image = string_prompt_image_private;
-/**
- * Semantic helper
- *
- * For example `"A cat wearing a {item}"`
- *
- */
-export type string_template = string_template_private;
-/**
- * Semantic helper
- *
- * For example `"How many hats does the cat wear?"`
- *
- */
-export type string_text_prompt = string_text_prompt_private;
-/**
- * Semantic helper
- *
- * For example `"How many hats does the cat wear?"`
- *
- */
-export type string_chat_prompt = string_chat_prompt_private;
-/**
- * Semantic helper
- *
- * For example `"You are an AI assistant. You are here to help me with my work."`
- *
- */
-export type string_system_message = string_system_message_private;
-/**
- * Semantic helper
- *
- * For example `"Following is a text about cats: Once upon a time there was a cat"`
- *
- */
-export type string_completion_prompt = string_completion_prompt_private;
-/**
- * Semantic helper
- *
- * For example `"index"` or `"explanation"`
- * Always in kebab-case
- *
- */
-export type string_page = string_page_private;
-/**
- * Semantic helper
- *
- * For example `"a"`
- *
- */
-export type string_char = string_char_private;
-/**
- * Semantic helper
- * Unique identifier of anything
- *
- * For example `"ainautes"`
- *
- */
-export type string_name = string_name_private;
-/**
- * Semantic helper
- * Unique identifier of anything
- *
- * For example `"eventTitle"`
- *
- */
-export type string_parameter_name = string_name;
-/**
- * Semantic helper
- * Unique identifier of parameter
- *
- * For example `"DevConf 2024"`
- *
- */
-export type string_parameter_value = string_parameter_value_private;
-/**
- * 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.
- *
- * Note: [🚉] This is fully serializable as JSON
- * @see https://ptbk.io/parameters
- */
-export type Parameters = Parameters_private;
-/**
- * Parameters to pass to execution of the pipeline
- *
- * Note: [🚉] This should be fully serializable as JSON
- * @see https://ptbk.io/parameters
- */
-export type InputParameters = InputParameters_private;
-/**
- * Semantic helper
- * Unique identifier of reserved parameter
- *
- * For example `"context"`
- *
- */
-export type string_reserved_parameter_name = string_reserved_parameter_name_private;
-/**
- * Represents a mapping of reserved parameter names to their values.
- * Reserved parameters are used internally by the pipeline and should not be set by users.
- *
- * Note: [🚉] This is fully serializable as JSON
- */
-export type ReservedParameters = ReservedParameters_private;
-/**
- * Semantic helper
- * Title of anything
- *
- * For example `"Ai*nautes"`
- *
- */
-export type string_title = string_title_private;
-/**
- * Semantic helper
- *
- * For example `"My AI Assistant"`
- *
- * TODO: !!!! Brand the type
- */
-export type string_agent_name = string_agent_name_private;
-/**
- * Semantic helper
- *
- * For example `"My AI Assistant"`
- *
- */
-export type string_agent_name_in_book = string_agent_name_in_book_private;
-/**
- * Semantic helper
- *
- * For example `"b126926439c5fcb83609888a11283723c1ef137c0ad599a77a1be81812bd221d"`
- *
- */
-export type string_agent_hash = string_agent_hash_private;
-/**
- * Semantic helper
- *
- * For example `"3mJr7AoUXx2Wqd"`
- *
- * TODO: !!!! Brand the type
- */
-export type string_agent_permanent_id = string_agent_permanent_id_private;
-/**
- * Unstructured description of the persona
- *
- * For example `"Skilled copywriter"`
- *
- */
-export type string_persona_description = string_persona_description_private;
-/**
- * Unstructured description of the model
- *
- * For example `"Model with logical reasoning and creative mindset"`
- *
- */
-export type string_model_description = string_model_description_private;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */
+export type { InputParameters, Parameters, ReservedParameters } from './Parameters';
+export type { string_agent_hash, string_agent_name, string_agent_name_in_book, string_agent_permanent_id } from './string_agent_name';
+export type { string_business_category_name } from './string_business_category_name';
+export type { string_model_name } from './string_model_name';
+export type { string_name, string_parameter_name, string_parameter_value, string_reserved_parameter_name } from './string_name';
+export type { string_page, string_char } from './string_page';
+export type { string_chat_prompt, string_completion_prompt, string_prompt, string_prompt_image, string_system_message, string_template, string_text_prompt, } from './string_prompt';
+export type { string_persona_description, string_model_description } from './string_persona_description';
+export type { string_title } from './string_title';

package/esm/src/types/string_parameter_value_private.d.ts

@@ -4,6 +4,6 @@
  *
  * For example `"DevConf 2024"`
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_name.ts`
  */
 export type string_parameter_value_private = string;

package/esm/src/types/string_persona_description.d.ts

@@ -0,0 +1,14 @@
+import type { string_model_description_private } from './string_model_description_private';
+import type { string_persona_description_private } from './string_persona_description_private';
+/**
+ * Unstructured description of the persona
+ *
+ * For example `"Skilled copywriter"`
+ */
+export type string_persona_description = string_persona_description_private;
+/**
+ * Unstructured description of the model
+ *
+ * For example `"Model with logical reasoning and creative mindset"`
+ */
+export type string_model_description = string_model_description_private;

package/esm/src/types/string_persona_description_private.d.ts

@@ -3,6 +3,6 @@
  *
  * For example `"Skilled copywriter"`
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_persona_description.ts`
  */
 export type string_persona_description_private = string;

package/esm/src/types/string_prompt.d.ts

@@ -0,0 +1,49 @@
+import type { string_chat_prompt_private } from './string_chat_prompt_private';
+import type { string_completion_prompt_private } from './string_completion_prompt_private';
+import type { string_prompt_image_private } from './string_prompt_image_private';
+import type { string_prompt_private } from './string_prompt_private';
+import type { string_system_message_private } from './string_system_message_private';
+import type { string_template_private } from './string_template_private';
+import type { string_text_prompt_private } from './string_text_prompt_private';
+/**
+ * Semantic helper
+ *
+ * For example `"How many eyes does a cat have?"`
+ */
+export type string_prompt = string_prompt_private;
+/**
+ * Semantic helper
+ *
+ * For example `"A cat wearing a hat"`
+ */
+export type string_prompt_image = string_prompt_image_private;
+/**
+ * Semantic helper
+ *
+ * For example `"A cat wearing a {item}"`
+ */
+export type string_template = string_template_private;
+/**
+ * Semantic helper
+ *
+ * For example `"How many hats does the cat wear?"`
+ */
+export type string_text_prompt = string_text_prompt_private;
+/**
+ * Semantic helper
+ *
+ * For example `"How many hats does the cat wear?"`
+ */
+export type string_chat_prompt = string_chat_prompt_private;
+/**
+ * Semantic helper
+ *
+ * For example `"You are an AI assistant. You are here to help me with my work."`
+ */
+export type string_system_message = string_system_message_private;
+/**
+ * Semantic helper
+ *
+ * For example `"Following is a text about cats: Once upon a time there was a cat"`
+ */
+export type string_completion_prompt = string_completion_prompt_private;

package/esm/src/types/string_prompt_image_private.d.ts

@@ -3,6 +3,6 @@
  *
  * For example `"A cat wearing a hat"`
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_prompt.ts`
  */
 export type string_prompt_image_private = string;

package/esm/src/types/string_prompt_private.d.ts

@@ -3,6 +3,6 @@
  *
  * For example `"How many eyes does a cat have?"`
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_prompt.ts`
  */
 export type string_prompt_private = string;

package/esm/src/types/string_reserved_parameter_name_private.d.ts

@@ -6,6 +6,6 @@ import { RESERVED_PARAMETER_NAMES } from '../constants';
  *
  * For example `"context"`
  *
- * @private internal utility of `string_parameter_name.ts`
+ * @private internal utility of `string_name.ts`
  */
 export type string_reserved_parameter_name_private = TupleToUnion<typeof RESERVED_PARAMETER_NAMES>;