@promptbook/javascript 0.112.0-32 → 0.112.0-35

package/esm/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts

@@ -6,7 +6,3 @@ import type { PromptbookStorage } from '../../_common/PromptbookStorage';
  * @private for `getLocalStorage` and `getSessionStorage`
  */
 export declare function makePromptbookStorageFromWebStorage<TValue>(webStorage: Storage): PromptbookStorage<TValue>;
-/**
- * TODO: [🧠] Should this be named `makePromptbookStorageFromWebStorage` vs `createPromptbookStorageFromWebStorage`
- * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
- */

package/esm/src/transpilers/_common/register/$bookTranspilersRegister.d.ts

@@ -4,12 +4,10 @@ import type { BookTranspiler } from '../BookTranspiler';
  * Register for book transpilers.
  *
  * Note: `$` is used to indicate that this interacts with the global scope
+ *
  * @singleton Only one instance of each register is created per build, but there can be more instances across different builds or environments.
  * @see https://github.com/webgptorg/promptbook/issues/249
  *
  * @public exported from `@promptbook/core`
  */
 export declare const $bookTranspilersRegister: $Register<BookTranspiler>;
-/**
- * TODO: [®] DRY Register logic
- */

package/esm/src/transpilers/formatted-book-in-markdown/register.d.ts

@@ -4,12 +4,9 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
+ * TODO: !!! Which package should export this?
+ *
  * @public exported from `@promptbook/wizard`
  * @public exported from `@promptbook/cli`
- *
- * TODO: !!! Which package should export this?
  */
 export declare const _FormattedBookInMarkdownTranspilerRegistration: Registration;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

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

@@ -1,5 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/**
- * Note: [⚫] Code in this file should never be published in any package
- */

package/esm/src/transpilers/openai-sdk/register.d.ts

@@ -4,12 +4,9 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
+ * TODO: [🧠] Which package should export this?
+ *
  * @public exported from `@promptbook/wizard`
  * @public exported from `@promptbook/cli`
- *
- * TODO: [🧠] Which package should export this?
  */
 export declare const _OpenAiSdkTranspilerRegistration: Registration;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

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

@@ -6,6 +6,7 @@
  * 3) Array represents itself
  *
  * @deprecated Use `Arrayable` from `type-fest` instead
+ *
  * @private internal type
  */
 export type Arrayable<TItem> = TItem | ReadonlyArray<TItem> | undefined;

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

@@ -0,0 +1,13 @@
+import type { really_unknown } from '../utils/organization/really_unknown';
+import type { ReservedParameters_private } from './ReservedParameters_private';
+import type { string_parameter_name } from './string_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 `Parameters.ts`
+ */
+export type InputParameters_private = Exclude<Record<string_parameter_name, really_unknown>, ReservedParameters_private>;

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

@@ -3,6 +3,3 @@
  * Controls how temporary or intermediate files are managed throughout processing.
  */
 export type IntermediateFilesStrategy = 'HIDE_AND_CLEAN' | 'HIDE_AND_KEEP';
-/**
- * TODO: [🎅] Maube add options for all kinds of cache, unite with `isCacheReloaded` and make `cacheStrategy` (which is not specific only for intermediate files)
- */

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

@@ -15,6 +15,3 @@ export type LlmCall = {
      */
     readonly report: ExecutionPromptReportJson;
 };
-/**
- * TODO: !!! Maybe different shape of LlmCall
- */

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

@@ -7,6 +7,7 @@ import type OpenAI from 'openai';
  * It does not specify the LLM with concrete version itself, only the requirements for the LLM.
  *
  * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook#model-requirements
  */
 export type ModelRequirements = CompletionModelRequirements | ChatModelRequirements | ImageGenerationModelRequirements | EmbeddingModelRequirements;

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

@@ -9,7 +9,10 @@ import type { TupleToUnion } from 'type-fest';
  */
 export type ModelVariant = TupleToUnion<typeof MODEL_VARIANTS>;
 /**
+ * Constant for model variants.
+ *
  * @see {@link ModelVariant}
+ *
  * @public exported from `@promptbook/core`
  */
 export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "IMAGE_GENERATION", "EMBEDDING"];

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

@@ -0,0 +1,18 @@
+import type { ReservedParameters_private } from './ReservedParameters_private';
+import type { string_parameter_name } from './string_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 `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

@@ -0,0 +1,11 @@
+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 `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/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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_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

@@ -0,0 +1,8 @@
+/**
+ * Semantic helper
+ *
+ * For example `"My AI Assistant"`
+ *
+ * @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

@@ -0,0 +1,10 @@
+/**
+ * Semantic helper
+ *
+ * For example `"My AI Assistant"`
+ *
+ * TODO: !!!! Brand the type
+ *
+ * @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

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

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.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

@@ -0,0 +1,6 @@
+/**
+ * Semantic helper
+ *
+ * @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

@@ -0,0 +1,8 @@
+/**
+ * Semantic helper
+ *
+ * For example `"a"`
+ *
+ * @private internal utility of `string_page.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_prompt.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_prompt.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;