@promptbook/node 0.112.0-46 → 0.112.0-48
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -16
- package/esm/index.es.js +338 -78
- package/esm/index.es.js.map +1 -1
- package/esm/src/avatars/AvatarOrImage.d.ts +49 -0
- package/esm/src/avatars/avatarInteractionUtils.d.ts +81 -0
- package/esm/src/avatars/avatarInteractionUtils.test.d.ts +1 -0
- package/esm/src/avatars/avatarPointerTracking.d.ts +17 -0
- package/esm/src/avatars/avatarRenderingUtils.d.ts +3 -2
- package/esm/src/avatars/avatarRenderingUtils.test.d.ts +1 -0
- package/esm/src/avatars/index.d.ts +2 -1
- package/esm/src/avatars/types/AvatarVisualDefinition.d.ts +41 -1
- package/esm/src/avatars/visuals/asciiOctopusAvatarVisual.d.ts +7 -0
- package/esm/src/avatars/visuals/octopus3AvatarVisual.d.ts +7 -0
- package/esm/src/avatars/visuals/octopusAvatarVisualShared.d.ts +159 -0
- package/esm/src/avatars/visuals/octopusAvatarVisualShared.test.d.ts +1 -0
- package/esm/src/book-components/Chat/Chat/ChatMessageItem.d.ts +1 -1
- package/esm/src/book-components/Chat/Chat/ChatMessageList.d.ts +1 -1
- package/esm/src/book-components/Chat/Chat/ChatProps.d.ts +1 -1
- package/esm/src/book-components/Chat/Chat/ChatToolCallModalComponents.d.ts +8 -2
- package/esm/src/book-components/Chat/Chat/TeamToolCallModalContent.test.d.ts +2 -0
- package/esm/src/book-components/Chat/hooks/useChatCompleteNotification.d.ts +2 -0
- package/esm/src/book-components/Chat/types/ChatParticipant.d.ts +10 -0
- package/esm/src/cli/cli-commands/coder/ensureCoderGitignoreFile.d.ts +1 -1
- package/esm/src/commitments/USE/USE.d.ts +1 -0
- package/esm/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts +1 -1
- package/esm/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.d.ts +47 -0
- package/esm/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.test.d.ts +1 -0
- package/esm/src/commitments/_common/createSerpSearchToolFunction.d.ts +12 -0
- package/esm/src/commitments/index.d.ts +2 -1
- package/esm/src/config.d.ts +2 -2
- package/esm/src/llm-providers/agent/RemoteAgent.d.ts +3 -0
- package/esm/src/llm-providers/openai/OpenAiAgentKitExecutionTools.test.d.ts +1 -0
- package/esm/src/utils/agents/resolveAgentAvatarImageUrl.d.ts +49 -5
- package/esm/src/utils/agents/resolveAgentAvatarImageUrl.test.d.ts +1 -0
- package/esm/src/version.d.ts +1 -1
- package/package.json +3 -3
- package/umd/index.umd.js +337 -77
- package/umd/index.umd.js.map +1 -1
- package/umd/src/avatars/AvatarOrImage.d.ts +49 -0
- package/umd/src/avatars/avatarInteractionUtils.d.ts +81 -0
- package/umd/src/avatars/avatarInteractionUtils.test.d.ts +1 -0
- package/umd/src/avatars/avatarPointerTracking.d.ts +17 -0
- package/umd/src/avatars/avatarRenderingUtils.d.ts +3 -2
- package/umd/src/avatars/avatarRenderingUtils.test.d.ts +1 -0
- package/umd/src/avatars/index.d.ts +2 -1
- package/umd/src/avatars/types/AvatarVisualDefinition.d.ts +41 -1
- package/umd/src/avatars/visuals/asciiOctopusAvatarVisual.d.ts +7 -0
- package/umd/src/avatars/visuals/octopus3AvatarVisual.d.ts +7 -0
- package/umd/src/avatars/visuals/octopusAvatarVisualShared.d.ts +159 -0
- package/umd/src/avatars/visuals/octopusAvatarVisualShared.test.d.ts +1 -0
- package/umd/src/book-components/Chat/Chat/ChatMessageItem.d.ts +1 -1
- package/umd/src/book-components/Chat/Chat/ChatMessageList.d.ts +1 -1
- package/umd/src/book-components/Chat/Chat/ChatProps.d.ts +1 -1
- package/umd/src/book-components/Chat/Chat/ChatToolCallModalComponents.d.ts +8 -2
- package/umd/src/book-components/Chat/Chat/TeamToolCallModalContent.test.d.ts +2 -0
- package/umd/src/book-components/Chat/hooks/useChatCompleteNotification.d.ts +2 -0
- package/umd/src/book-components/Chat/types/ChatParticipant.d.ts +10 -0
- package/umd/src/cli/cli-commands/coder/ensureCoderGitignoreFile.d.ts +1 -1
- package/umd/src/commitments/USE/USE.d.ts +1 -0
- package/umd/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts +1 -1
- package/umd/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.d.ts +47 -0
- package/umd/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.test.d.ts +1 -0
- package/umd/src/commitments/_common/createSerpSearchToolFunction.d.ts +12 -0
- package/umd/src/commitments/index.d.ts +2 -1
- package/umd/src/config.d.ts +2 -2
- package/umd/src/llm-providers/agent/RemoteAgent.d.ts +3 -0
- package/umd/src/llm-providers/openai/OpenAiAgentKitExecutionTools.test.d.ts +1 -0
- package/umd/src/utils/agents/resolveAgentAvatarImageUrl.d.ts +49 -5
- package/umd/src/utils/agents/resolveAgentAvatarImageUrl.test.d.ts +1 -0
- package/umd/src/version.d.ts +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
<!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
|
|
2
2
|
|
|
3
|
-
#
|
|
3
|
+
# 🐙 Promptbook: Invisible AI Agents
|
|
4
4
|
|
|
5
|
-
Create persistent AI agents that turn your company's scattered knowledge into action
|
|
5
|
+
Create persistent AI agents that turn your company's scattered knowledge into action - powered by the [Agents Server](https://gallery.ptbk.io/)
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
@@ -118,13 +118,13 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
|
|
|
118
118
|
|
|
119
119
|
## 📖 The Book Whitepaper
|
|
120
120
|
|
|
121
|
-
Promptbook lets you create **persistent AI agents** that work on real goals for your company. The [**Agents Server**](https://gallery.ptbk.io/) is the heart of the project
|
|
121
|
+
Promptbook lets you create **persistent AI agents** that work on real goals for your company. The [**Agents Server**](https://gallery.ptbk.io/) is the heart of the project - a place where your AI agents live, remember context, collaborate in teams, and get things done.
|
|
122
122
|
|
|
123
123
|
Nowadays, the biggest challenge for most business applications isn't the raw capabilities of AI models. Large language models such as GPT-5.2 and Claude-4.5 are incredibly capable.
|
|
124
124
|
|
|
125
125
|
The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
|
|
126
126
|
|
|
127
|
-
In Promptbook, you define your agents **using simple Books**
|
|
127
|
+
In Promptbook, you define your agents **using simple Books** - a human-readable language that is explicit, easy to understand and write, reliable, and highly portable. You then deploy them to the **Agents Server**, where they run persistently and work toward their goals.
|
|
128
128
|
|
|
129
129
|
<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
|
|
130
130
|
|
|
@@ -225,7 +225,7 @@ Your job is to provide legal advice and support to the company and its employees
|
|
|
225
225
|
|
|
226
226
|
#### `Use` commitments
|
|
227
227
|
|
|
228
|
-
Use commitments grant the agent real capabilities
|
|
228
|
+
Use commitments grant the agent real capabilities - tools it can use to interact with the outside world. `USE EMAIL` lets the agent send emails, `USE BROWSER` lets it access and read web content, `USE SEARCH ENGINE` lets it search the web, and many more.
|
|
229
229
|
|
|
230
230
|
These are what turn a chatbot into a persistent agent that actually does work.
|
|
231
231
|
|
|
@@ -274,7 +274,7 @@ Your job is to provide legal advice and support to the company and its employees
|
|
|
274
274
|
|
|
275
275
|
### Promptbook Ecosystem
|
|
276
276
|
|
|
277
|
-
Promptbook is an ecosystem of tools centered around the **Agents Server**
|
|
277
|
+
Promptbook is an ecosystem of tools centered around the **Agents Server** - a production-ready platform for running persistent AI agents.
|
|
278
278
|
|
|
279
279
|
#### Agents Server
|
|
280
280
|
|
|
@@ -296,7 +296,7 @@ The [Promptbook Engine](https://github.com/webgptorg/promptbook) is the open-sou
|
|
|
296
296
|
|
|
297
297
|
## 💜 The Promptbook Project
|
|
298
298
|
|
|
299
|
-
Promptbook project is an ecosystem centered around the **Agents Server**
|
|
299
|
+
Promptbook project is an ecosystem centered around the **Agents Server** - a platform for creating, deploying, and running persistent AI agents. Following is a list of the most important pieces of the project:
|
|
300
300
|
|
|
301
301
|
<table>
|
|
302
302
|
<thead>
|
|
@@ -309,7 +309,7 @@ Promptbook project is an ecosystem centered around the **Agents Server** — a p
|
|
|
309
309
|
<tr>
|
|
310
310
|
<td><a href="https://gallery.ptbk.io/"><strong>⭐ Agents Server</strong></a></td>
|
|
311
311
|
<td>
|
|
312
|
-
The primary way to use Promptbook. A production-ready platform where your AI agents live
|
|
312
|
+
The primary way to use Promptbook. A production-ready platform where your AI agents live - create, manage, deploy, and interact with persistent agents that work on goals. Available as a hosted service or <a href="https://hub.docker.com/r/hejny/promptbook/">self-hosted via Docker</a>.
|
|
313
313
|
</td>
|
|
314
314
|
</tr>
|
|
315
315
|
<tr>
|
|
@@ -399,8 +399,8 @@ For information on reporting security vulnerabilities, see our [Security Policy]
|
|
|
399
399
|
|
|
400
400
|
The fastest way to get started is with the **Agents Server**:
|
|
401
401
|
|
|
402
|
-
- 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)**
|
|
403
|
-
- ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)**
|
|
402
|
+
- 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Self-host the Agents Server with full control over your data
|
|
403
|
+
- ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)** - Start creating agents immediately, no setup required
|
|
404
404
|
|
|
405
405
|
### NPM Packages _(for developers embedding the Engine)_
|
|
406
406
|
|
|
@@ -545,7 +545,7 @@ npx ptbk coder verify
|
|
|
545
545
|
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------ | ---- | ----- | ------------------------------------------------------------------------ |
|
|
546
546
|
| `ptbk coder init` | Creates `prompts/`, `prompts/done/`, the project-generic template files materialized in `prompts/templates/` (currently `common.md`), and a starter `AGENTS.md`; ensures `.env` contains `CODING_AGENT_GIT_NAME`, `CODING_AGENT_GIT_EMAIL`, and `CODING_AGENT_GIT_SIGNING_KEY`; adds helper coder scripts to `package.json`; ensures `.gitignore` contains `/.tmp`; and configures `.vscode/settings.json` to save pasted prompt images into `prompts/screenshots/`. |
|
|
547
547
|
| `ptbk coder generate-boilerplates` | Creates new prompt markdown files with fresh emoji tags so you can quickly fill in coding tasks; `--template` accepts either a built-in alias or a markdown file path relative to the project root. |
|
|
548
|
-
| `ptbk coder run` | Picks the next ready prompt, appends optional context, runs it through the selected coding agent, can optionally verify each attempt with a shell test command and feed failing output back for retries, then marks success or failure, commits the result, and pushes only when `--auto-push` is enabled.
|
|
548
|
+
| `ptbk coder run` | Picks the next ready prompt, appends optional context, runs it through the selected coding agent, can optionally verify each attempt with a shell test command and feed failing output back for retries, then marks success or failure, commits the result, and pushes only when `--auto-push` is enabled. |
|
|
549
549
|
| `ptbk coder find-refactor-candidates` | Scans the repository for oversized or overpacked files and writes prompt files for likely refactors; `--level <xlow | low | medium | high | xhigh | extreme>` ranges from a very benevolent scan to a very aggressive sweep. |
|
|
550
550
|
| `ptbk coder verify` | Walks through completed prompts, archives truly finished work, and adds follow-up repair prompts for unfinished results. |
|
|
551
551
|
|
|
@@ -556,7 +556,7 @@ npx ptbk coder verify
|
|
|
556
556
|
| `--agent <name>` | Selects the coding backend. |
|
|
557
557
|
| `--model <model>` | Chooses the runner model; required for `openai-codex` and `gemini`, optional for `github-copilot`. |
|
|
558
558
|
| `--context <text-or-file>` | Appends extra instructions inline or from a file like `AGENTS.md`. |
|
|
559
|
-
| `--test <command>` | Runs a verification command after each prompt attempt and feeds failing output back for retries.
|
|
559
|
+
| `--test <command>` | Runs a verification command after each prompt attempt and feeds failing output back for retries. |
|
|
560
560
|
| `--thinking-level <level>` | Sets reasoning effort for supported runners. |
|
|
561
561
|
| `--no-wait` | Skips interactive pauses between prompts for unattended execution. |
|
|
562
562
|
| `--ignore-git-changes` | Disables the clean-working-tree guard. |
|
|
@@ -659,8 +659,8 @@ _Note: This section is not a complete dictionary, more list of general AI / LLM
|
|
|
659
659
|
|
|
660
660
|
The **[Agents Server](https://gallery.ptbk.io/)** is the primary way to use Promptbook. It is a production-ready platform where you create, deploy, and manage persistent AI agents that work toward goals. Agents remember context across conversations, collaborate in teams, and follow the rules and knowledge you define in the Book language.
|
|
661
661
|
|
|
662
|
-
- **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/)
|
|
663
|
-
- **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/)
|
|
662
|
+
- **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/) - start creating agents immediately
|
|
663
|
+
- **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/) - full control over your data and infrastructure
|
|
664
664
|
- **API** for integrating agents into your own applications
|
|
665
665
|
|
|
666
666
|
## 🚂 Promptbook Engine
|
|
@@ -678,7 +678,7 @@ The Engine is the open-source core that powers the Agents Server. If you need to
|
|
|
678
678
|
- When you want agents that **collaborate in teams** and consult each other
|
|
679
679
|
- When you need to **integrate AI agents into your existing applications** via API
|
|
680
680
|
- When you want to **self-host** your AI agents with full control over data and infrastructure
|
|
681
|
-
- When you are writing an app that generates complex things via LLM
|
|
681
|
+
- When you are writing an app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
|
|
682
682
|
- When you want to **version** your agent definitions and **test multiple versions**
|
|
683
683
|
- When you want to **log** agent execution and backtrace issues
|
|
684
684
|
|
|
@@ -690,7 +690,7 @@ The Engine is the open-source core that powers the Agents Server. If you need to
|
|
|
690
690
|
- When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
|
|
691
691
|
- When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_
|
|
692
692
|
- When you need to use something other than JavaScript or TypeScript _(other languages are on the way, [see the discussion](https://github.com/webgptorg/promptbook/discussions/101))_
|
|
693
|
-
- When your main focus is on something other than text
|
|
693
|
+
- When your main focus is on something other than text - like images, audio, video, spreadsheets _(other media types may be added in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/103))_
|
|
694
694
|
- When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
|
|
695
695
|
|
|
696
696
|
[See more](https://github.com/webgptorg/promptbook/discussions/112)
|