@promptbook/openai 0.61.0-10 → 0.61.0-12

package/esm/typings/src/execution/PromptResult.d.ts

@@ -15,15 +15,21 @@ export type PromptResult = PromptCompletionResult | PromptChatResult | PromptEmb
 /**
  * Prompt completion result
  * It contains only the following text NOT the whole completion
+ *
+ * Note: This is fully serializable as JSON
  */
 export type PromptCompletionResult = PromptCommonResult;
 /**
  * Prompt chat result
+ *
+ * Note: This is fully serializable as JSON
  */
 export type PromptChatResult = PromptCommonResult & {};
 /**
  * Prompt embedding result
  * It contains only the following text NOT the whole completion
+ *
+ * Note: This is fully serializable as JSON
  */
 export type PromptEmbeddingResult = Omit<PromptCommonResult, 'content'> & {
     /**
@@ -31,6 +37,11 @@ export type PromptEmbeddingResult = Omit<PromptCommonResult, 'content'> & {
      */
     content: EmbeddingVector;
 };
+/**
+ * Common properties for all prompt results
+ *
+ * Note: This is fully serializable as JSON
+ */
 export type PromptCommonResult = {
     /**
      * Exact text response from the model
@@ -111,4 +122,5 @@ export type UncertainNumber = {
  * TODO: [🧠] Maybe type raw properly - not onject but OpenAI.result.whatever
  * TODO: [🧠] Maybe remove redundant raw.choices.text
  * TODO: Log raw even if prompt failed - log the raw error
+ * TODO: [🏳] Add `PromptTranslationResult`
  */

package/esm/typings/src/execution/ScriptExecutionTools.d.ts

@@ -1,5 +1,6 @@
 import type { ScriptLanguage } from '../types/ScriptLanguage';
-import type { string_name } from '../types/typeAliases';
+import type { string_parameter_name } from '../types/typeAliases';
+import type { string_parameter_value } from '../types/typeAliases';
 import type { string_script } from '../types/typeAliases';
 /**
  * Represents all the tools needed to EXECUTE SCRIPTs
@@ -22,7 +23,7 @@ export type ScriptExecutionToolsExecuteOptions = {
      * Theese parameters are passed to the script as variables
      * For example: { "name": "John" } => const name = "John";
      */
-    readonly parameters: Record<string_name, string>;
+    readonly parameters: Record<string_parameter_name, string_parameter_value>;
     /**
      * The content of the script to execute
      * - It can be a single statement
@@ -35,4 +36,5 @@ export type ScriptExecutionToolsExecuteOptions = {
 };
 /**
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
  */

package/esm/typings/src/execution/createPipelineExecutor.d.ts

@@ -36,8 +36,10 @@ export declare function createPipelineExecutor(options: CreatePipelineExecutorOp
 export {};
 /**
  * TODO: [🪂] Pass maxParallelCount here
+ * TODO: [♈] Probbably move expectations from templates to parameters
  * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
  * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
  * Note: CreatePipelineExecutorOptions are just connected to PipelineExecutor so do not extract to types folder
  * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/esm/typings/src/formats/csv/ListFormatDefinition.d.ts

@@ -8,4 +8,5 @@ export declare const CsvFormatDefinition: FormatDefinition<string, string, objec
  * TODO: [🍓] In `CsvFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `CsvFormatDefinition` implement `heal
  * TODO: [🍓] In `CsvFormatDefinition` implement `extractValues`
+ * TODO: [🏢] Allow to expect something inside CSV objects and other formats
  */

package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts

@@ -12,4 +12,5 @@ export declare const JsonFormatDefinition: FormatDefinition<string, string, obje
  * TODO: [🍓] In `JsonFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `JsonFormatDefinition` implement `heal
  * TODO: [🍓] In `JsonFormatDefinition` implement `extractValues`
+ * TODO: [🏢] Allow to expect something inside JSON objects and other formats
  */

package/esm/typings/src/formats/list/ListFormatDefinition.d.ts

@@ -10,4 +10,5 @@ export declare const ListFormatDefinition: FormatDefinition<string, string, obje
  * TODO: [🍓] In `ListFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `ListFormatDefinition` implement `heal
  * TODO: [🍓] In `ListFormatDefinition` implement `extractValues`
+ * TODO: [🏢] Allow to expect something inside each item of list and other formats
  */

package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts

@@ -12,4 +12,5 @@ export declare const XmlFormatDefinition: FormatDefinition<string, string, objec
  * TODO: [🍓] In `XmlFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `XmlFormatDefinition` implement `heal
  * TODO: [🍓] In `XmlFormatDefinition` implement `extractValues`
+ * TODO: [🏢] Allow to expect something inside XML and other formats
  */

package/esm/typings/src/knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts

@@ -15,3 +15,6 @@ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
      */
     promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
 }
+/**
+ * Note: [🔵] This code should never be published outside of `@promptbook/browser`
+ */ 

package/esm/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.d.ts

@@ -5,10 +5,10 @@ import type { KnowledgeSourceJson } from '../../../types/PipelineJson/KnowledgeS
  * Prepares the knowle
  *
  * @see https://github.com/webgptorg/promptbook/discussions/41
- * @private within the package
  */
 export declare function prepareKnowledgePieces(knowledgeSources: Array<KnowledgeSourceJson>, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'preparationIds'>>>;
 /**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
  *       Put `knowledgePieces` into `PrepareKnowledgeOptions`
  * TODO: [🪂] More than max things can run in parallel by acident [1,[2a,2b,_],[3a,3b,_]]

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -6,6 +6,7 @@ import type { string_markdown } from '../../../types/typeAliases';
  */
 export declare function prepareKnowledgeFromMarkdown(content: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
 /**
+ * TODO: [🔼] !!! Export via `@promptbook/markdown`
  * TODO: [🪂] Do it in parallel 11:11
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
  */

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts

@@ -1 +1,4 @@
 export {};
+/**
+ * TODO: [📓] Maybe test all file in samples (not just 10-simple.md)
+ */

package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -6,6 +6,7 @@ import type { string_base64 } from '../../../types/typeAliases';
  */
 export declare function prepareKnowledgeFromPdf(content: string_base64, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
 /**
+ * TODO: [🔼] !!! Export via `@promptbook/pdf`
  * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
  *       @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
  * TODO: [🪂] Do it in parallel

package/esm/typings/src/llm-providers/_common/createLlmToolsFromEnv.d.ts

@@ -0,0 +1,22 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+/**
+ * @@@
+ *
+ * Note: This function is not cached, every call creates new instance of LlmExecutionTools
+ *
+ * It looks for environment variables:
+ * - `process.env.OPENAI_API_KEY`
+ * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
+ *
+ * @returns @@@
+ */
+export declare function createLlmToolsFromEnv(): LlmExecutionTools;
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/node`
+ * TODO: @@@ write discussion about this - wizzard
+ * TODO: Add Azure
+ * TODO: [🧠] Which name is better `createLlmToolsFromEnv` or `createLlmToolsFromEnvironment`?
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ * TODO: [🧠] Maybe pass env as argument
+ * Note: [🟢] This code should never be published outside of `@promptbook/node`
+ */

package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts

@@ -0,0 +1,10 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+/**
+ * Returns LLM tools for CLI
+ *
+ * @private within the repository - for CLI utils
+ */
+export declare function getLlmToolsForCli(): LlmExecutionTools;
+/**
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
+ */

package/esm/typings/src/llm-providers/_common/getLlmToolsForTestingAndScriptsAndPlayground.d.ts

@@ -0,0 +1,10 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+/**
+ * Returns LLM tools for testing purposes
+ *
+ * @private within the repository - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
+ */
+export declare function getLlmToolsForTestingAndScriptsAndPlayground(): LlmExecutionTools;
+/**
+ * Note: [⚪] This should never be in any released package
+ */

package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts

@@ -0,0 +1,29 @@
+import type { PromptResult } from '../../../../execution/PromptResult';
+import type { Prompt } from '../../../../types/Prompt';
+import type { string_date_iso8601 } from '../../../../types/typeAliases';
+import type { string_promptbook_version } from '../../../../version';
+/**
+ * @@@
+ */
+export type CacheItem = {
+    /**
+     * @@@
+     */
+    date: string_date_iso8601;
+    /**
+     * @@@
+     */
+    promptbookVersion: string_promptbook_version;
+    /**
+     * @@@
+     */
+    prompt: Prompt;
+    /**
+     * @@@
+     */
+    promptResult: PromptResult;
+};
+/**
+ * TODO: [🧠] Should be this exported alongsite `cacheLlmTools` through `@promptbook/utils` OR through `@promptbook/types`
+ * TODO: [🛫] `prompt` is NOT fully serializable as JSON, it contains functions which are not serializable, fix it
+ */

package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts

@@ -0,0 +1,10 @@
+import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
+import type { CacheItem } from './CacheItem';
+export type CacheLlmToolsOptions = {
+    /**
+     * Total cost of the execution
+     *
+     * @default MemoryStorage
+     */
+    storage: PromptbookStorage<CacheItem>;
+};

package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts

@@ -0,0 +1,16 @@
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
+/**
+ * Intercepts LLM tools and counts total usage of the tools
+ *
+ * @param llmTools LLM tools to be intercepted with usage counting
+ * @returns LLM tools with same functionality with added total cost counting
+ */
+export declare function cacheLlmTools(llmTools: LlmExecutionTools, options?: Partial<CacheLlmToolsOptions>): LlmExecutionTools;
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
+ * TODO: @@@ write discussion about this and storages
+ *            write how to combine multiple interceptors
+ * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ */

package/esm/typings/src/llm-providers/_common/utils/count-total-cost/LlmExecutionToolsWithTotalCost.d.ts

@@ -0,0 +1,11 @@
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+import type { PromptResultUsage } from '../../../../execution/PromptResult';
+/**
+ * LLM tools with option to get total cost of the execution
+ */
+export type LlmExecutionToolsWithTotalCost = LlmExecutionTools & {
+    /**
+     * Total cost of the execution
+     */
+    totalUsage: PromptResultUsage;
+};

package/esm/typings/src/llm-providers/_common/utils/count-total-cost/countTotalCost.d.ts

@@ -0,0 +1,14 @@
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+import type { LlmExecutionToolsWithTotalCost } from './LlmExecutionToolsWithTotalCost';
+/**
+ * Intercepts LLM tools and counts total usage of the tools
+ *
+ * @param llmTools LLM tools to be intercepted with usage counting
+ * @returns LLM tools with same functionality with added total cost counting
+ */
+export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalCost;
+/**
+ * TODO: [🔼] !!! Export via `@promptbookcore/`
+ * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ */

package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -45,4 +45,5 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
  * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom OpenaiError
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  */

package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -15,7 +15,7 @@ export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
 }>;
 /**
  * Note: [🤖] Add models of new variant
- * TODO: !!!! Add embedding models OR Anthropic has only chat+completion models?
+ * TODO: [🧠] !!! Add embedding models OR Anthropic has only chat+completion models?
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
  * TODO: [🕚] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing

package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts

@@ -1,2 +1,5 @@
 #!/usr/bin/env ts-node
 export {};
+/**
+ * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ */

package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts

@@ -44,4 +44,5 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
 /**
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom AzureOpenaiError
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  */

package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts

@@ -1,2 +1,5 @@
 #!/usr/bin/env ts-node
 export {};
+/**
+ * TODO: Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ */

package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts

@@ -10,3 +10,6 @@ export declare class LangtailExecutionTools extends OpenAiExecutionTools impleme
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
 }
+/**
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ */ 

package/esm/typings/src/llm-providers/langtail/LangtailExecutionToolsOptions.d.ts

@@ -7,5 +7,5 @@ import type { OpenAiExecutionToolsOptions } from '../openai/OpenAiExecutionTools
  */
 export type LangtailExecutionToolsOptions = OpenAiExecutionToolsOptions;
 /**
- * TODO: !!! Use or remove
+ * TODO: !! Use or remove
  */

package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -29,6 +29,6 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: [🕵️‍♀️] Maybe just remove
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params
  */

package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -34,5 +34,5 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: [🕵️‍♀️] Maybe just remove
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  */

package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts

@@ -41,10 +41,12 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
     private callModelCommon;
     /**
      * List all available models that can be used
-     * This liost is a combination of all available models from all execution tools
+     * This lists is a combination of all available models from all execution tools
      */
     listModels(): Promise<Array<AvailableModel>>;
 }
 /**
  * TODO: [🧠][🎛] Aggregating multiple models - have result not only from one first aviable model BUT all of them
+ * TODO: [🏖] If no llmTools have for example not defined `callCompletionModel` this will still return object with defined `callCompletionModel` which just throws `PipelineExecutionError`, make it undefined instead
+ *       Look how `countTotalUsage` (and `cacheLlmTools`) implements it
  */

package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts

@@ -62,4 +62,5 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
  * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom OpenaiError
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  */

package/esm/typings/src/llm-providers/openai/computeUsage.d.ts

@@ -4,13 +4,13 @@
  * @see https://openai.com/api/pricing/
  * @see https://docs.anthropic.com/en/docs/models-overview
  *
- * @private within the package, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
+ * @private within the repository, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
  */
 type string_model_price = `$${number}.${number} / ${number}M tokens`;
 /**
  * Function computeUsage will create price per one token based on the string value found on openai page
  *
- * @private within the package, used only as internal helper for `OPENAI_MODELS`
+ * @private within the repository, used only as internal helper for `OPENAI_MODELS`
  */
 export declare function computeUsage(value: string_model_price): number;
 export {};

package/esm/typings/src/llm-providers/openai/openai-models.d.ts

@@ -24,4 +24,5 @@ export declare const OPENAI_MODELS: Array<AvailableModel & {
  * @see /other/playground/playground.ts
  * TODO: [🍓] Make better
  * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
+ * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
  */

package/esm/typings/src/llm-providers/openai/playground/playground.d.ts

@@ -1,2 +1,5 @@
 #!/usr/bin/env ts-node
 export {};
+/**
+ * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ */

package/esm/typings/src/personas/preparePersona.d.ts

@@ -5,9 +5,11 @@ import type { string_persona_description } from '../types/typeAliases';
  * Prepares the persona for the pipeline
  *
  * @see https://github.com/webgptorg/promptbook/discussions/22
- * @private within the package
  */
 export declare function preparePersona(personaDescription: string_persona_description, options: PrepareOptions): Promise<PersonaPreparedJson['modelRequirements']>;
 /**
- * TODO: [🪂] Do it in parallel
+ * TODO: [🔼] !!! Export via `@promptbook/core`
+ * TODO: [🏢] !! Check validity of `modelName` in pipeline
+ * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
+ * TODO: [🏢] !! Check validity of `temperature` in pipeline
  */

package/esm/typings/src/prepare/preparePipeline.d.ts

@@ -8,8 +8,10 @@ import type { PrepareOptions } from './PrepareOptions';
  */
 export declare function preparePipeline(pipeline: PipelineJson, options: PrepareOptions): Promise<PipelineJson>;
 /**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
- * TODO: [💸] Make utilities `interceptLlmTools` and `costLlmTools` to compute cost and DO put this counting logic in `prepareKnowledge` or `preparePersona`
+ * TODO: [🎐] !!!! Use here countTotalUsage
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/esm/typings/src/prepare/unpreparePipeline.d.ts

@@ -4,5 +4,6 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
  */
 export declare function unpreparePipeline(pipeline: PipelineJson): PipelineJson;
 /**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
  * TODO: Write tests for `preparePipeline`
  */

package/esm/typings/src/storage/_common/PromptbookStorage.d.ts

@@ -0,0 +1,25 @@
+import { Promisable } from 'type-fest';
+/**
+ * Storage of objects with asynchronous API
+ *
+ * Note: Naming `PromptbookStorage` not `Storage` to avoid name collision with global `Storage` interface.
+ * Note: This is simmilar to Web Storage API interface but everything is asynchronous and can store JSON objects.
+ */
+export type PromptbookStorage<TItem> = {
+    /**
+     * 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): Promisable<void>;
+};
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/types`
+ * TODO: [🧠][🛫] Constrain `TItem` to JSON-serializable objects only
+ */

package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts

@@ -0,0 +1,5 @@
+export {};
+/**
+ * Note: [⚪] This should never be in any released package
+ * TODO: Is this a good pattern to do type testing?
+ */

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

@@ -0,0 +1,30 @@
+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`
+ */

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

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

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

@@ -0,0 +1,7 @@
+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

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

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

@@ -0,0 +1,9 @@
+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`
+ */

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

@@ -0,0 +1,9 @@
+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`
+ */

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

@@ -0,0 +1,34 @@
+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`
+ */

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

@@ -0,0 +1,26 @@
+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`
+ */