necord 6.9.1 → 6.10.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [6.10.0](https://github.com/necordjs/necord/compare/v6.9.1...v6.10.0) (2025-08-28)
+
+### Features
+
+* add custom listener decorator helpers ([ab0c4d0](https://github.com/necordjs/necord/commit/ab0c4d04347b067104253820aa486197aed7b284))
+
 ## [6.9.1](https://github.com/necordjs/necord/compare/v6.9.0...v6.9.1) (2025-07-17)
 
 ## [6.9.0](https://github.com/necordjs/necord/compare/v6.8.14...v6.9.0) (2025-07-12)

package/coverage/clover.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1745497512895" clover="3.2.0">
-  <project timestamp="1745497512895" name="All files">
+<coverage generated="1756420753253" clover="3.2.0">
+  <project timestamp="1756420753253" name="All files">
     <metrics statements="0" coveredstatements="0" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0" elements="0" coveredelements="0" complexity="0" loc="0" ncloc="0" packages="0" files="0" classes="0"/>
   </project>
 </coverage>

package/coverage/lcov-report/index.html

@@ -86,7 +86,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2025-04-24T12:25:12.891Z
+                at 2025-08-28T22:39:13.250Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/dist/listeners/decorators/on.decorator.d.ts

@@ -1,8 +1,36 @@
+import { Listener } from './listener.decorator';
 import { NecordEvents } from '../listener.interface';
 /**
- * Decorator that marks a method as a listener for discord.js client.
+ * Decorator that marks a method as a listener for the discord.js client.
  * @param event The event name.
  * @returns The decorated method.
  * @url https://necord.org/listeners
  */
-export declare const On: <K extends keyof E, E = NecordEvents>(event: K) => import("@nestjs/common").CustomDecorator;
+export declare function On<E = NecordEvents>(event: keyof NoInfer<E>): ReturnType<typeof Listener>;
+/**
+ * @deprecated Use `On<CustomEvents>()` instead - This will be removed in future versions.
+ * Or use `createCustomOnDecorator<CustomEvents>()` to create a custom `On` decorator.
+ */
+export declare function On<K extends keyof E, E = NecordEvents>(event: K): ReturnType<typeof Listener>;
+/**
+ * Helper to create a strongly typed `On` decorator for custom events.
+ * This is useful when you have custom events that are not part of the default `NecordEvents`.
+ * @example
+ * ```typescript
+ * interface CustomEvents {
+ *  myCustomEvent: [string, number];
+ *  anotherEvent: [boolean];
+ * }
+ *
+ * const OnCustom = createCustomOnDecorator<CustomEvents>();
+ *
+ * class MyListener {
+ *  @OnCustom('myCustomEvent')
+ *  handleMyCustomEvent(@Context() [name, age]: [string, number]) {
+ *   console.log(`Name: ${name}, Age: ${age}`);
+ *  }
+ * }
+ *```
+ * @returns A strongly typed `On` decorator for custom events.
+ */
+export declare function createCustomOnDecorator<Events>(): <K extends keyof Events>(event: K) => import("@nestjs/common").CustomDecorator;

package/dist/listeners/decorators/on.decorator.js

@@ -1,12 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.On = void 0;
+exports.On = On;
+exports.createCustomOnDecorator = createCustomOnDecorator;
 const listener_decorator_1 = require("./listener.decorator");
+function On(event) {
+    return (0, listener_decorator_1.Listener)({ type: 'on', event });
+}
 /**
- * Decorator that marks a method as a listener for discord.js client.
- * @param event The event name.
- * @returns The decorated method.
- * @url https://necord.org/listeners
+ * Helper to create a strongly typed `On` decorator for custom events.
+ * This is useful when you have custom events that are not part of the default `NecordEvents`.
+ * @example
+ * ```typescript
+ * interface CustomEvents {
+ *  myCustomEvent: [string, number];
+ *  anotherEvent: [boolean];
+ * }
+ *
+ * const OnCustom = createCustomOnDecorator<CustomEvents>();
+ *
+ * class MyListener {
+ *  @OnCustom('myCustomEvent')
+ *  handleMyCustomEvent(@Context() [name, age]: [string, number]) {
+ *   console.log(`Name: ${name}, Age: ${age}`);
+ *  }
+ * }
+ *```
+ * @returns A strongly typed `On` decorator for custom events.
  */
-const On = (event) => (0, listener_decorator_1.Listener)({ type: 'on', event });
-exports.On = On;
+function createCustomOnDecorator() {
+    return (event) => On(event);
+}

package/dist/listeners/decorators/once.decorator.d.ts

@@ -1,3 +1,4 @@
+import { Listener } from './listener.decorator';
 import { NecordEvents } from '../listener.interface';
 /**
  * Decorator that marks a method as a listener for discord.js client.
@@ -5,4 +6,31 @@ import { NecordEvents } from '../listener.interface';
  * @returns The decorated method.
  * @url https://necord.org/listeners
  */
-export declare const Once: <K extends keyof E, E = NecordEvents>(event: K) => import("@nestjs/common").CustomDecorator;
+export declare function Once<E = NecordEvents>(event: keyof NoInfer<E>): ReturnType<typeof Listener>;
+/**
+ * @deprecated Use `Once<CustomEvents>()` instead - This will be removed in future versions.
+ * Or use `createCustomOnceDecorator<CustomEvents>()` to create a custom `Once` decorator.
+ */
+export declare function Once<K extends keyof E, E = NecordEvents>(event: K): ReturnType<typeof Listener>;
+/**
+ * Helper to create a strongly typed `Once` decorator for custom events.
+ * This is useful when you have custom events that are not part of the default `NecordEvents`.
+ * @example
+ * ```typescript
+ * interface CustomEvents {
+ *  myCustomEvent: [string, number];
+ *  anotherEvent: [boolean];
+ * }
+ *
+ * const OnceCustom = createCustomOnceDecorator<CustomEvents>();
+ *
+ * class MyListener {
+ *  @OnceCustom('myCustomEvent')
+ *  handleMyCustomEvent(@Context() [name, age]: [string, number]) {
+ *   console.log(`Name: ${name}, Age: ${age}`);
+ *  }
+ * }
+ *```
+ * @returns A strongly typed `Once` decorator for custom events.
+ */
+export declare function createCustomOnceDecorator<Events>(): <K extends keyof Events>(event: K) => import("@nestjs/common").CustomDecorator;

package/dist/listeners/decorators/once.decorator.js

@@ -1,12 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Once = void 0;
+exports.Once = Once;
+exports.createCustomOnceDecorator = createCustomOnceDecorator;
 const listener_decorator_1 = require("./listener.decorator");
+function Once(event) {
+    return (0, listener_decorator_1.Listener)({ type: 'once', event });
+}
 /**
- * Decorator that marks a method as a listener for discord.js client.
- * @param event
- * @returns The decorated method.
- * @url https://necord.org/listeners
+ * Helper to create a strongly typed `Once` decorator for custom events.
+ * This is useful when you have custom events that are not part of the default `NecordEvents`.
+ * @example
+ * ```typescript
+ * interface CustomEvents {
+ *  myCustomEvent: [string, number];
+ *  anotherEvent: [boolean];
+ * }
+ *
+ * const OnceCustom = createCustomOnceDecorator<CustomEvents>();
+ *
+ * class MyListener {
+ *  @OnceCustom('myCustomEvent')
+ *  handleMyCustomEvent(@Context() [name, age]: [string, number]) {
+ *   console.log(`Name: ${name}, Age: ${age}`);
+ *  }
+ * }
+ *```
+ * @returns A strongly typed `Once` decorator for custom events.
  */
-const Once = (event) => (0, listener_decorator_1.Listener)({ type: 'once', event });
-exports.Once = Once;
+function createCustomOnceDecorator() {
+    return (event) => Once(event);
+}

package/jest.config.json

@@ -0,0 +1,16 @@
+{
+	"moduleFileExtensions": [
+		"js",
+		"json",
+		"ts"
+	],
+	"testRegex": ".*\\.spec\\.ts$",
+	"transform": {
+		"^.+\\.(t|j)s$": "ts-jest"
+	},
+	"testEnvironment": "node",
+	"coverageDirectory": "./coverage",
+	"collectCoverageFrom": [
+		"src/**/*.ts"
+	]
+}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "necord",
 	"description": "A module for creating Discord bots using NestJS, based on Discord.js",
-	"version": "6.9.1",
+	"version": "6.10.0",
 	"scripts": {
 		"build": "rimraf dist && tsc -p tsconfig.build.json",
 		"prepublish:npm": "npm run build",
@@ -10,10 +10,17 @@
 		"publish:dev": "npm publish --access public --tag dev",
 		"prepare": "husky",
 		"format": "prettier --write \"src/**/*.ts\"",
-		"lint": "eslint --ignore-pattern .gitignore src/**/*.ts"
+		"lint": "eslint --ignore-pattern .gitignore src/**/*.ts",
+		"test": "jest",
+		"test:watch": "jest --watch",
+		"test:cov": "jest --coverage",
+		"test:ci": "jest --ci --passWithNoTests --coverage"
 	},
 	"lint-staged": {
-		"*.ts": "npm run format"
+		"*.ts": [
+			"npm run format",
+			"npm run test:ci"
+		]
 	},
 	"directories": {
 		"lib": "src",
@@ -59,26 +66,30 @@
 		"@eslint/eslintrc": "^3.2.0",
 		"@eslint/js": "^9.18.0",
 		"@favware/npm-deprecate": "2.0.0",
-		"@nestjs/common": "11.1.4",
-		"@nestjs/core": "11.1.4",
+		"@nestjs/common": "11.1.6",
+		"@nestjs/core": "11.1.6",
+		"@nestjs/testing": "^11.1.5",
 		"@release-it/conventional-changelog": "^10.0.0",
-		"@types/node": "24.0.14",
-		"discord-api-types": "0.38.16",
-		"discord.js": "14.21.0",
+		"@types/jest": "^30.0.0",
+		"@types/node": "24.3.0",
+		"discord-api-types": "0.38.21",
+		"discord.js": "14.22.1",
 		"eslint": "^9.18.0",
-		"eslint-config-prettier": "10.1.5",
+		"eslint-config-prettier": "10.1.8",
 		"eslint-plugin-import": "^2.31.0",
-		"eslint-plugin-prettier": "5.5.1",
+		"eslint-plugin-prettier": "5.5.4",
 		"globals": "^16.0.0",
 		"husky": "9.1.7",
-		"lint-staged": "16.1.2",
+		"jest": "^30.0.5",
+		"lint-staged": "16.1.5",
 		"prettier": "3.6.2",
 		"reflect-metadata": "0.2.2",
 		"release-it": "19.0.4",
 		"rimraf": "6.0.1",
 		"rxjs": "7.8.2",
+		"ts-jest": "^29.4.1",
 		"ts-node": "10.9.2",
-		"typescript": "5.8.3",
+		"typescript": "5.9.2",
 		"typescript-eslint": "^8.21.0"
 	},
 	"peerDependencies": {