@promptbook/openai 0.29.0 → 0.30.0-1

package/esm/typings/_packages/core.index.d.ts

@@ -1,4 +1,3 @@
-import { PromptTemplatePipeline } from '../classes/PromptTemplatePipeline';
 import { PromptTemplatePipelineLibrary } from '../classes/PromptTemplatePipelineLibrary';
 import { PTBK_VERSION } from '../config';
 import { promptTemplatePipelineStringToJson } from '../conversion/promptTemplatePipelineStringToJson';
@@ -9,7 +8,7 @@ import { CallbackInterfaceTools } from '../execution/plugins/user-interface-exec
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
 import { ExecutionTypes } from '../types/ExecutionTypes';
-export { ExecutionTypes, PTBK_VERSION, PromptTemplatePipeline, PromptTemplatePipelineLibrary };
+export { ExecutionTypes, PTBK_VERSION, PromptTemplatePipelineLibrary };
 export { SimplePromptInterfaceTools };
 export { promptTemplatePipelineStringToJson, validatePromptTemplatePipelineJson };
 export { MockedEchoNaturalExecutionTools };

package/esm/typings/classes/PromptTemplatePipelineLibrary.d.ts

@@ -5,7 +5,6 @@ import { PtpExecutor } from '../execution/PtpExecutor';
 import { Prompt } from '../types/Prompt';
 import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
 import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
-import { PromptTemplatePipeline } from './PromptTemplatePipeline';
 /**
  * Options for PromptTemplatePipelineLibrary
  */
@@ -13,7 +12,7 @@ type PromptTemplatePipelineLibraryOptions = {
     /**
      * The library of prompt template pipelines
      */
-    readonly library: Record<string_name, PromptTemplatePipeline>;
+    readonly library: Record<string_name, PromptTemplatePipelineJson>;
     /**
      * Optional settings for creating a PromptTemplatePipelineExecutor
      */
@@ -45,7 +44,7 @@ export declare class PromptTemplatePipelineLibrary {
     /**
      * Gets prompt template pipeline by name
      */
-    getPtp(name: string_name): PromptTemplatePipeline;
+    getPtp(name: string_name): PromptTemplatePipelineJson;
     /**
      * Checks whether prompt is in the library
      */

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

@@ -1,4 +1,4 @@
-import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
+import type { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
 /**
  * Validates PromptTemplatePipelineJson if it is logically valid.
  *

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

@@ -1,4 +1,4 @@
-import type { PromptTemplatePipeline } from '../classes/PromptTemplatePipeline';
+import { PromptTemplatePipelineJson } from '../_packages/types.index';
 import { ExecutionTools } from './ExecutionTools';
 import { PtpExecutor } from './PtpExecutor';
 export interface CreatePtpExecutorSettings {
@@ -16,7 +16,7 @@ interface CreatePtpExecutorOptions {
     /**
      * The Prompt Template Pipeline (PTP) to be executed
      */
-    readonly ptp: PromptTemplatePipeline;
+    readonly ptp: PromptTemplatePipelineJson;
     /**
      * The execution tools to be used during the execution of the PTP
      */

package/esm/typings/types/PromptTemplatePipelineJson/PromptTemplateJson.d.ts

@@ -75,6 +75,12 @@ interface PromptTemplateJsonCommon {
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
     readonly description?: string;
+    /**
+     * List of parameter names that are used in the prompt template and must be defined before the prompt template is executed
+     *
+     * Note: Joker is one of the dependent parameters
+     */
+    readonly dependentParameterNames: Array<string_name>;
     /**
      * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
      */
@@ -112,7 +118,7 @@ interface PromptTemplateJsonCommon {
     /**
      * Name of the parameter that is the result of the prompt template
      */
-    readonly resultingParameterName: string;
+    readonly resultingParameterName: string_name;
 }
 export {};
 /**

package/esm/typings/types/PromptTemplatePipelineJson/PromptTemplatePipelineJson.d.ts

@@ -8,7 +8,6 @@ import { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
  * It can have 3 formats:
  * -   **.ptbk.md file** in custom markdown format described above
  * -   _(this)_ **JSON** format, parsed from the .ptbk.md file
- * -   **Object** which is created from JSON format and bound with tools around (but not the execution logic)
  *
  * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline
  */

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

@@ -5,7 +5,6 @@
  * It can have 3 formats:
  * -   _(this)_ **.ptbk.md file** in custom markdown format described above
  * -   **JSON** format, parsed from the .ptbk.md file
- * -   **Object** which is created from JSON format and bound with tools around (but not the execution logic)
  *
  * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline
  */

package/esm/typings/utils/extractParameters.d.ts

@@ -0,0 +1,8 @@
+import { string_name, string_template } from '../types/typeAliases';
+/**
+ * Parses the template and returns the list of all parameter names
+ *
+ * @param template the template with parameters in {curly} braces
+ * @returns the list of parameter names
+ */
+export declare function extractParameters(template: string_template): Array<string_name>;

package/esm/typings/utils/extractParameters.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.29.0",
+    "version": "0.30.0-1",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -37,7 +37,7 @@
         "openai": "4.2.0"
     },
     "peerDependencies": {
-        "@promptbook/core": "0.29.0"
+        "@promptbook/core": "0.30.0-1"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/typings/_packages/core.index.d.ts

@@ -1,4 +1,3 @@
-import { PromptTemplatePipeline } from '../classes/PromptTemplatePipeline';
 import { PromptTemplatePipelineLibrary } from '../classes/PromptTemplatePipelineLibrary';
 import { PTBK_VERSION } from '../config';
 import { promptTemplatePipelineStringToJson } from '../conversion/promptTemplatePipelineStringToJson';
@@ -9,7 +8,7 @@ import { CallbackInterfaceTools } from '../execution/plugins/user-interface-exec
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
 import { ExecutionTypes } from '../types/ExecutionTypes';
-export { ExecutionTypes, PTBK_VERSION, PromptTemplatePipeline, PromptTemplatePipelineLibrary };
+export { ExecutionTypes, PTBK_VERSION, PromptTemplatePipelineLibrary };
 export { SimplePromptInterfaceTools };
 export { promptTemplatePipelineStringToJson, validatePromptTemplatePipelineJson };
 export { MockedEchoNaturalExecutionTools };

package/umd/typings/classes/PromptTemplatePipelineLibrary.d.ts

@@ -5,7 +5,6 @@ import { PtpExecutor } from '../execution/PtpExecutor';
 import { Prompt } from '../types/Prompt';
 import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
 import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
-import { PromptTemplatePipeline } from './PromptTemplatePipeline';
 /**
  * Options for PromptTemplatePipelineLibrary
  */
@@ -13,7 +12,7 @@ type PromptTemplatePipelineLibraryOptions = {
     /**
      * The library of prompt template pipelines
      */
-    readonly library: Record<string_name, PromptTemplatePipeline>;
+    readonly library: Record<string_name, PromptTemplatePipelineJson>;
     /**
      * Optional settings for creating a PromptTemplatePipelineExecutor
      */
@@ -45,7 +44,7 @@ export declare class PromptTemplatePipelineLibrary {
     /**
      * Gets prompt template pipeline by name
      */
-    getPtp(name: string_name): PromptTemplatePipeline;
+    getPtp(name: string_name): PromptTemplatePipelineJson;
     /**
      * Checks whether prompt is in the library
      */

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

@@ -1,4 +1,4 @@
-import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
+import type { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
 /**
  * Validates PromptTemplatePipelineJson if it is logically valid.
  *

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

@@ -1,4 +1,4 @@
-import type { PromptTemplatePipeline } from '../classes/PromptTemplatePipeline';
+import { PromptTemplatePipelineJson } from '../_packages/types.index';
 import { ExecutionTools } from './ExecutionTools';
 import { PtpExecutor } from './PtpExecutor';
 export interface CreatePtpExecutorSettings {
@@ -16,7 +16,7 @@ interface CreatePtpExecutorOptions {
     /**
      * The Prompt Template Pipeline (PTP) to be executed
      */
-    readonly ptp: PromptTemplatePipeline;
+    readonly ptp: PromptTemplatePipelineJson;
     /**
      * The execution tools to be used during the execution of the PTP
      */

package/umd/typings/types/PromptTemplatePipelineJson/PromptTemplateJson.d.ts

@@ -75,6 +75,12 @@ interface PromptTemplateJsonCommon {
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
      */
     readonly description?: string;
+    /**
+     * List of parameter names that are used in the prompt template and must be defined before the prompt template is executed
+     *
+     * Note: Joker is one of the dependent parameters
+     */
+    readonly dependentParameterNames: Array<string_name>;
     /**
      * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
      */
@@ -112,7 +118,7 @@ interface PromptTemplateJsonCommon {
     /**
      * Name of the parameter that is the result of the prompt template
      */
-    readonly resultingParameterName: string;
+    readonly resultingParameterName: string_name;
 }
 export {};
 /**

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

@@ -8,7 +8,6 @@ import { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
  * It can have 3 formats:
  * -   **.ptbk.md file** in custom markdown format described above
  * -   _(this)_ **JSON** format, parsed from the .ptbk.md file
- * -   **Object** which is created from JSON format and bound with tools around (but not the execution logic)
  *
  * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline
  */

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

@@ -5,7 +5,6 @@
  * It can have 3 formats:
  * -   _(this)_ **.ptbk.md file** in custom markdown format described above
  * -   **JSON** format, parsed from the .ptbk.md file
- * -   **Object** which is created from JSON format and bound with tools around (but not the execution logic)
  *
  * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline
  */

package/umd/typings/utils/extractParameters.d.ts

@@ -0,0 +1,8 @@
+import { string_name, string_template } from '../types/typeAliases';
+/**
+ * Parses the template and returns the list of all parameter names
+ *
+ * @param template the template with parameters in {curly} braces
+ * @returns the list of parameter names
+ */
+export declare function extractParameters(template: string_template): Array<string_name>;

package/umd/typings/utils/extractParameters.test.d.ts

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

package/esm/typings/classes/PromptTemplatePipeline.d.ts

@@ -1,71 +0,0 @@
-import { string_name, string_version } from '.././types/typeAliases';
-import { PromptTemplateJson } from '../types/PromptTemplatePipelineJson/PromptTemplateJson';
-import { PromptTemplateParameterJson } from '../types/PromptTemplatePipelineJson/PromptTemplateParameterJson';
-import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
-import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
-/**
- * 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:
- * -   **.ptbk.md file** in custom markdown format described above
- * -   **JSON** format, parsed from the .ptbk.md file
- * -   _(this)_ **Object** which is created from JSON format and bound with tools around (but not the execution logic)
- *
- * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline
- */
-export declare class PromptTemplatePipeline {
-    readonly ptbkUrl: URL | null;
-    readonly title: string | null;
-    readonly ptbkVersion: string_version | null;
-    readonly description: string | null;
-    readonly parameters: Record<string_name, PromptTemplateParameterJson>;
-    readonly promptTemplates: Array<PromptTemplateJson>;
-    /**
-     * Constructs PromptTemplatePipeline from any source
-     *
-     * Note: During the construction syntax and logic of source is validated
-     *
-     * @param source content of .ptbk.md or .ptbk.json file
-     * @returns PromptTemplatePipeline
-     */
-    static fromSource(ptbkSource: PromptTemplatePipelineString | PromptTemplatePipelineJson): PromptTemplatePipeline;
-    /**
-     * Constructs PromptTemplatePipeline from markdown source
-     *
-     * Note: During the construction syntax and logic of source is validated
-     *
-     * @param ptbkString content of .ptbk.md file
-     * @returns PromptTemplatePipeline
-     */
-    static fromString(ptbkString: PromptTemplatePipelineString): PromptTemplatePipeline;
-    /**
-     * Constructs PromptTemplatePipeline from JSON source
-     *
-     * Note: During the construction the source is logic validated
-     *
-     * @param ptbkjson content of .ptbk.json file parsed into JSON
-     * @returns PromptTemplatePipeline
-     */
-    static fromJson(ptbkjson: PromptTemplatePipelineJson): PromptTemplatePipeline;
-    private constructor();
-    /**
-     * Returns the first prompt template in the pipeline
-     */
-    get entryPromptTemplate(): PromptTemplateJson;
-    /**
-     * Gets the parameter that is the result of given prompt template
-     */
-    getResultingParameter(promptTemplateName: string_name): PromptTemplateParameterJson;
-    /**
-     * Gets the following prompt template in the pipeline or null if there is no following prompt template and this is the last one
-     */
-    getFollowingPromptTemplate(promptTemplateName: string_name): PromptTemplateJson | null;
-}
-/**
- * TODO: !! [👐][🧠] Split of PromptTemplatePipeline,PromptTemplatePipelineLibrary between interface and class
- * TODO: !! [👐] Make parameters and promptTemplates private WHEN split between interface and class
- * TODO: !! Add generic type for entry and result parameters
- * TODO: Can be Array elegantly typed such as it must have at least one element?
- * TODO: [🧠] Each PromptTemplatePipeline should have its unique hash to be able to compare them and execute on server ONLY the desired ones
- */

package/umd/typings/classes/PromptTemplatePipeline.d.ts

@@ -1,71 +0,0 @@
-import { string_name, string_version } from '.././types/typeAliases';
-import { PromptTemplateJson } from '../types/PromptTemplatePipelineJson/PromptTemplateJson';
-import { PromptTemplateParameterJson } from '../types/PromptTemplatePipelineJson/PromptTemplateParameterJson';
-import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
-import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
-/**
- * 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:
- * -   **.ptbk.md file** in custom markdown format described above
- * -   **JSON** format, parsed from the .ptbk.md file
- * -   _(this)_ **Object** which is created from JSON format and bound with tools around (but not the execution logic)
- *
- * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline
- */
-export declare class PromptTemplatePipeline {
-    readonly ptbkUrl: URL | null;
-    readonly title: string | null;
-    readonly ptbkVersion: string_version | null;
-    readonly description: string | null;
-    readonly parameters: Record<string_name, PromptTemplateParameterJson>;
-    readonly promptTemplates: Array<PromptTemplateJson>;
-    /**
-     * Constructs PromptTemplatePipeline from any source
-     *
-     * Note: During the construction syntax and logic of source is validated
-     *
-     * @param source content of .ptbk.md or .ptbk.json file
-     * @returns PromptTemplatePipeline
-     */
-    static fromSource(ptbkSource: PromptTemplatePipelineString | PromptTemplatePipelineJson): PromptTemplatePipeline;
-    /**
-     * Constructs PromptTemplatePipeline from markdown source
-     *
-     * Note: During the construction syntax and logic of source is validated
-     *
-     * @param ptbkString content of .ptbk.md file
-     * @returns PromptTemplatePipeline
-     */
-    static fromString(ptbkString: PromptTemplatePipelineString): PromptTemplatePipeline;
-    /**
-     * Constructs PromptTemplatePipeline from JSON source
-     *
-     * Note: During the construction the source is logic validated
-     *
-     * @param ptbkjson content of .ptbk.json file parsed into JSON
-     * @returns PromptTemplatePipeline
-     */
-    static fromJson(ptbkjson: PromptTemplatePipelineJson): PromptTemplatePipeline;
-    private constructor();
-    /**
-     * Returns the first prompt template in the pipeline
-     */
-    get entryPromptTemplate(): PromptTemplateJson;
-    /**
-     * Gets the parameter that is the result of given prompt template
-     */
-    getResultingParameter(promptTemplateName: string_name): PromptTemplateParameterJson;
-    /**
-     * Gets the following prompt template in the pipeline or null if there is no following prompt template and this is the last one
-     */
-    getFollowingPromptTemplate(promptTemplateName: string_name): PromptTemplateJson | null;
-}
-/**
- * TODO: !! [👐][🧠] Split of PromptTemplatePipeline,PromptTemplatePipelineLibrary between interface and class
- * TODO: !! [👐] Make parameters and promptTemplates private WHEN split between interface and class
- * TODO: !! Add generic type for entry and result parameters
- * TODO: Can be Array elegantly typed such as it must have at least one element?
- * TODO: [🧠] Each PromptTemplatePipeline should have its unique hash to be able to compare them and execute on server ONLY the desired ones
- */