@promptbook/types 0.95.0 → 0.98.0-3

package/README.md

@@ -25,6 +25,10 @@ Write AI applications using plain human language across multiple models and plat
 
 
 
+<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).
@@ -81,6 +85,8 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 During the computer revolution, we have seen [multiple generations of computer languages](https://github.com/webgptorg/promptbook/discussions/180), from the physical rewiring of the vacuum tubes through low-level machine code to the high-level languages like Python or JavaScript. And now, we're on the edge of the **next revolution**!
 
+
+
 It's a revolution of writing software in **plain human language** that is understandable and executable by both humans and machines – and it's going to change everything!
 
 The incredible growth in power of microprocessors and the Moore's Law have been the driving force behind the ever-more powerful languages, and it's been an amazing journey! Similarly, the large language models (like GPT or Claude) are the next big thing in language technology, and they're set to transform the way we interact with computers.
@@ -206,6 +212,8 @@ Join our growing community of developers and users:
 
 _A concise, Markdown-based DSL for crafting AI workflows and automations._
 
+
+
 ### Introduction
 
 Book is a Markdown-based language that simplifies the creation of AI applications, workflows, and automations. With human-readable commands, you can define inputs, outputs, personas, knowledge sources, and actions—without needing model-specific details.
@@ -255,6 +263,8 @@ Personas can have access to different knowledge, tools and actions. They can als
 
 -   [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
 
+
+
 ### **3. How:** Knowledge, Instruments and Actions
 
 The resources used by the personas are used to do the work.
@@ -354,6 +364,8 @@ The following glossary is used to clarify certain concepts:
 
 _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
+
+
 ### 💯 Core concepts
 
 -   [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)

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

@@ -12,6 +12,7 @@ import { _OllamaMetadataRegistration } from '../llm-providers/ollama/register-co
 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 { _OpenAiCompatibleMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
 import { _OpenAiAssistantRegistration } from '../llm-providers/openai/register-constructor';
 import { _BoilerplateScraperRegistration } from '../scrapers/_boilerplate/register-constructor';
@@ -42,6 +43,7 @@ export { _OllamaMetadataRegistration };
 export { _OllamaRegistration };
 export { _OpenAiMetadataRegistration };
 export { _OpenAiAssistantMetadataRegistration };
+export { _OpenAiCompatibleMetadataRegistration };
 export { _OpenAiRegistration };
 export { _OpenAiAssistantRegistration };
 export { _BoilerplateScraperRegistration };

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

@@ -111,6 +111,7 @@ import { _GoogleMetadataRegistration } from '../llm-providers/google/register-co
 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 { _OpenAiCompatibleMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { migratePipeline } from '../migrations/migratePipeline';
 import { preparePersona } from '../personas/preparePersona';
 import { book } from '../pipeline/book-notation';
@@ -259,6 +260,7 @@ export { _GoogleMetadataRegistration };
 export { _OllamaMetadataRegistration };
 export { _OpenAiMetadataRegistration };
 export { _OpenAiAssistantMetadataRegistration };
+export { _OpenAiCompatibleMetadataRegistration };
 export { migratePipeline };
 export { preparePersona };
 export { book };

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

@@ -1,21 +1,25 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { createOpenAiAssistantExecutionTools } from '../llm-providers/openai/createOpenAiAssistantExecutionTools';
+import { createOpenAiCompatibleExecutionTools } from '../llm-providers/openai/createOpenAiCompatibleExecutionTools';
 import { createOpenAiExecutionTools } from '../llm-providers/openai/createOpenAiExecutionTools';
 import { OPENAI_MODELS } from '../llm-providers/openai/openai-models';
 import { OpenAiAssistantExecutionTools } from '../llm-providers/openai/OpenAiAssistantExecutionTools';
 import type { OpenAiAssistantExecutionToolsOptions } from '../llm-providers/openai/OpenAiAssistantExecutionToolsOptions';
 import { OpenAiCompatibleExecutionTools } from '../llm-providers/openai/OpenAiCompatibleExecutionTools';
+import type { OpenAiCompatibleExecutionToolsOptions } from '../llm-providers/openai/OpenAiCompatibleExecutionToolsOptions';
 import { OpenAiExecutionTools } from '../llm-providers/openai/OpenAiExecutionTools';
 import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
 import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
 import { _OpenAiAssistantRegistration } from '../llm-providers/openai/register-constructor';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createOpenAiAssistantExecutionTools };
+export { createOpenAiCompatibleExecutionTools };
 export { createOpenAiExecutionTools };
 export { OPENAI_MODELS };
 export { OpenAiAssistantExecutionTools };
 export type { OpenAiAssistantExecutionToolsOptions };
 export { OpenAiCompatibleExecutionTools };
+export type { OpenAiCompatibleExecutionToolsOptions };
 export { OpenAiExecutionTools };
 export type { OpenAiExecutionToolsOptions };
 export { _OpenAiRegistration };

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

@@ -81,6 +81,7 @@ import type { DeepseekExecutionToolsOptions } from '../llm-providers/deepseek/De
 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 { OpenAiCompatibleExecutionToolsOptions } from '../llm-providers/openai/OpenAiCompatibleExecutionToolsOptions';
 import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
 import type { VercelExecutionToolsOptions } from '../llm-providers/vercel/VercelExecutionToolsOptions';
 import type { VercelProvider } from '../llm-providers/vercel/VercelProvider';
@@ -380,6 +381,7 @@ export type { DeepseekExecutionToolsOptions };
 export type { GoogleExecutionToolsOptions };
 export type { OllamaExecutionToolsOptions };
 export type { OpenAiAssistantExecutionToolsOptions };
+export type { OpenAiCompatibleExecutionToolsOptions };
 export type { OpenAiExecutionToolsOptions };
 export type { VercelExecutionToolsOptions };
 export type { VercelProvider };

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

@@ -11,6 +11,7 @@ import { _OllamaMetadataRegistration } from '../llm-providers/ollama/register-co
 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 { _OpenAiCompatibleMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
 import { _OpenAiAssistantRegistration } from '../llm-providers/openai/register-constructor';
 import { _BoilerplateScraperRegistration } from '../scrapers/_boilerplate/register-constructor';
@@ -41,6 +42,7 @@ export { _OllamaMetadataRegistration };
 export { _OllamaRegistration };
 export { _OpenAiMetadataRegistration };
 export { _OpenAiAssistantMetadataRegistration };
+export { _OpenAiCompatibleMetadataRegistration };
 export { _OpenAiRegistration };
 export { _OpenAiAssistantRegistration };
 export { _BoilerplateScraperRegistration };

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

@@ -1,12 +1,12 @@
 import type { ClientOptions } from 'openai';
 import type { string_token } from '../../types/typeAliases';
-import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
+import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
 /**
  * Options for `createOpenAiAssistantExecutionTools` and `OpenAiAssistantExecutionTools`
  *
  * @public exported from `@promptbook/openai`
  */
-export type OpenAiAssistantExecutionToolsOptions = OpenAiExecutionToolsOptions & ClientOptions & {
+export type OpenAiAssistantExecutionToolsOptions = OpenAiCompatibleExecutionToolsOptions & ClientOptions & {
     /**
      * Which assistant to use
      */

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

@@ -11,14 +11,14 @@ import type { string_markdown_text } from '../../types/typeAliases';
 import type { string_model_name } from '../../types/typeAliases';
 import type { string_title } from '../../types/typeAliases';
 import { computeOpenAiUsage } from './computeOpenAiUsage';
-import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
+import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
 /**
  * Execution Tools for calling OpenAI API or other OpeenAI compatible provider
  *
  * @public exported from `@promptbook/openai`
  */
 export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecutionTools {
-    protected readonly options: OpenAiExecutionToolsOptions;
+    protected readonly options: OpenAiCompatibleExecutionToolsOptions;
     /**
      * OpenAI API client.
      */
@@ -32,7 +32,7 @@ export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecu
      *
      * @param options which are relevant are directly passed to the OpenAI compatible client
      */
-    constructor(options: OpenAiExecutionToolsOptions);
+    constructor(options: OpenAiCompatibleExecutionToolsOptions);
     abstract get title(): string_title & string_markdown_text;
     abstract get description(): string_markdown;
     getClient(): Promise<OpenAI>;

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

@@ -0,0 +1,11 @@
+import type { ClientOptions } from 'openai';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+/**
+ * Options for `createOpenAiCompatibleExecutionTools` and `OpenAiCompatibleExecutionTools`
+ *
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
+ * Rest is used by the `OpenAiCompatibleExecutionTools`.
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export type OpenAiCompatibleExecutionToolsOptions = CommonToolsOptions & ClientOptions;

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

@@ -1,11 +1,9 @@
-import type { ClientOptions } from 'openai';
-import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
 /**
  * Options for `createOpenAiExecutionTools` and `OpenAiExecutionTools`
  *
- * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
- * Rest is used by the `OpenAiExecutionTools`.
+ * This extends OpenAiCompatibleExecutionToolsOptions.
  *
  * @public exported from `@promptbook/openai`
  */
-export type OpenAiExecutionToolsOptions = CommonToolsOptions & ClientOptions;
+export type OpenAiExecutionToolsOptions = OpenAiCompatibleExecutionToolsOptions;

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

@@ -0,0 +1,17 @@
+import { OpenAiCompatibleExecutionTools } from './OpenAiCompatibleExecutionTools';
+import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
+/**
+ * Execution Tools for calling OpenAI compatible API
+ *
+ * Note: This can be used for any OpenAI compatible APIs
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare const createOpenAiCompatibleExecutionTools: ((options: OpenAiCompatibleExecutionToolsOptions) => OpenAiCompatibleExecutionTools) & {
+    packageName: string;
+    className: string;
+};
+/**
+ * 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/openai/register-configuration.d.ts

@@ -19,6 +19,17 @@ export declare const _OpenAiMetadataRegistration: Registration;
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiAssistantMetadataRegistration: Registration;
+/**
+ * Registration of the OpenAI Compatible metadata
+ *
+ * Note: OpenAiCompatibleExecutionTools is an abstract class and cannot be instantiated directly.
+ * It serves as a base class for OpenAiExecutionTools and other compatible implementations.
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiCompatibleMetadataRegistration: Registration;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -19,6 +19,10 @@ export declare const _OpenAiRegistration: Registration;
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiAssistantRegistration: Registration;
+/**
+ * Note: OpenAiCompatibleExecutionTools is an abstract class and cannot be registered directly.
+ * It serves as a base class for OpenAiExecutionTools and other compatible implementations.
+ */
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  * Note: [💞] Ignore a discrepancy between file name and entity name

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.94.0`).
+ * It follows semantic versioning (e.g., `0.98.0-2`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.95.0",
+    "version": "0.98.0-3",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -72,6 +72,6 @@
     },
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.95.0"
+        "@promptbook/core": "0.98.0-3"
     }
 }