@promptbook/documents 0.103.0-14 → 0.103.0-16

package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts

@@ -1,21 +1,10 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { LegacyDocumentScraper } from './LegacyDocumentScraper';
 /**
  * Creates a scraper for legacy document formats (.doc, .rtf, etc).
  * Uses LibreOffice for conversion to extract content from older document formats.
  *
  * @public exported from `@promptbook/legacy-documents`
  */
-export declare const createLegacyDocumentScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => LegacyDocumentScraper) & 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: ("Pandoc" | "LibreOffice")[];
-}>;
+export declare const createLegacyDocumentScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

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

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const legacyDocumentScraperMetadata: 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: ("Pandoc" | "LibreOffice")[];
-}>;
+export declare const legacyDocumentScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts

@@ -1,20 +1,9 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { MarkdownScraper } from './MarkdownScraper';
 /**
  * Creates a scraper for markdown content.
  *
  * @public exported from `@promptbook/markdown-utils`
  */
-export declare const createMarkdownScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => MarkdownScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: true;
-    requiredExecutables: never[];
-}>;
+export declare const createMarkdownScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

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

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

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-13`).
+ * It follows semantic versioning (e.g., `0.103.0-15`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/documents",
-    "version": "0.103.0-14",
+    "version": "0.103.0-16",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -95,7 +95,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/documents.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-14"
+        "@promptbook/core": "0.103.0-16"
     },
     "dependencies": {
         "colors": "1.4.0",