llmz 0.0.2 → 0.0.5

package/dist/citations.d.ts

@@ -0,0 +1,63 @@
+export type Citation = {
+    id: number;
+    source: any;
+    tag: string;
+    offset?: number;
+};
+export type CitationReplaceFn = (citation: Citation) => string;
+/** These are all single-token symbols that are very rare in natural texts, making them suitable for usage within GPT Prompts. */
+export declare const RARE_SYMBOLS: {
+    readonly ARROW_UP: "↑";
+    readonly CIRCLE_BULLET: "・";
+    readonly STAR_BULLET_FULL: "★";
+    readonly STAR_BULLET_EMPTY: "☆";
+    readonly ARROW_BULLET: "→";
+    readonly SQUARE_BULLET: "■";
+    readonly TRIANGLE_BULLET: "►";
+    readonly OPENING_TAG: "【";
+    readonly CLOSING_TAG: "】";
+    readonly SS: "§";
+    readonly CROSS: "†";
+};
+export declare class CitationsManager {
+    private _citations;
+    private _nextId;
+    /**
+     * Registers a new source and returns the created Citation.
+     * @param source An object representing the source of the citation.
+     * @returns The created Citation.
+     */
+    registerSource(source: any): Citation;
+    /**
+     * Extracts citations from the provided content and cleans the content of citation tags.
+     * Non-found citations are replaced with a special "Not Found" citation.
+     * @param content The string content containing citation tags.
+     * @returns An object containing the cleaned content and an array of found citations.
+     */
+    extractCitations(content: string, replace?: CitationReplaceFn): {
+        cleaned: string;
+        citations: Citation[];
+    };
+    /**
+     * Strips citation tags from the provided content.
+     * @param content The string content containing citation tags.
+     * @returns The cleaned content without citation tags.
+     */
+    static stripCitationTags(content: string): string;
+    /**
+     * Removes citations from a deeply nested plain object and returns a new object with citations removed.
+     * @param obj The plain object to process.
+     * @returns A tuple containing the new object and an array of extracted citations with paths.
+     */
+    removeCitationsFromObject<T>(obj: T): [T, {
+        path: string;
+        citation: Citation;
+    }[]];
+    /**
+     * Re-adds citations to the cleaned content based on their offsets.
+     * @param cleaned The cleaned string without citation tags.
+     * @param citations The array of citations with offsets.
+     * @returns The string with citation tags re-added.
+     */
+    reAddCitations(cleaned: string, citations: Citation[]): string;
+}

package/dist/component-R2Y74VUI.js

@@ -0,0 +1,16 @@
+import {
+  Component,
+  assertValidComponent,
+  getComponentReference,
+  isAnyComponent,
+  isComponent
+} from "./chunk-HP7RKM25.js";
+import "./chunk-ORQP26SZ.js";
+import "./chunk-7WRN4E42.js";
+export {
+  Component,
+  assertValidComponent,
+  getComponentReference,
+  isAnyComponent,
+  isComponent
+};

package/dist/component-TSNW3SC7.cjs

@@ -0,0 +1,16 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+
+
+var _chunkEJRCDWBAcjs = require('./chunk-EJRCDWBA.cjs');
+require('./chunk-KMZDFWYZ.cjs');
+require('./chunk-UQOBUJIQ.cjs');
+
+
+
+
+
+
+exports.Component = _chunkEJRCDWBAcjs.Component; exports.assertValidComponent = _chunkEJRCDWBAcjs.assertValidComponent; exports.getComponentReference = _chunkEJRCDWBAcjs.getComponentReference; exports.isAnyComponent = _chunkEJRCDWBAcjs.isAnyComponent; exports.isComponent = _chunkEJRCDWBAcjs.isComponent;

package/dist/component.d.ts

@@ -1,11 +1,4 @@
-export type ComponentProperty = {
-    name: string;
-    type: 'string' | 'boolean' | 'number';
-    default?: string | boolean | number;
-    description?: string;
-    required: boolean;
-};
-export type Component = DefaultComponent | LeafComponent | ContainerComponent;
+import { z } from '@bpinternal/zui';
 export type ExampleUsage = {
     name: string;
     description: string;
@@ -13,39 +6,55 @@ export type ExampleUsage = {
 };
 export type ComponentChild = {
     description: string;
-    component: Component;
+    component: ComponentDefinition;
 };
-export type DefaultComponent = {
+export declare function assertValidComponent(component: ComponentDefinition): asserts component is ComponentDefinition;
+export declare function getComponentReference(component: ComponentDefinition): string;
+export type DefaultComponentDefinition<T extends z.ZodObject<any> = z.ZodObject<any>> = {
     type: 'default';
     name: string;
     aliases: string[];
     description: string;
     examples: ExampleUsage[];
     default: {
-        props: ComponentProperty[];
+        props: T;
         children: Array<ComponentChild>;
     };
 };
-export type LeafComponent = {
+export type LeafComponentDefinition<T extends z.ZodObject<any> = z.ZodObject<any>> = {
     type: 'leaf';
     name: string;
     description: string;
     aliases?: string[];
     examples: ExampleUsage[];
     leaf: {
-        props: ComponentProperty[];
+        props: T;
     };
 };
-export type ContainerComponent = {
+export type ContainerComponentDefinition<T extends z.ZodObject<any> = z.ZodObject<any>> = {
     type: 'container';
     name: string;
     description: string;
     aliases?: string[];
     examples: ExampleUsage[];
     container: {
-        props: ComponentProperty[];
+        props: T;
         children: Array<ComponentChild>;
     };
 };
-export declare function assertValidComponent(component: Component): asserts component is Component;
-export declare function getComponentReference(component: Component): string;
+export type ComponentDefinition = DefaultComponentDefinition | LeafComponentDefinition | ContainerComponentDefinition;
+type ExtractComponentProps<T extends ComponentDefinition> = T extends LeafComponentDefinition<infer P> ? z.infer<P> : T extends ContainerComponentDefinition<infer P> ? z.infer<P> : T extends DefaultComponentDefinition<infer P> ? z.infer<P> : never;
+export type RenderedComponent<TProps = Record<string, any>> = {
+    __jsx: true;
+    type: string;
+    children: any[];
+    props: TProps;
+};
+export declare class Component<T extends ComponentDefinition = ComponentDefinition> {
+    readonly definition: T;
+    readonly propsType: ExtractComponentProps<T>;
+    constructor(definition: T);
+}
+export declare function isComponent<T extends ComponentDefinition>(rendered: RenderedComponent<any>, component: Component<T>): rendered is RenderedComponent<ExtractComponentProps<T>>;
+export declare function isAnyComponent(message: unknown): message is RenderedComponent;
+export {};

package/dist/component.default.d.ts

@@ -1,10 +1,316 @@
+import { Component } from './component.js';
 export declare const DefaultComponents: {
-    Button: import("./component.js").LeafComponent;
-    Image: import("./component.js").LeafComponent;
-    File: import("./component.js").LeafComponent;
-    Video: import("./component.js").LeafComponent;
-    Audio: import("./component.js").LeafComponent;
-    Card: import("./component.js").ContainerComponent;
-    Carousel: import("./component.js").ContainerComponent;
-    Text: import("./component.js").DefaultComponent;
+    Button: Component<{
+        type: "leaf";
+        description: string;
+        name: string;
+        aliases: string[];
+        examples: {
+            name: string;
+            description: string;
+            code: string;
+        }[];
+        leaf: {
+            props: import("@bpinternal/zui").ZodObject<{
+                action: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodEnum<["say", "url", "postback"]>>;
+                label: import("@bpinternal/zui").ZodString;
+                value: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+                url: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+            }, "strip", {
+                label: string;
+                action: "say" | "url" | "postback";
+                value?: string | undefined;
+                url?: string | undefined;
+            }, {
+                label: string;
+                value?: string | undefined;
+                action?: "say" | "url" | "postback" | undefined;
+                url?: string | undefined;
+            }>;
+        };
+    }>;
+    Image: Component<{
+        type: "leaf";
+        name: string;
+        description: string;
+        aliases: never[];
+        examples: {
+            name: string;
+            description: string;
+            code: string;
+        }[];
+        leaf: {
+            props: import("@bpinternal/zui").ZodObject<{
+                url: import("@bpinternal/zui").ZodString;
+                alt: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+            }, "strip", {
+                url: string;
+                alt?: string | undefined;
+            }, {
+                url: string;
+                alt?: string | undefined;
+            }>;
+        };
+    }>;
+    File: Component<{
+        type: "leaf";
+        name: string;
+        description: string;
+        aliases: never[];
+        examples: {
+            name: string;
+            description: string;
+            code: string;
+        }[];
+        leaf: {
+            props: import("@bpinternal/zui").ZodObject<{
+                url: import("@bpinternal/zui").ZodString;
+                name: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+            }, "strip", {
+                url: string;
+                name?: string | undefined;
+            }, {
+                url: string;
+                name?: string | undefined;
+            }>;
+        };
+    }>;
+    Video: Component<{
+        type: "leaf";
+        name: string;
+        description: string;
+        aliases: never[];
+        examples: {
+            name: string;
+            description: string;
+            code: string;
+        }[];
+        leaf: {
+            props: import("@bpinternal/zui").ZodObject<{
+                url: import("@bpinternal/zui").ZodString;
+                title: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+            }, "strip", {
+                url: string;
+                title?: string | undefined;
+            }, {
+                url: string;
+                title?: string | undefined;
+            }>;
+        };
+    }>;
+    Audio: Component<{
+        type: "leaf";
+        name: string;
+        description: string;
+        aliases: never[];
+        examples: {
+            name: string;
+            description: string;
+            code: string;
+        }[];
+        leaf: {
+            props: import("@bpinternal/zui").ZodObject<{
+                url: import("@bpinternal/zui").ZodString;
+                title: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+            }, "strip", {
+                url: string;
+                title?: string | undefined;
+            }, {
+                url: string;
+                title?: string | undefined;
+            }>;
+        };
+    }>;
+    Card: Component<{
+        type: "container";
+        name: string;
+        description: string;
+        aliases: never[];
+        examples: {
+            name: string;
+            description: string;
+            code: string;
+        }[];
+        container: {
+            props: import("@bpinternal/zui").ZodObject<{
+                title: import("@bpinternal/zui").ZodString;
+                subtitle: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+            }, "strip", {
+                title: string;
+                subtitle?: string | undefined;
+            }, {
+                title: string;
+                subtitle?: string | undefined;
+            }>;
+            children: ({
+                description: string;
+                component: {
+                    type: "leaf";
+                    name: string;
+                    description: string;
+                    aliases: never[];
+                    examples: {
+                        name: string;
+                        description: string;
+                        code: string;
+                    }[];
+                    leaf: {
+                        props: import("@bpinternal/zui").ZodObject<{
+                            url: import("@bpinternal/zui").ZodString;
+                            alt: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+                        }, "strip", {
+                            url: string;
+                            alt?: string | undefined;
+                        }, {
+                            url: string;
+                            alt?: string | undefined;
+                        }>;
+                    };
+                };
+            } | {
+                description: string;
+                component: {
+                    type: "leaf";
+                    description: string;
+                    name: string;
+                    aliases: string[];
+                    examples: {
+                        name: string;
+                        description: string;
+                        code: string;
+                    }[];
+                    leaf: {
+                        props: import("@bpinternal/zui").ZodObject<{
+                            action: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodEnum<["say", "url", "postback"]>>;
+                            label: import("@bpinternal/zui").ZodString;
+                            value: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+                            url: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+                        }, "strip", {
+                            label: string;
+                            action: "say" | "url" | "postback";
+                            value?: string | undefined;
+                            url?: string | undefined;
+                        }, {
+                            label: string;
+                            value?: string | undefined;
+                            action?: "say" | "url" | "postback" | undefined;
+                            url?: string | undefined;
+                        }>;
+                    };
+                };
+            })[];
+        };
+    }>;
+    Carousel: Component<{
+        type: "container";
+        name: string;
+        description: string;
+        aliases: never[];
+        examples: {
+            name: string;
+            description: string;
+            code: string;
+        }[];
+        container: {
+            props: import("@bpinternal/zui").ZodObject<{}, "strip", {}, {}>;
+            children: {
+                description: string;
+                component: {
+                    type: "container";
+                    name: string;
+                    description: string;
+                    aliases: never[];
+                    examples: {
+                        name: string;
+                        description: string;
+                        code: string;
+                    }[];
+                    container: {
+                        props: import("@bpinternal/zui").ZodObject<{
+                            title: import("@bpinternal/zui").ZodString;
+                            subtitle: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+                        }, "strip", {
+                            title: string;
+                            subtitle?: string | undefined;
+                        }, {
+                            title: string;
+                            subtitle?: string | undefined;
+                        }>;
+                        children: ({
+                            description: string;
+                            component: {
+                                type: "leaf";
+                                name: string;
+                                description: string;
+                                aliases: never[];
+                                examples: {
+                                    name: string;
+                                    description: string;
+                                    code: string;
+                                }[];
+                                leaf: {
+                                    props: import("@bpinternal/zui").ZodObject<{
+                                        url: import("@bpinternal/zui").ZodString;
+                                        alt: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+                                    }, "strip", {
+                                        url: string;
+                                        alt?: string | undefined;
+                                    }, {
+                                        url: string;
+                                        alt?: string | undefined;
+                                    }>;
+                                };
+                            };
+                        } | {
+                            description: string;
+                            component: {
+                                type: "leaf";
+                                description: string;
+                                name: string;
+                                aliases: string[];
+                                examples: {
+                                    name: string;
+                                    description: string;
+                                    code: string;
+                                }[];
+                                leaf: {
+                                    props: import("@bpinternal/zui").ZodObject<{
+                                        action: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodEnum<["say", "url", "postback"]>>;
+                                        label: import("@bpinternal/zui").ZodString;
+                                        value: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+                                        url: import("@bpinternal/zui").ZodOptional<import("@bpinternal/zui").ZodString>;
+                                    }, "strip", {
+                                        label: string;
+                                        action: "say" | "url" | "postback";
+                                        value?: string | undefined;
+                                        url?: string | undefined;
+                                    }, {
+                                        label: string;
+                                        value?: string | undefined;
+                                        action?: "say" | "url" | "postback" | undefined;
+                                        url?: string | undefined;
+                                    }>;
+                                };
+                            };
+                        })[];
+                    };
+                };
+            }[];
+        };
+    }>;
+    Text: Component<{
+        type: "default";
+        name: string;
+        aliases: string[];
+        description: string;
+        examples: {
+            name: string;
+            description: string;
+            code: string;
+        }[];
+        default: {
+            props: import("@bpinternal/zui").ZodObject<{}, "strip", {}, {}>;
+            children: never[];
+        };
+    }>;
 };

package/dist/context.d.ts

@@ -1,4 +1,5 @@
 import { type Cognitive } from '@botpress/cognitive';
+import { Chat } from './chat.js';
 import { Component } from './component.js';
 import { SnapshotSignal } from './errors.js';
 import { Exit } from './exit.js';
@@ -9,7 +10,7 @@ import type { OAI } from './openai.js';
 import { Prompt } from './prompts/prompt.js';
 import { Snapshot } from './snapshots.js';
 import { Tool } from './tool.js';
-import { TranscriptArray, TranscriptMessage } from './transcript.js';
+import { TranscriptArray } from './transcript.js';
 import { ObjectMutation, Trace } from './types.js';
 type Model = Parameters<InstanceType<typeof Cognitive>['generateContent']>[0]['model'];
 export type IterationParameters = {
@@ -79,6 +80,8 @@ export declare namespace IterationStatuses {
         };
     };
 }
+export declare const ThinkExit: Exit<unknown>;
+export declare const ListenExit: Exit<unknown>;
 export declare class Iteration {
     id: string;
     messages: OAI.Message[];
@@ -93,7 +96,7 @@ export declare class Iteration {
     trackMutation(mutation: ObjectMutation): void;
     private _parameters;
     get transcript(): TranscriptArray;
-    get tools(): Tool<unknown, unknown>[];
+    get tools(): Tool<import("./types.js").ZuiType, import("./types.js").ZuiType>[];
     get objects(): ObjectInstance[];
     get exits(): Exit<unknown>[];
     get instructions(): string | undefined;
@@ -132,13 +135,13 @@ export declare class Iteration {
 }
 export declare class Context {
     id: string;
-    transcript?: ValueOrGetter<TranscriptArray, Context>;
+    chat?: Chat;
     instructions?: ValueOrGetter<string, Context>;
     objects?: ValueOrGetter<ObjectInstance[], Context>;
     tools?: ValueOrGetter<Tool[], Context>;
     exits?: ValueOrGetter<Exit[], Context>;
-    components?: ValueOrGetter<Component[], Context>;
     version: Prompt;
+    timeout: number;
     loop: number;
     temperature: number;
     model?: Model;
@@ -151,17 +154,17 @@ export declare class Context {
     private _getIterationMessages;
     private _refreshIterationParameters;
     constructor(props: {
+        chat?: Chat;
         instructions?: ValueOrGetter<string, Context>;
         objects?: ValueOrGetter<ObjectInstance[], Context>;
         tools?: ValueOrGetter<Tool[], Context>;
         exits?: ValueOrGetter<Exit[], Context>;
-        transcript?: ValueOrGetter<TranscriptMessage[], Context>;
-        components?: ValueOrGetter<Component[], Context>;
         loop?: number;
         temperature?: number;
         model?: Model;
         metadata?: Record<string, any>;
         snapshot?: Snapshot;
+        timeout?: number;
     });
 }
 export {};

package/dist/dual-modes-UHNDHNIF.cjs

@@ -0,0 +1,12 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunk6WT5VZBGcjs = require('./chunk-6WT5VZBG.cjs');
+require('./chunk-IKSIOIIP.cjs');
+require('./chunk-EJRCDWBA.cjs');
+require('./chunk-KMZDFWYZ.cjs');
+require('./chunk-FIVFS4HG.cjs');
+require('./chunk-P7J2WCBB.cjs');
+require('./chunk-UQOBUJIQ.cjs');
+
+
+exports.DualModePrompt = _chunk6WT5VZBGcjs.DualModePrompt;

package/dist/dual-modes-ZUQKPJFH.js

@@ -0,0 +1,12 @@
+import {
+  DualModePrompt
+} from "./chunk-WLUVY5QU.js";
+import "./chunk-JQBT7UWN.js";
+import "./chunk-HP7RKM25.js";
+import "./chunk-ORQP26SZ.js";
+import "./chunk-QT4QF3YA.js";
+import "./chunk-5TRUJES5.js";
+import "./chunk-7WRN4E42.js";
+export {
+  DualModePrompt
+};

package/dist/exit-KJ4COC5N.cjs

@@ -0,0 +1,8 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunk4I7UPBLNcjs = require('./chunk-4I7UPBLN.cjs');
+require('./chunk-P7J2WCBB.cjs');
+require('./chunk-UQOBUJIQ.cjs');
+
+
+exports.Exit = _chunk4I7UPBLNcjs.Exit;

package/dist/exit-OIYZLBVJ.js

@@ -0,0 +1,8 @@
+import {
+  Exit
+} from "./chunk-S6FOL2HY.js";
+import "./chunk-5TRUJES5.js";
+import "./chunk-7WRN4E42.js";
+export {
+  Exit
+};

package/dist/exit.d.ts

@@ -1,5 +1,9 @@
 import { type JSONSchema } from '@bpinternal/zui';
 import { ZuiType } from './types.js';
+export type ExitResult<T = unknown> = {
+    exit: Exit<T>;
+    result: T;
+};
 export declare class Exit<T = unknown> {
     name: string;
     aliases: string[];
@@ -9,6 +13,8 @@ export declare class Exit<T = unknown> {
     get zSchema(): import("@bpinternal/zui").ZodTypeAny | undefined;
     rename(name: string): this;
     clone(): Exit<any>;
+    is<T>(exit: Exit<T>): this is Exit<T>;
+    match(result: ExitResult): result is ExitResult<T>;
     constructor(props: {
         name: string;
         aliases?: string[];

package/dist/getter.d.ts

@@ -1,2 +1,2 @@
 export type ValueOrGetter<T, I> = T | ((ctx: I) => T) | ((ctx: I) => Promise<T>);
-export declare const getValue: <T, I>(valueOrGetter: ValueOrGetter<T, I>, ctx: I) => Promise<T>;
+export declare const getValue: <T, I>(valueOrGetter: ValueOrGetter<T, I>, ctx?: I) => Promise<T>;