@promptbook/utils 0.103.0-56 → 0.103.0-67

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

@@ -0,0 +1,52 @@
+import { CSSProperties } from 'react';
+import type { AgentBasicInformation } from '../../book-2.0/agent-source/AgentBasicInformation';
+import { string_css_class } from '../../types/typeAliases';
+/**
+ * @private props of PromptbookAgentIntegration component
+ */
+export type PromptbookAgentIntegrationProps = {
+    /**
+     * URL of the agent to connect to
+     *
+     * @example "http://s6.ptbk.io/benjamin-white"
+     */
+    readonly agentUrl: string;
+    /**
+     * Form of the agent integration
+     *
+     * @default `seamless`
+     *
+     * - `seamless` Default, current behavior
+     * - `book` Show the Agent as a book in BookEditor
+     * - `chat` Show the Agent as a chat which is not floating but as AgentChat component
+     * - `profile` Show the Agent as a profile using
+     */
+    readonly formfactor?: 'seamless' | 'book' | 'chat' | 'profile';
+    /**
+     * Optional metadata to show before the agent is connected
+     * Or to override the agent metadata if the agent does not provide it
+     */
+    readonly meta?: Partial<AgentBasicInformation['meta']>;
+    /**
+     * Callback when the window is opened or closed
+     */
+    onOpenChange?(isOpen: boolean): void;
+    /**
+     * Optional CSS class name which will be added to root element
+     */
+    readonly className?: string_css_class;
+    /**
+     * Optional CSS style which will be added to root element
+     */
+    readonly style?: CSSProperties;
+};
+/**
+ * Renders a floating agent button that opens a chat window with the remote agent.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function PromptbookAgentIntegration(props: PromptbookAgentIntegrationProps): import("react/jsx-runtime").JSX.Element | undefined;
+/**
+ * TODO: !!! Load the full branding
+ * TODO: !!! <promptbook-agent> element
+ */

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

@@ -0,0 +1,14 @@
+import { PromptbookAgentIntegrationProps } from './PromptbookAgentIntegration';
+type PromptbookAgentSeamlessIntegrationProps = Omit<PromptbookAgentIntegrationProps, 'formfactor'>;
+/**
+ * Renders a floating agent button that opens a chat window with the remote agent.
+ *
+ * @private component of PromptbookAgentIntegration
+ */
+export declare function PromptbookAgentSeamlessIntegration(props: PromptbookAgentSeamlessIntegrationProps): import("react/jsx-runtime").JSX.Element;
+export {};
+/**
+ * TODO: !!!! Use iframe here instead of implementing the chat directly, allow to switch between seamless and iframe mode via `isIframeUsed` prop
+ * TODO: !!! Load the full branding
+ * TODO: !!! <promptbook-agent> 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/commitments/CLOSED/CLOSED.d.ts

@@ -16,6 +16,10 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
  */
 export declare class ClosedCommitmentDefinition extends BaseCommitmentDefinition<'CLOSED'> {
     constructor();
+    /**
+     * The `CLOSED` commitment is standalone.
+     */
+    get requiresContent(): boolean;
     /**
      * Short one-line description of CLOSED.
      */

package/esm/typings/src/commitments/CLOSED/CLOSED.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: !!!! Must be last commitment to take effect
+ */

package/esm/typings/src/commitments/USE_BROWSER/USE_BROWSER.d.ts

@@ -19,6 +19,10 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
  */
 export declare class UseBrowserCommitmentDefinition extends BaseCommitmentDefinition<'USE BROWSER'> {
     constructor();
+    /**
+     * The `USE BROWSER` commitment is standalone.
+     */
+    get requiresContent(): boolean;
     /**
      * Short one-line description of USE BROWSER.
      */

package/esm/typings/src/commitments/_base/BaseCommitmentDefinition.d.ts

@@ -15,6 +15,12 @@ export declare abstract class BaseCommitmentDefinition<TBookCommitment extends s
      * Must be implemented by each concrete commitment.
      */
     abstract get description(): string;
+    /**
+     * Whether this commitment requires content.
+     * If true, regex will match only if there is content after the commitment keyword.
+     * If false, regex will match even if there is no content.
+     */
+    get requiresContent(): boolean;
     /**
      * Icon for this commitment.
      * It should be a single emoji.

package/esm/typings/src/llm-providers/agent/Agent.d.ts

@@ -4,7 +4,7 @@ import type { string_book } from '../../book-2.0/agent-source/string_book';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
-import type { string_agent_hash, string_agent_name, string_agent_url, string_url_image } from '../../types/typeAliases';
+import type { string_agent_hash, string_agent_name, string_agent_url, string_color, string_fonts, string_url_image } from '../../types/typeAliases';
 import { AgentLlmExecutionTools } from './AgentLlmExecutionTools';
 import type { AgentOptions } from './AgentOptions';
 /**
@@ -48,6 +48,8 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
         fullname?: string;
         image?: string_url_image;
         link?: string;
+        font?: string_fonts;
+        color?: string_color;
         title?: string;
         description?: string;
         [key: string]: string | undefined;

package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts

@@ -1,4 +1,4 @@
-import type { PipelineCollection } from '../../collection/pipeline-collection/pipeline-collection/PipelineCollection';
+import type { PipelineCollection } from '../../collection/pipeline-collection/PipelineCollection';
 /**
  * Get pipeline collection for Untitled Promptbook project
  *

package/esm/typings/src/types/typeAliases.d.ts

@@ -330,6 +330,12 @@ export type string_css_class = string;
  * For example `border`
  */
 export type string_css_property = string;
+/**
+ * Semantic helper
+ *
+ * For example `"Arial, sans-serif"`
+ */
+export type string_fonts = string;
 /**
  * Semantic helper
  *

package/esm/typings/src/utils/color/Color.d.ts

@@ -23,7 +23,7 @@ export declare class Color {
      * @param color
      * @returns Color object
      */
-    static from(color: string_color | Color): WithTake<Color>;
+    static from(color: string_color | Color, _isSingleValue?: boolean): WithTake<Color>;
     /**
      * Creates a new Color instance from miscellaneous formats
      * It just does not throw error when it fails, it returns PROMPTBOOK_COLOR instead

package/esm/typings/src/utils/random/$generateBookBoilerplate.d.ts

@@ -9,6 +9,12 @@ type GenerateBookBoilerplateOptions = PartialDeep<Omit<AgentBasicInformation, 'p
      * @default 'Adam'
      */
     parentAgentName?: string_agent_name_in_book;
+    /**
+     * Name pool to use for generating agent name
+     *
+     * @default 'ENGLISH'
+     */
+    namePool?: string;
 };
 /**
  * Generates boilerplate for a new agent book

package/esm/typings/src/utils/random/CzechNamePool.d.ts

@@ -0,0 +1,7 @@
+import type { NamePool } from './NamePool';
+/**
+ * Name pool for Czech names
+ *
+ * @private [🍇] Maybe expose via some package
+ */
+export declare const CzechNamePool: NamePool;

package/esm/typings/src/utils/random/EnglishNamePool.d.ts

@@ -0,0 +1,7 @@
+import type { NamePool } from './NamePool';
+/**
+ * Name pool for English names
+ *
+ * @private [🍇] Maybe expose via some package
+ */
+export declare const EnglishNamePool: NamePool;

package/esm/typings/src/utils/random/NamePool.d.ts

@@ -0,0 +1,17 @@
+import type { string_color, string_person_fullname } from '../../types/typeAliases';
+/**
+ * Result of generating a name
+ */
+export type GenerateNameResult = {
+    fullname: string_person_fullname;
+    color: string_color;
+};
+/**
+ * Interface for a name pool
+ */
+export type NamePool = {
+    /**
+     * Generates a random name
+     */
+    generateName(): GenerateNameResult;
+};

package/esm/typings/src/utils/random/getNamePool.d.ts

@@ -0,0 +1,10 @@
+import type { NamePool } from './NamePool';
+/**
+ * Gets the name pool based on the language code
+ *
+ * @param language - The language code (e.g. 'ENGLISH', 'CZECH')
+ * @returns The name pool
+ *
+ * @private [🍇] Maybe expose via some package
+ */
+export declare function getNamePool(language: string): NamePool;

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

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.103.0-55`).
+ * It follows semantic versioning (e.g., `0.103.0-66`).
  *
  * @generated
  */

package/package.json

@@ -1,12 +1,12 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.103.0-56",
+    "version": "0.103.0-67",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
     "repository": {
         "type": "git",
-        "url": "https://github.com/webgptorg/promptbook"
+        "url": "git+https://github.com/webgptorg/promptbook.git"
     },
     "author": "Pavol Hejný <pavol@ptbk.io> (https://www.pavolhejny.com/)",
     "contributors": [

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-56';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-67';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -289,15 +289,33 @@
          * @param color
          * @returns Color object
          */
-        static from(color) {
-            if (color instanceof Color) {
+        static from(color, _isSingleValue = false) {
+            if (color === '') {
+                throw new Error(`Can not create color from empty string`);
+            }
+            else if (color instanceof Color) {
                 return take(color);
             }
             else if (Color.isColor(color)) {
                 return take(color);
             }
             else if (typeof color === 'string') {
-                return Color.fromString(color);
+                try {
+                    return Color.fromString(color);
+                }
+                catch (error) {
+                    // <- Note: Can not use `assertsError(error)` here because it causes circular dependency
+                    if (_isSingleValue) {
+                        throw error;
+                    }
+                    const parts = color.split(/[\s+,;|]/);
+                    if (parts.length > 0) {
+                        return Color.from(parts[0].trim(), true);
+                    }
+                    else {
+                        throw new Error(`Can not create color from given string "${color}"`);
+                    }
+                }
             }
             else {
                 console.error({ color });