@xpr/nestjs-slack 1.0.2 → 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 { 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
@@ -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

@@ -24,13 +24,41 @@ exports.EventTypes = {
     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

package/index.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xpr/nestjs-slack",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "description": "NestJS server implementation of the Slack Assistant",
   "main": "index.js",
   "scripts": {

package/slack.d.ts

@@ -2,10 +2,16 @@ import { type CustomTransportStrategy, type MessageHandler, Server } from "@nest
 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

@@ -64,8 +64,7 @@ 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);

package/utils.d.ts

@@ -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