@effect/platform-node-shared 4.0.0-beta.7 → 4.0.0-beta.70

package/src/NodeStream.ts

@@ -1,9 +1,26 @@
 /**
- * @since 1.0.0
+ * Interoperability between Node streams and Effect streams and channels.
+ *
+ * This module adapts `Readable` and `Duplex` instances at the boundary with
+ * Node APIs: wrapping sources such as files, HTTP responses, child process
+ * output, and compression transforms as Effect `Stream`s or `Channel`s, piping
+ * Effect streams through Node duplex transforms, exposing an Effect `Stream`
+ * back to Node as a `Readable`, and collecting small readable payloads into
+ * strings or binary buffers.
+ *
+ * The adapters preserve the Node stream semantics that matter for production
+ * code. Writes wait for `drain` when a writable side applies backpressure,
+ * readable streams are destroyed on scope finalization by default, and stream
+ * failures are routed through `onError` or `Cause.UnknownError`. For long-lived
+ * or externally owned streams, pass `closeOnDone` or `endOnDone` carefully, and
+ * use `maxBytes` on collection helpers to avoid buffering unbounded input.
+ *
+ * @since 4.0.0
  */
 import * as Arr from "effect/Array"
 import * as Cause from "effect/Cause"
 import * as Channel from "effect/Channel"
+import * as Context from "effect/Context"
 import * as Effect from "effect/Effect"
 import * as Exit from "effect/Exit"
 import * as Fiber from "effect/Fiber"
@@ -13,15 +30,18 @@ import * as Latch from "effect/Latch"
 import * as MutableRef from "effect/MutableRef"
 import * as Pull from "effect/Pull"
 import * as Scope from "effect/Scope"
-import * as ServiceMap from "effect/ServiceMap"
 import * as Stream from "effect/Stream"
 import type { Duplex } from "node:stream"
 import { Readable } from "node:stream"
 import { pullIntoWritable } from "./NodeSink.ts"
 
 /**
+ * Converts a Node readable stream into an Effect `Stream`, reading chunks with
+ * an optional chunk size, mapping stream errors with `onError`, and destroying
+ * the readable on completion unless `closeOnDone` is `false`.
+ *
  * @category constructors
- * @since 1.0.0
+ * @since 4.0.0
  */
 export const fromReadable = <A = Uint8Array, E = Cause.UnknownError>(options: {
   readonly evaluate: LazyArg<Readable | NodeJS.ReadableStream>
@@ -32,8 +52,12 @@ export const fromReadable = <A = Uint8Array, E = Cause.UnknownError>(options: {
 }): Stream.Stream<A, E> => Stream.fromChannel(fromReadableChannel<A, E>(options))
 
 /**
+ * Creates a `Channel` that pulls chunks from a Node readable stream, mapping
+ * errors with `onError` and destroying the readable on completion unless
+ * `closeOnDone` is `false`.
+ *
  * @category constructors
- * @since 1.0.0
+ * @since 4.0.0
  */
 export const fromReadableChannel = <A = Uint8Array, E = Cause.UnknownError>(options: {
   readonly evaluate: LazyArg<Readable | NodeJS.ReadableStream>
@@ -52,8 +76,12 @@ export const fromReadableChannel = <A = Uint8Array, E = Cause.UnknownError>(opti
   )
 
 /**
+ * Creates a `Channel` over a Node `Duplex`, writing upstream chunks with
+ * backpressure while emitting chunks read from the duplex and optionally ending
+ * the writable side when upstream completes.
+ *
  * @category constructors
- * @since 1.0.0
+ * @since 4.0.0
  */
 export const fromDuplex = <IE, I = Uint8Array, O = Uint8Array, E = Cause.UnknownError>(
   options: {
@@ -95,13 +123,19 @@ export const fromDuplex = <IE, I = Uint8Array, O = Uint8Array, E = Cause.Unknown
   })
 
 /**
+ * Pipes an Effect `Stream` through a Node `Duplex`, writing the stream's
+ * chunks to the duplex and emitting chunks read back from it.
+ *
  * @category combinators
- * @since 1.0.0
+ * @since 4.0.0
  */
 export const pipeThroughDuplex: {
   /**
+   * Pipes an Effect `Stream` through a Node `Duplex`, writing the stream's
+   * chunks to the duplex and emitting chunks read back from it.
+   *
    * @category combinators
-   * @since 1.0.0
+   * @since 4.0.0
    */
   <B = Uint8Array, E2 = Cause.UnknownError>(
     options: {
@@ -114,8 +148,11 @@ export const pipeThroughDuplex: {
     }
   ): <R, E, A>(self: Stream.Stream<A, E, R>) => Stream.Stream<B, E2 | E, R>
   /**
+   * Pipes an Effect `Stream` through a Node `Duplex`, writing the stream's
+   * chunks to the duplex and emitting chunks read back from it.
+   *
    * @category combinators
-   * @since 1.0.0
+   * @since 4.0.0
    */
   <R, E, A, B = Uint8Array, E2 = Cause.UnknownError>(
     self: Stream.Stream<A, E, R>,
@@ -145,18 +182,27 @@ export const pipeThroughDuplex: {
   ))
 
 /**
+ * Pipes a stream of strings or bytes through a Node `Duplex` using default
+ * options and `Cause.UnknownError` for stream failures.
+ *
  * @category combinators
- * @since 1.0.0
+ * @since 4.0.0
  */
 export const pipeThroughSimple: {
   /**
+   * Pipes a stream of strings or bytes through a Node `Duplex` using default
+   * options and `Cause.UnknownError` for stream failures.
+   *
    * @category combinators
-   * @since 1.0.0
+   * @since 4.0.0
    */
   (duplex: LazyArg<Duplex>): <R, E>(self: Stream.Stream<string | Uint8Array, E, R>) => Stream.Stream<Uint8Array, E | Cause.UnknownError, R>
   /**
+   * Pipes a stream of strings or bytes through a Node `Duplex` using default
+   * options and `Cause.UnknownError` for stream failures.
+   *
    * @category combinators
-   * @since 1.0.0
+   * @since 4.0.0
    */
   <R, E>(self: Stream.Stream<string | Uint8Array, E, R>, duplex: LazyArg<Duplex>): Stream.Stream<Uint8Array, Cause.UnknownError | E, R>
 } = dual(2, <R, E>(
@@ -165,28 +211,39 @@ export const pipeThroughSimple: {
 ): Stream.Stream<Uint8Array, Cause.UnknownError | E, R> => pipeThroughDuplex(self, { evaluate: duplex }))
 
 /**
- * @since 1.0.0
- * @category conversions
+ * Converts an Effect `Stream` into a Node `Readable`, using the caller's
+ * Effect context to run the stream and destroying the readable if the stream
+ * fails.
+ *
+ * @category converting
+ * @since 4.0.0
  */
 export const toReadable = <E, R>(stream: Stream.Stream<string | Uint8Array, E, R>): Effect.Effect<Readable, never, R> =>
   Effect.map(
-    Effect.services<R>(),
+    Effect.context<R>(),
     (context) => new StreamAdapter(context, stream)
   )
 
 /**
- * @since 1.0.0
- * @category conversions
+ * Converts a service-free Effect `Stream` into a Node `Readable` using an
+ * empty Effect context.
+ *
+ * @category converting
+ * @since 4.0.0
  */
 export const toReadableNever = <E>(stream: Stream.Stream<string | Uint8Array, E, never>): Readable =>
   new StreamAdapter(
-    ServiceMap.empty(),
+    Context.empty(),
     stream
   )
 
 /**
- * @since 1.0.0
- * @category conversions
+ * Consumes a Node readable stream into a string using the selected encoding,
+ * failing through `onError` on stream errors or when `maxBytes` is exceeded
+ * and destroying the stream on interruption or failure.
+ *
+ * @category converting
+ * @since 4.0.0
  */
 export const toString = <E = Cause.UnknownError>(
   readable: LazyArg<Readable | NodeJS.ReadableStream>,
@@ -234,8 +291,12 @@ export const toString = <E = Cause.UnknownError>(
 }
 
 /**
- * @since 1.0.0
- * @category conversions
+ * Consumes a Node readable stream into an `ArrayBuffer`, failing through
+ * `onError` on stream errors or when `maxBytes` is exceeded and destroying the
+ * stream on interruption or failure.
+ *
+ * @category converting
+ * @since 4.0.0
  */
 export const toArrayBuffer = <E = Cause.UnknownError>(
   readable: LazyArg<Readable | NodeJS.ReadableStream>,
@@ -248,7 +309,7 @@ export const toArrayBuffer = <E = Cause.UnknownError>(
   const onError = options?.onError ?? defaultOnError
   return Effect.callback((resume) => {
     const stream = readable() as Readable
-    let buffer = Buffer.alloc(0)
+    const buffers: Array<Uint8Array> = []
     let bytes = 0
     stream.once("error", (err) => {
       if ("closed" in stream && !stream.closed) {
@@ -257,13 +318,16 @@ export const toArrayBuffer = <E = Cause.UnknownError>(
       resume(Effect.fail(onError(err) as E))
     })
     stream.once("end", () => {
-      if (buffer.buffer.byteLength === buffer.byteLength) {
-        return resume(Effect.succeed(buffer.buffer))
+      const buffer = buffers.length === 1 ? buffers[0] : Buffer.concat(buffers)
+      if (buffer.byteOffset === 0 && buffer.buffer.byteLength === buffer.byteLength) {
+        return resume(Effect.succeed(buffer.buffer as ArrayBuffer))
       }
-      resume(Effect.succeed(buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength)))
+      resume(
+        Effect.succeed(buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength) as ArrayBuffer)
+      )
     })
     stream.on("data", (chunk) => {
-      buffer = Buffer.concat([buffer, chunk])
+      buffers.push(chunk)
       bytes += chunk.length
       if (maxBytesNumber && bytes > maxBytesNumber) {
         resume(Effect.fail(onError(new Error("maxBytes exceeded")) as E))
@@ -278,8 +342,11 @@ export const toArrayBuffer = <E = Cause.UnknownError>(
 }
 
 /**
- * @since 1.0.0
- * @category conversions
+ * Consumes a Node readable stream into a `Uint8Array`, using the same error
+ * mapping and `maxBytes` handling as `toArrayBuffer`.
+ *
+ * @category converting
+ * @since 4.0.0
  */
 export const toUint8Array = <E = Cause.UnknownError>(
   readable: LazyArg<Readable | NodeJS.ReadableStream>,
@@ -361,7 +428,7 @@ class StreamAdapter<E, R> extends Readable {
   private fiber: Fiber.Fiber<void, E> | undefined = undefined
 
   constructor(
-    context: ServiceMap.ServiceMap<R>,
+    context: Context.Context<R>,
     stream: Stream.Stream<Uint8Array | string, E, R>
   ) {
     super({})
@@ -379,7 +446,7 @@ class StreamAdapter<E, R> extends Readable {
         }
       }))).pipe(
         this.readLatch.whenOpen,
-        Effect.provideServices(context),
+        Effect.provideContext(context),
         Effect.runFork
       )
     this.fiber.addObserver((exit) => {

package/src/NodeTerminal.ts

@@ -1,9 +1,27 @@
 /**
- * @since 1.0.0
+ * Shared Node.js implementation of Effect's `Terminal` service.
+ *
+ * This module is the process-backed terminal implementation used by Node
+ * platform packages. It adapts Node's `readline` APIs and the current
+ * process' `stdin` and `stdout` streams into a `Terminal`, making it suitable
+ * for CLIs, REPLs, prompts, full-screen terminal programs, and other
+ * command-line tools that need line input, keypress input, terminal
+ * dimensions, or prompt output.
+ *
+ * The implementation works with global process streams, so callers should
+ * acquire it with a scope or provide `layer` to ensure cleanup. When `stdin`
+ * is a TTY, raw mode is enabled while the scoped readline interface is active
+ * and restored on release; raw mode changes how keys are delivered and can
+ * affect other code reading stdin. In non-TTY environments such as pipes,
+ * redirected input, or CI, raw mode is unavailable, keypress behavior is
+ * limited, and stdout dimensions may be reported as zero.
+ *
+ * @since 4.0.0
  */
 import type * as Cause from "effect/Cause"
 import * as Effect from "effect/Effect"
 import * as Layer from "effect/Layer"
+import * as Option from "effect/Option"
 import { badArgument, type PlatformError } from "effect/PlatformError"
 import * as Predicate from "effect/Predicate"
 import * as Queue from "effect/Queue"
@@ -13,8 +31,12 @@ import * as Terminal from "effect/Terminal"
 import * as readline from "node:readline"
 
 /**
- * @since 1.0.0
+ * Creates a scoped process-backed `Terminal` using Node `readline`, enabling
+ * TTY raw mode while in scope and using the supplied predicate to decide when
+ * key input should end.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const make: (
   shouldQuit?: (input: Terminal.UserInput) => boolean
@@ -46,13 +68,14 @@ export const make: (
     })
 
     const columns = Effect.sync(() => stdout.columns ?? 0)
+    const rows = Effect.sync(() => stdout.rows ?? 0)
 
     const readInput = Effect.gen(function*() {
       yield* RcRef.get(rlRef)
       const queue = yield* Queue.make<Terminal.UserInput, Cause.Done>()
       const handleKeypress = (s: string | undefined, k: readline.Key) => {
         const userInput = {
-          input: s,
+          input: Option.fromUndefinedOr(s),
           key: { name: k.name ?? "", ctrl: !!k.ctrl, meta: !!k.meta, shift: !!k.shift }
         }
         Queue.offerUnsafe(queue, userInput)
@@ -93,6 +116,7 @@ export const make: (
 
     return Terminal.make({
       columns,
+      rows,
       readInput,
       readLine,
       display
@@ -101,8 +125,11 @@ export const make: (
 )
 
 /**
- * @since 1.0.0
+ * Provides the default process-backed `Terminal` service, ending key input on
+ * Ctrl+C or Ctrl+D.
+ *
  * @category layers
+ * @since 4.0.0
  */
 export const layer: Layer.Layer<Terminal.Terminal> = Layer.effect(Terminal.Terminal, make(defaultShouldQuit))
 

package/src/index.ts

@@ -0,0 +1,233 @@
+/**
+ * @since 4.0.0
+ */
+
+// @barrel: Auto-generated exports. Do not edit manually.
+
+/**
+ * Node.js implementation of `ChildProcessSpawner`.
+ *
+ * @since 4.0.0
+ */
+export * as NodeChildProcessSpawner from "./NodeChildProcessSpawner.ts"
+
+/**
+ * Node TCP socket integration for Effect Cluster runner communication.
+ *
+ * This module provides the shared Node layers used by socket-based cluster
+ * transports: a client protocol that opens TCP sockets to runner addresses and
+ * a socket server that listens for incoming runner RPC traffic. It is useful
+ * when wiring Node or Node-compatible cluster runners, sharing the same socket
+ * implementation across platform packages, or building tests and deployments
+ * that need direct runner-to-runner RPC over TCP rather than HTTP.
+ *
+ * Cluster runners must advertise an address that peers can reach while the
+ * server may listen on a different address via `runnerListenAddress`, which is
+ * common behind containers, port mappings, or Kubernetes services. Serialization
+ * is supplied by the surrounding layer, and gossip, shard discovery, health
+ * checks, and storage-backed delivery are coordinated by the cluster services
+ * that use this transport. Keep those responsibilities separate when debugging:
+ * a reachable socket does not by itself guarantee that runner membership,
+ * shard ownership, or persisted message notification is current.
+ *
+ * @since 4.0.0
+ */
+export * as NodeClusterSocket from "./NodeClusterSocket.ts"
+
+/**
+ * Node.js implementation of the Crypto service.
+ *
+ * @since 1.0.0
+ */
+export * as NodeCrypto from "./NodeCrypto.ts"
+
+/**
+ * Shared Node-compatible implementation of Effect's `FileSystem` service.
+ *
+ * This module adapts Node's `node:fs`, `node:os`, and `node:path` APIs into a
+ * layer that can be provided to Effect programs running on Node-compatible
+ * runtimes. It is used by platform packages to provide file and directory I/O,
+ * permissions, links, metadata, temporary files and directories, and file
+ * watching through the `FileSystem` service.
+ *
+ * Paths are passed to Node filesystem APIs, so relative paths are resolved by
+ * the current working directory and platform path rules still apply. Node
+ * filesystem failures are translated into `PlatformError` values, while invalid
+ * arguments become `BadArgument` failures. Open files are scoped resources with
+ * tracked read and write positions; append mode lets the operating system choose
+ * the write offset. File watching is exposed as a stream and follows
+ * `node:fs.watch` semantics unless a `WatchBackend` is provided, so recursive
+ * support, event coalescing, and reported paths can vary by runtime and
+ * platform.
+ *
+ * @since 4.0.0
+ */
+export * as NodeFileSystem from "./NodeFileSystem.ts"
+
+/**
+ * Shared Node-compatible implementation of Effect's `Path` service.
+ *
+ * This module adapts Node's `node:path` and `node:url` APIs into layers that
+ * can be provided to Effect programs needing path manipulation, such as
+ * resolving configuration files, building file system locations, parsing
+ * names and extensions, or converting between file paths and `file:` URLs.
+ *
+ * The default layer follows the host platform semantics exposed by
+ * `node:path`, while `layerPosix` and `layerWin32` provide stable POSIX or
+ * Windows behavior regardless of the current runtime. Path operations are
+ * syntactic and do not check whether files exist; separators, drive letters,
+ * UNC paths, and URL encoding rules can also differ by platform. Invalid
+ * file URL conversions are reported through `BadArgument`.
+ *
+ * @since 4.0.0
+ */
+export * as NodePath from "./NodePath.ts"
+
+/**
+ * Shared runtime helpers for running Effect programs as Node-compatible
+ * process entry points.
+ *
+ * This module provides the common `runMain` implementation used by
+ * Node-compatible platform packages. It is intended for CLIs, scripts,
+ * workers, servers, and other process-oriented programs that should run an
+ * Effect as their main fiber while still following Node process conventions.
+ *
+ * The runner installs `SIGINT` and `SIGTERM` handlers for the lifetime of the
+ * main fiber, translating those process signals into fiber interruption so
+ * Effect finalizers and the configured teardown can run. When the fiber exits,
+ * the signal listeners are removed and teardown determines the exit code. Clean
+ * success lets the Node event loop drain naturally instead of forcing
+ * `process.exit(0)`, while signal-triggered or non-zero exits call
+ * `process.exit` after teardown, so long-running resources should be modeled
+ * in the Effect scope and finalized explicitly.
+ *
+ * @since 4.0.0
+ */
+export * as NodeRuntime from "./NodeRuntime.ts"
+
+/**
+ * Sink adapters for writing Effect stream chunks into Node writable streams.
+ *
+ * This module is used at the boundary where Effect `Stream`s or `Channel`s need
+ * to push data into Node's writable side: file streams, HTTP request or
+ * response bodies, process stdio, sockets, and transform inputs such as
+ * compression or encryption streams. It exposes both a `Sink` constructor for
+ * ordinary stream pipelines and lower-level `Channel` and pull helpers used by
+ * other Node stream adapters.
+ *
+ * The implementation follows Node writable semantics. Chunks are written in
+ * order; when `write` returns `false`, pulling pauses until `drain` so upstream
+ * producers do not overrun the writable buffer. Writable `error` events are
+ * mapped through `onError`, and the writable is ended and awaited via `finish`
+ * when upstream completes unless `endOnDone` is `false`. Use `endOnDone: false`
+ * for externally owned or long-lived writables, and make sure `onError` keeps
+ * Node's untyped errors meaningful for the calling Effect workflow.
+ *
+ * @since 4.0.0
+ */
+export * as NodeSink from "./NodeSink.ts"
+
+/**
+ * Shared Node socket constructors for adapting `node:net` connections and
+ * other Node `Duplex` streams to Effect's `Socket.Socket` interface.
+ *
+ * Use this module when building TCP clients, Unix domain socket clients, or
+ * higher-level protocols that already expose a Node `Duplex`. Connections are
+ * scoped, so finalizers close or destroy the underlying stream, open timeouts
+ * are reported as socket open errors, and Node read, write, and close events
+ * are translated into `SocketError` values.
+ *
+ * Node sockets have a few operational details worth keeping in mind: Unix
+ * socket paths are supplied through `NetConnectOpts.path`, writes complete only
+ * after Node accepts or flushes the chunk, and abnormal close events are
+ * surfaced as close errors while normal remote ends complete the socket run.
+ *
+ * @since 4.0.0
+ */
+export * as NodeSocket from "./NodeSocket.ts"
+
+/**
+ * Shared Node socket server constructors for exposing `node:net` servers and
+ * `ws` WebSocket servers as Effect `SocketServer.SocketServer` services.
+ *
+ * Use this module when implementing TCP services, Unix domain socket services,
+ * WebSocket endpoints, or higher-level protocols such as RPC transports that
+ * need to accept incoming connections through Effect's socket APIs. TCP
+ * connections are adapted through `NodeSocket.fromDuplex`, while WebSocket
+ * handlers also receive the underlying `WebSocket` and Node `IncomingMessage`
+ * in their fiber context.
+ *
+ * The server starts listening before the constructor returns, and the exported
+ * `address` is derived from the actual Node server after binding. Prefer that
+ * address when using port `0`, wildcard hosts, or Unix socket paths. Incoming
+ * connections accepted before `run` is installed are queued and then handed to
+ * the handler, each `run` call owns the scope for its connection fibers, and
+ * the enclosing scope closes the underlying Node server.
+ *
+ * @since 4.0.0
+ */
+export * as NodeSocketServer from "./NodeSocketServer.ts"
+
+/**
+ * Shared Node.js implementation of the Effect `Stdio` service.
+ *
+ * This module builds the `Stdio` layer used by Node platform packages by
+ * wiring the service to the current process: command-line arguments come from
+ * `process.argv`, input is read from `process.stdin`, and output and error
+ * output are written to `process.stdout` and `process.stderr`. It is intended
+ * for CLIs, scripts, command runners, test harnesses, and other
+ * process-oriented programs that need standard I/O through Effect services.
+ *
+ * The process stdio streams are global resources owned by Node. This layer
+ * leaves stdin open and does not end stdout or stderr by default, avoiding
+ * accidental closure of handles other code in the process may still use. Those
+ * streams may be pipes, files, or TTYs; interactive terminal behavior such as
+ * raw mode, echo, colors, and cursor movement should be coordinated with the
+ * terminal APIs instead of assuming this layer has exclusive control.
+ *
+ * @since 4.0.0
+ */
+export * as NodeStdio from "./NodeStdio.ts"
+
+/**
+ * Interoperability between Node streams and Effect streams and channels.
+ *
+ * This module adapts `Readable` and `Duplex` instances at the boundary with
+ * Node APIs: wrapping sources such as files, HTTP responses, child process
+ * output, and compression transforms as Effect `Stream`s or `Channel`s, piping
+ * Effect streams through Node duplex transforms, exposing an Effect `Stream`
+ * back to Node as a `Readable`, and collecting small readable payloads into
+ * strings or binary buffers.
+ *
+ * The adapters preserve the Node stream semantics that matter for production
+ * code. Writes wait for `drain` when a writable side applies backpressure,
+ * readable streams are destroyed on scope finalization by default, and stream
+ * failures are routed through `onError` or `Cause.UnknownError`. For long-lived
+ * or externally owned streams, pass `closeOnDone` or `endOnDone` carefully, and
+ * use `maxBytes` on collection helpers to avoid buffering unbounded input.
+ *
+ * @since 4.0.0
+ */
+export * as NodeStream from "./NodeStream.ts"
+
+/**
+ * Shared Node.js implementation of Effect's `Terminal` service.
+ *
+ * This module is the process-backed terminal implementation used by Node
+ * platform packages. It adapts Node's `readline` APIs and the current
+ * process' `stdin` and `stdout` streams into a `Terminal`, making it suitable
+ * for CLIs, REPLs, prompts, full-screen terminal programs, and other
+ * command-line tools that need line input, keypress input, terminal
+ * dimensions, or prompt output.
+ *
+ * The implementation works with global process streams, so callers should
+ * acquire it with a scope or provide `layer` to ensure cleanup. When `stdin`
+ * is a TTY, raw mode is enabled while the scoped readline interface is active
+ * and restored on release; raw mode changes how keys are delivered and can
+ * affect other code reading stdin. In non-TTY environments such as pipes,
+ * redirected input, or CI, raw mode is unavailable, keypress behavior is
+ * limited, and stdout dimensions may be reported as zero.
+ *
+ * @since 4.0.0
+ */
+export * as NodeTerminal from "./NodeTerminal.ts"