@reventlessdev/reventless-local 3.0.0-alpha.140 → 3.0.0-alpha.142

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +77 -0
  3. package/package.json +13 -13
package/CHANGELOG.md CHANGED
@@ -3,6 +3,22 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # 3.0.0-alpha.142 (2026-07-11)
7
+
8
+ **Note:** Version bump only for package @reventlessdev/reventless-local
9
+
10
+
11
+
12
+
13
+
14
+ # 3.0.0-alpha.141 (2026-07-11)
15
+
16
+ **Note:** Version bump only for package @reventlessdev/reventless-local
17
+
18
+
19
+
20
+
21
+
6
22
  # 3.0.0-alpha.140 (2026-07-11)
7
23
 
8
24
  **Note:** Version bump only for package @reventlessdev/reventless-local
package/README.md ADDED
@@ -0,0 +1,77 @@
1
+ [![npm](https://img.shields.io/npm/v/@reventlessdev/reventless-local.svg?label=npm)](https://www.npmjs.com/package/@reventlessdev/reventless-local)
2
+ [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
3
+ [![Docs](https://img.shields.io/badge/docs-reventless.dev-blue)](https://docs.reventless.dev)
4
+
5
+ # @reventlessdev/reventless-local
6
+
7
+ > ⚠️ **Alpha.** APIs and on-disk formats can change without notice between releases.
8
+ > Pin exact versions and expect breaking changes.
9
+
10
+ The **local platform** for [Reventless](https://docs.reventless.dev) — a
11
+ spec-driven, event-sourced CQRS framework written in [ReScript](https://rescript-lang.org).
12
+ It implements the same platform interface as the cloud adapters, backed by
13
+ in-memory or SQLite data structures, so you can run and test your domain end to
14
+ end on a laptop — with no AWS and no cloud provisioning.
15
+
16
+ ## What it provides
17
+
18
+ ReScript modules, consumed by adding the package to your `rescript.json` `dependencies`:
19
+
20
+ - **`Platform`** — the local platform functor (`Platform.Make()` /
21
+ `Platform.MakeWithConfig({...})`) implementing `ReventlessInfra.Platform.T`.
22
+ It activates Pulumi mock mode automatically and starts a Domain GraphQL server
23
+ (and, in split mode, a Platform GraphQL server) plus MCP servers.
24
+ - **`Backend`** — selects the storage backend: `Backend.Memory` (default) or
25
+ `Backend.Sqlite({...})` for file-backed persistence.
26
+ - **Component builders** (`Aggregate_Builder`, `ReadModel_Builder`, `Plugin_Builder`,
27
+ the slice builders, `Task_Builder`, `Counter_Builder`, …) — local versions of
28
+ the core hierarchical components.
29
+ - **Adapters** (`src/adapter/`) — in-memory and SQLite implementations of each
30
+ core adapter: `EventLog`, `DcbEventLog`, `QueryDb`, `CommandTopic`, `EventTopic`,
31
+ `EventCollector`, `Counter`, `Scheduler`, `Task`, plus a local bus, query
32
+ engine, GraphQL/MCP server adapters, and auth/user store.
33
+ - **`TestRunner`** — helpers for running a local platform inside a test suite
34
+ (start/stop the GraphQL server), with Given-When-Then integration via
35
+ [`reventless-gwt`](https://www.npmjs.com/package/@reventlessdev/reventless-gwt).
36
+
37
+ ## Where it fits
38
+
39
+ `reventless-local` is the local-development/testing **platform** for the Reventless
40
+ framework. [`reventless-core`](https://www.npmjs.com/package/@reventlessdev/reventless-core)
41
+ is provider-agnostic; you pair it with exactly one platform adapter, and this is
42
+ the one for running without a cloud:
43
+
44
+ - [`@reventlessdev/reventless-aws`](https://www.npmjs.com/package/@reventlessdev/reventless-aws) — AWS (DynamoDB, Lambda, SQS, SNS, S3)
45
+ - [`@reventlessdev/reventless-postgres`](https://www.npmjs.com/package/@reventlessdev/reventless-postgres) — Postgres event log + query DB
46
+ - [`@reventlessdev/reventless-local`](https://www.npmjs.com/package/@reventlessdev/reventless-local) — **this package** (in-memory / SQLite)
47
+
48
+ The same domain components run unchanged on the local platform and on a cloud
49
+ adapter, so `reventless-local` is where you iterate and test before deploying. It
50
+ reuses [`reventless-postgres`](https://www.npmjs.com/package/@reventlessdev/reventless-postgres)
51
+ storage when you point it at a local Postgres.
52
+
53
+ ## Install
54
+
55
+ ```bash
56
+ pnpm add @reventlessdev/reventless-local
57
+ ```
58
+
59
+ Then register it as a ReScript dependency in `rescript.json`:
60
+
61
+ ```json
62
+ {
63
+ "dependencies": ["@reventlessdev/reventless-local"]
64
+ }
65
+ ```
66
+
67
+ Requires ReScript `^12.3.0` (peer dependency).
68
+
69
+ ## Links
70
+
71
+ - 📚 Documentation — [docs.reventless.dev](https://docs.reventless.dev)
72
+ - 📦 Repository — [ReventlessDev/reventless-core](https://github.com/ReventlessDev/reventless-core)
73
+ - 📋 [Changelog](./CHANGELOG.md)
74
+
75
+ ## License
76
+
77
+ [Apache-2.0](https://opensource.org/licenses/Apache-2.0)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@reventlessdev/reventless-local",
3
- "version": "3.0.0-alpha.140",
3
+ "version": "3.0.0-alpha.142",
4
4
  "description": "Local platform for Reventless (in-memory or SQLite backend, for development and testing without AWS)",
5
5
  "license": "Apache-2.0",
6
6
  "jest": {
@@ -31,22 +31,22 @@
31
31
  "graphql-yoga": "^5.21.0",
32
32
  "sury": "11.0.0-alpha.4",
33
33
  "ws": "^8.18.0",
34
- "@reventlessdev/rescript-effect": "0.1.0-alpha.26",
35
- "@reventlessdev/rescript-graphql-yoga": "1.0.0-alpha.19",
36
- "@reventlessdev/rescript-jest": "1.0.0-alpha.6",
37
- "@reventlessdev/rescript-pulumi-pulumi": "2.3.0-alpha.14",
38
- "@reventlessdev/rescript-mcp-sdk": "1.0.0-alpha.17",
39
- "@reventlessdev/reventless-core": "3.0.0-alpha.155",
40
- "@reventlessdev/reventless-graphql-server": "1.0.0-alpha.2",
41
- "@reventlessdev/reventless-gwt": "1.0.0-alpha.100",
42
- "@reventlessdev/reventless-infra": "3.0.0-alpha.96",
43
- "@reventlessdev/reventless-postgres": "3.0.0-alpha.19",
44
- "@reventlessdev/reventless-spec": "3.0.0-alpha.74"
34
+ "@reventlessdev/rescript-effect": "0.1.0-alpha.27",
35
+ "@reventlessdev/rescript-mcp-sdk": "1.0.0-alpha.18",
36
+ "@reventlessdev/rescript-graphql-yoga": "1.0.0-alpha.20",
37
+ "@reventlessdev/rescript-jest": "1.0.0-alpha.7",
38
+ "@reventlessdev/rescript-pulumi-pulumi": "2.3.0-alpha.15",
39
+ "@reventlessdev/reventless-core": "3.0.0-alpha.156",
40
+ "@reventlessdev/reventless-graphql-server": "1.0.0-alpha.3",
41
+ "@reventlessdev/reventless-infra": "3.0.0-alpha.97",
42
+ "@reventlessdev/reventless-gwt": "1.0.0-alpha.102",
43
+ "@reventlessdev/reventless-spec": "3.0.0-alpha.75",
44
+ "@reventlessdev/reventless-postgres": "3.0.0-alpha.20"
45
45
  },
46
46
  "devDependencies": {
47
47
  "rescript": "^12.3.0",
48
48
  "sury-ppx": "11.0.0-alpha.2",
49
- "@reventlessdev/reventless-ppx": "1.0.0-alpha.52"
49
+ "@reventlessdev/reventless-ppx": "1.0.0-alpha.53"
50
50
  },
51
51
  "peerDependencies": {
52
52
  "rescript": "^12.3.0"