@commandkit/queue 0.1.0-dev.20250709035032

package/LICENSE

@@ -0,0 +1,11 @@
+Copyright 2025 Avraj Sahota
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the “Software”), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,54 @@
+# @commandkit/queue
+
+Service agnostic message queue api for commandkit
+
+## Installation
+
+```bash
+npm install @commandkit/queue
+```
+
+## Usage
+
+### Driver configuration
+
+#### `@discordjs/brokers`
+
+First you need to install the dependencies:
+
+```bash
+npm install @discordjs/brokers ioredis
+```
+
+```typescript
+import Redis from 'ioredis';
+import { PubSubRedisBroker } from '@discordjs/brokers';
+import { RedisPubSubDriver } from '@commandkit/queue/discordjs';
+import { setDriver } from '@commandkit/queue';
+
+const broker = new PubSubRedisBroker(new Redis());
+const driver = new RedisPubSubDriver(broker);
+
+setDriver(driver);
+```
+
+### Example of sending and receiving a message
+
+```typescript
+import { send, receive } from '@commandkit/queue';
+
+// publisher
+await send('topic', { message: 'Hello World!' });
+
+// subscriber
+await receive('topic', (m) => {
+    console.log(m.message); // "Hello World!"
+});
+```
+
+## Documentation
+https://commandkit.dev/docs/next/api-reference/queue
+
+## License
+
+MIT © Avraj Sahota

package/dist/discordjs/index.d.ts

@@ -0,0 +1,12 @@
+import type { Awaitable, MessageQueue } from '../driver';
+import type { PubSubRedisBroker } from '@discordjs/brokers';
+type Handler<TEvent extends Record<string, any> = Record<string, any>> = (message: TEvent[keyof TEvent]) => Awaitable<void>;
+export declare class RedisPubSubDriver<TEvent extends Record<string, any> = Record<string, any>> implements MessageQueue {
+    readonly broker: PubSubRedisBroker<TEvent>;
+    private handlers;
+    constructor(broker: PubSubRedisBroker<TEvent>);
+    send<T extends keyof TEvent>(topic: T, message: TEvent[T]): Promise<void>;
+    receive<T extends keyof TEvent>(topic: T, handler: Handler<TEvent>): Promise<void>;
+    close(): Promise<void>;
+}
+export {};

package/dist/discordjs/index.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisPubSubDriver = void 0;
+class RedisPubSubDriver {
+    constructor(broker) {
+        this.broker = broker;
+        this.handlers = new Map();
+    }
+    async send(topic, message) {
+        await this.broker.publish(topic, message);
+    }
+    async receive(topic, handler) {
+        await this.broker.subscribe([topic]);
+        if (!this.handlers.has(topic)) {
+            const fn = async ({ data, ack }) => {
+                await handler(data);
+                void ack();
+            };
+            // @ts-ignore
+            this.broker.on(topic, fn);
+            this.handlers.set(topic, fn);
+        }
+    }
+    async close() {
+        for (const [topic, handler] of this.handlers) {
+            // @ts-ignore
+            this.broker.removeListener(topic, handler);
+        }
+        this.handlers.clear();
+        await this.broker.destroy();
+    }
+}
+exports.RedisPubSubDriver = RedisPubSubDriver;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZGlzY29yZGpzL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQWVBLE1BQWEsaUJBQWlCO0lBSzVCLFlBQW1DLE1BQWlDO1FBQWpDLFdBQU0sR0FBTixNQUFNLENBQTJCO1FBRDVELGFBQVEsR0FBRyxJQUFJLEdBQUcsRUFBZ0MsQ0FBQztJQUNZLENBQUM7SUFFakUsS0FBSyxDQUFDLElBQUksQ0FDZixLQUFRLEVBQ1IsT0FBa0I7UUFFbEIsTUFBTSxJQUFJLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxLQUFLLEVBQUUsT0FBTyxDQUFDLENBQUM7SUFDNUMsQ0FBQztJQUVNLEtBQUssQ0FBQyxPQUFPLENBQ2xCLEtBQVEsRUFDUixPQUF3QjtRQUV4QixNQUFNLElBQUksQ0FBQyxNQUFNLENBQUMsU0FBUyxDQUFDLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQztRQUVyQyxJQUFJLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztZQUM5QixNQUFNLEVBQUUsR0FBbUIsS0FBSyxFQUFFLEVBQUUsSUFBSSxFQUFFLEdBQUcsRUFBRSxFQUFFLEVBQUU7Z0JBQ2pELE1BQU0sT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO2dCQUNwQixLQUFLLEdBQUcsRUFBRSxDQUFDO1lBQ2IsQ0FBQyxDQUFDO1lBRUYsYUFBYTtZQUNiLElBQUksQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDLEtBQUssRUFBRSxFQUFFLENBQUMsQ0FBQztZQUMxQixJQUFJLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQUM7UUFDL0IsQ0FBQztJQUNILENBQUM7SUFFTSxLQUFLLENBQUMsS0FBSztRQUNoQixLQUFLLE1BQU0sQ0FBQyxLQUFLLEVBQUUsT0FBTyxDQUFDLElBQUksSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFDO1lBQzdDLGFBQWE7WUFDYixJQUFJLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxLQUFLLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDN0MsQ0FBQztRQUNELElBQUksQ0FBQyxRQUFRLENBQUMsS0FBSyxFQUFFLENBQUM7UUFFdEIsTUFBTSxJQUFJLENBQUMsTUFBTSxDQUFDLE9BQU8sRUFBRSxDQUFDO0lBQzlCLENBQUM7Q0FDRjtBQXpDRCw4Q0F5Q0MifQ==

package/dist/driver.d.ts

@@ -0,0 +1,6 @@
+export type Awaitable<T> = T | Promise<T>;
+export interface MessageQueue {
+    send(topic: string, message: any): Promise<void>;
+    receive(topic: string, handler: (message: any) => Awaitable<void>): Promise<void>;
+    close?(): Promise<void>;
+}

package/dist/driver.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZHJpdmVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2RyaXZlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import type { MessageQueue, Awaitable } from './driver';
+/**
+ * Set the message queue driver.
+ * @param driver The message queue driver to use.
+ */
+export declare function setDriver(driver: MessageQueue): void;
+/**
+ * Send a message to a topic.
+ * @param topic The topic to send the message to.
+ * @param message The message to send.
+ */
+export declare function send<T>(topic: string, message: T): Promise<void>;
+/**
+ * Receive a message from a topic.
+ * @param topic The topic to receive the message from.
+ * @param handler The handler to process the message.
+ */
+export declare function receive<T>(topic: string, handler: (message: T) => Awaitable<void>): Promise<void>;
+export * from './driver';

package/dist/index.js

@@ -0,0 +1,51 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setDriver = setDriver;
+exports.send = send;
+exports.receive = receive;
+let _driver = null;
+/**
+ * Set the message queue driver.
+ * @param driver The message queue driver to use.
+ */
+function setDriver(driver) {
+    _driver = driver;
+}
+/**
+ * Send a message to a topic.
+ * @param topic The topic to send the message to.
+ * @param message The message to send.
+ */
+function send(topic, message) {
+    if (!_driver) {
+        throw new Error('Message queue driver has not been set');
+    }
+    return _driver.send(topic, message);
+}
+/**
+ * Receive a message from a topic.
+ * @param topic The topic to receive the message from.
+ * @param handler The handler to process the message.
+ */
+function receive(topic, handler) {
+    if (!_driver) {
+        throw new Error('Message queue driver has not been set');
+    }
+    return _driver.receive(topic, handler);
+}
+__exportStar(require("./driver"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQVFBLDhCQUVDO0FBT0Qsb0JBTUM7QUFPRCwwQkFTQztBQXJDRCxJQUFJLE9BQU8sR0FBd0IsSUFBSSxDQUFDO0FBRXhDOzs7R0FHRztBQUNILFNBQWdCLFNBQVMsQ0FBQyxNQUFvQjtJQUM1QyxPQUFPLEdBQUcsTUFBTSxDQUFDO0FBQ25CLENBQUM7QUFFRDs7OztHQUlHO0FBQ0gsU0FBZ0IsSUFBSSxDQUFJLEtBQWEsRUFBRSxPQUFVO0lBQy9DLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztRQUNiLE1BQU0sSUFBSSxLQUFLLENBQUMsdUNBQXVDLENBQUMsQ0FBQztJQUMzRCxDQUFDO0lBRUQsT0FBTyxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxPQUFPLENBQUMsQ0FBQztBQUN0QyxDQUFDO0FBRUQ7Ozs7R0FJRztBQUNILFNBQWdCLE9BQU8sQ0FDckIsS0FBYSxFQUNiLE9BQXdDO0lBRXhDLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztRQUNiLE1BQU0sSUFBSSxLQUFLLENBQUMsdUNBQXVDLENBQUMsQ0FBQztJQUMzRCxDQUFDO0lBRUQsT0FBTyxPQUFPLENBQUMsT0FBTyxDQUFDLEtBQUssRUFBRSxPQUFPLENBQUMsQ0FBQztBQUN6QyxDQUFDO0FBRUQsMkNBQXlCIn0=

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@commandkit/queue",
+  "version": "0.1.0-dev.20250709035032",
+  "description": "Service agnostic message queue api for commandkit",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./discordjs": {
+      "types": "./dist/discordjs/index.d.ts",
+      "import": "./dist/discordjs/index.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/underctrl-io/commandkit.git",
+    "directory": "packages/queue"
+  },
+  "keywords": [
+    "commandkit",
+    "queue"
+  ],
+  "contributors": [
+    "Twilight <hello@twlite.dev>",
+    "Avraj <avraj@underctrl.io>"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/underctrl-io/commandkit/issues"
+  },
+  "homepage": "https://github.com/underctrl-io/commandkit#readme",
+  "devDependencies": {
+    "@discordjs/brokers": "^1.0.0",
+    "typescript": "^5.8.3",
+    "tsconfig": "0.0.0-dev.20250709035032"
+  },
+  "scripts": {
+    "lint": "tsc --noEmit",
+    "build": "tsc"
+  }
+}