@promptbook/openai 0.28.0-7 → 0.28.0-8

package/esm/typings/conversion/promptTemplatePipelineStringToJson-syntaxErrors.test.d.ts

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

package/esm/typings/conversion/promptTemplatePipelineStringToJson.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [💥] Some system to automatically generate tests for all the templates in the folder
- */

package/esm/typings/conversion/validatePromptTemplatePipelineJson-logicErrors.test.d.ts

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

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

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [💥] Some system to automatically generate tests for all the templates in the folder
- */

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

@@ -1,3 +1,4 @@
+import { number_integer, number_positive } from '../types/typeAliases';
 /**
  * Represents all the tools needed to interact with the user.
  *
@@ -13,12 +14,20 @@ export interface UserInterfaceTools {
     promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
 }
 export interface UserInterfaceToolsPromptDialogOptions {
+    /**
+     * Prompt title
+     *
+     * Note: This is not a prompt to language model but a prompt to the user
+     * @example "Your name"
+     */
+    promptTitle: string;
     /**
      * Prompt message
      *
      * Note: This is not a prompt to language model but a prompt to the user
+     * @example "Please enter your name, including your last name, title, etc."
      */
-    prompt: string;
+    promptMessage: string;
     /**
      * Default value for the input/textarea
      */
@@ -27,4 +36,10 @@ export interface UserInterfaceToolsPromptDialogOptions {
      * Placeholder for the input/textarea
      */
     placeholder?: string;
+    /**
+     * Priority of the prompt
+     *
+     * Note: This would be reflected for example into the UI z-index of the prompt modal
+     */
+    priority: number_integer & number_positive;
 }

package/esm/typings/execution/plugins/natural-execution-tools/mocked/joker.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPtpExecutor.test.ts"
+ */

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

@@ -6,7 +6,7 @@ import type { ExpectationAmount, ExpectationUnit } from './PromptTemplatePipelin
  * 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 = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
+export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
 /**
  * PtpVersion command tells which version is .ptp file using
  *
@@ -43,6 +43,13 @@ export interface ModelCommand {
     readonly key: keyof ModelRequirements;
     readonly value: any;
 }
+/**
+ * Joker parameter is used instead of executing the prompt template if it meet the expectations requirements
+ */
+export interface JokerCommand {
+    readonly type: 'JOKER';
+    readonly parameterName: string_name;
+}
 /**
  * Parameter command describes one parameter of the prompt template
  *

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

@@ -75,6 +75,10 @@ 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;
+    /**
+     * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
+     */
+    readonly jokers?: Array<string>;
     /**
      * Type of the execution
      * This determines if the prompt template is send to LLM, user or some scripting evaluation

package/esm/typings/types/execution-report/executionReportJsonToString.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [💥] Some system to automatically generate tests for all the templates in the folder
- */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.28.0-7",
+    "version": "0.28.0-8",
     "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.28.0-7"
+        "@promptbook/core": "0.28.0-8"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/typings/conversion/promptTemplatePipelineStringToJson-syntaxErrors.test.d.ts

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

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

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [💥] Some system to automatically generate tests for all the templates in the folder
- */

package/umd/typings/conversion/validatePromptTemplatePipelineJson-logicErrors.test.d.ts

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

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

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [💥] Some system to automatically generate tests for all the templates in the folder
- */

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

@@ -1,3 +1,4 @@
+import { number_integer, number_positive } from '../types/typeAliases';
 /**
  * Represents all the tools needed to interact with the user.
  *
@@ -13,12 +14,20 @@ export interface UserInterfaceTools {
     promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
 }
 export interface UserInterfaceToolsPromptDialogOptions {
+    /**
+     * Prompt title
+     *
+     * Note: This is not a prompt to language model but a prompt to the user
+     * @example "Your name"
+     */
+    promptTitle: string;
     /**
      * Prompt message
      *
      * Note: This is not a prompt to language model but a prompt to the user
+     * @example "Please enter your name, including your last name, title, etc."
      */
-    prompt: string;
+    promptMessage: string;
     /**
      * Default value for the input/textarea
      */
@@ -27,4 +36,10 @@ export interface UserInterfaceToolsPromptDialogOptions {
      * Placeholder for the input/textarea
      */
     placeholder?: string;
+    /**
+     * Priority of the prompt
+     *
+     * Note: This would be reflected for example into the UI z-index of the prompt modal
+     */
+    priority: number_integer & number_positive;
 }

package/umd/typings/execution/plugins/natural-execution-tools/mocked/joker.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPtpExecutor.test.ts"
+ */

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

@@ -6,7 +6,7 @@ import type { ExpectationAmount, ExpectationUnit } from './PromptTemplatePipelin
  * 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 = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
+export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
 /**
  * PtpVersion command tells which version is .ptp file using
  *
@@ -43,6 +43,13 @@ export interface ModelCommand {
     readonly key: keyof ModelRequirements;
     readonly value: any;
 }
+/**
+ * Joker parameter is used instead of executing the prompt template if it meet the expectations requirements
+ */
+export interface JokerCommand {
+    readonly type: 'JOKER';
+    readonly parameterName: string_name;
+}
 /**
  * Parameter command describes one parameter of the prompt template
  *

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

@@ -75,6 +75,10 @@ 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;
+    /**
+     * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
+     */
+    readonly jokers?: Array<string>;
     /**
      * Type of the execution
      * This determines if the prompt template is send to LLM, user or some scripting evaluation

package/umd/typings/types/execution-report/executionReportJsonToString.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [💥] Some system to automatically generate tests for all the templates in the folder
- */