winston-discordjs 2.1.0 → 4.0.0

package/README.md

@@ -9,7 +9,7 @@ A Winston transport using Discord.js, written in TypeScript
 
 ## Requirements
 
-- Node.js 12+
+- Node.js 16.6+
 
 ## Usage
 

package/dist/DiscordTransport.js

@@ -7,31 +7,25 @@ exports.DiscordTransport = void 0;
 const discord_js_1 = require("discord.js");
 const winston_transport_1 = __importDefault(require("winston-transport"));
 const LogHandlers_1 = require("./LogHandlers");
-const deprecationMessage = `Passing in a 'string' for { discordToken } is now deprecated, due to changes in Discord.js API. Please use a different initialization method.`;
 class DiscordTransport extends winston_transport_1.default {
     constructor(opts) {
         super(opts);
         if (opts) {
-            const { discordChannel, discordToken } = opts;
+            const { discordChannel, discordToken, intents = [] } = opts;
             if (opts.discordClient) {
                 this.discordClient = opts.discordClient;
             }
             else {
                 if (discordToken) {
-                    this.discordClient = new discord_js_1.Client();
+                    this.discordClient = new discord_js_1.Client({ intents });
                     this.discordClient.on("error", (error) => {
                         this.emit("warn", error);
                     });
                     this.discordClient.login(discordToken);
                 }
             }
-            if (discordChannel) {
-                if (discordChannel instanceof discord_js_1.TextChannel) {
-                    this.discordChannel = discordChannel;
-                }
-                else if (this.discordClient && typeof discordChannel === "string") {
-                    this.emit("warn", deprecationMessage);
-                }
+            if (discordChannel && discordChannel instanceof discord_js_1.TextChannel) {
+                this.discordChannel = discordChannel;
             }
         }
     }
@@ -40,29 +34,20 @@ class DiscordTransport extends winston_transport_1.default {
             this.emit("logged", info);
         });
         if (!this.silent && info) {
-            const logMessage = LogHandlers_1.handleInfo(info, this.format, this.level);
-            if (!this.discordChannel && this.discordClient && this.discordChannelId) {
-                this.emit("warn", deprecationMessage);
-                this.discordClient.channels
-                    .fetch(this.discordChannelId)
-                    .then((channel) => {
-                    if (channel instanceof discord_js_1.TextChannel) {
-                        this.discordChannel = channel;
-                    }
-                    else {
-                        this.emit("warn", `DiscordTransport received unexpected type of channel. Expected <${typeof discord_js_1.TextChannel}>, received: <${typeof channel}>`);
-                    }
-                })
-                    .catch((error) => {
-                    this.emit("warn", `DiscordTransport.log failed to initialize DiscordChannel with <${this.discordChannelId}>: ${error}`);
-                });
-            }
+            const logMessage = (0, LogHandlers_1.handleInfo)(info, this.format, this.level);
             if (this.discordChannel && logMessage) {
-                const messagePromise = logMessage instanceof Array
-                    ? this.discordChannel.send(logMessage[0], {
-                        embed: logMessage[1],
-                    })
-                    : this.discordChannel.send(logMessage);
+                let messagePromise;
+                if (Array.isArray(logMessage)) {
+                    const content = logMessage[0];
+                    const embed = logMessage[1];
+                    messagePromise = this.discordChannel.send({
+                        content,
+                        embeds: [embed],
+                    });
+                }
+                else {
+                    messagePromise = this.discordChannel.send(logMessage);
+                }
                 messagePromise.catch((error) => {
                     this.emit("warn", error);
                 });

package/dist/LogHandlers.js

@@ -4,9 +4,10 @@ exports.handleInfo = exports.handleObject = exports.handleLogform = exports.hand
 const utility_types_1 = require("utility-types");
 const discord_js_1 = require("discord.js");
 const LogLevels_1 = require("./LogLevels");
-exports.isTransformableInfo = (info) => {
+const isTransformableInfo = (info) => {
     return Boolean(info && "level" in info && "message" in info);
 };
+exports.isTransformableInfo = isTransformableInfo;
 const sortFields = (fields) => {
     const sortedFields = [];
     const timestampIndex = fields.findIndex((value) => value === "timestamp");
@@ -28,7 +29,7 @@ const sortFields = (fields) => {
     }
     return sortedFields;
 };
-exports.handlePrimitive = (info) => {
+const handlePrimitive = (info) => {
     switch (typeof info) {
         case "string": {
             return info;
@@ -38,13 +39,14 @@ exports.handlePrimitive = (info) => {
         }
     }
 };
-exports.handleLogform = (info, level) => {
-    var _a;
+exports.handlePrimitive = handlePrimitive;
+const handleLogform = (info, level) => {
     if ((level && level === info.level) || !level) {
         const messageEmbed = new discord_js_1.MessageEmbed();
         let logMessageString = "";
         const color = level
-            ? (_a = LogLevels_1.LogLevelToColor[level]) !== null && _a !== void 0 ? _a : "DEFAULT" : "DEFAULT";
+            ? LogLevels_1.LogLevelToColor[level] ?? "DEFAULT"
+            : "DEFAULT";
         messageEmbed.setColor(color);
         const fields = sortFields(Object.keys(info));
         for (const field of fields) {
@@ -57,32 +59,33 @@ exports.handleLogform = (info, level) => {
                 const capitalizedField = capitalize(field);
                 const value = info[field];
                 logMessageString += `${capitalizedField}: ${value}`;
-                messageEmbed.addField(capitalizedField, value, true);
+                messageEmbed.addField(capitalizedField, value.toString(), true);
             }
         }
         return [logMessageString, messageEmbed];
     }
     return undefined;
 };
-exports.handleObject = (info, format, level) => {
-    if (exports.isTransformableInfo(info)) {
+exports.handleLogform = handleLogform;
+const handleObject = (info, format, level) => {
+    if ((0, exports.isTransformableInfo)(info)) {
         if (format) {
             const formattedInfo = format.transform(info);
-            if (exports.isTransformableInfo(formattedInfo)) {
-                return exports.handleLogform(formattedInfo, level);
+            if ((0, exports.isTransformableInfo)(formattedInfo)) {
+                return (0, exports.handleLogform)(formattedInfo, level);
             }
             else {
-                return exports.handlePrimitive(formattedInfo);
+                return (0, exports.handlePrimitive)(formattedInfo);
             }
         }
         else {
-            return exports.handleLogform(info, level);
+            return (0, exports.handleLogform)(info, level);
         }
     }
     else if (info instanceof Error && info.stack) {
         return info.stack;
     }
-    else if (typeof (info === null || info === void 0 ? void 0 : info.toString) === "function" &&
+    else if (typeof info?.toString === "function" &&
         info.toString !== Object.toString) {
         return info.toString();
     }
@@ -91,14 +94,16 @@ exports.handleObject = (info, format, level) => {
         return JSON.stringify(info);
     }
 };
-exports.handleInfo = (info, format, level) => {
-    if (utility_types_1.isPrimitive(info)) {
-        return exports.handlePrimitive(info);
+exports.handleObject = handleObject;
+const handleInfo = (info, format, level) => {
+    if ((0, utility_types_1.isPrimitive)(info)) {
+        return (0, exports.handlePrimitive)(info);
     }
     else if (typeof info === "function") {
-        return exports.handleInfo(info(), format, level);
+        return (0, exports.handleInfo)(info(), format, level);
     }
     else {
-        return exports.handleObject(info, format, level);
+        return (0, exports.handleObject)(info, format, level);
     }
 };
+exports.handleInfo = handleInfo;

package/package.json

@@ -2,48 +2,44 @@
   "author": "Robert Smieja",
   "bugs": "https://github.com/robbot-discord/winston-discordjs/issues",
   "dependencies": {
-    "@types/ws": "^7.2.4",
-    "discord.js": "^12.2.0",
-    "logform": "^2.1.2",
+    "@types/ws": "^8.5.3",
+    "logform": "^2.4.2",
     "utility-types": "^3.10.0",
-    "winston": "^3.2.1",
-    "winston-transport": "^4.3.0"
+    "winston-transport": "^4.5.0"
+  },
+  "peerDependencies": {
+    "discord.js": "^13.8.1"
   },
   "description": "Winston Transport using Discord.js",
   "devDependencies": {
-    "@babel/core": "^7.9.6",
-    "@babel/preset-env": "^7.9.6",
-    "@babel/preset-typescript": "^7.9.0",
-    "@types/jest": "^25.2.3",
-    "@types/node": "^14.0.4",
-    "@typescript-eslint/eslint-plugin": "^2.34.0",
-    "@typescript-eslint/parser": "^2.34.0",
-    "eslint": "^7.0.0",
-    "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-prettier": "^3.1.3",
-    "husky": "^4.2.5",
-    "jest": "^26.0.1",
-    "lint-staged": "^10.2.4",
+    "@babel/core": "^7.18.6",
+    "@babel/preset-env": "^7.18.6",
+    "@babel/preset-typescript": "^7.18.6",
+    "@tsconfig/node16": "^1.0.3",
+    "@types/jest": "^28.1.4",
+    "@types/node": "^18.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.30.6",
+    "@typescript-eslint/parser": "^5.30.6",
+    "eslint": "^8.19.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-jest": "^26.5.3",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.1",
+    "jest": "^28.1.2",
+    "lint-staged": "^13.0.3",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.0.5",
+    "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
-    "ts-jest": "26.0.0",
-    "typescript": "^3.9.3"
+    "ts-jest": "28.0.5",
+    "typescript": "^4.7.4"
   },
   "engines": {
-    "node": ">=12",
-    "npm": ">=6"
+    "node": ">=16.6",
+    "npm": ">=8"
   },
   "files": [
     "dist"
   ],
-  "husky": {
-    "hooks": {
-      "pre-commit": [
-        "lint-staged"
-      ]
-    }
-  },
   "keywords": [
     "typescript",
     "nodejs",
@@ -54,14 +50,6 @@
     "transport"
   ],
   "license": "MIT",
-  "lint-staged": {
-    "*.{js,ts,jsx,tsx,json,md}": [
-      "prettier --write"
-    ],
-    "src/*.{js,ts,jsx,tsx}": [
-      "eslint --fix"
-    ]
-  },
   "main": "dist/index.js",
   "name": "winston-discordjs",
   "private": false,
@@ -70,6 +58,7 @@
     "build": "npm-run-all --parallel build:js lint",
     "build:js": "tsc",
     "clean": "rimraf dist/",
+    "check": "npm-run-all --parallel lint typecheck",
     "lint": "eslint ./src/**/*",
     "lint:fix": "eslint --fix ./src/**/*",
     "lint:staged": "lint-staged",
@@ -78,8 +67,10 @@
     "prepublishOnly": "npm-run-all --parallel test lint",
     "prettier": "prettier --write '*.{js,ts,jsx,tsx,json,md}'",
     "test": "jest",
-    "version": "npm run lint:fix && git add -A src"
+    "typecheck": "tsc --noEmit",
+    "version": "npm run lint:fix && git add -A src",
+    "prepare": "husky install"
   },
   "types": "dist/index.d.ts",
-  "version": "2.1.0"
+  "version": "4.0.0"
 }

package/dist/DiscordTransport.d.ts

@@ -1,20 +0,0 @@
-import Transport from "winston-transport";
-import { TextChannel, Client } from "discord.js";
-import TransportStream from "winston-transport";
-export interface DiscordTransportStreamOptions extends Transport.TransportStreamOptions {
-    discordClient?: Client;
-    discordToken?: string;
-    discordChannel?: string | TextChannel;
-}
-export declare class DiscordTransport extends TransportStream {
-    discordChannel?: TextChannel;
-    discordClient?: Client;
-    /**
-     * @deprecated This is a new field to assist in deprecating discordChannel gracefully. Will be removed in the next major version
-     */
-    discordChannelId?: string;
-    constructor(opts?: DiscordTransportStreamOptions);
-    log(info: any, callback?: () => void): void;
-    close(): void;
-}
-export default DiscordTransport;

package/dist/LogHandlers.d.ts

@@ -1,8 +0,0 @@
-import { TransformableInfo, Format } from "logform";
-import { Primitive } from "utility-types";
-import { MessageEmbed } from "discord.js";
-export declare const isTransformableInfo: (info: any) => info is TransformableInfo;
-export declare const handlePrimitive: (info: Primitive) => string;
-export declare const handleLogform: (info: TransformableInfo, level?: string | undefined) => [string, MessageEmbed] | undefined;
-export declare const handleObject: (info: Exclude<any, Primitive>, format?: Format | undefined, level?: string | undefined) => string | [string, MessageEmbed] | undefined;
-export declare const handleInfo: (info: any, format?: Format | undefined, level?: string | undefined) => string | [string, MessageEmbed] | undefined;

package/dist/LogLevels.d.ts

@@ -1,3 +0,0 @@
-import { ColorResolvable } from "discord.js";
-export declare type LogLevel = "emerg" | "alert" | "crit" | "error" | "warning" | "notice" | "info" | "debug";
-export declare const LogLevelToColor: Record<LogLevel, ColorResolvable>;

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-import DiscordTransport from "./DiscordTransport";
-export default DiscordTransport;