beachside 0.0.0-stage → 0.8.0

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,121 @@
-# Temporary Holding Version
+# TypeScript resource SDK
 
-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.
+`beachside` uses an installed adapter in the caller's server-side Node.js or Bun process. Official Daytona and E2B adapters are available from `@beachside/daytona` and `@beachside/e2b`. The experimental Modal integration is installed separately as `@beachside/modal` and uses the same public adapter contract as custom integrations. The fake provider is a deterministic test fixture. Live provider qualification remains separate from the packaged API shape.
+
+Install `beachside @beachside/daytona` (or `beachside @beachside/e2b`).
+
+```ts
+import { Beachside } from "beachside";
+import { daytona } from "@beachside/daytona";
+
+const beachside = await Beachside.connect(daytona({ apiKey: process.env.DAYTONA_API_KEY!, target: "us" }));
+await beachside.close();
+```
+
+```ts
+import { Beachside, Image } from "beachside";
+import { daytona } from "@beachside/daytona";
+
+const beachside = await Beachside.connect(daytona({ apiKey: process.env.DAYTONA_API_KEY!, target: "us" }));
+try {
+  const box = await beachside.sandboxes.create({ environment: Image.prepared("your-snapshot-id") });
+  try {
+    const result = await box.exec(["printf", "hello"]);
+    console.log(result.stdoutText(4096));
+  } finally {
+    await box.destroy();
+  }
+} finally {
+  await beachside.close();
+}
+```
+
+Provider credentials remain in the caller's process and are inappropriate for browser code. The repository's deterministic fake provider is an internal test fixture and is not published with the SDK.
+
+`exec` and `submitExec` accept a `readonly string[]` shorthand, such as `box.exec(["git", "status"])`. Each element is a literal argument; arrays never invoke a shell. The shorthand uses the same validation and defaults as `{ command: { kind: "argv", argv } }`, including rejection of empty arrays. Use the object form for `cwd`, `env`, deadlines, output limits, or an explicit `{ kind: "shell", script }` command. Arguments are copied before dispatch.
+
+`exec` returns exact `Uint8Array` stdout/stderr. A nonzero exit throws `NonzeroExitError` with the captured result; a completed execution with no exit code throws `NoExitCodeError`. Transport errors and unknown effects use separate errors. `stdoutText()` and `stderrText()` decode every captured byte as UTF-8 without a suffix; exported `outputText(bytes)` decodes every supplied byte. Existing `{ full: true }` calls remain equivalent. Pass an explicit numeric limit for bounded display, or use `stdoutPreview({ maxBytes? })` / `stderrPreview({ maxBytes? })` for `{ text, shortened }` with a 16 KiB default. Check `result.truncated` before parsing captured output. Full decoding cannot recover discarded capture; `shortened` is independent of `result.truncated`. Invalid display limits/options throw local `RangeError`s. File reads and writes default to a 1 MiB buffer bound; explicit `maxBytes` permits up to 16 MiB. Larger artifacts use `readFileStream`/`writeFileStream` with awaited byte chunks and no default whole-file ceiling.
+
+`submitCreate` and `box.submitExec` return operation handles with `reference`, `observe()`, and `wait({ signal })`. Ordinary `create` and `exec` call `wait` themselves. A direct operation has `durability: "process"`. An abort signal stops waiting, not provider compute. If it fires after an ordinary mutation was submitted, `WaitAbortedError` carries the recovery reference and original abort reason. `close()` releases client-owned state and never destroys a sandbox; call `box.destroy()` explicitly.
+
+References are versioned, serializable, and contain no credentials, command, environment, or file bytes. A direct reference records verified native scope, submission identity, and any required locator. The caller must separately configure a provider with the same scope to import it through `recover(reference)`. Recovery only observes; it never submits the mutation again. If native submission discovery is unavailable, an unknown effect remains unknown. Applications requiring a durable submission marker can use the optional `client.operations.prepare(...).submit(..., { beforeSubmit, onCheckpoint })` lifecycle, where `onCheckpoint` durably saves each versioned token before the provider proceeds, then persist pending-token updates and use observation-only recovery. Advanced mutations that call `ctx.checkpoint()` stop if this callback is missing or fails.
+
+`await client.capabilities()` and `await box.capabilities()` return dated, detached observations that retain command, image, network, and file facts. State support has four outcomes: `supported`, `unsupported`, `unavailable`, and `unknown`. `await client.sandboxes.checkCreate(input)` and `await box.checkSnapshot(request)` are read-only checks on SDK connections. They never build images, reserve compute, stop a sandbox, or submit a capture. A supported check resolves a single profile with exact preservation, bounded interruption, source state, consistency, mount handling, and retention evidence; it is not a reservation. Snapshot restore and volume operations report provider-specific support independently.
+
+Creation can require snapshot guarantees with `requirements: { snapshot: { requirements: { preserve: "filesystem" } } }`. `box.snapshot()` accepts the configured native default; optional requirements reject unsupported guarantees before effects. Daytona container capture stops/captures/restarts and preserves the filesystem with fresh restore execution. E2B capture preserves filesystem and memory. Unsupported combinations fail before allocation with `UNSUPPORTED` and `effect: "none"`; unavailable or unknown evidence fails with `UNAVAILABLE`. The mutation revalidates its plan before submission.
+
+Snapshot handles expose inspect and separately supported restore/delete operations. Volume handles expose native management and create-time mount descriptors. Daytona supports restore and verified mounts. E2B restores the saved native build UUID with `templateId:buildUUID` and cleans up its dedicated containing template after identity, scope and dependency checks; E2B mounts remain unsupported because the pinned API exposes reusable names without mounted native IDs. Writable mounted compute needs explicit `storage: "allow-unconfirmed"` cleanup when shutdown durability cannot be established; destroy never deletes independently retained storage. Provider capabilities and live qualification remain separate evidence.
+
+`ResourceReference` is the version-1 schema for resource identity, separate from an operation recovery reference. It supports sandbox, image, snapshot, volume, volume-version, mount, and session kinds, with verified provider scope, native locator, optional native generation, and ownership evidence (`borrowed`, `verified-created`, or `unknown`). `validateResourceReference`, `assertResourceScope`, and `assertResourceIdentity` validate serialized data and known identity. An adapter must supply generation evidence when a locator can be reused; the SDK never invents a generation or treats a reference as authority. These descriptors do not open, inspect, or delete artifacts, and cannot certify expiry or native ownership by themselves.
+
+Requirement reads finish before the durable submission marker; the approved preparation is then dispatched without another capability read. For already-stopped sources, an unchanged lifecycle request accepts a stopped outcome.
+
+Tracing uses your application’s OpenTelemetry provider. Set `tracing: false` to disable Beachside spans and propagation, or inject `tracing: { tracerProvider }`. Beachside never configures exporters or shuts down your provider. See the [tracing and safe diagnostics guide](https://beachside.run/docs/observability/) for pinned Node/Bun recipes and local-only vendor evidence; metrics and structured logs are a later release.
+
+Persist resource and operation references as versioned JSON in your own application storage. Their historical observations do not depend on the original API key or a mandatory signature. Reopen with current credentials for the same verified native scope; E2B credential rotation requires verified `teamId` configuration. `onReference` is awaited before stage dispatches and when evidence changes. Observation stays read-only; explicit `operation.continue()` may advance a proven never-submitted next stage. Serialize continuation across processes through your own lease or compare-and-swap. E2B cleanup deletes the containing template, not an individual build, and rejects known shared expansion; the provider offers no transactional read/delete generation condition.
+
+Empty restore resource maps and mount arrays are equivalent to omission. The SDK temporarily accepts legacy empty mount objects at runtime; see the migration below. Snapshot and volume deletion persist a rejected stage when cancellation is known to precede native dispatch. The SDK allows up to one second after caller cancellation to join deletion finalization and surface a proven rejection with `effect: "none"`; client close remains immediate, and a stalled finalization still reports uncertainty. Other mutation waits retain their existing cancellation behavior.
+
+Start with the [everyday SDK guides](https://beachside.run/docs/guides/resources/) and [snapshots/volumes](https://beachside.run/docs/guides/snapshots-and-volumes/). Save `captured.snapshot.reference` or `volume.reference` in application storage and reopen with `client.snapshots.get(...)` or `client.volumes.get(...)` on a fresh matching connection. Handles expose `provider` and `id`. Confirmed partial capture errors expose the snapshot reference and capture details through `BeachsideError.outcome`; do not parse native tokens or repeat capture. The [compiled example](../../apps/docs/examples/recovery-outcomes.ts) demonstrates these paths. Existing checkpoint/continuation APIs are advanced compatibility paths, not a prerequisite for ordinary application persistence.
+
+For explicit direct connection annotations, import `DirectBeachsideClient` and `DirectSandboxHandle` from `beachside`. They include `client.snapshots`, `client.volumes` and `sandbox.snapshot()`. `BeachsideClient` and `SandboxHandle` are aliases for those complete SDK surfaces.
+
+Malformed snapshot requests, restore requests, inventory inputs, volume creation inputs and mount descriptors reject with `BeachsideError` (`INVALID_ARGUMENT`, effect `none`) before provider mutation. Restore preflight uses `UnsupportedFeatureError.unmetRequirements` to report network policy, sizing, independent lifecycle and mount limitations together. Native response validation remains separate from caller input errors.
+
+Create and restore share `mounts: MountSpec[]` from `volume.at(path)`. Daytona selects exact current volumes alongside known mount-free filesystem/fresh snapshot state under `internet` or `daytona-default` networking; mounted `blocked` restore rejects before allocation. Unknown/recorded mount provenance and memory composition remain unsupported. No implicit storage creation, copying or name substitution occurs. Independent lifecycle is required unless explicitly set to `false`.
+
+The coordinated SDK/adapter release R replaces legacy action maps. Nonempty maps reject with `INVALID_ARGUMENT` and migration guidance. The SDK-only empty-object alias remains in R and the next published release R+1, then is removed at the next API release. Public types use arrays. Nonempty arrays require `snapshotRestore.mountInput: "specs"` before hook preparation; older hooks receive mount-free requests with no mounts field. Record actual R during version preparation. Snapshot, volume, sandbox and operation reference formats stay unchanged.
+
+Unknown restore outcomes expose selected `mounts` and an acknowledged `sandbox` reference when available. Persist these with the operation reference and reconcile read-only without another allocation. The first bounded mounted-restore acceptance at `824946d` passed A startup evidence, then failed a harness snapshot-name/ID assertion before B. The corrected workflow passed live at `5911ccc`: A and independently empty B passed first-action selected-data checks, private-state preservation, exact native identities and fresh-client reopening, with all owned resources cleaned up. Deterministic and packed evidence are separate from live qualification.
+
+
+## Reopen Beachside-created compute
+
+Direct SDK sandbox handles expose `reference: SandboxReference | null`. Save that reference in an application-owned trusted store and configure a fresh connection with the same native binding:
+
+```ts
+const reference = sandbox.reference ?? (await sandbox.inspect()).reference;
+if (!reference) throw new Error("Verified sandbox identity is unavailable");
+const saved = JSON.parse(JSON.stringify(reference));
+await client.close();
+const reopened = await freshClient.sandboxes.get(saved);
+const info = await reopened.inspect();
+if (info.state === "running") {
+  const bytes = await reopened.readFile("/tmp/work.txt");
+  const output = await reopened.exec(["/bin/sh", "-c", "printf reopened"]);
+}
+```
+
+References contain native identity, provider/scope and the native creation selectors required for verification; no credentials, observations or workflow journal. Successful create, snapshot restore and recovered results issue references after native verification. Legacy adapters may return null; a failed optional identity read after confirmed Daytona creation also returns a usable handle with null reference rather than hiding completed creation. A later `inspect().reference` can supply verified identity when native metadata becomes readable. Do not save null or synthesize a reference from the display ID.
+
+`get` reads native detail and never creates, resumes or extends lifetime. Stopped/suspended resources remain inactive. `inspect` supplies current `nativeState`, local receipt `observedAt`, hard expiry, idle-stop policy and stopped-retention facts. Unknown facts remain unknown; an elapsed deadline alone does not establish deletion. Missing/expired/deleted resources fail `NOT_FOUND`, native authorization fails `FORBIDDEN`, transport/detail access fails `UNAVAILABLE`, and identity/configuration mismatch fails `CONFLICT`. A destroyed tombstone can be inspected but cannot be reopened.
+
+Applications own persistence, fresh credentials and serialization of competing operations. There is a crash window before the reference is saved. Operation recovery references retain the verified sandbox reference so fresh-process observation and continuation check the original creation correlation. Older operation references retain their ID-only behavior. Existing operation recovery remains separate and read-only; reopening compute does not replay a command or recover a mutation. Configured `renew()` and native `suspend()`/`resume()` are available through optional adapter hooks; no implicit mutation is added to reopening. Deterministic/packed tests cover this slice; its new live reopening workflow has not run.
+
+## Native sandbox suspension
+
+Configure `lifecycle.suspension.preserve` once on a compatible adapter as a minimum, then call `await box.suspend()`. Save `box.reference`, open it with `await freshClient.sandboxes.get(savedReference)` while inactive, and call `await box.resume()` explicitly. Submit forms use the existing operation/result/recovery conventions. Daytona containers preserve filesystem and terminate processes; E2B pauses with memory and reports unknown execution continuity on resume. Both drop connections, retain the same scoped ID and never replace expired compute. Daytona requires known empty native mounts. E2B rejects known native mounts but permits absent mount metadata without claiming an empty set; preservation covers private filesystem/RAM, excluding external-storage flush, durability, atomic consistency and remote connection continuity. Daytona hard TTL keeps ticking; E2B paused state has indefinite retention requiring explicit destruction. Lost ACK stays uncertain and recovery only observes; acknowledged native facts remain directly accessible on partial/aborted errors. Unsupported adapters still support their other operations. Daytona suspension passed live at `6796b30`; E2B's revised private-state mapping passed at `26f516d`, with earlier failures retained and owned cleanup confirmed.
+
+## Filesystem workflows
+
+`readDirectory` returns bounded immediate children with honest completeness and an observation timestamp. `statFile` reports link identity by default and only available metadata; `fileExists` distinguishes absence from permission/transport failure. Mkdir/remove preserve recursive opt-in. `copyFile` stages regular-file bytes and `moveFile` performs same-filesystem rename; both default to no-clobber. Daytona and E2B implement these operations on compatible private Linux filesystems with Python 3 and native rename prerequisites.
+
+Streams use `AsyncIterable<Uint8Array>` with backpressure and split chunks up to 64 KiB. `writeFileStream` returns the confirmed byte count. Configure `transfers: { setupTimeoutMs, inactivityTimeoutMs, overallTimeoutMs }` on connection or override those fields per call. Defaults are 30-second setup, 60-second active IO inactivity and no overall deadline. Consumer processing does not trigger inactivity failure. `FilesystemError.details` retains known source/destination, temporary paths and transferred bytes when remote effects or cleanup are uncertain; do not replay uncertain mutations. A timeout or cancellation during staging cleanup preserves `effect: "applied"` after confirmed publication, with remaining correlated temporary paths indicating unfinished cleanup. See [the portable artifact recipe](../../apps/docs/examples/directory-files.ts) and [file guide](../../apps/docs/src/content/docs/docs/guides/files-and-output.md).
+
+`walkFiles(path, { maxDepth, maxEntries, exclude, signal })` yields deterministic depth-first entries with absolute `path`, root-relative `relativePath` and `depth` (children start at 1). Defaults are depth 32 and 10,000 observed entries; exact relative-path exclusions prune subtrees, and excluded entries still count. Symlinks/unknown types are yielded without descent. Incomplete listings, unreadable subtrees and budget overflow reject. Traversal is an observation of a changing namespace, not a snapshot or confinement boundary.
+
+`readTextLines(path, { maxLineBytes, ...transferOptions })` incrementally decodes UTF-8, handles split code points and LF/CRLF, preserves lone CR, and yields the final unterminated line without a spurious terminal empty line. Malformed UTF-8 uses replacement decoding. The default line limit is 1 MiB of source bytes excluding delimiters; overflow rejects with `OUTPUT_CAPACITY`. Both helpers compose existing adapter hooks. Fixture/packed acceptance is separate from live evidence; the older `2f6afe8` artifact passes predate F4, while the expanded recipe passed at `e91f2d5` on both borrowed provider images with confirmed cleanup. Range reads, batch transfer, glob/search and tree copy remain deferred.
+
+## Process output profiles
+
+Start a sustained process with `output: { mode: "stream" }` and consume `child.output()` promptly. The default yields separate stdout/stderr text. Choose `output: { mode: "stream", format: "bytes" }` before start to receive `{ stream, bytes: Uint8Array }` chunks containing original native bytes, including NUL and malformed UTF-8. Type inference selects `ProcessHandle<"bytes">`; no decoder or implicit re-encoding runs in this profile. Unsupported byte transports reject before starting.
+
+Both profiles have one consumer, 16 KiB maximum emitted chunks, and a 64 KiB/256-chunk pending queue. Admitted byte buffers are copied. Slow consumers receive explicit output failure while independently usable wait/status/input/termination remain available. Returning a sustained output iterator releases output only; `detach()` disposes the full local handle without terminating remote compute. Output completeness requires native end plus delivery of all admitted chunks. The byte profile promises per-stream byte order, with no framing or cross-stream ordering guarantee. PTYs and reconnection use the explicit APIs below.
+
+`child.signal("SIGTERM" | "SIGKILL")` requests a named signal independently of confirmed exit; `terminate()` remains the SIGKILL convenience. `child.reference()` snapshots a private, scoped, expiring JSON selector. Call `disconnect()` to park local observation without EOF or termination, then `box.processes.reopen(saved)` on the same sandbox through a fresh matching connection. An old handle is fenced; pending EOF or uncertain input prevents reference creation. Reopened handles expose `outputGap: true` and never claim complete output. There is no retained transcript replay or exact emission-time cutoff; native buffers may deliver earlier bytes. Reference availability is limited by native process/sandbox lifetime and at most 24 hours.
+
+`box.terminals.start({ command, columns: 80, rows: 24 })` creates an explicit controlling terminal. `output()` yields combined `Uint8Array` chunks; `write`, `resize`, status, wait, signals and termination remain portable. Terminals omit pipe EOF. Save their reference and use `box.terminals.reopen(saved)` for live reattachment. PTY echo, newline translation and buffering differ from ordinary pipes. `readProcessLines()` and `createProcessTail()` compose either text or byte pipe output into bounded diagnostic lines/windows with explicit partial/truncated flags; they do not retain provider logs or own compute. See the [process guide](../../apps/docs/src/content/docs/docs/guides/text-streaming.md) for limits and adapter guarantees.
+
+## Consumer types
+
+Use `BeachsideClient`, `SandboxHandle`, `SnapshotHandle`, `VolumeHandle`, `OperationHandle<T>` and `RecoveryReference` for application annotations. Concrete connection/handle declarations use the optional `true` type parameter to preserve their complete advanced and nominal compatibility surface; ordinary annotations retain their existing structural view. Concrete operations include a kind type parameter for continuation and recovery narrowing. Existing Adapter*/Direct* names, runtime classes and `instanceof` behavior remain supported. See the TypeScript reference for staged migration and advanced compatibility access.

package/dist/adapter-direct.d.ts

@@ -0,0 +1,299 @@
+import { type SandboxScopeOptions } from "./scoped-sandbox.js";
+import { type ConnectionWaitOptions, type CloseOptions } from "./connection-wait.js";
+import { type FileReadOptions, type FileWriteOptions, type FileStreamOptions, type FileStreamWriteOptions, type TransferPolicy } from "./file-transfer.js";
+import { type FileEntry } from "@beachside/adapter";
+import { type WalkFilesOptions, type WalkFileEntry, type ReadTextLinesOptions } from "./filesystem-extensions.js";
+import { type ProcessReference, type StartTerminalInput, type TerminalHandle, type ExecOptions, type StartProcessInput, type ProcessHandle, type ProcessOutputFormat } from "./processes.js";
+import { CaptureExpectation, type AdapterRecoveryReference as RecoveryReference } from "./adapter-reference.js";
+import { Telemetry, type ObservabilityOptions } from "./observability.js";
+import { SuspendResult, ResumeResult, type LifecycleIntent, type Preview, RenewRequest, RenewResult, type SandboxReference, type SandboxInfo as AdapterSandboxInfo, type Fact, type SandboxResources, type Support, SnapshotRequest, type SnapshotPlan, type CreatePlan, type DirectCapabilities } from "@beachside/adapter";
+import { z } from "zod";
+import { resourceManagers, type SandboxList, type SandboxListInput, type SnapshotResult, type WaitOptions } from "./resources.js";
+import { ResourceReference, type ArtifactDeletionResult, type DestroyValue, type OperationInput } from "@beachside/adapter";
+import { type AdapterConnection, type AdapterDefinition, type RuntimeSession, type CreateInput as AdapterCreateInput, type ImageBuildInput, type Json, type OperationKind, type PreparedOperation, type RuntimeResult, type Scope, type Sandbox } from "@beachside/adapter";
+import { type ReadOptions, type BeachsideClient, type SandboxHandle, type VolumeHandle, type OperationHandle, type CreateInput, type ExecInput, type ExecOutput, type ImageBuildResult } from "./resource.js";
+import type { BoundAdapter } from "./bound.js";
+/** A sandbox observation; `resources` is always present, as unknown when the adapter can't read it. */
+export type SandboxInfo = AdapterSandboxInfo & {
+    resources: Fact<SandboxResources>;
+};
+export { Image, outputText } from "./resource.js";
+export type { AdapterRecoveryReference } from "./adapter-reference.js";
+export type AdapterCapabilities = DirectCapabilities;
+export type RecoveredOperation = OperationHandle<SandboxHandle<true>, "create" | "snapshot_restore"> | OperationHandle<SuspendResult, "sandbox_suspend"> | OperationHandle<ResumeResult, "sandbox_resume"> | OperationHandle<RenewResult, "sandbox_renew"> | OperationHandle<SnapshotResult, "snapshot_capture"> | OperationHandle<VolumeHandle, "volume_create"> | OperationHandle<ArtifactDeletionResult, "snapshot_delete" | "volume_delete" | "image_delete"> | OperationHandle<ImageBuildResult, "image_build"> | OperationHandle<ExecOutput, "exec"> | OperationHandle<DestroyValue, "destroy"> | OperationHandle<void, "file_write" | "file_mkdir" | "file_remove">;
+/** Use the OperationHandle type for consumer annotations. This compatibility runtime class remains supported. */
+export declare class AdapterOperation<T, K extends OperationKind = OperationKind> {
+    #private;
+    private readonly client;
+    private readonly decode;
+    readonly kind: K;
+    readonly durability: "process";
+    private first;
+    get reference(): RecoveryReference;
+    private continuing;
+    private revision;
+    private persistence;
+    private persistedReference?;
+    private terminal?;
+    private pendingAt;
+    private nextPollAt;
+    constructor(client: AdapterDirectClient, reference: RecoveryReference, decode: (value: RuntimeResult, ref: RecoveryReference) => T, first?: RuntimeResult, kind?: K);
+    /** Advance proven unsubmitted stages. Applications serialize continuation across processes. */
+    continue(options?: {
+        signal?: AbortSignal;
+    }): Promise<this>;
+    private persistReference;
+    observe(): Promise<T | null>;
+    private observeWithSignal;
+    wait(options?: {
+        signal?: AbortSignal;
+        pollMs?: number;
+    }): Promise<T>;
+}
+/** Use the SandboxHandle type for consumer annotations. This compatibility runtime class remains supported. */
+export declare class AdapterSandbox {
+    #private;
+    private readonly client;
+    readonly id: string;
+    private invalidateProcessControl;
+    get reference(): SandboxReference | null;
+    constructor(client: AdapterDirectClient, id: string, reference?: SandboxReference | null);
+    readonly terminals: {
+        start: (input: StartTerminalInput, options?: WaitOptions) => Promise<TerminalHandle>;
+        reopen: (reference: ProcessReference<"bytes">, options?: WaitOptions) => Promise<TerminalHandle>;
+    };
+    readonly processes: {
+        reopen: <F extends ProcessOutputFormat>(reference: ProcessReference<F>, options?: WaitOptions) => Promise<ProcessHandle<F>>;
+        start: <F extends ProcessOutputFormat = "text">(input: StartProcessInput<F>, options?: WaitOptions) => Promise<ProcessHandle<F>>;
+    };
+    submitSuspend(options?: WaitOptions): Promise<OperationHandle<SuspendResult, "sandbox_suspend">>;
+    suspend(options?: WaitOptions): Promise<SuspendResult>;
+    submitResume(options?: WaitOptions): Promise<OperationHandle<ResumeResult, "sandbox_resume">>;
+    resume(options?: WaitOptions): Promise<ResumeResult>;
+    submitRenew(input?: RenewRequest, options?: WaitOptions): Promise<OperationHandle<RenewResult, "sandbox_renew">>;
+    renew(input?: RenewRequest, options?: WaitOptions): Promise<RenewResult>;
+    submitSnapshot(request?: SnapshotRequest, options?: WaitOptions): Promise<OperationHandle<SnapshotResult, OperationKind>>;
+    snapshot(request?: SnapshotRequest, options?: WaitOptions): Promise<SnapshotResult>;
+    capabilities(): Promise<AdapterCapabilities>;
+    checkSnapshot(request?: SnapshotRequest): Promise<Support<SnapshotPlan>>;
+    private checkSnapshotWithSignal;
+    supports(feature: "inspect" | "exec" | "readFile" | "writeFile" | "destroy" | "readDirectory" | "walkFiles" | "readTextLines" | "statFile" | "readFileStream" | "writeFileStream" | "copyFile" | "moveFile" | "listFiles" | "fileExists" | "makeDirectory" | "removeFile"): boolean;
+    inspect(options?: WaitOptions): Promise<SandboxInfo>;
+    /** Resolve access to an existing running sandbox; URL availability is not readiness. */
+    preview(port: number, options?: {
+        signal?: AbortSignal;
+    }): Promise<Preview>;
+    submitExec(input: ExecInput | readonly string[], options?: {
+        signal?: AbortSignal;
+    }): Promise<OperationHandle<ExecOutput, OperationKind>>;
+    exec(input: ExecInput | readonly string[], options?: ExecOptions): Promise<ExecOutput>;
+    /** Decode the complete bounded file as UTF-8, replacing malformed sequences and consuming its BOM. */
+    readTextFile(path: string, options?: FileReadOptions): Promise<string>;
+    /** Encode UTF-8 using the byte write's limits, cancellation and no-clobber default. */
+    writeTextFile(path: string, text: string, options?: FileWriteOptions): Promise<void>;
+    readDirectory(path: string, options?: ReadOptions): Promise<import("@beachside/adapter").DirectoryResult>;
+    /** Depth-first traversal, with complete listings and no descent into links or unknown entries. */
+    walkFiles(path: string, options?: WalkFilesOptions): AsyncIterable<WalkFileEntry>;
+    /** Incrementally decode UTF-8 lines, removing LF/CRLF delimiters and bounding each line. */
+    readTextLines(path: string, options?: ReadTextLinesOptions): AsyncIterable<string>;
+    statFile(path: string, options?: ReadOptions & {
+        followSymlinks?: boolean;
+    }): Promise<import("@beachside/adapter").FileStat>;
+    readFileStream(path: string, options?: FileStreamOptions): AsyncIterable<Uint8Array>;
+    writeFileStream(path: string, bytes: AsyncIterable<Uint8Array>, options?: FileStreamWriteOptions): Promise<number>;
+    copyFile(source: string, destination: string, options?: {
+        overwrite?: boolean;
+        signal?: AbortSignal;
+    }): Promise<void>;
+    moveFile(source: string, destination: string, options?: {
+        overwrite?: boolean;
+        signal?: AbortSignal;
+    }): Promise<void>;
+    private transferFile;
+    listFiles(path: string, options?: ReadOptions): Promise<FileEntry[]>;
+    fileExists(path: string, options?: ReadOptions): Promise<boolean>;
+    makeDirectory(path: string, options?: {
+        recursive?: boolean;
+        signal?: AbortSignal;
+    }): Promise<void>;
+    removeFile(path: string, options?: {
+        recursive?: boolean;
+        signal?: AbortSignal;
+    }): Promise<void>;
+    private fileMutation;
+    readFile(path: string, options?: FileReadOptions): Promise<Uint8Array>;
+    writeFile(path: string, bytes: Uint8Array, options?: FileWriteOptions): Promise<void>;
+    submitDestroy(options?: {
+        signal?: AbortSignal;
+        storage?: "require-durable" | "allow-unconfirmed";
+    }): Promise<OperationHandle<import("@beachside/adapter").DestroyValue, OperationKind>>;
+    destroy(options?: {
+        signal?: AbortSignal;
+        storage?: "require-durable" | "allow-unconfirmed";
+    }): Promise<import("@beachside/adapter").DestroyValue>;
+}
+/** Optional lifecycle API for applications with their own durable operation ledger. */
+export declare const ADAPTER_CONTRACT_VERSION: 1;
+export type AdvancedOperationResult = RuntimeResult;
+export type AdvancedOperationKind = OperationKind;
+export type AdvancedIdentity = {
+    operationId: string;
+    submissionId: string;
+    invocationKey: string;
+};
+export type AdvancedObservation = {
+    lifecycle?: LifecycleIntent;
+    renewal?: RenewRequest;
+    capture?: RecoveryReference["capture"];
+    scope: Scope;
+    kind: OperationKind;
+    operationId: string;
+    submissionId: string;
+    sandboxId?: string;
+    sandboxReference?: SandboxReference;
+    resource?: ResourceReference;
+    mounts?: import("@beachside/adapter").MountSpec[];
+    token?: Json;
+    tokenVersion?: number;
+};
+export declare class PreparedAdapterAttempt {
+    private readonly client;
+    private readonly prepared;
+    private readonly kind;
+    private readonly maxOutputBytes?;
+    private used;
+    constructor(client: AdapterDirectClient, prepared: PreparedOperation, kind: OperationKind, maxOutputBytes?: number | undefined);
+    get lifecycle(): Readonly<LifecycleIntent> | undefined;
+    /** Resolved renewal intent to persist in beforeSubmit and supply to operations.observe. */
+    get renewal(): Readonly<RenewRequest> | undefined;
+    /** The callback must durably record the submission marker; false cancels dispatch. */
+    submit(identity: AdvancedIdentity, options: {
+        beforeSubmit: () => Promise<boolean>;
+        signal?: AbortSignal;
+        onCheckpoint?: (token: Json, version: number) => Promise<void>;
+    }): Promise<AdvancedOperationResult | null>;
+}
+/** Use the BeachsideClient type for consumer annotations. This compatibility runtime class remains supported. */
+export declare class AdapterDirectClient {
+    readonly provider: string;
+    private readonly connection;
+    private readonly onReference?;
+    readonly cleanupStorage: "require-durable" | "allow-unconfirmed";
+    readonly transferPolicy: TransferPolicy;
+    private closed;
+    private closePromise?;
+    /** @deprecated Advanced compatibility access; prefer documented SDK operations. */
+    readonly telemetry: Telemetry;
+    /** @deprecated Advanced compatibility access; prefer documented SDK operations. */
+    readonly session: RuntimeSession;
+    /** @deprecated Advanced compatibility access; prefer documented SDK operations. */
+    readonly scope: Scope;
+    readonly operations: {
+        inventory: (input: {
+            cursor?: string;
+            limit: number;
+        }) => Promise<{
+            items: {
+                id: string;
+                state: "running" | "destroyed" | "unknown";
+            }[];
+            nextCursor?: string;
+        }>;
+        prepare: (kind: OperationKind, input: OperationInput, options?: {
+            signal?: AbortSignal;
+            maxOutputBytes?: number;
+        }) => Promise<PreparedAdapterAttempt>;
+        observe: (input: AdvancedObservation, options?: {
+            signal?: AbortSignal;
+        }) => Promise<AdvancedOperationResult | null>;
+    };
+    readonly signal: AbortSignal;
+    readonly sandboxes: {
+        with: <T>(input: CreateInput | undefined, callback: (sandbox: SandboxHandle<true>) => T | Promise<T>, options?: SandboxScopeOptions) => Promise<T>;
+        get: (reference: SandboxReference, options?: WaitOptions) => Promise<SandboxHandle<true>>;
+        /** List a bounded page of sandboxes; listed references reopen with `get`. */
+        list: (input?: SandboxListInput) => Promise<SandboxList>;
+        checkCreate: (input?: CreateInput) => Promise<Support<CreatePlan>>;
+        create: (input?: CreateInput, options?: {
+            signal?: AbortSignal;
+        }) => Promise<SandboxHandle<true>>;
+        submitCreate: (input?: CreateInput, options?: {
+            signal?: AbortSignal;
+        }) => Promise<OperationHandle<SandboxHandle<true>, OperationKind>>;
+    };
+    readonly snapshots: ReturnType<typeof resourceManagers>["snapshots"];
+    readonly volumes: ReturnType<typeof resourceManagers>["volumes"];
+    readonly images: ReturnType<typeof resourceManagers>["images"] & {
+        build: (input: ImageBuildInput, options?: {
+            signal?: AbortSignal;
+        }) => Promise<ImageBuildResult>;
+        submitBuild: (input: ImageBuildInput, options?: {
+            signal?: AbortSignal;
+        }) => Promise<OperationHandle<ImageBuildResult, OperationKind>>;
+    };
+    constructor(provider: string, connection: AdapterConnection<RuntimeSession>, onReference?: ((reference: RecoveryReference) => void | Promise<void>) | undefined, observability?: ObservabilityOptions, cleanupStorage?: "require-durable" | "allow-unconfirmed", transferPolicy?: TransferPolicy);
+    isClosed(): boolean;
+    ensureOpen(): void;
+    capabilities(target?: {
+        sandbox?: Sandbox;
+        create?: AdapterCreateInput;
+    }, options?: WaitOptions): Promise<AdapterCapabilities>;
+    checkCreate(input?: CreateInput): Promise<Support<CreatePlan>>;
+    private checkCreateWithSignal;
+    private checkImageBinding;
+    submitCreate(input?: CreateInput, options?: {
+        signal?: AbortSignal;
+    }): Promise<OperationHandle<SandboxHandle<true>, OperationKind>>;
+    private reopenSandbox;
+    submitBuild(input: ImageBuildInput, options?: {
+        signal?: AbortSignal;
+    }): Promise<OperationHandle<ImageBuildResult, OperationKind>>;
+    /** Decode a confirmed build; a missing adapter reference is never promoted to verified. */
+    private builtImage;
+    submit<T, K extends OperationKind = OperationKind>(kind: K, input: OperationInput, decode: (result: RuntimeResult, ref: RecoveryReference) => T, options?: {
+        signal?: AbortSignal;
+        sandboxId?: string;
+        sandboxReference?: SandboxReference;
+        resource?: ResourceReference;
+        capture?: z.infer<typeof CaptureExpectation>;
+        mounts?: import("@beachside/adapter").MountSpec[];
+        networkPolicy?: string;
+        file?: {
+            path: string;
+            bytes: number;
+        };
+        fileMutation?: RecoveryReference["fileMutation"];
+        maxOutputBytes?: number;
+    }): Promise<OperationHandle<T, K>>;
+    checkedOutcome(reference: RecoveryReference, outcome?: import("@beachside/adapter").OperationOutcome): import("@beachside/adapter").OperationOutcome | undefined;
+    persistReference(reference: RecoveryReference): Promise<void>;
+    private assertRecoverySandbox;
+    recover(reference: RecoveryReference): Promise<RecoveredOperation>;
+    close(options?: CloseOptions): Promise<void>;
+}
+/** Default storage requirement for new compute cleanup submissions. */
+export type ConnectOptions = ObservabilityOptions & ConnectionWaitOptions & {
+    onDiagnostic?: (error: unknown) => void;
+    cleanup?: {
+        storage?: "require-durable" | "allow-unconfirmed";
+    };
+    transfers?: TransferPolicy;
+};
+/** Compatibility name for connection controls. */
+export type DirectConnectOptions = ConnectOptions;
+export type { CloseOptions } from "./connection-wait.js";
+export type AdapterConnectOptions<C extends z.ZodType, K extends z.ZodType, S extends RuntimeSession> = ConnectOptions & {
+    adapter: Pick<AdapterDefinition<C, K, S>, "name" | "config" | "credentials"> & {
+        connect: (input: never) => Promise<S>;
+        policy?: {
+            schema: z.ZodType;
+            default: Json;
+        };
+    };
+    config: z.input<C>;
+    credentials: z.input<K>;
+    onReference?: (reference: RecoveryReference) => void | Promise<void>;
+    onDiagnostic?: (error: unknown) => void;
+};
+export declare function connectDirect(adapter: BoundAdapter, options?: ConnectOptions): Promise<BeachsideClient<true>>;
+export declare function connectDirect<C extends z.ZodType, K extends z.ZodType, S extends RuntimeSession>(options: AdapterConnectOptions<C, K, S>): Promise<BeachsideClient<true>>;