@phreshos/node 0.1.5 → 0.1.7

package/dist/main.d.ts

@@ -1,5 +1,5 @@
 export { gatewayAddress } from "./address.js";
 export { Client, ClientService, Endpoint, Process, Program, Server, ServerService, System, type ProgramProcessRunEvent, type ProgramProcessRunOptions } from "./system.js";
-export { Service, type ServiceKey, type ServiceLifecycle, type ServiceLifecycleEvents } from "@phreshos/core";
+export { Service, type ClientLaunch, type Launch, type ProgramDefinition, type ServerLaunch, type ServiceKey, } from "@phreshos/core";
 export { resolveHome } from "./home.js";
 export { Project, type Manifest, type PackedProject, type ProjectMode, type ProjectOptions, type ProjectRunOptions } from "./project.js";

package/dist/main.js

@@ -1,5 +1,5 @@
 export { gatewayAddress } from "./address.js";
 export { Client, ClientService, Endpoint, Process, Program, Server, ServerService, System } from "./system.js";
-export { Service } from "@phreshos/core";
+export { Service, } from "@phreshos/core";
 export { resolveHome } from "./home.js";
 export { Project } from "./project.js";

package/dist/project.js

@@ -70,6 +70,7 @@ export class Project {
             ...server && { server: {
                     location: resolve(this.directory, server.location),
                     start: server.start,
+                    service: server.service,
                     installCommand: config.server?.installCommand,
                     uninstallCommand: config.server?.uninstallCommand,
                     ...serverExecution(server)
@@ -77,6 +78,7 @@ export class Project {
             ...client && { client: {
                     location: /^https?:\/\//i.test(client.location) ? client.location : resolve(this.directory, client.location),
                     start: client.start,
+                    service: client.service,
                     title: config.client?.title,
                     size: config.client?.size,
                     position: config.client?.position,
@@ -203,6 +205,8 @@ function validateConfig(config) {
             throw new Error(`A declared ${half} half must have a location`);
         if (declared.start !== undefined && typeof declared.start !== "boolean")
             throw new Error(`A declared ${half} Endpoint's start default must be true or false`);
+        if (declared.service !== undefined && typeof declared.service !== "boolean")
+            throw new Error(`A declared ${half} Endpoint's service default must be true or false`);
     }
     if (!(config.server && (config.server.start ?? true)) && !(config.client && (config.client.start ?? true))) {
         throw new Error("A Program's default Process must start a Server Endpoint, a Client Endpoint, or both");
@@ -269,6 +273,7 @@ function packageDefinition(config, version) {
         ...config.server && { server: {
                 location: "server",
                 start: config.server.start,
+                service: config.server.service,
                 installCommand: config.server.installCommand,
                 uninstallCommand: config.server.uninstallCommand,
                 ...serverExecution(config.server)
@@ -276,6 +281,7 @@ function packageDefinition(config, version) {
         ...config.client && { client: {
                 location: "client",
                 start: config.client.start,
+                service: config.client.service,
                 title: config.client.title,
                 size: config.client.size,
                 position: config.client.position,

package/dist/system.js

@@ -62,8 +62,12 @@ export class System {
         requireConnected(this);
         if (!isServiceKey(key))
             throw new Error("A complete service key is required");
-        const normalized = Object.freeze({ program: key.program, endpoint: key.endpoint, name: key.name });
-        const identity = JSON.stringify([normalized.program, normalized.endpoint, normalized.name]);
+        const normalized = Object.freeze({
+            ...(key.program === undefined ? {} : { program: key.program }),
+            process: key.process,
+            endpoint: key.endpoint
+        });
+        const identity = JSON.stringify([key.program ?? null, key.process, key.endpoint]);
         return systemState(this).handles.obtain(`service:${identity}`, () => normalized.endpoint === "server"
             ? new ServerServiceHandle(this, normalized)
             : new ClientServiceHandle(this, normalized));
@@ -153,7 +157,7 @@ class ProgramRegistry extends Events {
         const waited = value;
         if (waited.event === "uninstall") {
             const payload = waited.payload;
-            return { program: programHandle(this.system, required(payload.program)), everythingRemoved: payload.everythingRemoved === true };
+            return { program: programHandle(this.system, required(payload.program)), everything: payload.everything === true };
         }
         return programHandle(this.system, required(waited.payload));
     }
@@ -171,7 +175,7 @@ class ProgramHandle extends ProgramBase {
         this.snapshot = snapshot;
         bindEvents(this, new Events(["forget", "uninstall"], (event, signal, timeout) => transport(system).control({
             capability: "program", operation: "wait", input: { program: snapshot.identity, event, timeout }
-        }, signal).then(value => value.payload)));
+        }, signal).then(value => programEntityEvent(event, value))));
         this.reference = snapshot.reference;
         this.identity = snapshot.identity;
         this.process = new ProgramProcesses(system, this);
@@ -182,11 +186,15 @@ class ProgramHandle extends ProgramBase {
     get description() { return this.snapshot.description; }
     get hasAgent() { return this.snapshot.hasAgent; }
     get server() {
-        return this.snapshot.server ? Object.freeze({ start: this.snapshot.server.start }) : null;
+        return this.snapshot.server ? Object.freeze({
+            start: this.snapshot.server.start,
+            service: this.snapshot.server.service
+        }) : null;
     }
     get client() {
         return this.snapshot.client ? Object.freeze({
             start: this.snapshot.client.start,
+            service: this.snapshot.client.service,
             title: this.snapshot.client.title,
             size: this.snapshot.client.size,
             position: this.snapshot.client.position,
@@ -255,7 +263,7 @@ class ProgramProcesses extends Events {
     system;
     program;
     constructor(system, program) {
-        super(["endpointStart", "endpointStop", "create", "exit"], (event, signal, timeout) => transport(system).control({
+        super(["create", "exit"], (event, signal, timeout) => transport(system).control({
             capability: "process", operation: "wait", input: { program: program.identity, event, timeout }
         }, signal).then(value => processEvent(system, value)));
         this.system = system;
@@ -328,7 +336,7 @@ class ProgramProcesses extends Events {
 class ProcessRegistry extends Events {
     system;
     constructor(system) {
-        super(["endpointStart", "endpointStop", "create", "exit"], (event, signal, timeout) => transport(system).control({
+        super(["create", "exit"], (event, signal, timeout) => transport(system).control({
             capability: "process", operation: "wait", input: { event, timeout }
         }, signal).then(value => processEvent(system, value)));
         this.system = system;
@@ -358,9 +366,9 @@ class ProcessHandle extends ProcessBase {
         super();
         this.system = system;
         this.snapshot = snapshot;
-        bindEvents(this, new Events(["endpointStart", "endpointStop", "exit"], (event, signal, timeout) => transport(system).control({
+        bindEvents(this, new Events(["exit"], (event, signal, timeout) => transport(system).control({
             capability: "process", operation: "wait", input: { process: snapshot.identity, event, timeout }
-        }, signal).then(value => processEvent(system, value))));
+        }, signal).then(exactProcessEvent)));
         this.identity = snapshot.identity;
         this.name = snapshot.name;
         this.startedAt = new Date(snapshot.startedAt);
@@ -396,11 +404,12 @@ class EndpointOperations extends Events {
         const value = await this.inspect();
         return value.running;
     }
-    async start(client) { await this.operation("start", client); }
+    async start(launch = {}) { await this.operation("start", launch); }
     async stop() { await this.operation("stop"); }
-    async service() {
-        const key = await transport(this.system).api({ capability: "endpoint", operation: "service", process: this.owner.identity, endpoint: this.endpoint });
-        return key ? this.system.service(key) : null;
+    async isService() {
+        return await transport(this.system).api({
+            capability: "endpoint", operation: "isService", process: this.owner.identity, endpoint: this.endpoint
+        });
     }
     publish(event, payload) {
         void transport(this.system).control({ capability: "endpoint", operation: "publish", input: {
@@ -412,9 +421,9 @@ class EndpointOperations extends Events {
                 process: this.owner.identity, endpoint: this.endpoint
             } });
     }
-    async operation(operation, client) {
+    async operation(operation, launch) {
         await transport(this.system).control({ capability: "endpoint", operation, input: {
-                process: this.owner.identity, endpoint: this.endpoint, ...(client ? { client } : {})
+                process: this.owner.identity, endpoint: this.endpoint, ...(launch ? { launch } : {})
             } });
     }
 }
@@ -434,7 +443,8 @@ class ServerEndpoint extends ServerBase {
     }
     process() { return this.base.process(); }
     exists() { return this.base.exists(); }
-    start() { return this.base.start(); }
+    isService() { return this.base.isService(); }
+    start(launch) { return this.base.start(launch); }
     stop() { return this.base.stop(); }
     publish(event, payload) { return this.base.publish(event, payload); }
     async ask(event, payload) {
@@ -450,9 +460,6 @@ class ServerEndpoint extends ServerBase {
     async waitReady(timeout) {
         await transport(this.system).control({ capability: "endpoint", operation: "waitReady", input: { process: this.owner.identity, endpoint: "server", timeout } });
     }
-    async service() {
-        return await this.base.service();
-    }
 }
 class ClientEndpoint extends ClientBase {
     endpoint = "client";
@@ -468,12 +475,10 @@ class ClientEndpoint extends ClientBase {
     }
     process() { return this.base.process(); }
     exists() { return this.base.exists(); }
-    start(overrides) { return this.base.start(overrides); }
+    isService() { return this.base.isService(); }
+    start(launch) { return this.base.start(launch); }
     stop() { return this.base.stop(); }
     publish(event, payload) { return this.base.publish(event, payload); }
-    async service() {
-        return await this.base.service();
-    }
 }
 class SystemWindow extends Events {
     system;
@@ -508,18 +513,18 @@ class SystemWindow extends Events {
 class ServiceBase {
     system;
     key;
-    name;
     lifecycle;
     constructor(system, key) {
         this.system = system;
         this.key = key;
-        this.lifecycle = new Events(["enable", "disable"], (event, signal, timeout) => transport(system).api({
+        this.lifecycle = new Events(["start", "stop"], (event, signal, timeout) => transport(system).api({
             capability: "service", operation: "wait", scope: "lifecycle", key, event, timeout
         }, signal));
-        this.name = key.name;
     }
-    async enabled() { return await transport(this.system).api({ capability: "service", operation: "enabled", key: this.key }); }
-    async waitReady(timeout) { await transport(this.system).api({ capability: "service", operation: "waitReady", key: this.key, timeout }); }
+    async exists() { return await transport(this.system).api({ capability: "service", operation: "exists", key: this.key }); }
+    publish(event, payload) {
+        void transport(this.system).api({ capability: "service", operation: "publish", key: this.key, event, payload });
+    }
 }
 /** Node-SDK handle for a Service provided by a Server Endpoint. */
 export class ServerService extends CoreServerService {
@@ -528,7 +533,6 @@ export class ServerService extends CoreServerService {
 class ServerServiceHandle extends ServerService {
     system;
     key;
-    name;
     lifecycle;
     base;
     constructor(system, key) {
@@ -536,17 +540,16 @@ class ServerServiceHandle extends ServerService {
         this.system = system;
         this.key = key;
         this.base = new ServiceBase(system, key);
-        this.name = key.name;
         this.lifecycle = this.base.lifecycle;
         bindEvents(this, new Events([], (event, signal, timeout) => transport(system).api({
             capability: "service", operation: "wait", scope: "events", key, event, timeout
         }, signal)));
     }
-    enabled() { return this.base.enabled(); }
-    waitReady(timeout) { return this.base.waitReady(timeout); }
-    publish = (event, payload) => {
-        void transport(this.system).api({ capability: "service", operation: "publish", key: this.key, event, payload });
-    };
+    exists() { return this.base.exists(); }
+    async waitReady(timeout) {
+        await transport(this.system).api({ capability: "service", operation: "waitReady", key: this.key, timeout });
+    }
+    publish = (event, payload) => this.base.publish(event, payload);
     async ask(event, payload) {
         return await transport(this.system).api({ capability: "service", operation: "ask", key: this.key, event, payload });
     }
@@ -561,20 +564,18 @@ export class ClientService extends CoreClientService {
     constructor() { super(); }
 }
 class ClientServiceHandle extends ClientService {
-    name;
     lifecycle;
     base;
     constructor(system, key) {
         super();
         this.base = new ServiceBase(system, key);
-        this.name = key.name;
         this.lifecycle = this.base.lifecycle;
         bindEvents(this, new Events([], (event, signal, timeout) => transport(system).api({
             capability: "service", operation: "wait", scope: "events", key, event, timeout
         }, signal)));
     }
-    enabled() { return this.base.enabled(); }
-    waitReady(timeout) { return this.base.waitReady(timeout); }
+    exists() { return this.base.exists(); }
+    publish = (event, payload) => this.base.publish(event, payload);
 }
 async function listProcesses(system, program) {
     const processes = [];
@@ -599,18 +600,15 @@ async function* command(system, request) {
 async function waitEndpointLifecycle(system, owner, endpoint, event, signal, timeout = 10_000) {
     if (event !== "start" && event !== "stop")
         throw new Error(`An Endpoint lifecycle has no "${event}" event`);
-    const processEventName = event === "start" ? "endpointStart" : "endpointStop";
-    const deadline = Date.now() + timeout;
-    while (true) {
-        const value = await transport(system).control({
-            capability: "process",
-            operation: "wait",
-            input: { process: owner.identity, event: processEventName, timeout: Math.max(0, deadline - Date.now()) }
-        }, signal);
-        const changed = processEvent(system, value);
-        if (changed === owner[endpoint])
-            return undefined;
-    }
+    await transport(system).control({
+        capability: "endpoint",
+        operation: "waitLifecycle",
+        input: { process: owner.identity, endpoint, event, timeout }
+    }, signal);
+}
+function programEntityEvent(event, value) {
+    const payload = value.payload;
+    return event === "uninstall" ? payload?.everything === true : undefined;
 }
 function processEvent(system, value) {
     const waited = value;
@@ -622,14 +620,20 @@ function processEvent(system, value) {
             code: payload.code,
             signal: payload.signal
         };
-    if ((waited.event === "endpointStart" || waited.event === "endpointStop") && payload?.processSnapshot) {
-        const process = processHandle(system, payload.processSnapshot);
-        return payload.endpoint === "client" ? process.client : process.server;
-    }
     if (payload && typeof payload.identity === "string")
         return processHandle(system, payload);
     return payload;
 }
+function exactProcessEvent(value) {
+    const payload = value.payload;
+    if (!payload)
+        return payload;
+    return {
+        status: payload.status,
+        code: payload.code,
+        signal: payload.signal
+    };
+}
 function bindEvents(target, events) {
     Object.assign(target, eventsOf(events));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phreshos/node",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Node.js access to PhreshOS and Program projects.",
   "type": "module",
   "main": "dist/main.js",
@@ -11,7 +11,11 @@
       "default": "./dist/main.js"
     }
   },
-  "files": ["dist", "LICENSE", "README.md"],
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
   "author": "Zohayr SLILEH",
   "license": "MIT",
   "repository": {
@@ -32,7 +36,7 @@
     "prepack": "node --run build"
   },
   "dependencies": {
-    "@phreshos/core": "^0.1.26",
+    "@phreshos/core": "^0.1.29",
     "adm-zip": "^0.6.0",
     "jiti": "^2.7.0"
   },