llmz 0.0.2 → 0.0.4

package/dist/index.js

@@ -1,34 +1,38 @@
 import {
   Snapshot
-} from "./chunk-UG2GCPHF.js";
+} from "./chunk-4KB5WXHR.js";
+import "./chunk-EFGXTO64.js";
 import {
   Tool
-} from "./chunk-DILHJIMP.js";
+} from "./chunk-QBXIE6EY.js";
 import {
   formatTypings,
   getTypings
-} from "./chunk-ZSRC3TN4.js";
+} from "./chunk-UNMKB2DA.js";
 import {
   CodeFormattingError,
   SnapshotSignal,
   ThinkSignal
-} from "./chunk-RJHDQL4C.js";
+} from "./chunk-JKVVQN2P.js";
+import "./chunk-JQBT7UWN.js";
 import {
   Exit
-} from "./chunk-6QDFMQHA.js";
-import "./chunk-Q4DEJGXD.js";
-import "./chunk-MSTBEKOQ.js";
-import "./chunk-3T465BEW.js";
+} from "./chunk-S6WICIDW.js";
+import {
+  Component,
+  assertValidComponent,
+  isComponent
+} from "./chunk-ZCPQ3QOW.js";
+import "./chunk-ORQP26SZ.js";
 import {
   escapeString,
   getMultilineComment,
   isValidIdentifier
-} from "./chunk-DFZ6GX5C.js";
+} from "./chunk-5TRUJES5.js";
 import {
   cloneDeep_default,
   upperFirst_default
-} from "./chunk-7S3UY52U.js";
-import "./chunk-YSQDPG26.js";
+} from "./chunk-7WRN4E42.js";
 
 // src/objects.ts
 import { z } from "@bpinternal/zui";
@@ -497,8 +501,142 @@ function embedPropertyValue(property) {
   return "unknown";
 }
 
+// src/citations.ts
+var RARE_SYMBOLS = {
+  ARROW_UP: "\u2191",
+  CIRCLE_BULLET: "\u30FB",
+  STAR_BULLET_FULL: "\u2605",
+  STAR_BULLET_EMPTY: "\u2606",
+  ARROW_BULLET: "\u2192",
+  SQUARE_BULLET: "\u25A0",
+  TRIANGLE_BULLET: "\u25BA",
+  OPENING_TAG: "\u3010",
+  CLOSING_TAG: "\u3011",
+  SS: "\xA7",
+  CROSS: "\u2020"
+};
+var CitationsManager = class {
+  _citations = /* @__PURE__ */ new Map();
+  _nextId = 0;
+  /**
+   * 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) {
+    const id = this._nextId++;
+    const tag = `${RARE_SYMBOLS.OPENING_TAG}${id}${RARE_SYMBOLS.CLOSING_TAG}`;
+    const citation = {
+      id,
+      source,
+      tag
+    };
+    this._citations.set(id, citation);
+    return 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, replace) {
+    const citations = [];
+    const notFoundCitation = {
+      id: -1,
+      source: "Not Found",
+      tag: ""
+    };
+    const regex = new RegExp(`${RARE_SYMBOLS.OPENING_TAG}([\\d|\\w|\\s|,]{0,})${RARE_SYMBOLS.CLOSING_TAG}`, "ig");
+    let match;
+    const offsets = [];
+    while ((match = regex.exec(content)) !== null) {
+      const offset = match.index;
+      const length = match[0].length;
+      offsets.push({ start: offset, length });
+      const multi = (match[1] ?? "").split(/\D/g).map((s) => s.trim()).filter(Boolean).map((s) => parseInt(s, 10)).filter((s) => !isNaN(s) && s >= 0);
+      for (const citationId of multi) {
+        const citation = this._citations.get(citationId);
+        if (citation) {
+          citations.push({ ...citation, offset });
+        } else {
+          citations.push({ ...notFoundCitation, offset });
+        }
+      }
+    }
+    const entries = offsets.map((o) => ({
+      start: o.start,
+      length: o.length,
+      citations: citations.filter((x) => x.offset === o.start && x.id !== -1)
+    })).sort((a, b) => a.start - b.start);
+    let result = "";
+    let cursor = 0;
+    for (const { start, length, citations: citations2 } of entries) {
+      result += content.slice(cursor, start);
+      const replacement = citations2.map((citation) => replace ? replace(citation) : "").join("");
+      result += replacement;
+      cursor = start + length;
+    }
+    result += content.slice(cursor);
+    return { cleaned: result, citations };
+  }
+  /**
+   * 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) {
+    const regex = new RegExp(`${RARE_SYMBOLS.OPENING_TAG}([\\d|\\w|\\s|,]{0,})${RARE_SYMBOLS.CLOSING_TAG}?`, "g");
+    return content.replace(regex, "");
+  }
+  /**
+   * 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(obj) {
+    const result = [];
+    const processObject = (current, path) => {
+      if (typeof current === "string") {
+        const extraction = this.extractCitations(current);
+        if (extraction.citations.length > 0) {
+          result.push(...extraction.citations.map((citation) => ({ path, citation })));
+        }
+        return extraction.cleaned;
+      } else if (typeof current === "object" && current !== null) {
+        const newObject = Array.isArray(current) ? [] : {};
+        for (const key of Object.keys(current)) {
+          newObject[key] = processObject(current[key], `${path}.${key}`);
+        }
+        return newObject;
+      }
+      return current;
+    };
+    const newObj = processObject(obj, "root");
+    return [newObj, result];
+  }
+  /**
+   * 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, citations) {
+    let content = cleaned;
+    citations.sort((a, b) => (a.offset ?? 0) - (b.offset ?? 0));
+    const adjustment = 0;
+    for (const citation of citations) {
+      if (citation.offset != null) {
+        const position = citation.offset + adjustment;
+        content = content.slice(0, position) + citation.tag + content.slice(position);
+      }
+    }
+    return content;
+  }
+};
+
 // src/component.default.ts
-var Button = {
+var Button = new Component({
   type: "leaf",
   description: "A button component that can perform actions when clicked",
   name: "Button",
@@ -548,8 +686,8 @@ var Button = {
       }
     ]
   }
-};
-var Image = {
+});
+var Image = new Component({
   type: "leaf",
   name: "Image",
   description: "Displays an image from a URL.",
@@ -579,8 +717,8 @@ var Image = {
       }
     ]
   }
-};
-var File = {
+});
+var File = new Component({
   type: "leaf",
   name: "File",
   description: "Sends a downloadable file to the user.",
@@ -610,8 +748,8 @@ var File = {
       }
     ]
   }
-};
-var Video = {
+});
+var Video = new Component({
   type: "leaf",
   name: "Video",
   description: "Embeds a video from a URL.",
@@ -641,8 +779,8 @@ var Video = {
       }
     ]
   }
-};
-var Audio = {
+});
+var Audio = new Component({
   type: "leaf",
   name: "Audio",
   description: "Plays an audio clip from a URL.",
@@ -672,8 +810,8 @@ var Audio = {
       }
     ]
   }
-};
-var Card = {
+});
+var Card = new Component({
   type: "container",
   name: "Card",
   description: "A visual card component that can include an image and buttons.",
@@ -709,16 +847,16 @@ var Card = {
     children: [
       {
         description: "Image (optional, max 1)",
-        component: Image
+        component: Image.definition
       },
       {
         description: "Button (optional, up to 5)",
-        component: Button
+        component: Button.definition
       }
     ]
   }
-};
-var Carousel = {
+});
+var Carousel = new Component({
   type: "container",
   name: "Carousel",
   description: "A virtual container for displaying 1 to 10 Card components as a carousel.",
@@ -746,12 +884,12 @@ var Carousel = {
     children: [
       {
         description: "Card component (required, 1\u201310 allowed)",
-        component: Card
+        component: Card.definition
       }
     ]
   }
-};
-var Text = {
+});
+var Text = new Component({
   type: "default",
   name: "Message",
   aliases: ["Text", "Markdown"],
@@ -769,7 +907,15 @@ var Text = {
     props: [],
     children: []
   }
-};
+});
+var messageTool = (handler) => new Tool({
+  name: "Message",
+  metadata: {
+    system: true,
+    description: "Sends a message with components like Button, Image, File, Video, Audio, Card, Carousel, and Text."
+  },
+  handler: async (args) => await handler(args)
+});
 var DefaultComponents = {
   Button,
   Image,
@@ -783,22 +929,24 @@ var DefaultComponents = {
 
 // src/index.ts
 var executeContext = async (props) => {
-  const { executeContext: executeContext2 } = (await import("./llmz-WY74UVE3.js")).llmz;
+  const { executeContext: executeContext2 } = (await import("./llmz-AS5TGCQS.js")).llmz;
   return executeContext2(props);
 };
 var init = async () => {
-  await import("./llmz-WY74UVE3.js");
-  await import("./component-R3ZAVXUC.js");
-  await import("./tool-WVIPESKN.js");
-  await import("./exit-GYMXZZ4I.js");
-  await import("./jsx-CJ2RBODH.js");
-  await import("./vm-SMMA664M.js");
-  await import("./utils-TS23YJPE.js");
-  await import("./truncator-MTONQESU.js");
-  await import("./typings-HTYLRNIC.js");
-  await import("./dual-modes-2VDEOJ5D.js");
+  await import("./llmz-AS5TGCQS.js");
+  await import("./component-LQDU72LX.js");
+  await import("./tool-LY77IWV2.js");
+  await import("./exit-F6ZUL2NV.js");
+  await import("./jsx-AEHVFB3L.js");
+  await import("./vm-ZUQOSRRM.js");
+  await import("./utils-L5GLCS3C.js");
+  await import("./truncator-WAL2GCUY.js");
+  await import("./typings-AIV2OASX.js");
+  await import("./dual-modes-QHBOFWHM.js");
 };
 export {
+  CitationsManager,
+  Component,
   DefaultComponents,
   Exit,
   ObjectInstance,
@@ -806,6 +954,9 @@ export {
   SnapshotSignal,
   ThinkSignal,
   Tool,
+  assertValidComponent,
   executeContext,
-  init
+  init,
+  isComponent,
+  messageTool
 };

package/dist/{jsx-CJ2RBODH.js → jsx-AEHVFB3L.js}

@@ -3,9 +3,8 @@ import {
   createJsxComponent,
   isAnyJsxComponent,
   isJsxComponent
-} from "./chunk-7FIPXMZR.js";
-import "./chunk-7S3UY52U.js";
-import "./chunk-YSQDPG26.js";
+} from "./chunk-ORQP26SZ.js";
+import "./chunk-7WRN4E42.js";
 export {
   Jsx,
   createJsxComponent,

package/dist/jsx-AJAXBWFE.cjs

@@ -0,0 +1,13 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+
+var _chunkKMZDFWYZcjs = require('./chunk-KMZDFWYZ.cjs');
+require('./chunk-UQOBUJIQ.cjs');
+
+
+
+
+
+exports.Jsx = _chunkKMZDFWYZcjs.Jsx; exports.createJsxComponent = _chunkKMZDFWYZcjs.createJsxComponent; exports.isAnyJsxComponent = _chunkKMZDFWYZcjs.isAnyJsxComponent; exports.isJsxComponent = _chunkKMZDFWYZcjs.isJsxComponent;

package/dist/{llmz-WY74UVE3.js → llmz-AS5TGCQS.js}

@@ -1,14 +1,17 @@
+import {
+  DualModePrompt
+} from "./chunk-TJQVC4CE.js";
 import {
   runAsyncFunction
-} from "./chunk-RB2L33ZR.js";
-import "./chunk-7FIPXMZR.js";
+} from "./chunk-4EWY34YA.js";
 import {
   Snapshot
-} from "./chunk-UG2GCPHF.js";
+} from "./chunk-4KB5WXHR.js";
+import "./chunk-EFGXTO64.js";
 import {
   Tool
-} from "./chunk-DILHJIMP.js";
-import "./chunk-ZSRC3TN4.js";
+} from "./chunk-QBXIE6EY.js";
+import "./chunk-UNMKB2DA.js";
 import {
   AssignmentError,
   CodeExecutionError,
@@ -18,41 +21,38 @@ import {
   SnapshotSignal,
   ThinkSignal,
   VMSignal
-} from "./chunk-RJHDQL4C.js";
-import {
-  Exit
-} from "./chunk-6QDFMQHA.js";
-import {
-  DualModePrompt
-} from "./chunk-QPSUMPLP.js";
-import "./chunk-Q4DEJGXD.js";
+} from "./chunk-JKVVQN2P.js";
 import {
   cleanStackTrace
-} from "./chunk-MSTBEKOQ.js";
+} from "./chunk-JQBT7UWN.js";
+import {
+  Exit
+} from "./chunk-S6WICIDW.js";
 import {
   assertValidComponent
-} from "./chunk-3T465BEW.js";
+} from "./chunk-ZCPQ3QOW.js";
+import "./chunk-ORQP26SZ.js";
 import {
   truncateWrappedContent,
   wrapContent
-} from "./chunk-UVSOAH2H.js";
+} from "./chunk-QT4QF3YA.js";
 import {
   init,
   stripInvalidIdentifiers
-} from "./chunk-DFZ6GX5C.js";
+} from "./chunk-5TRUJES5.js";
 import {
   clamp_default,
   cloneDeep_default,
   isEqual_default,
   isPlainObject_default,
   omit_default
-} from "./chunk-7S3UY52U.js";
-import "./chunk-YSQDPG26.js";
+} from "./chunk-7WRN4E42.js";
 
 // src/llmz.ts
 import { Cognitive } from "@botpress/cognitive";
 import { z } from "@bpinternal/zui";
 import ms from "ms";
+import { ulid as ulid2 } from "ulid";
 
 // src/context.ts
 import { ulid } from "ulid";
@@ -72,15 +72,15 @@ var getValue = async (valueOrGetter, ctx) => {
 
 // src/handlers.ts
 var Emitter = class {
-  handlers = [];
+  _handlers = [];
   subscribe = (fn) => {
-    this.handlers.push(fn);
+    this._handlers.push(fn);
     return () => {
-      this.handlers = this.handlers.filter((handler) => handler !== fn);
+      this._handlers = this._handlers.filter((handler) => handler !== fn);
     };
   };
   emit(event) {
-    this.handlers.forEach((handler) => handler(event));
+    this._handlers.forEach((handler) => handler(event));
   }
 };
 var HookedArray = class extends Array {
@@ -263,6 +263,8 @@ var Context = class {
   exits;
   components;
   version = DualModePrompt;
+  timeout = 6e4;
+  // Default timeout of 60 seconds
   loop;
   temperature;
   model;
@@ -441,7 +443,7 @@ var Context = class {
       throw new Error("Too many tools. Expected at most 100 tools.");
     }
     for (const component of components) {
-      assertValidComponent(component);
+      assertValidComponent(component.definition);
     }
     const ReservedToolNames = [
       "think",
@@ -472,7 +474,10 @@ var Context = class {
     }
     if (MessageTool && components.length) {
       MessageTool.aliases = Array.from(
-        /* @__PURE__ */ new Set([...MessageTool.aliases, ...components.flatMap((x) => [x.name, ...x.aliases ?? []])])
+        /* @__PURE__ */ new Set([
+          ...MessageTool.aliases,
+          ...components.flatMap((x) => [x.definition.name, ...x.definition.aliases ?? []])
+        ])
       );
     }
     const nonMessageTools = tools.filter((x) => {
@@ -486,10 +491,12 @@ var Context = class {
         if (ReservedToolNames.includes(name)) {
           throw new Error(`Tool name "${name}" (${tool.name}) is reserved. Please choose a different name.`);
         }
-        if (components.find((x) => {
-          var _a2;
-          return x.name.toLowerCase() === name || ((_a2 = x.aliases) == null ? void 0 : _a2.map((x2) => x2.toLowerCase()).includes(name));
-        })) {
+        if (components.find(
+          (x) => {
+            var _a2;
+            return x.definition.name.toLowerCase() === name || ((_a2 = x.definition.aliases) == null ? void 0 : _a2.map((x2) => x2.toLowerCase()).includes(name));
+          }
+        )) {
           throw new Error(
             `Tool name "${name}" (${tool.name}) is already used by a component. Please choose a different name.`
           );
@@ -536,6 +543,7 @@ var Context = class {
     this.tools = props.tools;
     this.exits = props.exits;
     this.components = props.components;
+    this.timeout = Math.min(999999999, Math.max(0, props.timeout ?? 6e4));
     this.loop = props.loop ?? 3;
     this.temperature = props.temperature ?? 0.7;
     this.model = props.model;
@@ -565,9 +573,9 @@ var getModelOutputLimit = (inputLength) => clamp_default(
   RESPONSE_LENGTH_BUFFER.MAX_TOKENS
 );
 var executeContext = async (props) => {
-  var _a, _b, _c;
+  var _a, _b, _c, _d;
   await init();
-  const { signal, onIterationEnd, onTrace, onExit } = props;
+  const { signal, onIterationEnd, onTrace, onExit, onBeforeExecution } = props;
   const cognitive = props.client instanceof Cognitive ? props.client : new Cognitive({ client: props.client });
   const cleanups = [];
   const ctx = new Context({
@@ -577,6 +585,7 @@ var executeContext = async (props) => {
     loop: (_a = props.options) == null ? void 0 : _a.loop,
     temperature: (_b = props.options) == null ? void 0 : _b.temperature,
     model: (_c = props.options) == null ? void 0 : _c.model,
+    timeout: (_d = props.options) == null ? void 0 : _d.timeout,
     transcript: props.transcript,
     exits: props.exits,
     components: props.components,
@@ -593,6 +602,20 @@ var executeContext = async (props) => {
         };
       }
       const iteration = await ctx.nextIteration();
+      if (signal == null ? void 0 : signal.aborted) {
+        iteration.end({
+          type: "aborted",
+          aborted: {
+            reason: signal.reason ?? "The operation was aborted"
+          }
+        });
+        return {
+          status: "error",
+          error: signal.reason ?? "The operation was aborted",
+          context: ctx,
+          iterations: ctx.iterations
+        };
+      }
       cleanups.push(
         iteration.traces.onPush((traces) => {
           for (const trace of traces) {
@@ -606,14 +629,15 @@ var executeContext = async (props) => {
           ctx,
           cognitive,
           abortSignal: signal,
-          onExit
+          onExit,
+          onBeforeExecution
         });
       } catch (err) {
         iteration.end({
           type: "execution_error",
           execution_error: {
-            stack: cleanStackTrace(err.stack ?? "No stack trace available"),
-            message: "An unexpected error occurred: " + getErrorMessage(err)
+            message: "An unexpected error occurred: " + getErrorMessage(err),
+            stack: cleanStackTrace(err.stack ?? "No stack trace available")
           }
         });
       }
@@ -669,7 +693,8 @@ var executeIteration = async ({
   ctx,
   cognitive,
   abortSignal,
-  onExit
+  onExit,
+  onBeforeExecution
 }) => {
   var _a, _b, _c, _d, _e;
   let startedAt = Date.now();
@@ -687,6 +712,12 @@ var executeIteration = async ({
       x.content.trim().length > 0
     )
   );
+  traces.push({
+    type: "llm_call_started",
+    started_at: startedAt,
+    ended_at: startedAt,
+    model: ctx.model ?? ""
+  });
   const output = await cognitive.generateContent({
     signal: abortSignal,
     systemPrompt: (_a = messages.find((x) => x.role === "system")) == null ? void 0 : _a.content,
@@ -708,6 +739,28 @@ var executeIteration = async ({
   }
   const assistantResponse = ctx.version.parseAssistantResponse(out);
   iteration.code = assistantResponse.code.trim();
+  if (typeof onBeforeExecution === "function") {
+    try {
+      await onBeforeExecution(iteration);
+    } catch (err) {
+      if (err instanceof ThinkSignal) {
+        return iteration.end({
+          type: "thinking_requested",
+          thinking_requested: {
+            variables: err.context,
+            reason: err.reason
+          }
+        });
+      }
+      return iteration.end({
+        type: "execution_error",
+        execution_error: {
+          message: `Error in onBeforeExecution hook: ${getErrorMessage(err)}`,
+          stack: cleanStackTrace(err.stack ?? "No stack trace available")
+        }
+      });
+    }
+  }
   iteration.llm = {
     cached: output.meta.cached || false,
     ended_at: Date.now(),
@@ -794,7 +847,7 @@ var executeIteration = async ({
     });
   }
   startedAt = Date.now();
-  const result = await runAsyncFunction(vmContext, assistantResponse.code.trim(), traces, abortSignal).catch(
+  const result = await runAsyncFunction(vmContext, iteration.code, traces, abortSignal, ctx.timeout).catch(
     (err) => {
       return {
         success: false,
@@ -824,7 +877,7 @@ var executeIteration = async ({
       type: "execution_error",
       execution_error: {
         message: result.error.message,
-        stack: cleanStackTrace(result.error.stack ?? "No stack trace available")
+        stack: cleanStackTrace(result.error.stacktrace ?? result.error.stack ?? "No stack trace available")
       }
     });
   }
@@ -849,7 +902,7 @@ var executeIteration = async ({
     return iteration.end({
       type: "thinking_requested",
       thinking_requested: {
-        variables: result.signal.variables,
+        variables: result.signal.context,
         reason: result.signal.reason
       }
     });
@@ -942,10 +995,12 @@ var executeIteration = async ({
 function wrapTool({ tool, traces, object }) {
   const getToolInput = (input) => tool.zInput.safeParse(input).data ?? input;
   return function(input) {
+    const toolCallId = `tcall_${ulid2()}`;
     const alertSlowTool = setTimeout(
       () => traces.push({
         type: "tool_slow",
         tool_name: tool.name,
+        tool_call_id: toolCallId,
         started_at: Date.now(),
         input: getToolInput(input),
         object,
@@ -985,7 +1040,9 @@ function wrapTool({ tool, traces, object }) {
       return false;
     };
     try {
-      const result = tool.execute(input);
+      const result = tool.execute(input, {
+        callId: toolCallId
+      });
       if (result instanceof Promise || (result == null ? void 0 : result.then) && (result == null ? void 0 : result.catch)) {
         return result.then((res) => {
           output = res;
@@ -1001,6 +1058,7 @@ function wrapTool({ tool, traces, object }) {
           cancelSlowTool();
           traces.push({
             type: "tool_call",
+            tool_call_id: toolCallId,
             started_at: toolStart,
             ended_at: Date.now(),
             tool_name: tool.name,
@@ -1023,6 +1081,7 @@ function wrapTool({ tool, traces, object }) {
     cancelSlowTool();
     traces.push({
       type: "tool_call",
+      tool_call_id: toolCallId,
       started_at: toolStart,
       ended_at: Date.now(),
       tool_name: tool.name,