@promptbook/cli 0.103.0-10 → 0.103.0-100

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

@@ -0,0 +1,13 @@
+import { Agent } from '../../../llm-providers/agent/Agent';
+import type { LlmChatProps } from '../LlmChat/LlmChatProps';
+/**
+ * Props for AgentChat component, derived from LlmChatProps but with Agent-specific modifications
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type AgentChatProps = Omit<LlmChatProps, 'thread' | 'llmTools' | 'initialMessages' | 'userParticipantName' | 'llmParticipantName'> & {
+    /**
+     * The agent to chat with
+     */
+    readonly agent: Agent;
+};

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

@@ -44,6 +44,10 @@ export type ChatProps = {
      * Determines whether the voice recognition button is rendered
      */
     readonly isVoiceRecognitionButtonShown?: boolean;
+    /**
+     * Optional callback to trigger voice input
+     */
+    onVoiceInput?(): void;
     /**
      * The language code to use for voice recognition
      */
@@ -77,6 +81,12 @@ export type ChatProps = {
      * adding feature–specific controls (e.g. Pause / Resume in MockedChat).
      */
     readonly extraActions?: ReactNode;
+    /**
+     * Optional container to render the actions into (using React Portal).
+     * If provided, the actions toolbar will be rendered inside this element
+     * instead of its default position within the chat.
+     */
+    readonly actionsContainer?: HTMLElement | null;
     /**
      * Optional CSS class name which will be added to root <div/> element
      */

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

@@ -52,4 +52,9 @@ export type LlmChatProps = Omit<ChatProps, 'messages' | 'onMessage' | 'onChange'
      * @default 'ASSISTANT'
      */
     readonly llmParticipantName?: id;
+    /**
+     * Optional message to be automatically sent as if the user typed it.
+     * This is useful for seamless transitions from other pages.
+     */
+    readonly autoExecuteMessage?: string;
 };

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

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

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

@@ -42,6 +42,11 @@ export type MockedChatDelayConfig = {
      * If true, disables typing effect and shows full message at once (BLOCKY_FLOW)
      */
     blocky?: boolean;
+    /**
+     * This prop will allow to show N first messages immediately, while the rest will be typed out with delays
+     * @default 0
+     */
+    showIntermediateMessages?: number;
 };
 /**
  * Props for MockedChat component

package/esm/typings/src/book-components/Chat/save/_common/ChatSaveFormatDefinition.d.ts

@@ -1,7 +1,7 @@
 import type { Promisable } from 'type-fest';
 import type { string_file_extension, string_mime_type } from '../../../../types/typeAliases';
 import type { ChatMessage } from '../../types/ChatMessage';
-import { ChatParticipant } from '../../types/ChatParticipant';
+import type { ChatParticipant } from '../../types/ChatParticipant';
 /**
  * Plugin contract for chat export formatNames
  *

package/esm/typings/src/book-components/Chat/save/html/htmlSaveFormatDefinition.d.ts

@@ -15,5 +15,6 @@ export declare const htmlSaveFormatDefinition: {
     readonly fileExtension: "html";
 };
 /**
+ * TODO: !!! Add QR code with branding to the footer
  *  TODO: [😬] Take chat save to HTML from existing parallel implementation
  */

package/esm/typings/src/book-components/Chat/save/pdf/pdfSaveFormatDefinition.d.ts

@@ -14,3 +14,7 @@ export declare const pdfSaveFormatDefinition: {
     readonly mimeType: "application/pdf";
     readonly fileExtension: "pdf";
 };
+/**
+ * TODO: !!! Add QR code with branding to the footer
+ * TODO: !!! Add print option
+ */

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

@@ -1,6 +1,6 @@
+import type { string_book } from '../../../book-2.0/agent-source/string_book';
 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
  *

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

@@ -0,0 +1,29 @@
+import type { AgentBasicInformation } from '../../book-2.0/agent-source/AgentBasicInformation';
+type PromptbookAgentProps = {
+    /**
+     * URL of the agent to connect to
+     *
+     * @example "http://s6.ptbk.io/benjamin-white"
+     */
+    agentUrl: string;
+    /**
+     * Optional metadata to show before the agent is connected
+     * Or to override the agent metadata if the agent does not provide it
+     */
+    meta?: Partial<AgentBasicInformation['meta']>;
+    /**
+     * Callback when the window is opened or closed
+     */
+    onOpenChange?: (isOpen: boolean) => void;
+};
+/**
+ * Renders a floating agent button that opens a chat window with the remote agent.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function PromptbookAgent(props: PromptbookAgentProps): import("react/jsx-runtime").JSX.Element;
+export {};
+/**
+ * TODO: !!! Load the full branding
+ * TODO: !!! <promptbook-agent> element
+ */

package/esm/typings/src/book-components/Qr/BrandedQrCode.d.ts

@@ -0,0 +1,18 @@
+import type { QrCodeOptions } from './useQrCode';
+type BrandedQrCodeProps = QrCodeOptions & {
+    /**
+     * Width and height of the QR code canvas
+     *
+     * @default 250
+     */
+    size?: number;
+    /**
+     * Additional CSS class names to apply to the container div
+     */
+    className?: string;
+};
+/**
+ * @public exported from `@promptbook/components`
+ */
+export declare function BrandedQrCode(props: BrandedQrCodeProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/esm/typings/src/book-components/Qr/GenericQrCode.d.ts

@@ -0,0 +1,10 @@
+type GenericQrCodeProps = {
+    value: string | number;
+    size?: number;
+    className?: string;
+};
+/**
+ * @public exported from `@promptbook/components`
+ */
+export declare function GenericQrCode({ value, size, className }: GenericQrCodeProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/esm/typings/src/book-components/Qr/PromptbookQrCode.d.ts

@@ -0,0 +1,18 @@
+type PromptbookQrCodeProps = {
+    value: string | number;
+    /**
+     * Width and height of the QR code canvas
+     *
+     * @default 250
+     */
+    size?: number;
+    /**
+     * Additional CSS class names to apply to the container div
+     */
+    className?: string;
+};
+/**
+ * @public exported from `@promptbook/components`
+ */
+export declare function PromptbookQrCode(props: PromptbookQrCodeProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/esm/typings/src/book-components/Qr/useQrCode.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="react" />
+import type { QRCodeRenderersOptions } from 'qrcode';
+import type { string_url_image } from '../../types/typeAliases';
+export type QrCodeOptions = QRCodeRenderersOptions & {
+    value: string | number;
+    logoSrc?: string_url_image;
+};
+/**
+ *
+ *
+ * @private utility of QR code components
+ */
+export declare function useQrCode(options: QrCodeOptions): {
+    canvasRef: import("react").RefObject<HTMLCanvasElement | null>;
+};

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/HamburgerMenu/HamburgerMenu.d.ts

@@ -0,0 +1,12 @@
+type HamburgerMenuProps = {
+    isOpen: boolean;
+    onClick?: () => void;
+    className?: string;
+};
+/**
+ * @@@
+ *
+ * @private Internal component
+ */
+export declare function HamburgerMenu({ isOpen, onClick, className }: HamburgerMenuProps): import("react/jsx-runtime").JSX.Element;
+export {};

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

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

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

@@ -0,0 +1,47 @@
+import { ReactNode } from 'react';
+type TooltipProps = {
+    /**
+     * The content to display in the tooltip
+     */
+    content: string;
+    /**
+     * The element that triggers the tooltip
+     */
+    children: ReactNode;
+    /**
+     * The position of the tooltip relative to the trigger element
+     * @default "top"
+     */
+    position?: 'top' | 'right' | 'bottom' | 'left';
+    /**
+     * Optional delay before showing the tooltip (in milliseconds)
+     * @default 0
+     */
+    delay?: number;
+    /**
+     * Render the tooltip wrapper as a block-level element that spans full width.
+     * Useful when wrapping grid/list items so the clickable area matches the visual card.
+     * @default false
+     */
+    block?: boolean;
+    /**
+     * Enable tooltip on touch devices. By default tooltips are disabled on touch to avoid
+     * stealing clicks from the underlying element (eg. agent card selection).
+     * @default false
+     */
+    isEnabledOnTouch?: boolean;
+    /**
+     * If true, the tooltip will not be displayed but the content will still be rendered.
+     * In this case <Tooltip> is equivalent to a <React.Fragment> with the content.
+     *
+     * Note: Tooltip sometimes breaks the hover, temporarily disable via this prop
+     */
+    isDisabled?: boolean;
+};
+/**
+ * A tooltip component that displays additional information when hovering over an element
+ *
+ * @private Used internally in book components
+ */
+export declare function Tooltip({ content, children, position, delay, block, isEnabledOnTouch: enableOnTouch, isDisabled, }: TooltipProps): import("react/jsx-runtime").JSX.Element;
+export {};

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/CloseIcon.d.ts

@@ -1,11 +1,7 @@
-type CloseIconProps = {
-    size?: number;
-    color?: string;
-};
+import { JSX } from 'react';
 /**
- * @@@
+ * Renders an icon that represents the close action
  *
- * @public exported from `@promptbook/components`
+ * @private
  */
-export declare function CloseIcon({ size, color }: CloseIconProps): import("react/jsx-runtime").JSX.Element;
-export {};
+export declare function CloseIcon(): 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/ExitFullscreenIcon.d.ts

@@ -0,0 +1,7 @@
+import { JSX } from 'react';
+/**
+ * Renders an icon that represents the exit fullscreen action
+ *
+ * @private
+ */
+export declare function ExitFullscreenIcon(): JSX.Element;

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

@@ -0,0 +1,7 @@
+import { JSX } from 'react';
+/**
+ * Renders an icon that represents the fullscreen action
+ *
+ * @private
+ */
+export declare function FullscreenIcon(): 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/book-components/icons/MicIcon.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Shows simple microphone icon
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const MicIcon: ({ size }: {
+    size: number;
+}) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import type { $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 type { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Initializes `about` command for Promptbook CLI utilities
  *
@@ -6,8 +7,9 @@ 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: [🕋] Use here `aboutPromptbookInformation`
  * TODO: [🗽] Unite branding and make single place for it
  * 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/hello.d.ts

@@ -1,4 +1,5 @@
 import type { Command as Program } from 'commander';
+import type { $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 type { $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 type { $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 type { $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 type { $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 type { $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 type { $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 → start-agents-server.d.ts}

@@ -1,12 +1,13 @@
 import type { Command as Program } from 'commander';
+import type { $side_effect } from '../../utils/organization/$side_effect';
 /**
- * Initializes `start-server` command for Promptbook CLI utilities
+ * Initializes `start-agents-server` command for Promptbook CLI utilities
  *
  * Note: `$` is used to indicate that this function is not a pure function - it registers a command in the CLI
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeStartServerCommand(program: Program): void;
+export declare function $initializeStartAgentsServerCommand(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/start-pipelines-server.d.ts

@@ -0,0 +1,15 @@
+import type { Command as Program } from 'commander';
+import type { $side_effect } from '../../utils/organization/$side_effect';
+/**
+ * Initializes `start-pipelines-server` command for Promptbook CLI utilities
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it registers a command in the CLI
+ *
+ * @private internal function of `promptbookCli`
+ */
+export declare function $initializeStartPipelinesServerCommand(program: Program): $side_effect;
+/**
+ * TODO: [🕋] Use here `aboutPromptbookInformation`
+ * 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 type { $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 type { $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/collection/agent-collection/AgentCollection.d.ts

@@ -0,0 +1,12 @@
+import { AgentCollectionInSupabase } from './constructors/agent-collection-in-supabase/AgentCollectionInSupabase';
+/**
+ * Collection that groups together multiple AI Agents
+ *
+ * Note: [🧸] There are two types of collections:
+ * - `AgentCollection` - which groups together AI Agents
+ * - `PipelineCollection` - which groups together *(deprecated)* pipelines
+ */
+export type AgentCollection = AgentCollectionInSupabase;
+/**
+ * TODO: [🧠][🚙] `AgentXxx` vs `AgentsXxx` naming convention
+ */