@reventlessdev/reventless-aws 3.0.0-alpha.196 → 3.0.0-alpha.197

package/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# 3.0.0-alpha.197 (2026-07-11)
+
+### Features
+
+* **infra:** add DeployBootstrap seam for generated deploy programs ([f0dc868](https://github.com/ReventlessDev/reventless-core/commit/f0dc8686396d21e7b39667eb0825b2e57fe4dabf))
+
+
 # 3.0.0-alpha.196 (2026-07-11)
 
 **Note:** Version bump only for package @reventlessdev/reventless-aws

package/README.md

@@ -1,62 +1,89 @@
-[![npm version](https://img.shields.io/npm/v/@reventlessdev/reventless-aws.svg?label=version)](https://www.npmjs.com/package/@reventlessdev/reventless-aws)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Changelog](https://img.shields.io/badge/📋-Changelog-blue)](./CHANGELOG.md)
-
-# `reventless-aws`
-
-Reventless suplements to run Reventless applications on Amazon AWS.
-This package extends `reventless`.
-
-## Usage
-
-- Add `reventless-aws` to your dependencies in `package.json`.
-- Add `reventless-aws` to your dependencies in `rescript.json`.
-- For general information see this monorepo's [readme](../../README.md)
-
-## Introduction
-
-### Reventless Component
-
-Reventless uses [Pulumi](https://www.pulumi.com/docs/intro/concepts/programming-model/#components) components to create reusable parts of software. A component bundles several (cloud) resources which act together to fulfill a specific task (e.v. `EventLog`) in our system.  
-Components always consist of code run at deploytime **and** code run at runtime.
-
-[Reventless](../reventless/README.md) implements only general cloud-provider-agnostic components. These components need to be parameterized with cloud-provider-specific *adapters*.
-
-### Adapter
-
-Adapter implement cloud-provider-specific functionallity. An adapter chooses the cloud-provider's resource(s) and provides specialized functions to be used for a specific component.  
-E.g. adapter for the `EventLog` could choose to store it's data in a database-service or a filestorage-service and would provide functions which implement an eventlog's functionality (`replay` & `append`).
-
+[![npm](https://img.shields.io/npm/v/@reventlessdev/reventless-aws.svg?label=npm)](https://www.npmjs.com/package/@reventlessdev/reventless-aws)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Docs](https://img.shields.io/badge/docs-reventless.dev-blue)](https://docs.reventless.dev)
+
+# @reventlessdev/reventless-aws
+
+> ⚠️ **Alpha.** APIs and on-disk formats can change without notice between releases.
+> Pin exact versions and expect breaking changes.
+
+The **AWS adapter** for [Reventless](https://docs.reventless.dev) — a
+spec-driven, event-sourced CQRS framework written in [ReScript](https://rescript-lang.org).
+This package binds the provider-agnostic components of
+[`@reventlessdev/reventless-core`](https://www.npmjs.com/package/@reventlessdev/reventless-core)
+to concrete AWS resources and provisions them with [Pulumi](https://www.pulumi.com/),
+so the same domain code deploys to AWS unchanged. It covers both deploy-time
+(infrastructure) and runtime (Lambda handlers).
+
+## What it provides
+
+ReScript modules, consumed by adding the package to your `rescript.json` `dependencies`:
+
+- **`Platform`** — the AWS platform functor (`Platform.Make()` / `Platform.MakeWithConfig({...})`).
+  Applying it wires up AWS builders once; your plugin functor then takes only the
+  application-defined `Spec`, `Behavior`, and `Mappings`.
+- **Component builders** (`Aggregate_Builder`, `ReadModel_Builder`, `Plugin`,
+  the slice builders, `Task_Builder`, `Counter_Builder`, `Scheduler`, …) —
+  AWS-preconfigured versions of the core hierarchical components, including the
+  Single / PerAggregate / Micro runtime layouts.
+- **Adapters** (`src/adapter/`) — the AWS implementation of each core adapter
+  interface, one per component (`EventLog`, `CommandTopic`, `EventTopic`,
+  `EventCollector`, `QueryDb`, `Counter`, `ScheduledPublisher`, `Task`, …).
+- **`util/`** — AWS-resource helpers shared across adapters (DynamoDB, Lambda,
+  SQS/SNS FIFO, S3, IAM, AppSync, Cognito, VPC, CloudWatch).
+
+The adapters map core components onto AWS services:
+
+| Core component            | AWS resource            |
+|---------------------------|-------------------------|
+| EventLog / QueryDb        | DynamoDB                |
+| CommandTopic / EventTopic | SQS (FIFO), SNS         |
+| Runtime handlers          | Lambda                  |
+| Task buckets              | S3                      |
+| Domain API                | AppSync (GraphQL)       |
+
+## Where it fits
+
+`reventless-aws` is a storage/cloud **adapter** for the Reventless framework.
+[`reventless-core`](https://www.npmjs.com/package/@reventlessdev/reventless-core)
+is provider-agnostic; you pair it with exactly one platform adapter at deploy time:
+
+- [`@reventlessdev/reventless-aws`](https://www.npmjs.com/package/@reventlessdev/reventless-aws) — **this package** (DynamoDB, Lambda, SQS, SNS, S3)
+- [`@reventlessdev/reventless-postgres`](https://www.npmjs.com/package/@reventlessdev/reventless-postgres) — Postgres event log + query DB
+- [`@reventlessdev/reventless-local`](https://www.npmjs.com/package/@reventlessdev/reventless-local) — in-memory / SQLite platform for local dev and tests
+
+It also depends on [`reventless-postgres`](https://www.npmjs.com/package/@reventlessdev/reventless-postgres)
+so a deployment can back its event logs with managed Postgres (RDS/Aurora)
+instead of DynamoDB, and on
+[`reventless-infra`](https://www.npmjs.com/package/@reventlessdev/reventless-infra) /
+[`reventless-spec`](https://www.npmjs.com/package/@reventlessdev/reventless-spec)
+for the shared infrastructure and specification types.
+
+You normally obtain `reventless-aws` by scaffolding an app rather than installing
+it on its own.
+
+## Install
+
+```bash
+pnpm add @reventlessdev/reventless-aws
+```
 
-## Example
+Then register it as a ReScript dependency in `rescript.json`:
 
+```json
+{
+  "dependencies": ["@reventlessdev/reventless-aws"]
+}
 ```
-// TODO: DEMONSTRATE API
-```
-
-## Contribution
 
-### Changelog
+Requires ReScript `^12.3.0` (peer dependency).
 
-Please remember to update the changelog for any modifications accordingly!
+## Links
 
+- 📚 Documentation — [docs.reventless.dev](https://docs.reventless.dev)
+- 📦 Repository — [ReventlessDev/reventless-core](https://github.com/ReventlessDev/reventless-core)
+- 📋 [Changelog](./CHANGELOG.md)
 
-### Folder Structure
+## License
 
-```sh
-reventless-aws
-├── src
-│   ├── adapter                 [adapter per Reventless Component]
-│   │   ├── AtomicCounter
-│   │   ├── CommandGenerator
-│   │   ├── CommandTopic
-│   │   ├── DataCleaner
-│   │   ├── EventCollector
-│   │   ├── EventLog
-│   │   ├── EventTopic
-│   │   ├── QueryDb
-│   │   └── ScheduledPublisher
-│   ├── components              [components preconfigured with aws adapter]
-│   └── util                    [util functions by aws-resource, used by several adapters]
-└── __tests__                   [tests for adapters & utils]
-```
+[Apache-2.0](https://opensource.org/licenses/Apache-2.0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reventlessdev/reventless-aws",
-  "version": "3.0.0-alpha.196",
+  "version": "3.0.0-alpha.197",
   "description": "AWS adapters for Reventless",
   "license": "Apache-2.0",
   "dependencies": {
@@ -8,17 +8,17 @@
     "@aws-sdk/client-cloudfront": "3.970.0",
     "sury": "11.0.0-alpha.4",
     "uuid": "^13.0.0",
-    "@reventlessdev/rescript-effect": "0.1.0-alpha.26",
-    "@reventlessdev/rescript-jest": "1.0.0-alpha.6",
-    "@reventlessdev/rescript-pulumi-aws": "2.4.0-alpha.49",
-    "@reventlessdev/rescript-pulumi-pulumi": "2.3.0-alpha.14",
-    "@reventlessdev/rescript-aws-sdk": "2.2.0-alpha.20",
-    "@reventlessdev/rescript-uuid": "1.1.0-alpha.14",
-    "@reventlessdev/reventless-core": "3.0.0-alpha.155",
-    "@reventlessdev/reventless-infra": "3.0.0-alpha.96",
-    "@reventlessdev/reventless-interop": "3.0.0-alpha.25",
-    "@reventlessdev/reventless-postgres": "3.0.0-alpha.19",
-    "@reventlessdev/reventless-spec": "3.0.0-alpha.74"
+    "@reventlessdev/rescript-aws-sdk": "2.2.0-alpha.21",
+    "@reventlessdev/rescript-effect": "0.1.0-alpha.27",
+    "@reventlessdev/rescript-pulumi-aws": "2.4.0-alpha.50",
+    "@reventlessdev/rescript-jest": "1.0.0-alpha.7",
+    "@reventlessdev/rescript-pulumi-pulumi": "2.3.0-alpha.15",
+    "@reventlessdev/rescript-uuid": "1.1.0-alpha.15",
+    "@reventlessdev/reventless-core": "3.0.0-alpha.156",
+    "@reventlessdev/reventless-infra": "3.0.0-alpha.97",
+    "@reventlessdev/reventless-interop": "3.0.0-alpha.26",
+    "@reventlessdev/reventless-spec": "3.0.0-alpha.75",
+    "@reventlessdev/reventless-postgres": "3.0.0-alpha.20"
   },
   "devDependencies": {
     "rescript": "^12.3.0",

package/src/plugin/runtime/PluginRuntime_Builder.res

@@ -48,6 +48,17 @@ let registerStateChangeSliceSpec = (~specPath: string, ~behaviorPath: string) =>
   let _ = registeredSliceModulePaths->Array.push({specPath, behaviorPath})
 }
 
+/**
+Redundant with the seams that populate `dcbConfigRef` automatically:
+`pluginName` is set by `registerPluginName` (called from `Plugin_Builder.make`
+when the plugin builds), the DCB table name by `registerDcbTableName`, and slice
+module paths by `registerStateChangeSliceSpec` (from each slice's `moduleUrl`).
+No deploy program needs to call this. Kept only so any out-of-tree caller still
+compiles; slated for removal.
+*/
+@deprecated(
+  "pluginName is auto-registered by Plugin_Builder.make; use registerDcbTableName / registerStateChangeSliceSpec for the other fields. This call is unnecessary and will be removed."
+)
 let registerDcbConfig = (~pluginName, ~dcbTableName=?, ~stateChangeSliceModulePaths=[], ()) => {
   dcbConfigRef := {pluginName, dcbTableName, stateChangeSliceModulePaths}
   stateChangeSliceModulePaths->Array.length