@aligent/aws-wrappers 0.0.1

package/docs/classes/S3Service.md

@@ -0,0 +1,389 @@
+[**@aligent/aws-wrappers**](../modules.md)
+
+***
+
+[@aligent/aws-wrappers](../modules.md) / S3Service
+
+# Class: S3Service
+
+Defined in: [s3/s3.ts:35](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/s3/s3.ts#L35)
+
+Wrapper around the AWS S3 client providing structured Powertools logging
+and X-Ray tracing by default.
+
+Input shapes are intentionally tight (Bucket/Key/Body only). Callers
+needing SDK-level options not exposed here (server-side encryption,
+tagging, version IDs) should use `S3Client` directly.
+
+## Constructors
+
+<a id="constructor"></a>
+
+### Constructor
+
+> **new S3Service**(`opts?`): `S3Service`
+
+Defined in: [s3/s3.ts:45](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/s3/s3.ts#L45)
+
+#### Parameters
+
+##### opts?
+
+###### client?
+
+`S3Client`
+
+Optional pre-configured `S3Client`. When supplied,
+the wrapper does not apply X-Ray instrumentation.
+
+###### logger?
+
+`Logger`
+
+Optional Powertools logger. Defaults to a logger with
+`serviceName: 'S3Service'`.
+
+#### Returns
+
+`S3Service`
+
+## Methods
+
+<a id="copyobject"></a>
+
+### copyObject()
+
+> **copyObject**(`input`): `Promise`\<`CopyObjectCommandOutput`\>
+
+Defined in: [s3/s3.ts:145](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/s3/s3.ts#L145)
+
+Copy an object within S3.
+
+#### Parameters
+
+##### input
+
+`Required`\<`Pick`\<`CopyObjectCommandInput`, `"Bucket"` \| `"Key"` \| `"CopySource"`\>\>
+
+#### Returns
+
+`Promise`\<`CopyObjectCommandOutput`\>
+
+***
+
+<a id="deleteobject"></a>
+
+### deleteObject()
+
+> **deleteObject**(`input`): `Promise`\<`DeleteObjectCommandOutput`\>
+
+Defined in: [s3/s3.ts:199](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/s3/s3.ts#L199)
+
+Delete a single object from S3.
+
+#### Parameters
+
+##### input
+
+`Required`\<`Pick`\<`DeleteObjectCommandInput`, `"Bucket"` \| `"Key"`\>\>
+
+#### Returns
+
+`Promise`\<`DeleteObjectCommandOutput`\>
+
+***
+
+<a id="deleteobjects"></a>
+
+### deleteObjects()
+
+> **deleteObjects**(`bucket`, `keys`): `Promise`\<`DeleteObjectsCommandOutput`[]\>
+
+Defined in: [s3/s3.ts:211](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/s3/s3.ts#L211)
+
+Delete multiple objects from S3, auto-chunking the request into batches
+of 1000 keys (the S3-enforced DeleteObjects limit). Returns one output
+per chunk.
+
+#### Parameters
+
+##### bucket
+
+`string`
+
+##### keys
+
+`string`[]
+
+#### Returns
+
+`Promise`\<`DeleteObjectsCommandOutput`[]\>
+
+***
+
+<a id="emptybucket"></a>
+
+### emptyBucket()
+
+> **emptyBucket**(`bucket`): `Promise`\<`string`[]\>
+
+Defined in: [s3/s3.ts:234](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/s3/s3.ts#L234)
+
+Delete every object in a bucket. Streams the listing page-by-page and
+delegates each page's deletion to `deleteObjects`, so peak memory stays
+bounded by one page (~1000 keys) regardless of bucket size.
+
+#### Parameters
+
+##### bucket
+
+`string`
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+The keys of every deleted object.
+
+***
+
+<a id="getallobjects"></a>
+
+### getAllObjects()
+
+> **getAllObjects**\<`T`\>(`bucket`, `prefix?`): `Promise`\<`T`[]\>
+
+Defined in: [s3/s3.ts:176](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/s3/s3.ts#L176)
+
+List and JSON-parse every object under a bucket and optional prefix.
+Auto-paginated. Objects without a body are skipped.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+Expected type of each parsed object.
+
+#### Parameters
+
+##### bucket
+
+`string`
+
+##### prefix?
+
+`string`
+
+#### Returns
+
+`Promise`\<`T`[]\>
+
+***
+
+<a id="getjsonobject"></a>
+
+### getJsonObject()
+
+> **getJsonObject**\<`T`\>(`input`): `Promise`\<`T` \| `undefined`\>
+
+Defined in: [s3/s3.ts:123](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/s3/s3.ts#L123)
+
+Get an object from S3 and parse it as JSON.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+Expected type of the parsed value.
+
+#### Parameters
+
+##### input
+
+`Required`\<`Pick`\<`GetObjectCommandInput`, `"Bucket"` \| `"Key"`\>\>
+
+#### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+The parsed value, or `undefined` if the response has no body.
+
+#### Throws
+
+If the body is non-empty and not valid JSON.
+
+***
+
+<a id="getobject"></a>
+
+### getObject()
+
+> **getObject**(`input`): `Promise`\<`GetObjectCommandOutput`\>
+
+Defined in: [s3/s3.ts:97](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/s3/s3.ts#L97)
+
+Get an object from S3.
+
+#### Parameters
+
+##### input
+
+`Required`\<`Pick`\<`GetObjectCommandInput`, `"Bucket"` \| `"Key"`\>\>
+
+#### Returns
+
+`Promise`\<`GetObjectCommandOutput`\>
+
+***
+
+<a id="getobjectbody"></a>
+
+### getObjectBody()
+
+> **getObjectBody**(`input`): `Promise`\<`string` \| `undefined`\>
+
+Defined in: [s3/s3.ts:109](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/s3/s3.ts#L109)
+
+Get an object from S3 and return its body as a string.
+
+#### Parameters
+
+##### input
+
+`Required`\<`Pick`\<`GetObjectCommandInput`, `"Bucket"` \| `"Key"`\>\>
+
+#### Returns
+
+`Promise`\<`string` \| `undefined`\>
+
+The object body as a string, or `undefined` if the response
+has no body.
+
+***
+
+<a id="headobject"></a>
+
+### headObject()
+
+> **headObject**(`input`): `Promise`\<`HeadObjectCommandOutput`\>
+
+Defined in: [s3/s3.ts:135](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/s3/s3.ts#L135)
+
+Fetch the metadata for an S3 object without downloading its body.
+
+#### Parameters
+
+##### input
+
+`Required`\<`Pick`\<`HeadObjectCommandInput`, `"Bucket"` \| `"Key"`\>\>
+
+#### Returns
+
+`Promise`\<`HeadObjectCommandOutput`\>
+
+***
+
+<a id="listobjects"></a>
+
+### listObjects()
+
+> **listObjects**(`bucket`, `prefix?`): `Promise`\<`string`[]\>
+
+Defined in: [s3/s3.ts:156](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/s3/s3.ts#L156)
+
+List object keys under a bucket and optional prefix, auto-paginating
+across all pages.
+
+#### Parameters
+
+##### bucket
+
+`string`
+
+##### prefix?
+
+`string`
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+***
+
+<a id="putjsonobject"></a>
+
+### putJsonObject()
+
+> **putJsonObject**\<`T`\>(`input`): `Promise`\<`PutObjectCommandOutput`\>
+
+Defined in: [s3/s3.ts:75](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/s3/s3.ts#L75)
+
+Serialise a value to JSON and store it as an S3 object.
+
+Note: the structured log line only includes `Bucket` and `Key` —
+the JSON-encoded body is omitted to avoid spilling potentially
+large or sensitive content into CloudWatch.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+Type of the value being stored.
+
+#### Parameters
+
+##### input
+
+###### Body
+
+`T`
+
+###### Bucket
+
+`string`
+
+###### Key
+
+`string`
+
+###### Metadata?
+
+`Record`\<`string`, `string`\>
+
+#### Returns
+
+`Promise`\<`PutObjectCommandOutput`\>
+
+***
+
+<a id="putobject"></a>
+
+### putObject()
+
+> **putObject**(`input`): `Promise`\<`PutObjectCommandOutput`\>
+
+Defined in: [s3/s3.ts:59](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/s3/s3.ts#L59)
+
+Put an object into S3.
+
+Note: the structured log line only includes `Bucket` and `Key` —
+`Body` is omitted to avoid spilling large payloads or sensitive
+content into CloudWatch.
+
+#### Parameters
+
+##### input
+
+`Required`\<`Pick`\<`PutObjectCommandInput`, `"Bucket"` \| `"Key"` \| `"Body"`\>\>
+
+Bucket, Key, and Body of the object to store.
+
+#### Returns
+
+`Promise`\<`PutObjectCommandOutput`\>

package/docs/classes/SNSService.md

@@ -0,0 +1,95 @@
+[**@aligent/aws-wrappers**](../modules.md)
+
+***
+
+[@aligent/aws-wrappers](../modules.md) / SNSService
+
+# Class: SNSService
+
+Defined in: [sns/sns.ts:20](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/sns/sns.ts#L20)
+
+Wrapper around the AWS SNS client providing structured Powertools logging
+and X-Ray tracing by default.
+
+## Constructors
+
+<a id="constructor"></a>
+
+### Constructor
+
+> **new SNSService**(`opts?`): `SNSService`
+
+Defined in: [sns/sns.ts:30](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/sns/sns.ts#L30)
+
+#### Parameters
+
+##### opts?
+
+###### client?
+
+`SNSClient`
+
+Optional pre-configured `SNSClient`. When supplied,
+the wrapper does not apply X-Ray instrumentation.
+
+###### logger?
+
+`Logger`
+
+Optional Powertools logger. Defaults to a logger with
+`serviceName: 'SNSService'`.
+
+#### Returns
+
+`SNSService`
+
+## Methods
+
+<a id="publish"></a>
+
+### publish()
+
+> **publish**(`input`): `Promise`\<`PublishCommandOutput`\>
+
+Defined in: [sns/sns.ts:39](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/sns/sns.ts#L39)
+
+Publish a single message to an SNS topic.
+
+#### Parameters
+
+##### input
+
+`PublishCommandInput`
+
+PublishCommandInput including TopicArn and Message.
+
+#### Returns
+
+`Promise`\<`PublishCommandOutput`\>
+
+***
+
+<a id="publishbatch"></a>
+
+### publishBatch()
+
+> **publishBatch**(`input`): `Promise`\<`PublishBatchCommandOutput`[]\>
+
+Defined in: [sns/sns.ts:51](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/sns/sns.ts#L51)
+
+Publish a batch of messages to an SNS topic. The SNS API caps
+PublishBatch at 10 entries per request, so this method auto-chunks
+the caller's `PublishBatchRequestEntries` and sends one request per
+chunk, returning the array of outputs.
+
+#### Parameters
+
+##### input
+
+`PublishBatchCommandInput`
+
+PublishBatchCommandInput including TopicArn and entries.
+
+#### Returns
+
+`Promise`\<`PublishBatchCommandOutput`[]\>

package/docs/classes/SQSService.md

@@ -0,0 +1,162 @@
+[**@aligent/aws-wrappers**](../modules.md)
+
+***
+
+[@aligent/aws-wrappers](../modules.md) / SQSService
+
+# Class: SQSService
+
+Defined in: [sqs/sqs.ts:30](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/sqs/sqs.ts#L30)
+
+Wrapper around the AWS SQS client providing structured Powertools logging
+and X-Ray tracing by default.
+
+## Constructors
+
+<a id="constructor"></a>
+
+### Constructor
+
+> **new SQSService**(`opts?`): `SQSService`
+
+Defined in: [sqs/sqs.ts:40](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/sqs/sqs.ts#L40)
+
+#### Parameters
+
+##### opts?
+
+###### client?
+
+`SQSClient`
+
+Optional pre-configured `SQSClient`. When supplied,
+the wrapper does not apply X-Ray instrumentation.
+
+###### logger?
+
+`Logger`
+
+Optional Powertools logger. Defaults to a logger with
+`serviceName: 'SQSService'`.
+
+#### Returns
+
+`SQSService`
+
+## Methods
+
+<a id="deletemessage"></a>
+
+### deleteMessage()
+
+> **deleteMessage**(`input`): `Promise`\<`DeleteMessageCommandOutput`\>
+
+Defined in: [sqs/sqs.ts:68](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/sqs/sqs.ts#L68)
+
+Delete a single message from an SQS queue.
+
+#### Parameters
+
+##### input
+
+`DeleteMessageCommandInput`
+
+#### Returns
+
+`Promise`\<`DeleteMessageCommandOutput`\>
+
+***
+
+<a id="deletemessagebatch"></a>
+
+### deleteMessageBatch()
+
+> **deleteMessageBatch**(`input`): `Promise`\<`DeleteMessageBatchCommandOutput`[]\>
+
+Defined in: [sqs/sqs.ts:100](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/sqs/sqs.ts#L100)
+
+Delete a batch of messages from an SQS queue. The SQS API caps
+DeleteMessageBatch at 10 entries per request, so this method auto-chunks
+the caller's entries and sends one request per chunk.
+
+#### Parameters
+
+##### input
+
+`DeleteMessageBatchCommandInput`
+
+#### Returns
+
+`Promise`\<`DeleteMessageBatchCommandOutput`[]\>
+
+***
+
+<a id="receivemessages"></a>
+
+### receiveMessages()
+
+> **receiveMessages**(`input`): `Promise`\<`Message`[]\>
+
+Defined in: [sqs/sqs.ts:59](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/sqs/sqs.ts#L59)
+
+Receive messages from an SQS queue. Returns an empty array when no
+messages are available. No automatic deletion is performed — visibility
+timeout semantics are the caller's responsibility.
+
+#### Parameters
+
+##### input
+
+`ReceiveMessageCommandInput`
+
+#### Returns
+
+`Promise`\<`Message`[]\>
+
+The `Messages` array from the response, or `[]` if absent.
+
+***
+
+<a id="sendmessage"></a>
+
+### sendMessage()
+
+> **sendMessage**(`input`): `Promise`\<`SendMessageCommandOutput`\>
+
+Defined in: [sqs/sqs.ts:48](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/sqs/sqs.ts#L48)
+
+Send a single message to an SQS queue.
+
+#### Parameters
+
+##### input
+
+`SendMessageCommandInput`
+
+#### Returns
+
+`Promise`\<`SendMessageCommandOutput`\>
+
+***
+
+<a id="sendmessagebatch"></a>
+
+### sendMessageBatch()
+
+> **sendMessageBatch**(`input`): `Promise`\<`SendMessageBatchCommandOutput`[]\>
+
+Defined in: [sqs/sqs.ts:78](https://github.com/aligent/microservice-development-utilities/blob/30b581ee09ba114f98caadf97f423e40b9b4f410/packages/aws-wrappers/src/sqs/sqs.ts#L78)
+
+Send a batch of messages to an SQS queue. The SQS API caps
+SendMessageBatch at 10 entries per request, so this method auto-chunks
+the caller's entries and sends one request per chunk.
+
+#### Parameters
+
+##### input
+
+`SendMessageBatchCommandInput`
+
+#### Returns
+
+`Promise`\<`SendMessageBatchCommandOutput`[]\>