actor-ts 0.9.1 → 0.11.0

package/README.md

@@ -1,269 +1,294 @@
-<p align="center">
-  <img src="https://raw.githubusercontent.com/pathosDev/actor-ts/main/docs/public/logo.png" alt="actor-ts" width="560"/>
-</p>
-
-<p align="center">
-  <a href="https://github.com/pathosDev/actor-ts/actions/workflows/build.yml"><img alt="build workflow" src="https://github.com/pathosDev/actor-ts/actions/workflows/build.yml/badge.svg?branch=main"/></a>
-  <a href="https://github.com/pathosDev/actor-ts/actions/workflows/test.yml"><img alt="tests workflow" src="https://github.com/pathosDev/actor-ts/actions/workflows/test.yml/badge.svg?branch=main"/></a>
-  <a href="#"><img alt="tests" src="https://img.shields.io/badge/tests-1760%20of%201760-22c55e?style=flat-square&logo=bun"/></a>
-  <a href="#"><img alt="coverage" src="https://img.shields.io/badge/coverage-~86%25-22c55e?style=flat-square"/></a>
-</p>
-
-<p align="center">
-  <a href="#"><img alt="typescript" src="https://img.shields.io/badge/typescript-5.4+-3178c6?style=flat-square&logo=typescript&logoColor=white"/></a>
-  <a href="#"><img alt="bun" src="https://img.shields.io/badge/bun-%3E%3D1.1-f7bf88?style=flat-square&logo=bun&logoColor=white"/></a>
-  <a href="#"><img alt="node" src="https://img.shields.io/badge/node-%3E%3D20-339933?style=flat-square&logo=node.js&logoColor=white"/></a>
-  <a href="#"><img alt="deno" src="https://img.shields.io/badge/deno-%3E%3D2.0-000000?style=flat-square&logo=deno&logoColor=white"/></a>
-</p>
-
-<p align="center">
-  <a href="https://github.com/pathosDev/actor-ts/blob/main/LICENSE"><img alt="license" src="https://img.shields.io/badge/license-Apache_2.0-8b5cf6?style=flat-square"/></a>
-  <a href="#"><img alt="status" src="https://img.shields.io/badge/status-experimental-f59e0b?style=flat-square"/></a>
-</p>
-
----
-
-> ⚠️ **Disclaimer — please read before using.**
-> This is a **complex, AI-assisted hobby project** — a from-scratch port of
-> the actor-model stack (actors, supervision, cluster, sharding, persistence,
-> HTTP) to TypeScript, running on Bun, Node.js, and Deno.  Large parts were
-> written with AI pair-programming and **have not been battle-tested in
-> production**.  Test coverage is good (~1760 tests, ~86 % line) but the
-> surface area is enormous.  **Do not deploy this to anything that matters
-> yet.**  Use it to learn, to prototype, to benchmark ideas — not to handle
-> real money, users, or data.
-
----
-
-## What is this?
-
-`actor-ts` is a **batteries-included actor-model runtime** for TypeScript —
-messages, mailboxes, supervisors, location-transparent refs, the whole
-Erlang-style actor toolkit — running natively on **Bun**, **Node.js**, and
-**Deno**.
-
-A short tour of what's in the box:
-
-- **Actors** — single-threaded per-mailbox processing, lifecycle hooks, stash,
-  timers, become/unbecome, supervision (restart / resume / stop / escalate).
-- **Cluster** — gossip membership, φ-accrual failure detection, split-brain
-  resolvers, weakly-up, multiple transports (TCP, MessageChannel, in-memory).
-- **Cluster sharding + singleton + pub-sub + reliable delivery + receptionist**
-  — production patterns from the actor-model tradition.
-- **Distributed Data** — eight CRDTs (counters, registers, sets, maps) with
-  durable-storage backend, quorum reads/writes, automatic gossip.
-- **Persistence** — `PersistentActor`, `DurableState`, snapshots, projections,
-  persistence-query, replicated event sourcing.  Journals for in-memory,
-  SQLite (via Bun-SQLite + better-sqlite3), Cassandra / ScyllaDB.
-- **Object storage** — S3 / MinIO / R2 / filesystem with optional gzip/zstd
-  compression and client-side AES-256-GCM encryption (per-tenant subkeys via
-  HKDF).
-- **HTTP** — directive-style routing DSL with Fastify default, Express + Hono
-  backends, response caching, rate-limiting, idempotency-key dedup.
-- **Message brokers** — single `BrokerActor` base with Kafka, MQTT, AMQP,
-  NATS, Redis-Streams, gRPC, WebSocket, SSE, raw TCP/UDP integrations.
-  Reconnect-with-backoff, outbound buffer, subscriber fan-out are baked in.
-- **Caching** — pluggable Cache with in-memory, Redis, Memcached backends.
-- **Observability** — Prometheus exporter, OTel tracing + metrics, management
-  HTTP endpoints (`/health`, `/ready`, `/cluster/members`, `/sharding/regions`),
-  out-of-the-box stock metrics.
-- **TestKit** — `TestProbe`, `ManualScheduler`, `MultiNodeSpec` for
-  deterministic tests including cluster scenarios.
-
-Everything works under any of the three runtimes — runtime-specific backends
-(TCP sockets, worker threads, SQLite, HTTP serve) live behind small
-abstractions in [`src/runtime/`](./src/runtime/) and auto-detect at startup.
-
----
-
-## Quick start
-
-```bash
-bun add actor-ts                                  # Bun
-npm install actor-ts                              # Node
-# Deno: no install — import via `npm:actor-ts`
-```
-
-```ts
-import { Actor, ActorSystem, Props } from 'actor-ts';
-
-class Greeter extends Actor<string> {
-  override onReceive(name: string): void {
-    console.log(`hello, ${name}!`);
-  }
-}
-
-const system = ActorSystem.create('hello');
-const ref    = system.spawn(Props.create(() => new Greeter()), 'greeter');
-
-ref.tell('world');
-
-await new Promise(r => setTimeout(r, 20));
-await system.terminate();
-```
-
-The same file runs unchanged under `bun run`, `node` and `deno run`.
-
----
-
-## A few more patterns
-
-A flavour of what idiomatic `actor-ts` code looks like — pick the
-snippet that matches what you're reaching for.
-
-### Typed messages + pattern matching
-
-Discriminated-union messages plus `match().exhaustive()` from
-[`ts-pattern`](https://github.com/gvergnaud/ts-pattern) give you a
-compile-time check that every variant is handled. Add a new variant
-to `Cmd` without a matching `with(...)` arm and TypeScript fails the
-build.
-
-```ts
-import { Actor, ActorSystem, Props, type ActorRef } from 'actor-ts';
-import { match } from 'ts-pattern';
-
-type Cmd =
-  | { kind: 'inc' }
-  | { kind: 'dec' }
-  | { kind: 'get'; replyTo: ActorRef<number> };
-
-class Counter extends Actor<Cmd> {
-  private count = 0;
-  override onReceive(cmd: Cmd): void {
-    match(cmd)
-      .with({ kind: 'inc' }, () => { this.count++; })
-      .with({ kind: 'dec' }, () => { this.count--; })
-      .with({ kind: 'get' }, m => m.replyTo.tell(this.count))
-      .exhaustive();
-  }
-}
-```
-
-### Ask pattern — request / response
-
-`tell` is fire-and-forget; `ref.ask<Reply>(msg)` awaits a typed
-reply with a configurable timeout.  The framework spawns a
-one-shot reply actor, wires it as both `replyTo` and
-`context.sender`, and resolves the promise when the target replies.
-
-```ts
-import { ActorSystem, Props } from 'actor-ts';
-
-const system  = ActorSystem.create('demo');
-const counter = system.spawnAnonymous(Props.create(() => new Counter()));
-
-counter.tell({ kind: 'inc' });
-counter.tell({ kind: 'inc' });
-
-const value = await counter.ask<number>({ kind: 'get' }, 5_000);
-console.log(value);  // 2
-```
-
-### Event-sourced actor
-
-State is rebuilt from a journal on every restart — no in-place
-mutation, no "did this write commit?" question. Same `Counter` API
-the rest of the app sees, every mutation durable.
-
-```ts
-import { PersistentActor, ActorSystem, Props } from 'actor-ts';
-
-type Cmd   = { kind: 'inc' } | { kind: 'dec' };
-type Event = { kind: 'incremented' } | { kind: 'decremented' };
-interface State { count: number }
-
-class Counter extends PersistentActor<Cmd, Event, State> {
-  readonly persistenceId = 'counter-1';
-  initialState(): State { return { count: 0 }; }
-  onEvent(s: State, e: Event): State {
-    return e.kind === 'incremented'
-      ? { count: s.count + 1 }
-      : { count: s.count - 1 };
-  }
-  onCommand(_state: State, cmd: Cmd): void {
-    this.persist({
-      kind: cmd.kind === 'inc' ? 'incremented' : 'decremented',
-    });
-  }
-}
-```
-
-### Cluster sharding — N instances behind one ref
-
-Same actor code; the framework routes per-entity messages to the
-correct node in the cluster and migrates entities when nodes come
-and go. The `ShardRegion` ref you get back behaves like any other
-`ActorRef` to callers.
-
-```ts
-import { Cluster } from 'actor-ts';
-
-// One-call bootstrap — system + cluster + receptionist + SIGTERM
-// wiring in one line.  Discovery defaults to an env-driven chain
-// (CLUSTER_SEEDS → K8s API → DNS); local dev with no env produces
-// a single-node cluster, which is exactly what you want.
-const { system, cluster } = await Cluster.bootstrap({ name: 'app' });
-
-const cartRegion = cluster.sharding.start('cart', CartActor, {
-  extractEntityId: (msg: CartCmd) => msg.entityId,
-});
-
-cartRegion.tell({ entityId: 'user-42', kind: 'add', sku: 'book-1' });
-```
-
----
-
-## Documentation
-
-> 📚 **[actor-ts.dev](https://actor-ts.dev/)** —
-> full documentation site with concept guides, runnable examples, and an
-> auto-generated API reference.
-
-The docs site is the canonical entry point.  Highlights:
-
-- **[Quickstart](https://actor-ts.dev/intro/quickstart/)** —
-  hello-actor in five minutes.
-- **[Why actors?](https://actor-ts.dev/intro/why-actors/)** —
-  what the actor model gives you that Promise/Worker code doesn't.
-- **[Migrating from Akka / Pekko / Orleans](https://actor-ts.dev/migration/overview/)** —
-  for people coming from another actor framework.
-- **[API reference](https://actor-ts.dev/api/)** —
-  every public class, function, type generated from JSDoc.
-
----
-
-## Examples
-
-Two end-to-end sample apps that exercise the framework comprehensively, each
-with six interchangeable frontends (Plain HTML, Lit, Angular, React, Next.js,
-SvelteKit) talking the same WebSocket protocol to a clustered backend:
-
-- **[`examples/chat/`](./examples/chat/)** — multi-room chat with sharding,
-  persistence, DMs, typing indicators, read receipts, production-realistic
-  auth.  Demonstrates `ClusterSharding`, `DistributedPubSub`, `PersistentActor`,
-  `DistributedData` (ORSet, LWWMap), `ClusterSingleton`, failover.
-- **[`examples/voice/`](./examples/voice/)** — voice rooms with PCM-encoded
-  audio streaming over WebSocket.  Same cluster infrastructure, different
-  protocol shape.
-
-Run either with `bun examples/chat/backend/main.ts --port 2551` (then
-`--seeds localhost:2551` on additional terminals), open
-`http://localhost:8080`, pick a frontend, and poke.
-
----
-
-## Roadmap & status
-
-See [`ROADMAP.md`](./ROADMAP.md) for what's done and what's planned.  The
-[`CHANGELOG.md`](./CHANGELOG.md) tracks per-version changes — pre-1.0 minor
-bumps are potentially breaking; check the changelog before upgrading.
-
-Issues and feature requests live on
-[GitHub](https://github.com/pathosDev/actor-ts/issues).
-
----
-
-## License
-
-[Apache 2.0](./LICENSE).
+<p align="center">
+  <img src="https://raw.githubusercontent.com/pathosDev/actor-ts/main/docs/public/logo.png" alt="actor-ts" width="560"/>
+</p>
+
+<p align="center">
+  <a href="https://github.com/pathosDev/actor-ts/actions/workflows/build.yml"><img alt="build workflow" src="https://github.com/pathosDev/actor-ts/actions/workflows/build.yml/badge.svg?branch=main"/></a>
+  <a href="https://github.com/pathosDev/actor-ts/actions/workflows/test.yml"><img alt="tests workflow" src="https://github.com/pathosDev/actor-ts/actions/workflows/test.yml/badge.svg?branch=main"/></a>
+  <a href="#"><img alt="tests" src="https://img.shields.io/badge/tests-2657%20of%202657-22c55e?style=flat-square&logo=bun"/></a>
+  <a href="#"><img alt="coverage" src="https://img.shields.io/badge/coverage-~90%25-22c55e?style=flat-square"/></a>
+</p>
+
+<p align="center">
+  <a href="#"><img alt="typescript" src="https://img.shields.io/badge/typescript-5.4+-3178c6?style=flat-square&logo=typescript&logoColor=white"/></a>
+  <a href="#"><img alt="bun" src="https://img.shields.io/badge/bun-%3E%3D1.1-f7bf88?style=flat-square&logo=bun&logoColor=white"/></a>
+  <a href="#"><img alt="node" src="https://img.shields.io/badge/node-%3E%3D20-339933?style=flat-square&logo=node.js&logoColor=white"/></a>
+  <a href="#"><img alt="deno" src="https://img.shields.io/badge/deno-%3E%3D2.0-000000?style=flat-square&logo=deno&logoColor=white"/></a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/pathosDev/actor-ts/blob/main/LICENSE"><img alt="license" src="https://img.shields.io/badge/license-Apache_2.0-8b5cf6?style=flat-square"/></a>
+  <a href="#"><img alt="status" src="https://img.shields.io/badge/status-experimental-f59e0b?style=flat-square"/></a>
+</p>
+
+---
+
+> ⚠️ **Disclaimer — please read before using.**
+> This is a **complex, AI-assisted hobby project** — a from-scratch port of
+> the actor-model stack (actors, supervision, cluster, sharding, persistence,
+> HTTP) to TypeScript, running on Bun, Node.js, and Deno.  Large parts were
+> written with AI pair-programming and **have not been battle-tested in
+> production**.  Test coverage is good (~2657 tests, ~90 % line) but the
+> surface area is enormous.  **Do not deploy this to anything that matters
+> yet.**  Use it to learn, to prototype, to benchmark ideas — not to handle
+> real money, users, or data.
+
+---
+
+## What is this?
+
+`actor-ts` is a **batteries-included actor-model runtime** for TypeScript —
+messages, mailboxes, supervisors, location-transparent refs, the whole
+Erlang-style actor toolkit — running natively on **Bun**, **Node.js**, and
+**Deno**.
+
+A short tour of what's in the box:
+
+- **Actors** — single-threaded per-mailbox processing, lifecycle hooks, stash,
+  timers, become/unbecome, supervision (restart / resume / stop / escalate).
+- **Cluster** — gossip membership, φ-accrual failure detection, split-brain
+  resolvers, weakly-up, multiple transports (TCP, MessageChannel, in-memory).
+- **Cluster sharding + singleton + pub-sub + reliable delivery + receptionist**
+  — production patterns from the actor-model tradition.
+- **Distributed Data** — eight CRDTs (counters, registers, sets, maps) with
+  durable-storage backend, quorum reads/writes, automatic gossip.
+- **Persistence** — `PersistentActor`, `DurableState`, snapshots, projections,
+  persistence-query, replicated event sourcing.  Journals for in-memory,
+  SQLite (via Bun-SQLite + better-sqlite3), Cassandra / ScyllaDB.
+- **Object storage** — S3 / MinIO / R2 / filesystem with optional gzip/zstd
+  compression and client-side AES-256-GCM encryption (per-tenant subkeys via
+  HKDF).
+- **HTTP** — directive-style routing DSL with Fastify default, Express + Hono
+  backends, response caching, rate-limiting, idempotency-key dedup.  Typed
+  **WebSocket** routes: `websocket(path, actorRef)` binds a
+  `WebsocketServerActor` (typed messages, `reply` / `broadcast`,
+  connect/disconnect hooks); `WebsocketClientActor` is the reconnecting
+  client half.  Scoped error handling (`handleErrors`) + `fallback` routes;
+  a security-middleware suite (CORS, CSRF, HSTS, CSP, security headers,
+  Basic auth, request-id, timeout); HTML-escaping helpers; and
+  backend-agnostic **static file serving** (`getFromFile` /
+  `getFromDirectory` — MIME detection, conditional requests, Range,
+  directory browsing).
+- **Message brokers** — single `BrokerActor` base with Kafka, MQTT, AMQP,
+  NATS, Redis-Streams, gRPC, SSE, raw TCP/UDP integrations.
+  Reconnect-with-backoff, outbound buffer, subscriber fan-out are baked in.
+- **Caching** — pluggable Cache with in-memory, Redis, Memcached backends.
+- **Typed options + fail-fast validation** — one fluent `XOptions` builder per
+  configurable thing (or a plain object), with values validated once on the
+  merged settings (builder / object / HOCON alike) — a bad port, timeout, or
+  URL throws an `OptionsError` at startup, not deep in a later code path.
+- **Observability** — Prometheus exporter, OTel tracing, management
+  HTTP endpoints (`/health`, `/ready`, `/cluster/members`, `/sharding/regions`),
+  out-of-the-box stock metrics.
+- **TestKit** — `TestProbe`, `ManualScheduler`, `MultiNodeSpec` for
+  deterministic tests including cluster scenarios.
+
+Everything works under any of the three runtimes — runtime-specific backends
+(TCP sockets, worker threads, SQLite, HTTP serve) live behind small
+abstractions in [`src/runtime/`](./src/runtime/) and auto-detect at startup.
+
+---
+
+## Quick start
+
+```bash
+bun add actor-ts                                  # Bun
+npm install actor-ts                              # Node
+# Deno: no install — import via `npm:actor-ts`
+```
+
+```ts
+import { Actor, ActorSystem, Props } from 'actor-ts';
+
+class Greeter extends Actor<string> {
+  override onReceive(name: string): void {
+    console.log(`hello, ${name}!`);
+  }
+}
+
+const system = ActorSystem.create('hello');
+const ref    = system.spawn(Props.create(() => new Greeter()), 'greeter');
+
+ref.tell('world');
+
+await new Promise(r => setTimeout(r, 20));
+await system.terminate();
+```
+
+The same file runs unchanged under `bun run`, `node` and `deno run`.
+
+---
+
+## A few more patterns
+
+A flavour of what idiomatic `actor-ts` code looks like — pick the
+snippet that matches what you're reaching for.
+
+### Typed messages + pattern matching
+
+Discriminated-union messages plus `match().exhaustive()` from
+[`ts-pattern`](https://github.com/gvergnaud/ts-pattern) give you a
+compile-time check that every variant is handled. Add a new variant
+to `Command` without a matching `with(...)` arm and TypeScript fails the
+build.
+
+```ts
+import { Actor, ActorSystem, Props, type ActorRef } from 'actor-ts';
+import { match } from 'ts-pattern';
+
+type Command =
+  | { kind: 'inc' }
+  | { kind: 'dec' }
+  | { kind: 'get'; replyTo: ActorRef<number> };
+
+class Counter extends Actor<Command> {
+  private count = 0;
+  override onReceive(cmd: Command): void {
+    match(cmd)
+      .with({ kind: 'inc' }, () => { this.count++; })
+      .with({ kind: 'dec' }, () => { this.count--; })
+      .with({ kind: 'get' }, m => m.replyTo.tell(this.count))
+      .exhaustive();
+  }
+}
+```
+
+### Ask pattern — request / response
+
+`tell` is fire-and-forget; `ref.ask<Reply>(msg)` awaits a typed
+reply with a configurable timeout.  The framework spawns a
+one-shot reply actor, wires it as both `replyTo` and
+`context.sender`, and resolves the promise when the target replies.
+
+```ts
+import { ActorSystem, Props } from 'actor-ts';
+
+const system  = ActorSystem.create('demo');
+const counter = system.spawnAnonymous(Props.create(() => new Counter()));
+
+counter.tell({ kind: 'inc' });
+counter.tell({ kind: 'inc' });
+
+const value = await counter.ask<number>({ kind: 'get' }, 5_000);
+console.log(value);  // 2
+```
+
+### Event-sourced actor
+
+State is rebuilt from a journal on every restart — no in-place
+mutation, no "did this write commit?" question. Same `Counter` API
+the rest of the app sees, every mutation durable.
+
+```ts
+import { PersistentActor, ActorSystem, Props } from 'actor-ts';
+
+type Command   = { kind: 'inc' } | { kind: 'dec' };
+type Event = { kind: 'incremented' } | { kind: 'decremented' };
+interface State { count: number }
+
+class Counter extends PersistentActor<Command, Event, State> {
+  readonly persistenceId = 'counter-1';
+  initialState(): State { return { count: 0 }; }
+  onEvent(s: State, e: Event): State {
+    return e.kind === 'incremented'
+      ? { count: s.count + 1 }
+      : { count: s.count - 1 };
+  }
+  onCommand(_state: State, cmd: Command): void {
+    this.persist({
+      kind: cmd.kind === 'inc' ? 'incremented' : 'decremented',
+    });
+  }
+}
+```
+
+### Cluster sharding — N instances behind one ref
+
+Same actor code; the framework routes per-entity messages to the
+correct node in the cluster and migrates entities when nodes come
+and go. The `ShardRegion` ref you get back behaves like any other
+`ActorRef` to callers.
+
+```ts
+import { Cluster } from 'actor-ts';
+
+// One-call bootstrap — system + cluster + receptionist + SIGTERM
+// wiring in one line.  Discovery defaults to an env-driven chain
+// (CLUSTER_SEEDS → K8s API → DNS); local dev with no env produces
+// a single-node cluster, which is exactly what you want.
+const { system, cluster } = await Cluster.bootstrap({ name: 'app' });
+
+const cartRegion = cluster.sharding.start('cart', CartActor, {
+  extractEntityId: (msg: CartCommand) => msg.entityId,
+});
+
+cartRegion.tell({ entityId: 'user-42', kind: 'add', sku: 'book-1' });
+```
+
+---
+
+## Documentation
+
+> 📚 **[actor-ts.dev](https://actor-ts.dev/)** —
+> full documentation site with concept guides, runnable examples, and an
+> auto-generated API reference.
+
+The docs site is the canonical entry point.  Highlights:
+
+- **[Quickstart](https://actor-ts.dev/intro/quickstart/)** —
+  hello-actor in five minutes.
+- **[Why actors?](https://actor-ts.dev/intro/why-actors/)** —
+  what the actor model gives you that Promise/Worker code doesn't.
+- **[Migrating from Akka / Pekko / Orleans](https://actor-ts.dev/migration/overview/)** —
+  for people coming from another actor framework.
+- **[API reference](https://actor-ts.dev/api/)** —
+  every public class, function, type generated from JSDoc.
+
+---
+
+## Examples
+
+Two end-to-end sample apps that exercise the framework comprehensively, each
+with six interchangeable frontends (Plain HTML, Lit, Angular, React, Next.js,
+SvelteKit) talking the same WebSocket protocol to a clustered backend:
+
+- **[`examples/chat/`](./examples/chat/)** — multi-room chat with sharding,
+  persistence, DMs, typing indicators, read receipts, production-realistic
+  auth.  Demonstrates `ClusterSharding`, `DistributedPubSub`, `PersistentActor`,
+  `DistributedData` (ORSet, LWWMap), `ClusterSingleton`, failover.
+- **[`examples/voice/`](./examples/voice/)** — voice rooms with PCM-encoded
+  audio streaming over WebSocket.  Same cluster infrastructure, different
+  protocol shape.
+
+Run either with `bun examples/chat/backend/main.ts --port 2551` (then
+`--seeds localhost:2551` on additional terminals), open
+`http://localhost:8080`, pick a frontend, and poke.
+
+---
+
+## Roadmap & status
+
+See [`ROADMAP.md`](./ROADMAP.md) for what's done and what's planned.  The
+[`CHANGELOG.md`](./CHANGELOG.md) tracks per-version changes — pre-1.0 minor
+bumps are potentially breaking; check the changelog before upgrading.
+
+Issues and feature requests live on
+[GitHub](https://github.com/pathosDev/actor-ts/issues).
+
+---
+
+## Star History
+
+<a href="https://www.star-history.com/?repos=pathosDev%2Factor-ts&type=date&legend=top-left">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=pathosDev/actor-ts&type=date&theme=dark&legend=top-left&sealed_token=iyC35jF1VENIymplLwZ8Cn2oNYPgr_OxQBWJfsv8Zl0v59Pkk9eKbLf1Gy2VWG_U3xuXb_xL0AAo5KD6Zz9p3izijymg6rD60G6pDZhdGrWgybY6vbLayqijq5n-qYdEyva0SkJ1TCWfrl0uSXCU5LyUa0I_Hz4wbgyrFObbeBFFxzRDMxrNVlNH6f_6" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=pathosDev/actor-ts&type=date&legend=top-left&sealed_token=iyC35jF1VENIymplLwZ8Cn2oNYPgr_OxQBWJfsv8Zl0v59Pkk9eKbLf1Gy2VWG_U3xuXb_xL0AAo5KD6Zz9p3izijymg6rD60G6pDZhdGrWgybY6vbLayqijq5n-qYdEyva0SkJ1TCWfrl0uSXCU5LyUa0I_Hz4wbgyrFObbeBFFxzRDMxrNVlNH6f_6" />
+   <img alt="Star History Chart" src="https://api.star-history.com/chart?repos=pathosDev/actor-ts&type=date&legend=top-left&sealed_token=iyC35jF1VENIymplLwZ8Cn2oNYPgr_OxQBWJfsv8Zl0v59Pkk9eKbLf1Gy2VWG_U3xuXb_xL0AAo5KD6Zz9p3izijymg6rD60G6pDZhdGrWgybY6vbLayqijq5n-qYdEyva0SkJ1TCWfrl0uSXCU5LyUa0I_Hz4wbgyrFObbeBFFxzRDMxrNVlNH6f_6" />
+ </picture>
+</a>
+
+---
+
+## License
+
+[Apache 2.0](./LICENSE).

package/dist/Actor.d.ts

@@ -13,14 +13,14 @@ import type { Option } from './util/Option.js';
  * onReceive is never invoked concurrently for the same actor.  If onReceive
  * returns a Promise, the runtime awaits it before starting the next message.
  */
-export declare abstract class Actor<TMsg = unknown> {
+export declare abstract class Actor<TMessage = unknown> {
     /** @internal — injected by ActorCell at construction time. */
     private _context;
     /** @internal */
-    _attach(context: ActorContext<TMsg>): void;
+    _attach(context: ActorContext<TMessage>): void;
     /** Runtime context. Only valid after the actor has been started. */
-    protected get context(): ActorContext<TMsg>;
-    protected get self(): ActorRef<TMsg>;
+    protected get context(): ActorContext<TMessage>;
+    protected get self(): ActorRef<TMessage>;
     protected get sender(): Option<ActorRef>;
     protected get system(): ActorSystem;
     protected get log(): Logger;
@@ -28,7 +28,7 @@ export declare abstract class Actor<TMsg = unknown> {
      * Main message handler.  Receives each envelope dequeued from the mailbox.
      * A thrown error (sync or async) is caught by the supervisor.
      */
-    abstract onReceive(message: TMsg): void | Promise<void>;
+    abstract onReceive(message: TMessage): void | Promise<void>;
     /** Called after construction and before the first message is processed. */
     preStart(): void | Promise<void>;
     /** Called after the actor has been terminated. Children are already stopped. */
@@ -37,7 +37,7 @@ export declare abstract class Actor<TMsg = unknown> {
      * Called before a restart, on the instance about to be thrown away.
      * The default stops children and then calls postStop().
      */
-    preRestart(_reason: Error, _message?: TMsg): void | Promise<void>;
+    preRestart(_reason: Error, _message?: TMessage): void | Promise<void>;
     /** Called on the fresh instance after a restart.  Default: call preStart(). */
     postRestart(_reason: Error): void | Promise<void>;
     /**

package/dist/Actor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Actor.d.ts","sourceRoot":"","sources":["../src/Actor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAmB,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;GAQG;AACH,8BAAsB,KAAK,CAAC,IAAI,GAAG,OAAO;IACxC,8DAA8D;IAC9D,OAAO,CAAC,QAAQ,CAAsB;IAEtC,gBAAgB;IAChB,OAAO,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,GAAG,IAAI;IAI1C,oEAAoE;IACpE,SAAS,KAAK,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,CAA0B;IAErE,SAAS,KAAK,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,CAA+B;IACnE,SAAS,KAAK,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAiC;IACzE,SAAS,KAAK,MAAM,IAAI,WAAW,CAAiC;IACpE,SAAS,KAAK,GAAG,IAAI,MAAM,CAA8B;IAEzD;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEvD,2EAA2E;IAC3E,QAAQ,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhC,gFAAgF;IAChF,QAAQ,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjE,+EAA+E;IAC/E,WAAW,CAAC,OAAO,EAAE,KAAK,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjD;;;OAGG;IACH,kBAAkB,IAAI,kBAAkB;CACzC"}
+{"version":3,"file":"Actor.d.ts","sourceRoot":"","sources":["../src/Actor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAmB,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;GAQG;AACH,8BAAsB,KAAK,CAAC,QAAQ,GAAG,OAAO;IAC5C,8DAA8D;IAC9D,OAAO,CAAC,QAAQ,CAA0B;IAE1C,gBAAgB;IAChB,OAAO,CAAC,OAAO,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,IAAI;IAI9C,oEAAoE;IACpE,SAAS,KAAK,OAAO,IAAI,YAAY,CAAC,QAAQ,CAAC,CAA0B;IAEzE,SAAS,KAAK,IAAI,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAA+B;IACvE,SAAS,KAAK,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAiC;IACzE,SAAS,KAAK,MAAM,IAAI,WAAW,CAAiC;IACpE,SAAS,KAAK,GAAG,IAAI,MAAM,CAA8B;IAEzD;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3D,2EAA2E;IAC3E,QAAQ,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhC,gFAAgF;IAChF,QAAQ,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrE,+EAA+E;IAC/E,WAAW,CAAC,OAAO,EAAE,KAAK,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjD;;;OAGG;IACH,kBAAkB,IAAI,kBAAkB;CACzC"}

package/dist/Actor.js.map

@@ -1 +1 @@
-{"version":3,"file":"Actor.js","sourceRoot":"","sources":["../src/Actor.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAsB,MAAM,kBAAkB,CAAC;AAGvE;;;;;;;;GAQG;AACH,MAAM,OAAgB,KAAK;IACzB,8DAA8D;IACtD,QAAQ,CAAsB;IAEtC,gBAAgB;IAChB,OAAO,CAAC,OAA2B;QACjC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,oEAAoE;IACpE,IAAc,OAAO,KAAyB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAErE,IAAc,IAAI,KAAqB,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IACnE,IAAc,MAAM,KAAuB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IACzE,IAAc,MAAM,KAAkB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IACpE,IAAc,GAAG,KAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAQzD,2EAA2E;IAC3E,QAAQ,KAA0B,CAAC;IAEnC,gFAAgF;IAChF,QAAQ,KAA0B,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,OAAc,EAAE,QAAe;QACxC,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED,+EAA+E;IAC/E,WAAW,CAAC,OAAc;QACxB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,kBAAkB,KAAyB,OAAO,eAAe,CAAC,CAAC,CAAC;CACrE"}
+{"version":3,"file":"Actor.js","sourceRoot":"","sources":["../src/Actor.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAsB,MAAM,kBAAkB,CAAC;AAGvE;;;;;;;;GAQG;AACH,MAAM,OAAgB,KAAK;IACzB,8DAA8D;IACtD,QAAQ,CAA0B;IAE1C,gBAAgB;IAChB,OAAO,CAAC,OAA+B;QACrC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,oEAAoE;IACpE,IAAc,OAAO,KAA6B,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEzE,IAAc,IAAI,KAAyB,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IACvE,IAAc,MAAM,KAAuB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IACzE,IAAc,MAAM,KAAkB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IACpE,IAAc,GAAG,KAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAQzD,2EAA2E;IAC3E,QAAQ,KAA0B,CAAC;IAEnC,gFAAgF;IAChF,QAAQ,KAA0B,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,OAAc,EAAE,QAAmB;QAC5C,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED,+EAA+E;IAC/E,WAAW,CAAC,OAAc;QACxB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,kBAAkB,KAAyB,OAAO,eAAe,CAAC,CAAC,CAAC;CACrE"}