@promptbook/remote-client 0.61.0-11 → 0.61.0-13

package/esm/index.es.js

@@ -214,7 +214,7 @@ var RemoteLlmExecutionTools = /** @class */ (function () {
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.61.0-10';
+var PROMPTBOOK_VERSION = '0.61.0-12';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 export { PROMPTBOOK_VERSION, RemoteLlmExecutionTools };

package/esm/typings/src/_packages/execute-javascript.index.d.ts

@@ -1,4 +1,5 @@
 import spaceTrim from 'spacetrim';
+import { extractBlock } from '../postprocessing/utils/extractBlock';
 import { JavascriptEvalExecutionTools } from '../scripting/javascript/JavascriptEvalExecutionTools';
 import { JavascriptExecutionTools } from '../scripting/javascript/JavascriptExecutionTools';
 import { prettifyMarkdown } from '../utils/markdown/prettifyMarkdown';
@@ -13,7 +14,6 @@ import { normalizeTo_camelCase } from '../utils/normalization/normalizeTo_camelC
 import { normalizeTo_snake_case } from '../utils/normalization/normalizeTo_snake_case';
 import { normalizeWhitespaces } from '../utils/normalization/normalizeWhitespaces';
 import { removeDiacritics } from '../utils/normalization/removeDiacritics';
-import { extractBlock } from '../utils/postprocessing/extractBlock';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
 import { trimCodeBlock } from '../utils/trimCodeBlock';

package/esm/typings/src/_packages/utils.index.d.ts

@@ -7,6 +7,7 @@ import { titleToName } from '../conversion/utils/titleToName';
 import { forEachAsync } from '../execution/utils/forEachAsync';
 import { replaceParameters } from '../execution/utils/replaceParameters';
 import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
+import { extractBlock } from '../postprocessing/utils/extractBlock';
 import { $currentDate } from '../utils/currentDate';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
 import { countLines } from '../utils/expectation-counters/countLines';
@@ -34,7 +35,6 @@ import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFro
 import { removeDiacritics } from '../utils/normalization/removeDiacritics';
 import { searchKeywords } from '../utils/normalization/searchKeywords';
 import { parseNumber } from '../utils/parseNumber';
-import { extractBlock } from '../utils/postprocessing/extractBlock';
 import { $randomSeed } from '../utils/random/randomSeed';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';

package/esm/typings/src/cli/cli-commands/hello.d.ts

@@ -5,3 +5,6 @@ import type { Command as Program } from 'commander';
  * @private part of `promptbookCli`
  */
 export declare function initializeHelloCommand(program: Program): void;
+/**
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
+ */ 

package/esm/typings/src/cli/cli-commands/make.d.ts

@@ -5,3 +5,6 @@ import type { Command as Program } from 'commander';
  * @private part of `promptbookCli`
  */
 export declare function initializeMakeCommand(program: Program): void;
+/**
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
+ */

package/esm/typings/src/cli/cli-commands/prettify.d.ts

@@ -5,3 +5,6 @@ import type { Command as Program } from 'commander';
  * @private part of `promptbookCli`
  */
 export declare function initializePrettifyCommand(program: Program): void;
+/**
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
+ */

package/esm/typings/src/cli/promptbookCli.d.ts

@@ -6,4 +6,5 @@ export declare function promptbookCli(): Promise<void>;
  * TODO: [🥠] Do not export to utils directly, its just for CLI script
  * TODO: [🕌] When more functionalities, rename
  * Note: 11:11
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
  */

package/esm/typings/src/collection/PipelineCollection.d.ts

@@ -5,7 +5,7 @@ import type { string_pipeline_url } from '../types/typeAliases';
 /**
  * Collection that groups together pipelines, knowledge, personas, tools and actions
  *
- * @see !!! https://github.com/webgptorg/pipeline#pipeline-collection
+ * @see @@@ https://github.com/webgptorg/pipeline#pipeline-collection
  */
 export type PipelineCollection = {
     /**

package/esm/typings/src/collection/SimplePipelineCollection.d.ts

@@ -14,7 +14,7 @@ export declare class SimplePipelineCollection implements PipelineCollection {
     /**
      * Constructs a pipeline collection from promptbooks
      *
-     * @param promptbooks !!!
+     * @param promptbooks @@@
      *
      * @private Use instead `createCollectionFromJson`
      * Note: During the construction logic of all promptbooks are validated

package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts

@@ -44,4 +44,5 @@ export declare function createCollectionFromDirectory(path: string_folder_path,
 export {};
 /**
  * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
+ * Note: [🟢] This code should never be published outside of `@promptbook/node`
  */

package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts

@@ -9,4 +9,5 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
 export declare const boilerplateCommandParser: CommandParser<BoilerplateCommand>;
 /**
  * TODO: [💐] Implement BOILERPLATE command into `pipelineStringToJsonSync` function
+ * Note: [⚪] This should never be in any released package
  */

package/esm/typings/src/commands/_common/types/CommandParser.d.ts

@@ -28,7 +28,7 @@ export type CommandParserInput = {
     readonly args: Array<string_name & string_SCREAMING_CASE>;
 };
 /**
- * TODO: !!!! Annotate
+ * TODO: @@@ Annotate all
  * TODO: [🧠] Maybe put flag if it is for whole `.ptbk.md` file of just one section
  * TODO: [🍧] CommandParser should have applyToPipelineJson method
  *       which will apply parsed command to the pipeline JSON

package/esm/typings/src/config.d.ts

@@ -21,4 +21,4 @@ export declare const PIPELINE_COLLECTION_BASE_FILENAME = "index";
 /**
  * The names of the parameters that are reserved for special purposes
  */
-export declare const RESERVED_PARAMETER_NAMES: string[];
+export declare const RESERVED_PARAMETER_NAMES: readonly string[];

package/esm/typings/src/conversion/pipelineJsonToString.d.ts

@@ -8,7 +8,7 @@ import type { PipelineString } from '../types/PipelineString';
  */
 export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
 /**
- * TODO: !!!!! Implement new features and commands into `promptTemplateParameterJsonToString`
+ * TODO: !!!! Implement new features and commands into `promptTemplateParameterJsonToString`
  * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
  * TODO: Escape all
  */

package/esm/typings/src/conversion/validation/validatePipeline.d.ts

@@ -26,6 +26,8 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
  *     >  ex port function validatePipeline(promptbook: unknown): asserts promptbook is PipelineJson {
  */
 /**
- * TODO: [🧠] !!!!! Validate new things
+ * TODO: [🧠][🐣] !!!! Validate that all samples match expectations
+ * TODO: [🧠][🐣] !!!! Validate that knowledge is valid (non-void)
+ * TODO: [🧠] !!! Validationg not only logic itself but imports around - files and websites and rerefenced pipelines exists
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
- */ 
+ */

package/esm/typings/src/errors/LimitReachedError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error type indicates that some limit was reached
+ */
+export declare class LimitReachedError extends Error {
+    readonly name = "LimitReachedError";
+    constructor(message: string);
+}

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

@@ -5,5 +5,6 @@ export type CommonExecutionToolsOptions = {
     readonly isVerbose?: boolean;
 };
 /**
+ * TODO: [🈁] Maybe add here `isDeterministic`
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
  */

package/esm/typings/src/execution/utils/addUsage.d.ts

@@ -1,7 +1,63 @@
 import type { PromptResultUsage } from '../PromptResult';
+/**
+ * @@@
+ *
+ * TODO: [🔼] Export with addUsage
+ */
+export declare const ZERO_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    readonly price: {
+        readonly value: 0;
+    };
+    readonly input: {
+        readonly tokensCount: {
+            readonly value: 0;
+        };
+        readonly charactersCount: {
+            readonly value: 0;
+        };
+        readonly wordsCount: {
+            readonly value: 0;
+        };
+        readonly sentencesCount: {
+            readonly value: 0;
+        };
+        readonly linesCount: {
+            readonly value: 0;
+        };
+        readonly paragraphsCount: {
+            readonly value: 0;
+        };
+        readonly pagesCount: {
+            readonly value: 0;
+        };
+    };
+    readonly output: {
+        readonly tokensCount: {
+            readonly value: 0;
+        };
+        readonly charactersCount: {
+            readonly value: 0;
+        };
+        readonly wordsCount: {
+            readonly value: 0;
+        };
+        readonly sentencesCount: {
+            readonly value: 0;
+        };
+        readonly linesCount: {
+            readonly value: 0;
+        };
+        readonly paragraphsCount: {
+            readonly value: 0;
+        };
+        readonly pagesCount: {
+            readonly value: 0;
+        };
+    };
+}>;
 /**
  * Function `addUsage` will add multiple usages into one
  *
- * Note: If you provide 0 values, it returns void usage
+ * Note: If you provide 0 values, it returns ZERO_USAGE
  */
 export declare function addUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;

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/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/{umd/typings/src/llm-providers/utils → esm/typings/src/llm-providers/_common}/createLlmToolsFromEnv.d.ts

@@ -12,10 +12,11 @@ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
  */
 export declare function createLlmToolsFromEnv(): LlmExecutionTools;
 /**
- * TODO: !!!!! Export this util
- * TODO: !!!! write discussion about this - wizzard
+ * 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/{umd/typings/src/llm-providers → esm/typings/src/llm-providers/_common}/utils/cache/CacheItem.d.ts

@@ -1,7 +1,7 @@
-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';
+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';
 /**
  * @@@
  */

package/{umd/typings/src/llm-providers → esm/typings/src/llm-providers/_common}/utils/cache/CacheLlmToolsOptions.d.ts

@@ -1,4 +1,4 @@
-import type { PromptbookStorage } from '../../../storage/_common/PromptbookStorage';
+import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
 import type { CacheItem } from './CacheItem';
 export type CacheLlmToolsOptions = {
     /**

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

@@ -1,4 +1,4 @@
-import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
 import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
 /**
  * Intercepts LLM tools and counts total usage of the tools
@@ -8,9 +8,8 @@ import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
  */
 export declare function cacheLlmTools(llmTools: LlmExecutionTools, options?: Partial<CacheLlmToolsOptions>): LlmExecutionTools;
 /**
- * TODO: !!!!! Export this util
- * TODO: !!!!! Use this for tests in promptbook project itself
- * TODO: !!!! write discussion about this and storages
+ * 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/{utils → _common/utils}/count-total-cost/LlmExecutionToolsWithTotalCost.d.ts

@@ -1,5 +1,5 @@
-import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
-import type { PromptResultUsage } from '../../../execution/PromptResult';
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+import type { PromptResultUsage } from '../../../../execution/PromptResult';
 /**
  * LLM tools with option to get total cost of the execution
  */

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

@@ -1,4 +1,4 @@
-import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
 import type { LlmExecutionToolsWithTotalCost } from './LlmExecutionToolsWithTotalCost';
 /**
  * Intercepts LLM tools and counts total usage of the tools
@@ -8,7 +8,7 @@ import type { LlmExecutionToolsWithTotalCost } from './LlmExecutionToolsWithTota
  */
 export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalCost;
 /**
- * TODO: !!!!! Export this utils
+ * 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/_common/utils/count-total-cost/limitTotalCost.d.ts

@@ -0,0 +1,32 @@
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+import type { PromptResultUsage } from '../../../../execution/PromptResult';
+import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
+import type { TODO } from '../../../../utils/organization/TODO';
+import type { LlmExecutionToolsWithTotalCost } from './LlmExecutionToolsWithTotalCost';
+/**
+ * Options for `limitTotalCost`
+ */
+type LimitTotalCostOptions = {
+    /**
+     * @@@
+     *
+     * @default ZERO_USAGE
+     */
+    maxTotalCost: PromptResultUsage;
+    /**
+     * @@@
+     *
+     * @default MemoryStorage
+     */
+    storage: PromptbookStorage<TODO>;
+};
+/**
+ * @@@
+ */
+export declare function limitTotalCost(llmTools: LlmExecutionTools, options?: Partial<LimitTotalCostOptions>): LlmExecutionToolsWithTotalCost;
+export {};
+/**
+ * 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/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/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: !!! Use here `seed`
+ * 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: !!! Use here `seed`
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  */

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/personas/preparePersona.d.ts

@@ -5,6 +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: [🔼] !!! 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,9 +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: !!!!! Use here countTotalUsage
+ * 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

@@ -20,5 +20,6 @@ export type PromptbookStorage<TItem> = {
     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

@@ -1,5 +1,5 @@
 export {};
 /**
- * TODO: !!!!! Check that this files is not exported into build
+ * 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

@@ -24,5 +24,7 @@ export declare class FilesStorage<TItem> implements PromptbookStorage<TItem> {
     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

@@ -8,3 +8,6 @@ export type FilesStorageOptions = {
      */
     cacheFolderPath: string_folder_path;
 };
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/types`
+ */

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

@@ -4,5 +4,6 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
  */
 export declare function getLocalStorage<TItem>(): PromptbookStorage<TItem>;
 /**
- * Export through `@promptbook/browser`
+ * 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

@@ -4,5 +4,6 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
  */
 export declare function getSessionStorage<TItem>(): PromptbookStorage<TItem>;
 /**
- * Export through `@promptbook/browser`
+ * 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

@@ -29,3 +29,6 @@ export declare class MemoryStorage<TItem> implements PromptbookStorage<TItem> {
      */
     removeItem(key: string): void;
 }
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/core`
+ */