qrusty-client 0.1.0 → 0.3.0

package/README.md

@@ -18,13 +18,16 @@ npm install qrusty-client
 ## Usage
 
 ```js
-const QrustyClient = require('qrusty-client');
-const client = new QrustyClient('http://localhost:3000');
+const QrustyClient = require("qrusty-client");
+const client = new QrustyClient("http://localhost:6784");
 
 (async () => {
-  await client.publish('orders', 100, { order_id: 123 });
-  const msg = await client.consume('orders', 'worker-1');
-  await client.ack('orders', msg.id, 'worker-1');
+  await client.createQueue("orders", "MaxFirst", true);
+  await client.publish("orders", 100, { order_id: 123 });
+  const msg = await client.consume("orders", "worker-1");
+  if (msg) {
+    await client.ack("orders", msg.id, "worker-1");
+  }
 })();
 ```
 

package/index.js

@@ -2,84 +2,191 @@
  * QrustyClient - Node.js client for the qrusty priority queue API
  * @module QrustyClient
  */
-const axios = require('axios');
+const axios = require("axios");
 
 class QrustyClient {
-    /**
-     * Create a new QrustyClient
-     * @param {string} baseUrl - Base URL of the qrusty server
-     */
-    constructor(baseUrl) {
-        this.baseUrl = baseUrl.replace(/\/$/, '');
-    }
+  /**
+   * Create a new QrustyClient
+   * @param {string} baseUrl - Base URL of the qrusty server
+   */
+  constructor(baseUrl) {
+    this.baseUrl = baseUrl.replace(/\/$/, "");
+  }
 
-    /**
-     * Publish a message to a queue
-     * @param {string} queue
-     * @param {number} priority
-     * @param {object} payload
-     * @param {number} [maxRetries=3]
-     * @returns {Promise<object>}
-     */
-    async publish(queue, priority, payload, maxRetries = 3) {
-        const data = { queue, priority, payload, max_retries: maxRetries };
-        const resp = await axios.post(`${this.baseUrl}/publish`, data);
-        return resp.data;
-    }
+  /**
+   * Check server health
+   * @returns {Promise<string>}
+   */
+  async health() {
+    const resp = await axios.get(`${this.baseUrl}/health`);
+    return resp.data;
+  }
 
-    /**
-     * Consume a message from a queue
-     * @param {string} queue
-     * @param {string} consumerId
-     * @param {number} [timeoutSeconds=30]
-     * @returns {Promise<object>}
-     */
-    async consume(queue, consumerId, timeoutSeconds = 30) {
-        const data = { consumer_id: consumerId, timeout_seconds: timeoutSeconds };
-        const resp = await axios.post(`${this.baseUrl}/consume/${queue}`, data);
-        return resp.data;
-    }
+  /**
+   * Create or configure a queue
+   * @param {string} name
+   * @param {string} [ordering="MaxFirst"] - One of: Fifo | MinFirst | MaxFirst
+   * @param {boolean} [allowDuplicates=true]
+   * @returns {Promise<void>}
+   */
+  async createQueue(name, ordering = "MaxFirst", allowDuplicates = true) {
+    const data = {
+      name,
+      config: { ordering, allow_duplicates: allowDuplicates },
+    };
+    await axios.post(`${this.baseUrl}/create-queue`, data);
+  }
 
-    /**
-     * Acknowledge a message
-     * @param {string} queue
-     * @param {string} messageId
-     * @param {string} consumerId
-     * @returns {Promise<object>}
-     */
-    async ack(queue, messageId, consumerId) {
-        const data = { message_id: messageId, consumer_id: consumerId };
-        const resp = await axios.post(`${this.baseUrl}/ack/${queue}`, data);
-        return resp.data;
-    }
+  /**
+   * Update queue configuration (name and/or allow_duplicates)
+   * @param {string} name - Current queue name
+   * @param {string} [newName] - New name for the queue (optional)
+   * @param {boolean} [allowDuplicates] - New allow_duplicates setting (optional)
+   * @returns {Promise<void>}
+   */
+  async updateQueue(name, newName = undefined, allowDuplicates = undefined) {
+    const config = {};
+    if (newName !== undefined) config.name = newName;
+    if (allowDuplicates !== undefined)
+      config.allow_duplicates = allowDuplicates;
 
-    /**
-     * Purge a queue
-     * @param {string} queue
-     * @returns {Promise<object>}
-     */
-    async purge(queue) {
-        const resp = await axios.post(`${this.baseUrl}/purge-queue/${queue}`);
-        return resp.data;
+    if (Object.keys(config).length === 0) {
+      throw new Error(
+        "At least one of newName or allowDuplicates must be specified",
+      );
     }
 
-    /**
-     * Get stats for all queues
-     * @returns {Promise<object>}
-     */
-    async stats() {
-        const resp = await axios.get(`${this.baseUrl}/stats`);
-        return resp.data;
+    const data = { name, config };
+    await axios.post(`${this.baseUrl}/update-queue`, data);
+  }
+
+  /**
+   * Delete a queue and its messages
+   * @param {string} queue
+   * @returns {Promise<object>}
+   */
+  async deleteQueue(queue) {
+    const resp = await axios.delete(`${this.baseUrl}/delete-queue/${queue}`);
+    return resp.data;
+  }
+
+  /**
+   * Publish a message to a queue
+   * @param {string} queue
+   * @param {number} priority
+   * @param {object} payload
+   * @param {number} [maxRetries=3]
+   * @returns {Promise<object>}
+   */
+  async publish(queue, priority, payload, maxRetries = 3) {
+    const payloadStr =
+      typeof payload === "string" ? payload : JSON.stringify(payload);
+    const data = {
+      queue,
+      priority,
+      payload: payloadStr,
+      max_retries: maxRetries,
+    };
+    const resp = await axios.post(`${this.baseUrl}/publish`, data);
+    return resp.data;
+  }
+
+  /**
+   * Consume a message from a queue
+   * @param {string} queue
+   * @param {string} consumerId
+   * @param {number} [timeoutSeconds=30]
+   * @returns {Promise<object>}
+   */
+  async consume(queue, consumerId, timeoutSeconds = 30) {
+    const data = { consumer_id: consumerId, timeout_seconds: timeoutSeconds };
+    const resp = await axios.post(`${this.baseUrl}/consume/${queue}`, data);
+    return resp.data;
+  }
+
+  /**
+   * Acknowledge a message
+   * @param {string} queue
+   * @param {string} messageId
+   * @param {string} consumerId
+   * @returns {Promise<object>}
+   */
+  async ack(queue, messageId, consumerId) {
+    const data = { consumer_id: consumerId };
+    try {
+      await axios.post(`${this.baseUrl}/ack/${queue}/${messageId}`, data);
+      return true;
+    } catch (e) {
+      if (e?.response?.status === 404) return false;
+      throw e;
     }
+  }
 
-    /**
-     * List all queues
-     * @returns {Promise<object>}
-     */
-    async listQueues() {
-        const resp = await axios.get(`${this.baseUrl}/queues`);
-        return resp.data;
+  /**
+   * Negative-acknowledge a message
+   * @param {string} queue
+   * @param {string} messageId
+   * @param {string} consumerId
+   * @returns {Promise<boolean>} True if nack'd, false if not found
+   */
+  async nack(queue, messageId, consumerId) {
+    const data = { consumer_id: consumerId };
+    try {
+      await axios.post(`${this.baseUrl}/nack/${queue}/${messageId}`, data);
+      return true;
+    } catch (e) {
+      if (e?.response?.status === 404) return false;
+      throw e;
     }
+  }
+
+  /**
+   * Purge a queue
+   * @param {string} queue
+   * @returns {Promise<object>}
+   */
+  async purge(queue) {
+    const resp = await axios.post(`${this.baseUrl}/purge-queue/${queue}`);
+    return resp.data;
+  }
+
+  /**
+   * Get stats for all queues
+   * @returns {Promise<object>}
+   */
+  async stats() {
+    const resp = await axios.get(`${this.baseUrl}/stats`);
+    return resp.data;
+  }
+
+  /**
+   * Get statistics for a specific queue
+   * @param {string} queue
+   * @returns {Promise<object>}
+   */
+  async queueStats(queue) {
+    const resp = await axios.get(`${this.baseUrl}/queue-stats/${queue}`);
+    return resp.data;
+  }
+
+  /**
+   * Get time-series metrics for a queue
+   * @param {string} queue
+   * @returns {Promise<object>}
+   */
+  async queueMetrics(queue) {
+    const resp = await axios.get(`${this.baseUrl}/queues/${queue}/metrics`);
+    return resp.data;
+  }
+
+  /**
+   * List all queues
+   * @returns {Promise<object>}
+   */
+  async listQueues() {
+    const resp = await axios.get(`${this.baseUrl}/queues`);
+    return resp.data;
+  }
 }
 
 module.exports = QrustyClient;

package/package.json

@@ -1,19 +1,19 @@
 {
-    "name": "qrusty-client",
-    "version": "0.1.0",
-    "description": "Node.js client for the qrusty priority queue server API.",
-    "main": "index.js",
-    "author": "Gordon Greene <greeng3@obscure-reference.com>",
-    "license": "MIT",
-    "scripts": {
-        "test": "jest",
-        "docs": "jsdoc -c jsdoc.json"
-    },
-    "dependencies": {
-        "axios": "^1.6.7"
-    },
-    "devDependencies": {
-        "jest": "30.0.5",
-        "jsdoc": "^4.0.2"
-    }
-}
+  "name": "qrusty-client",
+  "version": "0.3.0",
+  "description": "Node.js client for the qrusty priority queue server API.",
+  "main": "index.js",
+  "author": "Gordon Greene <greeng3@obscure-reference.com>",
+  "license": "MIT",
+  "scripts": {
+    "test": "jest",
+    "docs": "jsdoc -c jsdoc.json"
+  },
+  "dependencies": {
+    "axios": "^1.13.2"
+  },
+  "devDependencies": {
+    "jest": "30.2.0",
+    "jsdoc": "^4.0.5"
+  }
+}