@promptbook/browser 0.63.0-0

package/umd/typings/src/commands/PERSONA/personaCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { PersonaCommand } from './PersonaCommand';
+/**
+ * Parses the persona command
+ *
+ * @see ./PERSONA-README.md for more details
+ * @private within the commands folder
+ */
+export declare const personaCommandParser: CommandParser<PersonaCommand>;

package/umd/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts

@@ -0,0 +1,11 @@
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Parsed POSTPROCESS command
+ *
+ * @see ./postprocessCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type PostprocessCommand = {
+    readonly type: 'POSTPROCESS';
+    readonly functionName: string_name;
+};

package/umd/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts

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

package/umd/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { PostprocessCommand } from './PostprocessCommand';
+/**
+ * Parses the postprocess command
+ *
+ * @see ./POSTPROCESS-README.md for more details
+ * @private within the commands folder
+ */
+export declare const postprocessCommandParser: CommandParser<PostprocessCommand>;

package/umd/typings/src/commands/PROMPTBOOK_VERSION/PromptbookVersionCommand.d.ts

@@ -0,0 +1,11 @@
+import type { string_semantic_version } from '../../types/typeAliases';
+/**
+ * Parsed PROMPTBOOK_VERSION command
+ *
+ * @see ./promptbookVersionCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type PromptbookVersionCommand = {
+    readonly type: 'PROMPTBOOK_VERSION';
+    readonly promptbookVersion: string_semantic_version;
+};

package/umd/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommand.test.d.ts

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

package/umd/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { PromptbookVersionCommand } from './PromptbookVersionCommand';
+/**
+ * Parses the PROMPTBOOK_VERSION command
+ *
+ * @see ./PROMPTBOOK_VERSION-README.md for more details
+ * @private within the commands folder
+ */
+export declare const promptbookVersionCommandParser: CommandParser<PromptbookVersionCommand>;

package/umd/typings/src/commands/URL/UrlCommand.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Parsed URL command
+ *
+ * @see ./urlCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type UrlCommand = {
+    readonly type: 'URL';
+    readonly pipelineUrl: URL;
+};

package/umd/typings/src/commands/URL/urlCommand.test.d.ts

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

package/umd/typings/src/commands/URL/urlCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { UrlCommand } from './UrlCommand';
+/**
+ * Parses the url command
+ *
+ * @see ./URL-README.md for more details
+ * @private within the commands folder
+ */
+export declare const urlCommandParser: CommandParser<UrlCommand>;

package/umd/typings/src/commands/X_ACTION/ActionCommand.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Parsed ACTION command
+ *
+ * @see ./actionCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type ActionCommand = {
+    readonly type: 'ACTION';
+};

package/umd/typings/src/commands/X_ACTION/actionCommand.test.d.ts

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

package/umd/typings/src/commands/X_ACTION/actionCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { ActionCommand } from './ActionCommand';
+/**
+ * Parses the action command
+ *
+ * @see ./ACTION-README.md for more details
+ * @private within the commands folder
+ */
+export declare const actionCommandParser: CommandParser<ActionCommand>;

package/umd/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Parsed INSTRUMENT command
+ *
+ * @see ./instrumentCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type InstrumentCommand = {
+    readonly type: 'INSTRUMENT';
+};

package/umd/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts

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

package/umd/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts

@@ -0,0 +1,9 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { InstrumentCommand } from './InstrumentCommand';
+/**
+ * Parses the instrument command
+ *
+ * @see ./INSTRUMENT-README.md for more details
+ * @private within the commands folder
+ */
+export declare const instrumentCommandParser: CommandParser<InstrumentCommand>;

package/umd/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Parsed BOILERPLATE command
+ *
+ * @see ./boilerplateCommandParser.ts for more details
+ * @private within the commands folder
+ */
+export type BoilerplateCommand = {
+    readonly type: 'BOILERPLATE';
+    readonly value: string;
+};

package/umd/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts

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

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

@@ -0,0 +1,13 @@
+import type { CommandParser } from '../_common/types/CommandParser';
+import type { BoilerplateCommand } from './BoilerplateCommand';
+/**
+ * Parses the boilerplate command
+ *
+ * @see ./BOILERPLATE-README.md for more details
+ * @private within the commands folder
+ */
+export declare const boilerplateCommandParser: CommandParser<BoilerplateCommand>;
+/**
+ * TODO: [💐] Implement BOILERPLATE command into `pipelineStringToJsonSync` function
+ * Note: [⚪] This should never be in any released package
+ */

package/umd/typings/src/commands/_common/parseCommand.d.ts

@@ -0,0 +1,12 @@
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { Command } from './types/Command';
+import type { CommandUsagePlace } from './types/CommandUsagePlaces';
+/**
+ * Parses one line of ul/ol to command
+ *
+ * @returns parsed command object
+ * @throws {ParsingError} if the command is invalid
+ *
+ * @private within the pipelineStringToJson
+ */
+export declare function parseCommand(raw: string_markdown_text, usagePlace: CommandUsagePlace): Command;

package/umd/typings/src/commands/_common/parseCommand.test.d.ts

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

package/umd/typings/src/commands/_common/types/Command.d.ts

@@ -0,0 +1,6 @@
+import { COMMANDS } from '../../index';
+/**
+ * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
+ * It is parsed from the markdown from ul/ol items - one command per one item.
+ */
+export type Command = ReturnType<typeof COMMANDS[number]['parse']>;

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

@@ -0,0 +1,64 @@
+import type { WritableDeep } from 'type-fest';
+import type { PromptTemplateJson } from '../../../types/PipelineJson/PromptTemplateJson';
+import type { PipelineJson } from '../../../types/PipelineJson/PipelineJson';
+import type { string_markdown_text } from '../../../types/typeAliases';
+import type { string_name } from '../../../types/typeAliases';
+import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
+import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { CommandUsagePlace } from './CommandUsagePlaces';
+export type CommandParser<TCommand extends {
+    type: string_name & string_SCREAMING_CASE;
+}> = {
+    readonly name: string_name & string_SCREAMING_CASE;
+    readonly aliasNames?: Array<string_name & string_SCREAMING_CASE>;
+    readonly deprecatedNames?: Array<string_name & string_SCREAMING_CASE>;
+    readonly usagePlaces: Array<CommandUsagePlace>;
+    readonly description: string_markdown_text;
+    readonly documentationUrl: string_promptbook_documentation_url;
+    readonly examples: Array<string_markdown_text>;
+    /**
+     * @throws {ParsingError} if the parsing fails
+     */
+    parse(input: CommandParserInput): TCommand;
+    /**
+     * @@@ Mutated by the command
+     */
+    applyToPipelineJson?(command: TCommand, subjects: ApplyToPipelineJsonSubjects): void;
+};
+export type CommandParserInput = {
+    readonly usagePlace: CommandUsagePlace;
+    readonly raw: string_markdown_text;
+    readonly rawArgs: string_markdown_text;
+    readonly normalized: string_name & string_SCREAMING_CASE;
+    readonly args: Array<string_name & string_SCREAMING_CASE>;
+};
+/**
+ * @@@ Mutated by the command
+ */
+export type ApplyToPipelineJsonSubjects = {
+    /**
+     * @@@ Mutated by the command
+     */
+    readonly pipelineJson: WritableDeep<PipelineJson>;
+    /**
+     * @@@
+     *
+     * @@@ Mutated by the command
+     *
+     * When used in
+     * - `PIPELINE_HEAD` it is `null`
+     * - `PIPELINE_TEMPLATE` it is the prompt template
+     */
+    readonly templateJson: null | Partial<WritableDeep<PromptTemplateJson>>;
+};
+/**
+ * TODO: @@@ Annotate all
+ * TODO: [🍧][♓️] Add order here
+ * TODO: [🧠] Maybe put flag if it is for whole `.ptbk.md` file of just one section
+ * TODO: [🍧] All commands must implement `applyToPipelineJson` method
+ *       which will apply parsed command to the pipeline JSON
+ *       it will be called from `pipelineStringToJsonSync`
+ *       and replace hardcoded switch statement and [💐]
+ *       and throw ParsingError
+ *
+ */

package/umd/typings/src/commands/_common/types/CommandUsagePlaces.d.ts

@@ -0,0 +1,9 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Where the command can be used
+ */
+export type CommandUsagePlace = TupleToUnion<typeof CommandUsagePlaces>;
+/**
+ * Where the command can be used
+ */
+export declare const CommandUsagePlaces: readonly ["PIPELINE_HEAD", "PIPELINE_TEMPLATE"];

package/umd/typings/src/commands/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * All available command parsers
+ */
+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>];

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

@@ -0,0 +1,87 @@
+/**
+ * The maximum number of iterations for a loops
+ *
+ * @private within the repository - too low-level in comparison to other `MAX_...`
+ */
+export declare const LOOP_LIMIT = 1000;
+/**
+ * The maximum number of iterations for a loops which adds characters one by one
+ *
+ * @private within the repository - too low-level in comparison to other `MAX_...`
+ */
+export declare const CHARACTER_LOOP_LIMIT = 100000;
+/**
+ * The maximum number of (LLM) tasks running in parallel
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MAX_PARALLEL_COUNT = 5;
+/**
+ * The maximum number of attempts to execute LLM task before giving up
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MAX_EXECUTION_ATTEMPTS = 3;
+/**
+ * The maximum length of the (generated) filename
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MAX_FILENAME_LENGTH = 30;
+/**
+ * @@@
+ * TODO: [🐝] !!! Use
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
+/**
+ * @@@
+ * TODO: [🐝] !!! Use
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
+/**
+ * Where to store the cache of executions for promptbook CLI
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
+/**
+ * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PIPELINE_COLLECTION_BASE_FILENAME = "index";
+/**
+ * Nonce which is used for replacing things in strings
+ */
+export declare const REPLACING_NONCE = "u$k42k%!V2zo34w7Fu#@QUHYPW";
+/**
+ * The names of the parameters that are reserved for special purposes
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const RESERVED_PARAMETER_NAMES: readonly ["content", "context", "knowledge", "samples", "modelName", "currentDate"];
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const RESERVED_PARAMETER_MISSING_VALUE: string;
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const RESERVED_PARAMETER_RESTRICTED: string;
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare const DEBUG_ALLOW_PAYED_TESTING: boolean;
+/**
+ * TODO: !!!!!! Check that all @private contains some normalized explanation
+ */

package/umd/typings/src/config.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] Maybe more elegant how to prevent accidental costs
+ */

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

@@ -0,0 +1,16 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineString } from '../types/PipelineString';
+/**
+ * Converts promptbook in JSON format to string format
+ *
+ * @param pipelineJson Promptbook in JSON format (.ptbk.json)
+ * @returns Promptbook in string format (.ptbk.md)
+ * @public exported from `@promptbook/core`
+ */
+export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
+/**
+ * TODO: !!!! Implement new features and commands into `promptTemplateParameterJsonToString`
+ * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
+ * TODO: [🏛] Maybe make some markdown builder
+ * TODO: [🏛] Escape all
+ */

package/umd/typings/src/conversion/pipelineStringToJson.d.ts

@@ -0,0 +1,38 @@
+import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineString } from '../types/PipelineString';
+/**
+ * Options for `pipelineStringToJson`
+ *
+ * @public exported from `@promptbook/core`
+ */
+export type PipelineStringToJsonOptions = {
+    /**
+     * Tools for processing required for preparation of knowledge *(not for actual execution)*
+     *
+     * Note: If you provide `null`, the knowledge will not be prepared
+     */
+    readonly llmTools: LlmExecutionTools | null;
+};
+/**
+ * Compile pipeline from string (markdown) format to JSON format
+ *
+ * Note: There are 3 similar functions:
+ * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `preparePipeline` - just one step in the compilation process
+ *
+ * Note: This function does not validate logic of the pipeline only the syntax
+ * Note: This function acts as compilation process
+ *
+ * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
+ * @param options - Options and tools for the compilation
+ * @returns {Promptbook} compiled in JSON format (.ptbk.json)
+ * @throws {ParsingError} if the promptbook string is not valid
+ * @public exported from `@promptbook/core`
+ */
+export declare function pipelineStringToJson(pipelineString: PipelineString, options?: PipelineStringToJsonOptions): Promise<PipelineJson>;
+/**
+ * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ */

package/umd/typings/src/conversion/pipelineStringToJson.test.d.ts

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

package/umd/typings/src/conversion/pipelineStringToJsonSync.d.ts

@@ -0,0 +1,29 @@
+import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import type { PipelineString } from '../types/PipelineString';
+/**
+ * Compile pipeline from string (markdown) format to JSON format synchronously
+ *
+ * Note: There are 3 similar functions:
+ * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `preparePipeline` - just one step in the compilation process
+ *
+ * Note: This function does not validate logic of the pipeline only the syntax
+ * Note: This function acts as compilation process
+ *
+ * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
+ * @returns {Promptbook} compiled in JSON format (.ptbk.json)
+ * @throws {ParsingError} if the promptbook string is not valid
+ * @public exported from `@promptbook/core`
+ */
+export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
+/**
+ * TODO: !!!! Warn if used only sync version
+ * TODO: [🚞] Report here line/column of error
+ * TODO: Use spaceTrim more effectively
+ * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
+ * TODO: [🥞] Not optimal parsing because `splitMarkdownIntoSections` is executed twice with same string, once through `flattenMarkdown` and second directly here
+ * TODO: [♈] Probbably move expectations from templates to parameters
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ * TODO: [🍙] Make some standart order of json properties
+ */

package/umd/typings/src/conversion/pipelineStringToJsonSync.test.d.ts

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

package/umd/typings/src/conversion/prettify/PrettifyOptions.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Options for `prettifyPipelineString` function
+ */
+export type PrettifyOptions = {
+    /***
+     * If true, adds Mermaid graph to the Promptbook string
+     */
+    readonly isGraphAdded?: boolean;
+    /**
+     * If true, the string is prettifyed as markdown
+     */
+    readonly isPrettifyed?: boolean;
+};

package/umd/typings/src/conversion/prettify/prettifyPipelineString.d.ts

@@ -0,0 +1,12 @@
+import type { PipelineString } from '../../types/PipelineString';
+import type { PrettifyOptions } from './PrettifyOptions';
+/**
+ * Prettyfies Promptbook string and adds Mermaid graph
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function prettifyPipelineString(pipelineString: PipelineString, options: PrettifyOptions): Promise<PipelineString>;
+/**
+ * TODO: Maybe use some Mermaid package instead of string templating
+ * TODO: [🕌] When more than 2 functionalities, split into separate functions
+ */

package/umd/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts

@@ -0,0 +1,27 @@
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { PromptTemplateJson } from '../../types/PipelineJson/PromptTemplateJson';
+import type { string_href } from '../../types/typeAliases';
+/**
+ * Addtional options for rendering Mermaid graph
+ */
+export type renderPipelineMermaidOptions = {
+    /**
+     * Callback for creating from prompt template graph node
+     */
+    linkPromptTemplate?(promptTemplate: PromptTemplateJson): {
+        href: string_href;
+        title: string;
+    } | null;
+};
+/**
+ * Creates a Mermaid graph based on the promptbook
+ *
+ * Note: The result is not wrapped in a Markdown code block
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function renderPromptbookMermaid(pipelineJson: PipelineJson, options?: renderPipelineMermaidOptions): string;
+/**
+ * TODO: Maybe use some Mermaid package instead of string templating
+ * TODO: [🕌] When more than 2 functionalities, split into separate functions
+ */

package/umd/typings/src/conversion/utils/extractParameterNamesFromPromptTemplate.d.ts

@@ -0,0 +1,14 @@
+import type { PromptTemplateJson } from '../../types/PipelineJson/PromptTemplateJson';
+import type { string_parameter_name } from '../../types/typeAliases';
+/**
+ * Parses the prompt template and returns the set of all used parameters
+ *
+ * @param promptTemplate the template with used parameters
+ * @returns the set of parameter names
+ * @throws {ParsingError} if the script is invalid
+ * @public exported from `@promptbook/utils`
+ */
+export declare function extractParameterNamesFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'blockType' | 'content' | 'preparedContent' | 'jokerParameterNames'>): Set<string_parameter_name>;
+/**
+ * TODO: [🔣] If script require contentLanguage
+ */

package/umd/typings/src/conversion/utils/extractParameterNamesFromPromptTemplate.test.d.ts

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

package/umd/typings/src/conversion/utils/extractVariables.d.ts

@@ -0,0 +1,14 @@
+import type { string_javascript } from '../../types/typeAliases';
+import type { string_javascript_name } from '../../types/typeAliases';
+/**
+ * Parses the given script and returns the list of all used variables that are not defined in the script
+ *
+ * @param script from which to extract the variables
+ * @returns the list of variable names
+ * @throws {ParsingError} if the script is invalid
+ * @public exported from `@promptbook/utils`
+ */
+export declare function extractVariables(script: string_javascript): Set<string_javascript_name>;
+/**
+ * TODO: [🔣] Support for multiple languages - python, java,...
+ */

package/umd/typings/src/conversion/utils/extractVariables.test.d.ts

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

package/umd/typings/src/conversion/utils/renameParameter.d.ts

@@ -0,0 +1,26 @@
+import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
+import type { string_name } from '../../types/typeAliases';
+type RenameParameterOptions = {
+    /**
+     * Pipeline to search and replace for parameters
+     * This pipeline is returned as copy with replaced parameters
+     */
+    readonly pipeline: PipelineJson;
+    /**
+     * Original parameter name that should be replaced
+     */
+    readonly oldParameterName: string_name;
+    /**
+     * New parameter name that should replace the original parameter name
+     */
+    readonly newParameterName: string_name;
+};
+/**
+ * Function renameParameter will find all usable parameters for given prompt template
+ * In other words, it will find all parameters that are not used in the prompt template itseld and all its dependencies
+ *
+ * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
+ * @public exported from `@promptbook/utils`
+ */
+export declare function renameParameter(options: RenameParameterOptions): PipelineJson;
+export {};

package/umd/typings/src/conversion/utils/renameParameter.test.d.ts

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

package/umd/typings/src/conversion/utils/stringifyPipelineJson.d.ts

@@ -0,0 +1,16 @@
+import type { string_json } from '../../types/typeAliases';
+/**
+ * Stringify the PipelineJson with proper formatting
+ *
+ * Note: [0] It can be used for more JSON types like whole collection of pipelines, single knowledge piece, etc.
+ * Note: In contrast to JSON.stringify, this function ensures that **embedding index** is on single line
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
+/**
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/samples/mixed-knowledge.ptbk.md
+ * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
+ * TODO: [🧠] Maybe more elegant solution than replacing via regex
+ * TODO: [🍙] Make some standart order of json properties
+ */

package/umd/typings/src/conversion/utils/stringifyPipelineJson.test.d.ts

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

package/umd/typings/src/conversion/utils/titleToName.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @@@
+ *
+ * @param value @@@
+ * @returns @@@
+ * @example @@@
+ * @public exported from `@promptbook/utils`
+ */
+export declare function titleToName(value: string): string;

package/umd/typings/src/conversion/utils/titleToName.test.d.ts

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