@promptbook/cli 0.84.0-11 → 0.84.0-13

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.
@@ -19,7 +19,8 @@ import { DEFAULT_MAX_EXECUTION_ATTEMPTS } from '../config';
19
19
  import { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH } from '../config';
20
20
  import { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL } from '../config';
21
21
  import { DEFAULT_BOOKS_DIRNAME } from '../config';
22
- import { DEFAULT_EXECUTIONS_CACHE_DIRNAME } from '../config';
22
+ import { DEFAULT_DOWNLOAD_CACHE_DIRNAME } from '../config';
23
+ import { DEFAULT_EXECUTION_CACHE_DIRNAME } from '../config';
23
24
  import { DEFAULT_SCRAPE_CACHE_DIRNAME } from '../config';
24
25
  import { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME } from '../config';
25
26
  import { DEFAULT_REMOTE_URL } from '../config';
@@ -145,7 +146,8 @@ export { DEFAULT_MAX_EXECUTION_ATTEMPTS };
145
146
  export { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH };
146
147
  export { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL };
147
148
  export { DEFAULT_BOOKS_DIRNAME };
148
- export { DEFAULT_EXECUTIONS_CACHE_DIRNAME };
149
+ export { DEFAULT_DOWNLOAD_CACHE_DIRNAME };
150
+ export { DEFAULT_EXECUTION_CACHE_DIRNAME };
149
151
  export { DEFAULT_SCRAPE_CACHE_DIRNAME };
150
152
  export { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME };
151
153
  export { DEFAULT_REMOTE_URL };
@@ -166,6 +166,14 @@ export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
166
166
  * @public exported from `@promptbook/core`
167
167
  */
168
168
  export declare const DEFAULT_BOOKS_DIRNAME = "./books";
169
+ /**
170
+ * Where to store the temporary downloads
171
+ *
172
+ * Note: When the folder does not exist, it is created recursively
173
+ *
174
+ * @public exported from `@promptbook/core`
175
+ */
176
+ export declare const DEFAULT_DOWNLOAD_CACHE_DIRNAME = "./.promptbook/download-cache";
169
177
  /**
170
178
  * Where to store the cache of executions for promptbook CLI
171
179
  *
@@ -173,7 +181,7 @@ export declare const DEFAULT_BOOKS_DIRNAME = "./books";
173
181
  *
174
182
  * @public exported from `@promptbook/core`
175
183
  */
176
- export declare const DEFAULT_EXECUTIONS_CACHE_DIRNAME = "./.promptbook/executions-cache";
184
+ export declare const DEFAULT_EXECUTION_CACHE_DIRNAME = "./.promptbook/execution-cache";
177
185
  /**
178
186
  * Where to store the scrape cache
179
187
  *
@@ -3,7 +3,7 @@ import type fs from 'fs/promises';
3
3
  /**
4
4
  * Container for all the tools needed to manipulate with filesystem
5
5
  */
6
- export type FilesystemTools = Pick<typeof fs, 'access' | 'constants' | 'readFile' | 'writeFile' | 'stat' | 'readdir'>;
6
+ export type FilesystemTools = Pick<typeof fs, 'access' | 'constants' | 'readFile' | 'writeFile' | 'stat' | 'readdir' | 'mkdir'>;
7
7
  /**
8
8
  * TODO: Implement destroyable pattern to free resources
9
9
  */
@@ -6,6 +6,7 @@ import type { PipelineString } from '../pipeline/PipelineString';
6
6
  import type { TaskProgress } from '../types/TaskProgress';
7
7
  import type { InputParameters } from '../types/typeAliases';
8
8
  import type { string_filename } from '../types/typeAliases';
9
+ import type { string_parameter_value } from '../types/typeAliases';
9
10
  import type { string_pipeline_url } from '../types/typeAliases';
10
11
  /**
11
12
  * Wizzard for simple usage of the Promptbook
@@ -27,7 +28,12 @@ declare class Wizzard {
27
28
  *
28
29
  * Note: This works simmilar to the `ptbk run` command
29
30
  */
30
- execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
31
+ execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
32
+ /**
33
+ * Simple result of the execution
34
+ */
35
+ result: string_parameter_value;
36
+ } & PipelineExecutorResult>;
31
37
  private executionTools;
32
38
  /**
33
39
  * Provides the tools automatically for the Node.js environment
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/cli",
3
- "version": "0.84.0-11",
3
+ "version": "0.84.0-13",
4
4
  "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
5
5
  "--note-0": " <- [🐊]",
6
6
  "private": false,
package/umd/index.umd.js CHANGED
@@ -51,7 +51,7 @@
51
51
  * @generated
52
52
  * @see https://github.com/webgptorg/promptbook
53
53
  */
54
- var PROMPTBOOK_ENGINE_VERSION = '0.84.0-10';
54
+ var PROMPTBOOK_ENGINE_VERSION = '0.84.0-12';
55
55
  /**
56
56
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
57
57
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -327,6 +327,14 @@
327
327
  */
328
328
  var DEFAULT_BOOKS_DIRNAME = './books';
329
329
  // <- TODO: [🕝] Make also `BOOKS_DIRNAME_ALTERNATIVES`
330
+ /**
331
+ * Where to store the temporary downloads
332
+ *
333
+ * Note: When the folder does not exist, it is created recursively
334
+ *
335
+ * @public exported from `@promptbook/core`
336
+ */
337
+ var DEFAULT_DOWNLOAD_CACHE_DIRNAME = './.promptbook/download-cache';
330
338
  /**
331
339
  * Where to store the cache of executions for promptbook CLI
332
340
  *
@@ -334,7 +342,7 @@
334
342
  *
335
343
  * @public exported from `@promptbook/core`
336
344
  */
337
- var DEFAULT_EXECUTIONS_CACHE_DIRNAME = './.promptbook/executions-cache';
345
+ var DEFAULT_EXECUTION_CACHE_DIRNAME = './.promptbook/execution-cache';
338
346
  /**
339
347
  * Where to store the scrape cache
340
348
  *
@@ -529,6 +537,7 @@
529
537
  readFile: promises.readFile,
530
538
  writeFile: promises.writeFile,
531
539
  readdir: promises.readdir,
540
+ mkdir: promises.mkdir,
532
541
  };
533
542
  }
534
543
  /**
@@ -2730,7 +2739,7 @@
2730
2739
  _c.sent()]),
2731
2740
  {
2732
2741
  storage: new FileCacheStorage({ fs: $provideFilesystemForNode() }, {
2733
- rootFolderPath: path.join(process.cwd(), DEFAULT_EXECUTIONS_CACHE_DIRNAME),
2742
+ rootFolderPath: path.join(process.cwd(), DEFAULT_EXECUTION_CACHE_DIRNAME),
2734
2743
  }),
2735
2744
  isCacheReloaded: isCacheReloaded,
2736
2745
  }])];
@@ -6514,10 +6523,11 @@
6514
6523
  function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
6515
6524
  var _a;
6516
6525
  return __awaiter(this, void 0, void 0, function () {
6517
- var _b, fetch, knowledgeSourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
6518
- return __generator(this, function (_f) {
6519
- switch (_f.label) {
6526
+ var _b, fetch, knowledgeSourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, basename, hash, rootDirname_1, filepath, _f, _g, _h, _j, _k, filename_1, fileExtension, mimeType;
6527
+ return __generator(this, function (_l) {
6528
+ switch (_l.label) {
6520
6529
  case 0:
6530
+ console.log('!!! makeKnowledgeSourceHandler', knowledgeSource);
6521
6531
  _b = tools.fetch, fetch = _b === void 0 ? scraperFetch : _b;
6522
6532
  knowledgeSourceContent = knowledgeSource.knowledgeSourceContent;
6523
6533
  name = knowledgeSource.name;
@@ -6525,54 +6535,74 @@
6525
6535
  if (!name) {
6526
6536
  name = knowledgeSourceContentToName(knowledgeSourceContent);
6527
6537
  }
6528
- if (!isValidUrl(knowledgeSourceContent)) return [3 /*break*/, 2];
6538
+ if (!isValidUrl(knowledgeSourceContent)) return [3 /*break*/, 5];
6529
6539
  url = knowledgeSourceContent;
6530
6540
  return [4 /*yield*/, fetch(url)];
6531
6541
  case 1:
6532
- response_1 = _f.sent();
6542
+ response_1 = _l.sent();
6533
6543
  mimeType = ((_a = response_1.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.split(';')[0]) || 'text/html';
6534
- return [2 /*return*/, {
6535
- source: name,
6536
- filename: null,
6537
- url: url,
6538
- mimeType: mimeType,
6539
- /*
6540
- TODO: [🥽]
6541
- > async asBlob() {
6542
- > // TODO: [👨🏻‍🤝‍👨🏻] This can be called multiple times BUT when called second time, response in already consumed
6543
- > const content = await response.blob();
6544
- > return content;
6545
- > },
6546
- */
6547
- asJson: function () {
6548
- return __awaiter(this, void 0, void 0, function () {
6549
- var content;
6550
- return __generator(this, function (_a) {
6551
- switch (_a.label) {
6552
- case 0: return [4 /*yield*/, response_1.json()];
6553
- case 1:
6554
- content = _a.sent();
6555
- return [2 /*return*/, content];
6556
- }
6544
+ if (tools.fs === undefined || !url.endsWith('.pdf')) {
6545
+ return [2 /*return*/, {
6546
+ source: name,
6547
+ filename: null,
6548
+ url: url,
6549
+ mimeType: mimeType,
6550
+ /*
6551
+ TODO: [🥽]
6552
+ > async asBlob() {
6553
+ > // TODO: [👨🏻‍🤝‍👨🏻] This can be called multiple times BUT when called second time, response in already consumed
6554
+ > const content = await response.blob();
6555
+ > return content;
6556
+ > },
6557
+ */
6558
+ asJson: function () {
6559
+ return __awaiter(this, void 0, void 0, function () {
6560
+ var content;
6561
+ return __generator(this, function (_a) {
6562
+ switch (_a.label) {
6563
+ case 0: return [4 /*yield*/, response_1.json()];
6564
+ case 1:
6565
+ content = _a.sent();
6566
+ return [2 /*return*/, content];
6567
+ }
6568
+ });
6557
6569
  });
6558
- });
6559
- },
6560
- asText: function () {
6561
- return __awaiter(this, void 0, void 0, function () {
6562
- var content;
6563
- return __generator(this, function (_a) {
6564
- switch (_a.label) {
6565
- case 0: return [4 /*yield*/, response_1.text()];
6566
- case 1:
6567
- content = _a.sent();
6568
- return [2 /*return*/, content];
6569
- }
6570
+ },
6571
+ asText: function () {
6572
+ return __awaiter(this, void 0, void 0, function () {
6573
+ var content;
6574
+ return __generator(this, function (_a) {
6575
+ switch (_a.label) {
6576
+ case 0: return [4 /*yield*/, response_1.text()];
6577
+ case 1:
6578
+ content = _a.sent();
6579
+ return [2 /*return*/, content];
6580
+ }
6581
+ });
6570
6582
  });
6571
- });
6572
- },
6573
- }];
6583
+ },
6584
+ }];
6585
+ }
6586
+ basename = url.split('/').pop() || titleToName(url);
6587
+ hash = sha256__default["default"](hexEncoder__default["default"].parse(url)).toString( /* hex */);
6588
+ rootDirname_1 = path.join(process.cwd(), DEFAULT_DOWNLOAD_CACHE_DIRNAME);
6589
+ filepath = path.join.apply(void 0, __spreadArray(__spreadArray([], __read(nameToSubfolderPath(hash /* <- TODO: [🎎] Maybe add some SHA256 prefix */)), false), ["".concat(basename.substring(0, MAX_FILENAME_LENGTH), ".pdf")], false));
6590
+ return [4 /*yield*/, tools.fs.mkdir(path.dirname(path.join(rootDirname_1, filepath)), { recursive: true })];
6574
6591
  case 2:
6575
- if (!isValidFilePath(knowledgeSourceContent)) return [3 /*break*/, 4];
6592
+ _l.sent();
6593
+ _g = (_f = tools.fs).writeFile;
6594
+ _h = [path.join(rootDirname_1, filepath)];
6595
+ _k = (_j = Buffer).from;
6596
+ return [4 /*yield*/, response_1.arrayBuffer()];
6597
+ case 3: return [4 /*yield*/, _g.apply(_f, _h.concat([_k.apply(_j, [_l.sent()])]))];
6598
+ case 4:
6599
+ _l.sent();
6600
+ // TODO: !!!!!!!! Check the file security
6601
+ // TODO: !!!!!!!! Check the file size (if it is not too big)
6602
+ // TODO: !!!!!!!! Delete the file
6603
+ return [2 /*return*/, makeKnowledgeSourceHandler({ name: name, knowledgeSourceContent: filepath }, tools, __assign(__assign({}, options), { rootDirname: rootDirname_1 }))];
6604
+ case 5:
6605
+ if (!isValidFilePath(knowledgeSourceContent)) return [3 /*break*/, 7];
6576
6606
  if (tools.fs === undefined) {
6577
6607
  throw new EnvironmentMismatchError('Can not import file knowledge without filesystem tools');
6578
6608
  // <- TODO: [🧠] What is the best error type here`
@@ -6585,8 +6615,8 @@
6585
6615
  fileExtension = getFileExtension(filename_1);
6586
6616
  mimeType = extensionToMimeType(fileExtension || '');
6587
6617
  return [4 /*yield*/, isFileExisting(filename_1, tools.fs)];
6588
- case 3:
6589
- if (!(_f.sent())) {
6618
+ case 6:
6619
+ if (!(_l.sent())) {
6590
6620
  throw new NotFoundError(spaceTrim__default["default"](function (block) { return "\n Can not make source handler for file which does not exist:\n\n File:\n ".concat(block(knowledgeSourceContent), "\n\n Full file path:\n ").concat(block(filename_1), "\n "); }));
6591
6621
  }
6592
6622
  // TODO: [🧠][😿] Test security file - file is scoped to the project (BUT maybe do this in `filesystemTools`)
@@ -6632,7 +6662,7 @@
6632
6662
  });
6633
6663
  },
6634
6664
  }];
6635
- case 4: return [2 /*return*/, {
6665
+ case 7: return [2 /*return*/, {
6636
6666
  source: name,
6637
6667
  filename: null,
6638
6668
  url: null,