@promptbook/javascript 0.112.0-31 → 0.112.0-34

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

@@ -0,0 +1,17 @@
+import type { string_mime_type_private } from './string_mime_type_private';
+/**
+ * Semantic helper
+ *
+ * For example `"SGVsbG8sIFdvcmxkIQ=="`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_base64_private = string;
+/**
+ * Semantic helper
+ *
+ * For example `"data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_data_url_private = `data:${string_mime_type_private};base64,${string_base64_private}`;

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * Semantic helper
+ *
+ * For example `"pavol@hejny.org"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_email_private = string;
+/**
+ * Semantic helper
+ *
+ * For example `"pavol@hejny.org, jirka@webgpt.cz"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_emails_private = string;

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

@@ -0,0 +1,55 @@
+/**
+ * Semantic helper
+ *
+ * For example `"towns.cz"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_domain_private = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://*.pavolhejny.com/*"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_origin_private = string;
+/**
+ * Semantic helper
+ *
+ * For example `"com"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_tdl_private = string;
+/**
+ * Semantic helper
+ *
+ * For example `"localhost"` or `"collboard.com"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_hostname_private = string;
+/**
+ * Semantic helper
+ *
+ * For example `"localhost:9977"` or `"collboard.com"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_host_private = string;
+/**
+ * Semantic helper
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_protocol_private = 'http:' | 'https:';
+/**
+ * Semantic helper
+ *
+ * For example `"192.168.1.1"` (IPv4)
+ * For example `"2001:0db8:85a3:0000:0000:8a2e:0370:7334"` (IPv6)
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_ip_address_private = string;

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

@@ -0,0 +1,17 @@
+/**
+ * Semantic helper
+ *
+ * For example `"text/plain"` or `"application/collboard"`
+ *
+ * @private internal utility of `string_url.ts`
+ */
+export type string_mime_type_private = string;
+/**
+ * Semantic helper
+ *
+ * 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

@@ -0,0 +1,8 @@
+/**
+ * Unstructured description of the model
+ *
+ * For example `"Model with logical reasoning and creative mindset"`
+ *
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type string_model_description_private = string;

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

@@ -0,0 +1,8 @@
+/**
+ * Semantic helper
+ *
+ * For example `"gpt-4"`
+ *
+ * @private internal utility of `string_parameter_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_private.d.ts

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

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

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

package/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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;