@effect/platform-node 4.0.0-beta.8 → 4.0.0-beta.80

package/src/NodeServices.ts

@@ -1,6 +1,14 @@
 /**
- * @since 1.0.0
+ * Aggregate Node.js platform services layer.
+ *
+ * This module defines the `NodeServices` union and a single `layer` that
+ * provides Node-backed child process spawning, crypto, filesystem, path, stdio,
+ * and terminal services. Use the layer when a Node program wants the standard
+ * platform services from one place.
+ *
+ * @since 4.0.0
  */
+import type { Crypto } from "effect/Crypto"
 import type { FileSystem } from "effect/FileSystem"
 import * as Layer from "effect/Layer"
 import type { Path } from "effect/Path"
@@ -8,25 +16,33 @@ import type { Stdio } from "effect/Stdio"
 import type { Terminal } from "effect/Terminal"
 import type { ChildProcessSpawner } from "effect/unstable/process/ChildProcessSpawner"
 import * as NodeChildProcessSpawner from "./NodeChildProcessSpawner.ts"
+import * as NodeCrypto from "./NodeCrypto.ts"
 import * as NodeFileSystem from "./NodeFileSystem.ts"
 import * as NodePath from "./NodePath.ts"
 import * as NodeStdio from "./NodeStdio.ts"
 import * as NodeTerminal from "./NodeTerminal.ts"
 
 /**
- * @since 1.0.0
+ * The union of core services provided by the Node platform layer, including
+ * child process spawning, filesystem, path, stdio, and terminal services.
+ *
  * @category models
+ * @since 4.0.0
  */
-export type NodeServices = ChildProcessSpawner | FileSystem | Path | Stdio | Terminal
+export type NodeServices = ChildProcessSpawner | Crypto | FileSystem | Path | Stdio | Terminal
 
 /**
- * @since 1.0.0
- * @category layer
+ * Provides the default Node implementations for child process spawning,
+ * filesystem, path, stdio, and terminal services.
+ *
+ * @category layers
+ * @since 4.0.0
  */
 export const layer: Layer.Layer<NodeServices> = Layer.provideMerge(
   NodeChildProcessSpawner.layer,
   Layer.mergeAll(
     NodeFileSystem.layer,
+    NodeCrypto.layer,
     NodePath.layer,
     NodeStdio.layer,
     NodeTerminal.layer

package/src/NodeSink.ts

@@ -1,8 +1,8 @@
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * from "@effect/platform-node-shared/NodeSink"

package/src/NodeSocket.ts

@@ -1,5 +1,13 @@
 /**
- * @since 1.0.0
+ * Node.js socket constructors and layers for Effect sockets.
+ *
+ * This module re-exports the shared Node socket support for TCP connections,
+ * Unix domain socket connections, and Node `Duplex` streams. It also provides
+ * WebSocket constructor layers: one that uses `globalThis.WebSocket` when
+ * present and falls back to `ws`, one that always uses `ws`, and one that
+ * creates a `Socket.Socket` layer for a WebSocket URL.
+ *
+ * @since 4.0.0
  */
 import { NodeWS as WS } from "@effect/platform-node-shared/NodeSocket"
 import type * as Duration from "effect/Duration"
@@ -9,13 +17,16 @@ import * as Layer from "effect/Layer"
 import * as Socket from "effect/unstable/socket/Socket"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * from "@effect/platform-node-shared/NodeSocket"
 
 /**
- * @since 1.0.0
+ * Provides a `Socket.WebSocketConstructor`, using `globalThis.WebSocket` when
+ * available and falling back to the `ws` package otherwise.
+ *
  * @category layers
+ * @since 4.0.0
  */
 export const layerWebSocketConstructor: Layer.Layer<
   Socket.WebSocketConstructor
@@ -27,8 +38,25 @@ export const layerWebSocketConstructor: Layer.Layer<
 })
 
 /**
- * @since 1.0.0
+ * Provides a `Socket.WebSocketConstructor` backed explicitly by the `ws`
+ * package.
+ *
  * @category layers
+ * @since 4.0.0
+ */
+export const layerWebSocketConstructorWS: Layer.Layer<
+  Socket.WebSocketConstructor
+> = Layer.succeed(Socket.WebSocketConstructor)(
+  (url, protocols) => new WS.WebSocket(url, protocols) as unknown as globalThis.WebSocket
+)
+
+/**
+ * Creates a `Socket.Socket` layer for a WebSocket URL using the Node WebSocket
+ * constructor layer, honoring protocol, open-timeout, and close-code error
+ * options.
+ *
+ * @category layers
+ * @since 4.0.0
  */
 export const layerWebSocket: (
   url: string | Effect.Effect<string>,

package/src/NodeSocketServer.ts

@@ -1,8 +1,8 @@
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * from "@effect/platform-node-shared/NodeSocketServer"

package/src/NodeStdio.ts

@@ -1,12 +1,22 @@
 /**
- * @since 1.0.0
+ * Node.js `Stdio` layer for the current process.
+ *
+ * The exported layer reuses the shared Node stdio implementation. It satisfies
+ * the platform-independent `Stdio` service by reading command-line arguments
+ * from `process.argv`, consuming input from `process.stdin`, and writing output
+ * streams to `process.stdout` and `process.stderr`.
+ *
+ * @since 4.0.0
  */
 import * as NodeStdio from "@effect/platform-node-shared/NodeStdio"
 import type * as Layer from "effect/Layer"
 import type { Stdio } from "effect/Stdio"
 
 /**
- * @since 1.0.0
- * @category layer
+ * Provides the `Stdio` service backed by the current process arguments,
+ * stdin, stdout, and stderr streams.
+ *
+ * @category layers
+ * @since 4.0.0
  */
 export const layer: Layer.Layer<Stdio> = NodeStdio.layer

package/src/NodeStream.ts

@@ -1,8 +1,8 @@
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * from "@effect/platform-node-shared/NodeStream"

package/src/NodeTerminal.ts

@@ -1,5 +1,11 @@
 /**
- * @since 1.0.0
+ * Node.js implementation of the Effect `Terminal` service.
+ *
+ * This module reuses the shared Node terminal implementation. `make` creates a
+ * scoped process-backed `Terminal` service, and `layer` provides the default
+ * service with the standard quit behavior for key input.
+ *
+ * @since 4.0.0
  */
 import * as NodeTerminal from "@effect/platform-node-shared/NodeTerminal"
 import type { Effect } from "effect/Effect"
@@ -8,13 +14,19 @@ import type { Scope } from "effect/Scope"
 import type { Terminal, UserInput } from "effect/Terminal"
 
 /**
- * @since 1.0.0
+ * Creates a scoped `Terminal` service backed by process stdin/stdout, using the
+ * optional predicate to decide when key input should end the input stream.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const make: (shouldQuit?: (input: UserInput) => boolean) => Effect<Terminal, never, Scope> = NodeTerminal.make
 
 /**
- * @since 1.0.0
+ * Provides the default process-backed `Terminal` service, ending key input on
+ * the default quit keys.
+ *
  * @category layers
+ * @since 4.0.0
  */
 export const layer: Layer<Terminal> = NodeTerminal.layer

package/src/NodeWorker.ts

@@ -1,5 +1,14 @@
 /**
- * @since 1.0.0
+ * Parent-side Node.js support for Effect workers.
+ *
+ * `layerPlatform` installs the `WorkerPlatform` used by a Node program that
+ * owns workers. It supports both `node:worker_threads` workers and IPC-enabled
+ * child processes, routing messages through Effect's worker protocol. `layer`
+ * combines that platform with a `Spawner` callback, and the platform asks
+ * workers to close on scope finalization before forcefully terminating them on
+ * timeout.
+ *
+ * @since 4.0.0
  */
 import * as Deferred from "effect/Deferred"
 import * as Effect from "effect/Effect"
@@ -12,8 +21,12 @@ import type * as ChildProcess from "node:child_process"
 import type * as WorkerThreads from "node:worker_threads"
 
 /**
- * @since 1.0.0
+ * Provides the Node `WorkerPlatform` for `worker_threads` workers and child
+ * process workers, wiring messages, errors, and exits into Effect workers and
+ * terminating the worker if graceful shutdown times out.
+ *
  * @category layers
+ * @since 4.0.0
  */
 export const layerPlatform: Layer.Layer<Worker.WorkerPlatform> = Layer.succeed(Worker.WorkerPlatform)(
   Worker.makePlatform<WorkerThreads.Worker | ChildProcess.ChildProcess>()({
@@ -63,7 +76,7 @@ export const layerPlatform: Layer.Layer<Worker.WorkerPlatform> = Layer.succeed(W
               message: "An messageerror event was emitted",
               cause
             })
-          }).asEffect()
+          })
         )
       })
       port.worker.on("error", (cause) => {
@@ -74,7 +87,7 @@ export const layerPlatform: Layer.Layer<Worker.WorkerPlatform> = Layer.succeed(W
               message: "An error event was emitted",
               cause
             })
-          }).asEffect()
+          })
         )
       })
       port.worker.on("exit", (code) => {
@@ -84,7 +97,7 @@ export const layerPlatform: Layer.Layer<Worker.WorkerPlatform> = Layer.succeed(W
             reason: new WorkerReceiveError({
               message: "The worker has exited with code: " + code
             })
-          }).asEffect()
+          })
         )
       })
       return Effect.void
@@ -93,8 +106,11 @@ export const layerPlatform: Layer.Layer<Worker.WorkerPlatform> = Layer.succeed(W
 )
 
 /**
- * @since 1.0.0
+ * Provides the Node `WorkerPlatform` together with a `Worker.Spawner` created
+ * from the supplied worker or child-process spawning function.
+ *
  * @category layers
+ * @since 4.0.0
  */
 export const layer = (
   spawn: (id: number) => WorkerThreads.Worker | ChildProcess.ChildProcess

package/src/NodeWorkerRunner.ts

@@ -1,5 +1,14 @@
 /**
- * @since 1.0.0
+ * Node.js runtime support for workers that serve Effect worker requests.
+ *
+ * `NodeWorkerRunner` supplies the Node implementation of the Effect worker
+ * runner platform. The exported `layer` runs inside a `node:worker_threads`
+ * worker through `parentPort`, or inside a child process through
+ * `process.send`. It listens for parent messages, runs handlers registered with
+ * `WorkerRunner`, sends replies over the same channel, and closes when the
+ * parent sends the close message.
+ *
+ * @since 4.0.0
  */
 import * as Cause from "effect/Cause"
 import * as Deferred from "effect/Deferred"
@@ -12,8 +21,12 @@ import * as WorkerRunner from "effect/unstable/workers/WorkerRunner"
 import * as WorkerThreads from "node:worker_threads"
 
 /**
- * @since 1.0.0
+ * Provides the `WorkerRunnerPlatform` for code running inside a Node worker
+ * thread or child process, routing parent messages to the registered handler
+ * and sending responses back through the parent channel.
+ *
  * @category layers
+ * @since 4.0.0
  */
 export const layer: Layer.Layer<WorkerRunner.WorkerRunnerPlatform> = Layer.succeed(WorkerRunner.WorkerRunnerPlatform)({
   start<O = unknown, I = unknown>() {
@@ -36,7 +49,7 @@ export const layer: Layer.Layer<WorkerRunner.WorkerRunnerPlatform> = Layer.succe
         Effect.scopedWith(Effect.fnUntraced(function*(scope) {
           const closeLatch = Deferred.makeUnsafe<void, WorkerError>()
           const trackFiber = Fiber.runIn(scope)
-          const services = yield* Effect.services<R>()
+          const services = yield* Effect.context<R>()
           const runFork = Effect.runForkWith(services)
           const onExit = (exit: Exit.Exit<any, E>) => {
             if (exit._tag === "Failure" && !Cause.hasInterruptsOnly(exit.cause)) {
@@ -70,7 +83,7 @@ export const layer: Layer.Layer<WorkerRunner.WorkerRunnerPlatform> = Layer.succe
                     message: "received messageerror event",
                     cause
                   })
-                }).asEffect()
+                })
               )
             })
             WorkerThreads.parentPort.on("error", (cause) => {
@@ -81,7 +94,7 @@ export const layer: Layer.Layer<WorkerRunner.WorkerRunnerPlatform> = Layer.succe
                     message: "received messageerror event",
                     cause
                   })
-                }).asEffect()
+                })
               )
             })
           }

package/src/Undici.ts

@@ -1,16 +1,29 @@
 /**
- * @since 1.0.0
+ * Re-export of the Undici HTTP client package used by the Node platform.
+ *
+ * This module gives Effect applications a package-local import for Undici
+ * primitives while working with `@effect/platform-node`. Import named Undici
+ * APIs from here when configuring Node HTTP client dispatchers, creating agents
+ * or mock agents, setting the process-global dispatcher, or sharing the same
+ * Undici types with integrations that use the platform HTTP client.
+ *
+ * The module does not wrap or reinterpret Undici behavior. It forwards the
+ * installed `undici` named exports and default export, so connection pooling,
+ * dispatcher lifetimes, mocking, aborts, and request options follow Undici's
+ * own semantics.
+ *
+ * @since 4.0.0
  */
 import Undici from "undici"
 
 /**
- * @since 1.0.0
- * @category undici
+ * @category Undici
+ * @since 4.0.0
  */
 export * from "undici"
 
 /**
- * @since 1.0.0
- * @category undici
+ * @category Undici
+ * @since 4.0.0
  */
 export default Undici

package/src/index.ts

@@ -1,127 +1,130 @@
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 
 // @barrel: Auto-generated exports. Do not edit manually.
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as Mime from "./Mime.ts"
 
 /**
- * Node.js implementation of `ChildProcessSpawner`.
- *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeChildProcessSpawner from "./NodeChildProcessSpawner.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeClusterHttp from "./NodeClusterHttp.ts"
 
 /**
- * @since 1.0.0
+ * @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 1.0.0
+ * @since 4.0.0
  */
 export * as NodeHttpClient from "./NodeHttpClient.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeHttpIncomingMessage from "./NodeHttpIncomingMessage.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeHttpPlatform from "./NodeHttpPlatform.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeHttpServer from "./NodeHttpServer.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeHttpServerRequest from "./NodeHttpServerRequest.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeMultipart from "./NodeMultipart.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodePath from "./NodePath.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeRedis from "./NodeRedis.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeRuntime from "./NodeRuntime.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeServices from "./NodeServices.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeSink from "./NodeSink.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeSocket from "./NodeSocket.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeSocketServer from "./NodeSocketServer.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeStdio from "./NodeStdio.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeStream from "./NodeStream.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeTerminal from "./NodeTerminal.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeWorker from "./NodeWorker.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as NodeWorkerRunner from "./NodeWorkerRunner.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as Undici from "./Undici.ts"