@promptbook/openai 0.103.0-2 → 0.103.0-21

package/esm/typings/src/book-2.0/agent-source/padBook.d.ts

@@ -0,0 +1,16 @@
+import { string_book } from './string_book';
+/**
+ *  Number of padding lines to add at the end of the book content
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PADDING_LINES = 11;
+/**
+ * A function that adds padding to the book content
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function padBook(content: string_book): string_book;
+/**
+ * TODO: [🧠] Maybe export
+ */

package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts

@@ -1,4 +1,5 @@
 import type { AgentBasicInformation } from '../../../book-2.0/agent-source/AgentBasicInformation';
+import type { string_book } from '../../../book-2.0/agent-source/string_book';
 import type { string_css_class } from '../../../types/typeAliases';
 /**
  * Props of `AvatarProfile`
@@ -10,6 +11,10 @@ export type AvatarProfileProps = {
      * Agent to be shown
      */
     readonly agent: AgentBasicInformation;
+    /**
+     * The source of the agent, which will be displayed in the BookEditor.
+     */
+    readonly agentSource: string_book;
     /**
      * Optional CSS class name which will be added to root <div> element
      */

package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfileTooltip.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="react" />
+import type { string_book } from '../../../book-2.0/agent-source/string_book';
+type AvatarProfileTooltipProps = {
+    agentSource: string_book;
+    position: {
+        top: number;
+        left: number;
+    };
+};
+/**
+ *
+ * @private internal subcomponent of `<Chat>` component
+ */
+export declare const AvatarProfileTooltip: import("react").ForwardRefExoticComponent<AvatarProfileTooltipProps & import("react").RefAttributes<HTMLDivElement>>;
+export {};

package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts

@@ -1,13 +1,25 @@
 import type { CSSProperties } from 'react';
 import type { Promisable } from 'type-fest';
-import type { string_book } from '../../book-2.0/agent-source/string_book';
-import type { string_knowledge_source_content } from '../../types/typeAliases';
+import { type string_book } from '../../book-2.0/agent-source/string_book';
+import type { number_percent, number_positive, string_css_value, string_knowledge_source_content } from '../../types/typeAliases';
+/**
+ * Default height of the book editor
+ *
+ * Note: This height is computed based on the number of lines in the default book + padding multiplied by an estimated line height.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const DEFAULT_BOOK_EDITOR_HEIGHT: number;
 /**
  * Props of `BookEditor`
  *
  * @public exported from `@promptbook/components`
  */
 export type BookEditorProps = {
+    /**
+     * The source of the agent to be displayed in the editor.
+     */
+    readonly agentSource?: string_book;
     /**
      * Additional CSS classes to apply to the editor container.
      */
@@ -17,10 +29,21 @@ export type BookEditorProps = {
      */
     readonly style?: CSSProperties;
     /**
-     * CSS className for a font (e.g. from next/font) to style the editor text.
-     * If omitted, defaults to system serif fonts.
+     * Height of the `BookEditor` component
+     *
+     * - You can use any valid CSS value, e.g., `500px`, `100%`, `50vh`, etc.
+     * - If not set, the default height is `DEFAULT_BOOK_EDITOR_HEIGHT`.
+     * - If set to `null`, the height should be controlled entirely via `className` or `style`, otherwise the editor will have zero height.
+     *
+     * @default `DEFAULT_BOOK_EDITOR_HEIGHT`
+     */
+    readonly height?: string_css_value | null;
+    /**
+     * Zoom level of the editor
+     *
+     * @default 1 (100%)
      */
-    readonly fontClassName?: string;
+    readonly zoom?: number_percent & number_positive;
     /**
      * The book which is being edited.
      */
@@ -42,10 +65,45 @@ export type BookEditorProps = {
      */
     readonly isBorderRadiusDisabled?: boolean;
     /**
-     * If true, shows the footer with book title and version information.
-     * By default, the footer is hidden.
+     * If true, the editor is in read-only mode
+     *
+     * @default false
+     */
+    readonly isReadonly?: boolean;
+    /**
+     * Optional translations for the component
+     */
+    readonly translations?: {
+        /**
+         * Message to show when trying to edit a readonly editor
+         *
+         * @default "You cannot edit this book"
+         */
+        readonly readonlyMessage?: string;
+    };
+    /**
+     * If true, shows the download button in the action bar.
+     * By default, the download button is shown.
+     */
+    readonly isDownloadButtonShown?: boolean;
+    /**
+     * If true, shows the about button in the action bar.
+     * By default, the about button is shown.
+     */
+    readonly isAboutButtonShown?: boolean;
+    /**
+     * If defined, the editor will be synced with other editors with the same sync configuration.
      */
-    readonly isFooterShown?: boolean;
+    readonly sync?: {
+        /**
+         * The URL of the y-websocket server.
+         */
+        readonly serverUrl: string;
+        /**
+         * The name of the room to join.
+         */
+        readonly roomName: string;
+    };
 };
 /**
  * Renders a book editor

package/esm/typings/src/book-components/BookEditor/BookEditorActionbar.d.ts

@@ -0,0 +1,11 @@
+type BookEditorActionbarProps = {
+    value: string | undefined;
+    isDownloadButtonShown?: boolean;
+    isAboutButtonShown?: boolean;
+};
+/**
+ *
+ * @private Internal component used by `BookEditor`
+ */
+export declare function BookEditorActionbar(props: BookEditorActionbarProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/esm/typings/src/book-components/BookEditor/BookEditorMonaco.d.ts

@@ -0,0 +1,5 @@
+import type { BookEditorProps } from './BookEditor';
+/**
+ * @private Internal component used by `BookEditor`
+ */
+export declare function BookEditorMonaco(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/BookEditor/config.d.ts

@@ -3,6 +3,7 @@
  * In Next.js environments, you can override this by importing the font directly
  *
  * @public exported from `@promptbook/components`
+ * @deprecated !!! Remove
  */
 export declare const DEFAULT_BOOK_FONT_CLASS: any;
 /**

package/esm/typings/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts

@@ -0,0 +1,12 @@
+import type { string_markdown } from '../../../types/typeAliases';
+/**
+ * Renders markdown content with support for code highlighting, math, and tables.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function MarkdownContent({ content }: {
+    content: string_markdown;
+}): import("react/jsx-runtime").JSX.Element;
+/**
+ * TODO: !!! Split into multiple files
+ */ 

package/esm/typings/src/book-components/Chat/types/ChatParticipant.d.ts

@@ -1,5 +1,6 @@
 import type { id, string_color, string_person_fullname, string_url_image } from '../../../types/typeAliases';
 import { Color } from '../../../utils/color/Color';
+import type { string_book } from '../../../book-2.0/agent-source/string_book';
 /**
  * A participant in the chat
  *
@@ -26,6 +27,10 @@ export type ChatParticipant = {
      * Color associated with the participant
      */
     color?: string_color | Color;
+    /**
+     * Agent source for avatar profile
+     */
+    agentSource?: string_book;
 };
 /**
  * TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`

package/esm/typings/src/book-components/_common/Dropdown/Dropdown.d.ts

@@ -0,0 +1,15 @@
+import { JSX } from 'react';
+type DropdownProps = {
+    actions: Array<{
+        icon: JSX.Element;
+        name: string;
+        onClick: () => void;
+    }>;
+};
+/**
+ * @@@
+ *
+ * @private internal subcomponent used by various components
+ */
+export declare function Dropdown({ actions }: DropdownProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/esm/typings/src/book-components/_common/Modal/Modal.d.ts

@@ -0,0 +1,13 @@
+import { ReactNode } from 'react';
+/**
+ *
+ * @private internal subcomponent used by various components
+ */
+export declare function Modal({ children, onClose, className, }: {
+    children: ReactNode;
+    onClose: () => void;
+    className?: string;
+}): import("react").ReactPortal;
+/**
+ * TODO: !!!! Use this also for feedback modal in Chat component - Make modals DRY
+ */

package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts

@@ -4,4 +4,4 @@ import type { string_css_class } from '../../../types/typeAliases';
  *
  * @private within the `@promptbook/components`
  */
-export declare function classNames(...classes: Array<string_css_class | undefined | false | null>): string_css_class;
+export declare function classNames(...classes: Array<string_css_class | undefined | false | null | 0>): string_css_class;

package/esm/typings/src/book-components/icons/AboutIcon.d.ts

@@ -0,0 +1,9 @@
+import { SVGProps } from 'react';
+/**
+ * @@@
+ *
+ * @private internal subcomponent used by various components
+ */
+export declare function AboutIcon(props: SVGProps<SVGSVGElement> & {
+    size?: number;
+}): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/icons/DownloadIcon.d.ts

@@ -0,0 +1,9 @@
+import { SVGProps } from 'react';
+/**
+ * @@@
+ *
+ * @private internal subcomponent used by various components
+ */
+export declare function DownloadIcon(props: SVGProps<SVGSVGElement> & {
+    size?: number;
+}): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/icons/MenuIcon.d.ts

@@ -0,0 +1,12 @@
+import { SVGProps } from 'react';
+/**
+ * @@@
+ *
+ * @private internal subcomponent used by various components
+ */
+export declare function MenuIcon(props: SVGProps<SVGSVGElement> & {
+    size?: number;
+}): import("react/jsx-runtime").JSX.Element;
+/**
+ * TODO: !!! Mark all components to not be used outside of browser
+ */

package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `boilerplate` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeBoilerplateCommand(program: Program): void;
+export declare function $initializeBoilerplateCommand(program: Program): $side_effect;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/cli/cli-commands/about.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `about` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeAboutCommand(program: Program): void;
+export declare function $initializeAboutCommand(program: Program): $side_effect;
 /**
  * TODO: [🗽] Unite branding and make single place for it
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/cli/cli-commands/hello.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes testing `hello` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeHelloCommand(program: Program): void;
+export declare function $initializeHelloCommand(program: Program): $side_effect;
 /**
  * TODO: [🧠][🐣] Make here some easter egg with generated hello greeting via LLM models
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/cli/cli-commands/list-models.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `list-models` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeListModelsCommand(program: Program): void;
+export declare function $initializeListModelsCommand(program: Program): $side_effect;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `list-scrapers` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeListScrapersCommand(program: Program): void;
+export declare function $initializeListScrapersCommand(program: Program): $side_effect;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/cli/cli-commands/login.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `login` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeLoginCommand(program: Program): void;
+export declare function $initializeLoginCommand(program: Program): $side_effect;
 /**
  * TODO: Implement non-interactive login
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/cli/cli-commands/make.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `make` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeMakeCommand(program: Program): void;
+export declare function $initializeMakeCommand(program: Program): $side_effect;
 /**
  * TODO: [🥃][main] !!3 Allow `ptbk make` without configuring any llm tools
  * TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types

package/esm/typings/src/cli/cli-commands/prettify.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `prettify` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializePrettifyCommand(program: Program): void;
+export declare function $initializePrettifyCommand(program: Program): $side_effect;
 /**
  * TODO: [😶] Unite folder listing
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/cli/cli-commands/run.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `run` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeRunCommand(program: Program): void;
+export declare function $initializeRunCommand(program: Program): $side_effect;
 /**
  * TODO: !!5 Catch and wrap all errors from CLI
  * TODO: [🧠] Pass `maxExecutionAttempts`, `csvSettings`

package/esm/typings/src/cli/cli-commands/start-server.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `start-server` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeStartServerCommand(program: Program): void;
+export declare function $initializeStartServerCommand(program: Program): $side_effect;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/cli/cli-commands/test-command.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `test` command for Promptbook CLI utilities
  *
@@ -6,7 +7,7 @@ import type { Command as Program } from 'commander';
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeTestCommand(program: Program): void;
+export declare function $initializeTestCommand(program: Program): $side_effect;
 /**
  * TODO: [😶] Unite folder listing
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts

@@ -1,7 +1,8 @@
 import { Command } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Note: `$` is used to indicate that this function is not a pure function - it registers an option in the CLI
  *
  * @private utility of CLI
  */
-export declare function $addGlobalOptionsToCommand(command: Command): void;
+export declare function $addGlobalOptionsToCommand(command: Command): $side_effect;

package/esm/typings/src/commands/_common/types/CommandParser.d.ts

@@ -1,10 +1,9 @@
 import type { SetOptional, WritableDeep } from 'type-fest';
 import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../../pipeline/PipelineJson/TaskJson';
-import type { string_markdown_text } from '../../../types/typeAliases';
-import type { string_name } from '../../../types/typeAliases';
-import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
+import type { string_markdown_text, string_name, string_promptbook_documentation_url } from '../../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
+import { $side_effect } from '../../../utils/organization/$side_effect';
 import type { ___and___ } from '../../../utils/organization/___and___';
 import type { CommandUsagePlace } from './CommandUsagePlaces';
 /**
@@ -98,7 +97,7 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
      *
      * Note: `$` is used to indicate that this function mutates given `pipelineJson`
      */
-    $applyToPipelineJson(command: TCommand, $pipelineJson: $PipelineJson): void;
+    $applyToPipelineJson(command: TCommand, $pipelineJson: $PipelineJson): $side_effect;
     /**
      * Reads the command from the `PipelineJson`
      *
@@ -126,7 +125,7 @@ export type PipelineTaskCommandParser<TCommand extends CommandBase> = CommonComm
      *
      * Note: `$` is used to indicate that this function mutates given `taskJson` and/or `pipelineJson`
      */
-    $applyToTaskJson(command: TCommand, $taskJson: $TaskJson, $pipelineJson: $PipelineJson): void;
+    $applyToTaskJson(command: TCommand, $taskJson: $TaskJson, $pipelineJson: $PipelineJson): $side_effect;
     /**
      * Reads the command from the `TaskJson`
      *

package/esm/typings/src/config.d.ts

@@ -45,7 +45,20 @@ export declare const CLAIM = "Turn your company's scattered knowledge into AI re
  */
 export declare const PROMPTBOOK_COLOR: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
 /**
- * Dark color of the Promptbook
+ * Colors for syntax highlighting in the `<BookEditor/>`
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PROMPTBOOK_SYNTAX_COLORS: {
+    readonly TITLE: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly LINE: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly COMMITMENT: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly PARAMETER: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+};
+/**
+ * Chat color of the Promptbook (in chat)
  *
  * TODO: [🗽] Unite branding and make single place for it
  *