@promptbook/types 0.103.0-3 → 0.103.0-30

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 (85) hide show
  1. package/README.md +6 -207
  2. package/esm/typings/src/_packages/browser.index.d.ts +6 -0
  3. package/esm/typings/src/_packages/cli.index.d.ts +4 -0
  4. package/esm/typings/src/_packages/components.index.d.ts +12 -8
  5. package/esm/typings/src/_packages/core.index.d.ts +10 -0
  6. package/esm/typings/src/_packages/types.index.d.ts +10 -0
  7. package/esm/typings/src/_packages/wizard.index.d.ts +4 -0
  8. package/esm/typings/src/book-2.0/agent-source/padBook.d.ts +16 -0
  9. package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +76 -15
  10. package/esm/typings/src/book-components/BookEditor/BookEditorActionbar.d.ts +14 -0
  11. package/esm/typings/src/book-components/BookEditor/BookEditorMonaco.d.ts +5 -0
  12. package/esm/typings/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +15 -0
  13. package/esm/typings/src/book-components/Chat/MockedChat/MockedChat.d.ts +5 -0
  14. package/esm/typings/src/book-components/Qr/BrandedQrCode.d.ts +18 -0
  15. package/esm/typings/src/book-components/Qr/GenericQrCode.d.ts +10 -0
  16. package/esm/typings/src/book-components/Qr/PromptbookQrCode.d.ts +18 -0
  17. package/esm/typings/src/book-components/Qr/useQrCode.d.ts +15 -0
  18. package/esm/typings/src/book-components/_common/Dropdown/Dropdown.d.ts +15 -0
  19. package/esm/typings/src/book-components/_common/Modal/Modal.d.ts +4 -1
  20. package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts +1 -1
  21. package/esm/typings/src/book-components/icons/AboutIcon.d.ts +9 -0
  22. package/esm/typings/src/book-components/icons/CloseIcon.d.ts +4 -8
  23. package/esm/typings/src/book-components/icons/DownloadIcon.d.ts +9 -0
  24. package/esm/typings/src/book-components/icons/ExitFullscreenIcon.d.ts +7 -0
  25. package/esm/typings/src/book-components/icons/FullscreenIcon.d.ts +7 -0
  26. package/esm/typings/src/book-components/icons/MenuIcon.d.ts +12 -0
  27. package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +2 -1
  28. package/esm/typings/src/cli/cli-commands/about.d.ts +3 -1
  29. package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
  30. package/esm/typings/src/cli/cli-commands/list-models.d.ts +2 -1
  31. package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +2 -1
  32. package/esm/typings/src/cli/cli-commands/login.d.ts +2 -1
  33. package/esm/typings/src/cli/cli-commands/make.d.ts +2 -1
  34. package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
  35. package/esm/typings/src/cli/cli-commands/run.d.ts +2 -1
  36. package/esm/typings/src/cli/cli-commands/start-server.d.ts +3 -1
  37. package/esm/typings/src/cli/cli-commands/test-command.d.ts +2 -1
  38. package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +2 -1
  39. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +4 -5
  40. package/esm/typings/src/config.d.ts +14 -1
  41. package/esm/typings/src/execution/utils/usage-constants.d.ts +4 -124
  42. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +2 -1
  43. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +2 -1
  44. package/esm/typings/src/remote-server/startRemoteServer.d.ts +1 -0
  45. package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +1 -12
  46. package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +1 -9
  47. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +1 -12
  48. package/esm/typings/src/scrapers/document/register-metadata.d.ts +1 -9
  49. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +1 -12
  50. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +1 -9
  51. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +1 -12
  52. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +1 -9
  53. package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +1 -12
  54. package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +1 -9
  55. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +1 -12
  56. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +1 -9
  57. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +1 -12
  58. package/esm/typings/src/scrapers/website/register-metadata.d.ts +1 -9
  59. package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +2 -1
  60. package/esm/typings/src/transpilers/_common/BookTranspiler.d.ts +19 -0
  61. package/esm/typings/src/transpilers/_common/BookTranspilerDefinition.d.ts +37 -0
  62. package/esm/typings/src/transpilers/_common/BookTranspilerOptions.d.ts +19 -0
  63. package/esm/typings/src/transpilers/_common/register/$bookTranspilersRegister.d.ts +15 -0
  64. package/esm/typings/src/transpilers/langchain/LangchainTranspiler.d.ts +7 -0
  65. package/esm/typings/src/transpilers/langchain/register.d.ts +15 -0
  66. package/esm/typings/src/transpilers/openai/OpenAiSdkTranspiler.d.ts +13 -0
  67. package/esm/typings/src/transpilers/openai/register.d.ts +15 -0
  68. package/esm/typings/src/types/typeAliases.d.ts +1 -1
  69. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +2 -1
  70. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +2 -1
  71. package/esm/typings/src/utils/files/$induceBookDownload.d.ts +13 -0
  72. package/esm/typings/src/utils/files/$induceFileDownload.d.ts +13 -0
  73. package/esm/typings/src/utils/files/ObjectUrl.d.ts +46 -0
  74. package/esm/typings/src/utils/misc/aboutPromptbookInformation.d.ts +21 -0
  75. package/esm/typings/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts +1 -0
  76. package/esm/typings/src/utils/misc/xAboutPromptbookInformation.d.ts +13 -0
  77. package/esm/typings/src/utils/organization/$side_effect.d.ts +7 -0
  78. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +2 -1
  79. package/esm/typings/src/version.d.ts +1 -1
  80. package/package.json +2 -2
  81. package/esm/typings/src/book-components/BookEditor/BookEditorInner.d.ts +0 -5
  82. package/esm/typings/src/book-components/BookEditor/BookEditorWrapper.d.ts +0 -6
  83. package/esm/typings/src/book-components/BookEditor/config.d.ts +0 -10
  84. package/esm/typings/src/book-components/Chat/utils/renderMarkdown.d.ts +0 -21
  85. package/esm/typings/src/book-components/Chat/utils/renderMarkdown.test.d.ts +0 -1
@@ -0,0 +1,5 @@
1
+ import type { BookEditorProps } from './BookEditor';
2
+ /**
3
+ * @private Internal component used by `BookEditor`
4
+ */
5
+ export declare function BookEditorMonaco(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,15 @@
1
+ import type { string_markdown } from '../../../types/typeAliases';
2
+ type MarkdownContentProps = {
3
+ content: string_markdown;
4
+ className?: string;
5
+ };
6
+ /**
7
+ * Renders markdown content with support for code highlighting, math, and tables.
8
+ *
9
+ * @public exported from `@promptbook/components`
10
+ */
11
+ export declare function MarkdownContent(props: MarkdownContentProps): import("react/jsx-runtime").JSX.Element;
12
+ export {};
13
+ /**
14
+ * TODO: !!! Split into multiple files
15
+ */
@@ -42,6 +42,11 @@ export type MockedChatDelayConfig = {
42
42
  * If true, disables typing effect and shows full message at once (BLOCKY_FLOW)
43
43
  */
44
44
  blocky?: boolean;
45
+ /**
46
+ * This prop will allow to show N first messages immediately, while the rest will be typed out with delays
47
+ * @default 0
48
+ */
49
+ showIntermediateMessages?: number;
45
50
  };
46
51
  /**
47
52
  * Props for MockedChat component
@@ -0,0 +1,18 @@
1
+ import { QrCodeOptions } from './useQrCode';
2
+ type BrandedQrCodeProps = QrCodeOptions & {
3
+ /**
4
+ * Width and height of the QR code canvas
5
+ *
6
+ * @default 250
7
+ */
8
+ size?: number;
9
+ /**
10
+ * Additional CSS class names to apply to the container div
11
+ */
12
+ className?: string;
13
+ };
14
+ /**
15
+ * @public exported from `@promptbook/components`
16
+ */
17
+ export declare function BrandedQrCode(props: BrandedQrCodeProps): import("react/jsx-runtime").JSX.Element;
18
+ export {};
@@ -0,0 +1,10 @@
1
+ type GenericQrCodeProps = {
2
+ value: string | number;
3
+ size?: number;
4
+ className?: string;
5
+ };
6
+ /**
7
+ * @public exported from `@promptbook/components`
8
+ */
9
+ export declare function GenericQrCode({ value, size, className }: GenericQrCodeProps): import("react/jsx-runtime").JSX.Element;
10
+ export {};
@@ -0,0 +1,18 @@
1
+ type PromptbookQrCodeProps = {
2
+ value: string | number;
3
+ /**
4
+ * Width and height of the QR code canvas
5
+ *
6
+ * @default 250
7
+ */
8
+ size?: number;
9
+ /**
10
+ * Additional CSS class names to apply to the container div
11
+ */
12
+ className?: string;
13
+ };
14
+ /**
15
+ * @public exported from `@promptbook/components`
16
+ */
17
+ export declare function PromptbookQrCode(props: PromptbookQrCodeProps): import("react/jsx-runtime").JSX.Element;
18
+ export {};
@@ -0,0 +1,15 @@
1
+ /// <reference types="react" />
2
+ import type { QRCodeRenderersOptions } from 'qrcode';
3
+ import { string_url_image } from '../../types/typeAliases';
4
+ export type QrCodeOptions = QRCodeRenderersOptions & {
5
+ value: string | number;
6
+ logoSrc?: string_url_image;
7
+ };
8
+ /**
9
+ *
10
+ *
11
+ * @private utility of QR code components
12
+ */
13
+ export declare function useQrCode(options: QrCodeOptions): {
14
+ canvasRef: import("react").RefObject<HTMLCanvasElement | null>;
15
+ };
@@ -0,0 +1,15 @@
1
+ import { JSX } from 'react';
2
+ type DropdownProps = {
3
+ actions: Array<{
4
+ icon: JSX.Element;
5
+ name: string;
6
+ onClick: () => void;
7
+ }>;
8
+ };
9
+ /**
10
+ * @@@
11
+ *
12
+ * @private internal subcomponent used by various components
13
+ */
14
+ export declare function Dropdown({ actions }: DropdownProps): import("react/jsx-runtime").JSX.Element;
15
+ export {};
@@ -1,10 +1,13 @@
1
1
  import { ReactNode } from 'react';
2
2
  /**
3
3
  *
4
- * @private internal subcomponent of `<Chat>` component
4
+ * @private internal subcomponent used by various components
5
5
  */
6
6
  export declare function Modal({ children, onClose, className, }: {
7
7
  children: ReactNode;
8
8
  onClose: () => void;
9
9
  className?: string;
10
10
  }): import("react").ReactPortal;
11
+ /**
12
+ * TODO: !!!! Use this also for feedback modal in Chat component - Make modals DRY
13
+ */
@@ -4,4 +4,4 @@ import type { string_css_class } from '../../../types/typeAliases';
4
4
  *
5
5
  * @private within the `@promptbook/components`
6
6
  */
7
- export declare function classNames(...classes: Array<string_css_class | undefined | false | null>): string_css_class;
7
+ export declare function classNames(...classes: Array<string_css_class | undefined | false | null | 0>): string_css_class;
@@ -0,0 +1,9 @@
1
+ import { SVGProps } from 'react';
2
+ /**
3
+ * @@@
4
+ *
5
+ * @private internal subcomponent used by various components
6
+ */
7
+ export declare function AboutIcon(props: SVGProps<SVGSVGElement> & {
8
+ size?: number;
9
+ }): import("react/jsx-runtime").JSX.Element;
@@ -1,11 +1,7 @@
1
- type CloseIconProps = {
2
- size?: number;
3
- color?: string;
4
- };
1
+ import { JSX } from 'react';
5
2
  /**
6
- * @@@
3
+ * Renders an icon that represents the close action
7
4
  *
8
- * @public exported from `@promptbook/components`
5
+ * @private
9
6
  */
10
- export declare function CloseIcon({ size, color }: CloseIconProps): import("react/jsx-runtime").JSX.Element;
11
- export {};
7
+ export declare function CloseIcon(): JSX.Element;
@@ -0,0 +1,9 @@
1
+ import { SVGProps } from 'react';
2
+ /**
3
+ * @@@
4
+ *
5
+ * @private internal subcomponent used by various components
6
+ */
7
+ export declare function DownloadIcon(props: SVGProps<SVGSVGElement> & {
8
+ size?: number;
9
+ }): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,7 @@
1
+ import { JSX } from 'react';
2
+ /**
3
+ * Renders an icon that represents the exit fullscreen action
4
+ *
5
+ * @private
6
+ */
7
+ export declare function ExitFullscreenIcon(): JSX.Element;
@@ -0,0 +1,7 @@
1
+ import { JSX } from 'react';
2
+ /**
3
+ * Renders an icon that represents the fullscreen action
4
+ *
5
+ * @private
6
+ */
7
+ export declare function FullscreenIcon(): JSX.Element;
@@ -0,0 +1,12 @@
1
+ import { SVGProps } from 'react';
2
+ /**
3
+ * @@@
4
+ *
5
+ * @private internal subcomponent used by various components
6
+ */
7
+ export declare function MenuIcon(props: SVGProps<SVGSVGElement> & {
8
+ size?: number;
9
+ }): import("react/jsx-runtime").JSX.Element;
10
+ /**
11
+ * TODO: !!! Mark all components to not be used outside of browser
12
+ */
@@ -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 `boilerplate` 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 $initializeBoilerplateCommand(program: Program): void;
10
+ export declare function $initializeBoilerplateCommand(program: Program): $side_effect;
10
11
  /**
11
12
  * Note: [💞] Ignore a discrepancy between file name and entity name
12
13
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
@@ -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 `about` command for Promptbook CLI utilities
4
5
  *
@@ -6,8 +7,9 @@ import type { Command as Program } from 'commander';
6
7
  *
7
8
  * @private internal function of `promptbookCli`
8
9
  */
9
- export declare function $initializeAboutCommand(program: Program): void;
10
+ export declare function $initializeAboutCommand(program: Program): $side_effect;
10
11
  /**
12
+ * TODO: [🕋] Use here `aboutPromptbookInformation`
11
13
  * TODO: [🗽] Unite branding and make single place for it
12
14
  * Note: [💞] Ignore a discrepancy between file name and entity name
13
15
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
@@ -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 testing `hello` 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 $initializeHelloCommand(program: Program): void;
10
+ export declare function $initializeHelloCommand(program: Program): $side_effect;
10
11
  /**
11
12
  * TODO: [🧠][🐣] Make here some easter egg with generated hello greeting via LLM models
12
13
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -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 `list-models` 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 $initializeListModelsCommand(program: Program): void;
10
+ export declare function $initializeListModelsCommand(program: Program): $side_effect;
10
11
  /**
11
12
  * Note: [💞] Ignore a discrepancy between file name and entity name
12
13
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
@@ -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 `list-scrapers` 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 $initializeListScrapersCommand(program: Program): void;
10
+ export declare function $initializeListScrapersCommand(program: Program): $side_effect;
10
11
  /**
11
12
  * Note: [💞] Ignore a discrepancy between file name and entity name
12
13
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
@@ -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 `login` 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 $initializeLoginCommand(program: Program): void;
10
+ export declare function $initializeLoginCommand(program: Program): $side_effect;
10
11
  /**
11
12
  * TODO: Implement non-interactive login
12
13
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -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 `make` 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 $initializeMakeCommand(program: Program): void;
10
+ export declare function $initializeMakeCommand(program: Program): $side_effect;
10
11
  /**
11
12
  * TODO: [🥃][main] !!3 Allow `ptbk make` without configuring any llm tools
12
13
  * TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types
@@ -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 `prettify` 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 $initializePrettifyCommand(program: Program): void;
10
+ export declare function $initializePrettifyCommand(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,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 `run` 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 $initializeRunCommand(program: Program): void;
10
+ export declare function $initializeRunCommand(program: Program): $side_effect;
10
11
  /**
11
12
  * TODO: !!5 Catch and wrap all errors from CLI
12
13
  * TODO: [🧠] Pass `maxExecutionAttempts`, `csvSettings`
@@ -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 `start-server` command for Promptbook CLI utilities
4
5
  *
@@ -6,8 +7,9 @@ import type { Command as Program } from 'commander';
6
7
  *
7
8
  * @private internal function of `promptbookCli`
8
9
  */
9
- export declare function $initializeStartServerCommand(program: Program): void;
10
+ export declare function $initializeStartServerCommand(program: Program): $side_effect;
10
11
  /**
12
+ * TODO: [🕋] Use here `aboutPromptbookInformation`
11
13
  * Note: [💞] Ignore a discrepancy between file name and entity name
12
14
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
13
15
  */
@@ -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): void;
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): void;
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): void;
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): void;
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,20 @@ 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
- * Dark color of the Promptbook
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 LINE: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
57
+ readonly COMMITMENT: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
58
+ readonly PARAMETER: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
59
+ };
60
+ /**
61
+ * Chat color of the Promptbook (in chat)
49
62
  *
50
63
  * TODO: [🗽] Unite branding and make single place for it
51
64
  *
@@ -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
  *
@@ -11,6 +11,7 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
11
11
  */
12
12
  export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
13
13
  /**
14
+ * TODO: [🕋] Use here `aboutPromptbookInformation`
14
15
  * TODO: [🌡] Add CORS and security - probably via `helmet`
15
16
  * TODO: Split this file into multiple functions - handler for each request
16
17
  * TODO: Maybe use `$exportJson`