flashq 0.3.2 → 0.3.4

package/dist/client/validation.js

@@ -0,0 +1,112 @@
+"use strict";
+/**
+ * Input validation utilities for FlashQ client.
+ *
+ * Provides validation functions for queue names, job data sizes,
+ * and batch operation limits.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_BATCH_SIZE = exports.MAX_JOB_DATA_SIZE = void 0;
+exports.validateQueueName = validateQueueName;
+exports.validateJobDataSize = validateJobDataSize;
+exports.validateBatchSize = validateBatchSize;
+exports.validateJobId = validateJobId;
+exports.validateTimeout = validateTimeout;
+const errors_1 = require("../errors");
+/** Maximum allowed job data size in bytes (1MB) */
+exports.MAX_JOB_DATA_SIZE = 1024 * 1024;
+/** Maximum number of jobs per batch operation */
+exports.MAX_BATCH_SIZE = 1000;
+/** Regex pattern for valid queue names: alphanumeric, underscore, hyphen, dot (1-256 chars) */
+const QUEUE_NAME_REGEX = /^[a-zA-Z0-9_.-]{1,256}$/;
+/**
+ * Validates a queue name against naming rules.
+ *
+ * Queue names must:
+ * - Be non-empty strings
+ * - Contain only alphanumeric characters, underscores, hyphens, or dots
+ * - Be between 1 and 256 characters long
+ *
+ * @param queue - The queue name to validate
+ * @throws ValidationError if the queue name is invalid
+ *
+ * @example
+ * ```typescript
+ * validateQueueName('my-queue');      // OK
+ * validateQueueName('queue.name');    // OK
+ * validateQueueName('queue name');    // Throws: contains space
+ * validateQueueName('');              // Throws: empty
+ * ```
+ */
+function validateQueueName(queue) {
+    if (!queue || typeof queue !== 'string') {
+        throw new errors_1.ValidationError('Queue name is required', 'queue');
+    }
+    if (!QUEUE_NAME_REGEX.test(queue)) {
+        throw new errors_1.ValidationError(`Invalid queue name: "${queue}". Must be alphanumeric, _, -, . (1-256 chars)`, 'queue');
+    }
+}
+/**
+ * Validates that job data does not exceed the maximum allowed size.
+ *
+ * The size is calculated by JSON-stringifying the data and measuring
+ * the resulting string length in bytes.
+ *
+ * @param data - The job data to validate
+ * @throws ValidationError if the data exceeds MAX_JOB_DATA_SIZE
+ *
+ * @example
+ * ```typescript
+ * validateJobDataSize({ small: 'data' });  // OK
+ * validateJobDataSize(largeBuffer);        // Throws if > 1MB
+ * ```
+ */
+function validateJobDataSize(data) {
+    const size = JSON.stringify(data).length;
+    if (size > exports.MAX_JOB_DATA_SIZE) {
+        throw new errors_1.ValidationError(`Job data size (${size} bytes) exceeds max (${exports.MAX_JOB_DATA_SIZE} bytes)`, 'data');
+    }
+}
+/**
+ * Validates batch operation size.
+ *
+ * @param count - Number of items in the batch
+ * @param operation - Name of the operation for error messages
+ * @throws ValidationError if count exceeds MAX_BATCH_SIZE
+ *
+ * @example
+ * ```typescript
+ * validateBatchSize(100, 'push');   // OK
+ * validateBatchSize(1500, 'push');  // Throws: exceeds 1000
+ * ```
+ */
+function validateBatchSize(count, operation) {
+    if (count > exports.MAX_BATCH_SIZE) {
+        throw new errors_1.ValidationError(`Batch ${operation} size (${count}) exceeds max (${exports.MAX_BATCH_SIZE})`, 'batch');
+    }
+}
+/**
+ * Validates a job ID is a positive integer.
+ *
+ * @param jobId - The job ID to validate
+ * @throws ValidationError if jobId is not a positive integer
+ */
+function validateJobId(jobId) {
+    if (!Number.isInteger(jobId) || jobId <= 0) {
+        throw new errors_1.ValidationError(`Invalid job ID: ${jobId}. Must be a positive integer`, 'jobId');
+    }
+}
+/**
+ * Validates a timeout value is within acceptable bounds.
+ *
+ * @param timeout - Timeout in milliseconds
+ * @param min - Minimum allowed value (default: 0)
+ * @param max - Maximum allowed value (default: 10 minutes)
+ * @throws ValidationError if timeout is out of bounds
+ */
+function validateTimeout(timeout, min = 0, max = 600000) {
+    if (timeout < min || timeout > max) {
+        throw new errors_1.ValidationError(`Timeout ${timeout}ms out of bounds (${min}-${max}ms)`, 'timeout');
+    }
+}
+//# sourceMappingURL=validation.js.map

package/dist/client/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/client/validation.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAgCH,8CAUC;AAiBD,kDAQC;AAeD,8CAOC;AAQD,sCAIC;AAUD,0CAOC;AApHD,sCAA4C;AAE5C,mDAAmD;AACtC,QAAA,iBAAiB,GAAG,IAAI,GAAG,IAAI,CAAC;AAE7C,iDAAiD;AACpC,QAAA,cAAc,GAAG,IAAI,CAAC;AAEnC,+FAA+F;AAC/F,MAAM,gBAAgB,GAAG,yBAAyB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,iBAAiB,CAAC,KAAa;IAC7C,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,MAAM,IAAI,wBAAe,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IACD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,wBAAe,CACvB,wBAAwB,KAAK,gDAAgD,EAC7E,OAAO,CACR,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,mBAAmB,CAAC,IAAa;IAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;IACzC,IAAI,IAAI,GAAG,yBAAiB,EAAE,CAAC;QAC7B,MAAM,IAAI,wBAAe,CACvB,kBAAkB,IAAI,wBAAwB,yBAAiB,SAAS,EACxE,MAAM,CACP,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,iBAAiB,CAAC,KAAa,EAAE,SAAiB;IAChE,IAAI,KAAK,GAAG,sBAAc,EAAE,CAAC;QAC3B,MAAM,IAAI,wBAAe,CACvB,SAAS,SAAS,UAAU,KAAK,kBAAkB,sBAAc,GAAG,EACpE,OAAO,CACR,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,KAAa;IACzC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,IAAI,wBAAe,CAAC,mBAAmB,KAAK,8BAA8B,EAAE,OAAO,CAAC,CAAC;IAC7F,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,eAAe,CAAC,OAAe,EAAE,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM;IACpE,IAAI,OAAO,GAAG,GAAG,IAAI,OAAO,GAAG,GAAG,EAAE,CAAC;QACnC,MAAM,IAAI,wBAAe,CACvB,WAAW,OAAO,qBAAqB,GAAG,IAAI,GAAG,KAAK,EACtD,SAAS,CACV,CAAC;IACJ,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flashq",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "Official TypeScript SDK for flashQ - High-Performance Job Queue (BullMQ-compatible API)",
   "author": "Egeo Minotti",
   "license": "MIT",