@promptbook/editable 0.94.0-0 → 0.94.0-3

package/README.md

@@ -189,16 +189,8 @@ Join our growing community of developers and users:
 
 _A concise, Markdown-based DSL for crafting AI workflows and automations._
 
----
 
-### 📑 Table of Contents
 
--   [Introduction](#introduction)
--   [Example](#example)
--   [1. What: Workflows, Tasks & Parameters](#1-what-workflows-tasks--parameters)
--   [2. Who: Personas](#2-who-personas)
--   [3. How: Knowledge, Instruments & Actions](#3-how-knowledge-instruments-and-actions)
--   [General Principles](#general-principles)
 
 ### Introduction
 
@@ -311,6 +303,7 @@ Or you can install them separately:
 -   **[@promptbook/vercel](https://www.npmjs.com/package/@promptbook/vercel)** - Adapter for Vercel functionalities
 -   **[@promptbook/google](https://www.npmjs.com/package/@promptbook/google)** - Integration with Google's Gemini API
 -   **[@promptbook/deepseek](https://www.npmjs.com/package/@promptbook/deepseek)** - Integration with [DeepSeek API](https://www.deepseek.com/)
+-   **[@promptbook/ollama](https://www.npmjs.com/package/@promptbook/ollama)** - Integration with [Ollama](https://ollama.com/) API
 -   **[@promptbook/azure-openai](https://www.npmjs.com/package/@promptbook/azure-openai)** - Execution tools for Azure OpenAI API
 
 -   **[@promptbook/fake-llm](https://www.npmjs.com/package/@promptbook/fake-llm)** - Mocked execution tools for testing the library and saving the tokens

package/esm/index.es.js

@@ -17,7 +17,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.94.0-0';
+const PROMPTBOOK_ENGINE_VERSION = '0.94.0-3';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

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

@@ -8,6 +8,8 @@ import { _DeepseekMetadataRegistration } from '../llm-providers/deepseek/registe
 import { _DeepseekRegistration } from '../llm-providers/deepseek/register-constructor';
 import { _GoogleMetadataRegistration } from '../llm-providers/google/register-configuration';
 import { _GoogleRegistration } from '../llm-providers/google/register-constructor';
+import { _OllamaMetadataRegistration } from '../llm-providers/ollama/register-configuration';
+import { _OllamaRegistration } from '../llm-providers/ollama/register-constructor';
 import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
@@ -36,6 +38,8 @@ export { _DeepseekMetadataRegistration };
 export { _DeepseekRegistration };
 export { _GoogleMetadataRegistration };
 export { _GoogleRegistration };
+export { _OllamaMetadataRegistration };
+export { _OllamaRegistration };
 export { _OpenAiMetadataRegistration };
 export { _OpenAiAssistantMetadataRegistration };
 export { _OpenAiRegistration };

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

@@ -108,6 +108,7 @@ import { _AnthropicClaudeMetadataRegistration } from '../llm-providers/anthropic
 import { _AzureOpenAiMetadataRegistration } from '../llm-providers/azure-openai/register-configuration';
 import { _DeepseekMetadataRegistration } from '../llm-providers/deepseek/register-configuration';
 import { _GoogleMetadataRegistration } from '../llm-providers/google/register-configuration';
+import { _OllamaMetadataRegistration } from '../llm-providers/ollama/register-configuration';
 import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { migratePipeline } from '../migrations/migratePipeline';
@@ -255,6 +256,7 @@ export { _AnthropicClaudeMetadataRegistration };
 export { _AzureOpenAiMetadataRegistration };
 export { _DeepseekMetadataRegistration };
 export { _GoogleMetadataRegistration };
+export { _OllamaMetadataRegistration };
 export { _OpenAiMetadataRegistration };
 export { _OpenAiAssistantMetadataRegistration };
 export { migratePipeline };

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

@@ -0,0 +1,10 @@
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { createOllamaExecutionTools } from '../llm-providers/ollama/createOllamaExecutionTools';
+import { DEFAULT_OLLAMA_BASE_URL } from '../llm-providers/ollama/OllamaExecutionToolsOptions';
+import type { OllamaExecutionToolsOptions } from '../llm-providers/ollama/OllamaExecutionToolsOptions';
+import { _OllamaRegistration } from '../llm-providers/ollama/register-constructor';
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { createOllamaExecutionTools };
+export { DEFAULT_OLLAMA_BASE_URL };
+export type { OllamaExecutionToolsOptions };
+export { _OllamaRegistration };

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

@@ -79,6 +79,7 @@ import type { AnthropicClaudeExecutionToolsProxiedOptions } from '../llm-provide
 import type { AzureOpenAiExecutionToolsOptions } from '../llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions';
 import type { DeepseekExecutionToolsOptions } from '../llm-providers/deepseek/DeepseekExecutionToolsOptions';
 import type { GoogleExecutionToolsOptions } from '../llm-providers/google/GoogleExecutionToolsOptions';
+import type { OllamaExecutionToolsOptions } from '../llm-providers/ollama/OllamaExecutionToolsOptions';
 import type { OpenAiAssistantExecutionToolsOptions } from '../llm-providers/openai/OpenAiAssistantExecutionToolsOptions';
 import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
 import type { VercelExecutionToolsOptions } from '../llm-providers/vercel/VercelExecutionToolsOptions';
@@ -377,6 +378,7 @@ export type { AnthropicClaudeExecutionToolsProxiedOptions };
 export type { AzureOpenAiExecutionToolsOptions };
 export type { DeepseekExecutionToolsOptions };
 export type { GoogleExecutionToolsOptions };
+export type { OllamaExecutionToolsOptions };
 export type { OpenAiAssistantExecutionToolsOptions };
 export type { OpenAiExecutionToolsOptions };
 export type { VercelExecutionToolsOptions };

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

@@ -7,6 +7,8 @@ import { _DeepseekMetadataRegistration } from '../llm-providers/deepseek/registe
 import { _DeepseekRegistration } from '../llm-providers/deepseek/register-constructor';
 import { _GoogleMetadataRegistration } from '../llm-providers/google/register-configuration';
 import { _GoogleRegistration } from '../llm-providers/google/register-constructor';
+import { _OllamaMetadataRegistration } from '../llm-providers/ollama/register-configuration';
+import { _OllamaRegistration } from '../llm-providers/ollama/register-constructor';
 import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
@@ -35,6 +37,8 @@ export { _DeepseekMetadataRegistration };
 export { _DeepseekRegistration };
 export { _GoogleMetadataRegistration };
 export { _GoogleRegistration };
+export { _OllamaMetadataRegistration };
+export { _OllamaRegistration };
 export { _OpenAiMetadataRegistration };
 export { _OpenAiAssistantMetadataRegistration };
 export { _OpenAiRegistration };

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

@@ -1,4 +1,5 @@
 import type { ModelVariant } from '../types/ModelVariant';
+import type { number_usd } from '../types/typeAliases';
 import type { string_model_description } from '../types/typeAliases';
 import type { string_model_name } from '../types/typeAliases';
 import type { string_title } from '../types/typeAliases';
@@ -32,7 +33,14 @@ export type AvailableModel = {
      * @example "Model with 1 billion parameters and advanced reasoning capabilities"
      */
     readonly modelDescription?: string_model_description;
+    /**
+     * Pricing information for the model
+     */
+    readonly pricing?: {
+        readonly prompt: number_usd;
+        readonly output: number_usd;
+    };
 };
 /**
- * TODO: (not only [🕘]) Put pricing information here
+ * TODO: [🧠] Maybe rename to something else - like `ModelInformation` or `ModelMetadata`
  */

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

@@ -72,6 +72,8 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
     readonly taskId: task_id;
     /**
      * Human-readable title of the task - used for displaying in the UI
+     *
+     * For example name of the book which is being executed
      */
     readonly title: string;
     /**
@@ -99,7 +101,7 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
     /**
      * Gets just the current value which is mutated during the task processing
      */
-    currentValue: PartialDeep<TTaskResult>;
+    readonly currentValue: PartialDeep<TTaskResult>;
     /**
      * List of errors that occurred during the task processing
      */

package/esm/typings/src/llm-providers/_common/filterModels.d.ts

@@ -4,12 +4,12 @@ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
  * Creates a wrapper around LlmExecutionTools that only exposes models matching the filter function
  *
  * @param llmTools The original LLM execution tools to wrap
- * @param modelFilter Function that determines whether a model should be included
+ * @param predicate Function that determines whether a model should be included
  * @returns A new LlmExecutionTools instance with filtered models
  *
  * @public exported from `@promptbook/core`
  */
-export declare function filterModels<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools, modelFilter: (model: AvailableModel) => boolean): TLlmTools;
+export declare function filterModels<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools, predicate: (model: AvailableModel) => boolean): TLlmTools;
 /**
  * TODO: !!! [models] Test that this is working
  */

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

@@ -2,7 +2,7 @@ import type { ClientOptions } from '@anthropic-ai/sdk';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { RemoteClientOptions } from '../../remote-server/types/RemoteClientOptions';
 /**
- * Options for `AnthropicClaudeExecutionTools`
+ * Options for `createAnthropicClaudeExecutionTools` and `AnthropicClaudeExecutionTools`
  *
  * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
  * @public exported from `@promptbook/anthropic-claude`

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

@@ -3,7 +3,7 @@ import type { string_name } from '../../types/typeAliases';
 import type { string_token } from '../../types/typeAliases';
 import type { string_user_id } from '../../types/typeAliases';
 /**
- * Options for `AzureOpenAiExecutionTools`
+ * Options for `createAzureOpenAiExecutionTools` and `AzureOpenAiExecutionTools`
  *
  * @see https://oai.azure.com/portal/
  * @public exported from `@promptbook/azure-openai`

package/esm/typings/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts

@@ -1,7 +1,7 @@
 import type { createDeepSeek } from '@ai-sdk/deepseek';
 import type { VercelExecutionToolsOptions } from '../vercel/VercelExecutionToolsOptions';
 /**
- * Options for `DeepseekExecutionTools`
+ * Options for `createDeepseekExecutionTools`
  *
  * This combines options for Promptbook, Deepseek and Vercel together
  * @public exported from `@promptbook/deepseek`

package/esm/typings/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts

@@ -1,7 +1,7 @@
 import type { createGoogleGenerativeAI } from '@ai-sdk/google';
 import type { VercelExecutionToolsOptions } from '../vercel/VercelExecutionToolsOptions';
 /**
- * Options for `GoogleExecutionTools`
+ * Options for `createGoogleExecutionTools`
  *
  * This combines options for Promptbook, Google and Vercel together
  * @public exported from `@promptbook/google`

package/esm/typings/src/llm-providers/ollama/OllamaExecutionToolsOptions.d.ts

@@ -0,0 +1,23 @@
+import type { OpenAiExecutionToolsOptions } from '../openai/OpenAiExecutionToolsOptions';
+/**
+ * Default base URL for Ollama API
+ *
+ * @public exported from `@promptbook/ollama`
+ */
+export declare const DEFAULT_OLLAMA_BASE_URL = "http://localhost:11434";
+/**
+ * Options for `createOllamaExecutionTools`
+ *
+ * This combines options for Promptbook, Google and Vercel together
+ * @public exported from `@promptbook/ollama`
+ */
+export type OllamaExecutionToolsOptions = {
+    /**
+     * Base URL of Ollama API
+     *
+     * Note: Naming this `baseURL` not `baseUrl` to be consistent with OpenAI API
+     *
+     * @default `DEFAULT_OLLAMA_BASE_URL`
+     */
+    baseURL?: string;
+} & Omit<OpenAiExecutionToolsOptions, 'baseURL' | 'userId'>;

package/esm/typings/src/llm-providers/ollama/createOllamaExecutionTools.d.ts

@@ -0,0 +1,11 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { OllamaExecutionToolsOptions } from './OllamaExecutionToolsOptions';
+/**
+ * Execution Tools for calling Ollama API
+ *
+ * @public exported from `@promptbook/ollama`
+ */
+export declare const createOllamaExecutionTools: ((ollamaOptions: OllamaExecutionToolsOptions) => LlmExecutionTools) & {
+    packageName: string;
+    className: string;
+};

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

@@ -0,0 +1,6 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * 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/ollama/register-configuration.d.ts

@@ -0,0 +1,14 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OllamaMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/llm-providers/ollama/register-constructor.d.ts

@@ -0,0 +1,15 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/ollama`
+ * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OllamaRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -2,7 +2,7 @@ import type { ClientOptions } from 'openai';
 import type { string_token } from '../../types/typeAliases';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
- * Options for `OpenAiAssistantExecutionTools`
+ * Options for `createOpenAiAssistantExecutionTools` and `OpenAiAssistantExecutionTools`
  *
  * @public exported from `@promptbook/openai`
  */

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

@@ -40,7 +40,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     /**
      * List all available OpenAI models that can be used
      */
-    listModels(): ReadonlyArray<AvailableModel>;
+    listModels(): Promise<ReadonlyArray<AvailableModel>>;
     /**
      * Calls OpenAI API to use a chat model.
      */

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

@@ -1,7 +1,7 @@
 import type { ClientOptions } from 'openai';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 /**
- * Options for `OpenAiExecutionTools`
+ * Options for `createOpenAiExecutionTools` and `OpenAiExecutionTools`
  *
  * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
  * Rest is used by the `OpenAiExecutionTools`.

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

@@ -3,6 +3,8 @@ import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions'
 /**
  * Execution Tools for calling OpenAI API
  *
+ * Note: This can be also used for other OpenAI compatible APIs, like Ollama
+ *
  * @public exported from `@promptbook/openai`
  */
 export declare const createOpenAiExecutionTools: ((options: OpenAiExecutionToolsOptions) => OpenAiExecutionTools) & {

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

@@ -1,5 +1,4 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
-import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available OpenAI models with pricing
  *
@@ -9,12 +8,7 @@ import type { number_usd } from '../../types/typeAliases';
  * @see https://openai.com/api/pricing/
  * @public exported from `@promptbook/openai`
  */
-export declare const OPENAI_MODELS: ReadonlyArray<AvailableModel & {
-    pricing?: {
-        readonly prompt: number_usd;
-        readonly output: number_usd;
-    };
-}>;
+export declare const OPENAI_MODELS: ReadonlyArray<AvailableModel>;
 /**
  * Note: [🤖] Add models of new variant
  * TODO: [🧠] Some mechanism to propagate unsureness

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.93.0`).
+ * It follows semantic versioning (e.g., `0.94.0-2`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/editable",
-    "version": "0.94.0-0",
+    "version": "0.94.0-3",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -63,7 +63,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/editable.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.94.0-0"
+        "@promptbook/core": "0.94.0-3"
     },
     "dependencies": {
         "crypto-js": "4.2.0",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.94.0-0';
+    const PROMPTBOOK_ENGINE_VERSION = '0.94.0-3';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name