@fluxyte/sdk 0.5.0 → 0.5.1

package/README.md

@@ -3,11 +3,12 @@
 The official TypeScript SDK for the Fluxyte Onboarding AI API: a context-aware,
 documentation-grounded assistant designed for onboarding and setup flows (not generic chat).
 
-## What's New In 0.4.0
+## What's New In 0.5.0
 
-- Voice chat API via `client.voiceChat(...)` for speech input.
-- Optional synthesized audio reply output.
-- React voice chat hook support for UI integration.
+- Structured resources are available on chat, streaming, and voice responses.
+- Supported resource kinds: `VIDEO`, `AUDIO`, `STORE`, `REDIRECT`, `REFERRAL`, and `CHECKOUT`.
+- Video and audio resources can include a safe `embedUrl` for inline rendering.
+- `useStreamingChat()` now exposes the completed response's `resources`.
 
 ## Install
 
@@ -138,6 +139,41 @@ console.log(res.answerId);
 console.log(res.reply);
 console.log(res.confidence);
 console.log(res.sources);
+console.log(res.resources);
+```
+
+### Rich Content Resources
+
+When approved knowledge or a flow step includes a related resource, the response
+can contain:
+
+```ts
+type ContentResource = {
+  id: string;
+  kind:
+    | "VIDEO"
+    | "AUDIO"
+    | "STORE"
+    | "REDIRECT"
+    | "REFERRAL"
+    | "CHECKOUT";
+  url: string;
+  label: string;
+  embedUrl?: string | null;
+};
+```
+
+Use `url` for links and actions. Use `embedUrl` only when it is present; it is
+the server-approved URL intended for an embedded video or audio player.
+
+```ts
+for (const resource of res.resources ?? []) {
+  if (resource.embedUrl) {
+    renderEmbeddedMedia(resource.embedUrl, resource.label);
+  } else {
+    renderResourceLink(resource.url, resource.label);
+  }
+}
 ```
 
 ## Chat Completions (Streaming via SSE)
@@ -152,7 +188,7 @@ Streaming lifecycle:
 
 1. `meta` (contains `answerId`)
 2. `delta` (partial text; one or more)
-3. `done` (confidence, sources)
+3. `done` (confidence, sources, resources)
 
 ```ts
 const stop = client.streamChat(
@@ -167,6 +203,7 @@ const stop = client.streamChat(
     if (event.type === "done") {
       console.log("\nConfidence:", event.confidence);
       console.log("Sources:", event.sources);
+      console.log("Resources:", event.resources);
     }
   },
   (err) => {
@@ -196,6 +233,7 @@ const voice = await client.voiceChat({
 console.log(voice.transcript); // text recognized from audio
 console.log(voice.reply); // AI text reply
 console.log(voice.replyAudioBase64); // optional synthesized voice
+console.log(voice.resources); // approved related links or embedded media
 ```
 
 ## Context
@@ -323,7 +361,15 @@ await send({
 ```tsx
 import { useStreamingChat } from "@fluxyte/sdk/react";
 
-const { text, answerId, confidence, streaming, start, stop } = useStreamingChat();
+const {
+  text,
+  answerId,
+  confidence,
+  resources,
+  streaming,
+  start,
+  stop,
+} = useStreamingChat();
 
 start({
   message: "What's the next step?",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluxyte/sdk",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Official Fluxyte SDK (TypeScript) for the Fluxyte Onboarding AI API",
   "license": "SEE LICENSE IN LICENSE.md",
   "type": "module",