@promptbook/types 0.86.10 → 0.86.22

package/README.md

@@ -166,9 +166,7 @@ And **Promptbook.city** branded socials:
 _/Sub-brand for images and graphics generated via Promptbook prompting/_
 
 -   [Instagram `@promptbook.city`](https://www.instagram.com/promptbook.city/)
--   [Facebook `Promptbook City`](https://www.facebook.com/61565718625569) 
-
-## 
+-   [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
 
 
 
@@ -179,7 +177,9 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
 
 
 
-Following is the documentation and blueprint of 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.
 
 ### Example
 
@@ -187,35 +187,56 @@ Following is the documentation and blueprint of the Book language.
 # 🌟 My first Book
 
 -   BOOK VERSION 1.0.0
--   URL https://promptbook.studio/my-first-book/
+-   URL https://promptbook.studio/hello.book
+-   INPUT PARAMETER {topic}
+-   OUTPUT PARAMETER {article}
 
 # Write an article
 
 -   PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
--   KNOWLEDGE https://ptbk.io
--   KNOWLEDGE ./promptbook.pdf
+-   KNOWLEDGE https://wikipedia.org/
+-   KNOWLEDGE ./journalist-ethics.pdf
 -   EXPECT MIN 1 Sentence
--   EXPECT MAX 1 Paragraph
+-   EXPECT MAX 5 Pages
 
-> Write an article about the future of artificial intelligence in the next 10 years and how metalanguages will change the way AI is used in the world.
-> Look specifically at the impact of Promptbook on the AI industry.
+> Write an article about {topic}
 
 -> {article}
 ```
 
+Each part of the book defines one of 3 circles:
+
 ### **What:** Workflows, Tasks and Parameters
 
+What work needs to be done. Each book defines a workflow, which is one or more tasks. Each workflow has a fixed input and output. For example, you have a book that generates an article from a topic. Once it generates an article about AI, once about marketing, once about cooking. The workflow (= your AI program) is the same, only the input and output change.
+
+**Related commands:**
+
 -   [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
 
 ### **Who:** Personas
 
+Who does the work. Each task is performed by a persona. A persona is a description of your virtual employee. It is a higher abstraction than the model, tokens, temperature, top-k, top-p and other model parameters.
+
+You can describe what you want in human language like `Jane, creative writer with a sense of sharp humour` instead of `gpt-4-2024-13-31, temperature 1.2, top-k 40, STOP token ".\n",...`.
+
+Personas can have access to different knowledge, tools and actions. They can also consult their work with other personas or user, if allowed.
+
+**Related commands:**
+
 -   [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
 
+
+
 ### **How:** Knowledge, Instruments and Actions
 
--   [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md)
--   [INSTRUMENT](https://github.com/webgptorg/promptbook/blob/main/documents/commands/INSTRUMENT.md)
--   [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md)
+The resources used by the personas are used to do the work.
+
+**Related commands:**
+
+-   [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md) of documents, websites, and other resources
+-   [INSTRUMENT](https://github.com/webgptorg/promptbook/blob/main/documents/commands/INSTRUMENT.md) for real-time data like time, location, weather, stock prices, searching the internet, calculations, etc.
+-   [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md) for actions like sending emails, creating files, ending a workflow, etc.
 
 ### General principles of book language
 
@@ -306,35 +327,7 @@ The following glossary is used to clarify certain concepts:
 
 _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
-#### Promptbook core
-
--   **Organization** _(legacy name collection)_ group jobs, workforce, knowledge, instruments, and actions into one package. Entities in one organization can share resources (= import resources from each other).
-    -   **Jobs**
-        -   **Task**
-        -   **Subtask**
-    -   **Workforce**
-        -   **Persona**
-        -   **Team**
-        -   **Role**
-    -   **Knowledge**
-        -   **Public**
-        -   **Private**
-        -   **Protected**
-    -   **Instruments**
-    -   **Actions**
-
-#### Book language
-
--   **Book file**
-    -   **Section**
-        -   **Heading**
-        -   **Description**
-        -   **Command**
-        -   **Block**
-        -   **Return statement**
-    -   **Comment**
-    -   **Import**
-    -   **Scope**
+
 
 #### 💯 Core concepts
 

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

@@ -178,6 +178,7 @@ import type { string_css } from '../types/typeAliases';
 import type { string_svg } from '../types/typeAliases';
 import type { string_script } from '../types/typeAliases';
 import type { string_javascript } from '../types/typeAliases';
+import type { string_typescript } from '../types/typeAliases';
 import type { string_json } from '../types/typeAliases';
 import type { string_css_class } from '../types/typeAliases';
 import type { string_css_property } from '../types/typeAliases';
@@ -459,6 +460,7 @@ export type { string_css };
 export type { string_svg };
 export type { string_script };
 export type { string_javascript };
+export type { string_typescript };
 export type { string_json };
 export type { string_css_class };
 export type { string_css_property };

package/esm/typings/src/conversion/utils/extractVariablesFromScript.d.ts

@@ -1,14 +1,14 @@
 import type { string_javascript } from '../../types/typeAliases';
-import type { string_javascript_name } from '../../types/typeAliases';
+import type { string_typescript } from '../../types/typeAliases';
 /**
- * Parses the given script and returns the list of all used variables that are not defined in the script
+ * Extract all used variable names from ginen JavaScript/TypeScript script
  *
- * @param script from which to extract the variables
- * @returns the list of variable names
+ * @param script JavaScript/TypeScript script
+ * @returns Set of variable names
  * @throws {ParseError} if the script is invalid
  * @public exported from `@promptbook/utils` <- Note: [👖] This is usable elsewhere than in Promptbook, so keeping in utils
  */
-export declare function extractVariablesFromScript(script: string_javascript): Set<string_javascript_name>;
+export declare function extractVariablesFromScript(script: string_javascript | string_typescript): Set<string>;
 /**
  * TODO: [🔣] Support for multiple languages - python, java,...
  */

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

@@ -7,15 +7,15 @@ import type { ErrorJson } from '../errors/utils/ErrorJson';
  */
 export type AbstractTaskResult = {
     /**
-     * Whether the execution was successful, details are aviable in `executionReport`
+     * Whether the execution was successful, details are available in `executionReport`
      */
     readonly isSuccessful: boolean;
     /**
-     * Errors that occured during the execution, details are aviable in `executionReport`
+     * Errors that occured during the execution, details are available in `executionReport`
      */
     readonly errors: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
     /**
-     * Warnings that occured during the execution, details are aviable in `executionReport`
+     * Warnings that occured during the execution, details are available in `executionReport`
      */
     readonly warnings: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
 };

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

@@ -17,7 +17,7 @@ export type PipelineExecutorResult = AbstractTaskResult & {
      */
     readonly outputParameters: Readonly<Parameters>;
     /**
-     * Added usage of whole execution, detailed usage is aviable in `executionReport`
+     * Added usage of whole execution, detailed usage is available in `executionReport`
      */
     readonly usage: ReadonlyDeep<PromptResultUsage>;
     /**

package/esm/typings/src/execution/utils/usageToHuman.d.ts

@@ -1,11 +1,21 @@
 import type { string_markdown } from '../../types/typeAliases';
 import type { PromptResultUsage } from '../PromptResultUsage';
+import type { UncertainNumber } from '../UncertainNumber';
+/**
+ * Minimal usage information required to calculate worktime
+ */
+type PartialPromptResultUsage = Partial<PromptResultUsage> & {
+    price: UncertainNumber;
+    input: Pick<PromptResultUsage['input'], 'wordsCount'>;
+    output: Pick<PromptResultUsage['output'], 'wordsCount' | 'charactersCount'>;
+};
 /**
  * Function `usageToHuman` will take usage and convert it to human readable report
  *
  * @public exported from `@promptbook/core`
  */
-export declare function usageToHuman(usage: PromptResultUsage): string_markdown;
+export declare function usageToHuman(usage: PartialPromptResultUsage): string_markdown;
+export {};
 /**
  * TODO: [🍓][🧞‍♂️] Use "$1" not "1 USD"
  * TODO: [🍓][🧞‍♂️] Use markdown formatting like "Cost approximately **$1**"

package/esm/typings/src/execution/utils/usageToWorktime.d.ts

@@ -1,5 +1,12 @@
 import type { PromptResultUsage } from '../PromptResultUsage';
 import type { UncertainNumber } from '../UncertainNumber';
+/**
+ * Minimal usage information required to calculate worktime
+ */
+type PartialPromptResultUsage = Pick<PromptResultUsage, 'input' | 'output'> & {
+    input: Pick<PromptResultUsage['input'], 'wordsCount'>;
+    output: Pick<PromptResultUsage['output'], 'wordsCount'>;
+};
 /**
  * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
  *
@@ -9,4 +16,5 @@ import type { UncertainNumber } from '../UncertainNumber';
  *
  * @public exported from `@promptbook/core`
  */
-export declare function usageToWorktime(usage: PromptResultUsage): UncertainNumber;
+export declare function usageToWorktime(usage: PartialPromptResultUsage): UncertainNumber;
+export {};

package/esm/typings/src/formats/_common/FormatDefinition.d.ts

@@ -64,7 +64,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
  * TODO: [♏] Add some prepare hook to modify prompt according to the format
  * TODO: [🍓]`name` and `aliases` should be UPPERCASE only and interpreted as case-insensitive (via normalization)
  * TODO: [🍓][👨‍⚖️] Compute TPartialValue dynamically - PartialString<TValue>
- * TODO: [🍓][🧠] Should execution tools be aviable to heal, canBeValid and isValid?
+ * TODO: [🍓][🧠] Should execution tools be available to heal, canBeValid and isValid?
  * TODO: [🍓][🧠] llm Provider Bindings
  * TODO: [🍓][🔼] Export via some package
  */

package/esm/typings/src/formats/text/TextFormatDefinition.d.ts

@@ -10,7 +10,7 @@ import type { FormatDefinition } from '../_common/FormatDefinition';
 export declare const TextFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
 /**
  * TODO: [1] Make type for XML Text and Schema
- * TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages aviable as subvalues
+ * TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages available as subvalues
  * TODO: [🍓] In `TextFormatDefinition` implement simple `isValid`
  * TODO: [🍓] In `TextFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `TextFormatDefinition` implement `heal

package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts

@@ -57,7 +57,7 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
     callCommonModel(prompt: Prompt): Promise<PromptResult>;
 }
 /**
- * TODO: [🧠][🎛] Aggregating multiple models - have result not only from one first aviable model BUT all of them
+ * TODO: [🧠][🎛] Aggregating multiple models - have result not only from one first available model BUT all of them
  * TODO: [🏖] If no llmTools have for example not defined `callCompletionModel` this will still return object with defined `callCompletionModel` which just throws `PipelineExecutionError`, make it undefined instead
  *       Look how `countTotalUsage` (and `cacheLlmTools`) implements it
  */

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

@@ -272,6 +272,12 @@ export type string_script = string;
  * For example `console.info("Hello World!")`
  */
 export type string_javascript = string;
+/**
+ * Semantic helper
+ *
+ * For example `console.info("Hello World!" as string)`
+ */
+export type string_typescript = string;
 /**
  * Semantic helper for JSON strings
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.86.10",
+    "version": "0.86.22",
     "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.10"
+        "@promptbook/core": "0.86.22"
     }
 }