llmz 0.0.2 → 0.0.4

package/dist/index.cjs

@@ -1,34 +1,38 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { newObj[key] = obj[key]; } } } newObj.default = obj; return newObj; } } function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { newObj[key] = obj[key]; } } } newObj.default = obj; return newObj; } } function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } var _class;
 
-var _chunkC2TSWGYCcjs = require('./chunk-C2TSWGYC.cjs');
+var _chunk6YWYCVABcjs = require('./chunk-6YWYCVAB.cjs');
+require('./chunk-VAF2H6UD.cjs');
 
 
-var _chunkYPOOKE3Acjs = require('./chunk-YPOOKE3A.cjs');
+var _chunk4QTK5ALHcjs = require('./chunk-4QTK5ALH.cjs');
 
 
 
-var _chunkYUDUY7XWcjs = require('./chunk-YUDUY7XW.cjs');
+var _chunkHYVKY3W6cjs = require('./chunk-HYVKY3W6.cjs');
 
 
 
 
-var _chunkZUAFUOURcjs = require('./chunk-ZUAFUOUR.cjs');
+var _chunkJDABP4SDcjs = require('./chunk-JDABP4SD.cjs');
+require('./chunk-IKSIOIIP.cjs');
 
 
-var _chunkR2N2UUKCcjs = require('./chunk-R2N2UUKC.cjs');
-require('./chunk-QZGFCB4T.cjs');
-require('./chunk-PQN6HW7A.cjs');
-require('./chunk-E5W3P7EO.cjs');
+var _chunkLVKZYKTPcjs = require('./chunk-LVKZYKTP.cjs');
 
 
 
 
-var _chunkENFB45AIcjs = require('./chunk-ENFB45AI.cjs');
+var _chunkJK2LZW2Gcjs = require('./chunk-JK2LZW2G.cjs');
+require('./chunk-KMZDFWYZ.cjs');
 
 
 
-var _chunk3CGLDS5Tcjs = require('./chunk-3CGLDS5T.cjs');
-require('./chunk-A7BDFLAE.cjs');
+
+var _chunkP7J2WCBBcjs = require('./chunk-P7J2WCBB.cjs');
+
+
+
+var _chunkUQOBUJIQcjs = require('./chunk-UQOBUJIQ.cjs');
 
 // src/objects.ts
 var _zui = require('@bpinternal/zui');
@@ -40,7 +44,7 @@ var _traverse = require('@babel/traverse'); var _traverse2 = _interopRequireDefa
 var _types = require('@babel/types'); var t = _interopRequireWildcard(_types);
 var traverse = _traverse2.default;
 function getTypingsWithoutComments(type) {
-  const typeClone = _chunk3CGLDS5Tcjs.cloneDeep_default.call(void 0, type);
+  const typeClone = _chunkUQOBUJIQcjs.cloneDeep_default.call(void 0, type);
   removeBabelComments(typeClone);
   return new (0, _generator.CodeGenerator)(typeClone, { comments: false }).generate().code;
 }
@@ -108,7 +112,7 @@ function extractAndHoistTypes(ast) {
       }
       currPath = parentPath;
     }
-    return parts.size ? Array.from(parts).reverse().map(_chunk3CGLDS5Tcjs.upperFirst_default) : ["UnnamedType"];
+    return parts.size ? Array.from(parts).reverse().map(_chunkUQOBUJIQcjs.upperFirst_default) : ["UnnamedType"];
   }
   function generateTypeName(path) {
     return getTypePaths(path).join("");
@@ -275,12 +279,12 @@ async function hoistTypings(code, formatOptions) {
     } catch (err) {
       console.error(err);
       if (formatOptions.throwOnError) {
-        throw new (0, _chunkZUAFUOURcjs.CodeFormattingError)(err instanceof Error ? err.message : String(_nullishCoalesce(err, () => ( "Unknown Error"))), code);
+        throw new (0, _chunkJDABP4SDcjs.CodeFormattingError)(err instanceof Error ? err.message : String(_nullishCoalesce(err, () => ( "Unknown Error"))), code);
       }
       break;
     }
   }
-  return _chunkYUDUY7XWcjs.formatTypings.call(void 0, code, formatOptions);
+  return _chunkHYVKY3W6cjs.formatTypings.call(void 0, code, formatOptions);
 }
 
 // src/objects.ts
@@ -293,7 +297,7 @@ var ObjectInstance = class {
   
   constructor(props) {
     var _a;
-    if (!_chunkENFB45AIcjs.isValidIdentifier.call(void 0, props.name)) {
+    if (!_chunkP7J2WCBBcjs.isValidIdentifier.call(void 0, props.name)) {
       throw new Error(
         `Invalid name for tool ${props.name}. A tool name must start with a letter and contain only letters, numbers, and underscores. It must be 1-50 characters long.`
       );
@@ -326,7 +330,7 @@ var ObjectInstance = class {
         if (props.properties.filter((p) => p.name === prop.name).length > 1) {
           throw new Error(`Duplicate property name "${prop.name}" in tool ${props.name}`);
         }
-        if (!_chunkENFB45AIcjs.isValidIdentifier.call(void 0, prop.name)) {
+        if (!_chunkP7J2WCBBcjs.isValidIdentifier.call(void 0, prop.name)) {
           throw new Error(
             `Invalid name for property ${prop.name}. A property name must start with a letter and contain only letters, numbers, and underscores. It must be 1-50 characters long.`
           );
@@ -350,7 +354,7 @@ var ObjectInstance = class {
     this.description = props.description;
     this.metadata = _nullishCoalesce(props.metadata, () => ( {}));
     this.properties = props.properties;
-    this.tools = _chunkYPOOKE3Acjs.Tool.withUniqueNames(_nullishCoalesce(props.tools, () => ( [])));
+    this.tools = _chunk4QTK5ALHcjs.Tool.withUniqueNames(_nullishCoalesce(props.tools, () => ( [])));
   }
   async getTypings() {
     return getObjectTypings(this).withProperties().withTools().build();
@@ -372,11 +376,11 @@ function getObjectTypings(obj) {
       for (const prop of _nullishCoalesce(obj.properties, () => ( []))) {
         const description = _nullishCoalesce(prop.description, () => ( ""));
         if (description == null ? void 0 : description.trim().length) {
-          typings.push(_chunkENFB45AIcjs.getMultilineComment.call(void 0, description));
+          typings.push(_chunkP7J2WCBBcjs.getMultilineComment.call(void 0, description));
         }
         let type = "unknown";
         if (prop.type) {
-          type = await _chunkYUDUY7XWcjs.getTypings.call(void 0, prop.type, {});
+          type = await _chunkHYVKY3W6cjs.getTypings.call(void 0, prop.type, {});
         } else if (prop.value !== void 0) {
           type = typeof prop.value;
         }
@@ -396,7 +400,7 @@ function getObjectTypings(obj) {
       typings.push("");
       for (const tool of obj.tools) {
         const fnType = _zui.z.function(tool.zInput, tool.zOutput).title(tool.name).describe(_nullishCoalesce(tool.description, () => ( "")));
-        let temp = await _chunkYUDUY7XWcjs.getTypings.call(void 0, fnType, {
+        let temp = await _chunkHYVKY3W6cjs.getTypings.call(void 0, fnType, {
           declaration: true
         });
         temp = temp.replace("declare function ", "function ");
@@ -417,9 +421,9 @@ function getObjectTypings(obj) {
     typings.push("}" + closingBracket);
     let header = "";
     if ((_a = obj.description) == null ? void 0 : _a.trim().length) {
-      header = _chunkENFB45AIcjs.getMultilineComment.call(void 0, obj.description);
+      header = _chunkP7J2WCBBcjs.getMultilineComment.call(void 0, obj.description);
     }
-    return _chunkYUDUY7XWcjs.formatTypings.call(void 0, 
+    return _chunkHYVKY3W6cjs.formatTypings.call(void 0, 
       `${header}
       export namespace ${obj.name} {
       ${body}
@@ -450,7 +454,7 @@ function getObjectTypings(obj) {
 }
 function embedPropertyValue(property) {
   if (typeof property.value === "string") {
-    return _chunkENFB45AIcjs.escapeString.call(void 0, property.value);
+    return _chunkP7J2WCBBcjs.escapeString.call(void 0, property.value);
   }
   if (Number.isNaN(property.value)) {
     return "NaN";
@@ -468,7 +472,7 @@ function embedPropertyValue(property) {
     return `new Date('${property.value.toISOString()}')`;
   }
   if (property.value instanceof RegExp) {
-    return `new RegExp(${_chunkENFB45AIcjs.escapeString.call(void 0, property.value.source)}, ${_chunkENFB45AIcjs.escapeString.call(void 0, property.value.flags)})`;
+    return `new RegExp(${_chunkP7J2WCBBcjs.escapeString.call(void 0, property.value.source)}, ${_chunkP7J2WCBBcjs.escapeString.call(void 0, property.value.flags)})`;
   }
   if (property.value === null) {
     return "null";
@@ -486,7 +490,7 @@ function embedPropertyValue(property) {
     return `${property.value}n`;
   }
   if (property.value instanceof Error) {
-    return `Error(${_chunkENFB45AIcjs.escapeString.call(void 0, property.value.message)})`;
+    return `Error(${_chunkP7J2WCBBcjs.escapeString.call(void 0, property.value.message)})`;
   }
   if (property.value instanceof Map) {
     return `new Map(${JSON.stringify(Array.from(property.value.entries()))})`;
@@ -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 = class {constructor() { _class.prototype.__init.call(this);_class.prototype.__init2.call(this); }
+  __init() {this._citations = /* @__PURE__ */ new Map()}
+  __init2() {this._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 = (_nullishCoalesce(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) => (_nullishCoalesce(a.offset, () => ( 0))) - (_nullishCoalesce(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;
+  }
+}, _class);
+
 // src/component.default.ts
-var Button = {
+var Button = new (0, _chunkJK2LZW2Gcjs.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 (0, _chunkJK2LZW2Gcjs.Component)({
   type: "leaf",
   name: "Image",
   description: "Displays an image from a URL.",
@@ -579,8 +717,8 @@ var Image = {
       }
     ]
   }
-};
-var File = {
+});
+var File = new (0, _chunkJK2LZW2Gcjs.Component)({
   type: "leaf",
   name: "File",
   description: "Sends a downloadable file to the user.",
@@ -610,8 +748,8 @@ var File = {
       }
     ]
   }
-};
-var Video = {
+});
+var Video = new (0, _chunkJK2LZW2Gcjs.Component)({
   type: "leaf",
   name: "Video",
   description: "Embeds a video from a URL.",
@@ -641,8 +779,8 @@ var Video = {
       }
     ]
   }
-};
-var Audio = {
+});
+var Audio = new (0, _chunkJK2LZW2Gcjs.Component)({
   type: "leaf",
   name: "Audio",
   description: "Plays an audio clip from a URL.",
@@ -672,8 +810,8 @@ var Audio = {
       }
     ]
   }
-};
-var Card = {
+});
+var Card = new (0, _chunkJK2LZW2Gcjs.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 (0, _chunkJK2LZW2Gcjs.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 (0, _chunkJK2LZW2Gcjs.Component)({
   type: "default",
   name: "Message",
   aliases: ["Text", "Markdown"],
@@ -769,7 +907,15 @@ var Text = {
     props: [],
     children: []
   }
-};
+});
+var messageTool = (handler) => new (0, _chunk4QTK5ALHcjs.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,20 +929,20 @@ var DefaultComponents = {
 
 // src/index.ts
 var executeContext = async (props) => {
-  const { executeContext: executeContext2 } = (await Promise.resolve().then(() => _interopRequireWildcard(require("./llmz-EGTGPSTX.cjs")))).llmz;
+  const { executeContext: executeContext2 } = (await Promise.resolve().then(() => _interopRequireWildcard(require("./llmz-R6XZG3JQ.cjs")))).llmz;
   return executeContext2(props);
 };
 var init = async () => {
-  await Promise.resolve().then(() => _interopRequireWildcard(require("./llmz-EGTGPSTX.cjs")));
-  await Promise.resolve().then(() => _interopRequireWildcard(require("./component-DWBRHLEN.cjs")));
-  await Promise.resolve().then(() => _interopRequireWildcard(require("./tool-AY47ML65.cjs")));
-  await Promise.resolve().then(() => _interopRequireWildcard(require("./exit-PQHMJEOG.cjs")));
-  await Promise.resolve().then(() => _interopRequireWildcard(require("./jsx-PPLE5YTB.cjs")));
-  await Promise.resolve().then(() => _interopRequireWildcard(require("./vm-4JFSZAMR.cjs")));
-  await Promise.resolve().then(() => _interopRequireWildcard(require("./utils-UR4IMUHC.cjs")));
-  await Promise.resolve().then(() => _interopRequireWildcard(require("./truncator-ZKPOW2I3.cjs")));
-  await Promise.resolve().then(() => _interopRequireWildcard(require("./typings-QRJGGNUM.cjs")));
-  await Promise.resolve().then(() => _interopRequireWildcard(require("./dual-modes-3MH5N6RY.cjs")));
+  await Promise.resolve().then(() => _interopRequireWildcard(require("./llmz-R6XZG3JQ.cjs")));
+  await Promise.resolve().then(() => _interopRequireWildcard(require("./component-HQ5YQNRX.cjs")));
+  await Promise.resolve().then(() => _interopRequireWildcard(require("./tool-SWJYOR2Z.cjs")));
+  await Promise.resolve().then(() => _interopRequireWildcard(require("./exit-IDKGZD7M.cjs")));
+  await Promise.resolve().then(() => _interopRequireWildcard(require("./jsx-AJAXBWFE.cjs")));
+  await Promise.resolve().then(() => _interopRequireWildcard(require("./vm-GJ5R72AP.cjs")));
+  await Promise.resolve().then(() => _interopRequireWildcard(require("./utils-QC4I2L6R.cjs")));
+  await Promise.resolve().then(() => _interopRequireWildcard(require("./truncator-NYN7BGKJ.cjs")));
+  await Promise.resolve().then(() => _interopRequireWildcard(require("./typings-XR6CYHW4.cjs")));
+  await Promise.resolve().then(() => _interopRequireWildcard(require("./dual-modes-YE4S2AIL.cjs")));
 };
 
 
@@ -808,4 +954,9 @@ var init = async () => {
 
 
 
-exports.DefaultComponents = DefaultComponents; exports.Exit = _chunkR2N2UUKCcjs.Exit; exports.ObjectInstance = ObjectInstance; exports.Snapshot = _chunkC2TSWGYCcjs.Snapshot; exports.SnapshotSignal = _chunkZUAFUOURcjs.SnapshotSignal; exports.ThinkSignal = _chunkZUAFUOURcjs.ThinkSignal; exports.Tool = _chunkYPOOKE3Acjs.Tool; exports.executeContext = executeContext; exports.init = init;
+
+
+
+
+
+exports.CitationsManager = CitationsManager; exports.Component = _chunkJK2LZW2Gcjs.Component; exports.DefaultComponents = DefaultComponents; exports.Exit = _chunkLVKZYKTPcjs.Exit; exports.ObjectInstance = ObjectInstance; exports.Snapshot = _chunk6YWYCVABcjs.Snapshot; exports.SnapshotSignal = _chunkJDABP4SDcjs.SnapshotSignal; exports.ThinkSignal = _chunkJDABP4SDcjs.ThinkSignal; exports.Tool = _chunk4QTK5ALHcjs.Tool; exports.assertValidComponent = _chunkJK2LZW2Gcjs.assertValidComponent; exports.executeContext = executeContext; exports.init = init; exports.isComponent = _chunkJK2LZW2Gcjs.isComponent; exports.messageTool = messageTool;

package/dist/index.d.ts

@@ -2,8 +2,9 @@ export { Tool } from './tool.js';
 export { Exit } from './exit.js';
 export { ObjectInstance } from './objects.js';
 export { SnapshotSignal, ThinkSignal } from './errors.js';
-export { Component, ContainerComponent, DefaultComponent, LeafComponent } from './component.js';
-export { DefaultComponents } from './component.default.js';
+export { Component, RenderedComponent, LeafComponentDefinition, ContainerComponentDefinition, DefaultComponentDefinition, ComponentDefinition, assertValidComponent, isComponent, } from './component.js';
+export { Citation, CitationsManager } from './citations.js';
+export { DefaultComponents, messageTool } from './component.default.js';
 export { Snapshot } from './snapshots.js';
 import { type ExecutionProps } from './llmz.js';
 import { type ExecutionResult } from './types.js';