@xpr/nestjs-slack 1.0.1 → 2.0.0

package/decorators.d.ts

@@ -1,6 +1,5 @@
-import { ActionConstraints, OptionsConstraints, ShortcutConstraints, ViewConstraints } from '@slack/bolt';
-import { type Pattern } from './utils';
-import type { AllMiddlewareArgs, AnyMiddlewareArgs, SlackActionMiddlewareArgs, SlackCommandMiddlewareArgs, SlackEventMiddlewareArgs, SlackOptionsMiddlewareArgs, SlackShortcutMiddlewareArgs, SlackViewMiddlewareArgs } from '@slack/bolt/dist/types';
+import { type Pattern } from "./utils";
+import type { ActionConstraints, AllMiddlewareArgs, AnyMiddlewareArgs, OptionsConstraints, ShortcutConstraints, SlackActionMiddlewareArgs, SlackCommandMiddlewareArgs, SlackEventMiddlewareArgs, SlackOptionsMiddlewareArgs, SlackShortcutMiddlewareArgs, SlackViewMiddlewareArgs, ViewConstraints } from "@slack/bolt/dist/types";
 export { Pattern };
 export type EndpointArgs<T extends AnyMiddlewareArgs> = T & AllMiddlewareArgs;
 /**
@@ -16,15 +15,45 @@ export declare const EventTypes: {
     Message: string;
 };
 /**
- * Decorator for Slack controller
+ * Decorator for Slack/Bolt application controller
+ *
+ * @example slack controller:
+ * ```ts
+ * import { SlackController } from '@xpr/nestjs-slack';
+ *
+ * @SlackController()
+ * class MySlackController {
+ *    // add decorated methods
+ * }
+ * ```
  */
 export declare function SlackController(): ClassDecorator;
 /**
  * Arguments for the slack event handler
+ *
+ * See {@link SlackEvent}
  */
 export type SlackEventArgs = EndpointArgs<SlackEventMiddlewareArgs>;
 /**
  * Decorator for event events
+ *
+ * Usage:
+ * ```ts
+ * import {
+ *  SlackController,
+ *  SlackEvent,
+ *  SlackEventArgs,
+ * } from '@xpr/nestjs-slack';
+ *
+ * @SlackController()
+ * class MySlackController {
+ *
+ *    @SlackEvent('event_name')
+ *    foo(args: SlackEventArgs) {
+ *    }
+ * }
+ * ```
+ *
  * @see guide https://tools.slack.dev/bolt-js/concepts/event-listening
  * @see api https://api.slack.com/apis/events-api
  * @param event
@@ -98,7 +127,7 @@ export type OptionId = OptionsConstraints;
  * @param optionId
  */
 export declare function SlackOption(optionId: OptionId): MethodDecorator;
-export type SlackMessageArgs = EndpointArgs<SlackEventMiddlewareArgs<'message'>>;
+export type SlackMessageArgs = EndpointArgs<SlackEventMiddlewareArgs<"message">>;
 /**
  * Decorator for message events
  *
@@ -107,3 +136,4 @@ export type SlackMessageArgs = EndpointArgs<SlackEventMiddlewareArgs<'message'>>
  * @param pattern
  */
 export declare function SlackMessage(pattern?: Pattern): MethodDecorator;
+//# sourceMappingURL=decorators.d.ts.map

package/decorators.js

@@ -15,22 +15,50 @@ const utils_1 = require("./utils");
  * @see https://tools.slack.dev/bolt-js/reference/
  */
 exports.EventTypes = {
-    Event: 'event',
-    Shortcut: 'shortcut',
-    Command: 'command',
-    Action: 'action',
-    View: 'view',
-    Option: 'option',
-    Message: 'message',
+    Event: "event",
+    Shortcut: "shortcut",
+    Command: "command",
+    Action: "action",
+    View: "view",
+    Option: "option",
+    Message: "message",
 };
 /**
- * Decorator for Slack controller
+ * Decorator for Slack/Bolt application controller
+ *
+ * @example slack controller:
+ * ```ts
+ * import { SlackController } from '@xpr/nestjs-slack';
+ *
+ * @SlackController()
+ * class MySlackController {
+ *    // add decorated methods
+ * }
+ * ```
  */
 function SlackController() {
     return (target) => (0, common_1.Controller)()(target);
 }
 /**
  * Decorator for event events
+ *
+ * Usage:
+ * ```ts
+ * import {
+ *  SlackController,
+ *  SlackEvent,
+ *  SlackEventArgs,
+ * } from '@xpr/nestjs-slack';
+ *
+ * @SlackController()
+ * class MySlackController {
+ *
+ *    @SlackEvent('event_name')
+ *    foo(args: SlackEventArgs) {
+ *    }
+ * }
+ * ```
+ *
  * @see guide https://tools.slack.dev/bolt-js/concepts/event-listening
  * @see api https://api.slack.com/apis/events-api
  * @param event
@@ -89,6 +117,6 @@ function SlackOption(optionId) {
  * @see reference https://api.slack.com/events/message
  * @param pattern
  */
-function SlackMessage(pattern = '*') {
+function SlackMessage(pattern = "*") {
     return (0, utils_1.eventDecorator)(exports.EventTypes.Message, pattern);
 }

package/index.d.ts

@@ -1,3 +1,4 @@
 import Slack from "./slack";
 export * from "./decorators";
 export { Slack };
+//# sourceMappingURL=index.d.ts.map

package/license

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright 2025 to Ziv Perry.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to delal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xpr/nestjs-slack",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "NestJS server implementation of the Slack Assistant",
   "main": "index.js",
   "scripts": {
@@ -42,7 +42,8 @@
   "files": [
     "*.js",
     "*.d.ts",
-    "readme.md"
+    "readme.md",
+    "license"
   ],
   "release": {
     "extends": "semantic-release-monorepo",

package/readme.md

@@ -1,6 +1,7 @@
 # @xpr/nestjs-slack
 
-A NestJS microservice transport and decorators for [Slack Bolt Apps](https://github.com/slackapi/bolt-js).
+A NestJS microservice transport and decorators for
+[Slack Bolt Apps](https://github.com/slackapi/bolt-js).
 
 ### Usage
 
@@ -31,27 +32,22 @@ await app.listen();
 Example of a Slack controller with listener for action and a command.
 
 ```ts
-import {
-  SlackAction,
-  SlackCommand,
-  SlackController,
-} from '@xpr/nestjs-slack';
+import { SlackAction, SlackCommand, SlackController } from "@xpr/nestjs-slack";
 
 @SlackController()
 export class MyController {
-
-  @SlackAction('button-action')
+  @SlackAction("button-action")
   async onAction({ ack, respond, payload }: SlackActionMiddlewareArgs) {
     await ack();
     await respond(`Button clicked! with payload ${JSON.stringify(payload)}`);
   }
 
-  @SlackCommand('/ping')
+  @SlackCommand("/ping")
   async onPing({ ack, respond }: SlackCommandMiddlewareArgs) {
     await ack();
     await respond({
-      text: 'pong!',
-      response_type: 'in_channel',
+      text: "pong!",
+      response_type: "in_channel",
     });
   }
 }
@@ -63,4 +59,4 @@ export class MyController {
 
 ## Decorators
 
-See [source file](./decorators.ts).
+See [source file](./decorators.ts).

package/slack.d.ts

@@ -1,11 +1,17 @@
-import { type CustomTransportStrategy, type MessageHandler, Server } from '@nestjs/microservices';
-import { App, type AppOptions } from '@slack/bolt';
+import { type CustomTransportStrategy, type MessageHandler, Server } from "@nestjs/microservices";
+import { App, type AppOptions } from "@slack/bolt";
 export type SlackOptions = {
     /**
-     * Slack application options with required types
+     * Slack application options with required types.
      * @see https://github.com/slackapi/bolt-js
      */
     slack: AppOptions;
+    /**
+     * Whether to inject NestJS logger into the Slack app.
+     * The injected logger override any provided in the `slack` options.
+     * @default false
+     */
+    injectNestjsLogger?: boolean;
 };
 export default class Slack extends Server implements CustomTransportStrategy {
     #private;
@@ -27,3 +33,4 @@ export default class Slack extends Server implements CustomTransportStrategy {
      */
     protected app(): App;
 }
+//# sourceMappingURL=slack.d.ts.map

package/slack.js

@@ -22,7 +22,7 @@ class Slack extends microservices_1.Server {
         this.#app && (await this.#app.stop());
     }
     on() {
-        throw new Error('Use SlackEvent decorator to register events');
+        throw new Error("Use SlackEvent decorator to register events");
     }
     unwrap() {
         return this.#app;
@@ -64,12 +64,11 @@ class Slack extends microservices_1.Server {
      */
     app() {
         if (!this.#app) {
-            // make sure to add logger if not provided
-            if (!this.options.slack.logger) {
+            if (this.options.injectNestjsLogger && !this.options.slack.logger) {
                 this.options.slack.logger = (0, utils_1.adjustLogger)(this.logger);
             }
             this.#app = new bolt_1.App(this.options.slack);
-            this.logger.log('Bolt app created');
+            this.logger.log("Bolt app created");
         }
         return this.#app;
     }

package/utils.d.ts

@@ -1,4 +1,4 @@
-import { type Logger } from '@slack/bolt';
+import { type Logger } from "@slack/bolt";
 export type Pattern = string | RegExp;
 /**
  * Create method decorator
@@ -13,3 +13,4 @@ export declare function eventDecorator<T>(type: string, event: T): MethodDecorat
  */
 export declare function messageDecorator(type: string, pattern: Pattern): MethodDecorator;
 export declare function adjustLogger(logger: any): Logger;
+//# sourceMappingURL=utils.d.ts.map

package/utils.js

@@ -6,7 +6,7 @@ exports.adjustLogger = adjustLogger;
 const microservices_1 = require("@nestjs/microservices");
 const bolt_1 = require("@slack/bolt");
 const normalizePattern = (pattern) => {
-    if (typeof pattern === 'string') {
+    if (typeof pattern === "string") {
         return pattern;
     }
     if (pattern instanceof RegExp) {
@@ -39,29 +39,29 @@ function messageDecorator(type, pattern) {
 function adjustLogger(logger) {
     // this patch required to support NestJS logger that not use the standard "info"
     // and use "log" instead
-    if (logger['log'] && !logger['info']) {
-        logger['info'] = logger['log'].bind(logger);
+    if (logger["log"] && !logger["info"]) {
+        logger["info"] = logger["log"].bind(logger);
     }
     // minimal logger interface required by @slack/bolt library
-    for (const method of ['debug', 'info', 'warn', 'error']) {
-        if (typeof logger[method] !== 'function') {
+    for (const method of ["debug", "info", "warn", "error"]) {
+        if (typeof logger[method] !== "function") {
             throw new Error(`Logger must implement "${method}" method`);
         }
     }
     // add compatibility with @slack/bolt library
-    if (!logger['setLevel']) {
+    if (!logger["setLevel"]) {
         logger.setLevel = () => {
             // don't allow library to set the level
         };
     }
-    if (!logger['getLevel']) {
+    if (!logger["getLevel"]) {
         logger.getLevel = () => {
             // always return the lowest supported level (by library, not real logger)
             // to avoid filtering log messages by library instead of real logger
             return bolt_1.LogLevel.DEBUG;
         };
     }
-    if (!logger['setName']) {
+    if (!logger["setName"]) {
         logger.setName = (name) => {
             // search for all possible setName/setContext methods, use "noop" if none
             (logger.setName ?? logger.setContext ?? ((i) => i))(name);