@promptbook/javascript 0.112.0-32 → 0.112.0-34

package/umd/src/storage/file-cache-storage/FileCacheStorage.d.ts

@@ -34,7 +34,5 @@ export declare class FileCacheStorage<TItem> implements PromptbookStorage<TItem>
      */
     removeItem(key: string): Promise<void>;
 }
-/**
- * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- */
+/** Note: [🟢] Code for Node file-cache storage [FileCacheStorage](src/storage/file-cache-storage/FileCacheStorage.ts) should never be published into packages that could be imported into browser environment */
+/** TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values */

package/umd/src/storage/local-storage/getIndexedDbStorage.d.ts

@@ -6,6 +6,4 @@ import type { IndexedDbStorageOptions } from './utils/IndexedDbStorageOptions';
  * @public exported from `@promptbook/browser`
  */
 export declare function getIndexedDbStorage<TItem>(options: IndexedDbStorageOptions): PromptbookStorage<TItem>;
-/**
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
- */
+/** Note: [🔵] Code for browser storage helper [getIndexedDbStorage](src/storage/local-storage/getIndexedDbStorage.ts) should never be published outside of `@promptbook/browser` */

package/umd/src/storage/local-storage/getLocalStorage.d.ts

@@ -5,6 +5,4 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
  * @public exported from `@promptbook/browser`
  */
 export declare function getLocalStorage<TItem>(): PromptbookStorage<TItem>;
-/**
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
- */
+/** Note: [🔵] Code for browser storage helper [getLocalStorage](src/storage/local-storage/getLocalStorage.ts) should never be published outside of `@promptbook/browser` */

package/umd/src/storage/local-storage/getSessionStorage.d.ts

@@ -5,6 +5,4 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
  * @public exported from `@promptbook/browser`
  */
 export declare function getSessionStorage<TItem>(): PromptbookStorage<TItem>;
-/**
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
- */
+/** Note: [🔵] Code for browser storage helper [getSessionStorage](src/storage/local-storage/getSessionStorage.ts) should never be published outside of `@promptbook/browser` */

package/umd/src/transpilers/openai-sdk/playground/playground.d.ts

@@ -1,5 +1,3 @@
 #!/usr/bin/env ts-node
 export {};
-/**
- * Note: [⚫] Code in this file should never be published in any package
- */
+/** Note: [⚫] Code for playground [openai-sdk playground](src/transpilers/openai-sdk/playground/playground.ts) should never be published in any package */

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

@@ -0,0 +1,11 @@
+import type { really_unknown } from '../utils/organization/really_unknown';
+import type { ReservedParameters_private } from './ReservedParameters_private';
+import type { string_parameter_name } from './string_parameter_name';
+/**
+ * Parameters to pass to execution of the pipeline
+ *
+ * Note: [🚉] This should be fully serializable as JSON
+ * @see https://ptbk.io/parameters
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type InputParameters_private = Exclude<Record<string_parameter_name, really_unknown>, ReservedParameters_private>;

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

@@ -0,0 +1,16 @@
+import type { ReservedParameters_private } from './ReservedParameters_private';
+import type { string_parameter_name } from './string_parameter_name';
+import type { string_parameter_value_private } from './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
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type Parameters_private = Exclude<Record<string_parameter_name, string_parameter_value_private>, ReservedParameters_private>;

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

@@ -0,0 +1,10 @@
+import type { string_reserved_parameter_name_private } from './string_reserved_parameter_name_private';
+import type { string_parameter_value_private } from './string_parameter_value_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
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type ReservedParameters_private = Record<string_reserved_parameter_name_private, string_parameter_value_private>;

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

@@ -0,0 +1,21 @@
+import type { number_integer, number_positive } from './number_positive';
+/**
+ * Byte count helper.
+ */
+export type number_bytes = number_integer & number_positive;
+/**
+ * Kilobyte count helper.
+ */
+export type number_kilobytes = number_positive;
+/**
+ * Megabyte count helper.
+ */
+export type number_megabytes = number_positive;
+/**
+ * Gigabyte count helper.
+ */
+export type number_gigabytes = number_positive;
+/**
+ * Terabyte count helper.
+ */
+export type number_terabytes = number_positive;

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

@@ -0,0 +1,13 @@
+import type { number_integer, number_positive } from './number_positive';
+/**
+ * Semantic helper for incremental IDs
+ */
+export type number_id = number_integer & (number_positive | 0);
+/**
+ * Semantic helper for number of rows and columns
+ */
+export type number_linecol_number = number_integer & number_positive;
+/**
+ * Semantic helper for number of tokens
+ */
+export type number_tokens = number_integer & (number_positive | 0);

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

@@ -0,0 +1,8 @@
+/**
+ * Likeness of the wallpaper
+ *
+ * - 👍 is equivalent to 1
+ * - 👎 is equivalent to -1
+ * - ❤ is equivalent to more than 1
+ */
+export type number_likeness = number;

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

@@ -0,0 +1,33 @@
+import type { number_integer } from './number_positive';
+/**
+ * Milliseconds helper.
+ */
+export type number_milliseconds = number_integer;
+/**
+ * Seconds helper.
+ */
+export type number_seconds = number;
+/**
+ * Minutes helper.
+ */
+export type number_minutes = number;
+/**
+ * Hours helper.
+ */
+export type number_hours = number;
+/**
+ * Days helper.
+ */
+export type number_days = number;
+/**
+ * Weeks helper.
+ */
+export type number_weeks = number;
+/**
+ * Months helper.
+ */
+export type number_months = number;
+/**
+ * Years helper.
+ */
+export type number_years = number;

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

@@ -0,0 +1,18 @@
+/**
+ * Semantic helper;
+ * Percentage from 0 to 1 (100%) (and below and above)
+ */
+export type number_percent = number;
+/**
+ * Semantic helper;
+ * Model temperature
+ */
+export type number_model_temperature = number_percent;
+/**
+ * Semantic helper;
+ * Seed for random generator
+ *
+ * Percentage from 0 to 1 (100%)
+ * TODO: Is seed (in OpenAI) number from 0 to 1?
+ */
+export type number_seed = number_percent;

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

@@ -0,0 +1,16 @@
+/**
+ * Positive number helper.
+ */
+export type number_positive = number;
+/**
+ * Negative number helper.
+ */
+export type number_negative = number;
+/**
+ * Integer number helper.
+ */
+export type number_integer = number;
+/**
+ * TCP/UDP port helper.
+ */
+export type number_port = number_positive & number_integer;

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

@@ -2,109 +2,9 @@
  * Semantic helper for US Dollars
  */
 export type number_usd = number;
-/**
- * Semantic helper for incremental IDs
- */
-export type number_id = number_integer & (number_positive | 0);
-/**
- * Semantic helper for number of rows and columns
- */
-export type number_linecol_number = number_integer & number_positive;
-/**
- * Semantic helper for number of tokens
- */
-export type number_tokens = number_integer & (number_positive | 0);
-/**
- * Positive number helper.
- */
-export type number_positive = number;
-/**
- * Negative number helper.
- */
-export type number_negative = number;
-/**
- * Integer number helper.
- */
-export type number_integer = number;
-/**
- * TCP/UDP port helper.
- */
-export type number_port = number_positive & number_integer;
-/**
- * Semantic helper;
- * Percentage from 0 to 1 (100%) (and below and above)
- */
-export type number_percent = number;
-/**
- * Semantic helper;
- * Model temperature
- */
-export type number_model_temperature = number_percent;
-/**
- * Semantic helper;
- * Seed for random generator
- *
- * Percentage from 0 to 1 (100%)
- * TODO: Is seed (in OpenAI) number from 0 to 1?
- */
-export type number_seed = number_percent;
-/**
- * Likeness of the wallpaper
- *
- * - 👍 is equivalent to 1
- * - 👎 is equivalent to -1
- * - ❤ is equivalent to more than 1
- */
-export type number_likeness = number;
-/**
- * Milliseconds helper.
- */
-export type number_milliseconds = number_integer;
-/**
- * Seconds helper.
- */
-export type number_seconds = number;
-/**
- * Minutes helper.
- */
-export type number_minutes = number;
-/**
- * Hours helper.
- */
-export type number_hours = number;
-/**
- * Days helper.
- */
-export type number_days = number;
-/**
- * Weeks helper.
- */
-export type number_weeks = number;
-/**
- * Months helper.
- */
-export type number_months = number;
-/**
- * Years helper.
- */
-export type number_years = number;
-/**
- * Byte count helper.
- */
-export type number_bytes = number_integer & number_positive;
-/**
- * Kilobyte count helper.
- */
-export type number_kilobytes = number_positive;
-/**
- * Megabyte count helper.
- */
-export type number_megabytes = number_positive;
-/**
- * Gigabyte count helper.
- */
-export type number_gigabytes = number_positive;
-/**
- * Terabyte count helper.
- */
-export type number_terabytes = number_positive;
+export type { number_bytes, number_gigabytes, number_kilobytes, number_megabytes, number_terabytes } from './number_bytes';
+export type { number_id, number_linecol_number, number_tokens } from './number_id';
+export type { number_likeness } from './number_likeness';
+export type { number_days, number_hours, number_milliseconds, number_minutes, number_months, number_seconds, number_weeks, number_years, } from './number_milliseconds';
+export type { number_model_temperature, number_percent, number_seed } from './number_percent';
+export type { number_integer, number_negative, number_port, number_positive } from './number_positive';

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

@@ -0,0 +1,9 @@
+import type { string_sha256 } from './string_sha256';
+/**
+ * Semantic helper
+ *
+ * For example `"b126926439c5fcb83609888a11283723c1ef137c0ad599a77a1be81812bd221d"`
+ *
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type string_agent_hash_private = string_sha256;

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * Semantic helper
+ *
+ * For example `"My AI Assistant"`
+ *
+ * TODO: !!!! Brand the type
+ * @private internal utility of `string_parameter_name.ts`
+ */
+export type string_agent_name_private = string;

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

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

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