@promptbook/remote-server 0.112.0-32 → 0.112.0-34

package/esm/src/utils/files/$induceFileDownload.d.ts

@@ -8,6 +8,4 @@ import type { $side_effect } from '../organization/$side_effect';
  * @public exported from `@promptbook/browser`
  */
 export declare function $induceFileDownload(fileOrBlobOrUrl: File | Blob | URL | string_url): Promise<$side_effect>;
-/**
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
- */
+/** Note: [🔵] Code for browser file helper [$induceFileDownload](src/utils/files/$induceFileDownload.ts) should never be published outside of `@promptbook/browser` */

package/esm/src/utils/files/ObjectUrl.d.ts

@@ -41,6 +41,4 @@ export declare class ObjectUrl extends Registration implements IDestroyable {
      */
     get url(): URL;
 }
-/**
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
- */
+/** Note: [🔵] Code for browser file helper [ObjectUrl](src/utils/files/ObjectUrl.ts) should never be published outside of `@promptbook/browser` */

package/esm/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.112.0-31`).
+ * It follows semantic versioning (e.g., `0.112.0-33`).
  *
  * @generated
  */

package/esm/src/wizard/$getCompiledBook.d.ts

@@ -9,7 +9,5 @@ import type { string_filename, string_pipeline_url } from '../types/typeAliases'
  * @private usable through `ptbk run` and `@promptbook/wizard`
  */
 export declare function $getCompiledBook(tools: Required<Pick<ExecutionTools, 'fs' | 'fetch'>>, pipelineSource: string_filename | string_pipeline_url | PipelineString, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
-/**
- * TODO: Write unit test
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- */
+/** Note: [🟢] Code for Node wizard helper [$getCompiledBook](src/wizard/$getCompiledBook.ts) should never be published into packages that could be imported into browser environment */
+/** TODO: Write unit test */

package/esm/src/wizard/wizard.d.ts

@@ -69,7 +69,5 @@ declare class Wizard {
  */
 export declare const wizard: Wizard;
 export {};
-/**
- * TODO: [🧠] Maybe some way how to handle the progress and streaming?
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- */
+/** Note: [🟢] Code for Node wizard helper [wizard](src/wizard/wizard.ts) should never be published into packages that could be imported into browser environment */
+/** TODO: [🧠] Maybe some way how to handle the progress and streaming? */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-server",
-    "version": "0.112.0-32",
+    "version": "0.112.0-34",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -98,7 +98,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/remote-server.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.112.0-32"
+        "@promptbook/core": "0.112.0-34"
     },
     "dependencies": {
         "@mozilla/readability": "0.6.0",

package/umd/index.umd.js

@@ -50,7 +50,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.112.0-32';
+    const PROMPTBOOK_ENGINE_VERSION = '0.112.0-34';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1398,9 +1398,7 @@
             }
         });
     }
-    /**
-     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
-     */
+    /** Note: [🟢] Code for Node command-execution helper [$execCommand](src/utils/execCommand/$execCommand.ts) should never be published into packages that could be imported into browser environment */
 
     /**
      * [🐱‍🚀]
@@ -1427,9 +1425,7 @@
             isVerbose: true,
         });
     }
-    /**
-     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
-     */
+    /** Note: [🟢] Code for Node server bootstrap [startAgentServer](src/remote-server/startAgentServer.ts) should never be published into packages that could be imported into browser environment */
 
     /**
      * Make error report URL for the given error
@@ -1942,10 +1938,8 @@
             return null;
         }
     }
-    /**
-     * 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
-     */
+    /** Note: [🟢] Code for Node executable locator [locateAppOnLinux](src/executables/platforms/locateAppOnLinux.ts) should never be published into packages that could be imported into browser environment */
+    /** TODO: [🧠][♿] Maybe export through `@promptbook/node` */
 
     /**
      * Provides filesystem access (for example for Node.js-based scrapers)
@@ -1968,10 +1962,8 @@
             watch: promises.watch,
         };
     }
-    /**
-     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
-     * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
-     */
+    /** Note: [🟢] Code for Node scraper registration helper [$provideFilesystemForNode](src/scrapers/_common/register/$provideFilesystemForNode.ts) should never be published into packages that could be imported into browser environment */
+    /** TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming */
 
     /**
      * Checks if the file is executable
@@ -2024,10 +2016,8 @@
             return null;
         }
     }
-    /**
-     * 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
-     */
+    /** Note: [🟢] Code for Node executable locator [locateAppOnMacOs](src/executables/platforms/locateAppOnMacOs.ts) should never be published into packages that could be imported into browser environment */
+    /** TODO: [🧠][♿] Maybe export through `@promptbook/node` */
 
     /**
      * Attempts to locate the specified application on a Windows system by searching common installation directories.
@@ -2056,10 +2046,8 @@
             return null;
         }
     }
-    /**
-     * 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
-     */
+    /** Note: [🟢] Code for Node executable locator [locateAppOnWindows](src/executables/platforms/locateAppOnWindows.ts) should never be published into packages that could be imported into browser environment */
+    /** TODO: [🧠][♿] Maybe export through `@promptbook/node` */
 
     /**
      * Locates an application on the system
@@ -2096,10 +2084,8 @@
             }
         }
     }
-    /**
-     * 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
-     */
+    /** Note: [🟢] Code for Node executable locator [locateApp](src/executables/locateApp.ts) should never be published into packages that could be imported into browser environment */
+    /** TODO: [🧠][♿] Maybe export through `@promptbook/node` */
 
     /**
      * Locates the LibreOffice executable on the current system by searching platform-specific paths.
@@ -2115,10 +2101,8 @@
             macOsName: 'LibreOffice',
         });
     }
-    /**
-     * 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
-     */
+    /** Note: [🟢] Code for Node executable locator [locateLibreoffice](src/executables/apps/locateLibreoffice.ts) should never be published into packages that could be imported into browser environment */
+    /** TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/legacy-documents` */
 
     /**
      * Locates the Pandoc executable on the current system by searching platform-specific paths.
@@ -2134,10 +2118,8 @@
             macOsName: 'Pandoc',
         });
     }
-    /**
-     * 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
-     */
+    /** Note: [🟢] Code for Node executable locator [locatePandoc](src/executables/apps/locatePandoc.ts) should never be published into packages that could be imported into browser environment */
+    /** TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/documents` */
 
     /**
      * Provides paths to required executables (i.e. as Pandoc and LibreOffice) for Node.js environments.
@@ -2154,9 +2136,9 @@
             //                                              <- TODO: [🧠] `null` vs `undefined`
         };
     }
+    /** Note: [🟢] Code for Node executable locator [$provideExecutablesForNode](src/executables/$provideExecutablesForNode.ts) should never be published into packages that could be imported into browser environment */
     /**
      * 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
      * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
      */
 
@@ -8089,10 +8071,8 @@
         }
         return scrapers;
     }
-    /**
-     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
-     * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
-     */
+    /** Note: [🟢] Code for Node scraper registration helper [$provideScrapersForNode](src/scrapers/_common/register/$provideScrapersForNode.ts) should never be published into packages that could be imported into browser environment */
+    /** TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming */
 
     /**
      * Normalizes a given text to camelCase format.
@@ -10415,12 +10395,12 @@
         };
         return fileHandler;
     }
+    /** Note: [🟢] Code for Node scraper helper [getScraperIntermediateSource](src/scrapers/_common/utils/getScraperIntermediateSource.ts) should never be published into packages that could be imported into browser environment */
     /**
      * Note: Not using `FileCacheStorage` for two reasons:
      * 1) Need to store more than serialized JSONs
      * 2) Need to switch between a `rootDirname` and `cacheDirname` <- TODO: [😡]
      * TODO: [🐱‍🐉][🧠] Make some smart crop
-     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
      */
 
     /**
@@ -10752,11 +10732,11 @@
             return knowledge;
         }
     }
+    /** Note: [🟢] Code for Node scraper implementation [WebsiteScraper](src/scrapers/website/WebsiteScraper.ts) should never be published into packages that could be imported into browser environment */
     /**
      * TODO: [👣] Scraped website in .md can act as cache item - there is no need to run conversion each time
      * TODO: [🪂] Do it in parallel 11:11
      * Note: No need to aggregate usage here, it is done by intercepting the llmTools
-     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
      */
 
     /**
@@ -10879,9 +10859,7 @@
         `);
         }
     }
-    /**
-     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
-     */
+    /** Note: [🟢] Code for Node browser-fetch helper [fetchUrlContent](src/commitments/USE_BROWSER/fetchUrlContent.ts) should never be published into packages that could be imported into browser environment */
 
     /**
      * Cached implementation of `run_browser` when it can be resolved.
@@ -22652,10 +22630,8 @@
         // TODO: [🔱] Do here auto-installation
         return [new JavascriptExecutionTools({ ...options, functions: getAllCommitmentsToolFunctionsForNode() })];
     }
-    /**
-     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
-     * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
-     */
+    /** Note: [🟢] Code for Node scraper registration helper [$provideScriptingForNode](src/scrapers/_common/register/$provideScriptingForNode.ts) should never be published into packages that could be imported into browser environment */
+    /** TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming */
 
     // TODO: [🥺] List running services from REMOTE_SERVER_URLS
     // TODO: [🥺] Import directly from YML
@@ -23861,8 +23837,8 @@
             },
         };
     }
+    /** Note: [🟢] Code for Node server bootstrap [startRemoteServer](src/remote-server/startRemoteServer.ts) should never be published into packages that could be imported into browser environment */
     /**
-
      * TODO: [🕋] Use here `aboutPromptbookInformation`
      * TODO: [🌡] Add CORS and security - probably via `helmet`
      * TODO: Split this file into multiple functions - handler for each request
@@ -23875,7 +23851,6 @@
      * TODO: [🃏] Pass here some security token to prevent malitious usage and/or DDoS
      * TODO: [0] Set unavailable models as undefined in `RemoteLlmExecutionTools` NOT throw error here
      * TODO: Allow to constrain anonymous mode for specific models / providers
-     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
      */
 
     /**