@promptbook/legacy-documents 0.71.0-12

package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts

@@ -0,0 +1,60 @@
+import { Promisable, ReadonlyDeep } from 'type-fest';
+import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { TaskProgress } from '../../types/TaskProgress';
+import type { Parameters } from '../../types/typeAliases';
+import type { ExecutionTools } from '../ExecutionTools';
+import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
+/**
+ * @@@
+ *
+ * @private internal type of `executeTemplate`
+ */
+type executeSingleTemplateOptions = {
+    /**
+     * @@@
+     */
+    readonly currentTemplate: ReadonlyDeep<TemplateJson>;
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly parametersToPass: Readonly<Parameters>;
+    /**
+     * @@@
+     */
+    readonly tools: ExecutionTools;
+    /**
+     * @@@
+     */
+    readonly onProgress: (taskProgress: TaskProgress) => Promisable<void>;
+    /**
+     * Settings for the pipeline executor
+     */
+    readonly settings: CreatePipelineExecutorSettings;
+    /**
+     * @@@
+     */
+    readonly $executionReport: ExecutionReportJson;
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function executeTemplate(options: executeSingleTemplateOptions): Promise<Readonly<Parameters>>;
+export {};
+/**
+ * TODO: [🤹‍♂️]
+ */
+/**
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
+ */

package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts

@@ -0,0 +1,15 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { ExecuteAttemptsOptions } from './40-executeAttempts';
+/**
+ * @@@
+ *
+ * @private internal type of `executeFormatSubvalues`
+ */
+type ExecuteFormatCellsOptions = ExecuteAttemptsOptions;
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function executeFormatSubvalues(options: ExecuteFormatCellsOptions): Promise<TODO_any>;
+export {};

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -0,0 +1,69 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { Parameters } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { TODO_string } from '../../utils/organization/TODO_string';
+import type { ExecutionTools } from '../ExecutionTools';
+import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
+/**
+ * @@@
+ *
+ * @private internal type of `executeAttempts`
+ */
+export type ExecuteAttemptsOptions = {
+    /**
+     * @@@
+     */
+    readonly jokerParameterNames: Readonly<Array<string_parameter_name>>;
+    /**
+     * @@@
+     */
+    readonly priority: number;
+    /**
+     * @@@
+     */
+    readonly maxAttempts: number;
+    /**
+     * @@@
+     */
+    readonly preparedContent: TODO_string;
+    /**
+     * @@@
+     */
+    readonly parameters: Readonly<Parameters>;
+    /**
+     * @@@
+     */
+    readonly template: ReadonlyDeep<TemplateJson>;
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly tools: ExecutionTools;
+    /**
+     * Settings for the pipeline executor
+     */
+    readonly settings: CreatePipelineExecutorSettings;
+    /**
+     * @@@
+     */
+    readonly $executionReport: ExecutionReportJson;
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function executeAttempts(options: ExecuteAttemptsOptions): Promise<TODO_string>;
+/**
+ * TODO: Break into smaller functions
+ */

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

@@ -0,0 +1,34 @@
+import type { ReadonlyDeep } from 'type-fest';
+import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { Parameters } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal type of `createPipelineExecutor`
+ */
+type FilterJustOutputParametersOptions = {
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly parametersToPass: Readonly<Parameters>;
+    /**
+     * @@@
+     */
+    readonly $warnings: PipelineExecutionError[];
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function filterJustOutputParameters(options: FilterJustOutputParametersOptions): Parameters;
+export {};

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

@@ -0,0 +1,10 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getContextForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;

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

@@ -0,0 +1,27 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal type of `getKnowledgeForTemplate`
+ */
+type GetKnowledgeForTemplateOptions = {
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly template: ReadonlyDeep<TemplateJson>;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getKnowledgeForTemplate(options: GetKnowledgeForTemplateOptions): Promise<string_parameter_value & string_markdown>;
+export {};

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

@@ -0,0 +1,30 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { ReservedParameters } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal type of `getReservedParametersForTemplate`
+ */
+type GetReservedParametersForTemplateOptions = {
+    /**
+     * @@@
+     */
+    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * @@@
+     */
+    readonly template: ReadonlyDeep<TemplateJson>;
+    /**
+     * @@@
+     */
+    readonly pipelineIdentification: string;
+};
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getReservedParametersForTemplate(options: GetReservedParametersForTemplateOptions): Promise<Readonly<ReservedParameters>>;
+export {};

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

@@ -0,0 +1,10 @@
+import type { ReadonlyDeep } from 'type-fest';
+import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function getSamplesForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;

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

@@ -0,0 +1,7 @@
+import type { EmbeddingVector } from './EmbeddingVector';
+/**
+ * Pretty print an embedding vector for logging
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function embeddingVectorToString(embeddingVector: Readonly<EmbeddingVector>): string;

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

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

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

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

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

@@ -0,0 +1,8 @@
+import type { AutomaticTranslator } from './AutomaticTranslator';
+/**
+ * @private still in development [🏳]
+ */
+export declare class FakeAutomaticTranslator implements AutomaticTranslator {
+    constructor();
+    translate(message: string): string;
+}

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

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

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

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

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

@@ -0,0 +1,8 @@
+/**
+ *
+ * @param message
+ * @returns
+ * @throws {PipelineExecutionError}
+ * @private still in development [🏳]
+ */
+export declare function extractMultiplicatedOccurrence(message: string): string;

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

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

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

@@ -0,0 +1,11 @@
+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>;
+/**
+ * TODO: [😶] Unite floder listing
+ */

package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts

@@ -0,0 +1,13 @@
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { ExecutionTools } from '../ExecutionTools';
+/**
+ * Note: There is unfortunately no equivalent for this function in the browser environment
+ *       because it is not possible automatically detect configured LLM providers
+ *       you need to provide them manually BUT you can help by utilities like `$provideScrapersForBrowser`
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $provideExecutionToolsForNode(options?: PrepareAndScrapeOptions): Promise<ExecutionTools>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

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

@@ -0,0 +1,65 @@
+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/esm/typings/src/execution/utils/addUsage.test.d.ts

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

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

@@ -0,0 +1,29 @@
+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
+ * @private internal function of `createPipelineExecutor`
+ */
+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
+ * TODO: [🧠][🤠] This should be part of `TextFormatDefinition`
+ * Note: [💝] and [🤠] are interconnected together
+ */

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

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

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

@@ -0,0 +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 utility of LlmExecutionTools
+ */
+export declare function computeUsageCounts(content: string): Omit<PromptResultUsageCounts, 'tokensCount'>;

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

@@ -0,0 +1,20 @@
+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`
+ * @deprecated [🪂] Use queues instead
+ */
+export declare function forEachAsync<TItem>(array: Array<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: Array<TItem>) => Promisable<void>): Promise<void>;
+export {};

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

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

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

@@ -0,0 +1,16 @@
+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: [🧠] Maybe use "~" instead of "approximately"
+ * TODO: [🏛] Maybe make some markdown builder
+ */

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

@@ -0,0 +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
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function usageToWorktime(usage: PromptResultUsage): UncertainNumber;

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

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

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

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

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

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

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

@@ -0,0 +1,70 @@
+import type { string_mime_type } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { empty_object } from '../../utils/organization/empty_object';
+import type { FormatSubvalueDefinition } from './FormatSubvalueDefinition';
+/**
+ * A format definition is a set of functions that define how to validate, heal and convert response from LLM
+ *
+ * @@@ Describe setting vs schema
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/36
+ * @private still in development [🏢]
+ */
+export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
+    /**
+     * The name of the format used in .ptbk.md files
+     *
+     * @sample "JSON"
+     */
+    readonly formatName: string_name & string_SCREAMING_CASE;
+    /**
+     * Aliases for the `formatName`
+     */
+    readonly aliases?: Array<string_name & string_SCREAMING_CASE>;
+    /**
+     * 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, settings?: TSettings, 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, settings?: TSettings, 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, settings?: TSettings, scheme?: TSchema): TValue;
+    /**
+     * @@@
+     */
+    readonly subvalueDefinitions: Array<FormatSubvalueDefinition<TValue, TSettings>>;
+};
+/**
+ * TODO: [♏] Add some prepare hook to modify prompt according to the format
+ * 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
+ */