@promptbook/vercel 0.103.0-14 → 0.103.0-16
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.
- package/esm/index.es.js +29 -4
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/browser.index.d.ts +6 -0
- package/esm/typings/src/_packages/core.index.d.ts +2 -0
- package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +23 -0
- package/esm/typings/src/book-components/BookEditor/BookEditorActionbar.d.ts +11 -0
- package/esm/typings/src/book-components/_common/Dropdown/Dropdown.d.ts +15 -0
- package/esm/typings/src/book-components/_common/Modal/Modal.d.ts +2 -2
- package/esm/typings/src/book-components/icons/AboutIcon.d.ts +9 -0
- package/esm/typings/src/book-components/icons/DownloadIcon.d.ts +9 -0
- package/esm/typings/src/book-components/icons/MenuIcon.d.ts +12 -0
- package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/about.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/list-models.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/login.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/make.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/run.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/start-server.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/test-command.d.ts +2 -1
- package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +2 -1
- package/esm/typings/src/commands/_common/types/CommandParser.d.ts +4 -5
- package/esm/typings/src/config.d.ts +13 -1
- package/esm/typings/src/execution/utils/usage-constants.d.ts +4 -124
- package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +2 -1
- package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +2 -1
- package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +1 -12
- package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +1 -9
- package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +1 -12
- package/esm/typings/src/scrapers/document/register-metadata.d.ts +1 -9
- package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +1 -12
- package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +1 -9
- package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +1 -12
- package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +1 -9
- package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +1 -12
- package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +1 -9
- package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +1 -12
- package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +1 -9
- package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +1 -12
- package/esm/typings/src/scrapers/website/register-metadata.d.ts +1 -9
- package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +2 -1
- package/esm/typings/src/utils/execCommand/$execCommand.d.ts +2 -1
- package/esm/typings/src/utils/execCommand/$execCommands.d.ts +2 -1
- package/esm/typings/src/utils/files/$induceBookDownload.d.ts +13 -0
- package/esm/typings/src/utils/files/$induceFileDownload.d.ts +13 -0
- package/esm/typings/src/utils/files/ObjectUrl.d.ts +46 -0
- package/esm/typings/src/utils/organization/$side_effect.d.ts +7 -0
- package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +2 -1
- package/esm/typings/src/version.d.ts +1 -1
- package/package.json +2 -2
- package/umd/index.umd.js +29 -4
- package/umd/index.umd.js.map +1 -1
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { Command as Program } from 'commander';
|
|
2
|
+
import { $side_effect } from '../../utils/organization/$side_effect';
|
|
2
3
|
/**
|
|
3
4
|
* Initializes `test` command for Promptbook CLI utilities
|
|
4
5
|
*
|
|
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
|
|
|
6
7
|
*
|
|
7
8
|
* @private internal function of `promptbookCli`
|
|
8
9
|
*/
|
|
9
|
-
export declare function $initializeTestCommand(program: Program):
|
|
10
|
+
export declare function $initializeTestCommand(program: Program): $side_effect;
|
|
10
11
|
/**
|
|
11
12
|
* TODO: [😶] Unite folder listing
|
|
12
13
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command } from 'commander';
|
|
2
|
+
import { $side_effect } from '../../utils/organization/$side_effect';
|
|
2
3
|
/**
|
|
3
4
|
* Note: `$` is used to indicate that this function is not a pure function - it registers an option in the CLI
|
|
4
5
|
*
|
|
5
6
|
* @private utility of CLI
|
|
6
7
|
*/
|
|
7
|
-
export declare function $addGlobalOptionsToCommand(command: Command):
|
|
8
|
+
export declare function $addGlobalOptionsToCommand(command: Command): $side_effect;
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
import type { SetOptional, WritableDeep } from 'type-fest';
|
|
2
2
|
import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
|
|
3
3
|
import type { TaskJson } from '../../../pipeline/PipelineJson/TaskJson';
|
|
4
|
-
import type { string_markdown_text } from '../../../types/typeAliases';
|
|
5
|
-
import type { string_name } from '../../../types/typeAliases';
|
|
6
|
-
import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
|
|
4
|
+
import type { string_markdown_text, string_name, string_promptbook_documentation_url } from '../../../types/typeAliases';
|
|
7
5
|
import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
|
|
6
|
+
import { $side_effect } from '../../../utils/organization/$side_effect';
|
|
8
7
|
import type { ___and___ } from '../../../utils/organization/___and___';
|
|
9
8
|
import type { CommandUsagePlace } from './CommandUsagePlaces';
|
|
10
9
|
/**
|
|
@@ -98,7 +97,7 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
|
|
|
98
97
|
*
|
|
99
98
|
* Note: `$` is used to indicate that this function mutates given `pipelineJson`
|
|
100
99
|
*/
|
|
101
|
-
$applyToPipelineJson(command: TCommand, $pipelineJson: $PipelineJson):
|
|
100
|
+
$applyToPipelineJson(command: TCommand, $pipelineJson: $PipelineJson): $side_effect;
|
|
102
101
|
/**
|
|
103
102
|
* Reads the command from the `PipelineJson`
|
|
104
103
|
*
|
|
@@ -126,7 +125,7 @@ export type PipelineTaskCommandParser<TCommand extends CommandBase> = CommonComm
|
|
|
126
125
|
*
|
|
127
126
|
* Note: `$` is used to indicate that this function mutates given `taskJson` and/or `pipelineJson`
|
|
128
127
|
*/
|
|
129
|
-
$applyToTaskJson(command: TCommand, $taskJson: $TaskJson, $pipelineJson: $PipelineJson):
|
|
128
|
+
$applyToTaskJson(command: TCommand, $taskJson: $TaskJson, $pipelineJson: $PipelineJson): $side_effect;
|
|
130
129
|
/**
|
|
131
130
|
* Reads the command from the `TaskJson`
|
|
132
131
|
*
|
|
@@ -45,7 +45,19 @@ export declare const CLAIM = "Turn your company's scattered knowledge into AI re
|
|
|
45
45
|
*/
|
|
46
46
|
export declare const PROMPTBOOK_COLOR: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
|
|
47
47
|
/**
|
|
48
|
-
*
|
|
48
|
+
* Colors for syntax highlighting in the `<BookEditor/>`
|
|
49
|
+
*
|
|
50
|
+
* TODO: [🗽] Unite branding and make single place for it
|
|
51
|
+
*
|
|
52
|
+
* @public exported from `@promptbook/core`
|
|
53
|
+
*/
|
|
54
|
+
export declare const PROMPTBOOK_SYNTAX_COLORS: {
|
|
55
|
+
readonly TITLE: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
|
|
56
|
+
readonly COMMITMENT: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
|
|
57
|
+
readonly PARAMETER: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
|
|
58
|
+
};
|
|
59
|
+
/**
|
|
60
|
+
* Chat color of the Promptbook (in chat)
|
|
49
61
|
*
|
|
50
62
|
* TODO: [🗽] Unite branding and make single place for it
|
|
51
63
|
*
|
|
@@ -3,145 +3,25 @@
|
|
|
3
3
|
*
|
|
4
4
|
* @public exported from `@promptbook/core`
|
|
5
5
|
*/
|
|
6
|
-
export declare const ZERO_VALUE:
|
|
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:
|
|
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:
|
|
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:
|
|
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):
|
|
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):
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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
|
|
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
|
|
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
|
+
*/
|