@promptbook/remote-client - npm Package Compare versions

Comparing version 0.28.0-7 to 0.28.0-8

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

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

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

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

esm/typings/execution/UserInterfaceTools.d.ts

@@ -0,1 +1,2 @@
+import { number_integer, number_positive } from '../types/typeAliases';
 /**
@@ -17,7 +18,15 @@ * Represents all the tools needed to interact with the user.
     /**
+     * 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;
     /**
@@ -31,2 +40,8 @@ * Default value 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;
 }

esm/typings/types/Command.d.ts

@@ -9,3 +9,3 @@ import type { string_markdown_text, string_name, string_version } from '.././types/typeAliases';
  */
-export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
+export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
 /**
@@ -48,2 +48,9 @@ * PtpVersion command tells which version is .ptp file using
 /**
+ * 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
@@ -50,0 +57,0 @@ *

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

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

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

@@ -79,2 +79,6 @@ import { number_integer, number_positive_or_zero, string_javascript, string_javascript_name, string_markdown, string_name, string_prompt, string_template } from '../.././types/typeAliases';
     /**
+     * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
+     */
+    readonly jokers?: Array<string>;
+    /**
      * Type of the execution
@@ -81,0 +85,0 @@ * This determines if the prompt template is send to LLM, user or some scripting evaluation

package.json

 {
     "name": "@promptbook/remote-client",
-    "version": "0.28.0-7",
+    "version": "0.28.0-8",
     "description": "Library to supercharge your use of large language models",
@@ -40,3 +40,3 @@ "private": false,
     "peerDependencies": {
-        "@promptbook/core": "0.28.0-7"
+        "@promptbook/core": "0.28.0-8"
     },
@@ -43,0 +43,0 @@ "main": "./umd/index.umd.js",

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

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

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

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

umd/typings/execution/UserInterfaceTools.d.ts

@@ -0,1 +1,2 @@
+import { number_integer, number_positive } from '../types/typeAliases';
 /**
@@ -17,7 +18,15 @@ * Represents all the tools needed to interact with the user.
     /**
+     * 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;
     /**
@@ -31,2 +40,8 @@ * Default value 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;
 }

umd/typings/types/Command.d.ts

@@ -9,3 +9,3 @@ import type { string_markdown_text, string_name, string_version } from '.././types/typeAliases';
  */
-export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
+export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | JokerCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
 /**
@@ -48,2 +48,9 @@ * PtpVersion command tells which version is .ptp file using
 /**
+ * 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
@@ -50,0 +57,0 @@ *

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

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

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

@@ -79,2 +79,6 @@ import { number_integer, number_positive_or_zero, string_javascript, string_javascript_name, string_markdown, string_name, string_prompt, string_template } from '../.././types/typeAliases';
     /**
+     * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
+     */
+    readonly jokers?: Array<string>;
+    /**
      * Type of the execution
@@ -81,0 +85,0 @@ * This determines if the prompt template is send to LLM, user or some scripting evaluation

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

332512

increased by0.47%

Number of package files

270

increased by2.27%

Lines of code

5238

increased by0.89%

No dependency changes