@theholocron/holocron-plugin-slack 5.0.0-alpha.278 → 5.0.0-alpha.279

package/dist/index.d.mts

@@ -1,17 +1,22 @@
 import { AuthError, Notifications, PluginToken, ResolveTokenInput, VerifyTokenFailure, VerifyTokenResult, VerifyTokenResult as VerifyTokenResult$1, VerifyTokenSuccess } from "@theholocron/cli";
 import { SlackClient, SlackClientOptions, createSlackClient } from "@theholocron/slack-client";
+/** Resolves the Slack bot token from `--token`, `HOLOCRON_SLACK_TOKEN`, `SLACK_BOT_TOKEN` or the keyring entry for `slack`, and throws `AuthError` when none is set. */
 export declare const resolveToken: import("@theholocron/cli").TokenResolver;
 /** Every token this plugin takes, for `holocron doctor tokens`. */
 export declare const tokens: PluginToken[];
+/** Options for the Slack `notifications` capability. */
 interface SlackNotificationsOptions {
   /** Default channel id used when `send()` is called without an explicit channel. */
   defaultChannel?: string;
 }
+/** `notifications` capability for Slack: posts messages to a channel as the bot. */
 export declare class SlackNotifications implements Notifications {
   /** Memoized client thunk — resolves the token on first authenticated call. */
   private readonly client;
   private readonly opts;
+  /** Capability key; always `"notifications"`. */
   readonly key: "notifications";
+  /** Provider name; always `"slack"`. */
   readonly providerName = "slack";
   constructor(
   /** Memoized client thunk — resolves the token on first authenticated call. */
@@ -22,19 +27,27 @@ interface VerifyTokenOptions {
   baseUrl?: string;
   fetch?: typeof fetch;
 }
+/** Checks a Slack bot token with `auth.test` and reports the bot user and workspace, or why it was rejected. */
 export declare function verifyToken(token: string, opts?: VerifyTokenOptions): Promise<VerifyTokenResult$1>;
+/** Options for the Slack plugin: the token lookup inputs plus the notification defaults. */
 export interface SlackPluginOptions extends ResolveTokenInput, SlackNotificationsOptions {
   /** Override base URL for tests. Default: https://slack.com/api */
   baseUrl?: string;
+  /** Override `fetch` for tests. */
   fetch?: typeof fetch;
 }
+/** Shared state for one Slack plugin instance: its options and a lazily created client. */
 export interface PluginContext {
+  /** The options the plugin was created with. */
   options: SlackPluginOptions;
   /** Memoized client — the token is resolved on first use, not at plugin load. */
   client: () => SlackClient;
 }
+/** Builds the plugin context from its options. */
 export declare function createContext(options?: SlackPluginOptions): PluginContext;
+/** Builds the `notifications` capability for the context. */
 export declare function notifications(ctx: PluginContext): Notifications;
+/** Creates the Slack plugin: its `connection` probe and the `notifications` capability. */
 export declare function createPlugin(options?: SlackPluginOptions): {
   name: string;
   probes: {
@@ -44,5 +57,6 @@ export declare function createPlugin(options?: SlackPluginOptions): {
     notifications: () => Notifications;
   };
 };
+/** Hint printed by `holocron auth set slack` when no token is supplied or the token is rejected; explains how to create a bot token. */
 export declare const AUTH_HINT: string;
 export { AuthError, type ResolveTokenInput, type SlackClient, type SlackClientOptions, type SlackNotificationsOptions, type VerifyTokenFailure, type VerifyTokenResult, type VerifyTokenSuccess, createSlackClient };

package/dist/index.mjs

@@ -2,6 +2,7 @@ import { AuthError, connectionProbe, createResolveToken } from "@theholocron/cli
 import { createSlackClient } from "@theholocron/slack-client";
 import { errorMessage } from "@theholocron/misc-utils";
 // src/auth.ts
+/** Resolves the Slack bot token from `--token`, `HOLOCRON_SLACK_TOKEN`, `SLACK_BOT_TOKEN` or the keyring entry for `slack`, and throws `AuthError` when none is set. */
 const resolveToken = createResolveToken({
 	envName: "HOLOCRON_SLACK_TOKEN",
 	vendorEnvName: "SLACK_BOT_TOKEN",
@@ -11,10 +12,13 @@ const resolveToken = createResolveToken({
 /** Every token this plugin takes, for `holocron doctor tokens`. */
 const tokens = [resolveToken.token];
 // src/capabilities/notifications.ts
+/** `notifications` capability for Slack: posts messages to a channel as the bot. */
 var SlackNotifications = class {
 	client;
 	opts;
+	/** Capability key; always `"notifications"`. */
 	key = "notifications";
+	/** Provider name; always `"slack"`. */
 	providerName = "slack";
 	constructor(client, opts) {
 		this.client = client;
@@ -27,6 +31,7 @@ var SlackNotifications = class {
 	}
 };
 // src/verify-token.ts
+/** Checks a Slack bot token with `auth.test` and reports the bot user and workspace, or why it was rejected. */
 async function verifyToken(token, opts = {}) {
 	const client = createSlackClient({
 		token,
@@ -47,6 +52,7 @@ async function verifyToken(token, opts = {}) {
 	}
 }
 // src/index.ts
+/** Builds the plugin context from its options. */
 function createContext(options = {}) {
 	let client;
 	return {
@@ -58,9 +64,11 @@ function createContext(options = {}) {
 		})
 	};
 }
+/** Builds the `notifications` capability for the context. */
 function notifications(ctx) {
 	return new SlackNotifications(ctx.client, ctx.options);
 }
+/** Creates the Slack plugin: its `connection` probe and the `notifications` capability. */
 function createPlugin(options = {}) {
 	const ctx = createContext(options);
 	return {
@@ -78,5 +86,6 @@ function createPlugin(options = {}) {
 		capabilities: { notifications: () => notifications(ctx) }
 	};
 }
+/** Hint printed by `holocron auth set slack` when no token is supplied or the token is rejected; explains how to create a bot token. */
 const AUTH_HINT = "create a Slack app at https://api.slack.com/apps, add the chat:write bot scope, install it to your workspace, copy the Bot User OAuth Token (xoxb-...), then run: holocron auth set slack <xoxb-TOKEN>";
 export { AUTH_HINT, AuthError, SlackNotifications, createContext, createPlugin, createSlackClient, notifications, resolveToken, tokens, verifyToken };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/holocron-plugin-slack",
-  "version": "5.0.0-alpha.278",
+  "version": "5.0.0-alpha.279",
   "description": "Holocron plugin for Slack. Implements the notifications capability via Slack's bot API.",
   "keywords": [
     "holocron",
@@ -41,11 +41,11 @@
     "tsx": "4.23.15",
     "typescript": "^5.9.3",
     "vitest": "^5.0.5",
+    "@theholocron/cli": "5.0.0-alpha.279",
     "@theholocron/eslint-config": "^8.9.0-alpha.4",
     "@theholocron/http-client": "^1.58.0-alpha.3",
     "@theholocron/misc-utils": "^1.16.1-alpha.3",
     "@theholocron/slack-client": "^1.58.0-alpha.3",
-    "@theholocron/cli": "5.0.0-alpha.278",
     "@theholocron/tsconfig": "^8.9.0-alpha.4",
     "@theholocron/tsdown-config": "^8.9.0-alpha.4",
     "@theholocron/vitest-config": "^8.9.0-alpha.4"
@@ -53,7 +53,7 @@
   "peerDependencies": {
     "@theholocron/misc-utils": "^1.16.0",
     "@theholocron/slack-client": "^1.43.1",
-    "@theholocron/cli": "5.0.0-alpha.278"
+    "@theholocron/cli": "5.0.0-alpha.279"
   },
   "engines": {
     "node": ">=22"