@promptbook/browser 0.103.0-4 → 0.103.0-41

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.
Files changed (145) hide show
  1. package/README.md +57 -21
  2. package/esm/index.es.js +11526 -216
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/books/index.d.ts +0 -81
  5. package/esm/typings/src/_packages/browser.index.d.ts +6 -0
  6. package/esm/typings/src/_packages/cli.index.d.ts +4 -0
  7. package/esm/typings/src/_packages/components.index.d.ts +12 -8
  8. package/esm/typings/src/_packages/core.index.d.ts +30 -10
  9. package/esm/typings/src/_packages/node.index.d.ts +4 -2
  10. package/esm/typings/src/_packages/remote-server.index.d.ts +2 -0
  11. package/esm/typings/src/_packages/types.index.d.ts +18 -2
  12. package/esm/typings/src/_packages/wizard.index.d.ts +4 -0
  13. package/esm/typings/src/book-2.0/agent-source/AgentBasicInformation.d.ts +1 -0
  14. package/esm/typings/src/book-2.0/agent-source/padBook.d.ts +16 -0
  15. package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +76 -15
  16. package/esm/typings/src/book-components/BookEditor/BookEditorActionbar.d.ts +14 -0
  17. package/esm/typings/src/book-components/BookEditor/BookEditorMonaco.d.ts +5 -0
  18. package/esm/typings/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +15 -0
  19. package/esm/typings/src/book-components/Chat/MockedChat/MockedChat.d.ts +5 -0
  20. package/esm/typings/src/book-components/Chat/save/html/htmlSaveFormatDefinition.d.ts +1 -0
  21. package/esm/typings/src/book-components/Chat/save/pdf/pdfSaveFormatDefinition.d.ts +4 -0
  22. package/esm/typings/src/book-components/Qr/BrandedQrCode.d.ts +18 -0
  23. package/esm/typings/src/book-components/Qr/GenericQrCode.d.ts +10 -0
  24. package/esm/typings/src/book-components/Qr/PromptbookQrCode.d.ts +18 -0
  25. package/esm/typings/src/book-components/Qr/useQrCode.d.ts +15 -0
  26. package/esm/typings/src/book-components/_common/Dropdown/Dropdown.d.ts +15 -0
  27. package/esm/typings/src/book-components/_common/Modal/Modal.d.ts +2 -2
  28. package/esm/typings/src/book-components/_common/Tooltip/Tooltip.d.ts +47 -0
  29. package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts +1 -1
  30. package/esm/typings/src/book-components/icons/AboutIcon.d.ts +9 -0
  31. package/esm/typings/src/book-components/icons/CloseIcon.d.ts +4 -8
  32. package/esm/typings/src/book-components/icons/DownloadIcon.d.ts +9 -0
  33. package/esm/typings/src/book-components/icons/ExitFullscreenIcon.d.ts +7 -0
  34. package/esm/typings/src/book-components/icons/FullscreenIcon.d.ts +7 -0
  35. package/esm/typings/src/book-components/icons/MenuIcon.d.ts +12 -0
  36. package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +2 -1
  37. package/esm/typings/src/cli/cli-commands/about.d.ts +3 -1
  38. package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
  39. package/esm/typings/src/cli/cli-commands/list-models.d.ts +2 -1
  40. package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +2 -1
  41. package/esm/typings/src/cli/cli-commands/login.d.ts +2 -1
  42. package/esm/typings/src/cli/cli-commands/make.d.ts +2 -1
  43. package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
  44. package/esm/typings/src/cli/cli-commands/run.d.ts +2 -1
  45. package/esm/typings/src/cli/cli-commands/{start-server.d.ts → start-agents-server.d.ts} +3 -2
  46. package/esm/typings/src/cli/cli-commands/start-pipelines-server.d.ts +15 -0
  47. package/esm/typings/src/cli/cli-commands/test-command.d.ts +2 -1
  48. package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +2 -1
  49. package/esm/typings/src/collection/agent-collection/AgentCollection.d.ts +36 -0
  50. package/esm/typings/src/collection/agent-collection/constructors/AgentCollectionInDirectory.d.ts +88 -0
  51. package/esm/typings/src/collection/{PipelineCollection.d.ts → pipeline-collection/PipelineCollection.d.ts} +7 -3
  52. package/esm/typings/src/collection/{SimplePipelineCollection.d.ts → pipeline-collection/SimplePipelineCollection.d.ts} +5 -5
  53. package/esm/typings/src/collection/{constructors/createCollectionFromDirectory.d.ts → pipeline-collection/constructors/createPipelineCollectionFromDirectory.d.ts} +8 -11
  54. package/esm/typings/src/collection/pipeline-collection/constructors/createPipelineCollectionFromJson.d.ts +13 -0
  55. package/esm/typings/src/collection/{constructors/createCollectionFromPromise.d.ts → pipeline-collection/constructors/createPipelineCollectionFromPromise.d.ts} +6 -5
  56. package/esm/typings/src/collection/{constructors/createCollectionFromUrl.d.ts → pipeline-collection/constructors/createPipelineCollectionFromUrl.d.ts} +3 -3
  57. package/esm/typings/src/collection/{constructors/createSubcollection.d.ts → pipeline-collection/constructors/createPipelineSubcollection.d.ts} +3 -3
  58. package/esm/typings/src/collection/pipeline-collection/pipelineCollectionToJson.d.ts +13 -0
  59. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +4 -5
  60. package/esm/typings/src/config.d.ts +22 -2
  61. package/esm/typings/src/errors/0-index.d.ts +3 -0
  62. package/esm/typings/src/errors/NotAllowed.d.ts +9 -0
  63. package/esm/typings/src/execution/AvailableModel.d.ts +1 -0
  64. package/esm/typings/src/execution/Executables.d.ts +3 -0
  65. package/esm/typings/src/execution/ExecutionTask.d.ts +12 -3
  66. package/esm/typings/src/execution/ExecutionTools.d.ts +5 -0
  67. package/esm/typings/src/execution/FilesystemTools.d.ts +1 -1
  68. package/esm/typings/src/execution/LlmExecutionTools.d.ts +7 -1
  69. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +5 -0
  70. package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts +5 -0
  71. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +5 -0
  72. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +5 -0
  73. package/esm/typings/src/execution/utils/logLlmCall.d.ts +8 -0
  74. package/esm/typings/src/execution/utils/usage-constants.d.ts +4 -124
  75. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +2 -1
  76. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +2 -1
  77. package/esm/typings/src/llm-providers/agent/Agent.d.ts +49 -0
  78. package/esm/typings/src/llm-providers/agent/AgentLlmExecutionTools.d.ts +9 -4
  79. package/esm/typings/src/llm-providers/agent/AgentOptions.d.ts +17 -0
  80. package/esm/typings/src/llm-providers/agent/CreateAgentLlmExecutionToolsOptions.d.ts +16 -0
  81. package/esm/typings/src/llm-providers/agent/createAgentLlmExecutionTools.d.ts +1 -19
  82. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +28 -0
  83. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +7 -1
  84. package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts +1 -1
  85. package/esm/typings/src/playground/permanent/_boilerplate.d.ts +5 -0
  86. package/esm/typings/src/playground/permanent/agent-with-browser-playground.d.ts +5 -0
  87. package/esm/typings/src/playground/playground.d.ts +0 -3
  88. package/esm/typings/src/playground/playground1.d.ts +2 -0
  89. package/esm/typings/src/remote-server/startAgentServer.d.ts +23 -0
  90. package/esm/typings/src/remote-server/startRemoteServer.d.ts +4 -1
  91. package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts +22 -8
  92. package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +1 -12
  93. package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +1 -9
  94. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +1 -12
  95. package/esm/typings/src/scrapers/document/register-metadata.d.ts +1 -9
  96. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +1 -12
  97. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +1 -9
  98. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +1 -12
  99. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +1 -9
  100. package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +1 -12
  101. package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +1 -9
  102. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +1 -12
  103. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +1 -9
  104. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +1 -12
  105. package/esm/typings/src/scrapers/website/register-metadata.d.ts +1 -9
  106. package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +2 -1
  107. package/esm/typings/src/transpilers/_common/BookTranspiler.d.ts +29 -0
  108. package/esm/typings/src/transpilers/_common/BookTranspilerOptions.d.ts +18 -0
  109. package/esm/typings/src/transpilers/_common/register/$bookTranspilersRegister.d.ts +15 -0
  110. package/esm/typings/src/transpilers/formatted-book-in-markdown/FormattedBookInMarkdownTranspiler.d.ts +13 -0
  111. package/esm/typings/src/transpilers/formatted-book-in-markdown/register.d.ts +15 -0
  112. package/esm/typings/src/transpilers/openai-sdk/OpenAiSdkTranspiler.d.ts +13 -0
  113. package/esm/typings/src/transpilers/openai-sdk/OpenAiSdkTranspiler.test.d.ts +1 -0
  114. package/esm/typings/src/transpilers/openai-sdk/playground/playground.d.ts +5 -0
  115. package/esm/typings/src/transpilers/openai-sdk/register.d.ts +15 -0
  116. package/esm/typings/src/types/LlmCall.d.ts +20 -0
  117. package/esm/typings/src/types/Updatable.d.ts +19 -0
  118. package/esm/typings/src/types/typeAliases.d.ts +1 -1
  119. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +2 -1
  120. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +2 -1
  121. package/esm/typings/src/utils/files/$induceBookDownload.d.ts +13 -0
  122. package/esm/typings/src/utils/files/$induceFileDownload.d.ts +13 -0
  123. package/esm/typings/src/utils/files/ObjectUrl.d.ts +46 -0
  124. package/esm/typings/src/utils/files/listAllFiles.d.ts +2 -3
  125. package/esm/typings/src/utils/misc/aboutPromptbookInformation.d.ts +21 -0
  126. package/esm/typings/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts +1 -0
  127. package/esm/typings/src/utils/misc/xAboutPromptbookInformation.d.ts +13 -0
  128. package/esm/typings/src/utils/organization/$side_effect.d.ts +7 -0
  129. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +2 -1
  130. package/esm/typings/src/version.d.ts +1 -1
  131. package/esm/typings/src/wizard/$getCompiledBook.d.ts +1 -2
  132. package/package.json +12 -4
  133. package/umd/index.umd.js +11524 -218
  134. package/umd/index.umd.js.map +1 -1
  135. package/esm/typings/src/book-components/BookEditor/BookEditorInner.d.ts +0 -5
  136. package/esm/typings/src/book-components/BookEditor/BookEditorWrapper.d.ts +0 -9
  137. package/esm/typings/src/book-components/BookEditor/config.d.ts +0 -10
  138. package/esm/typings/src/book-components/Chat/utils/renderMarkdown.d.ts +0 -21
  139. package/esm/typings/src/collection/collectionToJson.d.ts +0 -13
  140. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +0 -13
  141. /package/esm/typings/src/{book-components/Chat/utils/renderMarkdown.test.d.ts → collection/agent-collection/constructors/AgentCollectionInDirectory.test.d.ts} +0 -0
  142. /package/esm/typings/src/collection/{constructors/createCollectionFromDirectory.test.d.ts → pipeline-collection/constructors/createPipelineCollectionFromDirectory.test.d.ts} +0 -0
  143. /package/esm/typings/src/collection/{constructors/createCollectionFromJson.test.d.ts → pipeline-collection/constructors/createPipelineCollectionFromJson.test.d.ts} +0 -0
  144. /package/esm/typings/src/collection/{constructors/createCollectionFromPromise.test.d.ts → pipeline-collection/constructors/createPipelineCollectionFromPromise.test.d.ts} +0 -0
  145. /package/esm/typings/src/collection/{collectionToJson.test.d.ts → pipeline-collection/pipelineCollectionToJson.test.d.ts} +0 -0
package/README.md CHANGED
@@ -110,11 +110,15 @@ The main challenge is to narrow it down, constrain it, set the proper **context,
110
110
 
111
111
  Promptbook takes the best from both worlds. You are defining your AI behavior by simple **books**, which are very explicit. They are automatically enforced, but they are very easy to understand, very easy to write, and very reliable and portable.
112
112
 
113
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
113
114
 
114
- <img
115
- alt="Paul Smith & Associés Book"
116
- src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.&width=800&height=450&nonce=0"
117
- />
115
+ **<ins>Paul Smith & Associés</ins>**<br/>
116
+ <br/>
117
+ **PERSONA** You are a company lawyer.<br/>
118
+ Your job is to provide legal advice and support to the company and its employees.<br/>
119
+ You are knowledgeable, professional, and detail-oriented.<br/>
120
+
121
+ </td></tr></table>
118
122
 
119
123
  <div style="page-break-after: always;"></div>
120
124
 
@@ -128,11 +132,15 @@ You can look at it as prompting (or writing a system message), but decorated by
128
132
 
129
133
  Personas define the character of your AI persona, its role, and how it should interact with users. It sets the tone and style of communication.
130
134
 
135
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
136
+
137
+ **<ins>Paul Smith & Associés</ins>**<br/>
138
+ <br/>
139
+ **PERSONA** You are a company lawyer.<br/>
140
+ Your job is to provide legal advice and support to the company and its employees.<br/>
141
+ You are knowledgeable, professional, and detail-oriented.<br/>
131
142
 
132
- <img
133
- alt="Paul Smith & Associés Book"
134
- src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.&width=800&height=450&nonce=0"
135
- />
143
+ </td></tr></table>
136
144
 
137
145
  #### `Knowledge` commitment
138
146
 
@@ -142,11 +150,18 @@ This can include domain-specific knowledge, company policies, or any other relev
142
150
 
143
151
  Promptbook Engine will automatically enforce this knowledge during interactions. When the knowledge is short enough, it will be included in the prompt. When it is too long, it will be stored in vector databases and RAG retrieved when needed. But you don't need to care about it.
144
152
 
153
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
154
+
155
+ **<ins>Paul Smith & Associés</ins>**<br/>
156
+ <br/>
157
+ **PERSONA** You are a company lawyer.<br/>
158
+ Your job is to provide legal advice and support to the company and its employees.<br/>
159
+ You are knowledgeable, professional, and detail-oriented.<br/>
160
+ <br/>
161
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
162
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
145
163
 
146
- <img
147
- alt="Paul Smith & Associés Book"
148
- src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20%20https%3A%2F%2Fcompany.com%2Fcompany-policies.pdf%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20https%3A%2F%2Fcompany.com%2Finternal-documents%2Femployee-handbook.docx&width=800&height=450&nonce=0"
149
- />
164
+ </td></tr></table>
150
165
 
151
166
  #### `Rule` commitment
152
167
 
@@ -154,21 +169,42 @@ Rules will enforce specific behaviors or constraints on the AI's responses. This
154
169
 
155
170
  Depending on rule strictness, Promptbook will either propagate it to the prompt or use other techniques, like adversary agent, to enforce it.
156
171
 
172
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
157
173
 
158
- <img
159
- alt="Paul Smith & Associés Book"
160
- src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.%0A%20%20%20%20%20%20%7C%20RULE%20Always%20ensure%20compliance%20with%20laws%20and%20regulations.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20outside%20your%20area%20of%20expertise.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20about%20criminal%20law.%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20%20https%3A%2F%2Fcompany.com%2Fcompany-policies.pdf%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20https%3A%2F%2Fcompany.com%2Finternal-documents%2Femployee-handbook.docx&width=800&height=450&nonce=0"
161
- />
174
+ **<ins>Paul Smith & Associés</ins>**<br/>
175
+ <br/>
176
+ **PERSONA** You are a company lawyer.<br/>
177
+ Your job is to provide legal advice and support to the company and its employees.<br/>
178
+ You are knowledgeable, professional, and detail-oriented.<br/>
179
+ <br/>
180
+ **RULE** Always ensure compliance with laws and regulations.<br/>
181
+ **RULE** Never provide legal advice outside your area of expertise.<br/>
182
+ **RULE** Never provide legal advice about criminal law.<br/>
183
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
184
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
185
+
186
+ </td></tr></table>
162
187
 
163
188
  #### `Action` commitment
164
189
 
165
190
  Action Commitment allows you to define specific actions that the AI can take during interactions. This can include things like posting on a social media platform, sending emails, creating calendar events, or interacting with your internal systems.
166
191
 
167
-
168
- <img
169
- alt="Paul Smith & Associés Book"
170
- src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.%0A%20%20%20%20%20%20%7C%20RULE%20Always%20ensure%20compliance%20with%20laws%20and%20regulations.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20outside%20your%20area%20of%20expertise.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20about%20criminal%20law.%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20%20https%3A%2F%2Fcompany.com%2Fcompany-policies.pdf%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20https%3A%2F%2Fcompany.com%2Finternal-documents%2Femployee-handbook.docx%0A%20%20%20%20%20%20%7C%20ACTION%20When%20a%20user%20asks%20about%20an%20issue%20that%20could%20be%20treated%20as%20a%20crime%2C%20notify%20legal%40company.com.&width=800&height=450&nonce=0"
171
- />
192
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
193
+
194
+ **<ins>Paul Smith & Associés</ins>**<br/>
195
+ <br/>
196
+ **PERSONA** You are a company lawyer.<br/>
197
+ Your job is to provide legal advice and support to the company and its employees.<br/>
198
+ You are knowledgeable, professional, and detail-oriented.<br/>
199
+ <br/>
200
+ **RULE** Always ensure compliance with laws and regulations.<br/>
201
+ **RULE** Never provide legal advice outside your area of expertise.<br/>
202
+ **RULE** Never provide legal advice about criminal law.<br/>
203
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
204
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
205
+ **ACTION** When a user asks about an issue that could be treated as a crime, notify legal@company.com.<br/>
206
+
207
+ </td></tr></table>
172
208
 
173
209
  [Read more about the language](./BLUEPRINT.md)
174
210