Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/three-knives-share.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@driimus/aws-event-factory": patch
---

fix: only ship build artifacts
7 changes: 7 additions & 0 deletions .changeset/two-suns-bathe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@driimus/aws-event-factory": patch
"@driimus/lambda-batch-processor": patch
"@driimus/sqs-permanent-failure-dlq": patch
---

docs: mention optional types
9 changes: 9 additions & 0 deletions packages/aws-event-factory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,15 @@ explicit inputs should always be provided for the parts of an event that you rea
pnpm add --save-dev @faker-js/faker fishery @driimus/aws-event-factory
```

### Type hints

For types to work as expected, `@types/aws-lambda` must be installed:

```sh
pnpm add --save-dev @types/aws-lambda

```

## Usage

Make sure to check out fishery's [documentation](https://github.com/thoughtbot/fishery#documentation) for a more detailed API Reference of the exposed factories.
Expand Down
3 changes: 3 additions & 0 deletions packages/aws-event-factory/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
"type": "module",
"exports": "./dist/index.js",
"types": "./dist/index.d.ts",
"files": [
"./dist"
],
"scripts": {
"build": "tsc",
"test": "vitest run"
Expand Down
12 changes: 10 additions & 2 deletions packages/lambda-batch-processor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,18 @@ Concurrently process batch records with partial failure support.
pnpm add @driimus/lambda-batch-processor
```

### Type hints

For types to work as expected, `@types/aws-lambda` must be installed:

```sh
pnpm add --save-dev @types/aws-lambda

```

## Usage

> [!WARNING]
> [`ReportBatchItemFailures`](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting) must be enabled to allow retrying failed messages.
> [!WARNING] > [`ReportBatchItemFailures`](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting) must be enabled to allow retrying failed messages.

```ts
import { SQSBatchProcessor } from '@driimus/lambda-batch-processor';
Expand Down
9 changes: 9 additions & 0 deletions packages/sqs-permanent-failure-dlq/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,15 @@ that sends corresponding SQS messages to a dead-letter SQS queue.
pnpm add @driimus/lambda-batch-processor @driimus/sqs-permanent-failure-dlq @aws-sdk/client-sqs
```

### Type hints

For types to work as expected, `@types/aws-lambda` must be installed:

```sh
pnpm add --save-dev @types/aws-lambda

```

## Usage

```ts
Expand Down