@promptbook/types 0.103.0-3 → 0.103.0-31
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/README.md +6 -207
- package/esm/typings/src/_packages/browser.index.d.ts +6 -0
- package/esm/typings/src/_packages/cli.index.d.ts +4 -0
- package/esm/typings/src/_packages/components.index.d.ts +12 -8
- package/esm/typings/src/_packages/core.index.d.ts +10 -0
- package/esm/typings/src/_packages/types.index.d.ts +10 -0
- package/esm/typings/src/_packages/wizard.index.d.ts +4 -0
- package/esm/typings/src/book-2.0/agent-source/padBook.d.ts +16 -0
- package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +76 -15
- package/esm/typings/src/book-components/BookEditor/BookEditorActionbar.d.ts +14 -0
- package/esm/typings/src/book-components/BookEditor/BookEditorMonaco.d.ts +5 -0
- package/esm/typings/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +15 -0
- package/esm/typings/src/book-components/Chat/MockedChat/MockedChat.d.ts +5 -0
- package/esm/typings/src/book-components/Qr/BrandedQrCode.d.ts +18 -0
- package/esm/typings/src/book-components/Qr/GenericQrCode.d.ts +10 -0
- package/esm/typings/src/book-components/Qr/PromptbookQrCode.d.ts +18 -0
- package/esm/typings/src/book-components/Qr/useQrCode.d.ts +15 -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 +4 -1
- package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts +1 -1
- package/esm/typings/src/book-components/icons/AboutIcon.d.ts +9 -0
- package/esm/typings/src/book-components/icons/CloseIcon.d.ts +4 -8
- package/esm/typings/src/book-components/icons/DownloadIcon.d.ts +9 -0
- package/esm/typings/src/book-components/icons/ExitFullscreenIcon.d.ts +7 -0
- package/esm/typings/src/book-components/icons/FullscreenIcon.d.ts +7 -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 +3 -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 +3 -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 +14 -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/remote-server/startRemoteServer.d.ts +1 -0
- 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/transpilers/_common/BookTranspiler.d.ts +19 -0
- package/esm/typings/src/transpilers/_common/BookTranspilerDefinition.d.ts +37 -0
- package/esm/typings/src/transpilers/_common/BookTranspilerOptions.d.ts +19 -0
- package/esm/typings/src/transpilers/_common/register/$bookTranspilersRegister.d.ts +15 -0
- package/esm/typings/src/transpilers/langchain/LangchainTranspiler.d.ts +7 -0
- package/esm/typings/src/transpilers/langchain/register.d.ts +15 -0
- package/esm/typings/src/transpilers/openai/OpenAiSdkTranspiler.d.ts +13 -0
- package/esm/typings/src/transpilers/openai/register.d.ts +15 -0
- package/esm/typings/src/types/typeAliases.d.ts +1 -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/misc/aboutPromptbookInformation.d.ts +21 -0
- package/esm/typings/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts +1 -0
- package/esm/typings/src/utils/misc/xAboutPromptbookInformation.d.ts +13 -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/esm/typings/src/book-components/BookEditor/BookEditorInner.d.ts +0 -5
- package/esm/typings/src/book-components/BookEditor/BookEditorWrapper.d.ts +0 -6
- package/esm/typings/src/book-components/BookEditor/config.d.ts +0 -10
- package/esm/typings/src/book-components/Chat/utils/renderMarkdown.d.ts +0 -21
- package/esm/typings/src/book-components/Chat/utils/renderMarkdown.test.d.ts +0 -1
|
@@ -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
|
*/
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { BookTranspilerOptions } from './BookTranspilerOptions';
|
|
2
|
+
/**
|
|
3
|
+
* Transpiler takes a book and transpiles it into another format.
|
|
4
|
+
*/
|
|
5
|
+
export type BookTranspiler =
|
|
6
|
+
/**
|
|
7
|
+
* Transpiles a book.
|
|
8
|
+
*
|
|
9
|
+
* @param book book to transpile
|
|
10
|
+
* @param options additional options for the transpiler
|
|
11
|
+
* @returns transpiled book
|
|
12
|
+
*/
|
|
13
|
+
(book: string, options: BookTranspilerOptions) => Promise<string>;
|
|
14
|
+
/**
|
|
15
|
+
* TODO: [🧠] Should there be a BookTranspiler class or just a function?
|
|
16
|
+
* Maybe a class with a constructor that takes ExecutionTools.
|
|
17
|
+
* Then the instance would be a function.
|
|
18
|
+
* @see LlmExecutionTools
|
|
19
|
+
*/
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import type { ExecutionTools } from '../../execution/ExecutionTools';
|
|
2
|
+
import type { string_name, string_title } from '../../types/typeAliases';
|
|
3
|
+
import type { Registered } from '../../utils/misc/$Register';
|
|
4
|
+
import type { BookTranspiler } from './BookTranspiler';
|
|
5
|
+
/**
|
|
6
|
+
* Definition of a book transpiler.
|
|
7
|
+
*
|
|
8
|
+
* @see https://github.com/webgptorg/promptbook/issues/249
|
|
9
|
+
*/
|
|
10
|
+
export type BookTranspilerDefinition = Registered & {
|
|
11
|
+
/**
|
|
12
|
+
* The name of the transpiler.
|
|
13
|
+
* It is used to identify the transpiler in the register.
|
|
14
|
+
*
|
|
15
|
+
* @example 'python-langchain'
|
|
16
|
+
*/
|
|
17
|
+
readonly name: string_name;
|
|
18
|
+
/**
|
|
19
|
+
* The title of the transpiler.
|
|
20
|
+
* It is used to display the transpiler in the UI.
|
|
21
|
+
*
|
|
22
|
+
* @example 'Python Langchain'
|
|
23
|
+
*/
|
|
24
|
+
readonly title: string_title;
|
|
25
|
+
/**
|
|
26
|
+
* The factory function to create a transpiler instance.
|
|
27
|
+
* It can be async.
|
|
28
|
+
*
|
|
29
|
+
* @param tools the execution tools that can be used by the transpiler
|
|
30
|
+
* @returns the transpiler instance
|
|
31
|
+
*/
|
|
32
|
+
readonly new: (tools: ExecutionTools) => BookTranspiler | Promise<BookTranspiler>;
|
|
33
|
+
};
|
|
34
|
+
/**
|
|
35
|
+
* TODO: [🧠] What other information should be in the public profile of the transpiler?
|
|
36
|
+
* - input format, output format, version, description, icon, etc.
|
|
37
|
+
*/
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Options for the BookTranspiler.
|
|
3
|
+
*
|
|
4
|
+
* @see https://github.com/webgptorg/promptbook/issues/249
|
|
5
|
+
*/
|
|
6
|
+
export type BookTranspilerOptions = {
|
|
7
|
+
/**
|
|
8
|
+
* If true, the transpiler will log verbose information to the console.
|
|
9
|
+
*
|
|
10
|
+
* @default false
|
|
11
|
+
*/
|
|
12
|
+
readonly isVerbose?: boolean;
|
|
13
|
+
/**
|
|
14
|
+
* If true, the transpiler will include comments in the output.
|
|
15
|
+
*
|
|
16
|
+
* @default true
|
|
17
|
+
*/
|
|
18
|
+
readonly shouldIncludeComments?: boolean;
|
|
19
|
+
};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { $Register } from '../../../utils/misc/$Register';
|
|
2
|
+
import type { BookTranspilerDefinition } from '../BookTranspilerDefinition';
|
|
3
|
+
/**
|
|
4
|
+
* Register for book transpilers.
|
|
5
|
+
*
|
|
6
|
+
* Note: `$` is used to indicate that this interacts with the global scope
|
|
7
|
+
* @singleton Only one instance of each register is created per build, but there can be more instances across different builds or environments.
|
|
8
|
+
* @see https://github.com/webgptorg/promptbook/issues/249
|
|
9
|
+
*
|
|
10
|
+
* @public exported from `@promptbook/core`
|
|
11
|
+
*/
|
|
12
|
+
export declare const $bookTranspilersRegister: $Register<BookTranspilerDefinition>;
|
|
13
|
+
/**
|
|
14
|
+
* TODO: [®] DRY Register logic
|
|
15
|
+
*/
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { BookTranspilerDefinition } from '../_common/BookTranspilerDefinition';
|
|
2
|
+
/**
|
|
3
|
+
* Transpiler to Python code using LangChain library.
|
|
4
|
+
*
|
|
5
|
+
* @private TODO: !!!! Which package should export this?
|
|
6
|
+
*/
|
|
7
|
+
export declare const LangchainTranspiler: BookTranspilerDefinition;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { Registration } from '../../_packages/types.index';
|
|
2
|
+
/**
|
|
3
|
+
* Registration of LLM provider
|
|
4
|
+
*
|
|
5
|
+
* Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
|
|
6
|
+
*
|
|
7
|
+
* @public exported from `@promptbook/wizard`
|
|
8
|
+
* @public exported from `@promptbook/cli`
|
|
9
|
+
*
|
|
10
|
+
* TODO: !!!! Which package should export this?
|
|
11
|
+
*/
|
|
12
|
+
export declare const _LangchainTranspilerRegistration: Registration;
|
|
13
|
+
/**
|
|
14
|
+
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
15
|
+
*/
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { BookTranspilerDefinition } from '../_common/BookTranspilerDefinition';
|
|
2
|
+
/**
|
|
3
|
+
* Transpiler to Javascript code using OpenAI SDK.
|
|
4
|
+
*
|
|
5
|
+
* @private TODO: !!!! Which package should export this?
|
|
6
|
+
*/
|
|
7
|
+
export declare const OpenAiSdkTranspiler: BookTranspilerDefinition;
|
|
8
|
+
/**
|
|
9
|
+
* TODO: [🧠] What should be the scope of the transpiled code?
|
|
10
|
+
* - Just a single function?
|
|
11
|
+
* - A class?
|
|
12
|
+
* - A whole package?
|
|
13
|
+
*/
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { Registration } from '../../_packages/types.index';
|
|
2
|
+
/**
|
|
3
|
+
* Registration of LLM provider
|
|
4
|
+
*
|
|
5
|
+
* Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
|
|
6
|
+
*
|
|
7
|
+
* @public exported from `@promptbook/wizard`
|
|
8
|
+
* @public exported from `@promptbook/cli`
|
|
9
|
+
*
|
|
10
|
+
* TODO: !!!! Which package should export this?
|
|
11
|
+
*/
|
|
12
|
+
export declare const _OpenAiSdkTranspilerRegistration: Registration;
|
|
13
|
+
/**
|
|
14
|
+
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
15
|
+
*/
|
|
@@ -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
|
+
*/
|
|
@@ -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,21 @@
|
|
|
1
|
+
import type { string_markdown } from '../../types/typeAliases';
|
|
2
|
+
export type AboutPromptbookInformationOptions = {
|
|
3
|
+
/**
|
|
4
|
+
* Include information about available servers
|
|
5
|
+
*
|
|
6
|
+
* @default true
|
|
7
|
+
*/
|
|
8
|
+
isServersInfoIncluded?: boolean;
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Provide information about Promptbook, engine version, book language version, servers, ...
|
|
12
|
+
*
|
|
13
|
+
* @param options Which information to include
|
|
14
|
+
* @returns Information about Promptbook in markdown format
|
|
15
|
+
*
|
|
16
|
+
* @public exported from `@promptbook/core`
|
|
17
|
+
*/
|
|
18
|
+
export declare function aboutPromptbookInformation(options?: AboutPromptbookInformationOptions): string_markdown;
|
|
19
|
+
/**
|
|
20
|
+
* TODO: [🗽] Unite branding and make single place for it
|
|
21
|
+
*/
|
|
@@ -16,5 +16,6 @@ export type InjectCssModuleIntoShadowRootOptions = {
|
|
|
16
16
|
*
|
|
17
17
|
* @public exported from `@promptbook/components`
|
|
18
18
|
* <- TODO: [🧠] Make `@promptbook/components-utils`
|
|
19
|
+
* @deprecated This was used for BookEditor shadow DOM support, which is no longer needed
|
|
19
20
|
*/
|
|
20
21
|
export declare function injectCssModuleIntoShadowRoot(options: InjectCssModuleIntoShadowRootOptions): void;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { AboutPromptbookInformationOptions } from './aboutPromptbookInformation';
|
|
2
|
+
type AboutPromptbookInformationProps = AboutPromptbookInformationOptions;
|
|
3
|
+
/**
|
|
4
|
+
* Provide information about Promptbook, engine version, book language version, servers, ...
|
|
5
|
+
*
|
|
6
|
+
* @public exported from `@promptbook/components`
|
|
7
|
+
*/
|
|
8
|
+
export declare function AboutPromptbookInformation(props: AboutPromptbookInformationProps): import("react/jsx-runtime").JSX.Element;
|
|
9
|
+
export {};
|
|
10
|
+
/**
|
|
11
|
+
* TODO: !!! Remove "x" from filename
|
|
12
|
+
* TODO: [🗽] Unite branding and make single place for it
|
|
13
|
+
*/
|
|
@@ -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
|
|
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
|
*/
|