@phreshos/core 0.1.3 → 0.1.4

package/dist/channel.d.ts

@@ -1,5 +1,6 @@
 import type { Endpoint } from "./endpoint.js";
 import type { Publishable } from "./publishable.js";
+import type { ServiceDefinition } from "./service.js";
 import type { Captures, Subscribable } from "./subscribable.js";
 /** One application value arriving through the current Endpoint's Channel. */
 export type ChannelMessage<Payload = unknown, From = Endpoint> = Readonly<{
@@ -16,9 +17,9 @@ type ChannelFallback<Events extends object, From> = keyof Events extends never ?
 /** Every application event observable through a Channel. */
 export type ChannelCapture<Events extends object = {}, From = Endpoint> = Captures<ChannelEvents<Events, From>, ChannelFallback<Events, From>>;
 /** Addressed input and destinationless output for the executing Endpoint. */
-export interface Channel<Events extends object = {}, From = Endpoint> extends Subscribable<ChannelEvents<Events, From>, ChannelFallback<Events, From>>, Publishable {
+export interface Channel<Events extends object = {}, From = Endpoint, Definition extends ServiceDefinition = ServiceDefinition> extends Subscribable<ChannelEvents<Events, From>, ChannelFallback<Events, From>>, Publishable {
     /** Exposes this executing Channel under one public service name. */
-    enableService(name: string): Promise<void>;
+    enableService(definition: Definition): Promise<void>;
     /** Stops exposing this executing Channel as a service. */
     disableService(): Promise<void>;
 }

package/dist/config.d.ts

@@ -52,11 +52,6 @@ type Description = Readonly<{
     version?: string;
     /** Short human-readable explanation of what the Program does. */
     description?: string;
-    /**
-     * Markdown file describing only the Program-owned API contract.
-     * System access, Endpoint, and event mechanics belong to system documentation.
-     */
-    apiDocs?: string;
     /** PNG source between 128 and 2,048 pixels per side and no larger than 5 MiB. */
     icon?: string;
     /** Command run before production start, installation, and packaging. */

package/dist/main.d.ts

@@ -2,7 +2,7 @@ export { type Message, type Cleanup, type Capture, type Captures, type EventMess
 export { type Publishable } from "./publishable.js";
 export { type Timeoutable } from "./timeout.js";
 export { type Askable, type TimedAskable } from "./askable.js";
-export { ClientServiceHandler, ServerServiceHandler, ServiceHandler, isServiceKey, type ClientServiceChannel, type ServerServiceChannel, type ServiceChannel, type ServiceKey, type ServiceLifecycleEvents } from "./service.js";
+export { ClientServiceHandler, ServerServiceHandler, ServiceHandler, isServiceKey, type ClientServiceChannel, type ServerServiceChannel, type ServerServiceDefinition, type ServiceChannel, type ServiceDefinition, type ServiceKey, type ServiceLifecycleEvents } from "./service.js";
 export { isPermissionName, permissionNames, type PermissionDecision, type PermissionDecisions, type PermissionName, type Permissions, type ProgramPermissions, type TimedPermissions } from "./permissions.js";
 export { type Outcome } from "./outcome.js";
 export { type ServedFile } from "./served-file.js";

package/dist/program.d.ts

@@ -83,11 +83,6 @@ export interface Program<Events extends object = {}> extends Subscribable<Progra
     getProcess(identityOrName: string): Promise<Process | null>;
     /** Creates one Process of this Program. */
     createProcess(launch?: Launch): Promise<Process>;
-    /**
-     * Returns the Program-authored API entry point, or `null`.
-     * The document describes the Program's contract, not system mechanics.
-     */
-    apiDocs(): Promise<string | null>;
     /**
      * Returns one standard PNG representation of this Program's icon.
      * Programs without an authored icon receive the system default.

package/dist/service.d.ts

@@ -9,6 +9,16 @@ export type ServiceKey = Readonly<{
     /** Program-authored service identity. */
     name: string;
 }>;
+/** Runtime declaration of one service exposed by an Endpoint Channel. */
+export type ServiceDefinition = Readonly<{
+    /** Program-authored service identity. */
+    name: string;
+}>;
+/** Runtime declaration of one Server service and its optional API document. */
+export type ServerServiceDefinition = ServiceDefinition & Readonly<{
+    /** Complete API documentation owned by this service. */
+    docs?: string;
+}>;
 /** Lifecycle transitions of one exact service identity. */
 export type ServiceLifecycleEvents = {
     /** A live Endpoint began providing this service. */
@@ -48,6 +58,8 @@ export declare class ServerServiceHandler<Events extends object = {}> extends Se
 export interface ServerServiceHandler<Events extends object = {}> {
     readonly endpoint: "server";
     readonly channel: ServerServiceChannel<Events>;
+    /** Explicitly reads this live Server service's documentation, or `null`. */
+    docs(): Promise<string | null>;
 }
 /** Stable handle for one Client-provided service. */
 export declare class ClientServiceHandler<Events extends object = {}> extends ServiceHandler<ClientServiceChannel<Events>> {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phreshos/core",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Environment-neutral contracts and domain objects for PhreshOS Programs.",
   "type": "module",
   "sideEffects": false,