@airnauts/comments-notifier-slack 0.1.0 → 0.5.0

package/dist/index.d.ts

@@ -2,12 +2,22 @@ import type { NotificationEvent, Notifier } from '@airnauts/comments-server';
 export type SlackNotifierOptions = {
     /** Slack Incoming Webhook URL. The target channel is baked into this URL. */
     webhookUrl: string;
+    /**
+     * Query param the widget reads to focus a thread on load (the client's
+     * `threadParam`). Must match the host page's config so the deep-link opens
+     * the right thread. Defaults to `comments-thread`.
+     */
+    threadParam?: string;
 };
 export declare function slackNotifier(opts: SlackNotifierOptions): Notifier;
 export type SlackMessage = {
     text: string;
     blocks: unknown[];
 };
+export type FormatOptions = {
+    /** Override the deep-link query param (defaults to `comments-thread`). */
+    threadParam?: string;
+};
 /** Render a NotificationEvent as a Slack Block Kit message (with a plain-text fallback). */
-export declare function formatSlackMessage(event: NotificationEvent): SlackMessage;
+export declare function formatSlackMessage(event: NotificationEvent, opts?: FormatOptions): SlackMessage;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AAE5E,MAAM,MAAM,oBAAoB,GAAG;IACjC,6EAA6E;IAC7E,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAKD,wBAAgB,aAAa,CAAC,IAAI,EAAE,oBAAoB,GAAG,QAAQ,CAgBlE;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,EAAE,CAAA;CAClB,CAAA;AAED,4FAA4F;AAC5F,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,iBAAiB,GAAG,YAAY,CAgCzE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AAE5E,MAAM,MAAM,oBAAoB,GAAG;IACjC,6EAA6E;IAC7E,UAAU,EAAE,MAAM,CAAA;IAClB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAQD,wBAAgB,aAAa,CAAC,IAAI,EAAE,oBAAoB,GAAG,QAAQ,CAgBlE;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,EAAE,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,0EAA0E;IAC1E,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAaD,4FAA4F;AAC5F,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,iBAAiB,EACxB,IAAI,GAAE,aAAkB,GACvB,YAAY,CAiCd"}

package/dist/index.js

@@ -1,4 +1,5 @@
 // src/index.ts
+var DEFAULT_THREAD_PARAM = "comments-thread";
 var TIMEOUT_MS = 3e3;
 function slackNotifier(opts) {
   return {
@@ -7,7 +8,7 @@ function slackNotifier(opts) {
       const res = await fetch(opts.webhookUrl, {
         method: "POST",
         headers: { "content-type": "application/json" },
-        body: JSON.stringify(formatSlackMessage(event)),
+        body: JSON.stringify(formatSlackMessage(event, { threadParam: opts.threadParam })),
         signal: AbortSignal.timeout(TIMEOUT_MS)
       });
       if (!res.ok) {
@@ -16,9 +17,15 @@ function slackNotifier(opts) {
     }
   };
 }
-function formatSlackMessage(event) {
+function threadLink(event, param) {
+  const url = new URL(event.pageUrl);
+  url.searchParams.set(param, event.threadId);
+  return url.toString();
+}
+function formatSlackMessage(event, opts = {}) {
   const heading = event.type === "comment.added" ? "New reply" : "New comment";
   const where = event.pageTitle ?? event.pageUrl;
+  const link = threadLink(event, opts.threadParam ?? DEFAULT_THREAD_PARAM);
   const who = event.author.name ? `${event.author.name} (${event.author.email})` : event.author.email;
   const body = event.text.trim() === "" ? "(image comment)" : event.text;
   const quoted = body.replace(/\n/g, "\n>");
@@ -30,7 +37,7 @@ function formatSlackMessage(event) {
         type: "section",
         text: {
           type: "mrkdwn",
-          text: `:speech_balloon: *${heading}* \xB7 <${event.pageUrl}|${where}>`
+          text: `:speech_balloon: *${heading}* \xB7 <${link}|${where}>`
         }
       },
       {
@@ -39,7 +46,7 @@ function formatSlackMessage(event) {
       },
       {
         type: "context",
-        elements: [{ type: "mrkdwn", text: `${who} \xB7 <${event.pageUrl}|Open page>` }]
+        elements: [{ type: "mrkdwn", text: `${who} \xB7 <${link}|Open thread>` }]
       }
     ]
   };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { NotificationEvent, Notifier } from '@airnauts/comments-server'\n\nexport type SlackNotifierOptions = {\n  /** Slack Incoming Webhook URL. The target channel is baked into this URL. */\n  webhookUrl: string\n}\n\n/** Abort the webhook request after this many ms so a hung endpoint can't stall a write. */\nconst TIMEOUT_MS = 3000\n\nexport function slackNotifier(opts: SlackNotifierOptions): Notifier {\n  return {\n    name: 'slack',\n    async notify(event: NotificationEvent): Promise<void> {\n      const res = await fetch(opts.webhookUrl, {\n        method: 'POST',\n        headers: { 'content-type': 'application/json' },\n        body: JSON.stringify(formatSlackMessage(event)),\n        signal: AbortSignal.timeout(TIMEOUT_MS),\n      })\n      if (!res.ok) {\n        // Never include the webhook URL — it is a credential that ends up in logs.\n        throw new Error(`slack webhook responded ${res.status}`)\n      }\n    },\n  }\n}\n\nexport type SlackMessage = {\n  text: string\n  blocks: unknown[]\n}\n\n/** Render a NotificationEvent as a Slack Block Kit message (with a plain-text fallback). */\nexport function formatSlackMessage(event: NotificationEvent): SlackMessage {\n  const heading = event.type === 'comment.added' ? 'New reply' : 'New comment'\n  const where = event.pageTitle ?? event.pageUrl\n  const who = event.author.name\n    ? `${event.author.name} (${event.author.email})`\n    : event.author.email\n  // Image-only comments are allowed (empty text + an attachment), so fall back to\n  // a label rather than rendering an empty quote / dangling \"by … :\".\n  const body = event.text.trim() === '' ? '(image comment)' : event.text\n  const quoted = body.replace(/\\n/g, '\\n>')\n\n  return {\n    // Plain-text fallback for notifications / accessibility.\n    text: `${heading} by ${who}: ${body}`,\n    blocks: [\n      {\n        type: 'section',\n        text: {\n          type: 'mrkdwn',\n          text: `:speech_balloon: *${heading}* · <${event.pageUrl}|${where}>`,\n        },\n      },\n      {\n        type: 'section',\n        text: { type: 'mrkdwn', text: `>${quoted}` },\n      },\n      {\n        type: 'context',\n        elements: [{ type: 'mrkdwn', text: `${who} · <${event.pageUrl}|Open page>` }],\n      },\n    ],\n  }\n}\n"],"mappings":";AAQA,IAAM,aAAa;AAEZ,SAAS,cAAc,MAAsC;AAClE,SAAO;AAAA,IACL,MAAM;AAAA,IACN,MAAM,OAAO,OAAyC;AACpD,YAAM,MAAM,MAAM,MAAM,KAAK,YAAY;AAAA,QACvC,QAAQ;AAAA,QACR,SAAS,EAAE,gBAAgB,mBAAmB;AAAA,QAC9C,MAAM,KAAK,UAAU,mBAAmB,KAAK,CAAC;AAAA,QAC9C,QAAQ,YAAY,QAAQ,UAAU;AAAA,MACxC,CAAC;AACD,UAAI,CAAC,IAAI,IAAI;AAEX,cAAM,IAAI,MAAM,2BAA2B,IAAI,MAAM,EAAE;AAAA,MACzD;AAAA,IACF;AAAA,EACF;AACF;AAQO,SAAS,mBAAmB,OAAwC;AACzE,QAAM,UAAU,MAAM,SAAS,kBAAkB,cAAc;AAC/D,QAAM,QAAQ,MAAM,aAAa,MAAM;AACvC,QAAM,MAAM,MAAM,OAAO,OACrB,GAAG,MAAM,OAAO,IAAI,KAAK,MAAM,OAAO,KAAK,MAC3C,MAAM,OAAO;AAGjB,QAAM,OAAO,MAAM,KAAK,KAAK,MAAM,KAAK,oBAAoB,MAAM;AAClE,QAAM,SAAS,KAAK,QAAQ,OAAO,KAAK;AAExC,SAAO;AAAA;AAAA,IAEL,MAAM,GAAG,OAAO,OAAO,GAAG,KAAK,IAAI;AAAA,IACnC,QAAQ;AAAA,MACN;AAAA,QACE,MAAM;AAAA,QACN,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,MAAM,qBAAqB,OAAO,WAAQ,MAAM,OAAO,IAAI,KAAK;AAAA,QAClE;AAAA,MACF;AAAA,MACA;AAAA,QACE,MAAM;AAAA,QACN,MAAM,EAAE,MAAM,UAAU,MAAM,IAAI,MAAM,GAAG;AAAA,MAC7C;AAAA,MACA;AAAA,QACE,MAAM;AAAA,QACN,UAAU,CAAC,EAAE,MAAM,UAAU,MAAM,GAAG,GAAG,UAAO,MAAM,OAAO,cAAc,CAAC;AAAA,MAC9E;AAAA,IACF;AAAA,EACF;AACF;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { NotificationEvent, Notifier } from '@airnauts/comments-server'\n\nexport type SlackNotifierOptions = {\n  /** Slack Incoming Webhook URL. The target channel is baked into this URL. */\n  webhookUrl: string\n  /**\n   * Query param the widget reads to focus a thread on load (the client's\n   * `threadParam`). Must match the host page's config so the deep-link opens\n   * the right thread. Defaults to `comments-thread`.\n   */\n  threadParam?: string\n}\n\n/** Default deep-link param — mirrors the client's `DEFAULT_THREAD_PARAM`. */\nconst DEFAULT_THREAD_PARAM = 'comments-thread'\n\n/** Abort the webhook request after this many ms so a hung endpoint can't stall a write. */\nconst TIMEOUT_MS = 3000\n\nexport function slackNotifier(opts: SlackNotifierOptions): Notifier {\n  return {\n    name: 'slack',\n    async notify(event: NotificationEvent): Promise<void> {\n      const res = await fetch(opts.webhookUrl, {\n        method: 'POST',\n        headers: { 'content-type': 'application/json' },\n        body: JSON.stringify(formatSlackMessage(event, { threadParam: opts.threadParam })),\n        signal: AbortSignal.timeout(TIMEOUT_MS),\n      })\n      if (!res.ok) {\n        // Never include the webhook URL — it is a credential that ends up in logs.\n        throw new Error(`slack webhook responded ${res.status}`)\n      }\n    },\n  }\n}\n\nexport type SlackMessage = {\n  text: string\n  blocks: unknown[]\n}\n\nexport type FormatOptions = {\n  /** Override the deep-link query param (defaults to `comments-thread`). */\n  threadParam?: string\n}\n\n/**\n * Build the thread deep-link Slack should point at — the same URL the widget's\n * \"Copy link\" action produces (`pageUrl?comments-thread=<id>`), so the reader\n * lands on the focused thread rather than the bare page.\n */\nfunction threadLink(event: NotificationEvent, param: string): string {\n  const url = new URL(event.pageUrl)\n  url.searchParams.set(param, event.threadId)\n  return url.toString()\n}\n\n/** Render a NotificationEvent as a Slack Block Kit message (with a plain-text fallback). */\nexport function formatSlackMessage(\n  event: NotificationEvent,\n  opts: FormatOptions = {},\n): SlackMessage {\n  const heading = event.type === 'comment.added' ? 'New reply' : 'New comment'\n  const where = event.pageTitle ?? event.pageUrl\n  const link = threadLink(event, opts.threadParam ?? DEFAULT_THREAD_PARAM)\n  const who = event.author.name\n    ? `${event.author.name} (${event.author.email})`\n    : event.author.email\n  // Image-only comments are allowed (empty text + an attachment), so fall back to\n  // a label rather than rendering an empty quote / dangling \"by … :\".\n  const body = event.text.trim() === '' ? '(image comment)' : event.text\n  const quoted = body.replace(/\\n/g, '\\n>')\n\n  return {\n    // Plain-text fallback for notifications / accessibility.\n    text: `${heading} by ${who}: ${body}`,\n    blocks: [\n      {\n        type: 'section',\n        text: {\n          type: 'mrkdwn',\n          text: `:speech_balloon: *${heading}* · <${link}|${where}>`,\n        },\n      },\n      {\n        type: 'section',\n        text: { type: 'mrkdwn', text: `>${quoted}` },\n      },\n      {\n        type: 'context',\n        elements: [{ type: 'mrkdwn', text: `${who} · <${link}|Open thread>` }],\n      },\n    ],\n  }\n}\n"],"mappings":";AAcA,IAAM,uBAAuB;AAG7B,IAAM,aAAa;AAEZ,SAAS,cAAc,MAAsC;AAClE,SAAO;AAAA,IACL,MAAM;AAAA,IACN,MAAM,OAAO,OAAyC;AACpD,YAAM,MAAM,MAAM,MAAM,KAAK,YAAY;AAAA,QACvC,QAAQ;AAAA,QACR,SAAS,EAAE,gBAAgB,mBAAmB;AAAA,QAC9C,MAAM,KAAK,UAAU,mBAAmB,OAAO,EAAE,aAAa,KAAK,YAAY,CAAC,CAAC;AAAA,QACjF,QAAQ,YAAY,QAAQ,UAAU;AAAA,MACxC,CAAC;AACD,UAAI,CAAC,IAAI,IAAI;AAEX,cAAM,IAAI,MAAM,2BAA2B,IAAI,MAAM,EAAE;AAAA,MACzD;AAAA,IACF;AAAA,EACF;AACF;AAiBA,SAAS,WAAW,OAA0B,OAAuB;AACnE,QAAM,MAAM,IAAI,IAAI,MAAM,OAAO;AACjC,MAAI,aAAa,IAAI,OAAO,MAAM,QAAQ;AAC1C,SAAO,IAAI,SAAS;AACtB;AAGO,SAAS,mBACd,OACA,OAAsB,CAAC,GACT;AACd,QAAM,UAAU,MAAM,SAAS,kBAAkB,cAAc;AAC/D,QAAM,QAAQ,MAAM,aAAa,MAAM;AACvC,QAAM,OAAO,WAAW,OAAO,KAAK,eAAe,oBAAoB;AACvE,QAAM,MAAM,MAAM,OAAO,OACrB,GAAG,MAAM,OAAO,IAAI,KAAK,MAAM,OAAO,KAAK,MAC3C,MAAM,OAAO;AAGjB,QAAM,OAAO,MAAM,KAAK,KAAK,MAAM,KAAK,oBAAoB,MAAM;AAClE,QAAM,SAAS,KAAK,QAAQ,OAAO,KAAK;AAExC,SAAO;AAAA;AAAA,IAEL,MAAM,GAAG,OAAO,OAAO,GAAG,KAAK,IAAI;AAAA,IACnC,QAAQ;AAAA,MACN;AAAA,QACE,MAAM;AAAA,QACN,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,MAAM,qBAAqB,OAAO,WAAQ,IAAI,IAAI,KAAK;AAAA,QACzD;AAAA,MACF;AAAA,MACA;AAAA,QACE,MAAM;AAAA,QACN,MAAM,EAAE,MAAM,UAAU,MAAM,IAAI,MAAM,GAAG;AAAA,MAC7C;AAAA,MACA;AAAA,QACE,MAAM;AAAA,QACN,UAAU,CAAC,EAAE,MAAM,UAAU,MAAM,GAAG,GAAG,UAAO,IAAI,gBAAgB,CAAC;AAAA,MACvE;AAAA,IACF;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@airnauts/comments-notifier-slack",
-  "version": "0.1.0",
+  "version": "0.5.0",
   "description": "Slack Incoming Webhook notifier for the Airnauts commenting tool server.",
   "keywords": [
     "comments",
@@ -38,16 +38,16 @@
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "@airnauts/comments-core": "^0.5.0",
+    "@airnauts/comments-server": "^0.5.0"
+  },
+  "devDependencies": {
+    "@airnauts/comments-test-support": "0.0.0"
+  },
   "scripts": {
     "build": "tsup && tsc --build --force",
     "typecheck": "tsc --build",
     "test": "vitest run"
-  },
-  "dependencies": {
-    "@airnauts/comments-core": "workspace:^",
-    "@airnauts/comments-server": "workspace:^"
-  },
-  "devDependencies": {
-    "@airnauts/comments-test-support": "workspace:*"
   }
-}
+}