@promptbook/remote-server 0.88.0-11 → 0.88.0-12

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 CHANGED
@@ -58,8 +58,6 @@ 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
-
63
61
  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!
64
62
 
65
63
  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.
@@ -70,6 +68,9 @@ This shift is going to happen, whether we are ready for it or not. Our mission i
70
68
 
71
69
 
72
70
 
71
+
72
+
73
+
73
74
  ## 🚀 Get started
74
75
 
75
76
  Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
@@ -81,6 +82,8 @@ Take a look at the simple starter kit with books integrated into the **Hello Wor
81
82
 
82
83
 
83
84
 
85
+
86
+
84
87
  ## 💜 The Promptbook Project
85
88
 
86
89
  Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
@@ -122,29 +125,22 @@ Hello world examples:
122
125
  - [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
123
126
  - [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
124
127
 
125
-
126
-
127
128
  We also have a community of developers and users of **Promptbook**:
128
129
 
129
130
  - [Discord community](https://discord.gg/x3QWNaa89N)
130
131
  - [Landing page `ptbk.io`](https://ptbk.io)
131
132
  - [Github discussions](https://github.com/webgptorg/promptbook/discussions)
132
133
  - [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
133
- - [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
134
+ - [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
134
135
 
135
136
  And **Promptbook.studio** branded socials:
136
137
 
137
-
138
-
139
138
  - [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
140
139
 
141
140
  And **Promptujeme** sub-brand:
142
141
 
143
142
  _/Subbrand for Czech clients/_
144
143
 
145
-
146
-
147
-
148
144
  - [Promptujeme.cz](https://www.promptujeme.cz/)
149
145
  - [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
150
146
 
@@ -162,8 +158,6 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
162
158
 
163
159
  ## 💙 The Book language
164
160
 
165
-
166
-
167
161
  Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
168
162
 
169
163
  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.
@@ -213,8 +207,6 @@ Personas can have access to different knowledge, tools and actions. They can als
213
207
 
214
208
  - [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
215
209
 
216
-
217
-
218
210
  ### **How:** Knowledge, Instruments and Actions
219
211
 
220
212
  The resources used by the personas are used to do the work.
@@ -303,12 +295,8 @@ The following glossary is used to clarify certain concepts:
303
295
  - **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.
304
296
  - **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.
305
297
 
306
-
307
-
308
298
  _Note: This section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
309
299
 
310
-
311
-
312
300
  ### 💯 Core concepts
313
301
 
314
302
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -413,7 +401,7 @@ See [TODO.md](./TODO.md)
413
401
  <a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
414
402
  <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="70">
415
403
  </a>
416
-
404
+
417
405
  </div>
418
406
 
419
407
  ## 🖋️ Contributing
package/esm/index.es.js CHANGED
@@ -4,11 +4,11 @@ import http from 'http';
4
4
  import { Server } from 'socket.io';
5
5
  import spaceTrim$1, { spaceTrim } from 'spacetrim';
6
6
  import { forTime } from 'waitasecond';
7
+ import { randomBytes } from 'crypto';
7
8
  import { spawn } from 'child_process';
8
9
  import { stat, access, constants, readFile, writeFile, readdir, mkdir } from 'fs/promises';
9
10
  import { join, basename, dirname } from 'path';
10
11
  import { Subject } from 'rxjs';
11
- import { randomBytes } from 'crypto';
12
12
  import { format } from 'prettier';
13
13
  import parserHtml from 'prettier/parser-html';
14
14
  import hexEncoder from 'crypto-js/enc-hex';
@@ -31,7 +31,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
31
31
  * @generated
32
32
  * @see https://github.com/webgptorg/promptbook
33
33
  */
34
- const PROMPTBOOK_ENGINE_VERSION = '0.88.0-11';
34
+ const PROMPTBOOK_ENGINE_VERSION = '0.88.0-12';
35
35
  /**
36
36
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
37
37
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -154,7 +154,7 @@ const DEFAULT_MAX_PARALLEL_COUNT = 5; // <- TODO: [🤹‍♂️]
154
154
  *
155
155
  * @public exported from `@promptbook/core`
156
156
  */
157
- const DEFAULT_MAX_EXECUTION_ATTEMPTS = 3; // <- TODO: [🤹‍♂️]
157
+ const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10; // <- TODO: [🤹‍♂️]
158
158
  // <- TODO: [🕝] Make also `BOOKS_DIRNAME_ALTERNATIVES`
159
159
  /**
160
160
  * Where to store the temporary downloads
@@ -210,6 +210,21 @@ true);
210
210
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
211
211
  */
212
212
 
213
+ /**
214
+ * Generates random token
215
+ *
216
+ * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
217
+ *
218
+ * @private internal helper function
219
+ * @returns secure random token
220
+ */
221
+ function $randomToken(randomness) {
222
+ return randomBytes(randomness).toString('hex');
223
+ }
224
+ /**
225
+ * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
226
+ */
227
+
213
228
  /**
214
229
  * This error indicates errors during the execution of the pipeline
215
230
  *
@@ -217,11 +232,17 @@ true);
217
232
  */
218
233
  class PipelineExecutionError extends Error {
219
234
  constructor(message) {
235
+ // Added id parameter
220
236
  super(message);
221
237
  this.name = 'PipelineExecutionError';
238
+ // TODO: [🐙] DRY - Maybe $randomId
239
+ this.id = `error-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts */)}`;
222
240
  Object.setPrototypeOf(this, PipelineExecutionError.prototype);
223
241
  }
224
242
  }
243
+ /**
244
+ * TODO: !!!!!! Add id to all errors
245
+ */
225
246
 
226
247
  /**
227
248
  * This error indicates problems parsing the format value
@@ -551,19 +572,21 @@ const ALL_ERRORS = {
551
572
  */
552
573
  function serializeError(error) {
553
574
  const { name, message, stack } = error;
575
+ const { id } = error;
554
576
  if (!Object.keys(ALL_ERRORS).includes(name)) {
555
577
  console.error(spaceTrim$1((block) => `
556
-
578
+
557
579
  Cannot serialize error with name "${name}"
558
580
 
559
581
  ${block(stack || message)}
560
-
582
+
561
583
  `));
562
584
  }
563
585
  return {
564
586
  name: name,
565
587
  message,
566
588
  stack,
589
+ id, // Include id in the serialized object
567
590
  };
568
591
  }
569
592
 
@@ -1706,21 +1729,6 @@ function isPipelinePrepared(pipeline) {
1706
1729
  * - [♨] Are tasks prepared
1707
1730
  */
1708
1731
 
1709
- /**
1710
- * Generates random token
1711
- *
1712
- * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
1713
- *
1714
- * @private internal helper function
1715
- * @returns secure random token
1716
- */
1717
- function $randomToken(randomness) {
1718
- return randomBytes(randomness).toString('hex');
1719
- }
1720
- /**
1721
- * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
1722
- */
1723
-
1724
1732
  /**
1725
1733
  * Function isValidJsonString will tell you if the string is valid JSON or not
1726
1734
  *
@@ -1778,7 +1786,7 @@ function jsonStringsToJsons(object) {
1778
1786
  * @public exported from `@promptbook/utils`
1779
1787
  */
1780
1788
  function deserializeError(error) {
1781
- const { name, stack } = error;
1789
+ const { name, stack, id } = error; // Added id
1782
1790
  let { message } = error;
1783
1791
  let ErrorClass = ALL_ERRORS[error.name];
1784
1792
  if (ErrorClass === undefined) {
@@ -1793,7 +1801,9 @@ function deserializeError(error) {
1793
1801
  ${block(stack || '')}
1794
1802
  `);
1795
1803
  }
1796
- return new ErrorClass(message);
1804
+ const deserializedError = new ErrorClass(message);
1805
+ deserializedError.id = id; // Assign id to the error object
1806
+ return deserializedError;
1797
1807
  }
1798
1808
 
1799
1809
  /**
@@ -1843,6 +1853,7 @@ function assertsTaskSuccessful(executionResult) {
1843
1853
  */
1844
1854
  function createTask(options) {
1845
1855
  const { taskType, taskProcessCallback } = options;
1856
+ // TODO: [🐙] DRY
1846
1857
  const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts */)}`;
1847
1858
  let status = 'RUNNING';
1848
1859
  const createdAt = new Date();
@@ -4691,6 +4702,9 @@ function countCharacters(text) {
4691
4702
  text = text.replace(/\p{Extended_Pictographic}(\u{200D}\p{Extended_Pictographic})*/gu, '-');
4692
4703
  return text.length;
4693
4704
  }
4705
+ /**
4706
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4707
+ */
4694
4708
 
4695
4709
  /**
4696
4710
  * Number of characters per standard line with 11pt Arial font size.
@@ -4722,6 +4736,9 @@ function countLines(text) {
4722
4736
  const lines = text.split('\n');
4723
4737
  return lines.reduce((count, line) => count + Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 0);
4724
4738
  }
4739
+ /**
4740
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4741
+ */
4725
4742
 
4726
4743
  /**
4727
4744
  * Counts number of pages in the text
@@ -4733,6 +4750,9 @@ function countLines(text) {
4733
4750
  function countPages(text) {
4734
4751
  return Math.ceil(countLines(text) / LINES_PER_STANDARD_PAGE);
4735
4752
  }
4753
+ /**
4754
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4755
+ */
4736
4756
 
4737
4757
  /**
4738
4758
  * Counts number of paragraphs in the text
@@ -4742,6 +4762,9 @@ function countPages(text) {
4742
4762
  function countParagraphs(text) {
4743
4763
  return text.split(/\n\s*\n/).filter((paragraph) => paragraph.trim() !== '').length;
4744
4764
  }
4765
+ /**
4766
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4767
+ */
4745
4768
 
4746
4769
  /**
4747
4770
  * Split text into sentences
@@ -4759,6 +4782,9 @@ function splitIntoSentences(text) {
4759
4782
  function countSentences(text) {
4760
4783
  return splitIntoSentences(text).length;
4761
4784
  }
4785
+ /**
4786
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4787
+ */
4762
4788
 
4763
4789
  /**
4764
4790
  * Counts number of words in the text
@@ -4772,6 +4798,9 @@ function countWords(text) {
4772
4798
  text = text.replace(/([a-z])([A-Z])/g, '$1 $2');
4773
4799
  return text.split(/[^a-zа-я0-9]+/i).filter((word) => word.length > 0).length;
4774
4800
  }
4801
+ /**
4802
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4803
+ */
4775
4804
 
4776
4805
  /**
4777
4806
  * Index of all counter functions