@laburen/openclaw-plugin-whatsapp-api 0.4.0 → 0.6.0

package/index.js

@@ -419,6 +419,48 @@ async function sendWhatsAppApiMedia(params) {
 		}
 	});
 }
+/**
+* Marks a message as read in the WhatsApp Cloud API.
+*
+* @param params.messageId - The WhatsApp message ID to mark as read
+* @param params.account - Resolved account for Graph auth
+* @returns Graph message id (usually just "unknown" or empty for read marks)
+*/
+async function sendWhatsAppApiReadMark(params) {
+	const { phoneNumberId, accessToken } = resolveGraphAuth(params.account);
+	return await sendWithRetry({
+		endpoint: `https://graph.facebook.com/${params.account.outboundApiVersion}/${phoneNumberId}/messages`,
+		account: params.account,
+		accessToken,
+		payload: {
+			messaging_product: "whatsapp",
+			status: "read",
+			message_id: params.messageId
+		}
+	});
+}
+/**
+* Shows/hides the typing indicator in the WhatsApp Cloud API.
+*
+* @param params.to - Recipient WhatsApp ID
+* @param params.typing - `true` for "typing_on", `false` for "typing_off"
+* @param params.account - Resolved account for Graph auth
+* @returns Graph message id
+*/
+async function sendWhatsAppApiTypingIndicator(params) {
+	const { phoneNumberId, accessToken } = resolveGraphAuth(params.account);
+	return await sendWithRetry({
+		endpoint: `https://graph.facebook.com/${params.account.outboundApiVersion}/${phoneNumberId}/messages`,
+		account: params.account,
+		accessToken,
+		payload: {
+			messaging_product: "whatsapp",
+			recipient_type: "individual",
+			to: normalizeRecipient(params.to),
+			sender_action: params.typing ? "typing_on" : "typing_off"
+		}
+	});
+}
 async function sendWhatsAppApiLocation(params) {
 	const { phoneNumberId, accessToken } = resolveGraphAuth(params.account);
 	return await sendWithRetry({
@@ -1084,7 +1126,7 @@ async function handleWhatsAppApiWebhook(params) {
 //#endregion
 //#region src/channel/plugin.ts
 const CHANNEL_ID = "whatsapp-api";
-const log$3 = waLogger("channel");
+const log$4 = waLogger("channel");
 const DEFAULT_ACCOUNT_ID = "default";
 /**
 * Resolves when `signal` aborts, or never if `signal` is undefined.
@@ -1153,7 +1195,7 @@ async function dispatchInboundToAgent(params) {
 	const mediaAttachment = await downloadInboundMediaAttachment({
 		account,
 		message,
-		log: { warn: (msg) => log$3.warn(msg) }
+		log: { warn: (msg) => log$4.warn(msg) }
 	});
 	const replyApi = rt.channel.reply;
 	const ctxPayload = replyApi.finalizeInboundContext({
@@ -1181,9 +1223,33 @@ async function dispatchInboundToAgent(params) {
 		OriginatingTo: to
 	});
 	const dispatchFn = replyApi.dispatchReplyWithBufferedBlockDispatcher;
+	sendWhatsAppApiReadMark({
+		messageId: message.messageId,
+		account
+	}).catch((err) => log$4.warn("failed to mark read", {
+		error: String(err),
+		messageId: message.messageId
+	}));
 	await dispatchFn({
 		ctx: ctxPayload,
 		cfg,
+		typing: {
+			start: async () => {
+				await sendWhatsAppApiTypingIndicator({
+					to: message.from,
+					typing: true,
+					account
+				});
+			},
+			stop: async () => {
+				await sendWhatsAppApiTypingIndicator({
+					to: message.from,
+					typing: false,
+					account
+				});
+			},
+			onStartError: (err) => log$4.warn("failed to start typing", { error: String(err) })
+		},
 		dispatcherOptions: {
 			deliver: async (payload) => {
 				const account = resolveAccount(cfg, accountId);
@@ -1193,17 +1259,17 @@ async function dispatchInboundToAgent(params) {
 					account
 				});
 				if (sent.length === 0) {
-					log$3.info("skipping outbound: reply payload empty", { messageId: message.messageId });
+					log$4.info("skipping outbound: reply payload empty", { messageId: message.messageId });
 					return;
 				}
-				log$3.info(`sent ${sent.length} outbound message(s)`, {
+				log$4.info(`sent ${sent.length} outbound message(s)`, {
 					to: message.from,
 					messageId: message.messageId
 				});
 				onOutbound?.();
 			},
 			onError: (err, info) => {
-				log$3.error(`${info?.kind ?? "reply"} dispatch failed`, {
+				log$4.error(`${info?.kind ?? "reply"} dispatch failed`, {
 					accountId,
 					messageId: message.messageId,
 					error: String(err)
@@ -1353,6 +1419,97 @@ function createWhatsAppApiChannel(api) {
 	};
 }
 //#endregion
+//#region src/hooks/llm-output/handlers/forward-usage.ts
+/**
+* SPDX-License-Identifier: MIT
+*
+* Forwards LLM token usage from the `llm_output` hook to a configured HTTP endpoint.
+*/
+const log$3 = waLogger("llm-output/forward-usage");
+/** Plugin extension config keys (see `openclaw.plugin.json`). */
+const LABUREN_WEB_APP_CONFIG_KEY = "LABUREN_WEB_APP_URL";
+const USER_PHONE_CONFIG_KEY = "userPhoneNumber";
+const USAGE_PATH = "/api/usage";
+const USAGE_FEATURE = "openclaw_run";
+const POST_TIMEOUT_MS = 3e3;
+function resolveUsageIngestUrl() {
+	let baseRaw;
+	try {
+		baseRaw = getPluginApi().pluginConfig?.[LABUREN_WEB_APP_CONFIG_KEY];
+	} catch {
+		return null;
+	}
+	if (typeof baseRaw !== "string") return null;
+	const base = baseRaw.trim().replace(/\/+$/, "");
+	if (!base) return null;
+	try {
+		return new URL(USAGE_PATH, base).href;
+	} catch {
+		log$3.warn(`usage-forwarder: invalid ${LABUREN_WEB_APP_CONFIG_KEY} base URL`);
+		return null;
+	}
+}
+function resolveUserPhoneNumber() {
+	let raw;
+	try {
+		raw = getPluginApi().pluginConfig?.[USER_PHONE_CONFIG_KEY];
+	} catch {
+		return null;
+	}
+	if (typeof raw !== "string") return null;
+	const phone = raw.trim();
+	return phone.length > 0 ? phone : null;
+}
+async function handleForwardLlmUsage(event, ctx) {
+	const usage = event.usage;
+	if (!usage) return;
+	const endpoint = resolveUsageIngestUrl();
+	if (!endpoint) return;
+	const userPhoneNumber = resolveUserPhoneNumber();
+	if (!userPhoneNumber) return;
+	const input = usage.input ?? 0;
+	const output = usage.output ?? 0;
+	const cacheRead = usage.cacheRead ?? 0;
+	const cacheWrite = usage.cacheWrite ?? 0;
+	const total = usage.total ?? input + output + cacheRead + cacheWrite;
+	const body = {
+		feature: USAGE_FEATURE,
+		runId: event.runId,
+		sessionId: event.sessionId,
+		userPhoneNumber,
+		sessionKey: ctx.sessionKey,
+		agentId: ctx.agentId,
+		provider: event.provider,
+		model: event.model,
+		usage: {
+			input,
+			output,
+			cacheRead,
+			cacheWrite,
+			total
+		},
+		capturedAt: (/* @__PURE__ */ new Date()).toISOString()
+	};
+	try {
+		const res = await fetch(endpoint, {
+			method: "POST",
+			headers: { "Content-Type": "application/json" },
+			body: JSON.stringify(body),
+			signal: AbortSignal.timeout(POST_TIMEOUT_MS)
+		});
+		if (!res.ok) log$3.warn(`usage-forwarder: HTTP ${res.status}`);
+	} catch (err) {
+		log$3.warn(`usage-forwarder: request failed (${String(err)})`);
+	}
+}
+//#endregion
+//#region src/hooks/llm-output/register.ts
+function registerLlmOutputHook(api) {
+	api.on("llm_output", async (event, ctx) => {
+		await handleForwardLlmUsage(event, ctx);
+	});
+}
+//#endregion
 //#region src/plugin/plugin-state-dir.ts
 /**
 * SPDX-License-Identifier: MIT
@@ -1444,6 +1601,7 @@ function registerMessageReceivedHook(api) {
 */
 function registerAllPluginHooks(api) {
 	registerMessageReceivedHook(api);
+	registerLlmOutputHook(api);
 }
 //#endregion
 //#region src/services/context-window-check/register.ts

package/openclaw.plugin.json

@@ -9,6 +9,14 @@
     "type": "object",
     "additionalProperties": false,
     "properties": {
+      "LABUREN_WEB_APP_URL": {
+        "type": "string",
+        "description": "Laburen web app base URL (no trailing slash). LLM usage is POSTed to {base}/api/usage."
+      },
+      "userPhoneNumber": {
+        "type": "string",
+        "description": "WhatsApp user phone (E.164 or your normalised form). Sent on each usage POST so the backend can resolve the user."
+      },
       "defaults": {
         "type": "object",
         "additionalProperties": false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@laburen/openclaw-plugin-whatsapp-api",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "type": "module",
   "description": "WhatsApp API channel plugin for OpenClaw",
   "main": "index.js",