@promptbook/remote-server 0.72.0-15 → 0.72.0-23

package/esm/index.es.js

@@ -7,7 +7,7 @@ import spaceTrim$1, { spaceTrim } from 'spacetrim';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.72.0-14';
+var PROMPTBOOK_VERSION = '0.72.0-22';
 // TODO: [main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************

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

@@ -16,8 +16,6 @@ import { _MarkdownScraperRegistration } from '../scrapers/markdown/register-cons
 import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
 import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
 import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
-import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
-import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
 export { PROMPTBOOK_VERSION };
 export { _CLI };
 export { _AnthropicClaudeMetadataRegistration };
@@ -36,5 +34,3 @@ export { _MarkdownScraperRegistration };
 export { _MarkdownScraperMetadataRegistration };
 export { _PdfScraperRegistration };
 export { _PdfScraperMetadataRegistration };
-export { _WebsiteScraperRegistration };
-export { _WebsiteScraperMetadataRegistration };

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

@@ -83,7 +83,6 @@ import { _LegacyDocumentScraperMetadataRegistration } from '../scrapers/document
 import { _DocumentScraperMetadataRegistration } from '../scrapers/document/register-metadata';
 import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
 import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
-import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
 import { MemoryStorage } from '../storage/memory/MemoryStorage';
 import { PrefixStorage } from '../storage/memory/utils/PrefixStorage';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
@@ -176,7 +175,6 @@ export { _LegacyDocumentScraperMetadataRegistration };
 export { _DocumentScraperMetadataRegistration };
 export { _MarkdownScraperMetadataRegistration };
 export { _PdfScraperMetadataRegistration };
-export { _WebsiteScraperMetadataRegistration };
 export { MemoryStorage };
 export { PrefixStorage };
 export { executionReportJsonToString };

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';
@@ -257,6 +258,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/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/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/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts

@@ -29,7 +29,6 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
     callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
 }
 /**
- * TODO: !!!!!! DO not use colors - can be used in browser
  * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
  * TODO: Maybe make custom OpenAiError
  * TODO: [🧠][🈁] Maybe use `isDeterministic` from options

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/remote-server",
-    "version": "0.72.0-15",
+    "version": "0.72.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/remote-server.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.72.0-15"
+        "@promptbook/core": "0.72.0-23"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -14,7 +14,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.72.0-14';
+    var PROMPTBOOK_VERSION = '0.72.0-22';
     // TODO: [main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************

package/esm/typings/src/_packages/website-crawler.index.d.ts

@@ -1,8 +0,0 @@
-import { PROMPTBOOK_VERSION } from '../version';
-import { createWebsiteScraper } from '../scrapers/website/createWebsiteScraper';
-import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
-import { WebsiteScraper } from '../scrapers/website/WebsiteScraper';
-export { PROMPTBOOK_VERSION };
-export { createWebsiteScraper };
-export { _WebsiteScraperRegistration };
-export { WebsiteScraper };

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

@@ -1,50 +0,0 @@
-import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
-import type { string_markdown } from '../../types/typeAliases';
-import type { Converter } from '../_common/Converter';
-import type { Scraper } from '../_common/Scraper';
-import type { ScraperSourceHandler } from '../_common/Scraper';
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';
-import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
-/**
- * Scraper for websites
- *
- * @see `documentationUrl` for more details
- * @public exported from `@promptbook/website-crawler`
- */
-export declare class WebsiteScraper implements Converter, Scraper {
-    private readonly tools;
-    private readonly options;
-    /**
-     * Metadata of the scraper which includes title, mime types, etc.
-     */
-    get metadata(): ScraperAndConverterMetadata;
-    /**
-     * Markdown scraper is used internally
-     */
-    private readonly markdownScraper;
-    /**
-     * Showdown converter is used internally
-     */
-    private readonly showdownConverter;
-    constructor(tools: Pick<ExecutionTools, 'fs' | 'llm'>, options: PrepareAndScrapeOptions);
-    /**
-     * Convert the website  to `.md` file and returns intermediate source
-     *
-     * Note: `$` is used to indicate that this function is not a pure function - it leaves files on the disk and you are responsible for cleaning them by calling `destroy` method of returned object
-     */
-    $convert(source: ScraperSourceHandler): Promise<ScraperIntermediateSource & {
-        markdown: string_markdown;
-    }>;
-    /**
-     * Scrapes the website and returns the knowledge pieces or `null` if it can't scrape it
-     */
-    scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
-}
-/**
- * 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
- */

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

@@ -1,20 +0,0 @@
-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: never[];
-}>;
-/**
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
- */

package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts

@@ -1,5 +0,0 @@
-#!/usr/bin/env ts-node
-export {};
-/**
- * Note: [⚫] Code in this file should never be published in any package
- */

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

@@ -1,13 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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: never[];
-}>;
-/**
- * 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/scrapers/website/utils/createShowdownConverter.d.ts

@@ -1,7 +0,0 @@
-import { Converter as ShowdownConverter } from 'showdown';
-/**
- * Create a new showdown converter instance
- *
- * @private utility of `WebsiteScraper`
- */
-export declare function createShowdownConverter(): ShowdownConverter;