@effect/platform-node-shared 4.0.0-beta.9 → 4.0.0-beta.90

package/src/NodeStream.ts

@@ -1,9 +1,18 @@
 /**
- * @since 1.0.0
+ * Adapters between Node streams and Effect streams, channels, and readables.
+ *
+ * This module is the stream boundary for Node APIs. It wraps `Readable` and
+ * `Duplex` values as Effect `Stream`s and `Channel`s, pipes Effect streams
+ * through Node duplex streams, exposes an Effect `Stream` back to Node as a
+ * `Readable`, and collects readable payloads into strings, array buffers, or
+ * `Uint8Array`s with optional byte limits.
+ *
+ * @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 +22,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 +44,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 +68,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 +115,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 +140,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 +174,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 +203,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 +283,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 +301,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 +310,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 +334,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 +420,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 +438,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,18 @@
 /**
- * @since 1.0.0
+ * Shared Node.js implementation of Effect's `Terminal` service.
+ *
+ * `NodeTerminal` adapts Node's `readline` APIs plus the current process
+ * `stdin` and `stdout` streams into {@link Terminal.Terminal}. The service can
+ * display output, read a line, stream key input, and read terminal dimensions.
+ * `make` manages readline and TTY raw mode in a scope, while `layer` provides
+ * the default service that ends key input on Ctrl+C or Ctrl+D.
+ *
+ * @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 +22,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 +59,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 +107,7 @@ export const make: (
 
     return Terminal.make({
       columns,
+      rows,
       readInput,
       readLine,
       display
@@ -101,8 +116,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,65 @@
+/**
+ * @since 4.0.0
+ */
+
+// @barrel: Auto-generated exports. Do not edit manually.
+
+/**
+ * @since 4.0.0
+ */
+export * as NodeChildProcessSpawner from "./NodeChildProcessSpawner.ts"
+
+/**
+ * @since 4.0.0
+ */
+export * as NodeClusterSocket from "./NodeClusterSocket.ts"
+
+/**
+ * @since 1.0.0
+ */
+export * as NodeCrypto from "./NodeCrypto.ts"
+
+/**
+ * @since 4.0.0
+ */
+export * as NodeFileSystem from "./NodeFileSystem.ts"
+
+/**
+ * @since 4.0.0
+ */
+export * as NodePath from "./NodePath.ts"
+
+/**
+ * @since 4.0.0
+ */
+export * as NodeRuntime from "./NodeRuntime.ts"
+
+/**
+ * @since 4.0.0
+ */
+export * as NodeSink from "./NodeSink.ts"
+
+/**
+ * @since 4.0.0
+ */
+export * as NodeSocket from "./NodeSocket.ts"
+
+/**
+ * @since 4.0.0
+ */
+export * as NodeSocketServer from "./NodeSocketServer.ts"
+
+/**
+ * @since 4.0.0
+ */
+export * as NodeStdio from "./NodeStdio.ts"
+
+/**
+ * @since 4.0.0
+ */
+export * as NodeStream from "./NodeStream.ts"
+
+/**
+ * @since 4.0.0
+ */
+export * as NodeTerminal from "./NodeTerminal.ts"