@promptbook/types 0.86.0-6 → 0.86.5

package/README.md

@@ -5,8 +5,8 @@
 
 
 
-[![NPM Version of ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook](https://badge.fury.io/js/promptbook.svg)](https://www.npmjs.com/package/promptbook)
-[![Quality of package ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook](https://packagequality.com/shield/promptbook.svg)](https://packagequality.com/#?package=promptbook)
+[![NPM Version of ![Promptbook logo - cube with letters P and B](./design/logo-h1.png) Promptbook](https://badge.fury.io/js/promptbook.svg)](https://www.npmjs.com/package/promptbook)
+[![Quality of package ![Promptbook logo - cube with letters P and B](./design/logo-h1.png) Promptbook](https://packagequality.com/shield/promptbook.svg)](https://packagequality.com/#?package=promptbook)
 [![Known Vulnerabilities](https://snyk.io/test/github/webgptorg/promptbook/badge.svg)](https://snyk.io/test/github/webgptorg/promptbook)
 [![Issues](https://img.shields.io/github/issues/webgptorg/promptbook.svg?style=flat)](https://github.com/webgptorg/promptbook/issues)
 
@@ -17,18 +17,12 @@
 ## 🌟 New Features
 
 -   📂 We have plugin for [VSCode](https://github.com/webgptorg/book-extension) to support `.book` file extension
+-   🐳 Available [Docker image](https://hub.docker.com/r/hejny/promptbook/)
 -   💫 Support of [`o3-mini` model by OpenAI](https://openai.com/index/openai-o3-mini/)
 -   🐋 **Support of [DeepSeek models](https://www.npmjs.com/package/@promptbook/deepseek)**
--   💙 Working [the **Book** language v1.0.0](https://github.com/webgptorg/book)
--   🖤 Run books from CLI - `npx ptbk run path/to/your/book`
--   📚 Support of `.docx`, `.doc` and `.pdf` documents as knowledge
 
 
 
-<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).
@@ -85,6 +79,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.
@@ -142,34 +138,41 @@ We also have a community of developers and users of **Promptbook**:
 -   [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/_
+*/Subbrand for Czech clients/*
+
+
 
 -   [Promptujeme.cz](https://www.promptujeme.cz/)
 -   [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
 
+
 And **Promptbook.city** branded socials:
 
-_/Sub-brand for images and graphics generated via Promptbook prompting/_
+*/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) 
 
 
 
-## 💙 Book language _(for prompt-engineer)_
 
 
 
+## 💙 The Book language
+
 
-## 💙 The blueprint of book language
 
 Following is the documentation and blueprint of the Book language.
 
@@ -178,6 +181,11 @@ Following is the documentation and blueprint of the Book language.
 ```markdown
 # 🌟 My first Book
 
+-   BOOK VERSION 1.0.0
+-   URL https://promptbook.studio/my-first-book/
+
+# 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
@@ -190,59 +198,31 @@ Following is the documentation and blueprint of the Book language.
 -> {article}
 ```
 
-### Goals and principles of book language
-
-File is designed to be easy to read and write. It is strict subset of markdown. It is designed to be understandable by both humans and machines and without specific knowledge of the language.
-
-It has file with `.book.md` or `.book` extension with `UTF-8` non BOM encoding.
-
-As it is source code, it can leverage all the features of version control systems like git and does not suffer from the problems of binary formats, proprietary formats, or no-code solutions.
-
-But unlike programming languages, it is designed to be understandable by non-programmers and non-technical people.
-
-### Structure
-
-Book is divided into sections. Each section starts with heading. The language itself is not sensitive to the type of heading _(`h1`, `h2`, `h3`, ...)_ but it is recommended to use `h1` for header section and `h2` for other sections.
-
-### Header
-
-Header is the first section of the book. It contains metadata about the pipeline. It is recommended to use `h1` heading for header section but it is not required.
-
-### Parameter
+### **What:** Workflows, Tasks and Parameters
 
-Foo bar
+-   [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
 
-#### Parameter names
+### **Who:** Personas
 
-Reserved words:
+-   [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
 
--   _each command_ like `PERSONA`, `EXPECT`, `KNOWLEDGE`, etc.
--   `content`
--   `context`
--   `knowledge`
--   `examples`
--   `modelName`
--   `currentDate`
+### **How:** Knowledge, Instruments and Actions
 
-#### Parameter notation
+-   [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)
 
-### Task
+### General principles of book language
 
-### Task type
+Book language is based on markdown. It is subset of markdown. It is designed to be easy to read and write. It is designed to be understandable by both humans and machines and without specific knowledge of the language.
 
-Todo todo
+The file has `.book` extension. It uses `UTF-8` non BOM encoding.
 
-### Command
+Book has two variants: flat - which is just a prompt with no structure, and full - which has a structure with tasks, commands and prompts.
 
-Todo todo
-
-### Block
-
-Todo todo
-
-### Return parameter
+As it is source code, it can leverage all the features of version control systems like git and does not suffer from the problems of binary formats, proprietary formats, or no-code solutions.
 
-### Examples
+But unlike programming languages, it is designed to be understandable by non-programmers and non-technical people.
 
 
 
@@ -288,6 +268,7 @@ Or you can install them separately:
 -   **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Usefull templates and examples of books which can be used as a starting point
 -   **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
 -   ⭐ **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
+-   🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
 
 
 
@@ -296,6 +277,11 @@ Or you can install them separately:
 
 ## 📚 Dictionary
 
+
+
+
+
+
 ### 📚 Dictionary
 
 The following glossary is used to clarify certain concepts:
@@ -311,6 +297,8 @@ 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_
 
 #### Promptbook core
@@ -371,6 +359,8 @@ _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
@@ -450,7 +440,7 @@ See [TODO.md](./TODO.md)
 <div style="display: flex; align-items: center; gap: 20px;">
 
   <a href="https://promptbook.studio/">
-    <img src="./other/design/promptbook-studio-logo.png" alt="Partner 3" height="100">
+    <img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="100">
   </a>
 
   <a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">

package/esm/typings/src/cli/test/ptbk2.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+/**
+ * Note: [🔺] Purpose of this file is to test the CLI in development environment
+ */
+export {};

package/esm/typings/src/conversion/compilePipeline.d.ts

@@ -13,7 +13,7 @@ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions
  * @param pipelineString {Promptbook} in string markdown format (.book.md)
  * @param tools - Tools for the preparation and scraping - if not provided together with `llm`, the preparation will be skipped
  * @param options - Options and tools for the compilation
- * @returns {Promptbook} compiled in JSON format (.book.json)
+ * @returns {Promptbook} compiled in JSON format (.bookc)
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts

@@ -11,7 +11,7 @@ import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOpt
  *
  * @param pipelineString {Promptbook} in string markdown format (.book.md)
  * @param options - Configuration of the remote server
- * @returns {Promptbook} compiled in JSON format (.book.json)
+ * @returns {Promptbook} compiled in JSON format (.bookc)
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/remote-client`
  */

package/esm/typings/src/conversion/parsePipeline.d.ts

@@ -12,7 +12,7 @@ import type { PipelineString } from '../pipeline/PipelineString';
  * Note: This function acts as compilation process
  *
  * @param pipelineString {Promptbook} in string markdown format (.book.md)
- * @returns {Promptbook} compiled in JSON format (.book.json)
+ * @returns {Promptbook} compiled in JSON format (.bookc)
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/conversion/pipelineJsonToString.d.ts

@@ -4,7 +4,7 @@ import type { PipelineString } from '../pipeline/PipelineString';
  * Converts promptbook in JSON format to string format
  *
  * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
- * @param pipelineJson Promptbook in JSON format (.book.json)
+ * @param pipelineJson Promptbook in JSON format (.bookc)
  * @returns Promptbook in string format (.book.md)
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/conversion/validation/_importPipeline.d.ts

@@ -2,7 +2,7 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { PipelineString } from '../../pipeline/PipelineString';
 import type { string_json } from '../../types/typeAliases';
 /**
- * Import the pipeline.book or pipeline.book.json file
+ * Import the pipeline.book or pipeline.bookc file
  *
  * Note: Using here custom import to work in jest tests
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
@@ -11,19 +11,19 @@ import type { string_json } from '../../types/typeAliases';
  * @private internal function of tests
  */
 export declare function importPipelineWithoutPreparation(path: `${string}.book`): PipelineString;
-export declare function importPipelineWithoutPreparation(path: `${string}.book.json`): PipelineJson;
+export declare function importPipelineWithoutPreparation(path: `${string}.bookc`): PipelineJson;
 /**
- * Import the pipeline.book.json file as parsed JSON
+ * Import the pipeline.bookc file as parsed JSON
  *
  * @private internal function of tests
  */
-export declare function importPipelineJson(path: `${string}.book.json`): PipelineJson;
+export declare function importPipelineJson(path: `${string}.bookc`): PipelineJson;
 /**
- * Import the pipeline.book.json file as string
+ * Import the pipeline.bookc file as string
  *
  * @private internal function of tests
  */
-export declare function importPipelineJsonAsString(path: `${string}.book.json`): string_json<PipelineJson>;
+export declare function importPipelineJsonAsString(path: `${string}.bookc`): string_json<PipelineJson>;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [⚫] Code in this file should never be published in any package

package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts

@@ -18,5 +18,5 @@ export type PreparationJson = {
 /**
  * TODO: [🍙] Make some standard order of json properties
  * TODO: Maybe put here used `modelName`
- * TODO: [🍥] When using `date` it changes all examples .book.json files each time so until some more elegant solution omit the time from prepared pipeline
+ * TODO: [🍥] When using `date` it changes all examples .bookc files each time so until some more elegant solution omit the time from prepared pipeline
  */

package/package.json

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