@xpr/nestjs-slack 0.9.3 → 1.0.1

package/decorators.d.ts

@@ -1,7 +1,8 @@
 import { ActionConstraints, OptionsConstraints, ShortcutConstraints, ViewConstraints } from '@slack/bolt';
 import { type Pattern } from './utils';
-export type { SlackActionMiddlewareArgs, SlackCommandMiddlewareArgs, SlackShortcutMiddlewareArgs, SlackEventMiddlewareArgs, SlackViewMiddlewareArgs, SlackOptionsMiddlewareArgs, AllMiddlewareArgs, } from '@slack/bolt/dist/types';
+import type { AllMiddlewareArgs, AnyMiddlewareArgs, SlackActionMiddlewareArgs, SlackCommandMiddlewareArgs, SlackEventMiddlewareArgs, SlackOptionsMiddlewareArgs, SlackShortcutMiddlewareArgs, SlackViewMiddlewareArgs } from '@slack/bolt/dist/types';
 export { Pattern };
+export type EndpointArgs<T extends AnyMiddlewareArgs> = T & AllMiddlewareArgs;
 /**
  * @see https://tools.slack.dev/bolt-js/reference/
  */
@@ -12,11 +13,16 @@ export declare const EventTypes: {
     Action: string;
     View: string;
     Option: string;
+    Message: string;
 };
 /**
  * Decorator for Slack controller
  */
 export declare function SlackController(): ClassDecorator;
+/**
+ * Arguments for the slack event handler
+ */
+export type SlackEventArgs = EndpointArgs<SlackEventMiddlewareArgs>;
 /**
  * Decorator for event events
  * @see guide https://tools.slack.dev/bolt-js/concepts/event-listening
@@ -24,6 +30,13 @@ export declare function SlackController(): ClassDecorator;
  * @param event
  */
 export declare function SlackEvent(event: string): MethodDecorator;
+/**
+ * Arguments for the slack shortcut handler
+ */
+export type SlackShortcutArgs = EndpointArgs<SlackShortcutMiddlewareArgs>;
+/**
+ * Shortcut id
+ */
 export type ShortCutId = Pattern | ShortcutConstraints;
 /**
  * Decorator for shortcut events
@@ -32,6 +45,10 @@ export type ShortCutId = Pattern | ShortcutConstraints;
  * @param shortcutId
  */
 export declare function SlackShortcut(shortcutId: ShortCutId): MethodDecorator;
+/**
+ * Arguments for the slack command handler
+ */
+export type SlackCommandArgs = EndpointArgs<SlackCommandMiddlewareArgs>;
 /**
  * Decorator for command events
  * @see guide https://tools.slack.dev/bolt-js/concepts/commands
@@ -39,6 +56,13 @@ export declare function SlackShortcut(shortcutId: ShortCutId): MethodDecorator;
  * @param commandId
  */
 export declare function SlackCommand(commandId: Pattern): MethodDecorator;
+/**
+ * Arguments for the slack action handler
+ */
+export type SlackActionArgs = EndpointArgs<SlackActionMiddlewareArgs>;
+/**
+ * Action id
+ */
 export type ActionId = Pattern | ActionConstraints;
 /**
  * Decorator for action events
@@ -46,6 +70,13 @@ export type ActionId = Pattern | ActionConstraints;
  * @param actionId
  */
 export declare function SlackAction(actionId: ActionId): MethodDecorator;
+/**
+ * Arguments for the slack view handler
+ */
+export type SlackViewArgs = EndpointArgs<SlackViewMiddlewareArgs>;
+/**
+ * View id
+ */
 export type ViewId = Pattern | ViewConstraints;
 /**
  * Decorator for view events
@@ -53,6 +84,13 @@ export type ViewId = Pattern | ViewConstraints;
  * @param viewId
  */
 export declare function SlackView(viewId: ViewId): MethodDecorator;
+/**
+ * Arguments for the slack option handler
+ */
+export type SlackOptionArgs = EndpointArgs<SlackOptionsMiddlewareArgs>;
+/**
+ * Options id
+ */
 export type OptionId = OptionsConstraints;
 /**
  * Decorator for options events
@@ -60,6 +98,7 @@ export type OptionId = OptionsConstraints;
  * @param optionId
  */
 export declare function SlackOption(optionId: OptionId): MethodDecorator;
+export type SlackMessageArgs = EndpointArgs<SlackEventMiddlewareArgs<'message'>>;
 /**
  * Decorator for message events
  *

package/decorators.js

@@ -21,6 +21,7 @@ exports.EventTypes = {
     Action: 'action',
     View: 'view',
     Option: 'option',
+    Message: 'message',
 };
 /**
  * Decorator for Slack controller
@@ -89,5 +90,5 @@ function SlackOption(optionId) {
  * @param pattern
  */
 function SlackMessage(pattern = '*') {
-    return (0, utils_1.messageDecorator)('message', pattern);
+    return (0, utils_1.eventDecorator)(exports.EventTypes.Message, pattern);
 }

package/package.json

@@ -1 +1,56 @@
-{"name":"@xpr/nestjs-slack","version":"0.9.3","description":"NestJS server implementation of the Slack Assistant","main":"index.js","scripts":{"build":"tsc -p tsconfig-lib.json","release":"npm run build && npm publish --access public"},"author":"Ziv Perry","license":"MIT","keywords":["slack","nestjs","assistant","ai"],"engines":{"node":">=20.0.0","npm":">=10.0.0"},"repository":{"type":"git","url":"git+https://github.com/ziv/nestjs-slack.git","directory":"packages/nestjs-slack-assistant"},"bugs":{"url":"https://github.com/ziv/nestjs-slack/issues"},"homepage":"https://github.com/ziv/nestjs-slack#readme","devDependencies":{"@tsconfig/node20":"^20.1.4","@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"},"files":["*.js","*.d.ts","readme.md"]}
+{
+  "name": "@xpr/nestjs-slack",
+  "version": "1.0.1",
+  "description": "NestJS server implementation of the Slack Assistant",
+  "main": "index.js",
+  "scripts": {
+    "build": "tsc -p tsconfig-lib.json"
+  },
+  "author": "Ziv Perry",
+  "license": "MIT",
+  "keywords": [
+    "slack",
+    "nestjs",
+    "assistant",
+    "ai"
+  ],
+  "engines": {
+    "node": ">=20.0.0",
+    "npm": ">=10.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ziv/nestjs-slack.git",
+    "directory": "packages/nestjs-slack-assistant"
+  },
+  "bugs": {
+    "url": "https://github.com/ziv/nestjs-slack/issues"
+  },
+  "homepage": "https://github.com/ziv/nestjs-slack#readme",
+  "devDependencies": {
+    "@tsconfig/node20": "^20.1.4",
+    "@types/node": "^22.10.6",
+    "semantic-release": "^24.2.3",
+    "semantic-release-monorepo": "^8.0.2"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.1",
+    "@nestjs/microservices": ">=11.0.13",
+    "@slack/bolt": ">=4.2.1",
+    "reflect-metadata": ">=0.2.2"
+  },
+  "files": [
+    "*.js",
+    "*.d.ts",
+    "readme.md"
+  ],
+  "release": {
+    "extends": "semantic-release-monorepo",
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/npm",
+      "@semantic-release/github"
+    ]
+  }
+}

package/slack.js

@@ -35,6 +35,9 @@ class Slack extends microservices_1.Server {
     register(handler) {
         const { type, event } = handler.extras;
         switch (type) {
+            case decorators_1.EventTypes.Message:
+                this.app().message(event, handler);
+                break;
             case decorators_1.EventTypes.Shortcut:
                 this.app().shortcut(event, handler);
                 break;
@@ -42,7 +45,6 @@ class Slack extends microservices_1.Server {
                 this.app().action(event, handler);
                 break;
             case decorators_1.EventTypes.Event:
-                // todo improve by providing types for events names
                 this.app().event(event, handler);
                 break;
             case decorators_1.EventTypes.Command: