@akterjs/client 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,18 @@
-# Temporary Holding Version
+# @akterjs/client
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Clients for calling actors from anywhere: an Effect client (`Room.client(key)`) and a Promise client (`createClient<App>`) with live query subscriptions. Runs in Bun, Node, Workers and browsers, so it imports only contracts.
+
+```sh
+npm install @akterjs/client
+```
+
+Docs: https://docs.akter.dev. Pricing: https://docs.akter.dev/pricing.
+
+Status: both clients work. The package root exports `createClient({ url, actors, headers?, fetch? })`, the Promise client: `akter.Room("lobby").post({ text: "hi" })` returns a Promise that rejects with the contract's error classes, so `instanceof` works, and its public types hold no Effect types. `@akterjs/client/effect` exports `akterClient({ url, headers?, fetch?, webSocket? })`, the layer behind `Room.client(key)`: it provides `RpcClient.Protocol` and `ActorClients` (`@akterjs/effect/contract/actor-client`). Both clients speak the Effect RPC that `akter dev` and Akter Cloud serve (`docs/adr/0016-clients-speak-effect-rpc-everywhere.md`): calls, queries, `create`, `ensure` and `warm` are NDJSON posts to `<url>/rpc` over `fetch`, and each live subscription is its own WebSocket to `<url>/rpc?request=<the RPC request as JSON>` with RPC JSON frames (`src/actor-protocol.layer.ts`). `headers()` runs for every request and every socket, so a refreshed token takes effect on the next one. A socket can't carry headers from a browser, so the client offers the subprotocols `akter-rpc` and `akter-auth.<token>` for an `Authorization: Bearer <token>` header, and sends the other headers in the RPC request frame; the token never goes in the URL. `webSocket` replaces the global `WebSocket` constructor. A subscription whose socket drops resubscribes with backoff (50 ms doubling, at most 5 s apart) and skips any update at or below the version it already delivered, so a reconnect never repeats an update. Both clients read their own writes: when a server answers a command or query `Exit` with the actor's commit `version`, as Akter Cloud does, the client keeps the highest version it has seen for that actor and key and sends it as each later request's `akter-floor` RPC header, and the server never answers it from a cache older than that (`src/read-floors.pure.ts`). `akter dev` answers no versions and gets no floor. Both clients mint a fresh command id for each command and retry a lost reply (a transport failure) with the same id, so a retried command takes effect once. The contract's errors and the hosted ones arrive as their own classes, and both `@akterjs/client` and `@akterjs/client/effect` re-export every hosted one a call can fail with (`ActorAlreadyExistsError`, `ActorNotCreatedError`, `ActorUnavailableError`, `CallerNotAllowedError`, `CommandIdExpiredError`, `HandlerFailedError`, `InvalidRequestError`, `UnauthenticatedError`, and for files `BlobTransferError`, `FileAccessDeniedError`, `FileNotFoundError`, `FilesUnavailableError` and `InvalidFileRequestError`), the same classes `@akterjs/effect` and `@akterjs/effect/contract/errors` export. A request the server ends with only an interrupt, which says it stopped the request without answering, fails with `ActorUnavailableError` ("…stopped this request before it answered. Retry shortly.") rather than interrupting the caller, so a CLI prints why instead of exiting 130 with nothing (`src/remote-interrupt.pure.ts`). A bundle test builds both clients and a contract for browsers and Workers and checks that only contract files and `effect` go in. `pnpm test` runs every client test on Node. `pnpm test:browser` and `pnpm test:workerd` run only the tests `vitest.config.ts` lists for headless Chromium and workerd, which is `tests/promise-client.adapter.portable.test.ts`: it drives the Promise client against a stubbed `fetch` that answers in the wire format, with no server. The other tests need Node, because the bundle test runs esbuild and the rest serve a room with `Akter.serve`. `@akterjs/conformance/client` holds the public-contract fixture both clients pass against `akter dev` here and against Akter Cloud in akter-cloud. Each query also has `subscribe`, and each actor has `state`: `room.messages.subscribe({ limit: 50 })` and `room.state` are streams on the Effect client, and on the Promise client `akter.Room("lobby").messages.subscribe({ limit: 50 }, render, onError?)` (a query declared without a payload subscribes as `subscribe(render, onError?)`) and `akter.Room("lobby").state.subscribe(render, onError?)` return a function that stops the subscription. Each update is `{ value, version }`, where `version` is the actor's journal position of the commit it reflects. An actor declared with `create` also has `create(input)` and `ensure(input)` on both clients: `create` fails with `ActorAlreadyExistsError` (exported by `@akterjs/effect`) when the actor exists, and `ensure` creates it only when it doesn't. Each mints a command id and retries a lost reply with it, like a command, so a retried create replays its first result instead of failing. Each actor also has `warm`: `room.warm` on the Effect client and `akter.Room("lobby").warm()` on the Promise client ask the server to open the actor before its first command, so a page can start the open on load and hide it behind the user's think time. A warm runs no command, journals nothing and leaves the actor's version as it was, and a warm on a key that was never created does nothing. Each actor also has `fork(into)`: `room.fork("copy")` on the Effect client and `akter.Room("lobby").fork("copy")` on the Promise client copy the actor at the moment the fork runs into the new key and return a client or handle on the copy. The copy starts quiet (no timers, outbox or running jobs, `docs/adr/0017-forks-start-quiet.md`), and later commands to either side don't reach the other. Each fork mints a command id and retries a lost reply with it, so a retried fork makes one copy; a fork into a key that exists fails with `ActorAlreadyExistsError`. `akter dev` forks. Akter Cloud refuses the fork RPC for every caller by design (`InvalidRequestError`): a fork there is an operator action on the Cloud API (decision 5), made with `akter actors fork`, the `actors_fork` MCP tool or the Cloud API's `actorForks.create`, `POST /v1/organizations/{organization}/apps/{app}/environments/{environment}/actors/{actor}/{key}/forks`.
+
+An actor whose contract declares `files: Akter.fileAccess({ callers })` has files on both clients; one without has no file calls, and its Promise handle has no `.files`. On the Promise client, `akter.Board("b1").files` has `upload(bytes)`, which takes a `Uint8Array` or a `ReadableStream<Uint8Array>` and resolves with the receipt, `list({ prefix?, limit?, cursor? })` and `usage(...)`, which resolve with `{ entries, cursor? }` (and `bytes` for usage), and `download(path, { offset, length }?)`, which resolves with a `ReadableStream<Uint8Array>`. The download is lazy: a missing file errors the stream with `FileNotFoundError` on its first read, not the Promise. A source stream that fails rejects the upload with `UploadSourceError`. On the Effect client, `akterClient` provides `ActorFileClients`, so `Room.files(key)` works over the network as it does in process: `upload(stream)` returns the receipt a command attaches with `Akter.files.attach(path, receipt)`, and `list`, `fileUsage` and `download(path, range?)` read what the actor holds. They are the `<Actor>/files/<operation>` RPCs ADR 0016 reserves, all NDJSON posts. Effect RPC has no client streams, so an upload is a session: `upload/open` returns an id bound to the actor, key and caller, `upload/append` sends chunks of at most 1 MiB in order and is idempotent by offset, so a lost reply is retried with the same offset, and `upload/close` checks the length and returns the receipt. A download streams chunks of at most 256 KiB. The server admits a file call only from a caller kind the declaration lists, and then runs the actor's `files.authorize` rule, which reads the state and the verified principal and refuses with `FileAccessDeniedError` unless it allows the call; a download's path is checked before the rule sees it. A fork admits only an app's operators, the `user` and `apiKey` kinds, because it runs no handler. The key must decode with the actor's key schema. A session another actor, key or caller names is refused. The server keeps at most 64 open sessions, 8 per caller and 8 per actor, and drops one idle for 60 seconds. A file past 1 GiB fails with `FileTooLargeError`. An actor holds at most 16 receipts no command has attached, and a receipt expires an hour after its upload closes.
+
+`@akterjs/client/operations` is the actor half of the operation registry that drives the `akter` CLI and the hosted MCP server (the Cloud half is `@akterjs/cloud-api/operations`): `actorOperations` lists each exposed kind (`call`, `query`, `state`, `watch`, `create`, `ensure`, `fork`, and the file kinds `files/list`, `files/usage`, `files/download` and `files/upload`, whose three session RPCs are one kind) with its command, tool name, input schema and annotations, `kindsOf` gives every RPC of an actor's group its kind or none, so a new kind of RPC fails the coverage test until it has an operation, and `actorRequestOf` builds the RPC tag and payload a caller sends, minting a UUIDv7 command id when the kind takes one and none was given. `@akterjs/client/actor-rpc` holds the one-RPC unary and streaming clients those requests go through, with schema-free JSON payloads, and the file transfers both callers run: `uploadSession({ request, content, wait })` opens an upload, appends the bytes in chunks of at most 1 MiB at their offsets and closes it for the receipt, and `downloadChunks({ request, wait })` collects a download's base64 chunks, failing whole rather than returning part of a file.
+
+- Depends on: `@akterjs/effect` (peer, contracts only) and `effect` (peer). `@akterjs/effect` is a peer so the app and the client share one copy: the client decodes errors into its classes, and a second copy would break `instanceof` on them.
+- Must not depend on: any private package.

package/dist/actor-fields.pure.d.mts

@@ -0,0 +1,77 @@
+import { Schema } from "effect";
+type JsonObject = Schema.JsonObject;
+declare const fieldSchemas: {
+  actor: {
+    description: string;
+    type: string;
+  };
+  after: {
+    description: string;
+    type: string;
+  };
+  commandId: {
+    description: string;
+    type: string;
+  };
+  computer: {
+    description: string;
+    type: string;
+  };
+  computerPath: {
+    description: string;
+    type: string;
+  };
+  content: {
+    description: string;
+    type: string;
+  };
+  cursor: {
+    description: string;
+    type: string;
+  };
+  direction: {
+    description: string;
+    enum: string[];
+    type: string;
+  };
+  into: {
+    description: string;
+  };
+  key: {
+    description: string;
+  };
+  length: {
+    description: string;
+    type: string;
+  };
+  limit: {
+    description: string;
+    type: string;
+  };
+  member: {
+    description: string;
+    type: string;
+  };
+  offset: {
+    description: string;
+    type: string;
+  };
+  path: {
+    description: string;
+    type: string;
+  };
+  payload: {
+    description: string;
+  };
+  prefix: {
+    description: string;
+    type: string;
+  };
+  step: {
+    description: string;
+    type: string;
+  };
+};
+type FieldName = keyof typeof fieldSchemas;
+declare const inputOf: (fields: readonly FieldName[]) => JsonObject;
+export { type FieldName, inputOf };

package/dist/actor-fields.pure.mjs

@@ -0,0 +1,85 @@
+import { Array, Record } from "effect";
+// src/actor-fields.pure.ts
+const fieldSchemas = {
+	actor: {
+		description: "The actor's name in the app, such as Sale.",
+		type: "string"
+	},
+	after: {
+		description: "Only log lines after this seq, the last one a page before printed, to read on from there.",
+		type: "integer"
+	},
+	commandId: {
+		description: "An id for this call, so a retry with the same id runs it once. A new one is made when it is missing.",
+		type: "string"
+	},
+	computer: {
+		description: "The computer's name, as the actor named it.",
+		type: "string"
+	},
+	computerPath: {
+		description: "Relative path in the computer's files directory.",
+		type: "string"
+	},
+	content: {
+		description: "The file's bytes, as base64.",
+		type: "string"
+	},
+	cursor: {
+		description: "Where the page to read starts, from the cursor of the page before.",
+		type: "string"
+	},
+	direction: {
+		description: "toComputer or fromComputer; copy-back returns an upload receipt.",
+		enum: ["toComputer", "fromComputer"],
+		type: "string"
+	},
+	into: { description: "The new actor's key, as JSON. A bare word is taken as a string key." },
+	key: { description: "The actor's key, as JSON. A bare word is taken as a string key." },
+	length: {
+		description: "How many bytes to read, from offset; give both or neither.",
+		type: "integer"
+	},
+	limit: {
+		description: "The most entries to return.",
+		type: "integer"
+	},
+	member: {
+		description: "The command or query to run.",
+		type: "string"
+	},
+	offset: {
+		description: "The byte to start reading at, with length; give both or neither.",
+		type: "integer"
+	},
+	path: {
+		description: "The file's path in the actor, such as photos/cat.png.",
+		type: "string"
+	},
+	payload: { description: "The command's, query's or create input's payload, as JSON." },
+	prefix: {
+		description: "Only paths that start with this.",
+		type: "string"
+	},
+	step: {
+		description: "The step's id, as steps list prints it.",
+		type: "string"
+	}
+};
+const optional = [
+	"after",
+	"commandId",
+	"cursor",
+	"length",
+	"limit",
+	"offset",
+	"payload",
+	"prefix"
+];
+const inputOf = (fields) => ({
+	additionalProperties: false,
+	properties: Record.fromEntries(Array.map(fields, (name) => [name, fieldSchemas[name]])),
+	required: Array.filter(fields, (name) => !Array.contains(optional, name)),
+	type: "object"
+});
+export { inputOf };

package/dist/actor-operations.pure.d.mts

@@ -0,0 +1,49 @@
+import { FieldName } from "./actor-fields.pure.mjs";
+import { Effect, Option, Schema } from "effect";
+import { SecureRandom } from "effect/crypto";
+import { Rpc } from "effect/rpc";
+type JsonObject = Schema.JsonObject;
+interface Annotations {
+  readonly confirm: boolean;
+  readonly destructive: boolean;
+  readonly idempotent: boolean;
+  readonly openWorld: boolean;
+  readonly readOnly: boolean;
+}
+type ActorKind = "call" | "computers/cp" | "computers/delete" | "computers/get" | "computers/list" | "computers/logs" | "computers/pause" | "computers/resume" | "computers/stop" | "create" | "ensure" | "files/download" | "files/list" | "files/upload" | "files/usage" | "fork" | "query" | "state" | "steps/get" | "steps/list" | "warm" | "watch";
+interface ActorOperation {
+  readonly annotations: Annotations;
+  readonly flag: Option.Option<string>;
+  readonly command: readonly [string, string];
+  readonly description: string;
+  readonly fields: readonly FieldName[];
+  readonly id: string;
+  readonly input: JsonObject;
+  readonly kind: ActorKind;
+  readonly stream: boolean;
+  readonly tool: string;
+}
+declare const unexposedKinds: readonly ActorKind[];
+declare const actorOperations: readonly ActorOperation[];
+interface Addressed {
+  readonly actor: string;
+  readonly kind: ActorKind;
+  readonly member: string;
+}
+declare const tagOf: ({ actor, kind, member }: Addressed) => string;
+declare const kindsOf: (requests: ReadonlyMap<string, Rpc.AnyWithProps>) => readonly (readonly [string, Option.Option<ActorKind>])[];
+interface ActorInput {
+  readonly actor: string;
+  readonly commandId: Option.Option<string>;
+  readonly fileFields: Readonly<Record<string, Schema.Json>>;
+  readonly into: Option.Option<Schema.Json>;
+  readonly key: Schema.Json;
+  readonly member: string;
+  readonly payload: Option.Option<Schema.Json>;
+}
+interface ActorRequest {
+  readonly payload: Readonly<Record<string, Schema.Json>>;
+  readonly tag: string;
+}
+declare const actorRequestOf: (operation: ActorOperation) => ((input: ActorInput) => Effect.Effect<ActorRequest, never, SecureRandom.SecureRandom>);
+export { type ActorInput, type ActorKind, type ActorOperation, type ActorRequest, type Annotations, type FieldName, actorOperations, actorRequestOf, kindsOf, tagOf, unexposedKinds };