@checkstack/notification-discord-backend 0.1.28 → 0.1.29

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @checkstack/notification-discord-backend
 
+## 0.1.29
+
+### Patch Changes
+
+- a06b899: Dead-code audit cleanup and a small platform of shared notification helpers.
+
+  **Removed (dead code)**
+
+  - `core/backend/src/plugin-manager/deregistration-guard.ts` deleted. The exported `assertCanDeregister()` was never called and was a less-complete version of the dependents+isUninstallable checks already done inline by `previewUninstallOriginator` / `uninstallOriginator` in `plugin-manager-orchestrator.ts`.
+  - `createMockQueueFactory` deprecated alias removed from `@checkstack/test-utils-backend`. Use `createMockQueueManager` directly.
+
+  **New shared helpers**
+
+  - `@checkstack/backend-api` now exports `requestTimeoutMs()` — a Zod field builder for outbound HTTP request timeouts (1s..60s, default 10s). Replaces hand-rolled `configNumber({}).min(1000).max(60_000).default(10_000)` in `integration-webhook-backend`, `integration-script-backend`, and `healthcheck-script-backend`'s inline collector.
+  - `@checkstack/notification-common` now exports `SubjectStatusSchema` / `SubjectStatus`, mirroring the existing `ImportanceSchema`.
+  - `@checkstack/notification-backend` now exports:
+    - `SUBJECT_STATUS_EMOJI` / `IMPORTANCE_EMOJI` — the shared status / importance emoji maps that Discord, Slack, Teams, Webex and Telegram previously each redefined inline.
+    - `postJson(opts)` — a timeout-bounded `fetch` wrapper that handles non-2xx logging and error mapping for webhook-style POSTs. Returns `{ ok: true, response } | { ok: false, error }`.
+
+  **Migrated to shared helpers**
+
+  - Discord, Slack, Gotify, Pushover notification backends now use `postJson`. Outer try/catch + per-plugin error mapping deleted (~140 LOC).
+  - Discord, Slack, Teams, Telegram, Webex notification backends now use `IMPORTANCE_EMOJI`. Discord, Slack, Teams use `SUBJECT_STATUS_EMOJI`.
+  - Teams, Webex, Backstage, Telegram kept their inline fetch/Bot logic: their error strings surface server response bodies to operators, or the transport isn't raw `fetch` (Telegram uses `grammy`'s `Bot`).
+
+  **API surface tightening**
+
+  - Per-plugin test-only re-exports in 6 notification backends (Pushover, Gotify, Backstage, Slack, Discord, Teams) and the `CertificateInfo` interface in `healthcheck-tls-backend/strategy.ts` are now JSDoc-tagged `@internal`. No behaviour change; signals that downstream consumers must not depend on them.
+
+- Updated dependencies [a06b899]
+- Updated dependencies [a06b899]
+  - @checkstack/backend-api@0.16.0
+  - @checkstack/notification-backend@1.1.0
+
 ## 0.1.28
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/notification-discord-backend",
-  "version": "0.1.28",
+  "version": "0.1.29",
   "type": "module",
   "main": "src/index.ts",
   "checkstack": {
@@ -18,9 +18,9 @@
     "pack": "bunx @checkstack/scripts plugin-pack"
   },
   "dependencies": {
-    "@checkstack/backend-api": "0.15.2",
+    "@checkstack/backend-api": "0.15.3",
     "@checkstack/common": "0.10.0",
-    "@checkstack/notification-backend": "1.0.4",
+    "@checkstack/notification-backend": "1.0.5",
     "zod": "^4.2.1"
   },
   "devDependencies": {

package/src/index.ts

@@ -9,9 +9,13 @@ import {
   type NotificationSubject,
   markdownToPlainText,
 } from "@checkstack/backend-api";
-import { notificationStrategyExtensionPoint } from "@checkstack/notification-backend";
+import {
+  notificationStrategyExtensionPoint,
+  postJson,
+  SUBJECT_STATUS_EMOJI,
+  IMPORTANCE_EMOJI,
+} from "@checkstack/notification-backend";
 import { pluginMetadata } from "./plugin-metadata";
-import { extractErrorMessage } from "@checkstack/common";
 
 // ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 // Configuration Schemas
@@ -79,13 +83,6 @@ interface DiscordEmbed {
   timestamp?: string;
 }
 
-const SUBJECT_STATUS_EMOJI = {
-  healthy: "🟢",
-  degraded: "🟡",
-  unhealthy: "🔴",
-  unknown: "⚪",
-} as const;
-
 function buildDiscordEmbed(options: DiscordEmbedOptions): DiscordEmbed {
   const { title, body, importance, action, subjects } = options;
 
@@ -96,14 +93,8 @@ function buildDiscordEmbed(options: DiscordEmbedOptions): DiscordEmbed {
     critical: 0xEF_44_44, // Red
   };
 
-  const importanceEmoji: Record<string, string> = {
-    info: "ℹ️",
-    warning: "⚠️",
-    critical: "🚨",
-  };
-
   const embed: DiscordEmbed = {
-    title: `${importanceEmoji[importance]} ${title}`,
+    title: `${IMPORTANCE_EMOJI[importance]} ${title}`,
     color: importanceColors[importance],
     timestamp: new Date().toISOString(),
   };
@@ -192,52 +183,25 @@ const discordStrategy: NotificationStrategy<DiscordConfig, DiscordUserConfig> =
         };
       }
 
-      try {
-        // Build the embed
-        const embed = buildDiscordEmbed({
-          title: notification.title,
-          body: notification.body,
-          importance: notification.importance,
-          action: notification.action,
-          subjects: notification.subjects,
-        });
-
-        // Send to Discord webhook
-        const response = await fetch(userConfig.webhookUrl, {
-          method: "POST",
-          headers: {
-            "Content-Type": "application/json",
-          },
-          body: JSON.stringify({
-            embeds: [embed],
-          }),
-          signal: AbortSignal.timeout(10_000),
-        });
-
-        if (!response.ok) {
-          const errorText = await response.text();
-          logger.error("Failed to send Discord message", {
-            status: response.status,
-            error: errorText.slice(0, 500),
-          });
-          return {
-            success: false,
-            error: `Failed to send Discord message: ${response.status}`,
-          };
-        }
-
-        // Discord webhooks return 204 No Content on success
-        return {
-          success: true,
-        };
-      } catch (error) {
-        const message = extractErrorMessage(error, "Unknown Discord API error");
-        logger.error("Discord notification error", { error: message });
-        return {
-          success: false,
-          error: `Failed to send Discord notification: ${message}`,
-        };
-      }
+      // Build the embed
+      const embed = buildDiscordEmbed({
+        title: notification.title,
+        body: notification.body,
+        importance: notification.importance,
+        action: notification.action,
+        subjects: notification.subjects,
+      });
+
+      // Send to Discord webhook
+      const result = await postJson({
+        url: userConfig.webhookUrl,
+        body: { embeds: [embed] },
+        serviceName: "Discord",
+        logger,
+      });
+      return result.ok
+        ? { success: true }
+        : { success: false, error: result.error };
     },
   };
 
@@ -259,6 +223,11 @@ export default createBackendPlugin({
   },
 });
 
-// Export for testing
+/**
+ * Internal exports for the package's own unit tests. Not part of the plugin's
+ * public API surface.
+ * @internal
+ */
 export { discordConfigSchemaV1, discordUserConfigSchema, buildDiscordEmbed };
+/** @internal */
 export type { DiscordConfig, DiscordUserConfig, DiscordEmbedOptions };