@botpress/runtime 1.8.1 → 1.8.2

package/dist/library.js

@@ -48,7 +48,7 @@ var init_define_BUILD = __esm({
 var define_PACKAGE_VERSIONS_default;
 var init_define_PACKAGE_VERSIONS = __esm({
   "<define:__PACKAGE_VERSIONS__>"() {
-    define_PACKAGE_VERSIONS_default = { runtime: "1.8.1", adk: "1.8.1", sdk: "4.19.0", llmz: "0.0.33", zai: "2.5.0", cognitive: "0.2.0" };
+    define_PACKAGE_VERSIONS_default = { runtime: "1.8.2", adk: "1.8.2", sdk: "4.19.0", llmz: "0.0.33", zai: "2.5.0", cognitive: "0.2.0" };
   }
 });
 
@@ -27678,11 +27678,11 @@ function expand_(str, isTop) {
           if (pad) {
             const need = width - c.length;
             if (need > 0) {
-              const z26 = new Array(need + 1).join("0");
+              const z27 = new Array(need + 1).join("0");
               if (i < 0) {
-                c = "-" + z26 + c.slice(1);
+                c = "-" + z27 + c.slice(1);
               } else {
-                c = z26 + c;
+                c = z27 + c;
               }
             }
           }
@@ -34293,7 +34293,7 @@ var init_esm9 = __esm({
 // src/library.ts
 init_define_BUILD();
 init_define_PACKAGE_VERSIONS();
-import { z as z25 } from "@botpress/sdk";
+import { z as z26 } from "@botpress/sdk";
 import { Cognitive as Cognitive2 } from "@botpress/cognitive";
 import { Zai as Zai2 } from "@botpress/zai";
 
@@ -42701,7 +42701,7 @@ init_define_PACKAGE_VERSIONS();
 // src/runtime/chat/chat.ts
 init_define_BUILD();
 init_define_PACKAGE_VERSIONS();
-import { Chat, DefaultComponents, isAnyComponent as isAnyComponent2 } from "llmz";
+import { Chat, isAnyComponent as isAnyComponent2 } from "llmz";
 
 // src/runtime/chat/truncate-transcript.ts
 init_define_BUILD();
@@ -43019,6 +43019,268 @@ var Transcript = {
   TRANSCRIPT_ITEM_MAX_BYTES: 1e4
 };
 
+// src/runtime/chat/components.ts
+init_define_BUILD();
+init_define_PACKAGE_VERSIONS();
+import { messages, z as z17 } from "@botpress/sdk";
+var DefaultMessageTypes = {
+  text: messages.defaults["text"].schema,
+  audio: messages.defaults["audio"].schema,
+  card: messages.defaults["card"].schema,
+  image: messages.defaults["image"].schema,
+  carousel: messages.defaults["carousel"].schema,
+  choice: messages.defaults["choice"].schema,
+  dropdown: messages.defaults["dropdown"].schema,
+  file: messages.defaults["file"].schema,
+  location: messages.defaults["location"].schema,
+  video: messages.defaults["video"].schema,
+  bloc: messages.defaults["bloc"].schema
+};
+var AudioComponent = new Autonomous.Component({
+  type: "leaf",
+  aliases: [],
+  name: "Audio",
+  description: `Send an audio file to the user, which will be playable by the user whithin the chat interface. The audio file should be in a supported format (e.g., MP3, WAV) and accessible via a public URL.`,
+  examples: [
+    {
+      name: " Basic Audio Message",
+      description: "Sends a simple audio message to the user",
+      code: `
+yield <Message>
+  Here's an **awesome** audio clip for you!
+  <Audio audioUrl="https://example.com/path/to/audio.mp3" />
+</Message>`
+    }
+  ],
+  leaf: {
+    props: z17.object({
+      audioUrl: z17.string().url().describe("The URL of the audio file to be sent.")
+    })
+  }
+});
+var ImageComponent = new Autonomous.Component({
+  type: "leaf",
+  aliases: ["img"],
+  name: "Image",
+  description: `Send an image to the user, which will be displayed within the chat interface. The image should be in a supported format (e.g., JPEG, PNG) and accessible via a public URL.`,
+  examples: [
+    {
+      name: " Basic Image Message",
+      description: "Sends a simple image message to the user",
+      code: `
+yield <Message>
+  Here's an **awesome** image for you!
+  <Image imageUrl="https://example.com/path/to/image.jpg" />
+</Message>`
+    }
+  ],
+  leaf: {
+    props: z17.object({
+      imageUrl: z17.string().url().describe("The URL of the image to be sent.")
+    })
+  }
+});
+var VideoComponent = new Autonomous.Component({
+  type: "leaf",
+  aliases: [],
+  name: "Video",
+  description: `Send a video to the user, which will be playable within the chat interface. The video should be in a supported format (e.g., MP4, WebM) and accessible via a public URL.`,
+  examples: [
+    {
+      name: " Basic Video Message",
+      description: "Sends a simple video message to the user",
+      code: `
+yield <Message>
+  Here's an **awesome** video for you!
+  <Video videoUrl="https://example.com/path/to/video.mp4" />
+</Message>`
+    }
+  ],
+  leaf: {
+    props: z17.object({
+      videoUrl: z17.string().url().describe("The URL of the video to be sent.")
+    })
+  }
+});
+var LocationComponent = new Autonomous.Component({
+  type: "leaf",
+  aliases: [],
+  name: "Location",
+  description: `Send a location to the user, which will be displayed as a map within the chat interface. The location should include latitude and longitude coordinates.
+The location can also optionally include an address and a title for better context.`,
+  examples: [
+    {
+      name: " Basic Location Message",
+      description: "Sends a simple location message to the user",
+      code: `
+yield <Message>
+  Here's the location you requested!
+  <Location latitude={37.7749} longitude={-122.4194} />
+</Message>`
+    },
+    {
+      name: " Location Message with Address and Title",
+      description: "Sends a location message with additional address and title information",
+      code: `
+yield <Message>
+  Here's the location of our office!
+  <Location 
+    latitude={45.506342} 
+    longitude={-73.572012} 
+    address="400 Blvd. De Maisonneuve Ouest #200, Montreal, Quebec H3A 1L4, Canada"
+    title="Botpress HQ" 
+  />
+</Message>`
+    }
+  ],
+  leaf: {
+    props: z17.object({
+      latitude: z17.number().describe("The latitude of the location to be sent."),
+      longitude: z17.number().describe("The longitude of the location to be sent."),
+      address: z17.string().optional().describe("The address of the location to be sent."),
+      title: z17.string().optional().describe("The title of the location to be sent.")
+    })
+  }
+});
+var ChoiceComponent = new Autonomous.Component({
+  type: "leaf",
+  aliases: ["choices", "option", "options", "buttons"],
+  name: "Choice",
+  description: `Present a choice to the user with multiple options.
+The user can select one of the provided options, and the selection will be sent back to the system for further processing.
+You can include up to 10 options for the user to choose from.
+Values for each option should be unique identifiers that can be used to identify the user's selection.`,
+  examples: [
+    {
+      name: " Basic Choice Message",
+      description: "Presents a simple choice message to the user",
+      code: `
+yield <Message>
+  Please choose one of the following options:
+  <Choice 
+    text="Select an option:"
+    options={[
+      { label: "Option 1", value: "option_1" },
+      { label: "Option 2", value: "option_2" },
+      { label: "Option 3", value: "option_3" }
+    ]}
+  />
+</Message>`
+    }
+  ],
+  leaf: {
+    props: z17.object({
+      text: z17.string().describe("The prompt text for the choice."),
+      options: z17.array(
+        z17.object({
+          label: z17.string().describe("The label of the option to be displayed to the user."),
+          value: z17.string().describe("The value of the option to be sent back when selected.")
+        })
+      ).describe("The list of options to present to the user.")
+    })
+  }
+});
+var DropdownComponent = new Autonomous.Component({
+  type: "leaf",
+  aliases: ["dropdown", "select", "combo"],
+  name: "Dropdown",
+  description: `Present a dropdown menu to the user with multiple options.
+The user can select one of the provided options from the dropdown, and the selection will be sent back to the system for further processing.
+Unlike the Choice component, the Dropdown component is typically used when there are more options to choose from, providing a more compact UI.
+The dropdown can include up to 100 options for the user to choose from.
+Values for each option should be unique identifiers that can be used to identify the user's selection.`,
+  examples: [
+    {
+      name: " Basic Dropdown Message",
+      description: "Presents a simple dropdown message to the user",
+      code: `
+yield <Message>
+  Please select a fruit from the dropdown:
+  <Dropdown 
+    text="Choose an option:"
+    options={[
+      { label: "\u{1F350} Pear", value: "pear" },
+      { label: "\u{1F34E} Apple", value: "apple" },
+      { label: "\u{1F34C} Banana", value: "banana" }
+    ]}
+  />
+</Message>`
+    }
+  ],
+  leaf: {
+    props: z17.object({
+      text: z17.string().describe("The prompt text for the dropdown."),
+      options: z17.array(
+        z17.object({
+          label: z17.string().describe("The label of the option to be displayed to the user."),
+          value: z17.string().describe("The value of the option to be sent back when selected.")
+        })
+      ).describe("The list of options to present in the dropdown.")
+    })
+  }
+});
+var CarouselComponent = new Autonomous.Component({
+  type: "leaf",
+  aliases: ["carousel", "cards", "card"],
+  name: "Carousel",
+  description: `Send a carousel of cards to the user, allowing them to browse through multiple items.
+Carousels are useful for displaying a collection of related items in a compact and interactive format.
+It is also possible to send a single card using the Carousel component, useful for sending a combination of image, text, and actions in one message such as a receipt or product detail.
+Each item in the carousel is represented as a card, which can include an image, title, subtitle, and actions.
+Users can navigate through the carousel by swiping or clicking on navigation controls.
+You can include multiple cards in the carousel, each with its own set of actions. A carousel can contain between 1 and 10 items (cards).`,
+  examples: [
+    {
+      name: " Basic Carousel Message",
+      description: "Sends a simple carousel message to the user",
+      code: `
+yield <Message>
+  Here is an **exciting** carousel for you!
+  <Carousel 
+    items={[
+      {
+        title: "Product 1",
+        subtitle: "Description of Product 1",
+        imageUrl: "https://example.com/path/to/image1.jpg",
+        actions: [
+          { action: "postback", label: "Buy Now", value: "buy_product_1" },
+          { action: "url", label: "View Details", value: "https://example.com/product_1" }
+        ]
+      },
+      {
+        title: "Product 2",
+        subtitle: "Description of Product 2",
+        imageUrl: "https://example.com/path/to/image2.jpg",
+        actions: [
+          { action: "postback", label: "Buy Now", value: "buy_product_2" },
+          { action: "url", label: "View Details", value: "https://example.com/product_2" }
+        ]
+      }
+    ]}
+  />
+</Message>`
+    }
+  ],
+  leaf: {
+    props: z17.object({
+      items: z17.array(
+        z17.object({
+          title: z17.string().describe("The title of the carousel item."),
+          subtitle: z17.string().optional().describe("The subtitle of the carousel item."),
+          imageUrl: z17.string().url().optional().describe("The URL of the image to be displayed on the carousel item."),
+          actions: z17.array(
+            z17.object({
+              action: z17.enum(["postback", "url", "say"]).describe("The type of action for the button."),
+              label: z17.string().describe("The label of the button to be displayed to the user."),
+              value: z17.string().describe("The value associated with the button action.")
+            })
+          ).max(3).describe("The list of actions (buttons) to include on the carousel item.")
+        })
+      ).describe("The list of items (cards) to include in the carousel.")
+    })
+  }
+});
+
 // src/runtime/chat/citations.ts
 init_define_BUILD();
 init_define_PACKAGE_VERSIONS();
@@ -43026,21 +43288,21 @@ init_define_PACKAGE_VERSIONS();
 // src/runtime/chat/transcript.ts
 init_define_BUILD();
 init_define_PACKAGE_VERSIONS();
-import { z as z17 } from "@botpress/sdk";
-var AttachmentSchema = z17.object({
-  type: z17.literal("image"),
-  url: z17.string()
-});
-var TranscriptItemSchema = z17.object({
-  id: z17.string(),
-  role: z17.union([z17.literal("assistant"), z17.literal("user"), z17.literal("event"), z17.literal("summary")]),
-  name: z17.string().optional(),
-  createdAt: z17.string().optional(),
-  content: z17.string().optional(),
-  attachments: z17.array(AttachmentSchema).optional(),
-  payload: z17.unknown().optional()
-});
-var TranscriptSchema = z17.array(TranscriptItemSchema);
+import { z as z18 } from "@botpress/sdk";
+var AttachmentSchema = z18.object({
+  type: z18.literal("image"),
+  url: z18.string()
+});
+var TranscriptItemSchema = z18.object({
+  id: z18.string(),
+  role: z18.union([z18.literal("assistant"), z18.literal("user"), z18.literal("event"), z18.literal("summary")]),
+  name: z18.string().optional(),
+  createdAt: z18.string().optional(),
+  content: z18.string().optional(),
+  attachments: z18.array(AttachmentSchema).optional(),
+  payload: z18.unknown().optional()
+});
+var TranscriptSchema = z18.array(TranscriptItemSchema);
 
 // src/runtime/handlers/index.ts
 init_define_BUILD();
@@ -43053,7 +43315,7 @@ init_define_PACKAGE_VERSIONS();
 // src/primitives/conversation.ts
 init_define_BUILD();
 init_define_PACKAGE_VERSIONS();
-import { z as z18 } from "@botpress/sdk";
+import { z as z19 } from "@botpress/sdk";
 import { setTimeout as setTimeout2 } from "node:timers/promises";
 
 // src/primitives/conversation-instance.ts
@@ -43185,7 +43447,7 @@ var BaseConversation = class {
   #startFromTrigger;
   constructor(props) {
     this.channel = props.channel;
-    this.schema = props.state ?? z18.object({}).passthrough();
+    this.schema = props.state ?? z19.object({}).passthrough();
     this.#handler = props.handler;
     if (props.startFromTrigger) {
       this.#startFromTrigger = props.startFromTrigger;
@@ -43363,45 +43625,45 @@ init_define_PACKAGE_VERSIONS();
 // src/primitives/definition.ts
 init_define_BUILD();
 init_define_PACKAGE_VERSIONS();
-import { z as z19 } from "@botpress/sdk";
+import { z as z20 } from "@botpress/sdk";
 var Definitions;
 ((Definitions2) => {
-  const conversationDefinitionSchema = z19.object({
-    type: z19.literal("conversation"),
-    channel: z19.union([
-      z19.string().min(1, "Channel must be a non-empty string").max(255, "Channel must be less than 255 characters").regex(/^(\*|[a-zA-Z0-9._-]+)$/, "Channel must be a valid identifier or glob '*'"),
-      z19.array(
-        z19.string().min(1, "Channel must be a non-empty string").max(255, "Channel must be less than 255 characters").regex(/^[a-zA-Z0-9._-]+$/, "Channel must be a valid identifier")
+  const conversationDefinitionSchema = z20.object({
+    type: z20.literal("conversation"),
+    channel: z20.union([
+      z20.string().min(1, "Channel must be a non-empty string").max(255, "Channel must be less than 255 characters").regex(/^(\*|[a-zA-Z0-9._-]+)$/, "Channel must be a valid identifier or glob '*'"),
+      z20.array(
+        z20.string().min(1, "Channel must be a non-empty string").max(255, "Channel must be less than 255 characters").regex(/^[a-zA-Z0-9._-]+$/, "Channel must be a valid identifier")
       )
     ])
   });
-  const workflowDefinitionSchema = z19.object({
-    type: z19.literal("workflow"),
-    name: z19.string().min(1, "Name must be a non-empty string").max(255, "Name must be less than 255 characters").regex(/^[a-zA-Z0-9_-]+$/, "Name must be a valid identifier")
+  const workflowDefinitionSchema = z20.object({
+    type: z20.literal("workflow"),
+    name: z20.string().min(1, "Name must be a non-empty string").max(255, "Name must be less than 255 characters").regex(/^[a-zA-Z0-9_-]+$/, "Name must be a valid identifier")
   });
-  const knowledgeDefinitionSchema = z19.object({
-    type: z19.literal("knowledge"),
-    name: z19.string().min(1, "Name must be a non-empty string").max(255, "Name must be less than 255 characters").regex(/^[a-zA-Z0-9_-]+$/, "Name must be a valid identifier")
+  const knowledgeDefinitionSchema = z20.object({
+    type: z20.literal("knowledge"),
+    name: z20.string().min(1, "Name must be a non-empty string").max(255, "Name must be less than 255 characters").regex(/^[a-zA-Z0-9_-]+$/, "Name must be a valid identifier")
   });
-  const triggerDefinitionSchema = z19.object({
-    type: z19.literal("trigger"),
-    name: z19.string().min(1, "Name must be a non-empty string").max(255, "Name must be less than 255 characters").regex(/^[a-zA-Z0-9_-]+$/, "Name must be a valid identifier")
+  const triggerDefinitionSchema = z20.object({
+    type: z20.literal("trigger"),
+    name: z20.string().min(1, "Name must be a non-empty string").max(255, "Name must be less than 255 characters").regex(/^[a-zA-Z0-9_-]+$/, "Name must be a valid identifier")
   });
-  const actionDefinitionSchema = z19.object({
-    type: z19.literal("action"),
-    name: z19.string().min(1, "Name must be a non-empty string").max(255, "Name must be less than 255 characters").regex(/^[a-zA-Z][a-zA-Z0-9]*$/, "Name must be alphanumeric with no special characters"),
-    title: z19.string().optional(),
-    description: z19.string().optional(),
-    attributes: z19.record(z19.string()).optional(),
-    input: z19.any().optional(),
+  const actionDefinitionSchema = z20.object({
+    type: z20.literal("action"),
+    name: z20.string().min(1, "Name must be a non-empty string").max(255, "Name must be less than 255 characters").regex(/^[a-zA-Z][a-zA-Z0-9]*$/, "Name must be alphanumeric with no special characters"),
+    title: z20.string().optional(),
+    description: z20.string().optional(),
+    attributes: z20.record(z20.string()).optional(),
+    input: z20.any().optional(),
     // JSONSchema7
-    output: z19.any().optional(),
+    output: z20.any().optional(),
     // JSONSchema7
-    cached: z19.boolean().optional()
+    cached: z20.boolean().optional()
   });
-  const tableDefinitionSchema = z19.object({
-    type: z19.literal("table"),
-    name: z19.string().min(1, "Name must be a non-empty string").max(255, "Name must be less than 255 characters").regex(/^[a-zA-Z0-9_-]+$/, "Name must be a valid identifier")
+  const tableDefinitionSchema = z20.object({
+    type: z20.literal("table"),
+    name: z20.string().min(1, "Name must be a non-empty string").max(255, "Name must be less than 255 characters").regex(/^[a-zA-Z0-9_-]+$/, "Name must be a valid identifier")
   });
   function isConversationDefinition(value) {
     return conversationDefinitionSchema.safeParse(value).success;
@@ -43457,7 +43719,7 @@ init_define_PACKAGE_VERSIONS();
 // src/primitives/data-sources/source-table.ts
 init_define_BUILD();
 init_define_PACKAGE_VERSIONS();
-import { z as z20 } from "@botpress/sdk";
+import { z as z21 } from "@botpress/sdk";
 var TableSource = class _TableSource extends DataSource {
   table;
   transformFn;
@@ -43478,7 +43740,7 @@ var TableSource = class _TableSource extends DataSource {
   get syncWorkflow() {
     return createSyncWorkflow({
       type: "table",
-      state: z20.object({ offset: z20.number().default(0) }),
+      state: z21.object({ offset: z21.number().default(0) }),
       handler: async () => {
         throw new Error("TableSource synchronization not implemented");
       }
@@ -43493,7 +43755,7 @@ var TableSource = class _TableSource extends DataSource {
 // src/primitives/data-sources/source-website.ts
 init_define_BUILD();
 init_define_PACKAGE_VERSIONS();
-import { z as z21 } from "@botpress/sdk";
+import { z as z22 } from "@botpress/sdk";
 
 // ../../node_modules/fast-xml-parser/src/fxp.js
 init_define_BUILD();
@@ -45046,16 +45308,16 @@ async function fetchHtml(url2, options) {
 }
 
 // src/primitives/data-sources/source-website.ts
-var State = z21.object({
-  urls: z21.array(
-    z21.object({
-      loc: z21.string(),
-      lastmod: z21.string().optional(),
-      changefreq: z21.string().optional(),
-      priority: z21.string().optional()
+var State = z22.object({
+  urls: z22.array(
+    z22.object({
+      loc: z22.string(),
+      lastmod: z22.string().optional(),
+      changefreq: z22.string().optional(),
+      priority: z22.string().optional()
     })
   ).default([]),
-  queue: z21.array(z21.object({ url: z21.string(), depth: z21.number() })).default([])
+  queue: z22.array(z22.object({ url: z22.string(), depth: z22.number() })).default([])
 });
 var WebsiteSource = class _WebsiteSource extends DataSource {
   mode;
@@ -45581,7 +45843,7 @@ var WebsiteSource = class _WebsiteSource extends DataSource {
 // src/primitives/data-sources/source-directory.ts
 init_define_BUILD();
 init_define_PACKAGE_VERSIONS();
-import { z as z22 } from "@botpress/sdk";
+import { z as z23 } from "@botpress/sdk";
 var DirectorySource = class _DirectorySource extends DataSource {
   _directoryPath;
   _filterFn;
@@ -45610,7 +45872,7 @@ var DirectorySource = class _DirectorySource extends DataSource {
   get syncWorkflow() {
     return createSyncWorkflow({
       type: "directory",
-      state: z22.object({}),
+      state: z23.object({}),
       handler: async ({ input, step: step2, client }) => {
         if (!adk.environment.isDevelopment()) {
           console.log("Directory ingestion is only supported in development environment");
@@ -45829,7 +46091,7 @@ var BaseKnowledge = class {
 // src/primitives/table.ts
 init_define_BUILD();
 init_define_PACKAGE_VERSIONS();
-import { transforms as transforms3, z as z23 } from "@bpinternal/zui";
+import { transforms as transforms3, z as z24 } from "@bpinternal/zui";
 var Typings6;
 ((Typings8) => {
   Typings8.Primitive = "table";
@@ -45847,7 +46109,7 @@ var BaseTable = class {
     return context.get("client");
   }
   constructor(props) {
-    const tableNameSchema = z23.string().min(1).refine((name) => !z23.string().uuid().safeParse(name).success, "Table name cannot be a UUID").refine(
+    const tableNameSchema = z24.string().min(1).refine((name) => !z24.string().uuid().safeParse(name).success, "Table name cannot be a UUID").refine(
       (name) => /^[a-zA-Z_$][a-zA-Z0-9_]{0,29}Table$/.test(name),
       "Table name must start with a letter/underscore, be 35 chars or less, contain only letters/numbers/underscores, and end with 'Table'"
     );
@@ -45861,7 +46123,7 @@ var BaseTable = class {
     }
     this.factor = props.factor ?? 1;
     this.columns = {};
-    let schema = z23.object({});
+    let schema = z24.object({});
     for (const [key, value] of Object.entries(props.columns)) {
       const val = value;
       if (val && typeof val === "object" && "schema" in val) {
@@ -46037,16 +46299,16 @@ var BaseTable = class {
 // src/primitives/trigger.ts
 init_define_BUILD();
 init_define_PACKAGE_VERSIONS();
-import { z as z24 } from "@botpress/sdk";
+import { z as z25 } from "@botpress/sdk";
 var Typings7;
 ((Typings8) => {
   Typings8.Primitive = "trigger";
 })(Typings7 || (Typings7 = {}));
-var TriggerSchema = z24.object({
-  name: z24.string().min(3, "Trigger name must be at least 3 characters").max(255, "Trigger name must be less than 255 characters").regex(/^[a-zA-Z0-9_]+$/, "Trigger name must contain only alphanumeric characters and underscores"),
-  description: z24.string().max(1024, "Description must be less than 1024 characters").optional(),
-  events: z24.array(z24.string()),
-  handler: z24.function().describe("Handler function for the trigger")
+var TriggerSchema = z25.object({
+  name: z25.string().min(3, "Trigger name must be at least 3 characters").max(255, "Trigger name must be less than 255 characters").regex(/^[a-zA-Z0-9_]+$/, "Trigger name must contain only alphanumeric characters and underscores"),
+  description: z25.string().max(1024, "Description must be less than 1024 characters").optional(),
+  events: z25.array(z25.string()),
+  handler: z25.function().describe("Handler function for the trigger")
 });
 var Trigger = class {
   name;
@@ -46135,7 +46397,7 @@ export {
   defineConfig,
   isWorkflowDataRequest,
   user,
-  z25 as z
+  z26 as z
 };
 /*! Bundled license information: