@promptbook/fake-llm - npm Package Compare versions

Comparing version 0.63.0-2 to 0.63.0-3

esm/index.es.js

@@ -7,3 +7,3 @@ import { spaceTrim } from 'spacetrim';
  */
-var PROMPTBOOK_VERSION = '0.63.0-1';
+var PROMPTBOOK_VERSION = '0.63.0-2';
 // TODO: !!!! List here all the versions and annotate + put into script
@@ -123,5 +123,6 @@
  *
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ *
  * @returns The same object as the input, but deeply frozen
- *
- * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ * @public exported from `@promptbook/utils`
  */
@@ -183,3 +184,3 @@ function deepFreeze(objectValue) {
  *
- * @private This is internal util of the promptbook
+ * @private internal utility
  */
@@ -193,3 +194,3 @@ function getCurrentIsoDate() {
  *
- * @private within the repository - too low-level in comparison to other `MAX_...`
+ * @private within the repository - too low-level in comparison with other `MAX_...`
  */
@@ -200,3 +201,3 @@ var LOOP_LIMIT = 1000;
  *
- * @private within the repository - too low-level in comparison to other `MAX_...`
+ * @private within the repository - too low-level in comparison with other `MAX_...`
  */
@@ -206,2 +207,4 @@ var CHARACTER_LOOP_LIMIT = 100000;
  * Nonce which is used for replacing things in strings
+ *
+ * @private within the repository
  */
@@ -236,9 +239,2 @@ var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
 var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
-/*
-TODO: !!! Just testing false-negative detection of [🟡][🟢][🔵][⚪] leak
-*/
-// [🟡][🟢][🔵][⚪]
-/**
- * TODO: !!!!!! Check that all @private contains some normalized explanation
- */
 
@@ -489,3 +485,4 @@ /**
  *
- * @private Always catched and rethrown as `PipelineExecutionError`
+ * @private error of `checkExpectations` and `createPipelineExecutor`
+ * Note: Always thrown in `checkExpectations` and catched in `createPipelineExecutor` and rethrown as `PipelineExecutionError`
  * Note: This is a kindof subtype of PipelineExecutionError
@@ -864,3 +861,3 @@ */
  * @returns {void} Nothing
- * @public exported from `@promptbook/core`
+ * @private internal function of `createPipelineExecutor`
  */
@@ -921,3 +918,3 @@ function checkExpectations(expectations, value) {
  *
- * @private internal util for MockedFackedLlmExecutionTools
+ * @private internal utility for MockedFackedLlmExecutionTools
  */
@@ -924,0 +921,0 @@ function $fakeTextToExpectations(expectations, postprocessing) {

esm/typings/src/_packages/anthropic-claude.index.d.ts

 import { PROMPTBOOK_VERSION } from '../version';
+import { ANTHROPIC_CLAUDE_MODELS } from '../llm-providers/anthropic-claude/anthropic-claude-models';
 import { AnthropicClaudeExecutionTools } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionTools';
 import type { AnthropicClaudeExecutionToolsOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
 export { PROMPTBOOK_VERSION };
+export { ANTHROPIC_CLAUDE_MODELS };
 export { AnthropicClaudeExecutionTools };
 export type { AnthropicClaudeExecutionToolsOptions };

esm/typings/src/_packages/browser.index.d.ts

 import { PROMPTBOOK_VERSION } from '../version';
+import { SimplePromptInterfaceTools } from '../knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools';
 import { getLocalStorage } from '../storage/local-storage/getLocalStorage';
 import { getSessionStorage } from '../storage/local-storage/getSessionStorage';
 export { PROMPTBOOK_VERSION };
+export { SimplePromptInterfaceTools };
 export { getLocalStorage };
 export { getSessionStorage };

esm/typings/src/_packages/core.index.d.ts

@@ -40,3 +40,2 @@ import { PROMPTBOOK_VERSION } from '../version';
 import { addUsage } from '../execution/utils/addUsage';
-import { checkExpectations } from '../execution/utils/checkExpectations';
 import { isPassingExpectations } from '../execution/utils/checkExpectations';
@@ -47,3 +46,2 @@ import { usageToHuman } from '../execution/utils/usageToHuman';
 import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
-import { SimplePromptInterfaceTools } from '../knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools';
 import { prepareKnowledgePieces } from '../knowledge/prepare-knowledge/_common/prepareKnowledgePieces';
@@ -104,3 +102,2 @@ import { prepareKnowledgeFromMarkdown } from '../knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown';
 export { addUsage };
-export { checkExpectations };
 export { isPassingExpectations };
@@ -111,3 +108,2 @@ export { usageToHuman };
 export type { CallbackInterfaceToolsOptions };
-export { SimplePromptInterfaceTools };
 export { prepareKnowledgePieces };
@@ -114,0 +110,0 @@ export { prepareKnowledgeFromMarkdown };

esm/typings/src/_packages/types.index.d.ts

 import { PROMPTBOOK_VERSION } from '../version';
 import type { PipelineCollection } from '../collection/PipelineCollection';
-import type { BoilerplateCommand } from '../commands/_BOILERPLATE/BoilerplateCommand';
 import type { Command } from '../commands/_common/types/Command';
@@ -9,17 +8,5 @@ import type { CommandParser } from '../commands/_common/types/CommandParser';
 import type { CommandUsagePlace } from '../commands/_common/types/CommandUsagePlaces';
-import type { BlockCommand } from '../commands/BLOCK/BlockCommand';
 import type { BlockType } from '../commands/BLOCK/BlockTypes';
 import type { ExpectAmountCommand } from '../commands/EXPECT/ExpectAmountCommand';
-import type { ExpectCommand } from '../commands/EXPECT/ExpectCommand';
 import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand';
-import type { JokerCommand } from '../commands/JOKER/JokerCommand';
-import type { KnowledgeCommand } from '../commands/KNOWLEDGE/KnowledgeCommand';
-import type { ModelCommand } from '../commands/MODEL/ModelCommand';
-import type { ParameterCommand } from '../commands/PARAMETER/ParameterCommand';
-import type { PersonaCommand } from '../commands/PERSONA/PersonaCommand';
-import type { PostprocessCommand } from '../commands/POSTPROCESS/PostprocessCommand';
-import type { PromptbookVersionCommand } from '../commands/PROMPTBOOK_VERSION/PromptbookVersionCommand';
-import type { UrlCommand } from '../commands/URL/UrlCommand';
-import type { ActionCommand } from '../commands/X_ACTION/ActionCommand';
-import type { InstrumentCommand } from '../commands/X_INSTRUMENT/InstrumentCommand';
 import type { PipelineStringToJsonOptions } from '../conversion/pipelineStringToJson';
@@ -44,12 +31,6 @@ import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
 import type { ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
-import type { AutomaticTranslator } from '../execution/translation/automatic-translate/automatic-translators/AutomaticTranslator';
-import type { TranslatorOptions } from '../execution/translation/automatic-translate/automatic-translators/TranslatorOptions';
 import type { UncertainNumber } from '../execution/UncertainNumber';
 import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
 import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
-import type { FormatDefinition } from '../formats/_common/FormatDefinition';
 import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
-import type { Scraper } from '../knowledge/prepare-knowledge/_common/Scraper';
-import type { ScraperSourceOptions } from '../knowledge/prepare-knowledge/_common/Scraper';
-import type { CreateLlmToolsFromEnvOptions } from '../llm-providers/_common/createLlmToolsFromEnv';
 import type { CacheItem } from '../llm-providers/_common/utils/cache/CacheItem';
@@ -73,3 +54,2 @@ import type { CacheLlmToolsOptions } from '../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
 import type { FilesStorageOptions } from '../storage/files-storage/FilesStorageOptions';
-import type { Arrayable } from '../types/Arrayable';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
@@ -228,12 +208,7 @@ import type { ExecutionReportString } from '../types/execution-report/ExecutionReportString';
 import type { string_snake_case } from '../utils/normalization/normalizeTo_snake_case';
-import type { ___ } from '../utils/organization/___';
 import type { really_any } from '../utils/organization/really_any';
-import type { really_unknown } from '../utils/organization/really_unknown';
 import type { TODO_any } from '../utils/organization/TODO_any';
-import type { TODO_object } from '../utils/organization/TODO_object';
-import type { TODO_unknown } from '../utils/organization/TODO_unknown';
 import type { string_promptbook_version } from '../version';
 export { PROMPTBOOK_VERSION };
 export type { PipelineCollection };
-export type { BoilerplateCommand };
 export type { Command };
@@ -244,17 +219,5 @@ export type { CommandParser };
 export type { CommandUsagePlace };
-export type { BlockCommand };
 export type { BlockType };
 export type { ExpectAmountCommand };
-export type { ExpectCommand };
 export type { ExpectFormatCommand };
-export type { JokerCommand };
-export type { KnowledgeCommand };
-export type { ModelCommand };
-export type { ParameterCommand };
-export type { PersonaCommand };
-export type { PostprocessCommand };
-export type { PromptbookVersionCommand };
-export type { UrlCommand };
-export type { ActionCommand };
-export type { InstrumentCommand };
 export type { PipelineStringToJsonOptions };
@@ -279,12 +242,6 @@ export type { PrettifyOptions };
 export type { ScriptExecutionToolsExecuteOptions };
-export type { AutomaticTranslator };
-export type { TranslatorOptions };
 export type { UncertainNumber };
 export type { UserInterfaceTools };
 export type { UserInterfaceToolsPromptDialogOptions };
-export type { FormatDefinition };
 export type { CallbackInterfaceToolsOptions };
-export type { Scraper };
-export type { ScraperSourceOptions };
-export type { CreateLlmToolsFromEnvOptions };
 export type { CacheItem };
@@ -308,3 +265,2 @@ export type { CacheLlmToolsOptions };
 export type { FilesStorageOptions };
-export type { Arrayable };
 export type { ExecutionReportJson };
@@ -463,8 +419,4 @@ export type { ExecutionReportString };
 export type { string_snake_case };
-export type { ___ };
 export type { really_any };
-export type { really_unknown };
 export type { TODO_any };
-export type { TODO_object };
-export type { TODO_unknown };
 export type { string_promptbook_version };

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

@@ -12,3 +12,3 @@ import { PROMPTBOOK_VERSION } from '../version';
 import { deepClone } from '../utils/deepClone';
-import { deepFreezeWithSameType } from '../utils/deepFreeze';
+import { deepFreeze } from '../utils/deepFreeze';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
@@ -43,2 +43,3 @@ import { countLines } from '../utils/expectation-counters/countLines';
 import { normalizeTo_snake_case } from '../utils/normalization/normalizeTo_snake_case';
+import { normalizeWhitespaces } from '../utils/normalization/normalizeWhitespaces';
 import { parseKeywords } from '../utils/normalization/parseKeywords';
@@ -59,2 +60,3 @@ import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFromString';
 import { unwrapResult } from '../utils/unwrapResult';
+import { isValidEmail } from '../utils/validators/email/isValidEmail';
 import { isValidFilePath } from '../utils/validators/filePath/isValidFilePath';
@@ -80,3 +82,3 @@ import { isValidJavascriptName } from '../utils/validators/javascriptName/isValidJavascriptName';
 export { deepClone };
-export { deepFreezeWithSameType };
+export { deepFreeze };
 export { countCharacters };
@@ -111,2 +113,3 @@ export { countLines };
 export { normalizeTo_snake_case };
+export { normalizeWhitespaces };
 export { parseKeywords };
@@ -127,2 +130,3 @@ export { parseKeywordsFromString };
 export { unwrapResult };
+export { isValidEmail };
 export { isValidFilePath };
@@ -129,0 +133,0 @@ export { isValidJavascriptName };

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

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

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

@@ -5,3 +5,3 @@ import type { Command as Program } from 'commander';
  *
- * @private part of `promptbookCli`
+ * @private internal function of `promptbookCli`
  */
@@ -8,0 +8,0 @@ export declare function initializeMakeCommand(program: Program): void;

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

@@ -5,3 +5,3 @@ import type { Command as Program } from 'commander';
  *
- * @private part of `promptbookCli`
+ * @private internal function of `promptbookCli`
  */
@@ -8,0 +8,0 @@ export declare function initializePrettifyCommand(program: Program): void;

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

 /**
  * Runs CLI utilities of Promptbook package
+ *
+ * @private within the `@promptbook/cli`
  */
 export declare function promptbookCli(): Promise<void>;
 /**
- * TODO: [🥠] Do not export to utils directly, its just for CLI script
+ * TODO: [🥠] Do not export, its just for CLI script
  * TODO: [🕌] When more functionalities, rename
@@ -8,0 +10,0 @@ * Note: 11:11

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

@@ -47,3 +47,3 @@ import type { PipelineStringToJsonOptions } from '../../conversion/pipelineStringToJson';
 /**
- * Note: [🟢] This code should never be published outside of `@pipeline/node`
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
  */

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

@@ -9,3 +9,3 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
  *
- * @private use `createCollectionFromJson` instead
+ * @private internal function of `createCollectionFromJson`, use `createCollectionFromJson` instead
  * @see https://github.com/webgptorg/pipeline#pipeline-collection
@@ -20,3 +20,2 @@ */
      *
-     * @private Use instead `createCollectionFromJson`
      * Note: During the construction logic of all pipelines are validated
@@ -23,0 +22,0 @@ * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead

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

@@ -12,3 +12,2 @@ import type { CommandParser } from '../_common/types/CommandParser';
  * TODO: [💐] Implement BOILERPLATE command into `pipelineStringToJsonSync` function
- * Note: [⚪] This should never be in any released package
  */

esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts

@@ -8,3 +8,5 @@ import type { TupleToUnion } from 'type-fest';
  * Where the command can be used
+ *
+ * @private internal base for `CommandUsagePlace`
  */
 export declare const CommandUsagePlaces: readonly ["PIPELINE_HEAD", "PIPELINE_TEMPLATE"];

esm/typings/src/commands/index.d.ts

 /**
  * All available command parsers
+ *
+ * @private internal index of `parseCommand`
  */
 export declare const COMMANDS: readonly [import("./_common/types/CommandParser").CommandParser<import("./BLOCK/BlockCommand").BlockCommand>, import("./_common/types/CommandParser").CommandParser<import("./EXPECT/ExpectCommand").ExpectCommand>, import("./_common/types/CommandParser").CommandParser<import("./JOKER/JokerCommand").JokerCommand>, import("./_common/types/CommandParser").CommandParser<import("./MODEL/ModelCommand").ModelCommand>, import("./_common/types/CommandParser").CommandParser<import("./PARAMETER/ParameterCommand").ParameterCommand>, import("./_common/types/CommandParser").CommandParser<import("./POSTPROCESS/PostprocessCommand").PostprocessCommand>, import("./_common/types/CommandParser").CommandParser<import("./PROMPTBOOK_VERSION/PromptbookVersionCommand").PromptbookVersionCommand>, import("./_common/types/CommandParser").CommandParser<import("./URL/UrlCommand").UrlCommand>, import("./_common/types/CommandParser").CommandParser<import("./KNOWLEDGE/KnowledgeCommand").KnowledgeCommand>, import("./_common/types/CommandParser").CommandParser<import("./X_ACTION/ActionCommand").ActionCommand>, import("./_common/types/CommandParser").CommandParser<import("./X_INSTRUMENT/InstrumentCommand").InstrumentCommand>, import("./_common/types/CommandParser").CommandParser<import("./PERSONA/PersonaCommand").PersonaCommand>, import("./_common/types/CommandParser").CommandParser<import("./_BOILERPLATE/BoilerplateCommand").BoilerplateCommand>];

esm/typings/src/config.d.ts

 /**
  * The maximum number of iterations for a loops
  *
- * @private within the repository - too low-level in comparison to other `MAX_...`
+ * @private within the repository - too low-level in comparison with other `MAX_...`
  */
@@ -10,3 +10,3 @@ export declare const LOOP_LIMIT = 1000;
  *
- * @private within the repository - too low-level in comparison to other `MAX_...`
+ * @private within the repository - too low-level in comparison with other `MAX_...`
  */
@@ -60,2 +60,4 @@ export declare const CHARACTER_LOOP_LIMIT = 100000;
  * Nonce which is used for replacing things in strings
+ *
+ * @private within the repository
  */
@@ -82,2 +84,11 @@ export declare const REPLACING_NONCE = "u$k42k%!V2zo34w7Fu#@QUHYPW";
 /**
+ * The thresholds for the relative time in the `moment` NPM package.
+ *
+ * @see https://momentjscom.readthedocs.io/en/latest/moment/07-customization/13-relative-time-threshold/
+ * @private within the repository - too low-level in comparison with other constants
+ */
+export declare const MOMENT_ARG_THRESHOLDS: {
+    readonly ss: 3;
+};
+/**
  * @@@
@@ -88,4 +99,1 @@ *
 export declare const DEBUG_ALLOW_PAYED_TESTING: boolean;
-/**
- * TODO: !!!!!! Check that all @private contains some normalized explanation
- */

esm/typings/src/conversion/validation/_importPipeline.d.ts

@@ -11,3 +11,3 @@ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
  * @param path - The path to the file relative to samples/templates directory
- * @private
+ * @private internal function of tests
  */
@@ -18,2 +18,4 @@ export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;
  * Import the pipeline.ptbk.json file as parsed JSON
+ *
+ * @private internal function of tests
  */
@@ -23,3 +25,5 @@ export declare function importPipelineJson(path: `${string}.ptbk.json`): PipelineJson;
  * Import the pipeline.ptbk.json file as string
+ *
+ * @private internal function of tests
  */
 export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;

esm/typings/src/errors/_ExpectError.d.ts

 /**
  * This error occurs when some expectation is not met in the execution of the pipeline
  *
- * @private Always catched and rethrown as `PipelineExecutionError`
+ * @private error of `checkExpectations` and `createPipelineExecutor`
+ * Note: Always thrown in `checkExpectations` and catched in `createPipelineExecutor` and rethrown as `PipelineExecutionError`
  * Note: This is a kindof subtype of PipelineExecutionError
@@ -6,0 +7,0 @@ */

esm/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts

 import type { Promisable } from 'type-fest';
+/**
+ * @private still in development [🏳]
+ */
 export type AutomaticTranslator = {
     translate(message: string): Promisable<string>;
 };

esm/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts

 import type { AutomaticTranslator } from './AutomaticTranslator';
 /**
  * This will wrap an automatic translator and log each translation into the console
+ *
+ * @private still in development [🏳]
  */
@@ -5,0 +7,0 @@ export declare class DebugAutomaticTranslator implements AutomaticTranslator {

esm/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts

 import type { AutomaticTranslator } from './AutomaticTranslator';
+/**
+ * @private still in development [🏳]
+ */
 export declare class FakeAutomaticTranslator implements AutomaticTranslator {
@@ -3,0 +6,0 @@ constructor();

esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts

@@ -6,2 +6,5 @@ import type { AutomaticTranslator } from './AutomaticTranslator';
 }
+/**
+ * @private still in development [🏳]
+ */
 export declare class LindatAutomaticTranslator implements AutomaticTranslator {
@@ -8,0 +11,0 @@ private readonly options;

esm/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts

@@ -0,1 +1,4 @@
+/**
+ * @private still in development [🏳]
+ */
 export type TranslatorOptions = {
@@ -2,0 +5,0 @@ readonly from?: string;

esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts

@@ -6,3 +6,4 @@ /**
  * @throws {PipelineExecutionError}
+ * @private still in development [🏳]
  */
 export declare function extractMultiplicatedOccurrence(message: string): string;

esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts

 import type { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
 import type { TranslatorOptions } from './automatic-translators/TranslatorOptions';
+/**
+ * @private still in development [🏳]
+ */
 export declare function translateMessages({ automaticTranslator, from, to, }: {
     automaticTranslator: AutomaticTranslator;
 } & TranslatorOptions): Promise<void>;

esm/typings/src/execution/utils/checkExpectations.d.ts

@@ -11,3 +11,3 @@ import type { Expectations } from '../../types/PipelineJson/Expectations';
  * @returns {void} Nothing
- * @public exported from `@promptbook/core`
+ * @private internal function of `createPipelineExecutor`
  */
@@ -14,0 +14,0 @@ export declare function checkExpectations(expectations: Expectations, value: string): void;

esm/typings/src/execution/utils/computeUsageCounts.d.ts

@@ -8,4 +8,4 @@ import type { PromptResultUsageCounts } from '../PromptResultUsage';
  *
- * @private internal util of LlmExecutionTools
+ * @private internal utility of LlmExecutionTools
  */
 export declare function computeUsageCounts(content: string): Omit<PromptResultUsageCounts, 'tokensCount'>;

esm/typings/src/expectations/drafts/isDomainNameFree.d.ts

 import type { string_name } from '../../types/typeAliases';
+/**
+ * @private still in development
+ */
 export declare function isDomainNameFree(name: string_name): Promise<boolean>;
@@ -3,0 +6,0 @@ /**

esm/typings/src/expectations/drafts/isGithubNameFree.d.ts

 import type { string_name } from '../../types/typeAliases';
+/**
+ * @private still in development
+ */
 export declare function isGithubNameFree(name: string_name): Promise<boolean>;
@@ -3,0 +6,0 @@ /**

esm/typings/src/formats/_common/FormatDefinition.d.ts

@@ -7,3 +7,3 @@ import type { string_mime_type } from '../../types/typeAliases';
  * @see https://github.com/webgptorg/promptbook/discussions/36
- * @private still an internal experimental
+ * @private still in development [🏢]
  */
@@ -10,0 +10,0 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSchema extends object> = {

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

 import type { FormatDefinition } from '../_common/FormatDefinition';
 /**
  * Definition for CSV spreadsheet
+ *
+ * @private still in development [🏢]
  */
@@ -5,0 +7,0 @@ export declare const CsvFormatDefinition: FormatDefinition<string, string, object>;

esm/typings/src/formats/index.d.ts

 /**
  * Definitions for all formats supported by Promptbook
+ *
+ * @private internal index of `...` <- TODO [🏢]
  */
 export declare const FORMAT_DEFINITIONS: import("./_common/FormatDefinition").FormatDefinition<string, string, object>[];

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

 import type { FormatDefinition } from '../_common/FormatDefinition';
 /**
  * Definition for JSON format
+ *
+ * @private still in development [🏢]
  */
@@ -5,0 +7,0 @@ export declare const JsonFormatDefinition: FormatDefinition<string, string, object>;

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

@@ -6,2 +6,4 @@ import type { FormatDefinition } from '../_common/FormatDefinition';
  * Note: list is just a string with multiple lines or multiple items separated by comma
+ *
+ * @private still in development [🏢]
  */
@@ -8,0 +10,0 @@ export declare const ListFormatDefinition: FormatDefinition<string, string, object>;

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

 import type { FormatDefinition } from '../_common/FormatDefinition';
 /**
  * Definition for XML format
+ *
+ * @private still in development [🏢]
  */
@@ -5,0 +7,0 @@ export declare const XmlFormatDefinition: FormatDefinition<string, string, object>;

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

@@ -10,3 +10,3 @@ import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
  *
- * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/browser`
  */
@@ -13,0 +13,0 @@ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {

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

@@ -6,2 +6,4 @@ import type { PrepareOptions } from '../../../prepare/PrepareOptions';
  * @@@
+ *
+ * @private still in development [🐝]
  */
@@ -8,0 +10,0 @@ export declare function prepareKnowledgeFromPdf(content: string_base64, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;

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

 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 /**
- * @privxxate <- TODO: !!!!!! Warn that not private or exported
+ * Options for `createLlmToolsFromEnv`
+ *
+ * @private internal type for `createLlmToolsFromEnv` and `getLlmToolsForTestingAndScriptsAndPlayground`
  */
@@ -35,4 +37,4 @@ export type CreateLlmToolsFromEnvOptions = {
  * TODO: [🧠] Maybe pass env as argument
- * Note: [🟢] This code should never be published outside of `@promptbook/node`
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

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

@@ -9,2 +9,3 @@ import type { AvailableModel } from '../../execution/LlmExecutionTools';
  * @see https://docs.anthropic.com/en/docs/models-overview
+ * @public exported from `@promptbook/anthropic-claude`
  */
@@ -11,0 +12,0 @@ export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {

esm/typings/src/llm-providers/mocked/fakeTextToExpectations.d.ts

@@ -9,3 +9,3 @@ import type { PostprocessingFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
  *
- * @private internal util for MockedFackedLlmExecutionTools
+ * @private internal utility for MockedFackedLlmExecutionTools
  */
@@ -12,0 +12,0 @@ export declare function $fakeTextToExpectations(expectations: Expectations, postprocessing?: Array<PostprocessingFunction>): Promise<string>;

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

@@ -15,3 +15,3 @@ import type { AvailableModel } from '../../execution/LlmExecutionTools';
  *
- * @private Internal utility of `joinLlmExecutionTools`
+ * @private internal utility of `joinLlmExecutionTools`
  */
@@ -18,0 +18,0 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {

esm/typings/src/llm-providers/openai/computeOpenaiUsage.d.ts

@@ -11,5 +11,5 @@ import type OpenAI from 'openai';
  * @throws {PipelineExecutionError} If the usage is not defined in the response from OpenAI
- * @private internal util of `OpenAiExecutionTools`
+ * @private internal utility of `OpenAiExecutionTools`
  */
 export declare function computeOpenaiUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
 resultContent: string, rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>): PromptResultUsage;

esm/typings/src/scripting/javascript/utils/preserve.d.ts

@@ -8,2 +8,3 @@ import type { really_any } from '../../../utils/organization/really_any';
  * @returns nothing
+ * @private internal function of `JavascriptExecutionTools` and `JavascriptEvalExecutionTools`
  */
@@ -10,0 +11,0 @@ export declare function preserve(func: (...params: Array<really_any>) => unknown): void;

esm/typings/src/scripting/javascript/utils/unknownToString.d.ts

@@ -6,4 +6,4 @@ import type { really_unknown } from '../../../utils/organization/really_unknown';
  * @param value String value for logging
- * @private Internal util
+ * @private internal util
  */
 export declare function unknownToString(value: really_unknown): string;

esm/typings/src/scripting/python/PythonExecutionTools.d.ts

@@ -8,2 +8,4 @@ import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
  * Warning: This is not implemented yet
+ *
+ * @private still in development
  */
@@ -10,0 +12,0 @@ export declare class PythonExecutionTools implements ScriptExecutionTools {

esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts

@@ -8,2 +8,4 @@ import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
  * Warning: This is not implemented yet
+ *
+ * @private still in development
  */
@@ -10,0 +12,0 @@ export declare class TypescriptExecutionTools implements ScriptExecutionTools {

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

@@ -30,3 +30,3 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
  * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
- * Note: [🟢] This code should never be published outside of `@promptbook/node`
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
  */

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

@@ -8,4 +8,4 @@ /**
  *
- * @private Internal utility type
+ * @private internal type
  */
 export type Arrayable<TItem> = TItem | Array<TItem> | undefined;

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

@@ -0,8 +1,3 @@
+import type { TupleToUnion } from 'type-fest';
 /**
- * @@@
- *
- * @private for `ModelVariant` and `modelCommandParser`
- */
-export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];
-/**
  * Model variant describes the very general type of the model
@@ -14,2 +9,8 @@ *
  */
-export type ModelVariant = typeof MODEL_VARIANTS[number];
+export type ModelVariant = TupleToUnion<typeof MODEL_VARIANTS>;
+/**
+ * @@@
+ *
+ * @private internal base for `ModelVariant` and `modelCommandParser`
+ */
+export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];

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

@@ -0,1 +1,2 @@
+import type { TupleToUnion } from 'type-fest';
 import type { number_integer } from '../typeAliases';
@@ -9,2 +10,3 @@ import type { number_positive } from '../typeAliases';
  * Note: Expectations are performed after all postprocessing steps
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/30
@@ -17,13 +19,17 @@ */
 /**
- * Units of text measurement
+ * Unit of text measurement
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/30
  */
-export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
+export type ExpectationUnit = TupleToUnion<typeof EXPECTATION_UNITS>;
 /**
- * Unit of text measurement
+ * Units of text measurement
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/30
+ * @private internal base for `ExpectationUnit`
  */
-export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
+export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
 /**
  * Amount of text measurement
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/30
@@ -30,0 +36,0 @@ */

esm/typings/src/types/ScriptLanguage.d.ts

 import type { TupleToUnion } from 'type-fest';
 /**
+ * Script language
+ */
+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"];
-/**
- * Script language
- */
-export type ScriptLanguage = TupleToUnion<typeof SUPPORTED_SCRIPT_LANGUAGES>;

esm/typings/src/types/typeAliases.d.ts

@@ -0,1 +1,2 @@
+import type { TupleToUnion } from 'type-fest';
 import { RESERVED_PARAMETER_NAMES } from '../config';
@@ -114,3 +115,3 @@ /**
  */
-export type string_reserved_parameter_name = typeof RESERVED_PARAMETER_NAMES[number];
+export type string_reserved_parameter_name = TupleToUnion<typeof RESERVED_PARAMETER_NAMES>;
 /**
@@ -117,0 +118,0 @@ * @@@

esm/typings/src/utils/arrayableToArray.d.ts

@@ -9,4 +9,4 @@ import type { Arrayable } from '../types/Arrayable';
  *
- * @private Internal utility
+ * @private internal utility
  */
 export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): Array<TItem>;

esm/typings/src/utils/deepFreeze.d.ts

@@ -5,5 +5,6 @@ import type { ReadonlyDeep } from 'type-fest';
  *
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ *
  * @returns The same object as the input, but deeply frozen
- *
- * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ * @public exported from `@promptbook/utils`
  */
@@ -15,6 +16,6 @@ export declare function deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
  *
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ *
  * @returns The same object as the input, but deeply frozen
- * @public exported from `@promptbook/utils`
- *
- * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ * @private this is in comparison to `deepFreeze` a more specific utility and maybe not very good practice to use without specific reason and considerations
  */
@@ -21,0 +22,0 @@ export declare function deepFreezeWithSameType<TObject>(objectValue: TObject): TObject;

esm/typings/src/utils/getCurrentIsoDate.d.ts

@@ -5,4 +5,4 @@ import type { string_date_iso8601 } from '../types/typeAliases';
  *
- * @private This is internal util of the promptbook
+ * @private internal utility
  */
 export declare function getCurrentIsoDate(): string_date_iso8601;

esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -19,3 +19,3 @@ import type { string_markdown } from '../../types/typeAliases';
 /***
- * TODO: [🍓][🌻] Decide of this is internal util, external util OR validator/postprocessor
+ * TODO: [🍓][🌻] Decide of this is internal utility, external util OR validator/postprocessor
  */

esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts

 /**
- * Take every whitespace (space, new line, tab) and replace it with a single space.
+ * Take every whitespace (space, new line, tab) and replace it with a single space
+ *
+ * @public exported from `@promptbook/utils`
  */
 export declare function normalizeWhitespaces(sentence: string): string;

esm/typings/src/utils/validators/email/isValidEmail.d.ts

@@ -5,3 +5,5 @@ import type { string_email } from '../../../types/typeAliases';
  * Checks if value is valid email
+ *
+ * @public exported from `@promptbook/utils`
  */
 export declare function isValidEmail(email: really_unknown): email is string_email;

package.json

 {
     "name": "@promptbook/fake-llm",
-    "version": "0.63.0-2",
+    "version": "0.63.0-3",
     "description": "Supercharge your use of large language models",
@@ -50,3 +50,3 @@ "private": false,
     "peerDependencies": {
-        "@promptbook/core": "0.63.0-2"
+        "@promptbook/core": "0.63.0-3"
     },
@@ -53,0 +53,0 @@ "dependencies": {

README.md

@@ -316,7 +316,7 @@ # ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook
 
-
 -   ⭐ **[ptbk](https://www.npmjs.com/package/ptbk)** - Bundle of all packages, when you want to install everything and you don't care about the size
 -   **[promptbook](https://www.npmjs.com/package/promptbook)** - Same as `ptbk`
 -   **[@promptbook/core](https://www.npmjs.com/package/@promptbook/core)** - Core of the library, it contains the main logic for promptbooks
--   **[@promptbook/node](https://www.npmjs.com/package/@promptbook/node)** - Core of the library for Node.js
+-   **[@promptbook/node](https://www.npmjs.com/package/@promptbook/node)** - Core of the library for Node.js environment
+-   **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
 -   ⭐ **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
@@ -323,0 +323,0 @@ -   **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown

umd/index.umd.js

@@ -10,3 +10,3 @@ (function (global, factory) {
      */
-    var PROMPTBOOK_VERSION = '0.63.0-1';
+    var PROMPTBOOK_VERSION = '0.63.0-2';
     // TODO: !!!! List here all the versions and annotate + put into script
@@ -126,5 +126,6 @@
      *
+     * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+     *
      * @returns The same object as the input, but deeply frozen
-     *
-     * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+     * @public exported from `@promptbook/utils`
      */
@@ -186,3 +187,3 @@ function deepFreeze(objectValue) {
      *
-     * @private This is internal util of the promptbook
+     * @private internal utility
      */
@@ -196,3 +197,3 @@ function getCurrentIsoDate() {
      *
-     * @private within the repository - too low-level in comparison to other `MAX_...`
+     * @private within the repository - too low-level in comparison with other `MAX_...`
      */
@@ -203,3 +204,3 @@ var LOOP_LIMIT = 1000;
      *
-     * @private within the repository - too low-level in comparison to other `MAX_...`
+     * @private within the repository - too low-level in comparison with other `MAX_...`
      */
@@ -209,2 +210,4 @@ var CHARACTER_LOOP_LIMIT = 100000;
      * Nonce which is used for replacing things in strings
+     *
+     * @private within the repository
      */
@@ -239,9 +242,2 @@ var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
     var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
-    /*
-    TODO: !!! Just testing false-negative detection of [🟡][🟢][🔵][⚪] leak
-    */
-    // [🟡][🟢][🔵][⚪]
-    /**
-     * TODO: !!!!!! Check that all @private contains some normalized explanation
-     */
 
@@ -492,3 +488,4 @@ /**
      *
-     * @private Always catched and rethrown as `PipelineExecutionError`
+     * @private error of `checkExpectations` and `createPipelineExecutor`
+     * Note: Always thrown in `checkExpectations` and catched in `createPipelineExecutor` and rethrown as `PipelineExecutionError`
      * Note: This is a kindof subtype of PipelineExecutionError
@@ -867,3 +864,3 @@ */
      * @returns {void} Nothing
-     * @public exported from `@promptbook/core`
+     * @private internal function of `createPipelineExecutor`
      */
@@ -924,3 +921,3 @@ function checkExpectations(expectations, value) {
      *
-     * @private internal util for MockedFackedLlmExecutionTools
+     * @private internal utility for MockedFackedLlmExecutionTools
      */
@@ -927,0 +924,0 @@ function $fakeTextToExpectations(expectations, postprocessing) {

No alert changes

Worsened metrics

Total package byte prevSize

521094

decreased by-38.46%

Number of package files

425

decreased by-49.64%

Lines of code

9613

decreased by-43.41%

No dependency changes