@promptbook/node 0.72.0-7 → 0.72.0-9

package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts

@@ -0,0 +1,20 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import { WebsiteScraper } from './WebsiteScraper';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/website-crawler`
+ */
+export declare const createWebsiteScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => WebsiteScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    isAvilableInBrowser: false;
+    requiredExecutables: string[];
+}>;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/scrapers/website/register-constructor.d.ts

@@ -0,0 +1,13 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of known scraper
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+ *
+ * @public exported from `@promptbook/website-crawler`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _WebsiteScraperRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/scrapers/website/register-metadata.d.ts

@@ -0,0 +1,24 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Metadata of the scraper
+ *
+ * @private within the scraper directory
+ */
+export declare const websiteScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    isAvilableInBrowser: false;
+    requiredExecutables: string[];
+}>;
+/**
+ * Registration of known scraper metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _WebsiteScraperMetadataRegistration: Registration;

package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts

@@ -1,10 +1,10 @@
 import type { Promisable } from 'type-fest';
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { string_postprocessing_function_name } from '../../types/typeAliases';
 /**
  * Options for `JavascriptExecutionTools`
  */
-export type JavascriptExecutionToolsOptions = CommonExecutionToolsOptions & {
+export type JavascriptExecutionToolsOptions = CommonToolsOptions & {
     /**
      * Functions to be executed in the JavaScript evaluation.
      *

package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts

@@ -1,4 +1,4 @@
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { ScriptExecutionTools } from '../../execution/ScriptExecutionTools';
 import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptExecutionTools';
 /**
@@ -9,8 +9,8 @@ import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptE
  * @private still in development
  */
 export declare class PythonExecutionTools implements ScriptExecutionTools {
-    protected readonly options: CommonExecutionToolsOptions;
-    constructor(options?: CommonExecutionToolsOptions);
+    protected readonly options: CommonToolsOptions;
+    constructor(options?: CommonToolsOptions);
     /**
      * Executes a Python
      */

package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts

@@ -1,4 +1,4 @@
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { ScriptExecutionTools } from '../../execution/ScriptExecutionTools';
 import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptExecutionTools';
 /**
@@ -9,8 +9,8 @@ import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptE
  * @private still in development
  */
 export declare class TypescriptExecutionTools implements ScriptExecutionTools {
-    protected readonly options: CommonExecutionToolsOptions;
-    constructor(options?: CommonExecutionToolsOptions);
+    protected readonly options: CommonToolsOptions;
+    constructor(options?: CommonToolsOptions);
     /**
      * Executes a TypeScript
      */

package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts

@@ -1,3 +1,4 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
 import type { FileCacheStorageOptions } from './FileCacheStorageOptions';
 /**
@@ -6,8 +7,9 @@ import type { FileCacheStorageOptions } from './FileCacheStorageOptions';
  * @public exported from `@promptbook/node`
  */
 export declare class FileCacheStorage<TItem> implements PromptbookStorage<TItem> {
-    protected readonly options: FileCacheStorageOptions;
-    constructor(options: FileCacheStorageOptions);
+    protected readonly tools: Required<Pick<ExecutionTools, 'fs'>>;
+    private readonly options;
+    constructor(tools: Required<Pick<ExecutionTools, 'fs'>>, options: FileCacheStorageOptions);
     /**
      * @@@
      */
@@ -27,5 +29,5 @@ export declare class FileCacheStorage<TItem> implements PromptbookStorage<TItem>
 }
 /**
  * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
- * Note: [🟢] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/storage/{utils → memory/utils}/PrefixStorage.d.ts

@@ -1,5 +1,5 @@
 import type { Promisable } from 'type-fest';
-import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import type { PromptbookStorage } from '../../_common/PromptbookStorage';
 /**
  * This class behaves like LocalStorage but separates keys by prefix
  *

package/esm/typings/src/storage/{utils → memory/utils}/makePromptbookStorageFromWebStorage.d.ts

@@ -1,4 +1,4 @@
-import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import type { PromptbookStorage } from '../../_common/PromptbookStorage';
 /**
  * @@@
  *

package/esm/typings/src/types/typeAliases.d.ts

@@ -331,6 +331,13 @@ export type string_href = string;
  * For example `"https://collboard.com/9SeSQTupmQHwuSrLi.png?width=1200&height=630"`
  */
 export type string_url_image = string;
+/**
+ * Semantic helper
+ *
+ * For example `"C:/Users/me/AppData/Local/Pandoc/pandoc.exe"`
+ * For example `"C:/Program Files/LibreOffice/program/swriter.exe"`
+ */
+export type string_executable_path = string;
 /**
  * Semantic helper
  *

package/esm/typings/src/utils/$Register.d.ts

@@ -1,14 +1,27 @@
-import type { string_javascript_name } from '../types/typeAliases';
+import { type IDestroyable } from 'destroyable';
+import type { string_name } from '../types/typeAliases';
 import type { TODO_string } from './organization/TODO_string';
+/**
+ * @@@
+ */
 export type Registered = {
     /**
      * @@@
      */
-    packageName: TODO_string;
+    readonly packageName: TODO_string;
+    /**
+     * @@@
+     */
+    readonly className: TODO_string;
+};
+/**
+ * @@@
+ */
+export type Registration = Registered & IDestroyable & {
     /**
      * @@@
      */
-    className: TODO_string;
+    readonly registerName: string_name;
 };
 /**
  * Register is @@@
@@ -18,9 +31,9 @@ export type Registered = {
  * @private internal utility, exported are only signleton instances of this class
  */
 export declare class $Register<TRegistered extends Registered> {
-    private readonly storageName;
+    private readonly registerName;
     private readonly storage;
-    constructor(storageName: string_javascript_name);
+    constructor(registerName: string_name);
     list(): Array<TRegistered>;
-    register(registered: TRegistered): void;
+    register(registered: TRegistered): Registration;
 }

package/esm/typings/src/utils/execCommand/$execCommand.d.ts

@@ -10,5 +10,5 @@ import type { IExecCommandOptions } from './IExecCommandOptions';
  */
 export declare function $execCommand(options: IExecCommandOptions): Promise<string>;
 /**
- * Note: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/utils/execCommand/$execCommands.d.ts

@@ -13,5 +13,5 @@ export declare function $execCommands({ commands, cwd, crashOnError, }: {
     readonly crashOnError?: boolean;
 }): Promise<void>;
 /**
- * Note: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

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

@@ -0,0 +1,14 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { string_dirname } from '../../types/typeAliases';
+/**
+ * Checks if the directory exists
+ *
+ * @private within the repository
+ */
+export declare function isDirectoryExisting(directoryPath: string_dirname, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
+ * TODO: [🧠][📂] "directory" vs "folder"
+ * TODO: [🖇] What about symlinks?
+ */

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

@@ -0,0 +1,13 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { string_filename } from '../../types/typeAliases';
+/**
+ * Checks if the file exists
+ *
+ * @private within the repository
+ */
+export declare function isFileExisting(filename: string_filename, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
+ * TODO: [🖇] What about symlinks?
+ */

package/esm/typings/src/utils/files/{$listAllFiles.d.ts → listAllFiles.d.ts}

@@ -1,18 +1,17 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
 import type { string_dirname } from '../../types/typeAliases';
 import type { string_filename } from '../../types/typeAliases';
 /**
  * Reads all files in the directory
  *
- * Note: `$` is used to indicate that this function is not a pure function - it looks at the filesystem
- *
  * @param path
  * @param isRecursive
  * @returns List of all files in the directory
  * @private internal function of `createCollectionFromDirectory`
  */
-export declare function $listAllFiles(path: string_dirname, isRecursive: boolean): Promise<Array<string_filename>>;
+export declare function listAllFiles(path: string_dirname, isRecursive: boolean, fs: FilesystemTools): Promise<Array<string_filename>>;
 /**
  * TODO: [😶] Unite floder listing
- * Note: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
  * TODO: [🖇] What about symlinks?
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.72.0-7",
+    "version": "0.72.0-9",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -51,16 +51,13 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/node.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.72.0-7"
+        "@promptbook/core": "0.72.0-9"
     },
     "dependencies": {
-        "@mozilla/readability": "^0.5.0",
         "colors": "1.4.0",
         "crypto-js": "4.2.0",
-        "jsdom": "^25.0.1",
         "papaparse": "5.4.1",
         "prettier": "2.8.1",
-        "showdown": "^2.1.0",
         "spacetrim": "0.11.39",
         "waitasecond": "1.11.83"
     }