@promptbook/types 0.35.0 → 0.36.1

package/umd/typings/config.d.ts

@@ -1,12 +0,0 @@
-import { ModelRequirements } from './types/ModelRequirements';
-/**
- * Default model requirements for the pipeline
- *
- * Note: As default, we use the chat model gpt-3.5-turbo. For most tasks, this is the best model with most intuitive usage.
- *       GPT-4 is overkill for most tasks so keeping it as opt-in option.
- */
-export declare const DEFAULT_MODEL_REQUIREMENTS: ModelRequirements;
-/**
- * TODO: !!! Different default model for different model variant
- * TODO: [🧠] What should be the default model?
- */

package/umd/typings/conversion/_importPtp.d.ts

@@ -1,12 +0,0 @@
-import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
-import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
-/**
- * Import the text file
- *
- * Note: Using here custom import to work in jest tests
- * Note: Using sync version is 💩 in the production code, but it's ok here in tests
- *
- * @private
- */
-export declare function importPtp(path: `${string}.ptbk.md`): PromptTemplatePipelineString;
-export declare function importPtp(path: `${string}.ptbk.json`): PromptTemplatePipelineJson;

package/umd/typings/conversion/promptTemplatePipelineStringToJson.d.ts

@@ -1,13 +0,0 @@
-import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
-import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
-/**
- * Parse prompt template pipeline from string format to JSON format
- *
- * Note: This function does not validate logic of the pipeline only the syntax
- */
-export declare function promptTemplatePipelineStringToJson(promptTemplatePipelineString: PromptTemplatePipelineString): PromptTemplatePipelineJson;
-/**
- * TODO: Report here line/column of error
- * TODO: Use spaceTrim more effectively
- * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
- */

package/umd/typings/conversion/validatePromptTemplatePipelineJson.d.ts

@@ -1,26 +0,0 @@
-import type { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
-/**
- * Validates PromptTemplatePipelineJson if it is logically valid.
- *
- * It checks:
- * -   if it has correct parameters dependency
- *
- * It does NOT check:
- * -   if it is valid json
- * -   if it is meaningful
- *
- * @param ptp valid or invalid PromptTemplatePipelineJson
- * @throws {Error} if invalid
- */
-export declare function validatePromptTemplatePipelineJson(ptp: PromptTemplatePipelineJson): void;
-/**
- * TODO: [🧠] Work with ptbkVersion
- * TODO: Use here some json-schema, Zod or something similar and change it to:
- *     > /**
- *     >  * Validates PromptTemplatePipelineJson if it is logically valid.
- *     >  *
- *     >  * It checks:
- *     >  * -   it has a valid structure
- *     >  * -   ...
- *     >  ex port function validatePromptTemplatePipelineJson(ptp: unknown): asserts ptp is PromptTemplatePipelineJson {
- */

package/umd/typings/execution/createPtpExecutor.d.ts

@@ -1,40 +0,0 @@
-import { PromptTemplatePipelineJson } from '../_packages/types.index';
-import { ExecutionTools } from './ExecutionTools';
-import { PtpExecutor } from './PtpExecutor';
-export interface CreatePtpExecutorSettings {
-    /**
-     * When executor does not satisfy expectations it will be retried this amount of times
-     *
-     * @default 3
-     */
-    readonly maxExecutionAttempts: number;
-}
-/**
- * Options for creating a PTP (Prompt Template Pipeline) executor
- */
-interface CreatePtpExecutorOptions {
-    /**
-     * The Prompt Template Pipeline (PTP) to be executed
-     */
-    readonly ptp: PromptTemplatePipelineJson;
-    /**
-     * The execution tools to be used during the execution of the PTP
-     */
-    readonly tools: ExecutionTools;
-    /**
-     * Optional settings for the PTP executor
-     */
-    readonly settings?: Partial<CreatePtpExecutorSettings>;
-}
-/**
- * Creates executor function from prompt template pipeline and execution tools.
- *
- * Note: Consider using getExecutor method of the library instead of using this function
- */
-export declare function createPtpExecutor(options: CreatePtpExecutorOptions): PtpExecutor;
-export {};
-/**
- * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
- * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
- * Note: CreatePtpExecutorOptions are just connected to PtpExecutor so do not extract to types folder
- */

package/umd/typings/types/PromptTemplatePipelineString.d.ts

@@ -1,16 +0,0 @@
-/**
- * Prompt template pipeline is the **core concept of this library**.
- * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
- *
- * It can have 3 formats:
- * -   _(this)_ **.ptbk.md file** in custom markdown format described above
- * -   **JSON** format, parsed from the .ptbk.md file
- *
- * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline
- */
-export type PromptTemplatePipelineString = string & {
-    readonly _type: 'PromptTemplatePipeline';
-};
-/**
- * TODO: !! Better validation (validatePromptTemplatePipelineString) or remove branded type and make it just string
- */