@wavebirdai/api 0.1.0-beta.11 → 0.1.0-beta.12

package/README.md

@@ -9,7 +9,7 @@ You need a saved Wavebird Test project and placement in Dashboard, a Server Test
 1. Install the package and generate the route files for your app directory:
 
    ```sh
-   npm install @wavebirdai/api@0.1.0-beta.11
+   npm install @wavebirdai/api@0.1.0-beta.12
    ./node_modules/.bin/wavebird-next init --lang ts --root . --app-dir src/app
    ```
 

package/dist/browser.d.ts

@@ -1,5 +1,10 @@
 /** Resolve after the publisher has presented the result; After timing starts then. */
-export type GenerationConsumer<T> = (response: Response, lifecycle: { onDelta(): void }) => T | Promise<T>;
+export type GenerationConsumer<T> = (response: Response, lifecycle: {
+  /** Streaming output progress. For Before and During Image, call after the first result is presented. */
+  onDelta(): void;
+  /** Explicitly mark the result as presented. Idempotent and bound to this generation. */
+  onPresented(): void;
+}) => T | Promise<T>;
 export type PublisherAds<Bound extends boolean = boolean> = {
   ready: Promise<void>;
   connectGeneration<T>(options: { request: (headers: Record<string, string>) => Response | Promise<Response>; consume: GenerationConsumer<T>; signal?: AbortSignal }): Promise<T>;

package/dist/browser.js

@@ -75,6 +75,10 @@ export function createPublisherAds(options) {
       sponsor = null; slot.hidden = true; slot.replaceChildren();
     }
   };
+  const notifyPresented = id => {
+    // Additive bridge: an already deployed renderer may predate this event.
+    if (typeof sponsor?.onPresented === "function") notify("onPresented", id);
+  };
   const current = job => !disposed && !job.cancelled && job.context === context && active === job;
   const event = (job, type) => {
     if (!current(job)) return;
@@ -84,9 +88,15 @@ export function createPublisherAds(options) {
     } else if (type === "progress") {
       if (job.state === "started") { job.progressed = true; notify("onDelta", job.id); }
     } else if (type === "no_result") {
-      if (job.state === "started") job.state = "no_result";
-    } else if (["done", "error", "abort"].includes(type)) {
       if (job.state !== "started") return;
+      job.state = "no_result";
+      if (timing !== "after") notify("onError", job.id);
+    } else if (type === "presented") {
+      if (!["started", "done"].includes(job.state) || job.presented) return;
+      job.presented = true; notifyPresented(job.id);
+    } else if (["done", "error", "abort"].includes(type)) {
+      if (job.state !== "started" &&
+          !(job.state === "done" && !job.consumed && ["error", "abort"].includes(type))) return;
       job.state = type;
       notify(type === "done" ? "onDone" : type === "abort" ? "onAbort" : "onError", job.id);
     }
@@ -118,7 +128,7 @@ export function createPublisherAds(options) {
   const ready = loadRenderer(rendererUrl).then(() => {
     if (disposed) return;
     sponsor = window.wavebird.createChatSponsor({ target: slot, ...binding,
-      clientId: options.clientId, surfaceId: options.surfaceId, timing, consentMode,
+      clientId: options.clientId, surfaceId: options.surfaceId, jobType: options.jobType, timing, consentMode,
       cleanupAfterClip: true,
       ...(turnBinding ? { turnBinding: true } : {}),
       ...(options.getFormat === undefined ? {} : { getFormat: options.getFormat }),
@@ -136,7 +146,8 @@ export function createPublisherAds(options) {
   }).catch(() => {});
 
   async function connectGeneration({ request, consume, signal }) {
-    const job = { id: crypto.randomUUID(), sessionId: binding.sessionId, context, state: "pending", cancelled: false };
+    const job = { id: crypto.randomUUID(), sessionId: binding.sessionId, context, state: "pending", cancelled: false,
+      presented: false, consumed: false };
     if (active) event(active, "abort");
     active = job;
     let reader = null, ended = false, buffer = "";
@@ -195,7 +206,8 @@ export function createPublisherAds(options) {
               }
               if (["done", "error", "abort"].includes(record.type)) {
                 ended = true;
-                if (record.type !== "done" || timing !== "after") event(job, record.type);
+                if (record.type === "done" && [204, 205, 304].includes(metadata.status)) event(job, "no_result");
+                else if (record.type !== "done" || timing !== "after") event(job, record.type);
                 if (record.type === "done" || !metadata.status.toString().startsWith("2")) controller.close();
                 else controller.error(new Error("generation_" + record.type));
                 return;
@@ -210,14 +222,20 @@ export function createPublisherAds(options) {
         const record = await nextRecord();
         if (!["done", "error", "abort"].includes(record.type)) throw new Error("generation_transport_invalid");
         ended = true;
-        if (record.type !== "done" || timing !== "after") event(job, record.type);
+        if (record.type === "done") event(job, "no_result");
+        else event(job, record.type);
       }
       const noBody = [204, 205, 304].includes(metadata.status);
       const primary = new Response(noBody ? null : output, {
         status: metadata.status, statusText: metadata.status_text || "", headers: metadata.headers
       });
-      const result = await consume(primary, { onDelta: () => event(job, "progress") });
-      if (timing === "after" && ended) event(job, noBody ? "no_result" : "done");
+      const result = await consume(primary, { onDelta: () => {
+        event(job, "progress");
+        if (timing === "before" || (timing === "during" && options.jobType === "image")) event(job, "presented");
+      }, onPresented: () => event(job, "presented") });
+      job.consumed = true;
+      if (timing === "before" || (timing === "during" && options.jobType === "image")) event(job, "presented");
+      if (timing === "after" && ended && !noBody) event(job, "done");
       return result;
     } catch (error) {
       event(job, signal?.aborted ? "abort" : "error");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wavebirdai/api",
-  "version": "0.1.0-beta.11",
+  "version": "0.1.0-beta.12",
   "private": false,
   "type": "module",
   "description": "Integrate Banner, Native, and Clip placements into authenticated chat apps with server-side keys, consent, and generation lifecycle handling",

package/src/browser.d.ts

@@ -1,5 +1,10 @@
 /** Resolve after the publisher has presented the result; After timing starts then. */
-export type GenerationConsumer<T> = (response: Response, lifecycle: { onDelta(): void }) => T | Promise<T>;
+export type GenerationConsumer<T> = (response: Response, lifecycle: {
+  /** Streaming output progress. For Before and During Image, call after the first result is presented. */
+  onDelta(): void;
+  /** Explicitly mark the result as presented. Idempotent and bound to this generation. */
+  onPresented(): void;
+}) => T | Promise<T>;
 export type PublisherAds<Bound extends boolean = boolean> = {
   ready: Promise<void>;
   connectGeneration<T>(options: { request: (headers: Record<string, string>) => Response | Promise<Response>; consume: GenerationConsumer<T>; signal?: AbortSignal }): Promise<T>;

package/src/browser.js

@@ -75,6 +75,10 @@ export function createPublisherAds(options) {
       sponsor = null; slot.hidden = true; slot.replaceChildren();
     }
   };
+  const notifyPresented = id => {
+    // Additive bridge: an already deployed renderer may predate this event.
+    if (typeof sponsor?.onPresented === "function") notify("onPresented", id);
+  };
   const current = job => !disposed && !job.cancelled && job.context === context && active === job;
   const event = (job, type) => {
     if (!current(job)) return;
@@ -84,9 +88,15 @@ export function createPublisherAds(options) {
     } else if (type === "progress") {
       if (job.state === "started") { job.progressed = true; notify("onDelta", job.id); }
     } else if (type === "no_result") {
-      if (job.state === "started") job.state = "no_result";
-    } else if (["done", "error", "abort"].includes(type)) {
       if (job.state !== "started") return;
+      job.state = "no_result";
+      if (timing !== "after") notify("onError", job.id);
+    } else if (type === "presented") {
+      if (!["started", "done"].includes(job.state) || job.presented) return;
+      job.presented = true; notifyPresented(job.id);
+    } else if (["done", "error", "abort"].includes(type)) {
+      if (job.state !== "started" &&
+          !(job.state === "done" && !job.consumed && ["error", "abort"].includes(type))) return;
       job.state = type;
       notify(type === "done" ? "onDone" : type === "abort" ? "onAbort" : "onError", job.id);
     }
@@ -118,7 +128,7 @@ export function createPublisherAds(options) {
   const ready = loadRenderer(rendererUrl).then(() => {
     if (disposed) return;
     sponsor = window.wavebird.createChatSponsor({ target: slot, ...binding,
-      clientId: options.clientId, surfaceId: options.surfaceId, timing, consentMode,
+      clientId: options.clientId, surfaceId: options.surfaceId, jobType: options.jobType, timing, consentMode,
       cleanupAfterClip: true,
       ...(turnBinding ? { turnBinding: true } : {}),
       ...(options.getFormat === undefined ? {} : { getFormat: options.getFormat }),
@@ -136,7 +146,8 @@ export function createPublisherAds(options) {
   }).catch(() => {});
 
   async function connectGeneration({ request, consume, signal }) {
-    const job = { id: crypto.randomUUID(), sessionId: binding.sessionId, context, state: "pending", cancelled: false };
+    const job = { id: crypto.randomUUID(), sessionId: binding.sessionId, context, state: "pending", cancelled: false,
+      presented: false, consumed: false };
     if (active) event(active, "abort");
     active = job;
     let reader = null, ended = false, buffer = "";
@@ -195,7 +206,8 @@ export function createPublisherAds(options) {
               }
               if (["done", "error", "abort"].includes(record.type)) {
                 ended = true;
-                if (record.type !== "done" || timing !== "after") event(job, record.type);
+                if (record.type === "done" && [204, 205, 304].includes(metadata.status)) event(job, "no_result");
+                else if (record.type !== "done" || timing !== "after") event(job, record.type);
                 if (record.type === "done" || !metadata.status.toString().startsWith("2")) controller.close();
                 else controller.error(new Error("generation_" + record.type));
                 return;
@@ -210,14 +222,20 @@ export function createPublisherAds(options) {
         const record = await nextRecord();
         if (!["done", "error", "abort"].includes(record.type)) throw new Error("generation_transport_invalid");
         ended = true;
-        if (record.type !== "done" || timing !== "after") event(job, record.type);
+        if (record.type === "done") event(job, "no_result");
+        else event(job, record.type);
       }
       const noBody = [204, 205, 304].includes(metadata.status);
       const primary = new Response(noBody ? null : output, {
         status: metadata.status, statusText: metadata.status_text || "", headers: metadata.headers
       });
-      const result = await consume(primary, { onDelta: () => event(job, "progress") });
-      if (timing === "after" && ended) event(job, noBody ? "no_result" : "done");
+      const result = await consume(primary, { onDelta: () => {
+        event(job, "progress");
+        if (timing === "before" || (timing === "during" && options.jobType === "image")) event(job, "presented");
+      }, onPresented: () => event(job, "presented") });
+      job.consumed = true;
+      if (timing === "before" || (timing === "during" && options.jobType === "image")) event(job, "presented");
+      if (timing === "after" && ended && !noBody) event(job, "done");
       return result;
     } catch (error) {
       event(job, signal?.aborted ? "abort" : "error");