@promptbook/wizard 0.95.0

package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts

@@ -0,0 +1,8 @@
+import type { string_name } from '../../../types/typeAliases';
+/**
+ * Converts a name to a properly formatted subfolder path for cache storage.
+ * Handles normalization and path formatting to create consistent cache directory structures.
+ *
+ * @private for `FileCacheStorage`
+ */
+export declare function nameToSubfolderPath(name: string_name): ReadonlyArray<string>;

package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/storage/local-storage/getIndexedDbStorage.d.ts

@@ -0,0 +1,11 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import type { IndexedDbStorageOptions } from './utils/IndexedDbStorageOptions';
+/**
+ * Gets wrapper around IndexedDB which can be used as PromptbookStorage
+ *
+ * @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`
+ */

package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts

@@ -0,0 +1,10 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * Gets wrapper around `localStorage` object which can be used as `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`
+ */

package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts

@@ -0,0 +1,10 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * Gets wrapper around `sessionStorage` object which can be used as `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`
+ */

package/esm/typings/src/storage/local-storage/utils/IndexedDbStorageOptions.d.ts

@@ -0,0 +1,14 @@
+import type { string_name } from '../../../types/typeAliases';
+/**
+ * Options for IndexedDB storage
+ */
+export type IndexedDbStorageOptions = {
+    /**
+     * Name of the database
+     */
+    databaseName: string_name;
+    /**
+     * Name of the object store (table) in the database
+     */
+    storeName: string_name;
+};

package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts

@@ -0,0 +1,8 @@
+import type { PromptbookStorage } from '../../_common/PromptbookStorage';
+import type { IndexedDbStorageOptions } from './IndexedDbStorageOptions';
+/**
+ * Creates a PromptbookStorage backed by IndexedDB.
+ * Uses a single object store named 'promptbook'.
+ * @private for `getIndexedDbStorage`
+ */
+export declare function makePromptbookStorageFromIndexedDb<TValue>(options: IndexedDbStorageOptions): PromptbookStorage<TValue>;

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

@@ -0,0 +1,12 @@
+import type { PromptbookStorage } from '../../_common/PromptbookStorage';
+/**
+ * Creates a Promptbook storage interface from a web storage object.
+ * Facilitates using Web Storage (localStorage/sessionStorage) as a storage backend.
+ *
+ * @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/typings/src/storage/memory/MemoryStorage.d.ts

@@ -0,0 +1,33 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * Stores data in memory (HEAP)
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class MemoryStorage<TItem> implements PromptbookStorage<TItem> {
+    private storage;
+    /**
+     * Returns the number of key/value pairs currently present in the list associated with the object.
+     */
+    get length(): number;
+    /**
+     * Empties the list associated with the object of all key/value pairs, if there are any.
+     */
+    clear(): void;
+    /**
+     * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
+     */
+    getItem(key: string): TItem | null;
+    /**
+     * Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
+     */
+    key(index: number): string | null;
+    /**
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     */
+    setItem(key: string, value: TItem): void;
+    /**
+     * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
+     */
+    removeItem(key: string): void;
+}

package/esm/typings/src/storage/utils/PrefixStorage.d.ts

@@ -0,0 +1,25 @@
+import type { Promisable } from 'type-fest';
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * This class behaves like LocalStorage but separates keys by prefix
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class PrefixStorage<TItem> implements PromptbookStorage<TItem> {
+    private baseStorage;
+    private keyPrefix;
+    private separator;
+    constructor(baseStorage: PromptbookStorage<TItem>, keyPrefix: string, separator?: string);
+    /**
+     * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
+     */
+    getItem(key: string): Promisable<TItem | null>;
+    /**
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     */
+    setItem(key: string, value: TItem): Promisable<void>;
+    /**
+     * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
+     */
+    removeItem(key: string): void;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * Item or array of items
+ *
+ * 1) Any item except array and undefined represents array with that one item (also null)
+ * 2) Undefined represents empty array
+ * 3) Array represents itself
+ *
+ * @deprecated Use `Arrayable` from `type-fest` instead
+ * @private internal type
+ */
+export type Arrayable<TItem> = TItem | ReadonlyArray<TItem> | undefined;

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

@@ -0,0 +1,8 @@
+/**
+ * Defines strategies for handling intermediate files during pipeline execution.
+ * 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/typings/src/types/ModelRequirements.d.ts

@@ -0,0 +1,104 @@
+import type { ModelVariant } from './ModelVariant';
+import type { number_model_temperature } from './typeAliases';
+import type { number_seed } from './typeAliases';
+import type { string_model_name } from './typeAliases';
+import type { string_system_message } from './typeAliases';
+/**
+ * Abstract way to specify the LLM.
+ * 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 | EmbeddingModelRequirements;
+/**
+ * Model requirements for the completion variant
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type CompletionModelRequirements = CommonModelRequirements & {
+    /**
+     * Completion model variant
+     */
+    modelVariant: 'COMPLETION';
+};
+/**
+ * Model requirements for the chat variant
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ChatModelRequirements = CommonModelRequirements & {
+    /**
+     * Chat model variant
+     */
+    modelVariant: 'CHAT';
+    /**
+     * System message to be used in the model
+     */
+    readonly systemMessage?: string_system_message;
+};
+/**
+ * Model requirements for the embedding variant
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type EmbeddingModelRequirements = CommonModelRequirements & {
+    /**
+     * Embedding model variant
+     */
+    modelVariant: 'EMBEDDING';
+};
+/**
+ * Common properties for all model requirements variants
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ *
+ * @private just abstract the common properties of the model requirements
+ */
+export type CommonModelRequirements = {
+    /**
+     * Model variant describes the very general type of the model
+     *
+     * There are 3 variants:
+     * - **COMPLETION** - model that takes prompt and writes the rest of the text
+     * - **CHAT** - model that takes prompt and previous messages and returns response
+     * - **EMBEDDING** - model that takes prompt and returns embedding
+     * <- [🤖]
+     */
+    readonly modelVariant: ModelVariant;
+    /**
+     * The model for text prompt
+     *
+     * Note: Model must be compatible with the model variant
+     * Note: If not specified, the best model for the variant will be used
+     *
+     * @example 'gpt-4', 'gpt-4-32k-0314', 'gpt-3.5-turbo-instruct',...
+     */
+    readonly modelName?: string_model_name;
+    /**
+     * The temperature of the model
+     *
+     * Note: [💱] Promptbook is using just `temperature` (not `top_k` and `top_p`)
+     */
+    readonly temperature?: number_model_temperature;
+    /**
+     * Seed for the model
+     */
+    readonly seed?: number_seed;
+    /**
+     * Maximum number of tokens that can be generated by the model
+     *
+     * Note: [🌾]
+     */
+    readonly maxTokens?: number;
+};
+/**
+ * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (similar that `user` identification is not here)
+ * TODO: [🧠][💱] Add more model options: `stop_token`, `logit_bias`, `logprobs` (`top_logprobs`), `top_k`, `top_p`, `presence_penalty`, `frequency_penalty`, `bestOf`, `logitBias`, `logitBiasType`,...
+ *       [💱] Probably keep using just `temperature` in Promptbook (not `top_k` and `top_p`)
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ * TODO: Maybe figure out better word than "variant"
+ * TODO: Add here more requirement options like max context size, max tokens, etc.
+ * TODO: [💕][🧠] Just selecting gpt3 or gpt4 level of model
+ * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
+ */

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

@@ -0,0 +1,15 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Model variant describes the very general type of the model
+ *
+ * There are these supported model variants:
+ * - `COMPLETION` - Model that takes prompt and writes the rest of the text
+ * - `CHAT` - Model that takes prompt and previous messages and returns response
+ * - `EMBEDDING` - Model that convert text into vector representations
+ */
+export type ModelVariant = TupleToUnion<typeof MODEL_VARIANTS>;
+/**
+ * @see {@link ModelVariant}
+ * @public exported from `@promptbook/core`
+ */
+export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];

package/esm/typings/src/types/NonEmptyArray.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Represents an array that is guaranteed to have at least one element
+ */
+export type NonEmptyArray<TItem> = [TItem, ...TItem[]];
+/**
+ * Represents an array that is guaranteed to have at least one element and is readonly
+ */
+export type NonEmptyReadonlyArray<TItem> = ReadonlyArray<TItem> & NonEmptyArray<TItem>;

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

@@ -0,0 +1,111 @@
+import type { FormatCommand } from '../commands/FORMAT/FormatCommand';
+import type { Expectations } from '../pipeline/PipelineJson/Expectations';
+import type { ChatModelRequirements } from './ModelRequirements';
+import type { CompletionModelRequirements } from './ModelRequirements';
+import type { EmbeddingModelRequirements } from './ModelRequirements';
+import type { ModelRequirements } from './ModelRequirements';
+import type { Parameters } from './typeAliases';
+import type { string_pipeline_url_with_task_hash } from './typeAliases';
+import type { string_postprocessing_function_name } from './typeAliases';
+import type { string_prompt } from './typeAliases';
+import type { string_template } from './typeAliases';
+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 | EmbeddingPrompt;
+/**
+ * Completion prompt
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type CompletionPrompt = CommonPrompt & {
+    /**
+     * Requirements for completion model
+     */
+    modelRequirements: CompletionModelRequirements;
+};
+/**
+ * Chat prompt
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ChatPrompt = CommonPrompt & {
+    /**
+     * Requirements for chat model
+     */
+    modelRequirements: ChatModelRequirements;
+};
+/**
+ * Embedding prompt
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type EmbeddingPrompt = CommonPrompt & {
+    /**
+     * Requirements for chat model
+     */
+    modelRequirements: EmbeddingModelRequirements;
+};
+/**
+ * Common properties for all prompt results
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ *
+ * @private just abstract the common properties of the prompts
+ */
+export type CommonPrompt = {
+    /**
+     * The title of the prompt
+     *
+     * Note: This has no effect on the model, it is just for the reporting
+     */
+    readonly title: string_title;
+    /**
+     * The text of the prompt with placeholders for parameters
+     *
+     * @example "What is the capital of {country}?"
+     */
+    readonly content: string_prompt & string_template;
+    /**
+     * Requirements for the model
+     */
+    readonly modelRequirements: ModelRequirements;
+    /**
+     * List of postprocessing steps that are executed after the prompt
+     */
+    readonly postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>;
+    /**
+     * Expectations for the answer
+     *
+     * For example 5 words, 3 sentences, 2 paragraphs, ...
+     * If not set, nothing is expected from the answer
+     */
+    readonly expectations?: Expectations;
+    /**
+     * Expect this format of the answer
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     * @deprecated [💝]
+     */
+    readonly format?: FormatCommand['format'];
+    /**
+     * Unique identifier of the pipeline with specific task name as hash
+     *
+     * @example https://promptbook.studio/webgpt/write-website-content-cs.book#keywords
+     */
+    readonly pipelineUrl?: string_pipeline_url_with_task_hash;
+    /**
+     * Parameters used in the `content`
+     */
+    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/typings/src/types/ScriptLanguage.d.ts

@@ -0,0 +1,13 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Script language
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ScriptLanguage = TupleToUnion<typeof SUPPORTED_SCRIPT_LANGUAGES>;
+/**
+ * Supported script languages
+ *
+ * @private internal base for `ScriptLanguage`
+ */
+export declare const SUPPORTED_SCRIPT_LANGUAGES: readonly ["javascript", "typescript", "python"];

package/esm/typings/src/types/SectionType.d.ts

@@ -0,0 +1,21 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Type of the section
+ */
+export type SectionType = TupleToUnion<typeof SectionTypes>;
+/**
+ * All available sections which are not tasks
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const NonTaskSectionTypes: readonly ["EXAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];
+/**
+ * All available section types
+ *
+ * There is is distinction between task types and section types
+ * - Every section in markdown has its SectionType
+ * - Some sections are tasks but other can be non-task sections
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const SectionTypes: readonly [...("PROMPT_TASK" | "SIMPLE_TASK" | "SCRIPT_TASK" | "DIALOG_TASK")[], "EXAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];

package/esm/typings/src/types/TaskType.d.ts

@@ -0,0 +1,15 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Type of the task
+ */
+export type TaskType = TupleToUnion<typeof TaskTypes>;
+/**
+ * All available task types
+ *
+ * There is is distinction between task types and section types
+ * - Every section in markdown has its SectionType
+ * - Some sections are tasks but other can be non-task sections
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const TaskTypes: readonly ["PROMPT", "SIMPLE", "SCRIPT", "DIALOG"];