@promptbook/markdown-utils 0.88.0-1 → 0.88.0-9

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.
@@ -122,21 +120,16 @@ We also have a community of developers and users of **Promptbook**:
122
120
  - [Landing page `ptbk.io`](https://ptbk.io)
123
121
  - [Github discussions](https://github.com/webgptorg/promptbook/discussions)
124
122
  - [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
125
- - [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
123
+ - [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
126
124
 
127
125
  And **Promptbook.studio** branded socials:
128
126
 
129
-
130
-
131
127
  - [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
132
128
 
133
129
  And **Promptujeme** sub-brand:
134
130
 
135
131
  _/Subbrand for Czech clients/_
136
132
 
137
-
138
-
139
-
140
133
  - [Promptujeme.cz](https://www.promptujeme.cz/)
141
134
  - [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
142
135
 
@@ -154,8 +147,6 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
154
147
 
155
148
  ## 💙 The Book language
156
149
 
157
-
158
-
159
150
  Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
160
151
 
161
152
  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.
@@ -205,8 +196,6 @@ Personas can have access to different knowledge, tools and actions. They can als
205
196
 
206
197
  - [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
207
198
 
208
-
209
-
210
199
  ### **How:** Knowledge, Instruments and Actions
211
200
 
212
201
  The resources used by the personas are used to do the work.
@@ -282,11 +271,6 @@ Or you can install them separately:
282
271
 
283
272
  ## 📚 Dictionary
284
273
 
285
-
286
-
287
-
288
-
289
-
290
274
  ### 📚 Dictionary
291
275
 
292
276
  The following glossary is used to clarify certain concepts:
@@ -302,12 +286,8 @@ The following glossary is used to clarify certain concepts:
302
286
  - **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.
303
287
  - **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.
304
288
 
305
-
306
-
307
289
  _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
308
290
 
309
-
310
-
311
291
  #### 💯 Core concepts
312
292
 
313
293
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -336,8 +316,6 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
336
316
  - [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
337
317
  - [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
338
318
 
339
-
340
-
341
319
  ### Terms specific to Promptbook TypeScript implementation
342
320
 
343
321
  - Anonymous mode
@@ -345,10 +323,9 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
345
323
 
346
324
 
347
325
 
348
- ## 🔌 Usage in Typescript / Javascript
326
+ ## 🚂 Promptbook Engine
349
327
 
350
- - [Simple usage](./examples/usage/simple-script)
351
- - [Usage with client and remote server](./examples/usage/remote)
328
+ ![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
352
329
 
353
330
  ## ➕➖ When to use Promptbook?
354
331
 
package/esm/index.es.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import spaceTrim, { spaceTrim as spaceTrim$1 } from 'spacetrim';
2
2
  import { format } from 'prettier';
3
3
  import parserHtml from 'prettier/parser-html';
4
- import { BehaviorSubject } from 'rxjs';
4
+ import { Subject } from 'rxjs';
5
5
  import { randomBytes } from 'crypto';
6
6
  import { forTime } from 'waitasecond';
7
7
  import hexEncoder from 'crypto-js/enc-hex';
@@ -25,7 +25,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
25
25
  * @generated
26
26
  * @see https://github.com/webgptorg/promptbook
27
27
  */
28
- const PROMPTBOOK_ENGINE_VERSION = '0.88.0-1';
28
+ const PROMPTBOOK_ENGINE_VERSION = '0.88.0-9';
29
29
  /**
30
30
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
31
31
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1741,6 +1741,36 @@ function $randomToken(randomness) {
1741
1741
  * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
1742
1742
  */
1743
1743
 
1744
+ /**
1745
+ * Recursively converts JSON strings to JSON objects
1746
+
1747
+ * @public exported from `@promptbook/utils`
1748
+ */
1749
+ function jsonStringsToJsons(object) {
1750
+ if (object === null) {
1751
+ return object;
1752
+ }
1753
+ if (Array.isArray(object)) {
1754
+ return object.map(jsonStringsToJsons);
1755
+ }
1756
+ if (typeof object !== 'object') {
1757
+ return object;
1758
+ }
1759
+ const newObject = { ...object };
1760
+ for (const [key, value] of Object.entries(object)) {
1761
+ if (typeof value === 'string' && isValidJsonString(value)) {
1762
+ newObject[key] = JSON.parse(value);
1763
+ }
1764
+ else {
1765
+ newObject[key] = jsonStringsToJsons(value);
1766
+ }
1767
+ }
1768
+ return newObject;
1769
+ }
1770
+ /**
1771
+ * TODO: Type the return type correctly
1772
+ */
1773
+
1744
1774
  /**
1745
1775
  * This error indicates problems parsing the format value
1746
1776
  *
@@ -1993,21 +2023,43 @@ function assertsTaskSuccessful(executionResult) {
1993
2023
  function createTask(options) {
1994
2024
  const { taskType, taskProcessCallback } = options;
1995
2025
  const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts */)}`;
1996
- const partialResultSubject = new BehaviorSubject({});
2026
+ let status = 'RUNNING';
2027
+ const createdAt = new Date();
2028
+ let updatedAt = createdAt;
2029
+ const errors = [];
2030
+ const warnings = [];
2031
+ let currentValue = {};
2032
+ const partialResultSubject = new Subject();
2033
+ // <- Note: Not using `BehaviorSubject` because on error we can't access the last value
1997
2034
  const finalResultPromise = /* not await */ taskProcessCallback((newOngoingResult) => {
2035
+ Object.assign(currentValue, newOngoingResult);
2036
+ // <- TODO: assign deep
1998
2037
  partialResultSubject.next(newOngoingResult);
1999
2038
  });
2000
2039
  finalResultPromise
2001
2040
  .catch((error) => {
2041
+ errors.push(error);
2002
2042
  partialResultSubject.error(error);
2003
2043
  })
2004
- .then((value) => {
2005
- if (value) {
2044
+ .then((executionResult) => {
2045
+ if (executionResult) {
2006
2046
  try {
2007
- assertsTaskSuccessful(value);
2008
- partialResultSubject.next(value);
2047
+ updatedAt = new Date();
2048
+ errors.push(...executionResult.errors);
2049
+ warnings.push(...executionResult.warnings);
2050
+ // <- TODO: !!! Only unique errors and warnings should be added (or filtered)
2051
+ // TODO: [🧠] !!! errors, warning, isSuccessful are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
2052
+ // Also maybe move `ExecutionTask.currentValue.usage` -> `ExecutionTask.usage`
2053
+ // And delete `ExecutionTask.currentValue.preparedPipeline`
2054
+ assertsTaskSuccessful(executionResult);
2055
+ status = 'FINISHED';
2056
+ currentValue = jsonStringsToJsons(executionResult);
2057
+ // <- TODO: Convert JSON values in string to JSON objects
2058
+ partialResultSubject.next(executionResult);
2009
2059
  }
2010
2060
  catch (error) {
2061
+ status = 'ERROR';
2062
+ errors.push(error);
2011
2063
  partialResultSubject.error(error);
2012
2064
  }
2013
2065
  }
@@ -2024,12 +2076,33 @@ function createTask(options) {
2024
2076
  return {
2025
2077
  taskType,
2026
2078
  taskId,
2079
+ get status() {
2080
+ return status;
2081
+ // <- Note: [1] Theese must be getters to allow changing the value in the future
2082
+ },
2083
+ get createdAt() {
2084
+ return createdAt;
2085
+ // <- Note: [1]
2086
+ },
2087
+ get updatedAt() {
2088
+ return updatedAt;
2089
+ // <- Note: [1]
2090
+ },
2027
2091
  asPromise,
2028
2092
  asObservable() {
2029
2093
  return partialResultSubject.asObservable();
2030
2094
  },
2095
+ get errors() {
2096
+ return errors;
2097
+ // <- Note: [1]
2098
+ },
2099
+ get warnings() {
2100
+ return warnings;
2101
+ // <- Note: [1]
2102
+ },
2031
2103
  get currentValue() {
2032
- return partialResultSubject.value;
2104
+ return currentValue;
2105
+ // <- Note: [1]
2033
2106
  },
2034
2107
  };
2035
2108
  }
@@ -4688,7 +4761,7 @@ async function executeAttempts(options) {
4688
4761
  Last result:
4689
4762
  ${block($ongoingTaskResult.$resultString === null
4690
4763
  ? 'null'
4691
- : $ongoingTaskResult.$resultString
4764
+ : spaceTrim$1($ongoingTaskResult.$resultString)
4692
4765
  .split('\n')
4693
4766
  .map((line) => `> ${line}`)
4694
4767
  .join('\n'))}