@promptbook/cli 0.62.2 → 0.63.0-0

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

@@ -1,9 +1,9 @@
-import type { AutomaticTranslator } from './AutomaticTranslator';
-/**
- * This will wrap an automatic translator and log each translation into the console
- */
-export declare class DebugAutomaticTranslator implements AutomaticTranslator {
-    private readonly automaticTranslator;
-    constructor(automaticTranslator: AutomaticTranslator);
-    translate(message: string): Promise<string>;
-}
+import type { AutomaticTranslator } from './AutomaticTranslator';
+/**
+ * This will wrap an automatic translator and log each translation into the console
+ */
+export declare class DebugAutomaticTranslator implements AutomaticTranslator {
+    private readonly automaticTranslator;
+    constructor(automaticTranslator: AutomaticTranslator);
+    translate(message: string): Promise<string>;
+}

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

@@ -1,5 +1,5 @@
-import type { AutomaticTranslator } from './AutomaticTranslator';
-export declare class FakeAutomaticTranslator implements AutomaticTranslator {
-    constructor();
-    translate(message: string): string;
-}
+import type { AutomaticTranslator } from './AutomaticTranslator';
+export declare class FakeAutomaticTranslator implements AutomaticTranslator {
+    constructor();
+    translate(message: string): string;
+}

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

@@ -1,11 +1,11 @@
-import type { AutomaticTranslator } from './AutomaticTranslator';
-import type { TranslatorOptions } from './TranslatorOptions';
-interface LindatAutomaticTranslatorOptions extends TranslatorOptions {
-    apiUrl?: URL;
-}
-export declare class LindatAutomaticTranslator implements AutomaticTranslator {
-    private readonly options;
-    constructor(options: LindatAutomaticTranslatorOptions);
-    translate(message: string): Promise<string>;
-}
-export {};
+import type { AutomaticTranslator } from './AutomaticTranslator';
+import type { TranslatorOptions } from './TranslatorOptions';
+interface LindatAutomaticTranslatorOptions extends TranslatorOptions {
+    apiUrl?: URL;
+}
+export declare class LindatAutomaticTranslator implements AutomaticTranslator {
+    private readonly options;
+    constructor(options: LindatAutomaticTranslatorOptions);
+    translate(message: string): Promise<string>;
+}
+export {};

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

@@ -1,4 +1,4 @@
-export type TranslatorOptions = {
-    readonly from?: string;
-    readonly to: string;
-};
+export type TranslatorOptions = {
+    readonly from?: string;
+    readonly to: string;
+};

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

@@ -1,7 +1,7 @@
-/**
- *
- * @param message
- * @returns
- * @throws {PipelineExecutionError}
- */
-export declare function extractMultiplicatedOccurrence(message: string): string;
+/**
+ *
+ * @param message
+ * @returns
+ * @throws {PipelineExecutionError}
+ */
+export declare function extractMultiplicatedOccurrence(message: string): string;

package/umd/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts

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

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

@@ -1,5 +1,5 @@
-import type { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
-import type { TranslatorOptions } from './automatic-translators/TranslatorOptions';
-export declare function translateMessages({ automaticTranslator, from, to, }: {
-    automaticTranslator: AutomaticTranslator;
-} & TranslatorOptions): Promise<void>;
+import type { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
+import type { TranslatorOptions } from './automatic-translators/TranslatorOptions';
+export declare function translateMessages({ automaticTranslator, from, to, }: {
+    automaticTranslator: AutomaticTranslator;
+} & TranslatorOptions): Promise<void>;

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

@@ -1,63 +1,65 @@
-import type { PromptResultUsage } from '../PromptResultUsage';
-/**
- * @@@
- *
- * 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 ZERO_USAGE
- */
-export declare function addUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;
+import type { PromptResultUsage } from '../PromptResultUsage';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+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 ZERO_USAGE
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function addUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;

package/umd/typings/src/execution/utils/addUsage.test.d.ts

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

package/umd/typings/src/execution/utils/checkExpectations.d.ts

@@ -1,25 +1,27 @@
-import type { Expectations } from '../../types/PipelineJson/Expectations';
-/**
- * Function checkExpectations will check if the expectations on given value are met
- *
- * Note: There are two simmilar functions:
- * - `checkExpectations` which throws an error if the expectations are not met
- * - `isPassingExpectations` which returns a boolean
- *
- * @throws {ExpectError} if the expectations are not met
- * @returns {void} Nothing
- */
-export declare function checkExpectations(expectations: Expectations, value: string): void;
-/**
- * Function checkExpectations will check if the expectations on given value are met
- *
- * Note: There are two simmilar functions:
- * - `checkExpectations` which throws an error if the expectations are not met
- * - `isPassingExpectations` which returns a boolean
- *
- * @returns {boolean} True if the expectations are met
- */
-export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
-/**
- * TODO: [💝] Unite object for expecting amount and format
- */
+import type { Expectations } from '../../types/PipelineJson/Expectations';
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two simmilar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @throws {ExpectError} if the expectations are not met
+ * @returns {void} Nothing
+ * @public exported from `@promptbook/core`
+ */
+export declare function checkExpectations(expectations: Expectations, value: string): void;
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two simmilar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @returns {boolean} True if the expectations are met
+ * @public exported from `@promptbook/core`
+ */
+export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
+/**
+ * TODO: [💝] Unite object for expecting amount and format
+ */

package/umd/typings/src/execution/utils/checkExpectations.test.d.ts

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

package/umd/typings/src/execution/utils/computeUsageCounts.d.ts

@@ -1,10 +1,10 @@
-import type { PromptResultUsageCounts } from '../PromptResultUsage';
-/**
- * Helper of usage compute
- *
- * @param content the content of prompt or response
- * @returns part of PromptResultUsageCounts
- *
- * @private internal util of LlmExecutionTools
- */
-export declare function computeUsageCounts(content: string): Omit<PromptResultUsageCounts, 'tokensCount'>;
+import type { PromptResultUsageCounts } from '../PromptResultUsage';
+/**
+ * Helper of usage compute
+ *
+ * @param content the content of prompt or response
+ * @returns part of PromptResultUsageCounts
+ *
+ * @private internal util of LlmExecutionTools
+ */
+export declare function computeUsageCounts(content: string): Omit<PromptResultUsageCounts, 'tokensCount'>;

package/umd/typings/src/execution/utils/forEachAsync.d.ts

@@ -1,18 +1,19 @@
-import type { Promisable } from 'type-fest';
-type ForEachAsyncOptions = {
-    /**
-     * Maximum number of tasks running in parallel
-     *
-     * @default Infinity
-     */
-    readonly maxParallelCount?: number;
-};
-/**
- * Async version of Array.forEach
- *
- * @param array - Array to iterate over
- * @param options - Options for the function
- * @param callbackfunction - Function to call for each item
- */
-export declare function forEachAsync<TItem>(array: Array<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: Array<TItem>) => Promisable<void>): Promise<void>;
-export {};
+import type { Promisable } from 'type-fest';
+type ForEachAsyncOptions = {
+    /**
+     * Maximum number of tasks running in parallel
+     *
+     * @default Infinity
+     */
+    readonly maxParallelCount?: number;
+};
+/**
+ * Async version of Array.forEach
+ *
+ * @param array - Array to iterate over
+ * @param options - Options for the function
+ * @param callbackfunction - Function to call for each item
+ * @public exported from `@promptbook/utils`
+ */
+export declare function forEachAsync<TItem>(array: Array<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: Array<TItem>) => Promisable<void>): Promise<void>;
+export {};

package/umd/typings/src/execution/utils/uncertainNumber.d.ts

@@ -1,9 +1,9 @@
-import type { UncertainNumber } from '../UncertainNumber';
-/**
- * Make UncertainNumber
- *
- * @param value
- *
- * @private utility for initializating UncertainNumber
- */
-export declare function uncertainNumber(value?: number | typeof NaN | undefined | null): UncertainNumber;
+import type { UncertainNumber } from '../UncertainNumber';
+/**
+ * Make UncertainNumber
+ *
+ * @param value
+ *
+ * @private utility for initializating UncertainNumber
+ */
+export declare function uncertainNumber(value?: number | typeof NaN | undefined | null): UncertainNumber;

package/umd/typings/src/execution/utils/usageToHuman.d.ts

@@ -1,15 +1,17 @@
-import type { string_markdown } from '../../types/typeAliases';
-import type { PromptResultUsage } from '../PromptResultUsage';
-/**
- * Function `usageToHuman` will take usage and convert it to human readable report
- */
-export declare function usageToHuman(usage: PromptResultUsage): string_markdown;
-/**
- * TODO: Use "$1" not "1 USD"
- * TODO: Use markdown formatting like "Cost approximately **$1**"
- * TODO: Report in minutes, seconds, days NOT 0.1 hours
- * TODO: [🧠] Maybe make from `uncertainNumberToHuman` separate exported utility
- * TODO: When negligible usage, report "Negligible" or just don't report it
- * TODO: [🧠] Maybe use "~" instead of "approximately"
- * TODO: [🏛] Maybe make some markdown builder
- */
+import type { string_markdown } from '../../types/typeAliases';
+import type { PromptResultUsage } from '../PromptResultUsage';
+/**
+ * Function `usageToHuman` will take usage and convert it to human readable report
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function usageToHuman(usage: PromptResultUsage): string_markdown;
+/**
+ * TODO: Use "$1" not "1 USD"
+ * TODO: Use markdown formatting like "Cost approximately **$1**"
+ * TODO: Report in minutes, seconds, days NOT 0.1 hours
+ * TODO: [🧠] Maybe make from `uncertainNumberToHuman` separate exported utility
+ * TODO: When negligible usage, report "Negligible" or just don't report it
+ * TODO: [🧠] Maybe use "~" instead of "approximately"
+ * TODO: [🏛] Maybe make some markdown builder
+ */

package/umd/typings/src/execution/utils/usageToHuman.test.d.ts

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

package/umd/typings/src/execution/utils/usageToWorktime.d.ts

@@ -1,10 +1,12 @@
-import type { PromptResultUsage } from '../PromptResultUsage';
-import type { UncertainNumber } from '../UncertainNumber';
-/**
- * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
- *
- * Note: This is an estimate based of theese sources:
- * - https://jecas.cz/doba-cteni
- * - https://www.originalnitonery.cz/blog/psani-vsemi-deseti-se-muzete-naucit-i-sami-doma
- */
-export declare function usageToWorktime(usage: PromptResultUsage): UncertainNumber;
+import type { PromptResultUsage } from '../PromptResultUsage';
+import type { UncertainNumber } from '../UncertainNumber';
+/**
+ * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
+ *
+ * Note: This is an estimate based of theese sources:
+ * - https://jecas.cz/doba-cteni
+ * - https://www.originalnitonery.cz/blog/psani-vsemi-deseti-se-muzete-naucit-i-sami-doma
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function usageToWorktime(usage: PromptResultUsage): UncertainNumber;

package/umd/typings/src/execution/utils/usageToWorktime.test.d.ts

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

package/umd/typings/src/expectations/drafts/isDomainNameFree.d.ts

@@ -1,6 +1,6 @@
-import type { string_name } from '../../types/typeAliases';
-export declare function isDomainNameFree(name: string_name): Promise<boolean>;
-/**
- * TODO: [🍓][🧠] Test and implement `isDomainNameFree`
- * TODO: Export via some (and probably new) NPM package
- */
+import type { string_name } from '../../types/typeAliases';
+export declare function isDomainNameFree(name: string_name): Promise<boolean>;
+/**
+ * TODO: [🍓][🧠] Test and implement `isDomainNameFree`
+ * TODO: Export via some (and probably new) NPM package
+ */

package/umd/typings/src/expectations/drafts/isGithubNameFree.d.ts

@@ -1,6 +1,6 @@
-import type { string_name } from '../../types/typeAliases';
-export declare function isGithubNameFree(name: string_name): Promise<boolean>;
-/**
- * TODO: [🍓][🧠] Test and implement `isGithubNameFree`
- * TODO: Export via some (and probably new) NPM package
- */
+import type { string_name } from '../../types/typeAliases';
+export declare function isGithubNameFree(name: string_name): Promise<boolean>;
+/**
+ * TODO: [🍓][🧠] Test and implement `isGithubNameFree`
+ * TODO: Export via some (and probably new) NPM package
+ */

package/umd/typings/src/formats/_common/FormatDefinition.d.ts

@@ -1,69 +1,70 @@
-import type { string_mime_type } from '../../types/typeAliases';
-import type { string_name } from '../../types/typeAliases';
-/**
- * A format definition is a set of functions that define how to validate, heal and convert response from LLM
- *
- * @see https://github.com/webgptorg/promptbook/discussions/36
- */
-export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSchema extends object> = {
-    /**
-     * The name of the format used in .ptbk.md files
-     *
-     * @sample "JSON"
-     */
-    readonly name: string_name;
-    /**
-     * Aliases for the name
-     */
-    readonly aliases?: Array<string_name>;
-    /**
-     * The mime type of the format (if any)
-     *
-     * @sample "application/json"
-     */
-    readonly mimeType?: string_mime_type;
-    /**
-     * Check if a value is fully valid
-     *
-     * @param value The value to check, for example "{\"foo\": true}"
-     * @param schema Optional schema to do extra validation
-     */
-    isValid(value: string, schema?: TSchema): value is TValue;
-    /**
-     * Check if a first part of a value is valid
-     *
-     * @see https://github.com/webgptorg/promptbook/discussions/37
-     *
-     * @param partialValue Partial value to check, for example "{\"foo\": t"
-     * @param schema Optional schema to do extra validation
-     */
-    canBeValid(partialValue: string, schema?: TSchema): partialValue is TPartialValue;
-    /**
-     * Heal a value to make it valid if possible
-     *
-     * Note: This make sense in context of LLMs that often returns slightly invalid values
-     * @see https://github.com/webgptorg/promptbook/discussions/31
-     *
-     * @param value The value to heal, for example "{foo: true}"
-     * @param scheme
-     * @throws {Error} If the value cannot be healed
-     */
-    heal(value: string, scheme?: TSchema): TValue;
-    /**
-     * Parses just the values and removes structural information
-     *
-     * Note: This is useful when you want to combine format expectations with counting words, characters,...
-     *
-     * @param value The value to check, for example "{\"name\": "John Smith"}"
-     * @param schema Optional schema
-     * @example "{\"name\": "John Smith"}" -> ["John Smith"]
-     */
-    extractValues(value: string, schema?: TSchema): Array<string>;
-};
-/**
- * TODO: [🍓]`name` and `aliases` should be UPPERCASE only and interpreted as case-insensitive (via normalization)
- * TODO: [🍓][👨‍⚖️] Compute TPartialValue dynamically - PartialString<TValue>
- * TODO: [🍓][🧠] Should execution tools be aviable to heal, canBeValid and isValid?
- * TODO: [🍓][🧠] llm Provider Bindings
- * TODO: [🍓][🔼] Export via some package
- */ 
+import type { string_mime_type } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+/**
+ * A format definition is a set of functions that define how to validate, heal and convert response from LLM
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/36
+ * @private still an internal experimental
+ */
+export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSchema extends object> = {
+    /**
+     * The name of the format used in .ptbk.md files
+     *
+     * @sample "JSON"
+     */
+    readonly name: string_name;
+    /**
+     * Aliases for the name
+     */
+    readonly aliases?: Array<string_name>;
+    /**
+     * The mime type of the format (if any)
+     *
+     * @sample "application/json"
+     */
+    readonly mimeType?: string_mime_type;
+    /**
+     * Check if a value is fully valid
+     *
+     * @param value The value to check, for example "{\"foo\": true}"
+     * @param schema Optional schema to do extra validation
+     */
+    isValid(value: string, schema?: TSchema): value is TValue;
+    /**
+     * Check if a first part of a value is valid
+     *
+     * @see https://github.com/webgptorg/promptbook/discussions/37
+     *
+     * @param partialValue Partial value to check, for example "{\"foo\": t"
+     * @param schema Optional schema to do extra validation
+     */
+    canBeValid(partialValue: string, schema?: TSchema): partialValue is TPartialValue;
+    /**
+     * Heal a value to make it valid if possible
+     *
+     * Note: This make sense in context of LLMs that often returns slightly invalid values
+     * @see https://github.com/webgptorg/promptbook/discussions/31
+     *
+     * @param value The value to heal, for example "{foo: true}"
+     * @param scheme
+     * @throws {Error} If the value cannot be healed
+     */
+    heal(value: string, scheme?: TSchema): TValue;
+    /**
+     * Parses just the values and removes structural information
+     *
+     * Note: This is useful when you want to combine format expectations with counting words, characters,...
+     *
+     * @param value The value to check, for example "{\"name\": "John Smith"}"
+     * @param schema Optional schema
+     * @example "{\"name\": "John Smith"}" -> ["John Smith"]
+     */
+    extractValues(value: string, schema?: TSchema): Array<string>;
+};
+/**
+ * TODO: [🍓]`name` and `aliases` should be UPPERCASE only and interpreted as case-insensitive (via normalization)
+ * TODO: [🍓][👨‍⚖️] Compute TPartialValue dynamically - PartialString<TValue>
+ * TODO: [🍓][🧠] Should execution tools be aviable to heal, canBeValid and isValid?
+ * TODO: [🍓][🧠] llm Provider Bindings
+ * TODO: [🍓][🔼] Export via some package
+ */

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

@@ -1,12 +1,12 @@
-import type { FormatDefinition } from '../_common/FormatDefinition';
-/**
- * Definition for CSV spreadsheet
- */
-export declare const CsvFormatDefinition: FormatDefinition<string, string, object>;
-/**
- * TODO: [🍓] In `CsvFormatDefinition` implement simple `isValid`
- * 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
- */
+import type { FormatDefinition } from '../_common/FormatDefinition';
+/**
+ * Definition for CSV spreadsheet
+ */
+export declare const CsvFormatDefinition: FormatDefinition<string, string, object>;
+/**
+ * TODO: [🍓] In `CsvFormatDefinition` implement simple `isValid`
+ * 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
+ */