@promptbook/legacy-documents 0.71.0-20 → 0.71.0-23

package/esm/typings/src/_packages/node.index.d.ts

@@ -1,9 +1,9 @@
 import { PROMPTBOOK_VERSION } from '../version';
 import { createCollectionFromDirectory } from '../collection/constructors/createCollectionFromDirectory';
+import { $provideExecutablesForNode } from '../executables/$provideExecutablesForNode';
 import { $provideExecutionToolsForNode } from '../execution/utils/$provideExecutionToolsForNode';
 import { $provideLlmToolsConfigurationFromEnv } from '../llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv';
 import { $provideLlmToolsFromEnv } from '../llm-providers/_common/register/$provideLlmToolsFromEnv';
-import { $provideExecutablesForNode } from '../scrapers/_common/register/$provideExecutablesForNode';
 import { $provideFilesystemForNode } from '../scrapers/_common/register/$provideFilesystemForNode';
 import { $provideScrapersForNode } from '../scrapers/_common/register/$provideScrapersForNode';
 import { FileCacheStorage } from '../storage/file-cache-storage/FileCacheStorage';
@@ -11,10 +11,10 @@ import { $execCommand } from '../utils/execCommand/$execCommand';
 import { $execCommands } from '../utils/execCommand/$execCommands';
 export { PROMPTBOOK_VERSION };
 export { createCollectionFromDirectory };
+export { $provideExecutablesForNode };
 export { $provideExecutionToolsForNode };
 export { $provideLlmToolsConfigurationFromEnv };
 export { $provideLlmToolsFromEnv };
-export { $provideExecutablesForNode };
 export { $provideFilesystemForNode };
 export { $provideScrapersForNode };
 export { FileCacheStorage };

package/esm/typings/src/_packages/types.index.d.ts

@@ -14,6 +14,7 @@ import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
 import type { renderPipelineMermaidOptions } from '../conversion/prettify/renderPipelineMermaidOptions';
 import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
 import type { ErrorJson } from '../errors/utils/ErrorJson';
+import type { LocateAppOptions } from '../executables/locateApp';
 import type { AvailableModel } from '../execution/AvailableModel';
 import type { CommonToolsOptions } from '../execution/CommonToolsOptions';
 import type { CreatePipelineExecutorOptions } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorOptions';
@@ -254,6 +255,7 @@ export type { PrettifyOptions };
 export type { renderPipelineMermaidOptions };
 export type { CallbackInterfaceToolsOptions };
 export type { ErrorJson };
+export type { LocateAppOptions };
 export type { AvailableModel };
 export type { CommonToolsOptions };
 export type { CreatePipelineExecutorOptions };

package/esm/typings/src/{scrapers/_common/register → executables}/$provideExecutablesForNode.d.ts

@@ -1,5 +1,5 @@
-import type { Executables } from '../../../execution/Executables';
-import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { Executables } from '../execution/Executables';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
 /**
  * @@@
  *
@@ -7,6 +7,6 @@ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeO
  */
 export declare function $provideExecutablesForNode(options?: PrepareAndScrapeOptions): Promise<Executables>;
 /**
- * TODO: [🧠] THis should be maybe in different folder
+ * TODO: [🧠] Allow to override the executables without need to call `locatePandoc` / `locateLibreoffice` in case of provided
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/executables/apps/locateLibreoffice.d.ts

@@ -0,0 +1,11 @@
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateLibreoffice(): Promise<string_executable_path>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/legacy-documents`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/executables/apps/locateLibreoffice.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/executables/apps/locatePandoc.d.ts

@@ -0,0 +1,11 @@
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locatePandoc(): Promise<string_executable_path>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/documents`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/executables/apps/locatePandoc.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/executables/locateApp.d.ts

@@ -0,0 +1,33 @@
+import type { RequireAtLeastOne } from 'type-fest';
+import type { string_executable_path } from '../types/typeAliases';
+/**
+ * Options for locating any application
+ */
+export interface LocateAppOptions {
+    /**
+     * Name of the application
+     */
+    appName: string;
+    /**
+     * Name of the executable on Linux
+     */
+    linuxWhich?: string;
+    /**
+     * Path suffix on Windows
+     */
+    windowsSuffix?: string;
+    /**
+     * Name of the application on macOS
+     */
+    macOsName?: string;
+}
+/**
+ * Locates an application on the system
+ *
+ * @private within the repository
+ */
+export declare function locateApp(options: RequireAtLeastOne<LocateAppOptions, 'linuxWhich' | 'windowsSuffix' | 'macOsName'>): Promise<string_executable_path>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/executables/locateApp.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts

@@ -0,0 +1,12 @@
+import type { LocateAppOptions } from '../locateApp';
+import type { string_executable_path } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateAppOnLinux({ appName, linuxWhich, }: Pick<Required<LocateAppOptions>, 'appName' | 'linuxWhich'>): Promise<string_executable_path>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts

@@ -0,0 +1,12 @@
+import type { string_executable_path } from '../../types/typeAliases';
+import type { LocateAppOptions } from '../locateApp';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateAppOnMacOs({ appName, macOsName, }: Pick<Required<LocateAppOptions>, 'appName' | 'macOsName'>): Promise<string_executable_path>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts

@@ -0,0 +1,12 @@
+import type { string_executable_path } from '../../types/typeAliases';
+import type { LocateAppOptions } from '../locateApp';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+export declare function locateAppOnWindows({ appName, windowsSuffix, }: Pick<Required<LocateAppOptions>, 'appName' | 'windowsSuffix'>): Promise<string_executable_path>;
+/**
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/scrapers/_common/Scraper.d.ts

@@ -51,12 +51,9 @@ export type ScraperSourceHandler = {
      * Get the content as a utf-8 string
      */
     asText(): Promisable<string>;
-    /**
-     * Get the content as a blob
-     */
-    asBlob(): Promisable<Blob>;
 };
 /**
+ * TODO: [🥽] Add ` asBlob(): Promisable<Blob>;` or asFile
  * TODO: [🐝] @@@ Annotate all
  * TODO: [🔼] Export via types
  */

package/esm/typings/src/utils/files/isExecutable.d.ts

@@ -0,0 +1,11 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+/**
+ * Checks if the file is executable
+ *
+ * @private within the repository
+ */
+export declare function isExecutable(path: string, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🖇] What about symlinks?
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/legacy-documents",
-    "version": "0.71.0-20",
+    "version": "0.71.0-23",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -52,7 +52,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/legacy-documents.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.71.0-20"
+        "@promptbook/core": "0.71.0-23"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -15,7 +15,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.71.0-19';
+    var PROMPTBOOK_VERSION = '0.71.0-22';
     // TODO: [main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -3099,7 +3099,6 @@
      * TODO: [®] DRY Register logic
      */
 
-    // TODO: !!!!!!last - Maybe delete this function
     /**
      * Creates a message with all registered scrapers
      *
@@ -3241,7 +3240,7 @@
         return __awaiter(this, void 0, void 0, function () {
             var sourceContent, name, _b, _c, rootDirname, _d, 
             // <- TODO: process.cwd() if running in Node.js
-            isVerbose, url, response_1, mimeType, filename_1, fileExtension, mimeType_1;
+            isVerbose, url, response_1, mimeType, filename_1, fileExtension, mimeType;
             return __generator(this, function (_e) {
                 switch (_e.label) {
                     case 0:
@@ -3263,19 +3262,14 @@
                                 filename: null,
                                 url: url,
                                 mimeType: mimeType,
-                                asBlob: function () {
-                                    return __awaiter(this, void 0, void 0, function () {
-                                        var content;
-                                        return __generator(this, function (_a) {
-                                            switch (_a.label) {
-                                                case 0: return [4 /*yield*/, response_1.blob()];
-                                                case 1:
-                                                    content = _a.sent();
-                                                    return [2 /*return*/, content];
-                                            }
-                                        });
-                                    });
-                                },
+                                /*
+                                TODO: [🥽]
+                                    > async asBlob() {
+                                    >     // TODO: [👨🏻‍🤝‍👨🏻] This can be called multiple times BUT when called second time, response in already consumed
+                                    >     const content = await response.blob();
+                                    >     return content;
+                                    > },
+                                */
                                 asJson: function () {
                                     return __awaiter(this, void 0, void 0, function () {
                                         var content;
@@ -3315,34 +3309,31 @@
                         }
                         filename_1 = path.join(rootDirname, sourceContent).split('\\').join('/');
                         fileExtension = getFileExtension(filename_1);
-                        mimeType_1 = extensionToMimeType(fileExtension || '');
+                        mimeType = extensionToMimeType(fileExtension || '');
                         return [4 /*yield*/, isFileExisting(filename_1, tools.fs)];
                     case 3:
                         if (!(_e.sent())) {
                             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(filename_1), "\n                      "); }));
                         }
-                        // TODO: !!!!!! Test security file - file is scoped to the project (maybe do this in `filesystemTools`)
+                        // TODO: [🧠][😿] Test security file - file is scoped to the project (BUT maybe do this in `filesystemTools`)
                         return [2 /*return*/, {
                                 source: name,
                                 filename: filename_1,
                                 url: null,
-                                mimeType: mimeType_1,
-                                asBlob: function () {
-                                    return __awaiter(this, void 0, void 0, function () {
-                                        var content;
-                                        return __generator(this, function (_a) {
-                                            switch (_a.label) {
-                                                case 0: return [4 /*yield*/, tools.fs.readFile(filename_1)];
-                                                case 1:
-                                                    content = _a.sent();
-                                                    return [2 /*return*/, new Blob([
-                                                            content,
-                                                            // <- TODO: !!!!!! Test that this is working
-                                                        ], { type: mimeType_1 })];
-                                            }
-                                        });
-                                    });
-                                },
+                                mimeType: mimeType,
+                                /*
+                                TODO: [🥽]
+                                    > async asBlob() {
+                                    >     const content = await tools.fs!.readFile(filename);
+                                    >     return new Blob(
+                                    >         [
+                                    >             content,
+                                    >             // <- TODO: [🥽] This is NOT tested, test it
+                                    >         ],
+                                    >         { type: mimeType },
+                                    >     );
+                                    > },
+                                */
                                 asJson: function () {
                                     return __awaiter(this, void 0, void 0, function () {
                                         var _a, _b;
@@ -3378,9 +3369,14 @@
                             asJson: function () {
                                 throw new UnexpectedError('Did not expect that `markdownScraper` would need to get the content `asJson`');
                             },
-                            asBlob: function () {
-                                throw new UnexpectedError('Did not expect that `markdownScraper` would need to get the content `asBlob`');
-                            },
+                            /*
+                            TODO: [🥽]
+                                > asBlob() {
+                                >     throw new UnexpectedError(
+                                >         'Did not expect that `markdownScraper` would need to get the content `asBlob`',
+                                >     );
+                                > },
+                            */
                         }];
                 }
             });
@@ -6035,9 +6031,14 @@
                                 asJson: function () {
                                     throw new UnexpectedError('Did not expect that `markdownScraper` would need to get the content `asJson`');
                                 },
-                                asBlob: function () {
-                                    throw new UnexpectedError('Did not expect that `markdownScraper` would need to get the content `asBlob`');
-                                },
+                                /*
+                                TODO: [🥽]
+                                    > asBlob() {
+                                    >     throw new UnexpectedError(
+                                    >         'Did not expect that `markdownScraper` would need to get the content `asBlob`',
+                                    >     );
+                                    > },
+                                */
                             };
                             knowledge = this.markdownScraper.scrape(markdownSource);
                             return [4 /*yield*/, cacheFilehandler.destroy()];
@@ -6203,9 +6204,14 @@
                                 asJson: function () {
                                     throw new UnexpectedError('Did not expect that `documentScraper` would need to get the content `asJson`');
                                 },
-                                asBlob: function () {
-                                    throw new UnexpectedError('Did not expect that `documentScraper` would need to get the content `asBlob`');
-                                },
+                                /*
+                                TODO: [🥽]
+                                    > asBlob() {
+                                    >     throw new UnexpectedError(
+                                    >         'Did not expect that `documentScraper` would need to get the content `asBlob`',
+                                    >     );
+                                    > },
+                                */
                             };
                             knowledge = this.documentScraper.scrape(markdownSource);
                             return [4 /*yield*/, cacheFilehandler.destroy()];