@promptbook/openai 0.81.0-22 → 0.81.0-24

package/esm/typings/src/conversion/parsePipeline.d.ts

@@ -19,7 +19,7 @@ import type { PipelineString } from '../pipeline/PipelineString';
 export declare function parsePipeline(pipelineString: PipelineString): PipelineJson;
 /**
  * TODO: [🧠] Maybe more things here can be refactored as high-level abstractions
- * TODO: [main] !!!! Warn if used only sync version
+ * TODO: [main] !!4 Warn if used only sync version
  * TODO: [🚞] Report here line/column of error
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal

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

@@ -22,9 +22,9 @@ export type renderPipelineMermaidOptions = {
  */
 export declare function renderPromptbookMermaid(pipelineJson: PipelineJson, options?: renderPipelineMermaidOptions): string;
 /**
- * TODO: [🧠] !! FOREACH in mermaid graph
- * TODO: [🧠] !! Knowledge in mermaid graph
- * TODO: [🧠] !! Personas in mermaid graph
+ * TODO: [🧠] FOREACH in mermaid graph
+ * TODO: [🧠] Knowledge in mermaid graph
+ * TODO: [🧠] Personas in mermaid graph
  * TODO: Maybe use some Mermaid package instead of string templating
  * TODO: [🕌] When more than 2 functionalities, split into separate functions
  */

package/esm/typings/src/conversion/validation/validatePipeline.d.ts

@@ -18,9 +18,9 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
 /**
  * @private internal function for `validatePipeline`
  */
-export declare function validatePipelineCore(pipeline: PipelineJson): void;
+export declare function validatePipeline_InnerFunction(pipeline: PipelineJson): void;
 /**
- * TODO: !! [🧞‍♀️] Do not allow joker + foreach
+ * TODO: [🧞‍♀️] Do not allow joker + foreach
  * TODO: [🧠] Work with promptbookVersion
  * TODO: Use here some json-schema, Zod or something similar and change it to:
  *     > /**
@@ -32,11 +32,11 @@ export declare function validatePipelineCore(pipeline: PipelineJson): void;
  *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
  */
 /**
- * TODO: [🧳][main] !!!! Validate that all examples match expectations
- * TODO: [🧳][🐝][main] !!!! Validate that knowledge is valid (non-void)
- * TODO: [🧳][main] !!!! Validate that persona can be used only with CHAT variant
- * TODO: [🧳][main] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
- * TODO: [🧳][main] !!!! Validate that reserved parameter is not used as joker
+ * TODO: [🧳][main] !!4 Validate that all examples match expectations
+ * TODO: [🧳][🐝][main] !!4 Validate that knowledge is valid (non-void)
+ * TODO: [🧳][main] !!4 Validate that persona can be used only with CHAT variant
+ * TODO: [🧳][main] !!4 Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
+ * TODO: [🧳][main] !!4 Validate that reserved parameter is not used as joker
  * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/esm/typings/src/errors/utils/getErrorReportUrl.d.ts

@@ -1,6 +1,6 @@
 /**
  * Make error report URL for the given error
  *
- * @private !!!!!!
+ * @private private within the repository
  */
 export declare function getErrorReportUrl(error: Error): URL;

package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -16,7 +16,7 @@ export declare const ANTHROPIC_CLAUDE_MODELS: ReadonlyArray<AvailableModel & {
 }>;
 /**
  * Note: [🤖] Add models of new variant
- * TODO: [🧠][main] !!! Add embedding models OR Anthropic has only chat+completion models?
+ * TODO: [🧠][main] !!3 Add embedding models OR Anthropic has only chat+completion models?
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
  * TODO: [🎰] Some mechanism to auto-update available models

package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts

@@ -11,8 +11,8 @@ export declare const createAnthropicClaudeExecutionTools: ((options: AnthropicCl
     className: string;
 };
 /**
- * TODO: [🧠][main] !!!! Make anonymous this with all LLM providers
- * TODO: [🧠][🧱][main] !!!! Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
+ * TODO: [🧠][main] !!4 Make anonymous this with all LLM providers
+ * TODO: [🧠][🧱][main] !!4 Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
  * TODO: [🧠] Maybe auto-detect usage in browser and determine default value of `isProxied`
  * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: [main] !!! Playground with WebGPT / Promptbook.studio anonymous server
- * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO: [main] !!3 Playground with WebGPT / Promptbook.studio anonymous server
+ * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
  * Note: [⚫] Code in this file should never be published in any package
  */

package/esm/typings/src/llm-providers/openai/playground/playground.d.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
  * Note: [⚫] Code in this file should never be published in any package
  */

package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
  * Note: [⚫] Code in this file should never be published in any package
  */

package/esm/typings/src/other/templates/getBookTemplates.d.ts

@@ -18,5 +18,5 @@ export declare function getBookTemplates(formfactorName?: string_formfactor_name
 /**
  * TODO: Unit test
  * TODO: [🧠] Which is the best place for this function
- * TODO: !!!!!! For GENERIC template ensure at least one pipeline is present for typescript in `getBookTemplates`
+ * TODO: !!6 For GENERIC template ensure at least one pipeline is present for typescript in `getBookTemplates`
  */

package/esm/typings/src/personas/preparePersona.d.ts

@@ -10,8 +10,8 @@ import type { string_persona_description } from '../types/typeAliases';
  */
 export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<PersonaPreparedJson['modelRequirements']>;
 /**
- * TODO: [🔃][main] !! If the persona was prepared with different version or different set of models, prepare it once again
- * TODO: [🏢] !! Check validity of `modelName` in pipeline
- * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
- * TODO: [🏢] !! Check validity of `temperature` in pipeline
+ * TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
+ * TODO: [🏢] Check validity of `modelName` in pipeline
+ * TODO: [🏢] Check validity of `systemMessage` in pipeline
+ * TODO: [🏢] Check validity of `temperature` in pipeline
  */

package/esm/typings/src/pipeline/PipelineString.d.ts

@@ -7,6 +7,3 @@
 export type PipelineString = string & {
     readonly _type: 'Promptbook';
 };
-/**
- * TODO: [💩] Better validation (validatePipelineString) or remove branded type and make it just string
- */

package/esm/typings/src/pipeline/book-notation.d.ts

@@ -9,7 +9,6 @@ import type { PipelineString } from './PipelineString';
  */
 export declare function book(strings: TemplateStringsArray, ...values: Array<string>): PipelineString;
 /**
- * TODO: Use ACRY book\`...\ notation instead of as PipelineString
  * TODO: [🧠][🈴] Where is the best location for this file
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/pipeline/isValidPipelineString.d.ts

@@ -3,9 +3,11 @@ import type { PipelineString } from './PipelineString';
  * Function `isValidPipelineString` will validate the if the string is a valid pipeline string
  * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
  *
+ * @param {string} pipelineString the candidate for a pipeline string
+ * @returns {boolean} if the string is a valid pipeline string
  * @public exported from `@promptbook/core`
  */
-export declare function isValidPipelineString(value: string): value is PipelineString;
+export declare function isValidPipelineString(pipelineString: string): pipelineString is PipelineString;
 /**
  * TODO: [🧠][🈴] Where is the best location for this file
  */

package/esm/typings/src/pipeline/validatePipelineString.d.ts

@@ -0,0 +1,14 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Function `validatePipelineString` will validate the if the string is a valid pipeline string
+ * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
+ *
+ * @param {string} pipelineString the candidate for a pipeline string
+ * @returns {PipelineString} the same string as input, but validated as valid
+ * @throws {ParseError} if the string is not a valid pipeline string
+ * @public exported from `@promptbook/core`
+ */
+export declare function validatePipelineString(pipelineString: string): PipelineString;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */

package/esm/typings/src/prepare/isPipelinePrepared.d.ts

@@ -8,7 +8,7 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
  */
 export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
 /**
- * TODO: [🔃][main] !! If the pipeline was prepared with different version or different set of models, prepare it once again
+ * TODO: [🔃][main] If the pipeline was prepared with different version or different set of models, prepare it once again
  * TODO: [🐠] Maybe base this on `makeValidator`
  * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`

package/esm/typings/src/prepare/prepareTasks.d.ts

@@ -25,7 +25,7 @@ export {};
  * TODO: [😂] Adding knowledge should be convert to async high-level abstractions, simmilar thing with expectations to sync high-level abstractions
  * TODO: [🧠] Add context to each task (if missing)
  * TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`
- * TODO: [♨][main] !!! Prepare index the examples and maybe tasks
+ * TODO: [♨][main] !!3 Prepare index the examples and maybe tasks
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time

package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts

@@ -1,4 +1,4 @@
 export {};
 /**
- * TODO: !! Make shared test between JavascriptEvalExecutionTools and JavascriptExecutionTools to test the same functionality when implemented via vm2
+ * TODO: Make shared test between JavascriptEvalExecutionTools and JavascriptExecutionTools to test the same functionality when implemented via vm2
  */

package/esm/typings/src/scripting/javascript/utils/preserve.d.ts

@@ -10,5 +10,5 @@ import type { really_any } from '../../../utils/organization/really_any';
 export declare function preserve(func: (...params: ReadonlyArray<really_any>) => unknown): void;
 /**
  * TODO: Probbably remove in favour of `keepImported`
- * TODO: !! [1] This maybe does memory leak
+ * TODO: [1] This maybe does memory leak
  */

package/esm/typings/src/types/typeAliases.d.ts

@@ -319,6 +319,12 @@ export type string_url = string;
  * For example `"https://collboard.com"`
  */
 export type string_base_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/"`
+ */
+export type string_pipeline_root_url = string;
 /**
  * Semantic helper
  *
@@ -623,8 +629,8 @@ export type number_megabytes = number_positive;
 export type number_gigabytes = number_positive;
 export type number_terabytes = number_positive;
 /**.
- * TODO: [main] !!! Change "For example" to @example
- * TODO: !! Change to branded types
+ * TODO: [main] !!3 Change "For example" to @example
+ * TODO: Change to branded types
  * TODO: Delete type aliases that are not exported or used internally
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts

@@ -40,6 +40,6 @@ export type CheckSerializableAsJsonOptions = {
 export declare function checkSerializableAsJson(options: CheckSerializableAsJsonOptions): void;
 /**
  * TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
- * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
  * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
  */

package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts

@@ -20,6 +20,6 @@ import type { JsonValue } from 'type-fest';
  */
 export declare function isSerializableAsJson(value: unknown): value is JsonValue;
 /**
- * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
  * TODO: [🧠][💺] Can be done this on type-level?
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.81.0-22",
+    "version": "0.81.0-24",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -54,7 +54,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.81.0-22"
+        "@promptbook/core": "0.81.0-24"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.81.0-21';
+    var PROMPTBOOK_ENGINE_VERSION = '0.81.0-23';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -384,7 +384,7 @@
     /**
      * Make error report URL for the given error
      *
-     * @private !!!!!!
+     * @private private within the repository
      */
     function getErrorReportUrl(error) {
         var report = {
@@ -535,7 +535,7 @@
     }
     /**
      * TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
-     * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
+     * TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
      * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
      */
 
@@ -785,6 +785,8 @@
                 throw new PipelineExecutionError("Parameter `{".concat(parameterName, "}` is not defined"));
             }
             parameterValue = valueToString(parameterValue);
+            // Escape curly braces in parameter values to prevent prompt-injection
+            parameterValue = parameterValue.replace(/[{}]/g, '\\$&');
             if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
                 parameterValue = parameterValue
                     .split('\n')
@@ -1524,7 +1526,7 @@
                     prompt: computeUsage("$5.00 / 1M tokens"),
                     output: computeUsage("$15.00 / 1M tokens"),
                 },
-                //TODO: [main] !!! Add gpt-4o-mini-2024-07-18 and all others to be up to date
+                //TODO: [main] !!3 Add gpt-4o-mini-2024-07-18 and all others to be up to date
             },
             /**/
             /**/
@@ -2113,7 +2115,7 @@
                                 assistant_id: this.assistantId,
                                 thread: {
                                     messages: [
-                                        // TODO:  [🗯] !! Allow threads to be passed
+                                        // TODO:  [🗯] Allow threads to be passed
                                         { role: 'user', content: rawPromptContent },
                                     ],
                                 },
@@ -2216,7 +2218,7 @@
      * @public exported from `@promptbook/openai`
      */
     var createOpenAiAssistantExecutionTools = Object.assign(function (options) {
-        // TODO: [🧠][main] !!!! If browser, auto add `dangerouslyAllowBrowser`
+        // TODO: [🧠][main] !!4 If browser, auto add `dangerouslyAllowBrowser`
         if (($isRunningInBrowser() || $isRunningInWebWorker()) && !options.dangerouslyAllowBrowser) {
             options = __assign(__assign({}, options), { dangerouslyAllowBrowser: true });
         }
@@ -2236,7 +2238,7 @@
      * @public exported from `@promptbook/openai`
      */
     var createOpenAiExecutionTools = Object.assign(function (options) {
-        // TODO: [🧠][main] !!!! If browser, auto add `dangerouslyAllowBrowser`
+        // TODO: [🧠][main] !!4 If browser, auto add `dangerouslyAllowBrowser`
         if (($isRunningInBrowser() || $isRunningInWebWorker()) && !options.dangerouslyAllowBrowser) {
             options = __assign(__assign({}, options), { dangerouslyAllowBrowser: true });
         }