@promptbook/markdown-utils 0.92.0-5 → 0.92.0-6

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 (14) hide show
  1. package/esm/index.es.js +114 -8
  2. package/esm/index.es.js.map +1 -1
  3. package/esm/typings/src/_packages/core.index.d.ts +4 -0
  4. package/esm/typings/src/_packages/utils.index.d.ts +2 -0
  5. package/esm/typings/src/cli/common/$provideLlmToolsForCli.d.ts +1 -1
  6. package/esm/typings/src/conversion/archive/loadArchive.d.ts +2 -2
  7. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +12 -0
  8. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts +5 -0
  9. package/esm/typings/src/formats/json/utils/jsonParse.d.ts +11 -0
  10. package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +43 -0
  11. package/esm/typings/src/remote-server/openapi.d.ts +397 -3
  12. package/package.json +1 -1
  13. package/umd/index.umd.js +114 -8
  14. package/umd/index.umd.js.map +1 -1
package/esm/typings/src/_packages/core.index.d.ts CHANGED
@@ -91,6 +91,8 @@ import { filterModels } from '../llm-providers/_common/filterModels';
91
91
  import { $llmToolsMetadataRegister } from '../llm-providers/_common/register/$llmToolsMetadataRegister';
92
92
  import { $llmToolsRegister } from '../llm-providers/_common/register/$llmToolsRegister';
93
93
  import { createLlmToolsFromConfiguration } from '../llm-providers/_common/register/createLlmToolsFromConfiguration';
94
+ import { MODEL_TRUST_LEVEL } from '../llm-providers/_common/register/LlmToolsMetadata';
95
+ import { MODEL_ORDER } from '../llm-providers/_common/register/LlmToolsMetadata';
94
96
  import { cacheLlmTools } from '../llm-providers/_common/utils/cache/cacheLlmTools';
95
97
  import { countUsage } from '../llm-providers/_common/utils/count-total-usage/countUsage';
96
98
  import { limitTotalUsage } from '../llm-providers/_common/utils/count-total-usage/limitTotalUsage';
@@ -230,6 +232,8 @@ export { filterModels };
230
232
  export { $llmToolsMetadataRegister };
231
233
  export { $llmToolsRegister };
232
234
  export { createLlmToolsFromConfiguration };
235
+ export { MODEL_TRUST_LEVEL };
236
+ export { MODEL_ORDER };
233
237
  export { cacheLlmTools };
234
238
  export { countUsage };
235
239
  export { limitTotalUsage };
package/esm/typings/src/_packages/utils.index.d.ts CHANGED
@@ -7,6 +7,7 @@ import { serializeError } from '../errors/utils/serializeError';
7
7
  import { forEachAsync } from '../execution/utils/forEachAsync';
8
8
  import { isValidCsvString } from '../formats/csv/utils/isValidCsvString';
9
9
  import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
10
+ import { jsonParse } from '../formats/json/utils/jsonParse';
10
11
  import { isValidXmlString } from '../formats/xml/utils/isValidXmlString';
11
12
  import { prompt } from '../pipeline/prompt-notation';
12
13
  import { promptTemplate } from '../pipeline/prompt-notation';
@@ -91,6 +92,7 @@ export { serializeError };
91
92
  export { forEachAsync };
92
93
  export { isValidCsvString };
93
94
  export { isValidJsonString };
95
+ export { jsonParse };
94
96
  export { isValidXmlString };
95
97
  export { prompt };
96
98
  export { promptTemplate };
package/esm/typings/src/cli/common/$provideLlmToolsForCli.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import type { LlmExecutionToolsWithTotalUsage } from '../../llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
2
1
  import type { CacheLlmToolsOptions } from '../../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
2
+ import type { LlmExecutionToolsWithTotalUsage } from '../../llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
3
3
  import type { string_promptbook_server_url } from '../../types/typeAliases';
4
4
  type ProvideLlmToolsForCliOptions = Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & {
5
5
  /**
package/esm/typings/src/conversion/archive/loadArchive.d.ts CHANGED
@@ -1,6 +1,6 @@
1
+ import type { FilesystemTools } from '../../execution/FilesystemTools';
1
2
  import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
2
3
  import type { string_filename } from '../../types/typeAliases';
3
- import type { FilesystemTools } from '../../execution/FilesystemTools';
4
4
  /**
5
5
  * Loads the books from the archive file with `.bookc` extension
6
6
  *
@@ -10,7 +10,7 @@ import type { FilesystemTools } from '../../execution/FilesystemTools';
10
10
  *
11
11
  * @private utility of Prompbook
12
12
  */
13
- export declare function loadArchive(filePath: string_filename, fs: FilesystemTools): Promise<Array<PipelineJson>>;
13
+ export declare function loadArchive(filePath: string_filename, fs: FilesystemTools): Promise<ReadonlyArray<PipelineJson>>;
14
14
  /**
15
15
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
16
16
  */
package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts CHANGED
@@ -3,12 +3,17 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
3
3
  import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
4
4
  import type { string_markdown } from '../../types/typeAliases';
5
5
  import type { string_parameter_value } from '../../types/typeAliases';
6
+ import type { ExecutionTools } from '../ExecutionTools';
6
7
  /**
7
8
  * @@@
8
9
  *
9
10
  * @private internal type of `getKnowledgeFoTask`
10
11
  */
11
12
  type GetKnowledgeForTaskOptions = {
13
+ /**
14
+ * The execution tools to be used during the execution of the pipeline
15
+ */
16
+ readonly tools: ExecutionTools;
12
17
  /**
13
18
  * @@@
14
19
  */
@@ -21,7 +26,14 @@ type GetKnowledgeForTaskOptions = {
21
26
  /**
22
27
  * @@@
23
28
  *
29
+ * Here is the place where RAG (retrieval-augmented generation) happens
30
+ *
24
31
  * @private internal utility of `createPipelineExecutor`
25
32
  */
26
33
  export declare function getKnowledgeForTask(options: GetKnowledgeForTaskOptions): Promise<string_parameter_value & string_markdown>;
27
34
  export {};
35
+ /**
36
+ * TODO: !!!! Verify if this is working
37
+ * TODO: [♨] Implement Better - use keyword search
38
+ * TODO: [♨] Examples of values
39
+ */
package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts CHANGED
@@ -2,12 +2,17 @@ import type { ReadonlyDeep } from 'type-fest';
2
2
  import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
3
3
  import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
4
4
  import type { ReservedParameters } from '../../types/typeAliases';
5
+ import type { ExecutionTools } from '../ExecutionTools';
5
6
  /**
6
7
  * @@@
7
8
  *
8
9
  * @private internal type of `getReservedParametersForTask`
9
10
  */
10
11
  type GetReservedParametersForTaskOptions = {
12
+ /**
13
+ * The execution tools to be used during the execution of the pipeline
14
+ */
15
+ readonly tools: ExecutionTools;
11
16
  /**
12
17
  * @@@
13
18
  */
package/esm/typings/src/formats/json/utils/jsonParse.d.ts ADDED
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Converts a JavaScript Object Notation (JSON) string into an object.
3
+ *
4
+ * Note: This is wrapper around `JSON.parse()` with better error and type handling
5
+ *
6
+ * @public exported from `@promptbook/utils`
7
+ */
8
+ export declare function jsonParse<T>(value: string): T;
9
+ /**
10
+ * TODO: !!!! Use in Promptbook.studio
11
+ */
package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts CHANGED
@@ -3,6 +3,41 @@ import type { string_title } from '../../../types/typeAliases';
3
3
  import type { Registered } from '../../../utils/$Register';
4
4
  import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
5
5
  import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
6
+ /**
7
+ * How is the model provider trusted?
8
+ *
9
+ * @public exported from `@promptbook/core`
10
+ */
11
+ export declare const MODEL_TRUST_LEVEL: {
12
+ readonly FULL: "Model is running on the local machine, training data and model weights are known, data are ethically sourced";
13
+ readonly OPEN: "Model is open source, training data and model weights are known";
14
+ readonly PARTIALLY_OPEN: "Model is open source, but training data and model weights are not (fully) known";
15
+ readonly CLOSED_LOCAL: "Model can be run locally, but it is not open source";
16
+ readonly CLOSED_FREE: "Model is behind API gateway but free to use";
17
+ readonly CLOSED_BUSINESS: "Model is behind API gateway and paid but has good SLA, TOS, privacy policy and in general is a good to use in business applications";
18
+ readonly CLOSED: "Model is behind API gateway and paid";
19
+ readonly UNTRUSTED: "Model has questions about the training data and ethics, but it is not known if it is a problem or not";
20
+ readonly VURNABLE: "Model has some known serious vulnerabilities, leaks, ethical problems, etc.";
21
+ };
22
+ /**
23
+ * How is the model provider important?
24
+ *
25
+ * @public exported from `@promptbook/core`
26
+ */
27
+ export declare const MODEL_ORDER: {
28
+ /**
29
+ * Top-tier models, e.g. OpenAI, Anthropic,...
30
+ */
31
+ readonly TOP_TIER: 333;
32
+ /**
33
+ * Mid-tier models, e.g. Llama, Mistral, etc.
34
+ */
35
+ readonly NORMAL: 100;
36
+ /**
37
+ * Low-tier models, e.g. Phi, Tiny, etc.
38
+ */
39
+ readonly LOW_TIER: 0;
40
+ };
6
41
  /**
7
42
  * @@@
8
43
  *
@@ -13,6 +48,14 @@ export type LlmToolsMetadata = Registered & {
13
48
  * @@@
14
49
  */
15
50
  readonly title: string_title;
51
+ /**
52
+ * How is the model is trusted?
53
+ */
54
+ readonly trustLevel: keyof typeof MODEL_TRUST_LEVEL;
55
+ /**
56
+ * How is the model provider important and should be sorted in the list of available providers?
57
+ */
58
+ readonly order: typeof MODEL_ORDER[keyof typeof MODEL_ORDER] | number;
16
59
  /**
17
60
  * List of environment variables that can be used to configure the provider
18
61
  *
package/esm/typings/src/remote-server/openapi.d.ts CHANGED
@@ -16,6 +16,13 @@ export declare const openapiJson: {
16
16
  responses: {
17
17
  '200': {
18
18
  description: string;
19
+ content: {
20
+ 'text/markdown': {
21
+ schema: {
22
+ type: string;
23
+ };
24
+ };
25
+ };
19
26
  };
20
27
  };
21
28
  };
@@ -46,13 +53,22 @@ export declare const openapiJson: {
46
53
  };
47
54
  };
48
55
  responses: {
49
- '200': {
56
+ '201': {
50
57
  description: string;
51
58
  content: {
52
59
  'application/json': {
53
60
  schema: {
54
61
  type: string;
55
62
  properties: {
63
+ isSuccess: {
64
+ type: string;
65
+ };
66
+ message: {
67
+ type: string;
68
+ };
69
+ error: {
70
+ type: string;
71
+ };
56
72
  identification: {
57
73
  type: string;
58
74
  };
@@ -61,6 +77,43 @@ export declare const openapiJson: {
61
77
  };
62
78
  };
63
79
  };
80
+ '400': {
81
+ description: string;
82
+ content: {
83
+ 'application/json': {
84
+ schema: {
85
+ type: string;
86
+ properties: {
87
+ error: {
88
+ type: string;
89
+ };
90
+ };
91
+ };
92
+ };
93
+ };
94
+ };
95
+ '401': {
96
+ description: string;
97
+ content: {
98
+ 'application/json': {
99
+ schema: {
100
+ type: string;
101
+ properties: {
102
+ isSuccess: {
103
+ type: string;
104
+ enum: boolean[];
105
+ };
106
+ message: {
107
+ type: string;
108
+ };
109
+ error: {
110
+ type: string;
111
+ };
112
+ };
113
+ };
114
+ };
115
+ };
116
+ };
64
117
  };
65
118
  };
66
119
  };
@@ -82,6 +135,16 @@ export declare const openapiJson: {
82
135
  };
83
136
  };
84
137
  };
138
+ '500': {
139
+ description: string;
140
+ content: {
141
+ 'text/plain': {
142
+ schema: {
143
+ type: string;
144
+ };
145
+ };
146
+ };
147
+ };
85
148
  };
86
149
  };
87
150
  };
@@ -111,6 +174,28 @@ export declare const openapiJson: {
111
174
  };
112
175
  '404': {
113
176
  description: string;
177
+ content: {
178
+ 'application/json': {
179
+ schema: {
180
+ type: string;
181
+ properties: {
182
+ error: {
183
+ type: string;
184
+ };
185
+ };
186
+ };
187
+ };
188
+ };
189
+ };
190
+ '500': {
191
+ description: string;
192
+ content: {
193
+ 'text/plain': {
194
+ schema: {
195
+ type: string;
196
+ };
197
+ };
198
+ };
114
199
  };
115
200
  };
116
201
  };
@@ -128,11 +213,172 @@ export declare const openapiJson: {
128
213
  type: string;
129
214
  items: {
130
215
  type: string;
216
+ properties: {
217
+ nonce: {
218
+ type: string;
219
+ };
220
+ taskId: {
221
+ type: string;
222
+ };
223
+ taskType: {
224
+ type: string;
225
+ };
226
+ status: {
227
+ type: string;
228
+ };
229
+ createdAt: {
230
+ type: string;
231
+ format: string;
232
+ };
233
+ updatedAt: {
234
+ type: string;
235
+ format: string;
236
+ };
237
+ };
238
+ };
239
+ };
240
+ };
241
+ };
242
+ };
243
+ };
244
+ };
245
+ };
246
+ '/executions/last': {
247
+ get: {
248
+ summary: string;
249
+ description: string;
250
+ responses: {
251
+ '200': {
252
+ description: string;
253
+ content: {
254
+ 'application/json': {
255
+ schema: {
256
+ type: string;
257
+ properties: {
258
+ nonce: {
259
+ type: string;
260
+ };
261
+ taskId: {
262
+ type: string;
263
+ };
264
+ taskType: {
265
+ type: string;
266
+ };
267
+ status: {
268
+ type: string;
269
+ };
270
+ errors: {
271
+ type: string;
272
+ items: {
273
+ type: string;
274
+ };
275
+ };
276
+ warnings: {
277
+ type: string;
278
+ items: {
279
+ type: string;
280
+ };
281
+ };
282
+ createdAt: {
283
+ type: string;
284
+ format: string;
285
+ };
286
+ updatedAt: {
287
+ type: string;
288
+ format: string;
289
+ };
290
+ currentValue: {
291
+ type: string;
292
+ };
293
+ };
294
+ };
295
+ };
296
+ };
297
+ };
298
+ '404': {
299
+ description: string;
300
+ content: {
301
+ 'text/plain': {
302
+ schema: {
303
+ type: string;
304
+ };
305
+ };
306
+ };
307
+ };
308
+ };
309
+ };
310
+ };
311
+ '/executions/{taskId}': {
312
+ get: {
313
+ summary: string;
314
+ description: string;
315
+ parameters: {
316
+ in: string;
317
+ name: string;
318
+ required: boolean;
319
+ schema: {
320
+ type: string;
321
+ };
322
+ description: string;
323
+ }[];
324
+ responses: {
325
+ '200': {
326
+ description: string;
327
+ content: {
328
+ 'application/json': {
329
+ schema: {
330
+ type: string;
331
+ properties: {
332
+ nonce: {
333
+ type: string;
334
+ };
335
+ taskId: {
336
+ type: string;
337
+ };
338
+ taskType: {
339
+ type: string;
340
+ };
341
+ status: {
342
+ type: string;
343
+ };
344
+ errors: {
345
+ type: string;
346
+ items: {
347
+ type: string;
348
+ };
349
+ };
350
+ warnings: {
351
+ type: string;
352
+ items: {
353
+ type: string;
354
+ };
355
+ };
356
+ createdAt: {
357
+ type: string;
358
+ format: string;
359
+ };
360
+ updatedAt: {
361
+ type: string;
362
+ format: string;
363
+ };
364
+ currentValue: {
365
+ type: string;
366
+ };
131
367
  };
132
368
  };
133
369
  };
134
370
  };
135
371
  };
372
+ '404': {
373
+ description: string;
374
+ content: {
375
+ 'text/plain': {
376
+ schema: {
377
+ type: string;
378
+ };
379
+ };
380
+ };
381
+ };
136
382
  };
137
383
  };
138
384
  };
@@ -149,12 +395,19 @@ export declare const openapiJson: {
149
395
  properties: {
150
396
  pipelineUrl: {
151
397
  type: string;
398
+ description: string;
399
+ };
400
+ book: {
401
+ type: string;
402
+ description: string;
152
403
  };
153
404
  inputParameters: {
154
405
  type: string;
406
+ description: string;
155
407
  };
156
408
  identification: {
157
409
  type: string;
410
+ description: string;
158
411
  };
159
412
  };
160
413
  };
@@ -174,13 +427,154 @@ export declare const openapiJson: {
174
427
  };
175
428
  '400': {
176
429
  description: string;
430
+ content: {
431
+ 'application/json': {
432
+ schema: {
433
+ type: string;
434
+ properties: {
435
+ error: {
436
+ type: string;
437
+ };
438
+ };
439
+ };
440
+ };
441
+ };
442
+ };
443
+ '404': {
444
+ description: string;
445
+ content: {
446
+ 'text/plain': {
447
+ schema: {
448
+ type: string;
449
+ };
450
+ };
451
+ };
452
+ };
453
+ };
454
+ };
455
+ };
456
+ '/api-docs': {
457
+ get: {
458
+ summary: string;
459
+ description: string;
460
+ responses: {
461
+ '200': {
462
+ description: string;
463
+ };
464
+ };
465
+ };
466
+ };
467
+ '/swagger': {
468
+ get: {
469
+ summary: string;
470
+ description: string;
471
+ responses: {
472
+ '200': {
473
+ description: string;
474
+ };
475
+ };
476
+ };
477
+ };
478
+ '/openapi': {
479
+ get: {
480
+ summary: string;
481
+ description: string;
482
+ responses: {
483
+ '200': {
484
+ description: string;
485
+ content: {
486
+ 'application/json': {
487
+ schema: {
488
+ type: string;
489
+ };
490
+ };
491
+ };
177
492
  };
178
493
  };
179
494
  };
180
495
  };
181
496
  };
182
- components: {};
183
- tags: never[];
497
+ components: {
498
+ schemas: {
499
+ Error: {
500
+ type: string;
501
+ properties: {
502
+ error: {
503
+ type: string;
504
+ };
505
+ };
506
+ };
507
+ ExecutionTaskSummary: {
508
+ type: string;
509
+ properties: {
510
+ nonce: {
511
+ type: string;
512
+ };
513
+ taskId: {
514
+ type: string;
515
+ };
516
+ taskType: {
517
+ type: string;
518
+ };
519
+ status: {
520
+ type: string;
521
+ };
522
+ createdAt: {
523
+ type: string;
524
+ format: string;
525
+ };
526
+ updatedAt: {
527
+ type: string;
528
+ format: string;
529
+ };
530
+ };
531
+ };
532
+ ExecutionTaskFull: {
533
+ type: string;
534
+ properties: {
535
+ nonce: {
536
+ type: string;
537
+ };
538
+ taskId: {
539
+ type: string;
540
+ };
541
+ taskType: {
542
+ type: string;
543
+ };
544
+ status: {
545
+ type: string;
546
+ };
547
+ errors: {
548
+ type: string;
549
+ items: {
550
+ type: string;
551
+ };
552
+ };
553
+ warnings: {
554
+ type: string;
555
+ items: {
556
+ type: string;
557
+ };
558
+ };
559
+ createdAt: {
560
+ type: string;
561
+ format: string;
562
+ };
563
+ updatedAt: {
564
+ type: string;
565
+ format: string;
566
+ };
567
+ currentValue: {
568
+ type: string;
569
+ };
570
+ };
571
+ };
572
+ };
573
+ };
574
+ tags: {
575
+ name: string;
576
+ description: string;
577
+ }[];
184
578
  };
185
579
  /**
186
580
  * Note: [💞] Ignore a discrepancy between file name and entity name
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/markdown-utils",
3
- "version": "0.92.0-5",
3
+ "version": "0.92.0-6",
4
4
  "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
5
5
  "private": false,
6
6
  "sideEffects": false,