@mercury-fw/channel-google-chat 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @mercury-fw/channel-google-chat
 
+## 0.7.0
+
+### Minor Changes
+
+- 4184ea6: - `loginLinkText` words a login link the same way on every channel, and the contract states that a login link is shown only to the person it's for.
+  - Google Chat shows the login to a service a plugin acts on as the person (Jira, Bitbucket) as a button that opens it, visible only to them: in a shared space it's a private message to whoever asked.
+  - `@mercury-fw/channel-google-chat` needs `@mercury-fw/channel-types` 0.46.0 or later.
+
 ## 0.6.0
 
 ### Minor Changes

package/README.md

@@ -26,6 +26,8 @@ channels: [googleChatChannel],
 
 Each message reaches the core as `google-chat:users/<id>`, the sender's Chat user, with their email when Google vouches for it (a person's, never a bot's), which a user directory can join on: the ZITADEL directory of `@mercury-fw/plugin-zitadel` does.
 
+When a plugin that acts as the person (Jira, Bitbucket) needs them to log in, the channel sends a card with a button that opens the service's login, visible only to that person: in a direct message the space is already theirs, in a shared space the card is a private message to whoever asked, since anyone else opening it would log their own account in as them. The service sends the browser back to the HTTP channel's `/login/callback`, so the app needs [`@mercury-fw/channel-http`](https://www.npmjs.com/package/@mercury-fw/channel-http) with `HTTP_SURFACE_PUBLIC_URL` too; without it Mercury answers that nobody can log in on this instance.
+
 ## Table of contents
 
 - [Setting up the Chat app](#setting-up-the-chat-app)

package/dist/google-chat-app-client.d.ts

@@ -55,10 +55,16 @@ export type ChatCard = {
     };
     sections: ChatCardSection[];
 };
-/** Posts `card` as a Cards v2 message to `space`. Returns the created message's `name`, same shape as `sendMessage`. */
+/**
+ * Posts `card` as a Cards v2 message to `space`. Returns the created message's
+ * `name`, same shape as `sendMessage`. With `privateViewer` (`users/<id>`) only
+ * that user and the app see it, in a space anyone else is in too.
+ */
 export declare function sendCard(space: string, card: ChatCard, deps: {
     tokenSource: TokenSource;
     fetchFn?: FetchFn;
+}, options?: {
+    privateViewer?: string;
 }): Promise<{
     name: string;
 }>;

package/google-chat-app-client.ts

@@ -171,17 +171,22 @@ export type ChatCardSection = {
 };
 export type ChatCard = { header?: { title: string }; sections: ChatCardSection[] };
 
-/** Posts `card` as a Cards v2 message to `space`. Returns the created message's `name`, same shape as `sendMessage`. */
+/**
+ * Posts `card` as a Cards v2 message to `space`. Returns the created message's
+ * `name`, same shape as `sendMessage`. With `privateViewer` (`users/<id>`) only
+ * that user and the app see it, in a space anyone else is in too.
+ */
 export async function sendCard(
   space: string,
   card: ChatCard,
   deps: { tokenSource: TokenSource; fetchFn?: FetchFn },
+  options: { privateViewer?: string } = {},
 ): Promise<{ name: string }> {
-  const data = (await callChatApi(
-    `${space}/messages`,
-    { method: "POST", body: { cardsV2: [{ cardId: "card", card }] } },
-    deps,
-  )) as { name: string };
+  const body = {
+    cardsV2: [{ cardId: "card", card }],
+    ...(options.privateViewer === undefined ? {} : { privateMessageViewer: { name: options.privateViewer } }),
+  };
+  const data = (await callChatApi(`${space}/messages`, { method: "POST", body }, deps)) as { name: string };
   return { name: data.name };
 }
 

package/google-chat-provider.ts

@@ -32,9 +32,12 @@ import {
 import { openSubscription, type PubSubSubscription, type StreamMessage } from "./google-chat-pubsub-stream.ts";
 import { splitForSendLimit } from "./google-chat-message-buffer.ts";
 import {
+  detectLoginRequired,
   detectPendingConfirmation,
+  loginLinkText,
   PENDING_CONFIRMATION_NOTE,
   NO_REPLY,
+  type LoginRequest,
   type PendingConfirmation,
   type ToolOutcome,
   type Provider,
@@ -73,6 +76,13 @@ function buildConfirmCard(pending: PendingConfirmation): ChatCard {
   };
 }
 
+/** The card that shows a person the link to log in to a service a plugin acts on as them: one button that opens it. */
+function buildLoginCard(login: LoginRequest): ChatCard {
+  return {
+    sections: [{ widgets: [{ buttonList: { buttons: [{ text: loginLinkText(login), onClick: { openLink: { url: login.url } } }] } }] }],
+  };
+}
+
 const TOOL_STATUS_LINES: Record<"loading" | ToolOutcome, string> = {
   loading: "In corso…",
   success: "Fatto.",
@@ -338,8 +348,12 @@ export function createGoogleChatProvider(deps: GoogleChatProviderDeps): GoogleCh
     });
   let activeSubscription: PubSubSubscription | undefined;
 
-  /** Per-turn output sink — same responsibilities as the retired `ChatStreamer`, rebuilt against the new client. */
-  function createSink(space: string): TurnSink {
+  /**
+   * Per-turn output sink — same responsibilities as the retired `ChatStreamer`,
+   * rebuilt against the new client. `viewer` is the person the turn is for;
+   * outside a direct message, what only they may see is sent to them alone.
+   */
+  function createSink(space: string, viewer: { user: string; isDirectMessage: boolean }): TurnSink {
     let chain: Promise<void> = Promise.resolve();
 
     function enqueue(fn: () => Promise<void>): void {
@@ -376,6 +390,9 @@ export function createGoogleChatProvider(deps: GoogleChatProviderDeps): GoogleCh
     // the same turn (e.g. after a tool call) always gets its own new card,
     // never reuses this one.
     let receivingCardName: string | undefined;
+
+    // A tool asking again in the same turn hands back the same pending login.
+    const shownLogins = new Set<string>();
     enqueue(async () => {
       log(`[chat:${space}] [out] receiving card`);
       const sent = await sendCardFn(space, buildReceivingCard(), clientDeps);
@@ -470,6 +487,16 @@ export function createGoogleChatProvider(deps: GoogleChatProviderDeps): GoogleCh
             sentMessageNames.add(sent.name);
           });
         }
+        const login = detectLoginRequired(step);
+        if (login && !shownLogins.has(login.url)) {
+          shownLogins.add(login.url);
+          enqueue(async () => {
+            log(`[chat:${space}] [out] login card: ${login.service}`);
+            const options = viewer.isDirectMessage ? undefined : { privateViewer: viewer.user };
+            const sent = await sendCardFn(space, buildLoginCard(login), clientDeps, options);
+            sentMessageNames.add(sent.name);
+          });
+        }
       },
       finalize: async (finalText: string) => {
         const trimmed = finalText.trim();
@@ -520,7 +547,7 @@ export function createGoogleChatProvider(deps: GoogleChatProviderDeps): GoogleCh
 
     busySessions.add(sessionKey);
     try {
-      const sink = createSink(event.space);
+      const sink = createSink(event.space, { user: event.sender, isDirectMessage: event.isDirectMessage });
       await handleTurn(
         {
           channel: "google-chat",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mercury-fw/channel-google-chat",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -31,10 +31,10 @@
     "@google-cloud/pubsub": "^5.3.1"
   },
   "peerDependencies": {
-    "@mercury-fw/channel-types": ">=0.36.0 <1.0.0"
+    "@mercury-fw/channel-types": ">=0.46.0 <1.0.0"
   },
   "devDependencies": {
-    "@mercury-fw/channel-types": "0.44.1",
+    "@mercury-fw/channel-types": "0.46.0",
     "@mercury-fw/typescript-config": "*",
     "@types/bun": "^1.4.2",
     "typescript": "^6.0.3"