@promptbook/cli 0.62.2 → 0.63.0-0

package/esm/typings/src/storage/files-storage/FilesStorage.d.ts

@@ -1,30 +1,31 @@
-import type { PromptbookStorage } from '../_common/PromptbookStorage';
-import type { FilesStorageOptions } from './FilesStorageOptions';
-/**
- * @@@
- */
-export declare class FilesStorage<TItem> implements PromptbookStorage<TItem> {
-    private readonly options;
-    constructor(options: FilesStorageOptions);
-    /**
-     * @@@
-     */
-    private getFilenameForKey;
-    /**
-     * @@@ 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): Promise<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): Promise<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): Promise<void>;
-}
-/**
- * TODO: [🔼] !!! Export via `@promptbook/node`
- * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
- * Note: [🟢] This code should never be published outside of `@promptbook/node`
- */
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import type { FilesStorageOptions } from './FilesStorageOptions';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare class FilesStorage<TItem> implements PromptbookStorage<TItem> {
+    private readonly options;
+    constructor(options: FilesStorageOptions);
+    /**
+     * @@@
+     */
+    private getFilenameForKey;
+    /**
+     * @@@ 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): Promise<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): Promise<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): Promise<void>;
+}
+/**
+ * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
+ * Note: [🟢] This code should never be published outside of `@promptbook/node`
+ */

package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts

@@ -1,13 +1,10 @@
-import type { string_folder_path } from '../../types/typeAliases';
-/**
- * @@@
- */
-export type FilesStorageOptions = {
-    /**
-     * @@@
-     */
-    cacheFolderPath: string_folder_path;
-};
-/**
- * TODO: [🔼] !!! Export via `@promptbook/types`
- */
+import type { string_folder_path } from '../../types/typeAliases';
+/**
+ * @@@
+ */
+export type FilesStorageOptions = {
+    /**
+     * @@@
+     */
+    cacheFolderPath: string_folder_path;
+};

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

@@ -1,7 +1,7 @@
-import type { string_name } from '../../../types/typeAliases';
-/**
- * @@@
- *
- * @private for `FilesStorage`
- */
-export declare function nameToSubfolderPath(name: string_name): Array<string>;
+import type { string_name } from '../../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private for `FilesStorage`
+ */
+export declare function nameToSubfolderPath(name: string_name): Array<string>;

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

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

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

@@ -1,9 +1,10 @@
-import type { PromptbookStorage } from '../_common/PromptbookStorage';
-/**
- * Gets wrapper around `localStorage` object which can be used as `PromptbookStorage`
- */
-export declare function getLocalStorage<TItem>(): PromptbookStorage<TItem>;
-/**
- * TODO: [🔼] !!! Export via `@promptbook/browser`
- * Note: [🔵] This code should never be published outside of `@promptbook/browser`
- */
+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: [🔵] This code should never be published outside of `@promptbook/browser`
+ */

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

@@ -1,9 +1,10 @@
-import type { PromptbookStorage } from '../_common/PromptbookStorage';
-/**
- * Gets wrapper around `sessionStorage` object which can be used as `PromptbookStorage`
- */
-export declare function getSessionStorage<TItem>(): PromptbookStorage<TItem>;
-/**
- * TODO: [🔼] !!! Export via `@promptbook/browser`
- * Note: [🔵] This code should never be published outside of `@promptbook/browser`
- */
+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: [🔵] This code should never be published outside of `@promptbook/browser`
+ */

package/esm/typings/src/storage/memory/MemoryStorage.d.ts

@@ -1,34 +1,33 @@
-import type { PromptbookStorage } from '../_common/PromptbookStorage';
-/**
- * Stores
- */
-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;
-}
-/**
- * TODO: [🔼] !!! Export via `@promptbook/core`
- */
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * Stores
+ *
+ * @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

@@ -1,26 +1,25 @@
-import { Promisable } from 'type-fest';
-import type { PromptbookStorage } from '../_common/PromptbookStorage';
-/**
- * This class behaves like LocalStorage but separates keys by prefix
- */
-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;
-}
-/**
- * TODO: [🔼] !!! Export via `@promptbook/core`
- */
+import { 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/storage/utils/makePromptbookStorageFromWebStorage.d.ts

@@ -1,11 +1,11 @@
-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
- */
+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/typings/src/types/Arrayable.d.ts

@@ -1,10 +1,10 @@
-/**
- * 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
- *
- * @private Internal utility type
- */
-export type Arrayable<TItem> = TItem | Array<TItem> | undefined;
+/**
+ * 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
+ *
+ * @private Internal utility type
+ */
+export type Arrayable<TItem> = TItem | Array<TItem> | undefined;

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

@@ -1,103 +1,102 @@
-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
- */
-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: [🔼] !!!!! (<- To all [🔼]) Export all from `@promptbook/types`
- * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar 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`,...
- *       [💱] Probbably 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"
- */
+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
+ */
+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`) (simmilar 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`,...
+ *       [💱] Probbably 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

@@ -1,14 +1,14 @@
-/**
- * @@@
- *
- * @private for `ModelVariant` and `modelCommandParser`
- */
-export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];
-/**
- * Model variant describes the very general type of the model
- *
- * There are two variants:
- * - **COMPLETION** - model that takes prompt and writes the rest of the text
- * - **CHAT** - model that takes prompt and previous messages and returns response
- */
-export type ModelVariant = typeof MODEL_VARIANTS[number];
+/**
+ * @@@
+ *
+ * @private for `ModelVariant` and `modelCommandParser`
+ */
+export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];
+/**
+ * Model variant describes the very general type of the model
+ *
+ * There are two variants:
+ * - **COMPLETION** - model that takes prompt and writes the rest of the text
+ * - **CHAT** - model that takes prompt and previous messages and returns response
+ */
+export type ModelVariant = typeof MODEL_VARIANTS[number];

package/esm/typings/src/types/PipelineJson/Expectations.d.ts

@@ -1,32 +1,32 @@
-import type { number_integer } from '../typeAliases';
-import type { number_positive } from '../typeAliases';
-/**
- * Expect this amount of each unit in the answer
- *
- * For example 5 words, 3 sentences, 2 paragraphs, ...
- *
- * Note: Expectations are performed after all postprocessing steps
- * @see https://github.com/webgptorg/promptbook/discussions/30
- */
-export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
-    readonly min?: ExpectationAmount;
-    readonly max?: ExpectationAmount;
-}>>;
-/**
- * Units of text measurement
- * @see https://github.com/webgptorg/promptbook/discussions/30
- */
-export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
-/**
- * Unit of text measurement
- * @see https://github.com/webgptorg/promptbook/discussions/30
- */
-export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
-/**
- * Amount of text measurement
- * @see https://github.com/webgptorg/promptbook/discussions/30
- */
-export type ExpectationAmount = number_integer & (number_positive | 0);
-/**
- * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
- */
+import type { number_integer } from '../typeAliases';
+import type { number_positive } from '../typeAliases';
+/**
+ * Expect this amount of each unit in the answer
+ *
+ * For example 5 words, 3 sentences, 2 paragraphs, ...
+ *
+ * Note: Expectations are performed after all postprocessing steps
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ */
+export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
+    readonly min?: ExpectationAmount;
+    readonly max?: ExpectationAmount;
+}>>;
+/**
+ * Units of text measurement
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ */
+export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
+/**
+ * Unit of text measurement
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ */
+export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
+/**
+ * Amount of text measurement
+ * @see https://github.com/webgptorg/promptbook/discussions/30
+ */
+export type ExpectationAmount = number_integer & (number_positive | 0);
+/**
+ * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
+ */