@promptbook/utils 0.103.0-9 → 0.104.0-0

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

@@ -0,0 +1,11 @@
+type CameraIconProps = {
+    size?: number;
+    color?: string;
+};
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function CameraIcon({ size, color }: CameraIconProps): import("react/jsx-runtime").JSX.Element;
+export {};

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/book-components/icons/SendIcon.d.ts

@@ -6,3 +6,6 @@
 export declare const SendIcon: ({ size }: {
     size: number;
 }) => import("react/jsx-runtime").JSX.Element;
+/**
+ * TODO: !!!! Search ACRY for "currentColor", it probably does not work and make no sense to have it in project
+ */

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
+ */

package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts

@@ -0,0 +1,75 @@
+import type { SupabaseClient } from '@supabase/supabase-js';
+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_agent_name } from '../../../../types/typeAliases';
+import { AgentCollectionInSupabaseOptions } from './AgentCollectionInSupabaseOptions';
+import type { AgentsDatabaseSchema } from './AgentsDatabaseSchema';
+/**
+ * Agent collection stored in Supabase table
+ *
+ * Note: This object can work both from Node.js and browser environment depending on the Supabase client provided
+ *
+ * @public exported from `@promptbook/core`
+ * <- TODO: [🐱‍🚀] Move to `@promptbook/supabase` package
+ */
+export declare class AgentCollectionInSupabase {
+    private readonly supabaseClient;
+    readonly options?: AgentCollectionInSupabaseOptions | undefined;
+    /**
+     * @param rootPath - path to the directory with agents
+     * @param tools - Execution tools to be used in [🐱‍🚀] `Agent` itself and listing the agents
+     * @param options - Options for the collection creation
+     */
+    constructor(supabaseClient: SupabaseClient<AgentsDatabaseSchema>, options?: AgentCollectionInSupabaseOptions | undefined);
+    /**
+     * Gets all agents in the collection
+     */
+    listAgents(): Promise<ReadonlyArray<AgentBasicInformation>>;
+    /**
+     * [🐱‍🚀]@@@
+     */
+    getAgentSource(agentName: string_agent_name): Promise<string_book>;
+    /**
+     * Creates a new agent in the collection
+     *
+     * Note: You can set 'PARENT' in the agent source to inherit from another agent in the collection.
+     */
+    createAgent(agentSource: string_book): Promise<AgentBasicInformation>;
+    /**
+     * Updates an existing agent in the collection
+     */
+    updateAgentSource(agentName: string_agent_name, agentSource: string_book): Promise<void>;
+    /**
+     * Deletes an agent from the collection
+     */
+    deleteAgent(agentName: string_agent_name): Promise<void>;
+    /**
+     * List history of an agent
+     */
+    listAgentHistory(agentName: string_agent_name): Promise<ReadonlyArray<{
+        id: number;
+        createdAt: string;
+        agentHash: string;
+        promptbookEngineVersion: string;
+    }>>;
+    /**
+     * List agents that are in history but not in the active agents list
+     */
+    listDeletedAgents(): Promise<ReadonlyArray<string_agent_name>>;
+    /**
+     * Restore an agent from history
+     */
+    restoreAgent(historyId: number): Promise<void>;
+    /**
+     * Get the Supabase table name with prefix
+     *
+     * @param tableName - The original table name
+     * @returns The prefixed table name
+     */
+    private getTableName;
+}
+/**
+ * TODO: [🐱‍🚀] Implement it here correctly and update JSDoc comments here, and on interface + other implementations
+ * TODO: Write unit test
+ * TODO: [🧠][🚙] `AgentXxx` vs `AgentsXxx` naming convention
+ */

package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabaseOptions.d.ts

@@ -0,0 +1,10 @@
+import type { CommonToolsOptions } from '../../../../execution/CommonToolsOptions';
+import type { PrepareAndScrapeOptions } from '../../../../prepare/PrepareAndScrapeOptions';
+export type AgentCollectionInSupabaseOptions = PrepareAndScrapeOptions & CommonToolsOptions & {
+    /**
+     * The Supabase tables prefix to use
+     *
+     * @default ''
+     */
+    tablePrefix?: string;
+};