@xmachines/play-actor 6.0.0 → 7.0.0

package/README.md

@@ -2,7 +2,7 @@
 
 The actor contract of the XMachines Play Architecture. It names no state machine library.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-6.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-actor)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-7.0.0-blue)](https://www.npmjs.com/package/@xmachines/play-actor)
 
 ## Installation
 
@@ -78,6 +78,13 @@ const value: string = actor.state.get().value;
 A plain object satisfies the contract as well. Nothing here asks for a class.
 
 ```ts
+import type { PlayActor } from "@xmachines/play-actor";
+import { createAtom } from "@xmachines/play-atom";
+
+type Snapshot = { readonly value: string };
+type AuthEvent =
+	{ readonly type: "auth.login"; readonly username: string } | { readonly type: "auth.logout" };
+
 const actor: PlayActor<Snapshot, AuthEvent> = {
 	state: createAtom<Snapshot>({ value: "guest" }),
 	send: () => {},
@@ -98,6 +105,7 @@ actor class of its own engine, and the contract stays out of the inheritance.
 ```ts
 import type { PlayActor } from "@xmachines/play-actor";
 import type { Routable } from "@xmachines/play-router";
+import { createAtom } from "@xmachines/play-atom";
 import { Actor, type AnyActorLogic } from "xstate";
 
 class MyRoutableActor

package/dist/index.js

@@ -1,22 +0,0 @@
-/**
- * @xmachines/play-actor - the actor contract of the Play Architecture
- *
- * The contract is minimal, and it names no engine: `state` and `send`. A state machine
- * library is the concern of an adapter, and `@xmachines/play-xstate` is the adapter of
- * XState v5.
- *
- * A capability is optional, and each one lives with the package that holds its shared
- * machinery:
- * - `Routable`, for an actor with a routing support, is in `@xmachines/play-router`, with
- *   the bridge that reads it
- * - `Viewable`, for an actor with a view rendering, is in `@xmachines/play-view`, with the
- *   view store lifecycle, the context projection and the provider guards
- *
- * A consumer that needs one capability installs one package, and a consumer that needs
- * neither installs neither. Neither capability implies the other.
- *
- * @packageDocumentation
- * @see [Play RFC](../../docs/rfc/play.md)
- */
-export {};
-//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xmachines/play-actor",
-  "version": "6.0.0",
+  "version": "7.0.0",
   "private": false,
   "description": "The actor contract of the Play Architecture: state and send. It names no state machine library",
   "keywords": [
@@ -49,16 +49,16 @@
   },
   "devDependencies": {
     "@testing-library/jest-dom": "^7.0.1",
-    "@types/node": "^26.6.2",
-    "@xmachines/play-atom": "6.0.0",
-    "oxfmt": "^0.70.0",
-    "oxlint": "^1.85.0",
-    "vite": "^8.3.0",
-    "vitest": "^5.0.1",
+    "@types/node": "^26.6.4",
+    "@xmachines/play-atom": "7.0.0",
+    "oxfmt": "^0.71.0",
+    "oxlint": "^1.86.0",
+    "vite": "^8.3.2",
+    "vitest": "^5.0.3",
     "xstate": "^5.33.0"
   },
   "peerDependencies": {
-    "@xmachines/play-atom": "6.0.0"
+    "@xmachines/play-atom": "7.0.0"
   },
   "engines": {
     "node": ">=24.0.0"

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG"}

package/dist/play-actor.js

@@ -1,28 +0,0 @@
-/**
- * The actor contract of the Play Architecture.
- *
- * An actor of XMachines holds exactly two things, and this file names both:
- *
- * - `state`: the reactive snapshot, as an atom
- * - `send`: the typed event dispatch
- *
- * It names NO engine. A state machine library is the concern of an adapter, and
- * `@xmachines/play-xstate` is the adapter of XState v5.
- *
- * The contract was an abstract CLASS that extended `Actor` of `xstate`, and the class
- * carried no implementation at all: both members were abstract, and `instanceof` of it
- * appeared nowhere. Its whole effect was to force the inheritance of XState on every
- * consumer of the contract, including `@xmachines/play-view` and
- * `@xmachines/play-router`, which read `currentView`, `currentRoute` and `send`, and no
- * other member.
- *
- * A capability is optional, and each one lives with the package that holds its shared
- * machinery: `Routable` is in `@xmachines/play-router`, beside the bridge that reads it,
- * and `Viewable` is in `@xmachines/play-view`, beside the view store lifecycle. Neither
- * one names an engine, and neither one implies the other.
- *
- * @packageDocumentation
- * @see [Play RFC](../../docs/rfc/play.md)
- */
-export {};
-//# sourceMappingURL=play-actor.js.map

package/dist/play-actor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"play-actor.js","sourceRoot":"","sources":["../src/play-actor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG"}