@efebia/sqs-queue-v2 0.0.8 → 0.0.10

package/README.md

@@ -0,0 +1,80 @@
+# @efebia/sqs-queue-v2
+
+AWS SQS queue consumer built on `@efebia/queue`, using the AWS SDK v2 (`aws-sdk`).
+
+> If you are starting a new project, prefer [`@efebia/sqs-queue-v3`](../sqs-queue-v3) which uses the modern modular AWS SDK v3.
+
+## Install
+
+```bash
+npm install @efebia/sqs-queue-v2
+```
+
+## Usage
+
+```ts
+import AWS from 'aws-sdk';
+import { Queue } from '@efebia/sqs-queue-v2';
+
+type MyMessage = { userId: string; action: string };
+
+const sqs = new AWS.SQS({ region: 'eu-west-1' });
+
+const queue = new Queue<MyMessage>({
+  client: sqs,
+  receiveOptions: {
+    QueueUrl: 'https://sqs.eu-west-1.amazonaws.com/123456789/my-queue',
+    WaitTimeSeconds: 20,
+    MaxNumberOfMessages: 1,
+  },
+  sleepTimeout: 5000,
+  logger: (obj, msg) => console.log(msg, obj),
+});
+
+// Start consuming
+queue.start(async (name, params, state) => {
+  console.log(`Received "${name}":`, params);
+  // set state.del = false to leave the message in the queue
+});
+
+// Send a message
+await queue.send({ name: 'doWork', params: { userId: '42', action: 'sync' } });
+
+// Stop the loop
+queue.stop();
+```
+
+## API
+
+### `new Queue<TMessage>(options)`
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `client` | `AWS.SQS` | — | **Required.** Configured SQS client instance |
+| `receiveOptions` | `AWS.SQS.ReceiveMessageRequest` | — | **Required.** Passed directly to `receiveMessage`. Must include `QueueUrl`. |
+| `receiveOptions.WaitTimeSeconds` | `number` | `20` | Long-polling wait time |
+| `receiveOptions.MaxNumberOfMessages` | `number` | `1` | Max messages per receive call |
+| `canRead` | `() => boolean \| Promise<boolean>` | `() => true` | Called before each receive; returning `false` skips the iteration |
+| `logger` | `(obj, msg?) => void` | no-op | Logging function for errors and warnings |
+| `sleepTimeout` | `number` | `5000` | Ms to wait after an error before retrying |
+| `errorCallback` | `(error) => void` | `console.error` | Called on uncaught errors in the loop |
+
+### Inherited from `@efebia/queue`
+
+- `start(callback, canThrow?)` — starts the polling loop
+- `stop()` — signals the loop to stop
+- `resume(callback)` — restarts a stopped queue
+- `isRunning()` — returns `true` if the loop is active
+- `send(message)` — sends a message (adds `createdAt` automatically)
+
+**Callback signature:**
+
+```ts
+(name: string, params: TMessage, state: { del: boolean }) => void | Promise<void>
+```
+
+After the callback resolves, the message is deleted from SQS unless `state.del` is set to `false`.
+
+## License
+
+MIT

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@efebia/sqs-queue-v2",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^18.11.18",
     "typescript": "~5.8.3"
   },
   "dependencies": {
-    "@efebia/queue": "^0.0.5",
+    "@efebia/queue": "^0.0.8",
     "aws-sdk": "^2.1292.0"
   },
   "files": [
@@ -16,5 +16,10 @@
   "scripts": {
     "build": "tsc"
   },
-  "main": "./lib"
+  "main": "./lib",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/efebia-com/be-libs.git",
+    "directory": "packages/sqs-queue-v2"
+  }
 }