@promptbook/javascript 0.112.0-32 → 0.112.0-34

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

@@ -1,84 +1,117 @@
-import type { TupleToUnion } from 'type-fest';
-import { RESERVED_PARAMETER_NAMES } from '../constants';
-import type { really_unknown } from '../utils/organization/really_unknown';
-import { string_base_58, string_sha256 } from './string_sha256';
-/**
- * Semantic helper
- */
-export type string_business_category_name = 'restaurant' | 'grocery' | 'person' | 'conference' | string;
+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
+ *
+ */
+export type string_business_category_name = string_business_category_name_private;
 /**
  * Semantic helper
  *
  * For example `"gpt-4"`
+ *
  */
-export type string_model_name = '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;
+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;
+export type string_prompt = string_prompt_private;
 /**
  * Semantic helper
  *
  * For example `"A cat wearing a hat"`
+ *
  */
-export type string_prompt_image = string;
+export type string_prompt_image = string_prompt_image_private;
 /**
  * Semantic helper
  *
  * For example `"A cat wearing a {item}"`
+ *
  */
-export type string_template = string;
+export type string_template = string_template_private;
 /**
  * Semantic helper
  *
  * For example `"How many hats does the cat wear?"`
+ *
  */
-export type string_text_prompt = string_prompt;
+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_text_prompt;
+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_text_prompt;
+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_text_prompt;
+export type string_completion_prompt = string_completion_prompt_private;
 /**
  * Semantic helper
  *
  * For example `"index"` or `"explanation"`
  * Always in kebab-case
+ *
  */
-export type string_page = 'index' | string;
+export type string_page = string_page_private;
 /**
  * Semantic helper
  *
  * For example `"a"`
+ *
  */
-export type string_char = string;
+export type string_char = string_char_private;
 /**
  * Semantic helper
  * Unique identifier of anything
  *
  * For example `"ainautes"`
+ *
  */
-export type string_name = string;
+export type string_name = string_name_private;
 /**
  * Semantic helper
  * Unique identifier of anything
  *
  * For example `"eventTitle"`
+ *
  */
 export type string_parameter_name = string_name;
 /**
@@ -86,8 +119,9 @@ export type string_parameter_name = string_name;
  * Unique identifier of parameter
  *
  * For example `"DevConf 2024"`
+ *
  */
-export type string_parameter_value = string;
+export type string_parameter_value = string_parameter_value_private;
 /**
  * Parameters of the pipeline
  *
@@ -99,35 +133,37 @@ export type string_parameter_value = string;
  * Note: [🚉] This is fully serializable as JSON
  * @see https://ptbk.io/parameters
  */
-export type Parameters = Exclude<Record<string_parameter_name, string_parameter_value>, ReservedParameters>;
+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 = Exclude<Record<string_parameter_name, really_unknown>, ReservedParameters>;
+export type InputParameters = InputParameters_private;
 /**
  * Semantic helper
  * Unique identifier of reserved parameter
  *
  * For example `"context"`
+ *
  */
-export type string_reserved_parameter_name = TupleToUnion<typeof RESERVED_PARAMETER_NAMES>;
+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 = Record<string_reserved_parameter_name, string_parameter_value>;
+export type ReservedParameters = ReservedParameters_private;
 /**
  * Semantic helper
  * Title of anything
  *
  * For example `"Ai*nautes"`
+ *
  */
-export type string_title = string;
+export type string_title = string_title_private;
 /**
  * Semantic helper
  *
@@ -135,19 +171,21 @@ export type string_title = string;
  *
  * TODO: !!!! Brand the type
  */
-export type string_agent_name = string;
+export type string_agent_name = string_agent_name_private;
 /**
  * Semantic helper
  *
  * For example `"My AI Assistant"`
+ *
  */
-export type string_agent_name_in_book = string;
+export type string_agent_name_in_book = string_agent_name_in_book_private;
 /**
  * Semantic helper
  *
  * For example `"b126926439c5fcb83609888a11283723c1ef137c0ad599a77a1be81812bd221d"`
+ *
  */
-export type string_agent_hash = string_sha256;
+export type string_agent_hash = string_agent_hash_private;
 /**
  * Semantic helper
  *
@@ -155,16 +193,21 @@ export type string_agent_hash = string_sha256;
  *
  * TODO: !!!! Brand the type
  */
-export type string_agent_permanent_id = string_base_58;
+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;
+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 string_model_description = string;

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

@@ -0,0 +1,9 @@
+/**
+ * Semantic helper
+ * Unique identifier of parameter
+ *
+ * For example `"DevConf 2024"`
+ *
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type string_parameter_value_private = string;

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

@@ -0,0 +1,8 @@
+/**
+ * Unstructured description of the persona
+ *
+ * For example `"Skilled copywriter"`
+ *
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type string_persona_description_private = string;

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

@@ -0,0 +1,8 @@
+/**
+ * Semantic helper
+ *
+ * For example `"A cat wearing a hat"`
+ *
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type string_prompt_image_private = string;

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

@@ -0,0 +1,8 @@
+/**
+ * Semantic helper
+ *
+ * For example `"How many eyes does a cat have?"`
+ *
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type string_prompt_private = string;

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

@@ -0,0 +1,11 @@
+import type { TupleToUnion } from 'type-fest';
+import { RESERVED_PARAMETER_NAMES } from '../constants';
+/**
+ * Semantic helper
+ * Unique identifier of reserved parameter
+ *
+ * For example `"context"`
+ *
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type string_reserved_parameter_name_private = TupleToUnion<typeof RESERVED_PARAMETER_NAMES>;

package/umd/src/types/string_system_message_private.d.ts

@@ -0,0 +1,9 @@
+import type { string_text_prompt_private } from './string_text_prompt_private';
+/**
+ * Semantic helper
+ *
+ * For example `"You are an AI assistant. You are here to help me with my work."`
+ *
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type string_system_message_private = string_text_prompt_private;

package/umd/src/types/string_template_private.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Semantic helper
+ *
+ * For example `"A cat wearing a {item}"`
+ *
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type string_template_private = string;

package/umd/src/types/string_text_prompt_private.d.ts

@@ -0,0 +1,9 @@
+import type { string_prompt_private } from './string_prompt_private';
+/**
+ * Semantic helper
+ *
+ * For example `"How many hats does the cat wear?"`
+ *
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type string_text_prompt_private = string_prompt_private;

package/umd/src/types/string_title_private.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Semantic helper
+ * Title of anything
+ *
+ * For example `"Ai*nautes"`
+ *
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type string_title_private = string;

package/umd/src/types/string_url.d.ts

@@ -1,146 +1,150 @@
+import type { string_base64_private, string_data_url_private } from './string_base64_private';
+import type { string_domain_private, string_host_private, string_hostname_private, string_ip_address_private, string_origin_private, string_protocol_private, string_tdl_private } from './string_host_private';
+import type { string_email_private, string_emails_private } from './string_email_private';
+import type { string_mime_type_private, string_mime_type_with_wildcard_private } from './string_mime_type_private';
+import type { string_agent_url_private, string_base_url_private, string_href_private, string_pipeline_root_url_private, string_pipeline_url_private, string_pipeline_url_with_task_hash_private, string_promptbook_server_url_private, string_uri_part_private, string_uri_private, string_url_image_private, string_url_private } from './string_url_private';
 /**
  * Semantic helper
  *
  * For example `"text/plain"` or `"application/collboard"`
  */
-export type string_mime_type = string;
+export type string_mime_type = string_mime_type_private;
 /**
  * Semantic helper
  *
  * For example `"text/*"` or `"image/*"`
  *
- *
  * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#unique_file_type_specifiers
  */
-export type string_mime_type_with_wildcard = string;
+export type string_mime_type_with_wildcard = string_mime_type_with_wildcard_private;
 /**
  * Semantic helper
  *
- * For example `"towns.cz"`
+ * For example `"SGVsbG8sIFdvcmxkIQ=="`
  */
-export type string_domain = string;
+export type string_base64 = string_base64_private;
 /**
  * Semantic helper
  *
- * For example `"https://*.pavolhejny.com/*"`
+ * For example `"data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="`
  */
-export type string_origin = string;
+export type string_data_url = string_data_url_private;
 /**
  * Semantic helper
  *
- * For example `"com"`
+ * For example `"towns.cz"`
  */
-export type string_tdl = string;
+export type string_domain = string_domain_private;
 /**
  * Semantic helper
  *
- * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"`
+ * For example `"https://*.pavolhejny.com/*"`
  */
-export type string_url = string;
+export type string_origin = string_origin_private;
 /**
  * Semantic helper
  *
- * For example `"https://s1.ptbk.io/promptbook"`
+ * For example `"com"`
  */
-export type string_promptbook_server_url = string;
+export type string_tdl = string_tdl_private;
 /**
  * Semantic helper
  *
- * For example `"https://collboard.com"`
+ * For example `"localhost"` or `"collboard.com"`
  */
-export type string_base_url = string;
+export type string_hostname = string_hostname_private;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.studio/webgpt/"`
+ * For example `"localhost:9977"` or `"collboard.com"`
  */
-export type string_pipeline_root_url = string;
+export type string_host = string_host_private;
 /**
  * Semantic helper
- *
- * For example `"https://s6.ptbk.io/agents/agent-007"`
  */
-export type string_agent_url = string;
+export type string_protocol = string_protocol_private;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book"`
+ * For example `"192.168.1.1"` (IPv4)
+ * For example `"2001:0db8:85a3:0000:0000:8a2e:0370:7334"` (IPv6)
  */
-export type string_pipeline_url = string;
+export type string_ip_address = string_ip_address_private;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book#keywords"`
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"`
  */
-export type string_pipeline_url_with_task_hash = string;
+export type string_url = string_url_private;
 /**
  * Semantic helper
  *
- * For example `"SGVsbG8sIFdvcmxkIQ=="`
+ * For example `"https://s1.ptbk.io/promptbook"`
  */
-export type string_base64 = string;
+export type string_promptbook_server_url = string_promptbook_server_url_private;
 /**
  * Semantic helper
  *
- * For example `"data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="`
+ * For example `"https://collboard.com"`
  */
-export type string_data_url = `data:${string_mime_type};base64,${string_base64}`;
+export type string_base_url = string_base_url_private;
 /**
  * Semantic helper
  *
- * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"` OR `/9SeSQTupmQHwuSrLi`
+ * For example `"https://promptbook.studio/webgpt/"`
  */
-export type string_href = string;
+export type string_pipeline_root_url = string_pipeline_root_url_private;
 /**
  * Semantic helper
  *
- * For example `"https://collboard.com/9SeSQTupmQHwuSrLi.png?width=1200&height=630"`
+ * For example `"https://s6.ptbk.io/agents/agent-007"`
  */
-export type string_url_image = string;
+export type string_agent_url = string_agent_url_private;
 /**
  * Semantic helper
  *
- * For example `"/9SeSQTupmQHwuSrLi"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book"`
  */
-export type string_uri = string;
+export type string_pipeline_url = string_pipeline_url_private;
 /**
  * Semantic helper
  *
- * For example `"9SeSQTupmQHwuSrLi"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book#keywords"`
  */
-export type string_uri_part = string;
+export type string_pipeline_url_with_task_hash = string_pipeline_url_with_task_hash_private;
 /**
  * Semantic helper
  *
- * For example `"localhost"` or `"collboard.com"`
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"` OR `/9SeSQTupmQHwuSrLi`
  */
-export type string_hostname = string;
+export type string_href = string_href_private;
 /**
  * Semantic helper
  *
- * For example `"localhost:9977"` or `"collboard.com"`
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi.png?width=1200&height=630"`
  */
-export type string_host = string;
+export type string_url_image = string_url_image_private;
 /**
  * Semantic helper
+ *
+ * For example `"/9SeSQTupmQHwuSrLi"`
  */
-export type string_protocol = 'http:' | 'https:';
+export type string_uri = string_uri_private;
 /**
  * Semantic helper
  *
- * For example `"192.168.1.1"` (IPv4)
- * For example `"2001:0db8:85a3:0000:0000:8a2e:0370:7334"` (IPv6)
+ * For example `"9SeSQTupmQHwuSrLi"`
  */
-export type string_ip_address = string;
+export type string_uri_part = string_uri_part_private;
 /**
  * Semantic helper
  *
  * For example `"pavol@hejny.org"`
  */
-export type string_email = string;
+export type string_email = string_email_private;
 /**
  * Semantic helper
  *
  * For example `"pavol@hejny.org, jirka@webgpt.cz"`
  */
-export type string_emails = string;
+export type string_emails = string_emails_private;

package/umd/src/types/string_url_private.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_url_private = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://s1.ptbk.io/promptbook"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_promptbook_server_url_private = string_url_private;
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_base_url_private = string_url_private;
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_pipeline_root_url_private = string_url_private;
+/**
+ * Semantic helper
+ *
+ * For example `"https://s6.ptbk.io/agents/agent-007"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_agent_url_private = string_url_private;
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_pipeline_url_private = string_url_private;
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book#keywords"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_pipeline_url_with_task_hash_private = string_pipeline_url_private;
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"` OR `/9SeSQTupmQHwuSrLi`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_href_private = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi.png?width=1200&height=630"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_url_image_private = string_url_private;
+/**
+ * Semantic helper
+ *
+ * For example `"/9SeSQTupmQHwuSrLi"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_uri_private = string;
+/**
+ * Semantic helper
+ *
+ * For example `"9SeSQTupmQHwuSrLi"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_uri_part_private = string;

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

@@ -6,7 +6,13 @@ export type { string_base64, string_base_url, string_data_url, string_domain, st
 export type { string_knowledge_source_content, string_knowledge_source_link } from './string_knowledge_source_content';
 export type { string_attribute, string_attribute_value_scope, string_color, string_javascript_name, string_legal_entity, string_license, string_person_firstname, string_person_fullname, string_person_lastname, string_person_profile, string_postprocessing_function_name, string_translate_language, string_translate_name, string_translate_name_not_normalized, } from './string_person_fullname';
 export type { id, string_app_id, string_date_iso8601, string_language, string_license_token, string_password, string_pgp_key, string_promptbook_token, string_ssh_key, string_token, string_user_id, task_id, } from './string_token';
-export type { number_bytes, number_days, number_gigabytes, number_hours, number_id, number_integer, number_kilobytes, number_likeness, number_linecol_number, number_megabytes, number_milliseconds, number_minutes, number_model_temperature, number_months, number_negative, number_percent, number_port, number_positive, number_seconds, number_seed, number_terabytes, number_tokens, number_usd, number_weeks, number_years, } from './number_usd';
+export type { number_id, number_linecol_number, number_tokens, } from './number_id';
+export type { number_integer, number_negative, number_port, number_positive } from './number_positive';
+export type { number_model_temperature, number_percent, number_seed } from './number_percent';
+export type { number_likeness } from './number_likeness';
+export type { number_weeks, number_days, number_hours, number_milliseconds, number_minutes, number_months, number_seconds, number_years, } from './number_milliseconds';
+export type { number_bytes, number_gigabytes, number_kilobytes, number_megabytes, number_terabytes } from './number_bytes';
+export type { number_usd } from './number_usd';
 /**
  * TODO: [main] !!3 Change "For example" to @example
  * TODO: Change to branded types

package/umd/src/utils/execCommand/$execCommand.d.ts

@@ -12,6 +12,4 @@ import type { ExecCommandOptions } from './ExecCommandOptions';
  * @public exported from `@promptbook/node`
  */
 export declare function $execCommand(options: ExecCommandOptions): Promise<$side_effect & string>;
-/**
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- */
+/** Note: [🟢] Code for Node command-execution helper [$execCommand](src/utils/execCommand/$execCommand.ts) should never be published into packages that could be imported into browser environment */

package/umd/src/utils/execCommand/$execCommands.d.ts

@@ -14,6 +14,4 @@ export declare function $execCommands({ commands, cwd, crashOnError, }: $side_ef
     readonly cwd: string;
     readonly crashOnError?: boolean;
 }): Promise<void>;
-/**
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- */
+/** Note: [🟢] Code for Node command-execution helper [$execCommands](src/utils/execCommand/$execCommands.ts) should never be published into packages that could be imported into browser environment */

package/umd/src/utils/files/$induceBookDownload.d.ts

@@ -8,6 +8,4 @@ import type { $side_effect } from '../organization/$side_effect';
  * @public exported from `@promptbook/browser`
  */
 export declare function $induceBookDownload(book: string_book): Promise<$side_effect>;
-/**
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
- */
+/** Note: [🔵] Code for browser file helper [$induceBookDownload](src/utils/files/$induceBookDownload.ts) should never be published outside of `@promptbook/browser` */