@promptbook/vercel 0.103.0-12 → 0.103.0-15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/esm/index.es.js +29 -4
  2. package/esm/index.es.js.map +1 -1
  3. package/esm/typings/src/_packages/browser.index.d.ts +6 -0
  4. package/esm/typings/src/_packages/core.index.d.ts +2 -0
  5. package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +5 -0
  6. package/esm/typings/src/book-components/BookEditor/BookEditorActionbar.d.ts +9 -0
  7. package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +2 -1
  8. package/esm/typings/src/cli/cli-commands/about.d.ts +2 -1
  9. package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
  10. package/esm/typings/src/cli/cli-commands/list-models.d.ts +2 -1
  11. package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +2 -1
  12. package/esm/typings/src/cli/cli-commands/login.d.ts +2 -1
  13. package/esm/typings/src/cli/cli-commands/make.d.ts +2 -1
  14. package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
  15. package/esm/typings/src/cli/cli-commands/run.d.ts +2 -1
  16. package/esm/typings/src/cli/cli-commands/start-server.d.ts +2 -1
  17. package/esm/typings/src/cli/cli-commands/test-command.d.ts +2 -1
  18. package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +2 -1
  19. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +4 -5
  20. package/esm/typings/src/config.d.ts +13 -1
  21. package/esm/typings/src/execution/utils/usage-constants.d.ts +4 -124
  22. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +2 -1
  23. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +2 -1
  24. package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +1 -12
  25. package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +1 -9
  26. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +1 -12
  27. package/esm/typings/src/scrapers/document/register-metadata.d.ts +1 -9
  28. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +1 -12
  29. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +1 -9
  30. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +1 -12
  31. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +1 -9
  32. package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +1 -12
  33. package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +1 -9
  34. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +1 -12
  35. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +1 -9
  36. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +1 -12
  37. package/esm/typings/src/scrapers/website/register-metadata.d.ts +1 -9
  38. package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +2 -1
  39. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +2 -1
  40. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +2 -1
  41. package/esm/typings/src/utils/files/$induceBookDownload.d.ts +13 -0
  42. package/esm/typings/src/utils/files/$induceFileDownload.d.ts +13 -0
  43. package/esm/typings/src/utils/files/ObjectUrl.d.ts +46 -0
  44. package/esm/typings/src/utils/organization/$side_effect.d.ts +7 -0
  45. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +2 -1
  46. package/esm/typings/src/version.d.ts +1 -1
  47. package/package.json +2 -2
  48. package/umd/index.umd.js +29 -4
  49. package/umd/index.umd.js.map +1 -1
@@ -3,145 +3,25 @@
3
3
  *
4
4
  * @public exported from `@promptbook/core`
5
5
  */
6
- export declare const ZERO_VALUE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
7
- readonly value: 0;
8
- }>;
6
+ export declare const ZERO_VALUE: any;
9
7
  /**
10
8
  * Represents the uncertain value
11
9
  *
12
10
  * @public exported from `@promptbook/core`
13
11
  */
14
- export declare const UNCERTAIN_ZERO_VALUE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
15
- readonly value: 0;
16
- readonly isUncertain: true;
17
- }>;
12
+ export declare const UNCERTAIN_ZERO_VALUE: any;
18
13
  /**
19
14
  * Represents the usage with no resources consumed
20
15
  *
21
16
  * @public exported from `@promptbook/core`
22
17
  */
23
- export declare const ZERO_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
24
- readonly price: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
25
- readonly value: 0;
26
- }>;
27
- readonly input: {
28
- readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
29
- readonly value: 0;
30
- }>;
31
- readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
32
- readonly value: 0;
33
- }>;
34
- readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
35
- readonly value: 0;
36
- }>;
37
- readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
38
- readonly value: 0;
39
- }>;
40
- readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
41
- readonly value: 0;
42
- }>;
43
- readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
44
- readonly value: 0;
45
- }>;
46
- readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
47
- readonly value: 0;
48
- }>;
49
- };
50
- readonly output: {
51
- readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
52
- readonly value: 0;
53
- }>;
54
- readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
55
- readonly value: 0;
56
- }>;
57
- readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
58
- readonly value: 0;
59
- }>;
60
- readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
61
- readonly value: 0;
62
- }>;
63
- readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
64
- readonly value: 0;
65
- }>;
66
- readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
67
- readonly value: 0;
68
- }>;
69
- readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
70
- readonly value: 0;
71
- }>;
72
- };
73
- }>;
18
+ export declare const ZERO_USAGE: any;
74
19
  /**
75
20
  * Represents the usage with unknown resources consumed
76
21
  *
77
22
  * @public exported from `@promptbook/core`
78
23
  */
79
- export declare const UNCERTAIN_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
80
- readonly price: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
81
- readonly value: 0;
82
- readonly isUncertain: true;
83
- }>;
84
- readonly input: {
85
- readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
86
- readonly value: 0;
87
- readonly isUncertain: true;
88
- }>;
89
- readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
90
- readonly value: 0;
91
- readonly isUncertain: true;
92
- }>;
93
- readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
94
- readonly value: 0;
95
- readonly isUncertain: true;
96
- }>;
97
- readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
98
- readonly value: 0;
99
- readonly isUncertain: true;
100
- }>;
101
- readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
102
- readonly value: 0;
103
- readonly isUncertain: true;
104
- }>;
105
- readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
106
- readonly value: 0;
107
- readonly isUncertain: true;
108
- }>;
109
- readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
110
- readonly value: 0;
111
- readonly isUncertain: true;
112
- }>;
113
- };
114
- readonly output: {
115
- readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
116
- readonly value: 0;
117
- readonly isUncertain: true;
118
- }>;
119
- readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
120
- readonly value: 0;
121
- readonly isUncertain: true;
122
- }>;
123
- readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
124
- readonly value: 0;
125
- readonly isUncertain: true;
126
- }>;
127
- readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
128
- readonly value: 0;
129
- readonly isUncertain: true;
130
- }>;
131
- readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
132
- readonly value: 0;
133
- readonly isUncertain: true;
134
- }>;
135
- readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
136
- readonly value: 0;
137
- readonly isUncertain: true;
138
- }>;
139
- readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
140
- readonly value: 0;
141
- readonly isUncertain: true;
142
- }>;
143
- };
144
- }>;
24
+ export declare const UNCERTAIN_USAGE: any;
145
25
  /**
146
26
  * Note: [💞] Ignore a discrepancy between file name and entity name
147
27
  */
@@ -1,4 +1,5 @@
1
1
  import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
2
+ import { $side_effect } from '../../utils/organization/$side_effect';
2
3
  /**
3
4
  * Used in `parsePipeline`
4
5
  *
@@ -11,7 +12,7 @@ export type SyncHighLevelAbstraction = {
11
12
  *
12
13
  * Note: `$` is used to indicate that this function mutates given `pipelineJson`
13
14
  */
14
- $applyToPipelineJson($pipelineJson: $PipelineJson): void;
15
+ $applyToPipelineJson($pipelineJson: $PipelineJson): $side_effect;
15
16
  };
16
17
  /**
17
18
  * TODO: [♓️] Add order here
@@ -1,4 +1,5 @@
1
1
  import type { string_filename, string_markdown } from '../../../types/typeAliases';
2
+ import { $side_effect } from '../../../utils/organization/$side_effect';
2
3
  /**
3
4
  * Pass the `.env` file which was used to configure LLM tools
4
5
  *
@@ -6,7 +7,7 @@ import type { string_filename, string_markdown } from '../../../types/typeAliase
6
7
  *
7
8
  * @private internal log of `$provideLlmToolsConfigurationFromEnv` and `$registeredLlmToolsMessage`
8
9
  */
9
- export declare function $setUsedEnvFilename(filepath: string_filename): void;
10
+ export declare function $setUsedEnvFilename(filepath: string_filename): $side_effect;
10
11
  /**
11
12
  * Creates a message with all registered LLM tools
12
13
  *
@@ -1,20 +1,9 @@
1
- import type { ExecutionTools } from '../../execution/ExecutionTools';
2
- import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
3
- import { BoilerplateScraper } from './BoilerplateScraper';
4
1
  /**
5
2
  * Constructor of `BoilerplateScraper`
6
3
  *
7
4
  * @public exported from `@promptbook/boilerplate`
8
5
  */
9
- export declare const createBoilerplateScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => BoilerplateScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
10
- title: string;
11
- packageName: string;
12
- className: string;
13
- mimeTypes: string[];
14
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
15
- isAvailableInBrowser: false;
16
- requiredExecutables: never[];
17
- }>;
6
+ export declare const createBoilerplateScraper: any;
18
7
  /**
19
8
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
20
9
  */
@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
4
4
  *
5
5
  * @private within the scraper directory
6
6
  */
7
- export declare const boilerplateScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
8
- title: string;
9
- packageName: string;
10
- className: string;
11
- mimeTypes: string[];
12
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
13
- isAvailableInBrowser: false;
14
- requiredExecutables: never[];
15
- }>;
7
+ export declare const boilerplateScraperMetadata: any;
16
8
  /**
17
9
  * Registration of known scraper metadata
18
10
  *
@@ -1,20 +1,9 @@
1
- import type { ExecutionTools } from '../../execution/ExecutionTools';
2
- import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
3
- import { DocumentScraper } from './DocumentScraper';
4
1
  /**
5
2
  * Creates a scraper for document content.
6
3
  *
7
4
  * @public exported from `@promptbook/documents`
8
5
  */
9
- export declare const createDocumentScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => DocumentScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
10
- title: string;
11
- packageName: string;
12
- className: string;
13
- mimeTypes: string[];
14
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
15
- isAvailableInBrowser: false;
16
- requiredExecutables: "Pandoc"[];
17
- }>;
6
+ export declare const createDocumentScraper: any;
18
7
  /**
19
8
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
20
9
  */
@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
4
4
  *
5
5
  * @private within the scraper directory
6
6
  */
7
- export declare const documentScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
8
- title: string;
9
- packageName: string;
10
- className: string;
11
- mimeTypes: string[];
12
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
13
- isAvailableInBrowser: false;
14
- requiredExecutables: "Pandoc"[];
15
- }>;
7
+ export declare const documentScraperMetadata: any;
16
8
  /**
17
9
  * Registration of known scraper metadata
18
10
  *
@@ -1,21 +1,10 @@
1
- import type { ExecutionTools } from '../../execution/ExecutionTools';
2
- import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
3
- import { LegacyDocumentScraper } from './LegacyDocumentScraper';
4
1
  /**
5
2
  * Creates a scraper for legacy document formats (.doc, .rtf, etc).
6
3
  * Uses LibreOffice for conversion to extract content from older document formats.
7
4
  *
8
5
  * @public exported from `@promptbook/legacy-documents`
9
6
  */
10
- export declare const createLegacyDocumentScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => LegacyDocumentScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
11
- title: string;
12
- packageName: string;
13
- className: string;
14
- mimeTypes: string[];
15
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
16
- isAvailableInBrowser: false;
17
- requiredExecutables: ("Pandoc" | "LibreOffice")[];
18
- }>;
7
+ export declare const createLegacyDocumentScraper: any;
19
8
  /**
20
9
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
21
10
  */
@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
4
4
  *
5
5
  * @private within the scraper directory
6
6
  */
7
- export declare const legacyDocumentScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
8
- title: string;
9
- packageName: string;
10
- className: string;
11
- mimeTypes: string[];
12
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
13
- isAvailableInBrowser: false;
14
- requiredExecutables: ("Pandoc" | "LibreOffice")[];
15
- }>;
7
+ export declare const legacyDocumentScraperMetadata: any;
16
8
  /**
17
9
  * Registration of known scraper metadata
18
10
  *
@@ -1,20 +1,9 @@
1
- import type { ExecutionTools } from '../../execution/ExecutionTools';
2
- import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
3
- import { MarkdownScraper } from './MarkdownScraper';
4
1
  /**
5
2
  * Creates a scraper for markdown content.
6
3
  *
7
4
  * @public exported from `@promptbook/markdown-utils`
8
5
  */
9
- export declare const createMarkdownScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => MarkdownScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
10
- title: string;
11
- packageName: string;
12
- className: string;
13
- mimeTypes: string[];
14
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
15
- isAvailableInBrowser: true;
16
- requiredExecutables: never[];
17
- }>;
6
+ export declare const createMarkdownScraper: any;
18
7
  /**
19
8
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
20
9
  */
@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
4
4
  *
5
5
  * @private within the scraper directory
6
6
  */
7
- export declare const markdownScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
8
- title: string;
9
- packageName: string;
10
- className: string;
11
- mimeTypes: string[];
12
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
13
- isAvailableInBrowser: true;
14
- requiredExecutables: never[];
15
- }>;
7
+ export declare const markdownScraperMetadata: any;
16
8
  /**
17
9
  * Registration of known scraper metadata
18
10
  *
@@ -1,21 +1,10 @@
1
- import type { ExecutionTools } from '../../execution/ExecutionTools';
2
- import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
3
- import { MarkitdownScraper } from './MarkitdownScraper';
4
1
  /**
5
2
  * Constructor of `MarkitdownScraper`
6
3
  *
7
4
  * @public exported from `@promptbook/markitdown`
8
5
  * @public exported from `@promptbook/pdf`
9
6
  */
10
- export declare const createMarkitdownScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => MarkitdownScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
11
- title: string;
12
- packageName: string;
13
- className: string;
14
- mimeTypes: string[];
15
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
16
- isAvailableInBrowser: false;
17
- requiredExecutables: never[];
18
- }>;
7
+ export declare const createMarkitdownScraper: any;
19
8
  /**
20
9
  * TODO: [🧠][🌜] Export only from `@promptbook/markitdown` or `@promptbook/pdf` NOT both
21
10
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
4
4
  *
5
5
  * @private within the scraper directory
6
6
  */
7
- export declare const markitdownScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
8
- title: string;
9
- packageName: string;
10
- className: string;
11
- mimeTypes: string[];
12
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
13
- isAvailableInBrowser: false;
14
- requiredExecutables: never[];
15
- }>;
7
+ export declare const markitdownScraperMetadata: any;
16
8
  /**
17
9
  * Registration of known scraper metadata
18
10
  *
@@ -1,21 +1,10 @@
1
- import type { ExecutionTools } from '../../execution/ExecutionTools';
2
- import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
3
- import { PdfScraper } from './PdfScraper';
4
1
  /**
5
2
  * Factory function to create an instance of PdfScraper.
6
3
  * It bundles the scraper class with its metadata.
7
4
  *
8
5
  * @public exported from `@promptbook/pdf`
9
6
  */
10
- export declare const createPdfScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => PdfScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
11
- title: string;
12
- packageName: string;
13
- className: string;
14
- mimeTypes: string[];
15
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
16
- isAvailableInBrowser: false;
17
- requiredExecutables: never[];
18
- }>;
7
+ export declare const createPdfScraper: any;
19
8
  /**
20
9
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
21
10
  */
@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
4
4
  *
5
5
  * @private within the scraper directory
6
6
  */
7
- export declare const pdfScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
8
- title: string;
9
- packageName: string;
10
- className: string;
11
- mimeTypes: string[];
12
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
13
- isAvailableInBrowser: false;
14
- requiredExecutables: never[];
15
- }>;
7
+ export declare const pdfScraperMetadata: any;
16
8
  /**
17
9
  * Registration of known scraper metadata
18
10
  *
@@ -1,21 +1,10 @@
1
- import type { ExecutionTools } from '../../execution/ExecutionTools';
2
- import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
3
- import { WebsiteScraper } from './WebsiteScraper';
4
1
  /**
5
2
  * Factory function to create an instance of WebsiteScraper.
6
3
  * It bundles the scraper class with its metadata.
7
4
  *
8
5
  * @public exported from `@promptbook/website-crawler`
9
6
  */
10
- export declare const createWebsiteScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => WebsiteScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
11
- title: string;
12
- packageName: string;
13
- className: string;
14
- mimeTypes: string[];
15
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
16
- isAvailableInBrowser: false;
17
- requiredExecutables: never[];
18
- }>;
7
+ export declare const createWebsiteScraper: any;
19
8
  /**
20
9
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
21
10
  */
@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
4
4
  *
5
5
  * @private within the scraper directory
6
6
  */
7
- export declare const websiteScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
8
- title: string;
9
- packageName: string;
10
- className: string;
11
- mimeTypes: string[];
12
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
13
- isAvailableInBrowser: false;
14
- requiredExecutables: never[];
15
- }>;
7
+ export declare const websiteScraperMetadata: any;
16
8
  /**
17
9
  * Registration of known scraper metadata
18
10
  *
@@ -1,4 +1,5 @@
1
1
  import type { PromptbookStorage } from '../_common/PromptbookStorage';
2
+ import { $side_effect } from '../../utils/organization/$side_effect';
2
3
  /**
3
4
  * Stores data in .env variables
4
5
  *
@@ -29,7 +30,7 @@ export declare class $EnvStorage<TItem> implements PromptbookStorage<TItem> {
29
30
  /**
30
31
  * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
31
32
  */
32
- setItem(key: string, value: TItem): Promise<void>;
33
+ setItem(key: string, value: TItem): Promise<$side_effect>;
33
34
  /**
34
35
  * 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.
35
36
  */
@@ -1,3 +1,4 @@
1
+ import { $side_effect } from '../organization/$side_effect';
1
2
  import type { ExecCommandOptions } from './ExecCommandOptions';
2
3
  /**
3
4
  * Run one command in a shell
@@ -10,7 +11,7 @@ import type { ExecCommandOptions } from './ExecCommandOptions';
10
11
  *
11
12
  * @public exported from `@promptbook/node`
12
13
  */
13
- export declare function $execCommand(options: ExecCommandOptions): Promise<string>;
14
+ export declare function $execCommand(options: ExecCommandOptions): Promise<$side_effect & string>;
14
15
  /**
15
16
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
16
17
  */
@@ -1,3 +1,4 @@
1
+ import { $side_effect } from '../organization/$side_effect';
1
2
  /**
2
3
  * Run multiple commands in a shell in sequence
3
4
  *
@@ -8,7 +9,7 @@
8
9
  *
9
10
  * @public exported from `@promptbook/node`
10
11
  */
11
- export declare function $execCommands({ commands, cwd, crashOnError, }: {
12
+ export declare function $execCommands({ commands, cwd, crashOnError, }: $side_effect & {
12
13
  readonly commands: string[];
13
14
  readonly cwd: string;
14
15
  readonly crashOnError?: boolean;
@@ -0,0 +1,13 @@
1
+ import { string_book } from '../../_packages/types.index';
2
+ import { $side_effect } from '../organization/$side_effect';
3
+ /**
4
+ * Download a Book in a browser
5
+ *
6
+ * Note: `$` is used to indicate that this function is not a pure function - its purpose is to cause a side effect (download a file)
7
+ *
8
+ * @public exported from `@promptbook/browser`
9
+ */
10
+ export declare function $induceBookDownload(book: string_book): Promise<$side_effect>;
11
+ /**
12
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
13
+ */
@@ -0,0 +1,13 @@
1
+ import { string_url } from '../../types/typeAliases';
2
+ import { $side_effect } from '../organization/$side_effect';
3
+ /**
4
+ * Download a File in a browser
5
+ *
6
+ * Note: `$` is used to indicate that this function is not a pure function - its purpose is to cause a side effect (download a file)
7
+ *
8
+ * @public exported from `@promptbook/browser`
9
+ */
10
+ export declare function $induceFileDownload(fileOrBlobOrUrl: File | Blob | URL | string_url): Promise<$side_effect>;
11
+ /**
12
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
13
+ */
@@ -0,0 +1,46 @@
1
+ import { IDestroyable, Registration } from 'destroyable';
2
+ import { string_mime_type, string_url } from '../../types/typeAliases';
3
+ /**
4
+ * Converts Blob, File or MediaSource to url using URL.createObjectURL
5
+ *
6
+ * @public exported from `@promptbook/browser`
7
+ */
8
+ export declare class ObjectUrl extends Registration implements IDestroyable {
9
+ readonly src: string_url;
10
+ private constructor();
11
+ /**
12
+ * Creates ObjectUrl from multiple input types
13
+ * Note: DO NOT forget to call destroy() when you are done with it
14
+ */
15
+ static from(source: Blob | File | MediaSource | string, mimeType: string_mime_type): ObjectUrl;
16
+ /**
17
+ * Creates ObjectUrl from string
18
+ * Note: DO NOT forget to call destroy() when you are done with it
19
+ */
20
+ static fromString(source: string, mimeType: string_mime_type): ObjectUrl;
21
+ /**
22
+ * Creates ObjectUrl
23
+ * DO NOT forget to call destroy() when you are done with it
24
+ */
25
+ static fromBlob(source: Blob | File | MediaSource): ObjectUrl;
26
+ /**
27
+ * Creates ObjectUrl:
28
+ * 1) With functionality for Blobs, Files or MediaSources
29
+ * 2) Just a wrapper for string urls
30
+ *
31
+ * DO NOT forget to call destroy() when you are done with it
32
+ */
33
+ static fromBlobOrUrl(source: Blob | File | MediaSource | URL | string_url): ObjectUrl;
34
+ /**
35
+ * Gets object url as string
36
+ * @alias src
37
+ */
38
+ get href(): string_url;
39
+ /**
40
+ * Gets object url as URL object
41
+ */
42
+ get url(): URL;
43
+ }
44
+ /**
45
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
46
+ */
@@ -0,0 +1,7 @@
1
+ import { really_any } from './really_any';
2
+ /**
3
+ * Organizational helper to mark a function that produces side effects
4
+ *
5
+ * @private within the repository
6
+ */
7
+ export type $side_effect = void | really_any;
@@ -1,4 +1,5 @@
1
1
  import type { ReadonlyDeep } from 'type-fest';
2
+ import { $side_effect } from '../organization/$side_effect';
2
3
  /**
3
4
  * Freezes the given object and all its nested objects recursively
4
5
  *
@@ -8,7 +9,7 @@ import type { ReadonlyDeep } from 'type-fest';
8
9
  * @returns The same object as the input, but deeply frozen
9
10
  * @public exported from `@promptbook/utils`
10
11
  */
11
- export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
12
+ export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<$side_effect & TObject>;
12
13
  /**
13
14
  * TODO: [🧠] Is there a way how to meaningfully test this utility
14
15
  */
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.103.0-11`).
18
+ * It follows semantic versioning (e.g., `0.103.0-14`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/vercel",
3
- "version": "0.103.0-12",
3
+ "version": "0.103.0-15",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -94,7 +94,7 @@
94
94
  "module": "./esm/index.es.js",
95
95
  "typings": "./esm/typings/src/_packages/vercel.index.d.ts",
96
96
  "peerDependencies": {
97
- "@promptbook/core": "0.103.0-12"
97
+ "@promptbook/core": "0.103.0-15"
98
98
  },
99
99
  "dependencies": {
100
100
  "colors": "1.4.0",