@promptbook/remote-client 0.103.0-12 → 0.103.0-15

package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts

@@ -1,21 +1,10 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { MarkitdownScraper } from './MarkitdownScraper';
 /**
  * Constructor of `MarkitdownScraper`
  *
  * @public exported from `@promptbook/markitdown`
  * @public exported from `@promptbook/pdf`
  */
-export declare const createMarkitdownScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => MarkitdownScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const createMarkitdownScraper: any;
 /**
  * TODO: [🧠][🌜] Export only from `@promptbook/markitdown` or `@promptbook/pdf` NOT both
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

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

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const markitdownScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const markitdownScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts

@@ -1,21 +1,10 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { PdfScraper } from './PdfScraper';
 /**
  * Factory function to create an instance of PdfScraper.
  * It bundles the scraper class with its metadata.
  *
  * @public exported from `@promptbook/pdf`
  */
-export declare const createPdfScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => PdfScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const createPdfScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

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

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const pdfScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const pdfScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

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

@@ -1,21 +1,10 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { WebsiteScraper } from './WebsiteScraper';
 /**
  * Factory function to create an instance of WebsiteScraper.
  * It bundles the scraper class with its metadata.
  *
  * @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/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const createWebsiteScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

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

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @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/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const websiteScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts

@@ -1,4 +1,5 @@
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Stores data in .env variables
  *
@@ -29,7 +30,7 @@ export declare class $EnvStorage<TItem> implements PromptbookStorage<TItem> {
     /**
      * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
      */
-    setItem(key: string, value: TItem): Promise<void>;
+    setItem(key: string, value: TItem): Promise<$side_effect>;
     /**
      * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
      */

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

@@ -1,3 +1,4 @@
+import { $side_effect } from '../organization/$side_effect';
 import type { ExecCommandOptions } from './ExecCommandOptions';
 /**
  * Run one command in a shell
@@ -10,7 +11,7 @@ import type { ExecCommandOptions } from './ExecCommandOptions';
  *
  * @public exported from `@promptbook/node`
  */
-export declare function $execCommand(options: ExecCommandOptions): Promise<string>;
+export declare function $execCommand(options: ExecCommandOptions): Promise<$side_effect & string>;
 /**
  * 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

@@ -1,3 +1,4 @@
+import { $side_effect } from '../organization/$side_effect';
 /**
  * Run multiple commands in a shell in sequence
  *
@@ -8,7 +9,7 @@
  *
  * @public exported from `@promptbook/node`
  */
-export declare function $execCommands({ commands, cwd, crashOnError, }: {
+export declare function $execCommands({ commands, cwd, crashOnError, }: $side_effect & {
     readonly commands: string[];
     readonly cwd: string;
     readonly crashOnError?: boolean;

package/esm/typings/src/utils/files/$induceBookDownload.d.ts

@@ -0,0 +1,13 @@
+import { string_book } from '../../_packages/types.index';
+import { $side_effect } from '../organization/$side_effect';
+/**
+ * Download a Book in a browser
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - its purpose is to cause a side effect (download a file)
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare function $induceBookDownload(book: string_book): Promise<$side_effect>;
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

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

@@ -0,0 +1,13 @@
+import { string_url } from '../../types/typeAliases';
+import { $side_effect } from '../organization/$side_effect';
+/**
+ * Download a File in a browser
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - its purpose is to cause a side effect (download a file)
+ *
+ * @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`
+ */

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

@@ -0,0 +1,46 @@
+import { IDestroyable, Registration } from 'destroyable';
+import { string_mime_type, string_url } from '../../types/typeAliases';
+/**
+ * Converts Blob, File or MediaSource to url using URL.createObjectURL
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare class ObjectUrl extends Registration implements IDestroyable {
+    readonly src: string_url;
+    private constructor();
+    /**
+     * Creates ObjectUrl from multiple input types
+     * Note: DO NOT forget to call destroy() when you are done with it
+     */
+    static from(source: Blob | File | MediaSource | string, mimeType: string_mime_type): ObjectUrl;
+    /**
+     * Creates ObjectUrl from string
+     * Note: DO NOT forget to call destroy() when you are done with it
+     */
+    static fromString(source: string, mimeType: string_mime_type): ObjectUrl;
+    /**
+     * Creates ObjectUrl
+     * DO NOT forget to call destroy() when you are done with it
+     */
+    static fromBlob(source: Blob | File | MediaSource): ObjectUrl;
+    /**
+     * Creates ObjectUrl:
+     * 1) With functionality for Blobs, Files or MediaSources
+     * 2) Just a wrapper for string urls
+     *
+     * DO NOT forget to call destroy() when you are done with it
+     */
+    static fromBlobOrUrl(source: Blob | File | MediaSource | URL | string_url): ObjectUrl;
+    /**
+     * Gets object url as string
+     * @alias src
+     */
+    get href(): string_url;
+    /**
+     * Gets object url as URL object
+     */
+    get url(): URL;
+}
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

package/esm/typings/src/utils/organization/$side_effect.d.ts

@@ -0,0 +1,7 @@
+import { really_any } from './really_any';
+/**
+ * Organizational helper to mark a function that produces side effects
+ *
+ * @private within the repository
+ */
+export type $side_effect = void | really_any;

package/esm/typings/src/utils/serialization/$deepFreeze.d.ts

@@ -1,4 +1,5 @@
 import type { ReadonlyDeep } from 'type-fest';
+import { $side_effect } from '../organization/$side_effect';
 /**
  * Freezes the given object and all its nested objects recursively
  *
@@ -8,7 +9,7 @@ import type { ReadonlyDeep } from 'type-fest';
  * @returns The same object as the input, but deeply frozen
  * @public exported from `@promptbook/utils`
  */
-export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
+export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<$side_effect & TObject>;
 /**
  * TODO: [🧠] Is there a way how to meaningfully test this utility
  */

package/esm/typings/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.103.0-11`).
+ * It follows semantic versioning (e.g., `0.103.0-14`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-client",
-    "version": "0.103.0-12",
+    "version": "0.103.0-15",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -100,7 +100,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/remote-client.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-12"
+        "@promptbook/core": "0.103.0-15"
     },
     "dependencies": {
         "crypto": "1.0.1",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-12';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-15';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1056,6 +1056,17 @@
      * TODO: Maybe implement by mix+hsl
      */
 
+    /**
+     * Makes color transformer which darker the given color
+     *
+     * @param amount from 0 to 1
+     *
+     * @public exported from `@promptbook/color`
+     */
+    function darken(amount) {
+        return lighten(-amount);
+    }
+
     /**
      * Calculates distance between two colors
      *
@@ -1221,15 +1232,29 @@
      * @public exported from `@promptbook/core`
      */
     const PROMPTBOOK_COLOR = Color.fromHex('#79EAFD');
-    // <- TODO: [🧠] Using `Color` here increases the package size approx 3kb, maybe remove it
+    // <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
+    /**
+     * Colors for syntax highlighting in the `<BookEditor/>`
+     *
+     * TODO: [🗽] Unite branding and make single place for it
+     *
+     * @public exported from `@promptbook/core`
+     */
+    ({
+        TITLE: PROMPTBOOK_COLOR.then(darken(0.5)),
+        COMMITMENT: Color.fromHex('#DA0F78'),
+        PARAMETER: Color.fromHex('#8e44ad'),
+    });
+    // <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
     /**
-     * Dark color of the Promptbook
+     * Chat color of the Promptbook (in chat)
      *
      * TODO: [🗽] Unite branding and make single place for it
      *
      * @public exported from `@promptbook/core`
      */
     PROMPTBOOK_COLOR.then(lighten(0.1)).then(saturate(0.9)).then(grayscale(0.9));
+    // <- TODO: [🧠][🈵] Using `Color` and `lighten`, `saturate`,... here increases the package size approx 3kb, maybe remove it
     /**
      * Color of the user (in chat)
      *
@@ -1238,6 +1263,7 @@
      * @public exported from `@promptbook/core`
      */
     Color.fromHex('#1D4ED8');
+    // <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
     /**
      * When the title is not provided, the default title is used
      *