@xpr/nestjs-slack 0.5.0 → 0.7.0

package/decorators.d.ts

@@ -1,5 +1,5 @@
-import { ActionConstraints, OptionsConstraints, ShortcutConstraints, ViewConstraints } from "@slack/bolt";
-import { type Pattern } from "./utils";
+import { ActionConstraints, OptionsConstraints, ShortcutConstraints, ViewConstraints } from '@slack/bolt';
+import { type Pattern } from './utils';
 export { Pattern };
 /**
  * @see https://tools.slack.dev/bolt-js/reference/
@@ -12,12 +12,15 @@ export declare const EventTypes: {
     View: string;
     Option: string;
 };
+/**
+ * Decorator for Slack controller
+ */
+export declare function SlackController(): ClassDecorator;
 /**
  * Decorator for event events
  * @see guide https://tools.slack.dev/bolt-js/concepts/event-listening
  * @see api https://api.slack.com/apis/events-api
  * @param event
- * @constructor
  */
 export declare function SlackEvent(event: string): MethodDecorator;
 export type ShortCutId = Pattern | ShortcutConstraints;
@@ -26,7 +29,6 @@ export type ShortCutId = Pattern | ShortcutConstraints;
  * @see guide https://tools.slack.dev/bolt-js/concepts/shortcuts
  * @see api https://api.slack.com/interactivity/shortcuts
  * @param shortcutId
- * @constructor
  */
 export declare function SlackShortcut(shortcutId: ShortCutId): MethodDecorator;
 /**
@@ -34,7 +36,6 @@ export declare function SlackShortcut(shortcutId: ShortCutId): MethodDecorator;
  * @see guide https://tools.slack.dev/bolt-js/concepts/commands
  * @see api https://api.slack.com/interactivity/slash-commands
  * @param commandId
- * @constructor
  */
 export declare function SlackCommand(commandId: Pattern): MethodDecorator;
 export type ActionId = Pattern | ActionConstraints;
@@ -42,7 +43,6 @@ export type ActionId = Pattern | ActionConstraints;
  * Decorator for action events
  * @see guide https://tools.slack.dev/bolt-js/concepts/actions
  * @param actionId
- * @constructor
  */
 export declare function SlackAction(actionId: ActionId): MethodDecorator;
 export type ViewId = Pattern | ViewConstraints;
@@ -50,7 +50,6 @@ export type ViewId = Pattern | ViewConstraints;
  * Decorator for view events
  * @see guide https://tools.slack.dev/bolt-js/concepts/view-submissions
  * @param viewId
- * @constructor
  */
 export declare function SlackView(viewId: ViewId): MethodDecorator;
 export type OptionId = OptionsConstraints;
@@ -58,7 +57,6 @@ export type OptionId = OptionsConstraints;
  * Decorator for options events
  * @see guide https://tools.slack.dev/bolt-js/concepts/options
  * @param optionId
- * @constructor
  */
 export declare function SlackOption(optionId: OptionId): MethodDecorator;
 /**
@@ -67,6 +65,5 @@ export declare function SlackOption(optionId: OptionId): MethodDecorator;
  * @see guide https://tools.slack.dev/bolt-js/concepts/message-listening
  * @see reference https://api.slack.com/events/message
  * @param pattern
- * @constructor
  */
 export declare function SlackMessage(pattern?: Pattern): MethodDecorator;

package/decorators.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventTypes = void 0;
+exports.SlackController = SlackController;
 exports.SlackEvent = SlackEvent;
 exports.SlackShortcut = SlackShortcut;
 exports.SlackCommand = SlackCommand;
@@ -8,24 +9,30 @@ exports.SlackAction = SlackAction;
 exports.SlackView = SlackView;
 exports.SlackOption = SlackOption;
 exports.SlackMessage = SlackMessage;
+const common_1 = require("@nestjs/common");
 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",
+    Event: 'event',
+    Shortcut: 'shortcut',
+    Command: 'command',
+    Action: 'action',
+    View: 'view',
+    Option: 'option',
 };
+/**
+ * Decorator for Slack controller
+ */
+function SlackController() {
+    return (target) => (0, common_1.Controller)()(target);
+}
 /**
  * Decorator for event events
  * @see guide https://tools.slack.dev/bolt-js/concepts/event-listening
  * @see api https://api.slack.com/apis/events-api
  * @param event
- * @constructor
  */
 function SlackEvent(event) {
     // todo input validation (types for event)
@@ -36,7 +43,6 @@ function SlackEvent(event) {
  * @see guide https://tools.slack.dev/bolt-js/concepts/shortcuts
  * @see api https://api.slack.com/interactivity/shortcuts
  * @param shortcutId
- * @constructor
  */
 function SlackShortcut(shortcutId) {
     return (0, utils_1.eventDecorator)(exports.EventTypes.Shortcut, shortcutId);
@@ -46,7 +52,6 @@ function SlackShortcut(shortcutId) {
  * @see guide https://tools.slack.dev/bolt-js/concepts/commands
  * @see api https://api.slack.com/interactivity/slash-commands
  * @param commandId
- * @constructor
  */
 function SlackCommand(commandId) {
     // todo input validation command must start with / etc.
@@ -56,7 +61,6 @@ function SlackCommand(commandId) {
  * Decorator for action events
  * @see guide https://tools.slack.dev/bolt-js/concepts/actions
  * @param actionId
- * @constructor
  */
 function SlackAction(actionId) {
     return (0, utils_1.eventDecorator)(exports.EventTypes.Action, actionId);
@@ -65,7 +69,6 @@ function SlackAction(actionId) {
  * Decorator for view events
  * @see guide https://tools.slack.dev/bolt-js/concepts/view-submissions
  * @param viewId
- * @constructor
  */
 function SlackView(viewId) {
     return (0, utils_1.eventDecorator)(exports.EventTypes.View, viewId);
@@ -74,7 +77,6 @@ function SlackView(viewId) {
  * Decorator for options events
  * @see guide https://tools.slack.dev/bolt-js/concepts/options
  * @param optionId
- * @constructor
  */
 function SlackOption(optionId) {
     return (0, utils_1.eventDecorator)(exports.EventTypes.Option, optionId);
@@ -85,8 +87,7 @@ function SlackOption(optionId) {
  * @see guide https://tools.slack.dev/bolt-js/concepts/message-listening
  * @see reference https://api.slack.com/events/message
  * @param pattern
- * @constructor
  */
-function SlackMessage(pattern = "*") {
-    return (0, utils_1.messageDecorator)("message", pattern);
+function SlackMessage(pattern = '*') {
+    return (0, utils_1.messageDecorator)('message', pattern);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xpr/nestjs-slack",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "NestJS server implementation of the Slack Assistant",
   "main": "index.js",
   "scripts": {
@@ -28,6 +28,7 @@
     "@types/node": "^22.10.6"
   },
   "peerDependencies": {
+    "@nestjs/common": "^11.0.1",
     "@nestjs/microservices": ">=11.0.13",
     "@slack/bolt": ">=4.2.1",
     "reflect-metadata": ">=0.2.2"

package/slack.d.ts

@@ -1,5 +1,5 @@
-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

package/slack.js

@@ -14,8 +14,6 @@ class Slack extends microservices_1.Server {
     async listen(callback) {
         for (const handler of this.getHandlers().values()) {
             this.register(handler);
-            const { type, event } = handler.extras;
-            this.logger.log(`Handler [${type}] registered with (${event})`);
         }
         await this.app().start();
         callback();
@@ -24,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;
@@ -36,6 +34,7 @@ class Slack extends microservices_1.Server {
      */
     register(handler) {
         const { type, event } = handler.extras;
+        this.logger.log(`Registering handler of type [${type}] with (${event})`);
         switch (type) {
             case decorators_1.EventTypes.Shortcut:
                 return this.app().shortcut(event, handler);
@@ -61,7 +60,7 @@ class Slack extends microservices_1.Server {
                 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;
     }