@walkeros/server-destination-slack 3.3.0-next-1776098542393

package/dist/examples/index.d.mts

@@ -0,0 +1,113 @@
+import { DestinationServer, sendServer } from '@walkeros/server-core';
+import { ChatPostMessageArguments, ChatPostMessageResponse, ChatPostEphemeralArguments, ChatPostEphemeralResponse, ConversationsOpenArguments, ConversationsOpenResponse, WebClient } from '@slack/web-api';
+import { Flow } from '@walkeros/core';
+
+/** A single Block Kit block (kept loose -- Slack does not export a union type). */
+type SlackBlock = Record<string, unknown>;
+interface Settings {
+    /** Slack Bot token (xoxb-...). Enables Web API mode. */
+    token?: string;
+    /** Incoming Webhook URL. Enables webhook mode. */
+    webhookUrl?: string;
+    /** Default channel ID or name. Required for Web API mode unless every rule provides one. */
+    channel?: string;
+    /** Default text template. Supports `${data.field}` interpolation against the walkerOS event. */
+    text?: string;
+    /** Default Block Kit blocks applied when no mapping override is set. */
+    blocks?: SlackBlock[];
+    /** Auto-add an event-name header block when generating default blocks. Default: true. */
+    includeHeader?: boolean;
+    /** Enable link unfurling. Default: false. */
+    unfurlLinks?: boolean;
+    /** Enable media unfurling. Default: false. */
+    unfurlMedia?: boolean;
+    /** Use mrkdwn formatting. Default: true. */
+    mrkdwn?: boolean;
+    /** Static thread_ts to reply to (rarely set at destination level). */
+    threadTs?: string;
+    /** Retry policy passed to WebClient. Default: 'default'. */
+    retryConfig?: 'default' | 'fiveRetriesInFiveMinutes' | 'none';
+    _client?: WebClient;
+}
+/**
+ * Mock-friendly interface for the WebClient methods the destination calls.
+ * Tests inject this via env.slackClient.
+ */
+interface SlackClientMock {
+    chat: {
+        postMessage: (opts: ChatPostMessageArguments) => Promise<ChatPostMessageResponse>;
+        postEphemeral: (opts: ChatPostEphemeralArguments) => Promise<ChatPostEphemeralResponse>;
+    };
+    conversations: {
+        open: (opts: ConversationsOpenArguments) => Promise<ConversationsOpenResponse>;
+    };
+}
+/**
+ * Env -- optional SDK / transport overrides. Production leaves these undefined.
+ * Tests inject `slackClient` (Web API mode) and/or `sendServer` (webhook mode).
+ */
+interface Env extends DestinationServer.Env {
+    slackClient?: SlackClientMock;
+    sendServer?: typeof sendServer;
+}
+
+declare const push: Env;
+declare const simulation: string[];
+
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { env_push as push, env_simulation as simulation };
+}
+
+/**
+ * Extended step example that may carry destination-level settings overrides.
+ */
+type SlackStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+};
+/**
+ * Purchase notification -- Web API mode, channel from mapping override,
+ * text template interpolated against event.data.
+ */
+declare const purchaseAlert: SlackStepExample;
+/**
+ * Error alert -- routes to a different channel via mapping override.
+ */
+declare const errorAlert: SlackStepExample;
+/**
+ * Welcome DM -- conversations.open(users) -> chat.postMessage(channel: D-id).
+ */
+declare const welcomeDM: SlackStepExample;
+/**
+ * Threaded checkout step -- thread_ts override puts the reply into a thread.
+ */
+declare const threadedCheckoutStep: SlackStepExample;
+/**
+ * Ephemeral message -- visible to one user in the target channel.
+ */
+declare const ephemeralMessage: SlackStepExample;
+/**
+ * Default blocks -- no custom text/blocks, destination auto-generates a
+ * Block Kit message from the event data.
+ */
+declare const defaultBlocks: SlackStepExample;
+/**
+ * Webhook mode -- no token, just webhookUrl. The destination calls sendServer
+ * with the JSON body. Channel is baked into the URL by Slack.
+ */
+declare const deployNotification: SlackStepExample;
+
+type step_SlackStepExample = SlackStepExample;
+declare const step_defaultBlocks: typeof defaultBlocks;
+declare const step_deployNotification: typeof deployNotification;
+declare const step_ephemeralMessage: typeof ephemeralMessage;
+declare const step_errorAlert: typeof errorAlert;
+declare const step_purchaseAlert: typeof purchaseAlert;
+declare const step_threadedCheckoutStep: typeof threadedCheckoutStep;
+declare const step_welcomeDM: typeof welcomeDM;
+declare namespace step {
+  export { type step_SlackStepExample as SlackStepExample, step_defaultBlocks as defaultBlocks, step_deployNotification as deployNotification, step_ephemeralMessage as ephemeralMessage, step_errorAlert as errorAlert, step_purchaseAlert as purchaseAlert, step_threadedCheckoutStep as threadedCheckoutStep, step_welcomeDM as welcomeDM };
+}
+
+export { env, step };

package/dist/examples/index.d.ts

@@ -0,0 +1,113 @@
+import { DestinationServer, sendServer } from '@walkeros/server-core';
+import { ChatPostMessageArguments, ChatPostMessageResponse, ChatPostEphemeralArguments, ChatPostEphemeralResponse, ConversationsOpenArguments, ConversationsOpenResponse, WebClient } from '@slack/web-api';
+import { Flow } from '@walkeros/core';
+
+/** A single Block Kit block (kept loose -- Slack does not export a union type). */
+type SlackBlock = Record<string, unknown>;
+interface Settings {
+    /** Slack Bot token (xoxb-...). Enables Web API mode. */
+    token?: string;
+    /** Incoming Webhook URL. Enables webhook mode. */
+    webhookUrl?: string;
+    /** Default channel ID or name. Required for Web API mode unless every rule provides one. */
+    channel?: string;
+    /** Default text template. Supports `${data.field}` interpolation against the walkerOS event. */
+    text?: string;
+    /** Default Block Kit blocks applied when no mapping override is set. */
+    blocks?: SlackBlock[];
+    /** Auto-add an event-name header block when generating default blocks. Default: true. */
+    includeHeader?: boolean;
+    /** Enable link unfurling. Default: false. */
+    unfurlLinks?: boolean;
+    /** Enable media unfurling. Default: false. */
+    unfurlMedia?: boolean;
+    /** Use mrkdwn formatting. Default: true. */
+    mrkdwn?: boolean;
+    /** Static thread_ts to reply to (rarely set at destination level). */
+    threadTs?: string;
+    /** Retry policy passed to WebClient. Default: 'default'. */
+    retryConfig?: 'default' | 'fiveRetriesInFiveMinutes' | 'none';
+    _client?: WebClient;
+}
+/**
+ * Mock-friendly interface for the WebClient methods the destination calls.
+ * Tests inject this via env.slackClient.
+ */
+interface SlackClientMock {
+    chat: {
+        postMessage: (opts: ChatPostMessageArguments) => Promise<ChatPostMessageResponse>;
+        postEphemeral: (opts: ChatPostEphemeralArguments) => Promise<ChatPostEphemeralResponse>;
+    };
+    conversations: {
+        open: (opts: ConversationsOpenArguments) => Promise<ConversationsOpenResponse>;
+    };
+}
+/**
+ * Env -- optional SDK / transport overrides. Production leaves these undefined.
+ * Tests inject `slackClient` (Web API mode) and/or `sendServer` (webhook mode).
+ */
+interface Env extends DestinationServer.Env {
+    slackClient?: SlackClientMock;
+    sendServer?: typeof sendServer;
+}
+
+declare const push: Env;
+declare const simulation: string[];
+
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { env_push as push, env_simulation as simulation };
+}
+
+/**
+ * Extended step example that may carry destination-level settings overrides.
+ */
+type SlackStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+};
+/**
+ * Purchase notification -- Web API mode, channel from mapping override,
+ * text template interpolated against event.data.
+ */
+declare const purchaseAlert: SlackStepExample;
+/**
+ * Error alert -- routes to a different channel via mapping override.
+ */
+declare const errorAlert: SlackStepExample;
+/**
+ * Welcome DM -- conversations.open(users) -> chat.postMessage(channel: D-id).
+ */
+declare const welcomeDM: SlackStepExample;
+/**
+ * Threaded checkout step -- thread_ts override puts the reply into a thread.
+ */
+declare const threadedCheckoutStep: SlackStepExample;
+/**
+ * Ephemeral message -- visible to one user in the target channel.
+ */
+declare const ephemeralMessage: SlackStepExample;
+/**
+ * Default blocks -- no custom text/blocks, destination auto-generates a
+ * Block Kit message from the event data.
+ */
+declare const defaultBlocks: SlackStepExample;
+/**
+ * Webhook mode -- no token, just webhookUrl. The destination calls sendServer
+ * with the JSON body. Channel is baked into the URL by Slack.
+ */
+declare const deployNotification: SlackStepExample;
+
+type step_SlackStepExample = SlackStepExample;
+declare const step_defaultBlocks: typeof defaultBlocks;
+declare const step_deployNotification: typeof deployNotification;
+declare const step_ephemeralMessage: typeof ephemeralMessage;
+declare const step_errorAlert: typeof errorAlert;
+declare const step_purchaseAlert: typeof purchaseAlert;
+declare const step_threadedCheckoutStep: typeof threadedCheckoutStep;
+declare const step_welcomeDM: typeof welcomeDM;
+declare namespace step {
+  export { type step_SlackStepExample as SlackStepExample, step_defaultBlocks as defaultBlocks, step_deployNotification as deployNotification, step_ephemeralMessage as ephemeralMessage, step_errorAlert as errorAlert, step_purchaseAlert as purchaseAlert, step_threadedCheckoutStep as threadedCheckoutStep, step_welcomeDM as welcomeDM };
+}
+
+export { env, step };

package/dist/examples/index.js

@@ -0,0 +1,278 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/examples/index.ts
+var examples_exports = {};
+__export(examples_exports, {
+  env: () => env_exports,
+  step: () => step_exports
+});
+module.exports = __toCommonJS(examples_exports);
+
+// src/examples/env.ts
+var env_exports = {};
+__export(env_exports, {
+  push: () => push,
+  simulation: () => simulation
+});
+var okMessageResponse = {
+  ok: true,
+  channel: "CMOCK",
+  ts: "1700000000.000100"
+};
+var okEphemeralResponse = { ok: true };
+var okOpenResponse = {
+  ok: true,
+  channel: { id: "D-MOCK-DM" }
+};
+function createMockClient() {
+  return {
+    chat: {
+      postMessage: () => Promise.resolve(okMessageResponse),
+      postEphemeral: () => Promise.resolve(okEphemeralResponse)
+    },
+    conversations: {
+      open: () => Promise.resolve(okOpenResponse)
+    }
+  };
+}
+var push = {
+  slackClient: createMockClient(),
+  sendServer: (() => Promise.resolve({ ok: true }))
+};
+var simulation = [
+  "call:slackClient.chat.postMessage",
+  "call:slackClient.chat.postEphemeral",
+  "call:slackClient.conversations.open",
+  "call:sendServer"
+];
+
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  defaultBlocks: () => defaultBlocks,
+  deployNotification: () => deployNotification,
+  ephemeralMessage: () => ephemeralMessage,
+  errorAlert: () => errorAlert,
+  purchaseAlert: () => purchaseAlert,
+  threadedCheckoutStep: () => threadedCheckoutStep,
+  welcomeDM: () => welcomeDM
+});
+var import_core = require("@walkeros/core");
+var purchaseAlert = {
+  in: (0, import_core.getEvent)("order complete", {
+    timestamp: 1700000100,
+    data: {
+      id: "ORD-500",
+      total: 299.99,
+      currency: "EUR",
+      product: "Pro Plan"
+    },
+    user: { id: "buyer-42" }
+  }),
+  mapping: {
+    settings: {
+      channel: "#sales",
+      text: ":moneybag: New order: ${data.id} - ${data.total} ${data.currency}"
+    }
+  },
+  out: [
+    "slackClient.chat.postMessage",
+    {
+      channel: "#sales",
+      text: ":moneybag: New order: ORD-500 - 299.99 EUR",
+      unfurl_links: false,
+      unfurl_media: false,
+      mrkdwn: true
+    }
+  ]
+};
+var errorAlert = {
+  in: (0, import_core.getEvent)("error occur", {
+    timestamp: 1700000200,
+    data: {
+      message: "Payment gateway timeout",
+      code: "PGW_TIMEOUT",
+      severity: "critical"
+    }
+  }),
+  mapping: {
+    settings: {
+      channel: "#engineering-alerts",
+      text: ":rotating_light: Error: ${data.message}"
+    }
+  },
+  out: [
+    "slackClient.chat.postMessage",
+    {
+      channel: "#engineering-alerts",
+      text: ":rotating_light: Error: Payment gateway timeout",
+      unfurl_links: false,
+      unfurl_media: false,
+      mrkdwn: true
+    }
+  ]
+};
+var welcomeDM = {
+  in: (0, import_core.getEvent)("user signup", {
+    timestamp: 1700000300,
+    data: { plan: "enterprise" },
+    user: { id: "U-NEW-USER" }
+  }),
+  mapping: {
+    settings: {
+      dm: true,
+      user: "U-NEW-USER",
+      text: ":wave: Welcome aboard! You signed up for the ${data.plan} plan."
+    }
+  },
+  out: [
+    ["slackClient.conversations.open", { users: "U-NEW-USER" }],
+    [
+      "slackClient.chat.postMessage",
+      {
+        channel: "D-MOCK-DM",
+        text: ":wave: Welcome aboard! You signed up for the enterprise plan.",
+        unfurl_links: false,
+        unfurl_media: false,
+        mrkdwn: true
+      }
+    ]
+  ]
+};
+var threadedCheckoutStep = {
+  in: (0, import_core.getEvent)("checkout step", {
+    timestamp: 1700000400,
+    data: { step: "payment", sessionTs: "1700000000.000050" }
+  }),
+  mapping: {
+    settings: {
+      channel: "#sales",
+      text: "Checkout step: ${data.step}",
+      threadTs: "1700000000.000050",
+      replyBroadcast: true
+    }
+  },
+  out: [
+    "slackClient.chat.postMessage",
+    {
+      channel: "#sales",
+      text: "Checkout step: payment",
+      thread_ts: "1700000000.000050",
+      reply_broadcast: true,
+      unfurl_links: false,
+      unfurl_media: false,
+      mrkdwn: true
+    }
+  ]
+};
+var ephemeralMessage = {
+  in: (0, import_core.getEvent)("quota warning", {
+    timestamp: 1700000500,
+    data: { remaining: 5 }
+  }),
+  mapping: {
+    settings: {
+      channel: "#admin",
+      ephemeral: true,
+      user: "U-ADMIN-1",
+      text: "Heads up: ${data.remaining} requests remaining"
+    }
+  },
+  out: [
+    "slackClient.chat.postEphemeral",
+    {
+      channel: "#admin",
+      user: "U-ADMIN-1",
+      text: "Heads up: 5 requests remaining",
+      unfurl_links: false,
+      unfurl_media: false,
+      mrkdwn: true
+    }
+  ]
+};
+var defaultBlocks = {
+  in: (0, import_core.getEvent)("lead submit", {
+    timestamp: 1700000600,
+    data: { name: "Acme", email: "sales@acme.test" },
+    source: { type: "server", id: "crm", previous_id: "" }
+  }),
+  mapping: {
+    settings: {
+      channel: "#growth"
+    }
+  },
+  out: [
+    "slackClient.chat.postMessage",
+    {
+      channel: "#growth",
+      text: "lead submit",
+      blocks: [
+        {
+          type: "header",
+          text: { type: "plain_text", text: "lead submit" }
+        },
+        {
+          type: "section",
+          fields: [
+            { type: "mrkdwn", text: "*name:*\nAcme" },
+            { type: "mrkdwn", text: "*email:*\nsales@acme.test" }
+          ]
+        },
+        {
+          type: "context",
+          elements: [{ type: "mrkdwn", text: "Source: crm" }]
+        }
+      ],
+      unfurl_links: false,
+      unfurl_media: false,
+      mrkdwn: true
+    }
+  ]
+};
+var deployNotification = {
+  in: (0, import_core.getEvent)("deploy complete", {
+    timestamp: 1700000700,
+    data: { version: "1.4.2", environment: "prod" }
+  }),
+  settings: {
+    token: void 0,
+    webhookUrl: "https://hooks.slack.com/services/T00/B00/xxx"
+  },
+  mapping: {
+    settings: {
+      text: ":rocket: Deployment complete: ${data.version} to ${data.environment}"
+    }
+  },
+  out: [
+    "sendServer",
+    "https://hooks.slack.com/services/T00/B00/xxx",
+    {
+      text: ":rocket: Deployment complete: 1.4.2 to prod",
+      unfurl_links: false,
+      unfurl_media: false,
+      mrkdwn: true
+    }
+  ]
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  env,
+  step
+});