@promptbook/javascript 0.111.0-3 → 0.111.0-7

package/umd/src/pipeline/PipelineJson/TaskJson.d.ts

@@ -0,0 +1,11 @@
+import type { ___or___ } from '../../utils/organization/___or___';
+import type { DialogTaskJson } from './DialogTaskJson';
+import type { PromptTaskJson } from './PromptTaskJson';
+import type { ScriptTaskJson } from './ScriptTaskJson';
+import type { SimpleTaskJson } from './SimpleTaskJson';
+/**
+ * Describes one (prompt) task in the pipeline
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type TaskJson = PromptTaskJson | SimpleTaskJson | ScriptTaskJson | DialogTaskJson | ___or___ | ___or___;

package/umd/src/pipeline/PipelineString.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Promptbook is the **core concept of this package**.
+ * It represents a series of tasks chained together to form a pipeline / one big task with input and result parameters.
+ *
+ * Represents a Promptbook pipeline defined as a string.
+ *
+ * @see The main Promptbook documentation for more details: https://github.com/webgptorg/promptbook#promptbook
+ */
+export type PipelineString = string & {
+    readonly _type: 'Promptbook';
+};

package/umd/src/pipeline/book-notation.d.ts

@@ -0,0 +1,20 @@
+import type { string_book } from '../book-2.0/agent-source/string_book';
+import type { PipelineString } from './PipelineString';
+/**
+ * Tag function for notating a pipeline with a book\`...\ notation as template literal
+ *
+ * Note: There are 3 similar functions:
+ * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
+ * 2) `promptTemplate` alias for `prompt`
+ * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
+ *
+ * @param strings The static string parts of the template literal
+ * @param values The dynamic values embedded within the template literal used as data
+ * @returns the pipeline string
+ * @public exported from `@promptbook/core`
+ */
+export declare function book(strings: TemplateStringsArray, ...values: Array<string>): string_book & PipelineString;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/umd/src/pipeline/isValidPipelineString.d.ts

@@ -0,0 +1,13 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Function `isValidPipelineString` will validate the if the string is a valid pipeline string
+ * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
+ *
+ * @param {string} pipelineString the candidate for a pipeline string
+ * @returns {boolean} if the string is a valid pipeline string
+ * @public exported from `@promptbook/core`
+ */
+export declare function isValidPipelineString(pipelineString: string): pipelineString is PipelineString;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */

package/umd/src/pipeline/isValidPipelineString.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */

package/umd/src/pipeline/prompt-notation/helpers/ParameterEscaping.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Normalizes a JSON string so it can be safely rendered without double escaping.
+ *
+ * @param value Candidate JSON string.
+ * @private function of ParameterEscaping
+ */
+declare function normalizeJsonString(value: string): string | null;
+/**
+ * Hides brackets in a string to avoid confusion with template parameters.
+ *
+ * @param value Input string with literal brackets.
+ * @private function of ParameterEscaping
+ */
+declare function hideBrackets(value: string): string;
+/**
+ * Restores hidden brackets.
+ *
+ * @param value String with hidden brackets.
+ * @private function of ParameterEscaping
+ */
+declare function restoreBrackets(value: string): string;
+/**
+ * Decides whether a parameter can be inlined safely.
+ *
+ * @param value Parameter rendered as string.
+ * @private function of ParameterEscaping
+ */
+declare function shouldInlineParameterValue(value: string): boolean;
+/**
+ * Escapes prompt parameter content to avoid breaking the template structure.
+ *
+ * @param value Parameter value to escape.
+ * @param options Escape options for additional characters.
+ * @private function of ParameterEscaping
+ */
+declare function escapePromptParameterValue(value: string, options: {
+    includeBraces: boolean;
+}): string;
+/**
+ * Collection of utilities that keep prompt parameters safe during interpolation.
+ *
+ * @private helper of prompt notation
+ */
+export declare const ParameterEscaping: {
+    normalizeJsonString: typeof normalizeJsonString;
+    hideBrackets: typeof hideBrackets;
+    restoreBrackets: typeof restoreBrackets;
+    shouldInlineParameterValue: typeof shouldInlineParameterValue;
+    escapePromptParameterValue: typeof escapePromptParameterValue;
+};
+export {};

package/umd/src/pipeline/prompt-notation/helpers/ParameterNaming.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Builds placeholder names while avoiding collisions with parameter content.
+ *
+ * @param values Parameter values to scan for conflicting tokens.
+ * @private function of ParameterNaming
+ */
+declare function buildParameterNames(values: string[]): string[];
+/**
+ * Provides naming utilities for prompt parameters.
+ *
+ * @private helper of prompt notation
+ */
+export declare const ParameterNaming: {
+    buildParameterNames: typeof buildParameterNames;
+};
+export {};

package/umd/src/pipeline/prompt-notation/helpers/ParameterSection.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Represents a structured parameter entry.
+ *
+ * @private type of ParameterSection
+ */
+type StructuredParameterEntry = {
+    name: string;
+    value: string;
+    jsonValue: string | null;
+};
+/**
+ * Formats the placeholder used in the prompt body for a parameter.
+ *
+ * @param name Parameter placeholder name.
+ * @private function of ParameterSection
+ */
+declare function formatParameterPlaceholder(name: string): string;
+/**
+ * Builds the structured parameters section appended to the prompt.
+ *
+ * @param items Parameter entries to include.
+ * @private function of ParameterSection
+ */
+declare function buildParametersSection(items: StructuredParameterEntry[]): string;
+/**
+ * Provides helpers for rendering structured parameter placeholders.
+ *
+ * @private helper of prompt notation
+ */
+export declare const ParameterSection: {
+    formatParameterPlaceholder: typeof formatParameterPlaceholder;
+    buildParametersSection: typeof buildParametersSection;
+};
+export {};

package/umd/src/pipeline/prompt-notation.d.ts

@@ -0,0 +1,56 @@
+import type { string_prompt } from '../types/typeAliases';
+import type { really_unknown } from '../utils/organization/really_unknown';
+/**
+ * Prompt string wrapper to retain prompt context across interpolations.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare class PromptString extends String {
+    /**
+     * @param value Prompt content.
+     */
+    constructor(value: string_prompt);
+    /**
+     * Returns the prompt as a primitive string.
+     */
+    toString(): string_prompt;
+    /**
+     * Returns the prompt as a primitive string for implicit coercion.
+     */
+    valueOf(): string_prompt;
+    /**
+     * Ensures template literal coercion returns the raw string.
+     */
+    [Symbol.toPrimitive](): string_prompt;
+}
+/**
+ * Tag function for notating a prompt as template literal
+ *
+ * Note: There are 3 similar functions:
+ * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
+ * 2) `promptTemplate` alias for `prompt`
+ * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
+ *
+ * @param strings
+ * @param values
+ * @returns prompt content wrapped as a PromptString
+ * @public exported from `@promptbook/utils`
+ */
+export declare function prompt(strings: TemplateStringsArray, ...values: Array<really_unknown>): PromptString;
+/**
+ * Tag function for notating a prompt as template literal
+ *
+ * Note: There are 3 similar functions:
+ * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
+ * 2) `promptTemplate` alias for `prompt`
+ * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
+ *
+ * @alias prompt
+ * @public exported from `@promptbook/utils`
+ */
+export declare const promptTemplate: typeof prompt;
+/**
+ * TODO: Maybe split into multiple files
+ * TODO: [🧠][🈴] Where is the best location for this file
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/umd/src/pipeline/prompt-notation.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [??][??] Where is the best location for this file
+ */

package/umd/src/pipeline/validatePipelineString.d.ts

@@ -0,0 +1,16 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Function `validatePipelineString` will validate the if the string is a valid pipeline string
+ * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @param {string} pipelineString the candidate for a pipeline string
+ * @returns {PipelineString} the same string as input, but validated as valid
+ * @throws {ParseError} if the string is not a valid pipeline string
+ * @public exported from `@promptbook/core`
+ */
+export declare function validatePipelineString(pipelineString: string): PipelineString;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */

package/umd/src/playground/permanent/_boilerplate.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/umd/src/playground/permanent/agent-with-browser-playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/umd/src/playground/permanent/error-handling-playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/umd/src/playground/playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/umd/src/postprocessing/utils/extractBlock.d.ts

@@ -0,0 +1,16 @@
+import type { string_markdown } from '../../types/typeAliases';
+/**
+ * Extracts code block from markdown.
+ *
+ * - When there are multiple or no code blocks the function throws a `ParseError`
+ *
+ * Note: There are multiple similar function:
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * - `extractJsonBlock` extracts exactly one valid JSON code block
+ * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
+ * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ * @throws {ParseError} if there is not exactly one code block in the markdown
+ */
+export declare function extractBlock(markdown: string_markdown): string;

package/umd/src/postprocessing/utils/extractJsonBlock.d.ts

@@ -0,0 +1,25 @@
+import type { string_json } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
+import type { really_unknown } from '../../utils/organization/really_unknown';
+/**
+ * Extracts  extracts exactly one valid JSON code block
+ *
+ * - When given string is a valid JSON as it is, it just returns it
+ * - When there is no JSON code block the function throws a `ParseError`
+ * - When there are multiple JSON code blocks the function throws a `ParseError`
+ *
+ * Note: It is not important if marked as ```json BUT if it is VALID JSON
+ * Note: There are multiple similar function:
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * - `extractJsonBlock` extracts exactly one valid JSON code block
+ * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
+ * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ * @throws {ParseError} if there is no valid JSON block in the markdown
+ */
+export declare function extractJsonBlock(markdown: string_markdown): string_json<really_unknown>;
+/**
+ * TODO: Add some auto-healing logic + extract YAML, JSON5, TOML, etc.
+ * TODO: [🏢] Make this logic part of `JsonFormatParser` or `isValidJsonString`
+ */

package/umd/src/postprocessing/utils/extractJsonBlock.test.d.ts

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

package/umd/src/prepare/PrepareAndScrapeOptions.d.ts

@@ -0,0 +1,52 @@
+import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
+import type { string_dirname } from '../types/typeAliases';
+/**
+ * Options for preparation of the pipeline
+ */
+export type PrepareAndScrapeOptions = {
+    /**
+     * Path to the root folder of the pipeline
+     *
+     * Note: When the pipeline is not created from files, it is `null`
+     * Note: This folder must exist (=it is not created recursively)
+     *
+     * @default null or `process.cwd()` when created via `$provide...` function in node
+     */
+    readonly rootDirname?: string_dirname | null;
+    /**
+     * Path to the cache folder
+     *
+     * Note: When the folder does not exist, it is created recursively
+     *
+     * @default DEFAULT_SCRAPE_CACHE_DIRNAME
+     */
+    readonly cacheDirname?: string_dirname;
+    /**
+     * Strategy for caching the intermediate results for knowledge source
+     *
+     * @default DEFAULT_INTERMEDIATE_FILES_STRATEGY
+     */
+    readonly intermediateFilesStrategy?: IntermediateFilesStrategy;
+    /**
+     * Maximum number of tasks running in parallel
+     *
+     * @default DEFAULT_MAX_PARALLEL_COUNT
+     */
+    readonly maxParallelCount?: number;
+    /**
+     * If true, the missing software is automatically installed
+     *
+     * @default DEFAULT_IS_AUTO_INSTALLED
+     */
+    readonly isAutoInstalled?: boolean;
+    /**
+     * If true, the preparation logs additional information
+     *
+     * @default DEFAULT_IS_VERBOSE
+     */
+    readonly isVerbose?: boolean;
+};
+/**
+ * TODO: [🧠] Maybe extend from `CommonToolsOptions`
+ * TODO: [🧠] Maybe split `PrepareAndScrapeOptions` and `ScrapeOptions` (`ScrapeOptions` should be extended from `PrepareAndScrapeOptions`)
+ */

package/umd/src/prepare/isPipelinePrepared.d.ts

@@ -0,0 +1,18 @@
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+/**
+ * Determine if the pipeline is fully prepared
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
+/**
+ * TODO: [🔃][main] If the pipeline was prepared with different version or different set of models, prepare it once again
+ * TODO: [🐠] Maybe base this on `makeValidator`
+ * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
+ * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
+ *     - [🏍] ? Is context in each task
+ *     - [♨] Are examples prepared
+ *     - [♨] Are tasks prepared
+ */

package/umd/src/prepare/isPipelinePrepared.test.d.ts

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

package/umd/src/prepare/preparePipeline.d.ts

@@ -0,0 +1,22 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
+/**
+ * Prepare pipeline locally
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
+ * Note: This function does not validate logic of the pipeline
+ * Note: This function acts as part of compilation process
+ * Note: When the pipeline is already prepared, it returns the same pipeline
+ * @public exported from `@promptbook/core`
+ */
+export declare function preparePipeline(pipeline: PipelineJson, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PipelineJson>;
+/**
+ * TODO: Write tests for `preparePipeline` and `preparePipelineOnRemoteServer`
+ * 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: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ * TODO: [🧠][♏] Maybe if expecting JSON (In Anthropic Claude and other models without non-json) and its not specified in prompt content, append the instructions
+ *       @see https://docs.anthropic.com/en/docs/test-and-evaluate/strengthen-guardrails/increase-consistency#specify-the-desired-output-format
+ */

package/umd/src/prepare/preparePipelineOnRemoteServer.d.ts

@@ -0,0 +1,17 @@
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOptions';
+/**
+ * Prepare pipeline on remote server
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
+ * Note: This function does not validate logic of the pipeline
+ * Note: This function acts as part of compilation process
+ * Note: When the pipeline is already prepared, it returns the same pipeline
+ *
+ * @public exported from `@promptbook/remote-client`
+ */
+export declare function preparePipelineOnRemoteServer<TCustomOptions = undefined>(pipeline: PipelineJson, options: RemoteClientOptions<TCustomOptions>): Promise<PipelineJson>;
+/**
+ * TODO: [🐚] Do not return `Promise<PipelineJson>` But `PreparationTask`
+ */

package/umd/src/prepare/prepareTasks.d.ts

@@ -0,0 +1,36 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
+import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
+type PrepareTaskInput = Pick<PipelineJson, 'tasks' | 'parameters'> & {
+    /**
+     * The number of knowledge pieces available for the pipeline.
+     */
+    readonly knowledgePiecesCount: number;
+};
+type PreparedTasks = {
+    /**
+     * The sequence of tasks after preparation.
+     */
+    readonly tasksPrepared: ReadonlyArray<TaskJson>;
+};
+/**
+ * Prepares tasks by adding knowledge to the prompt and ensuring all necessary parameters are included.
+ *
+ * @param tasks Sequence of tasks that are chained together to form a pipeline
+ * @returns A promise that resolves to the prepared tasks.
+ *
+ * @private internal utility of `preparePipeline`
+ */
+export declare function prepareTasks(pipeline: PrepareTaskInput, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PreparedTasks>;
+export {};
+/**
+ * TODO: [😂] Adding knowledge should be convert to async high-level abstractions, similar thing with expectations to sync high-level abstractions
+ * TODO: [🧠] Add context to each task (if missing)
+ * TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`
+ * TODO: [♨][main] !!3 Prepare index the examples and maybe tasks
+ * 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: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ */

package/umd/src/prepare/unpreparePipeline.d.ts

@@ -0,0 +1,13 @@
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+/**
+ * Unprepare just strips the preparation data of the pipeline
+ *
+ * @deprecated In future version this function will be removed or deprecated
+ * @public exported from `@promptbook/core`
+ */
+export declare function unpreparePipeline(pipeline: PipelineJson): PipelineJson;
+/**
+ * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
+ * TODO: Write tests for `preparePipeline`
+ * TODO: [🍙] Make some standard order of json properties
+ */

package/umd/src/remote-server/RemoteServer.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="node" />
+import type { IDestroyable } from 'destroyable';
+import express from 'express';
+import http from 'http';
+import { DefaultEventsMap, Server } from 'socket.io';
+import type { TODO_any } from '../utils/organization/TODO_any';
+import type { TODO_narrow } from '../utils/organization/TODO_narrow';
+export type RemoteServer = IDestroyable & {
+    /**
+     * HTTP server instance
+     */
+    readonly httpServer: http.Server<TODO_any>;
+    /**
+     * Express application instance
+     *
+     * Note: This is useful for adding custom routes
+     */
+    readonly expressApp: express.Express;
+    /**
+     * Socket.io server instance
+     */
+    readonly socketIoServer: Server<TODO_narrow<DefaultEventsMap>, TODO_narrow<DefaultEventsMap>, TODO_narrow<DefaultEventsMap>, TODO_any>;
+};

package/umd/src/remote-server/createRemoteClient.d.ts

@@ -0,0 +1,10 @@
+import type { Socket } from 'socket.io-client';
+import type { RemoteClientOptions } from './types/RemoteClientOptions';
+/**
+ * Creates a connection to the remote proxy server.
+ *
+ * Note: This function creates a connection to the remote server and returns a socket but responsibility of closing the connection is on the caller
+ *
+ * @private internal utility function
+ */
+export declare function createRemoteClient<TCustomOptions = undefined>(options: RemoteClientOptions<TCustomOptions>): Promise<Socket>;