@phreshos/node 0.1.8 → 0.1.9

package/README.md

@@ -1,66 +1,74 @@
-# @phreshos/node
+# `@phreshos/node`
 
-The Node.js interface for a running PhreshOS System and local Program projects.
+Node.js access to a running PhreshOS System and local Program projects.
 
-```ts
-import { Project, System } from "@phreshos/node"
+The Node SDK exposes the same System model used inside Server Endpoints and adds
+only connection lifecycle and project tooling.
 
-const project = await Project.open()
-const system = await System.connect()
+## Installation
 
-for await (const chunk of await project.install(system)) {
-  process[chunk.stream].write(chunk.text)
-}
+| Package manager | Command |
+| --- | --- |
+| npm | `npm install @phreshos/node` |
+| pnpm | `pnpm add @phreshos/node` |
+| Bun | `bun add @phreshos/node` |
+| Yarn | `yarn add @phreshos/node` |
+
+## System
 
-// This is the same transport-neutral System contract used by Server Programs.
+```ts
+import { System } from "@phreshos/node"
+
+const system = await System.connect()
 const programs = await system.program.list()
 
 await system.disconnect()
 ```
 
-`Project.open()` discovers `phresh.config.ts` from the current working
-directory by default. `System.connect()` resolves its home from an explicit
-argument, then `PHRESHOS_HOME`, then the current user's `.phreshos` directory.
+The transport is not public API. Code receives the same System, Program,
+Process, Endpoint, Service, Window, storage, and upload handles used by the
+Server SDK. `disconnect()` exists because external Node code owns the
+connection.
 
-Project operations remain available without duplicating CLI logic:
+## Project
 
 ```ts
-const project = await Project.open() // process.cwd()
+import { Project, System } from "@phreshos/node"
+
+const project = await Project.open()
 const system = await System.connect()
 
-await project.pack()
 for await (const event of await project.start(system, { signal })) {
-  // started, output, exited
-}
-
-for await (const event of await project.dev(system, { signal })) {
-  // started, output, exited
-}
-
-for await (const chunk of await project.install(system)) {
-  // stdout or stderr
+  console.log(event)
 }
 
 await system.disconnect()
 ```
 
-These shortcuts return the original `program.install()` or
-`program.process.run()` generator; they do not consume or mirror its events.
-The CLI owns presentation and its additional development Client server.
+`Project` owns authoring concerns: builds, development and production
+definitions, installation, execution shortcuts, and packaging. The System
+receives only the resulting Program definition.
 
-For custom composition, resolve either Program definition explicitly:
+`Project.open()` starts from the current working directory by default.
+`System.connect()` resolves an explicit System home, then `PHRESHOS_HOME`,
+then the current owner's default System home.
 
-```ts
-const definition = project.productionDefinition()
-// const definition = project.developmentDefinition()
+## Development
 
-const program = await system.forceCreateProgram(definition)
-const lifecycle = program.process.run({}, { signal })
+```sh
+bun install --frozen-lockfile
+bun run verify
 ```
 
-The lower-level System API stays composable: use
-`system.forceCreateProgram(definition)` to replace one runtime Program, and
-`program.process.run(launch, { signal })` when one Process should live exactly
-as long as its asynchronous iterator. Node also exports the runtime `Program`,
-`Process`, `Endpoint`, `Server`, and `Client` constructors; handles are
-canonical within one connected `System` and support `instanceof`.
+See the [Node SDK documentation](https://github.com/PhreshOS/docs/blob/main/content/docs/sdks/node.mdx)
+for the public model.
+
+## Repository boundary
+
+This repository owns the external Node connection and local-project API. Core
+owns the domain model, Server owns the Endpoint runtime adapter, and CLI owns
+terminal presentation and native service management.
+
+## License
+
+Licensed under the [MIT License](LICENSE). Copyright © 2026 Zohayr SLILEH.

package/dist/traffic.d.ts

@@ -15,7 +15,7 @@ export declare class EndpointTrafficHandle<Definitions extends object = {}> exte
         event: string;
         questionId: string;
         message: Readonly<{
-            to: import("@phreshos/core").Server<{}>;
+            to: import("@phreshos/core").Server<{}> | null;
             payload: Payload;
         }>;
     }>>;
@@ -28,7 +28,7 @@ export declare class ServerTrafficHandle<Definitions extends object = {}> extend
         event: string;
         questionId: string;
         message: Readonly<{
-            to: Endpoint<{}>;
+            to: Endpoint<{}> | null;
             outcome: import("@phreshos/core").Outcome<Result>;
         }>;
     }>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phreshos/node",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "Node.js access to PhreshOS and Program projects.",
   "type": "module",
   "main": "dist/main.js",
@@ -36,7 +36,7 @@
     "prepack": "node --run build"
   },
   "dependencies": {
-    "@phreshos/core": "^0.1.30",
+    "@phreshos/core": "^0.1.31",
     "adm-zip": "^0.6.0",
     "jiti": "^2.7.0"
   },