@promptbook/types 0.86.31 → 0.88.0-8

package/README.md

@@ -23,6 +23,10 @@
 
 
 
+<blockquote style="color: #ff8811">
+    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
+</blockquote>
+
 ## 📦 Package `@promptbook/types`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -274,7 +278,7 @@ Or you can install them separately:
 -   ⭐ **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
 -   **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
 -   _(Not finished)_ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizard for creating+running promptbooks in single line
--   **[@promptbook/execute-javascript](https://www.npmjs.com/package/@promptbook/execute-javascript)** - Execution tools for javascript inside promptbooks
+-   **[@promptbook/javascript](https://www.npmjs.com/package/@promptbook/javascript)** - Execution tools for javascript inside promptbooks
 -   **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
 -   **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK 
 -   **[@promptbook/vercel](https://www.npmjs.com/package/@promptbook/vercel)** - Adapter for Vercel functionalities
@@ -430,8 +434,6 @@ Promptbook project is under [BUSL 1.1 is an SPDX license](https://spdx.org/licen
 
 See [TODO.md](./TODO.md)
 
-
-
 ## 🤝 Partners
 
 <div style="display: flex; align-items: center; gap: 20px;">

package/esm/typings/src/_packages/node.index.d.ts

@@ -6,6 +6,7 @@ import { $provideLlmToolsConfigurationFromEnv } from '../llm-providers/_common/r
 import { $provideLlmToolsFromEnv } from '../llm-providers/_common/register/$provideLlmToolsFromEnv';
 import { $provideFilesystemForNode } from '../scrapers/_common/register/$provideFilesystemForNode';
 import { $provideScrapersForNode } from '../scrapers/_common/register/$provideScrapersForNode';
+import { $provideScriptingForNode } from '../scrapers/_common/register/$provideScriptingForNode';
 import { FileCacheStorage } from '../storage/file-cache-storage/FileCacheStorage';
 import { $execCommand } from '../utils/execCommand/$execCommand';
 import { $execCommands } from '../utils/execCommand/$execCommands';
@@ -17,6 +18,7 @@ export { $provideLlmToolsConfigurationFromEnv };
 export { $provideLlmToolsFromEnv };
 export { $provideFilesystemForNode };
 export { $provideScrapersForNode };
+export { $provideScriptingForNode };
 export { FileCacheStorage };
 export { $execCommand };
 export { $execCommands };

package/esm/typings/src/_packages/types.index.d.ts

@@ -40,6 +40,7 @@ import type { ExecutionReportString } from '../execution/execution-report/Execut
 import type { ExecutionReportStringOptions } from '../execution/execution-report/ExecutionReportStringOptions';
 import type { ExecutionTask } from '../execution/ExecutionTask';
 import type { PreparationTask } from '../execution/ExecutionTask';
+import type { task_status } from '../execution/ExecutionTask';
 import type { AbstractTask } from '../execution/ExecutionTask';
 import type { Task } from '../execution/ExecutionTask';
 import type { ExecutionTools } from '../execution/ExecutionTools';
@@ -322,6 +323,7 @@ export type { ExecutionReportString };
 export type { ExecutionReportStringOptions };
 export type { ExecutionTask };
 export type { PreparationTask };
+export type { task_status };
 export type { AbstractTask };
 export type { Task };
 export type { ExecutionTools };

package/esm/typings/src/cli/cli-commands/common/handleActionErrors.d.ts

@@ -0,0 +1,11 @@
+import type { Command as Program } from 'commander';
+type actionCallbackFunction = Parameters<Program['action']>[0];
+/**
+ * Wraps action to handle error console logging and exit process with error code
+ *
+ * @param action Action to be wrapped in error handling
+ * @returns Wrapped action
+ * @private internal helper function for CLI commands
+ */
+export declare function handleActionErrors(action: actionCallbackFunction): actionCallbackFunction;
+export {};

package/esm/typings/src/execution/ExecutionTask.d.ts

@@ -40,6 +40,10 @@ export type PreparationTask = AbstractTask<PipelineExecutorResult> & {
     readonly taskType: 'PREPARATION';
     readonly taskId: `prep-${task_id}`;
 };
+/**
+ * Status of a task
+ */
+export type task_status = 'RUNNING' | 'FINISHED' | 'ERROR';
 /**
  * Base interface for all task types
  */
@@ -52,6 +56,18 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * Unique identifier for the task
      */
     readonly taskId: task_id;
+    /**
+     * Status of the task
+     */
+    readonly status: task_status;
+    /**
+     * Date when the task was created
+     */
+    readonly createdAt: Date;
+    /**
+     * Date when the task was last updated
+     */
+    readonly updatedAt: Date;
     /**
      * Gets a promise that resolves with the task result
      */
@@ -66,6 +82,14 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * Gets just the current value which is mutated during the task processing
      */
     currentValue: PartialDeep<TTaskResult>;
+    /**
+     * List of errors that occurred during the task processing
+     */
+    readonly errors: Array<Error>;
+    /**
+     * List of warnings that occurred during the task processing
+     */
+    readonly warnings: Array<Error>;
 };
 export type Task = ExecutionTask | PreparationTask;
 export {};

package/esm/typings/src/scrapers/_common/register/$provideScriptingForNode.d.ts

@@ -0,0 +1,11 @@
+import type { ScriptExecutionTools } from '../../../execution/ScriptExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+/**
+ * Provides script execution tools
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $provideScriptingForNode(options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<ScriptExecutionTools>>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

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

@@ -6,7 +6,7 @@ import type { JavascriptExecutionToolsOptions } from './JavascriptExecutionTools
  * Warning: It is used for testing and mocking
  *          **NOT intended to use in the production** due to its unsafe nature, use `JavascriptExecutionTools` instead.
  *
- * @public exported from `@promptbook/execute-javascript`
+ * @public exported from `@promptbook/javascript`
  */
 export declare class JavascriptEvalExecutionTools implements ScriptExecutionTools {
     protected readonly options: JavascriptExecutionToolsOptions;

package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts

@@ -3,6 +3,6 @@ import { JavascriptEvalExecutionTools } from './JavascriptEvalExecutionTools';
  * Placeholder for better implementation of JavascriptExecutionTools - some propper sandboxing
  *
  * @alias JavascriptExecutionTools
- * @public exported from `@promptbook/execute-javascript`
+ * @public exported from `@promptbook/javascript`
  */
 export declare const JavascriptExecutionTools: typeof JavascriptEvalExecutionTools;

package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts

@@ -20,7 +20,7 @@ import { unwrapResult } from '../../utils/unwrapResult';
 /**
  * @@@
  *
- * @public exported from `@promptbook/execute-javascript`
+ * @public exported from `@promptbook/javascript`
  */
 export declare const POSTPROCESSING_FUNCTIONS: {
     spaceTrim: typeof spaceTrim;

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

@@ -6,7 +6,7 @@ import type { string_javascript_name } from '../../../types/typeAliases';
  * @param script from which to extract the variables
  * @returns the list of variable names
  * @throws {ParseError} if the script is invalid
- * @public exported from `@promptbook/execute-javascript`
+ * @public exported from `@promptbook/javascript`
  */
 export declare function extractVariablesFromJavascript(script: string_javascript): Set<string_javascript_name>;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.86.31",
+    "version": "0.88.0-8",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -45,6 +45,6 @@
     "homepage": "https://ptbk.io/",
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.86.31"
+        "@promptbook/core": "0.88.0-8"
     }
 }