@xpr/nestjs-slack 0.0.0 → 0.0.2

package/decorators.d.ts

@@ -1,6 +1,16 @@
-import { ActionConstraints, OptionsConstraints, ShortcutConstraints, ViewConstraints } from "@slack/bolt";
-import { type Pattern } from "./utils";
-export { Pattern };
+import { ActionConstraints, OptionsConstraints, ShortcutConstraints, ViewConstraints } from '@slack/bolt';
+export type Pattern = string | RegExp;
+export type ShortCutId = Pattern | ShortcutConstraints;
+export type ActionId = Pattern | ActionConstraints;
+export type ViewId = Pattern | ViewConstraints;
+export type OptionId = OptionsConstraints;
+export type AllConstraints = Pattern | ActionConstraints | ShortcutConstraints | ViewConstraints | OptionsConstraints;
+/**
+ * Create method decorator
+ * @param type type of listener
+ * @param event how to identify the event
+ */
+export declare function eventDecorator<T extends AllConstraints>(type: string, event: T): MethodDecorator;
 /**
  * @see https://tools.slack.dev/bolt-js/reference/
  */
@@ -20,7 +30,6 @@ export declare const EventTypes: {
  * @constructor
  */
 export declare function SlackEvent(event: string): MethodDecorator;
-export type ShortCutId = Pattern | ShortcutConstraints;
 /**
  * Decorator for shortcut events
  * @see guide https://tools.slack.dev/bolt-js/concepts/shortcuts
@@ -37,7 +46,6 @@ export declare function SlackShortcut(shortcutId: ShortCutId): MethodDecorator;
  * @constructor
  */
 export declare function SlackCommand(commandId: Pattern): MethodDecorator;
-export type ActionId = Pattern | ActionConstraints;
 /**
  * Decorator for action events
  * @see guide https://tools.slack.dev/bolt-js/concepts/actions
@@ -45,7 +53,6 @@ export type ActionId = Pattern | ActionConstraints;
  * @constructor
  */
 export declare function SlackAction(actionId: ActionId): MethodDecorator;
-export type ViewId = Pattern | ViewConstraints;
 /**
  * Decorator for view events
  * @see guide https://tools.slack.dev/bolt-js/concepts/view-submissions
@@ -53,7 +60,6 @@ export type ViewId = Pattern | ViewConstraints;
  * @constructor
  */
 export declare function SlackView(viewId: ViewId): MethodDecorator;
-export type OptionId = OptionsConstraints;
 /**
  * Decorator for options events
  * @see guide https://tools.slack.dev/bolt-js/concepts/options
@@ -69,4 +75,4 @@ export declare function SlackOption(optionId: OptionId): MethodDecorator;
  * @param pattern
  * @constructor
  */
-export declare function SlackMessage(pattern?: Pattern): MethodDecorator;
+export declare function SlackMessage(pattern?: string | RegExp): MethodDecorator;

package/decorators.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventTypes = void 0;
+exports.eventDecorator = eventDecorator;
 exports.SlackEvent = SlackEvent;
 exports.SlackShortcut = SlackShortcut;
 exports.SlackCommand = SlackCommand;
@@ -8,17 +9,37 @@ exports.SlackAction = SlackAction;
 exports.SlackView = SlackView;
 exports.SlackOption = SlackOption;
 exports.SlackMessage = SlackMessage;
-const utils_1 = require("./utils");
+const microservices_1 = require("@nestjs/microservices");
+const normalizePattern = (pattern) => {
+    if (typeof pattern === 'string') {
+        return pattern;
+    }
+    if (pattern instanceof RegExp) {
+        return pattern.toString();
+    }
+    return JSON.stringify(pattern);
+};
+/**
+ * Create method decorator
+ * @param type type of listener
+ * @param event how to identify the event
+ */
+function eventDecorator(type, event) {
+    return (target, key, descriptor) => (0, microservices_1.EventPattern)(`${type}://${normalizePattern(event)}`, {
+        type,
+        event,
+    })(target, key, descriptor);
+}
 /**
  * @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 event events
@@ -29,7 +50,10 @@ exports.EventTypes = {
  */
 function SlackEvent(event) {
     // todo input validation (types for event)
-    return (0, utils_1.eventDecorator)(exports.EventTypes.Event, event);
+    return (target, key, descriptor) => (0, microservices_1.EventPattern)(`${exports.EventTypes.Event}://${normalizePattern(event)}`, {
+        type: exports.EventTypes.Event,
+        event,
+    })(target, key, descriptor);
 }
 /**
  * Decorator for shortcut events
@@ -39,7 +63,7 @@ function SlackEvent(event) {
  * @constructor
  */
 function SlackShortcut(shortcutId) {
-    return (0, utils_1.eventDecorator)(exports.EventTypes.Shortcut, shortcutId);
+    return eventDecorator(exports.EventTypes.Shortcut, shortcutId);
 }
 /**
  * Decorator for command events
@@ -50,7 +74,7 @@ function SlackShortcut(shortcutId) {
  */
 function SlackCommand(commandId) {
     // todo input validation command must start with / etc.
-    return (0, utils_1.eventDecorator)(exports.EventTypes.Command, commandId);
+    return eventDecorator(exports.EventTypes.Command, commandId);
 }
 /**
  * Decorator for action events
@@ -59,7 +83,7 @@ function SlackCommand(commandId) {
  * @constructor
  */
 function SlackAction(actionId) {
-    return (0, utils_1.eventDecorator)(exports.EventTypes.Action, actionId);
+    return eventDecorator(exports.EventTypes.Action, actionId);
 }
 /**
  * Decorator for view events
@@ -68,7 +92,7 @@ function SlackAction(actionId) {
  * @constructor
  */
 function SlackView(viewId) {
-    return (0, utils_1.eventDecorator)(exports.EventTypes.View, viewId);
+    return eventDecorator(exports.EventTypes.View, viewId);
 }
 /**
  * Decorator for options events
@@ -77,7 +101,7 @@ function SlackView(viewId) {
  * @constructor
  */
 function SlackOption(optionId) {
-    return (0, utils_1.eventDecorator)(exports.EventTypes.Option, optionId);
+    return eventDecorator(exports.EventTypes.Option, optionId);
 }
 /**
  * Decorator for message events
@@ -87,6 +111,11 @@ function SlackOption(optionId) {
  * @param pattern
  * @constructor
  */
-function SlackMessage(pattern = "*") {
-    return (0, utils_1.messageDecorator)("message", pattern);
+function SlackMessage(pattern = '*') {
+    return (target, key, descriptor) => {
+        return (0, microservices_1.MessagePattern)(`message://${normalizePattern(pattern)}`, {
+            type: 'message',
+            pattern,
+        })(target, key, descriptor);
+    };
 }

package/index.d.ts

@@ -1,3 +1,3 @@
-import Slack from "./slack";
-export * from "./decorators";
+import Slack from './slack';
+export * from './decorators';
 export { Slack };

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@xpr/nestjs-slack",
-  "version": "0.0.0",
+  "version": "0.0.2",
   "description": "NestJS server implementation of the Slack Assistant",
   "main": "index.js",
   "scripts": {
-    "build": "tsc -p tsconfig-lib.json",
-    "postbuild": "cp package.json ../../dist/nestjs-slack/. && cp readme.md ../../dist/nestjs-slack/."
+    "build": "tsc -p tsconfig-lib.json && cp package.json ../../dist/nestjs-slack/. && cp readme.md ../../dist/nestjs-slack/."
   },
   "author": "Ziv Perry",
   "license": "MIT",

package/slack.d.ts

@@ -1,6 +1,6 @@
-import { type CustomTransportStrategy, type MessageHandler, Server } from "@nestjs/microservices";
-import { App, type AppOptions } from "@slack/bolt";
-export type SlackOptions = {
+import { type CustomTransportStrategy, type MessageHandler, Server } from '@nestjs/microservices';
+import { App, type AppOptions } from '@slack/bolt';
+export type SlackAssistantOptions = {
     /**
      * Slack application options with required types
      * @see https://github.com/slackapi/bolt-js
@@ -9,8 +9,8 @@ export type SlackOptions = {
 };
 export default class Slack extends Server implements CustomTransportStrategy {
     #private;
-    readonly options: SlackOptions;
-    constructor(options: SlackOptions);
+    readonly options: SlackAssistantOptions;
+    constructor(options: SlackAssistantOptions);
     listen(callback: () => void): Promise<void>;
     close(): Promise<void>;
     on(): void;
@@ -22,7 +22,7 @@ export default class Slack extends Server implements CustomTransportStrategy {
      */
     protected register(handler: MessageHandler): void;
     /**
-     * Get/Create Bolt app instance
+     * Get the Bolt app instance
      * @protected
      */
     protected app(): App;

package/slack.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const microservices_1 = require("@nestjs/microservices");
 const bolt_1 = require("@slack/bolt");
 const decorators_1 = require("./decorators");
-const utils_1 = require("./utils");
 class Slack extends microservices_1.Server {
     options;
     #app;
@@ -14,20 +13,20 @@ 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();
     }
     async close() {
-        this.#app && (await this.#app.stop());
+        // this.#app && (await this.#app.stop());
     }
+    // todo web-client/WebClient events for better typing of the event argument
     on() {
-        throw new Error("Use SlackEvent decorator to register events");
+        throw new Error('Use SlackEvent decorator to register events');
     }
     unwrap() {
-        return this.#app;
+        // return this.#app as T;
+        throw new Error('Use SlackEvent decorator to register events');
     }
     /**
      * Register the handler for the event
@@ -51,17 +50,13 @@ class Slack extends microservices_1.Server {
         }
     }
     /**
-     * Get/Create Bolt app instance
+     * Get the Bolt app instance
      * @protected
      */
     app() {
         if (!this.#app) {
-            // make sure to add logger if not provided
-            if (!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,15 +0,0 @@
-import { type Logger } from "@slack/bolt";
-export type Pattern = string | RegExp;
-/**
- * Create method decorator
- * @param type type of listener
- * @param event how to identify the event
- */
-export declare function eventDecorator<T>(type: string, event: T): MethodDecorator;
-/**
- * Create method decorator
- * @param type type of listener
- * @param pattern how to identify the message
- */
-export declare function messageDecorator(type: string, pattern: Pattern): MethodDecorator;
-export declare function adjustLogger(logger: any): Logger;

package/utils.js

@@ -1,65 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.eventDecorator = eventDecorator;
-exports.messageDecorator = messageDecorator;
-exports.adjustLogger = adjustLogger;
-const microservices_1 = require("@nestjs/microservices");
-const bolt_1 = require("@slack/bolt");
-const normalizePattern = (pattern) => {
-    if (typeof pattern === "string") {
-        return pattern;
-    }
-    if (pattern instanceof RegExp) {
-        return pattern.toString();
-    }
-    return JSON.stringify(pattern);
-};
-/**
- * Create method decorator
- * @param type type of listener
- * @param event how to identify the event
- */
-function eventDecorator(type, event) {
-    return (target, key, descriptor) => (0, microservices_1.EventPattern)(`${type}://${normalizePattern(event)}`, {
-        type,
-        event,
-    })(target, key, descriptor);
-}
-/**
- * Create method decorator
- * @param type type of listener
- * @param pattern how to identify the message
- */
-function messageDecorator(type, pattern) {
-    return (target, key, descriptor) => (0, microservices_1.MessagePattern)(`${type}://${normalizePattern(pattern)}`, {
-        type,
-        pattern,
-    })(target, key, descriptor);
-}
-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);
-    }
-    // minimal logger interface required by @slack/bolt library
-    for (const method of ["debug", "info", "warn", "error"]) {
-        if (typeof logger[method] !== "function") {
-            throw new Error(`Logger must implement "${method}" method`);
-        }
-    }
-    return Object.assign(logger, {
-        setLevel(_) {
-            // don't allow library to set the level
-        },
-        setName(name) {
-            // search for all possible setName/setContext methods, use "noop" if none
-            (logger.setName ?? logger.setContext ?? ((i) => i))(name);
-        },
-        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;
-        },
-    });
-}