jaypie 1.0.2 → 1.0.3

package/README.md

@@ -97,6 +97,30 @@ _A `@jaypie/cdk` package is intended_
 
 ### AWS
 
+```javascript
+import { 
+  getMessages,
+  getSecret,
+  sendBatchMessages,
+  sendMessage,
+} from "jaypie";
+```
+
+#### `getMessages(event)`
+
+Return an array of message bodies from an SQS event.
+
+```javascript
+import { getMessages } from '@jaypie/aws';
+
+const messages = getMessages(event);
+// messages = [{ salutation: "Hello, world!" }, { salutation: "Hola, dushi!" }]
+```
+
+#### `getSecret(secretName: string)`
+
+Retrieve a secret from AWS Secrets Manager using the secret name.
+
 ```javascript
 import { getSecret } from '@jaypie/aws';
 
@@ -104,6 +128,51 @@ const secret = await getSecret("MongoConnectionStringN0NC3-nSg1bR1sh");
 // secret = "mongodb+srv://username:password@env-project.n0nc3.mongodb.net/app?retryWrites=true&w=majority";
 ```
 
+#### `sendBatchMessages({ messages, queueUrl })`
+
+Batch and send messages to an SQS queue. If more than ten messages are provided, the function will batch them into groups of ten or less (per AWS).
+
+```javascript
+import { sendBatchMessages } from '@jaypie/aws';
+
+const messages = [
+  { salutation: "Hello, world!" },
+  { salutation: "Hola, dushi!" },
+];
+const queueUrl = "https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue";
+
+await sendBatchMessages({ messages, queueUrl });
+```
+
+| Parameter | Type | Required | Description |
+| --------- | ---- | -------- | ----------- |
+| `delaySeconds` | `number` | No | Seconds to delay message delivery; default `0` |
+| `messages` | `Array` | Yes | Array of message objects (or strings) |
+| `messageAttributes` | `object` | No | Message attributes |
+| `messageGroupId` | `string` | No | Custom message group for FIFO queues; default provided |
+| `queueUrl` | `string` | Yes | URL of the SQS queue |
+
+#### `sendMessage({ body, queueUrl })`
+
+Send a single message to an SQS queue.
+
+```javascript
+import { sendMessage } from '@jaypie/aws';
+
+const body = "Hello, world!";
+const queueUrl = "https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue";
+
+const response = await sendMessage({ body, queueUrl });
+```
+
+| Parameter | Type | Required | Description |
+| --------- | ---- | -------- | ----------- |
+| `body` | `string` | Yes | Message body |
+| `delaySeconds` | `number` | No | Seconds to delay message delivery; default `0` |
+| `messageAttributes` | `object` | No | Message attributes |
+| `messageGroupId` | `string` | No | Custom message group for FIFO queues; default provided |
+| `queueUrl` | `string` | Yes | URL of the SQS queue |
+
 ### Constants
 
 ```javascript
@@ -464,6 +533,28 @@ log.lib().trace();
 log.lib({ lib: "myLib" }).trace();
 ```
 
+##### log.tag(key, value) or log.tag({ key: value })
+
+Permanently add the key-value pair to the logger's tags, or at least until `log.untag(key)` is called.
+
+```javascript
+import { log } from "jaypie";
+
+log.tag("myTag", "myValue");
+log.tag({ myTag: "myValue" });
+```
+
+##### log.untag(key) or log.untag([key1, key2, ...])
+
+Remove the key-value pair from the logger's tags.
+
+```javascript
+import { log } from "jaypie";
+
+log.untag("myTag");
+log.untag(["myTag1", "myTag2"]);
+```
+
 ##### log.var(key, value) or log.var({ key: value })
 
 Log a key-value pair. In the `json` format, the key will be tagged as `var` and the value will be the value. Logging marker variables this way can be useful for debugging.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jaypie",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "author": "Finlayson Studio",
   "type": "module",
   "main": "src/index.js",
@@ -20,7 +20,7 @@
     "@jaypie/core": "^1.0.2"
   },
   "devDependencies": {
-    "@jaypie/testkit": "^1.0.3",
+    "@jaypie/testkit": "^1.0.4",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
@@ -33,8 +33,8 @@
     "vitest": "^1.4.0"
   },
   "peerDependencies": {
-    "@jaypie/aws": "^1.0.0",
-    "@jaypie/lambda": "^1.0.0",
+    "@jaypie/aws": "^1.0.1",
+    "@jaypie/lambda": "^1.0.1",
     "@jaypie/mongoose": "^1.0.0"
   },
   "peerDependenciesMeta": {

package/src/aws.package.js

@@ -7,6 +7,6 @@ import dynamicExport from "./dynamicExport.function.js";
 //
 
 export const { getSecret } = await dynamicExport({
-  functions: ["getSecret"],
+  functions: ["getMessages", "getSecret", "sendBatchMessages", "sendMessage"],
   moduleImport: JAYPIE.LIB.AWS,
 });