@promptbook/remote-client 0.88.0-9 → 0.89.0-1

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 (25) hide show
  1. package/README.md +35 -14
  2. package/esm/index.es.js +27 -3
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/core.index.d.ts +2 -2
  5. package/esm/typings/src/_packages/types.index.d.ts +10 -0
  6. package/esm/typings/src/config.d.ts +1 -1
  7. package/esm/typings/src/errors/PipelineExecutionError.d.ts +5 -0
  8. package/esm/typings/src/errors/utils/ErrorJson.d.ts +5 -0
  9. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +7 -0
  10. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/{countTotalUsage.d.ts → countUsage.d.ts} +1 -1
  11. package/esm/typings/src/playground/BrjappConnector.d.ts +64 -0
  12. package/esm/typings/src/playground/brjapp-api-schema.d.ts +12879 -0
  13. package/esm/typings/src/playground/playground.d.ts +5 -0
  14. package/esm/typings/src/remote-server/socket-types/_subtypes/PromptbookServer_Identification.d.ts +2 -1
  15. package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts +15 -3
  16. package/esm/typings/src/types/typeAliases.d.ts +2 -2
  17. package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +3 -0
  18. package/esm/typings/src/utils/expectation-counters/countLines.d.ts +3 -0
  19. package/esm/typings/src/utils/expectation-counters/countPages.d.ts +3 -0
  20. package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +3 -0
  21. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +3 -0
  22. package/esm/typings/src/utils/expectation-counters/countWords.d.ts +3 -0
  23. package/package.json +3 -2
  24. package/umd/index.umd.js +30 -7
  25. package/umd/index.umd.js.map +1 -1
package/README.md CHANGED
@@ -58,6 +58,8 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
58
58
 
59
59
  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**!
60
60
 
61
+
62
+
61
63
  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!
62
64
 
63
65
  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.
@@ -68,6 +70,9 @@ This shift is going to happen, whether we are ready for it or not. Our mission i
68
70
 
69
71
 
70
72
 
73
+
74
+
75
+
71
76
  ## 🚀 Get started
72
77
 
73
78
  Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
@@ -79,6 +84,8 @@ Take a look at the simple starter kit with books integrated into the **Hello Wor
79
84
 
80
85
 
81
86
 
87
+
88
+
82
89
  ## 💜 The Promptbook Project
83
90
 
84
91
  Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
@@ -114,22 +121,35 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
114
121
  </tbody>
115
122
  </table>
116
123
 
124
+ Hello world examples:
125
+
126
+ - [Hello world](https://github.com/webgptorg/hello-world)
127
+ - [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
128
+ - [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
129
+
130
+
131
+
117
132
  We also have a community of developers and users of **Promptbook**:
118
133
 
119
134
  - [Discord community](https://discord.gg/x3QWNaa89N)
120
135
  - [Landing page `ptbk.io`](https://ptbk.io)
121
136
  - [Github discussions](https://github.com/webgptorg/promptbook/discussions)
122
137
  - [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
123
- - [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
138
+ - [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
124
139
 
125
140
  And **Promptbook.studio** branded socials:
126
141
 
142
+
143
+
127
144
  - [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
128
145
 
129
146
  And **Promptujeme** sub-brand:
130
147
 
131
148
  _/Subbrand for Czech clients/_
132
149
 
150
+
151
+
152
+
133
153
  - [Promptujeme.cz](https://www.promptujeme.cz/)
134
154
  - [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
135
155
 
@@ -147,6 +167,8 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
147
167
 
148
168
  ## 💙 The Book language
149
169
 
170
+
171
+
150
172
  Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
151
173
 
152
174
  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.
@@ -196,6 +218,8 @@ Personas can have access to different knowledge, tools and actions. They can als
196
218
 
197
219
  - [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
198
220
 
221
+
222
+
199
223
  ### **How:** Knowledge, Instruments and Actions
200
224
 
201
225
  The resources used by the personas are used to do the work.
@@ -271,11 +295,9 @@ Or you can install them separately:
271
295
 
272
296
  ## 📚 Dictionary
273
297
 
274
- ### 📚 Dictionary
275
-
276
298
  The following glossary is used to clarify certain concepts:
277
299
 
278
- #### General LLM / AI terms
300
+ ### General LLM / AI terms
279
301
 
280
302
  - **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.
281
303
  - **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.
@@ -286,9 +308,13 @@ The following glossary is used to clarify certain concepts:
286
308
  - **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.
287
309
  - **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.
288
310
 
289
- _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
290
311
 
291
- #### 💯 Core concepts
312
+
313
+ _Note: This section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
314
+
315
+
316
+
317
+ ### 💯 Core concepts
292
318
 
293
319
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
294
320
  - [📯 Pipeline](https://github.com/webgptorg/promptbook/discussions/64)
@@ -301,7 +327,7 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
301
327
  - [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29)
302
328
  - [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32)
303
329
 
304
- ##### Advanced concepts
330
+ #### Advanced concepts
305
331
 
306
332
  - [📚 Knowledge (Retrieval-augmented generation)](https://github.com/webgptorg/promptbook/discussions/41)
307
333
  - [🌏 Remote server](https://github.com/webgptorg/promptbook/discussions/89)
@@ -316,11 +342,6 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
316
342
  - [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
317
343
  - [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
318
344
 
319
- ### Terms specific to Promptbook TypeScript implementation
320
-
321
- - Anonymous mode
322
- - Application mode
323
-
324
345
 
325
346
 
326
347
  ## 🚂 Promptbook Engine
@@ -391,11 +412,11 @@ See [TODO.md](./TODO.md)
391
412
  <div style="display: flex; align-items: center; gap: 20px;">
392
413
 
393
414
  <a href="https://promptbook.studio/">
394
- <img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="100">
415
+ <img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="70">
395
416
  </a>
396
417
 
397
418
  <a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
398
- <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="100">
419
+ <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="70">
399
420
  </a>
400
421
 
401
422
  </div>
package/esm/index.es.js CHANGED
@@ -1,4 +1,5 @@
1
1
  import spaceTrim$1, { spaceTrim } from 'spacetrim';
2
+ import { randomBytes } from 'crypto';
2
3
  import { io } from 'socket.io-client';
3
4
  import { SHA256 } from 'crypto-js';
4
5
  import hexEncoder from 'crypto-js/enc-hex';
@@ -19,7 +20,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
19
20
  * @generated
20
21
  * @see https://github.com/webgptorg/promptbook
21
22
  */
22
- const PROMPTBOOK_ENGINE_VERSION = '0.88.0-9';
23
+ const PROMPTBOOK_ENGINE_VERSION = '0.89.0-1';
23
24
  /**
24
25
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
25
26
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -193,6 +194,21 @@ class ParseError extends Error {
193
194
  * TODO: Maybe split `ParseError` and `ApplyError`
194
195
  */
195
196
 
197
+ /**
198
+ * Generates random token
199
+ *
200
+ * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
201
+ *
202
+ * @private internal helper function
203
+ * @returns secure random token
204
+ */
205
+ function $randomToken(randomness) {
206
+ return randomBytes(randomness).toString('hex');
207
+ }
208
+ /**
209
+ * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
210
+ */
211
+
196
212
  /**
197
213
  * This error indicates errors during the execution of the pipeline
198
214
  *
@@ -200,11 +216,17 @@ class ParseError extends Error {
200
216
  */
201
217
  class PipelineExecutionError extends Error {
202
218
  constructor(message) {
219
+ // Added id parameter
203
220
  super(message);
204
221
  this.name = 'PipelineExecutionError';
222
+ // TODO: [🐙] DRY - Maybe $randomId
223
+ this.id = `error-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts */)}`;
205
224
  Object.setPrototypeOf(this, PipelineExecutionError.prototype);
206
225
  }
207
226
  }
227
+ /**
228
+ * TODO: !!!!!! Add id to all errors
229
+ */
208
230
 
209
231
  /**
210
232
  * This error indicates that the promptbook object has valid syntax (=can be parsed) but contains logical errors (like circular dependencies)
@@ -460,7 +482,7 @@ const ALL_ERRORS = {
460
482
  * @public exported from `@promptbook/utils`
461
483
  */
462
484
  function deserializeError(error) {
463
- const { name, stack } = error;
485
+ const { name, stack, id } = error; // Added id
464
486
  let { message } = error;
465
487
  let ErrorClass = ALL_ERRORS[error.name];
466
488
  if (ErrorClass === undefined) {
@@ -475,7 +497,9 @@ function deserializeError(error) {
475
497
  ${block(stack || '')}
476
498
  `);
477
499
  }
478
- return new ErrorClass(message);
500
+ const deserializedError = new ErrorClass(message);
501
+ deserializedError.id = id; // Assign id to the error object
502
+ return deserializedError;
479
503
  }
480
504
 
481
505
  /**