@phreshos/client 0.1.22 → 0.1.24

package/README.md

@@ -18,14 +18,15 @@ a peer dependency. It does not redefine those objects, own server-side
 capabilities, or contain System and transport implementations.
 
 Its `System` contract exposes only desktop-session capabilities: read-only
-System Appearance, the mutable Theme local to this Desktop, desktop and pointer
-state, flat public uploads, and unrestricted server-side Fetch.
+System Appearance, mutable preferences local to this Desktop, desktop and
+pointer state, flat public uploads, and unrestricted server-side Fetch.
 `system.appearance.snapshot()` reads complete unresolved authoritative state.
-`system.theme.snapshot()` reads only the effective `"light" | "dark"` mode;
-`update("default")` resumes following the native environment. Both expose
-ordinary live-only `change` subscriptions with no initial replay. A Client
-cannot write authoritative Appearance or discover system-wide Programs and
-Processes.
+`system.desktopPreferences.snapshot()` reads the complete effective
+`{ theme, animations }` state. Its updates may set either preference explicitly
+or use `"default"` to resume following the native environment. Both capabilities
+expose ordinary live-only `change` subscriptions with no initial replay. A
+Client cannot write authoritative Appearance or discover system-wide Programs
+and Processes.
 
 `system.uploads` has the same flat contract as the Server SDK. It writes a
 value, then reads or describes it using exactly one opaque generated file key;

package/dist/desktop-preferences.d.ts

@@ -0,0 +1,11 @@
+import { type DesktopPreferencesUpdate } from "@phreshos/core";
+import Events from "./events.js";
+/** Mutable effective preferences local to the current Desktop. */
+export default class ClientDesktopPreferences extends Events {
+    constructor();
+    snapshot(): Promise<Readonly<{
+        theme: import("@phreshos/core").Theme;
+        animations: boolean;
+    }>>;
+    update(preferences: DesktopPreferencesUpdate): Promise<void>;
+}

package/dist/desktop-preferences.js

@@ -0,0 +1,21 @@
+import {} from "@phreshos/core";
+import Events from "./events.js";
+import wire from "./wire.js";
+/** Mutable effective preferences local to the current Desktop. */
+export default class ClientDesktopPreferences extends Events {
+    constructor() {
+        super((event, listener, impossible) => wire.on("host-desktop-preferences", event, value => {
+            listener(value);
+        }, null, impossible), observer => wire.onAll("host-desktop-preferences", (event, value) => {
+            if (typeof event === "string")
+                observer(event, value);
+        }));
+    }
+    async snapshot() {
+        const [preferences] = await wire.request(["desktopPreferences"]);
+        return preferences;
+    }
+    async update(preferences) {
+        await wire.request(["updateDesktopPreferences", preferences]);
+    }
+}

package/dist/main.d.ts

@@ -3,6 +3,6 @@ export { type SystemPointer, type PointerEvents, type PointerPosition } from "./
 export { type DesktopEvents, type DesktopSize, type SystemDesktop } from "./desktop.js";
 export { current, type Current, type CurrentServer } from "./current.js";
 export { type Channel, type ChannelCapture, type ChannelEvents, type ChannelMessage } from "./channel.js";
-export { ClientServiceHandler, ServerServiceHandler, ServiceHandler, type ClientServiceChannel, type ServerServiceChannel, type ServiceChannel, type ServiceKey, type ServiceLifecycleEvents } from "@phreshos/core";
+export { ClientService, ServerService, Service, type ClientServiceChannel, type ServerServiceChannel, type ServiceChannel, type ServiceKey, type ServiceLifecycleEvents } from "@phreshos/core";
 export { Client, Endpoint, Process, Program, Server, type Window, type ProgramProcess, type AnswerCapture, type AnswerMessage, type AnswerObserver, type AskCapture, type AskMessage, type AskObserver, type ClientTraffic, type EndpointTraffic, type ServerTraffic, type TrafficCapture, type TrafficEvents, type TrafficMessage } from "./domain.js";
-export type { Askable, Capture, Captures, ClientDeclaration, Cleanup, DirectoryStat, EndpointDeclaration, EntryStat, EventMessage, EventName, EventObserver, EventOptions, EventSubscriber, Exit, FileStat, Launch, LaunchClient, Layer, LogKind, LogRecord, LogSource, Message, OtherStat, Outcome, PermissionDecision, Permission, Position, Storage, ProgramEvents, ProgramProcessEvents, ProgramProcessExit, ProgramSql, ProgramStore, ProcessEvents, Publishable, SystemUploads, Upload, Size, Subscribable, SubscribableEvents, SubscribableFallback, TimedAskable, TimedPermission, Timeoutable, Appearance, AppearanceEvents, AppearanceSource, AppearanceSurface, SystemTheme, ThemedValue, Theme, ThemeEvents, ThemePreference, Value, WindowEvents, WindowGeometry, WindowLayer, WindowState, Easing, LocalWindow, LocalWindowSurface, VisibilityTransition, Transaction } from "@phreshos/core";
+export type { Askable, Capture, Captures, ClientDeclaration, Cleanup, DirectoryStat, EndpointDeclaration, EntryStat, EventMessage, EventName, EventObserver, EventOptions, EventSubscriber, Exit, FileStat, Launch, LaunchClient, Layer, LogKind, LogRecord, LogSource, Message, OtherStat, Outcome, PermissionDecision, Permission, Position, Storage, ProgramEvents, ProgramProcessEvents, ProgramProcessExit, ProgramSql, ProgramStore, ProcessEvents, Publishable, SystemUploads, Upload, Size, Subscribable, SubscribableEvents, SubscribableFallback, TimedAskable, TimedPermission, Timeoutable, Appearance, AppearanceEvents, AppearanceSource, AppearanceSurface, AnimationsPreference, DesktopPreferences, DesktopPreferencesEvents, DesktopPreferencesUpdate, SystemDesktopPreferences, ThemedValue, Theme, ThemePreference, Value, WindowEvents, WindowGeometry, WindowLayer, WindowState, Easing, LocalWindow, LocalWindowSurface, VisibilityTransition, Transaction } from "@phreshos/core";

package/dist/main.js

@@ -3,5 +3,5 @@ export {} from "./pointer.js";
 export {} from "./desktop.js";
 export { current } from "./current.js";
 export {} from "./channel.js";
-export { ClientServiceHandler, ServerServiceHandler, ServiceHandler } from "@phreshos/core";
+export { ClientService, ServerService, Service } from "@phreshos/core";
 export { Client, Endpoint, Process, Program, Server } from "./domain.js";

package/dist/service.d.ts

@@ -1,14 +1,14 @@
-import { type ClientServiceHandler, type ServerServiceHandler, type ServiceHandler, type ServiceKey } from "@phreshos/core";
+import { type ClientService, type ServerService, type Service, type ServiceKey } from "@phreshos/core";
 import type { HandleAddress } from "./domain.js";
 export declare function prepareService<EventsMap extends object = {}>(key: ServiceKey & {
     endpoint: "server";
-}): ServerServiceHandler<EventsMap>;
+}): ServerService<EventsMap>;
 export declare function prepareService<EventsMap extends object = {}>(key: ServiceKey & {
     endpoint: "client";
-}): ClientServiceHandler<EventsMap>;
-export declare function prepareService(key: ServiceKey): ServiceHandler;
+}): ClientService<EventsMap>;
+export declare function prepareService(key: ServiceKey): Service;
 export declare function enableCurrentService(name: string): Promise<void>;
 export declare function disableCurrentService(): Promise<void>;
-export declare function endpointService<EventsMap extends object = {}>(target: HandleAddress | null, endpoint: "server"): Promise<ServerServiceHandler<EventsMap> | null>;
-export declare function endpointService<EventsMap extends object = {}>(target: HandleAddress | null, endpoint: "client"): Promise<ClientServiceHandler<EventsMap> | null>;
-export declare function endpointService(target: HandleAddress | null, endpoint: "server" | "client"): Promise<ServiceHandler | null>;
+export declare function endpointService<EventsMap extends object = {}>(target: HandleAddress | null, endpoint: "server"): Promise<ServerService<EventsMap> | null>;
+export declare function endpointService<EventsMap extends object = {}>(target: HandleAddress | null, endpoint: "client"): Promise<ClientService<EventsMap> | null>;
+export declare function endpointService(target: HandleAddress | null, endpoint: "server" | "client"): Promise<Service | null>;

package/dist/service.js

@@ -1,11 +1,11 @@
-import { ClientServiceHandler as CoreClientServiceHandler, ServerServiceHandler as CoreServerServiceHandler, isServiceKey } from "@phreshos/core";
+import { ClientService as CoreClientService, ServerService as CoreServerService, isServiceKey } from "@phreshos/core";
 import Deadline from "./deadline.js";
 import Events from "./events.js";
 import HandleRegistry from "./handle-registry.js";
 import wire from "./wire.js";
 const handles = new HandleRegistry();
-const ServerServiceBase = CoreServerServiceHandler;
-const ClientServiceBase = CoreClientServiceHandler;
+const ServerServiceBase = CoreServerService;
+const ClientServiceBase = CoreClientService;
 class ServerChannelHandle extends Events {
     key;
     constructor(key) {

package/dist/system.d.ts

@@ -1,17 +1,17 @@
-import type { AppearanceSource, ClientServiceHandler, ServerServiceHandler, ServiceKey, SystemUploads, SystemTheme } from "@phreshos/core";
+import type { AppearanceSource, ClientService, SystemDesktopPreferences, ServerService, ServiceKey, SystemUploads } from "@phreshos/core";
 import { type SystemPointer } from "./pointer.js";
 import { type SystemDesktop } from "./desktop.js";
 type ServiceEndpoint = ServiceKey["endpoint"];
 type ServiceAddress<Endpoint extends ServiceEndpoint> = Omit<ServiceKey, "endpoint"> & Readonly<{
     endpoint: Endpoint;
 }>;
-type ServiceHandle<Endpoint extends ServiceEndpoint, Events extends object> = Endpoint extends "server" ? ServerServiceHandler<Events> : ClientServiceHandler<Events>;
+type ServiceHandle<Endpoint extends ServiceEndpoint, Events extends object> = Endpoint extends "server" ? ServerService<Events> : ClientService<Events>;
 /** Desktop capabilities structurally available to a Client endpoint. */
 export interface System {
     /** Complete unresolved Appearance read from the System authority. */
     readonly appearance: AppearanceSource;
-    /** Mutable effective Theme local to this Desktop. */
-    readonly theme: SystemTheme;
+    /** Mutable effective preferences local to this Desktop. */
+    readonly desktopPreferences: SystemDesktopPreferences;
     /** Layer-independent desktop size reads and live updates. */
     readonly desktop: SystemDesktop;
     /** Permission-guarded desktop pointer reads and live movement. */
@@ -23,9 +23,9 @@ export interface System {
     /** Returns a precisely typed stable handle for either service endpoint. */
     service<Endpoint extends ServiceEndpoint>(key: ServiceAddress<Endpoint>): ServiceHandle<Endpoint, {}>;
     /** Returns a typed stable handle for one exact Server service identity. */
-    service<ServiceEvents extends object>(key: ServiceAddress<"server">): ServerServiceHandler<ServiceEvents>;
+    service<ServiceEvents extends object>(key: ServiceAddress<"server">): ServerService<ServiceEvents>;
     /** Returns a typed stable handle for one exact Client service identity. */
-    service<ServiceEvents extends object>(key: ServiceAddress<"client">): ClientServiceHandler<ServiceEvents>;
+    service<ServiceEvents extends object>(key: ServiceAddress<"client">): ClientService<ServiceEvents>;
 }
 /** Desktop capabilities available to this Client. */
 export declare const system: System;

package/dist/system.js

@@ -1,5 +1,5 @@
 import ClientAppearance from "./appearance.js";
-import ClientTheme from "./theme.js";
+import ClientDesktopPreferences from "./desktop-preferences.js";
 import wire from "./wire.js";
 import ClientPointer, {} from "./pointer.js";
 import ClientDesktop, {} from "./desktop.js";
@@ -8,7 +8,7 @@ import { uploads } from "./uploads.js";
 import controlledStream from "./controlled-stream.js";
 class ClientSystem {
     appearance = new ClientAppearance();
-    theme = new ClientTheme();
+    desktopPreferences = new ClientDesktopPreferences();
     desktop = new ClientDesktop();
     pointer = new ClientPointer();
     uploads = uploads;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phreshos/client",
-  "version": "0.1.22",
+  "version": "0.1.24",
   "description": "The SDK used by a Program's client endpoint.",
   "type": "module",
   "main": "dist/main.js",
@@ -47,13 +47,13 @@
     "prepack": "node --run build"
   },
   "peerDependencies": {
-    "@phreshos/core": "^0.1.19"
+    "@phreshos/core": "^0.1.24"
   },
   "dependencies": {
     "@msgpack/msgpack": "^3.1.3"
   },
   "devDependencies": {
-    "@phreshos/core": "^0.1.19",
+    "@phreshos/core": "^0.1.24",
     "typescript": "^6.0.3"
   }
 }

package/dist/theme.d.ts

@@ -1,8 +0,0 @@
-import { type Theme, type ThemePreference } from "@phreshos/core";
-import Events from "./events.js";
-/** Mutable Theme local to the current Desktop. */
-export default class ClientTheme extends Events {
-    constructor();
-    snapshot(): Promise<Theme>;
-    update(theme: ThemePreference): Promise<void>;
-}

package/dist/theme.js

@@ -1,19 +0,0 @@
-import {} from "@phreshos/core";
-import Events from "./events.js";
-import wire from "./wire.js";
-/** Mutable Theme local to the current Desktop. */
-export default class ClientTheme extends Events {
-    constructor() {
-        super((event, listener, impossible) => wire.on("host-theme", event, value => listener(value), null, impossible), observer => wire.onAll("host-theme", (event, value) => {
-            if (typeof event === "string")
-                observer(event, value);
-        }));
-    }
-    async snapshot() {
-        const [theme] = await wire.request(["theme"]);
-        return theme;
-    }
-    async update(theme) {
-        await wire.request(["update-theme", theme]);
-    }
-}