@promptbook/types 0.88.0-9 → 0.89.0-1

package/README.md

@@ -83,6 +83,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.
@@ -93,6 +95,9 @@ This shift is going to happen, whether we are ready for it or not. Our mission i
 
 
 
+
+
+
 ## 🚀 Get started
 
 Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
@@ -104,6 +109,8 @@ Take a look at the simple starter kit with books integrated into the **Hello Wor
 
 
 
+
+
 ## 💜 The Promptbook Project
 
 Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
@@ -139,22 +146,35 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
   </tbody>
 </table>
 
+Hello world examples:
+
+-   [Hello world](https://github.com/webgptorg/hello-world)
+-   [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
+-   [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
+
+
+
 We also have a community of developers and users of **Promptbook**:
 
 -   [Discord community](https://discord.gg/x3QWNaa89N)
 -   [Landing page `ptbk.io`](https://ptbk.io)
 -   [Github discussions](https://github.com/webgptorg/promptbook/discussions)
 -   [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
--   [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
+-   [Facebook `Promptbook`](https://www.facebook.com/61560776453536) 
 
 And **Promptbook.studio** branded socials:
 
+
+
 -   [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
 
 And **Promptujeme** sub-brand:
 
 _/Subbrand for Czech clients/_
 
+
+
+
 -   [Promptujeme.cz](https://www.promptujeme.cz/)
 -   [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
 
@@ -172,6 +192,8 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
 
 ## 💙 The Book language
 
+
+
 Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
 
 Book is a language that can be used to write AI applications, agents, workflows, automations, knowledgebases, translators, sheet processors, email automations and more. It allows you to harness the power of AI models in human-like terms, without the need to know the specifics and technicalities of the models.
@@ -221,6 +243,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)
 
+
+
 ### **How:** Knowledge, Instruments and Actions
 
 The resources used by the personas are used to do the work.
@@ -296,11 +320,9 @@ Or you can install them separately:
 
 ## 📚 Dictionary
 
-### 📚 Dictionary
-
 The following glossary is used to clarify certain concepts:
 
-#### General LLM / AI terms
+### General LLM / AI terms
 
 -   **Prompt drift** is a phenomenon where the AI model starts to generate outputs that are not aligned with the original prompt. This can happen due to the model's training data, the prompt's wording, or the model's architecture.
 -   **Pipeline, workflow or chain** is a sequence of tasks that are executed in a specific order. In the context of AI, a pipeline can refer to a sequence of AI models that are used to process data.
@@ -311,9 +333,13 @@ The following glossary is used to clarify certain concepts:
 -   **Retrieval-augmented generation** is a machine learning paradigm where a model generates text by retrieving relevant information from a large database of text. This approach combines the benefits of generative models and retrieval models.
 -   **Longtail** refers to non-common or rare events, items, or entities that are not well-represented in the training data of machine learning models. Longtail items are often challenging for models to predict accurately.
 
-_Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
-#### 💯 Core concepts
+
+_Note: This section is not 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)
 -   [📯 Pipeline](https://github.com/webgptorg/promptbook/discussions/64)
@@ -326,7 +352,7 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
 -   [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29)
 -   [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32)
 
-##### Advanced concepts
+#### Advanced concepts
 
 -   [📚 Knowledge (Retrieval-augmented generation)](https://github.com/webgptorg/promptbook/discussions/41)
 -   [🌏 Remote server](https://github.com/webgptorg/promptbook/discussions/89)
@@ -341,11 +367,6 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
 -   [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
 -   [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
 
-### Terms specific to Promptbook TypeScript implementation
-
--   Anonymous mode
--   Application mode
-
 
 
 ## 🚂 Promptbook Engine
@@ -416,11 +437,11 @@ See [TODO.md](./TODO.md)
 <div style="display: flex; align-items: center; gap: 20px;">
 
   <a href="https://promptbook.studio/">
-    <img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="100">
+    <img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="70">
   </a>
 
   <a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
-    <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="100">
+    <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="70">
   </a>
 
 </div>

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

@@ -87,7 +87,7 @@ import { $llmToolsMetadataRegister } from '../llm-providers/_common/register/$ll
 import { $llmToolsRegister } from '../llm-providers/_common/register/$llmToolsRegister';
 import { createLlmToolsFromConfiguration } from '../llm-providers/_common/register/createLlmToolsFromConfiguration';
 import { cacheLlmTools } from '../llm-providers/_common/utils/cache/cacheLlmTools';
-import { countTotalUsage } from '../llm-providers/_common/utils/count-total-usage/countTotalUsage';
+import { countUsage } from '../llm-providers/_common/utils/count-total-usage/countUsage';
 import { limitTotalUsage } from '../llm-providers/_common/utils/count-total-usage/limitTotalUsage';
 import { _AnthropicClaudeMetadataRegistration } from '../llm-providers/anthropic-claude/register-configuration';
 import { _AzureOpenAiMetadataRegistration } from '../llm-providers/azure-openai/register-configuration';
@@ -217,7 +217,7 @@ export { $llmToolsMetadataRegister };
 export { $llmToolsRegister };
 export { createLlmToolsFromConfiguration };
 export { cacheLlmTools };
-export { countTotalUsage };
+export { countUsage };
 export { limitTotalUsage };
 export { _AnthropicClaudeMetadataRegistration };
 export { _AzureOpenAiMetadataRegistration };

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

@@ -106,6 +106,11 @@ import type { ScriptTaskJson } from '../pipeline/PipelineJson/ScriptTaskJson';
 import type { SimpleTaskJson } from '../pipeline/PipelineJson/SimpleTaskJson';
 import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
 import type { PipelineString } from '../pipeline/PipelineString';
+import type { paths } from '../playground/brjapp-api-schema';
+import type { webhooks } from '../playground/brjapp-api-schema';
+import type { components } from '../playground/brjapp-api-schema';
+import type { $defs } from '../playground/brjapp-api-schema';
+import type { operations } from '../playground/brjapp-api-schema';
 import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
 import type { PromptbookServer_Identification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
 import type { PromptbookServer_ApplicationIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
@@ -389,6 +394,11 @@ export type { ScriptTaskJson };
 export type { SimpleTaskJson };
 export type { TaskJson };
 export type { PipelineString };
+export type { paths };
+export type { webhooks };
+export type { components };
+export type { $defs };
+export type { operations };
 export type { PrepareAndScrapeOptions };
 export type { PromptbookServer_Identification };
 export type { PromptbookServer_ApplicationIdentification };

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

@@ -162,7 +162,7 @@ export declare const DEFAULT_MAX_PARALLEL_COUNT = 5;
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_MAX_EXECUTION_ATTEMPTS = 3;
+export declare const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10;
 /**
  * @@@
  * TODO: [🐝][main] !!3 Use

package/esm/typings/src/errors/PipelineExecutionError.d.ts

@@ -1,3 +1,4 @@
+import type { task_id } from '../types/typeAliases';
 /**
  * This error indicates errors during the execution of the pipeline
  *
@@ -5,5 +6,9 @@
  */
 export declare class PipelineExecutionError extends Error {
     readonly name = "PipelineExecutionError";
+    readonly id?: task_id;
     constructor(message: string);
 }
+/**
+ * TODO: !!!!!! Add id to all errors
+ */

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

@@ -1,3 +1,4 @@
+import type { task_id } from '../../types/typeAliases';
 import type { ALL_ERRORS } from '../0-index';
 /**
  * Represents a serialized error or custom Promptbook error
@@ -5,6 +6,10 @@ import type { ALL_ERRORS } from '../0-index';
  * Note: [🚉] This is fully serializable as JSON
  */
 export type ErrorJson = {
+    /**
+     * The unique identifier of the error
+     */
+    readonly id?: task_id;
     /**
      * The type of the error
      */

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts

@@ -1,3 +1,4 @@
+import type { Observable } from 'rxjs';
 import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
 import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
 /**
@@ -8,6 +9,12 @@ export type LlmExecutionToolsWithTotalUsage = LlmExecutionTools & {
      * Get total cost of the execution up to this point
      */
     getTotalUsage(): PromptResultUsage;
+    /**
+     * Observable of total cost of the execution up to this point
+     *
+     * Note: This does report the cost of the last prompt, not the total cost of the execution up to this point
+     */
+    spending(): Observable<PromptResultUsage>;
 };
 /**
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/{countTotalUsage.d.ts → countUsage.d.ts}

@@ -7,7 +7,7 @@ import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTot
  * @returns LLM tools with same functionality with added total cost counting
  * @public exported from `@promptbook/core`
  */
-export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
+export declare function countUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
 /**
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
  * TODO: [🧠] Is there some meaningfull way how to test this util

package/esm/typings/src/playground/BrjappConnector.d.ts

@@ -0,0 +1,64 @@
+type BrjappOptions = {
+    /**
+     * Add user to these groups
+     */
+    readonly userGroups: Array<string>;
+    /**
+     * Add this amount of credits to new users
+     */
+    readonly initialCredits: number;
+};
+/**
+ * Note: Credit = 1 Word to generate or read
+ * Note: What we call here "user" is on BRJ.APP "customer"
+ *
+ * @private - this will be moved to Promptbook studio
+ */
+export declare class BrjappConnector {
+    private readonly apiKey;
+    private options;
+    private readonly client;
+    constructor(apiKey: string, options: BrjappOptions);
+    /**
+     * Login or register user
+     *
+     * TODO: [🧠] Probbably better name for this method
+     *
+     * @param options
+     * @returns user token or null if user needs to verify email
+     */
+    loginOrRegister(options: {
+        email: string;
+        password: string;
+        customerRealIp: string;
+    }): Promise<{
+        isSuccess: boolean;
+        message: string;
+        token: string | null;
+        isEmailVerificationRequired: boolean;
+    }>;
+    private addInitailCredits;
+    buyCredits(options: {
+        email: string;
+        customerRealIp: string;
+    }): Promise<{
+        isSuccess: boolean;
+        message: string;
+        payLink: string | null;
+    }>;
+    /**
+     *
+     * @returns true if credits were spent, false if not enough credits or another error
+     */
+    spendCredits(options: {
+        email: string;
+        token: string;
+        creditsAmount: number;
+        description: string;
+        customerRealIp: string;
+    }): Promise<{
+        isSuccess: boolean;
+        message: string;
+    }>;
+}
+export {};