@phreshos/client 0.1.20 → 0.1.22

package/README.md

@@ -19,7 +19,7 @@ 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, publicly served values, and unrestricted server-side Fetch.
+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
@@ -27,6 +27,10 @@ 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;
+it exposes no filesystem path, path segments, listing, deletion, or clearing.
+
 Desktop and pointer access are independent objects rather than events merged
 into System:
 

package/dist/controlled-stream.d.ts

@@ -0,0 +1,2 @@
+/** Wrap a transferred byte stream so cancellation and completion release its transport. */
+export default function controlledStream(body: ReadableStream<Uint8Array>, abort: () => void, close: () => void): ReadableStream<Uint8Array<ArrayBufferLike>>;

package/dist/controlled-stream.js

@@ -0,0 +1,26 @@
+/** Wrap a transferred byte stream so cancellation and completion release its transport. */
+export default function controlledStream(body, abort, close) {
+    const reader = body.getReader();
+    return new ReadableStream({
+        async pull(controller) {
+            try {
+                const next = await reader.read();
+                if (next.done) {
+                    close();
+                    controller.close();
+                }
+                else
+                    controller.enqueue(next.value);
+            }
+            catch (error) {
+                close();
+                controller.error(error);
+            }
+        },
+        async cancel(reason) {
+            abort();
+            close();
+            await reader.cancel(reason);
+        }
+    });
+}

package/dist/main.d.ts

@@ -5,4 +5,4 @@ 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 { 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, ServedFile, 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, SystemTheme, ThemedValue, Theme, ThemeEvents, ThemePreference, Value, WindowEvents, WindowGeometry, WindowLayer, WindowState, Easing, LocalWindow, LocalWindowSurface, VisibilityTransition, Transaction } from "@phreshos/core";

package/dist/storage.js

@@ -1,4 +1,5 @@
 import { content } from "./content.js";
+import controlledStream from "./controlled-stream.js";
 import wire from "./wire.js";
 /** Client-side Program storage, structurally scoped by the iframe boundary. */
 export function area(which) {
@@ -18,7 +19,7 @@ export function area(which) {
             }
             if (!(answer[0] instanceof ReadableStream))
                 throw new Error("The storage response has no byte stream");
-            return controlled(answer[0], abort, close);
+            return controlledStream(answer[0], abort, close);
         }
         catch (error) {
             abort();
@@ -69,28 +70,3 @@ export function sql(kind) {
         }
     };
 }
-function controlled(body, abort, close) {
-    const reader = body.getReader();
-    return new ReadableStream({
-        async pull(controller) {
-            try {
-                const next = await reader.read();
-                if (next.done) {
-                    close();
-                    controller.close();
-                }
-                else
-                    controller.enqueue(next.value);
-            }
-            catch (error) {
-                close();
-                controller.error(error);
-            }
-        },
-        async cancel(reason) {
-            abort();
-            close();
-            await reader.cancel(reason);
-        }
-    });
-}

package/dist/system.d.ts

@@ -1,4 +1,4 @@
-import type { AppearanceSource, ClientServiceHandler, ServedFile, ServerServiceHandler, ServiceKey, SystemTheme } from "@phreshos/core";
+import type { AppearanceSource, ClientServiceHandler, ServerServiceHandler, ServiceKey, SystemUploads, SystemTheme } from "@phreshos/core";
 import { type SystemPointer } from "./pointer.js";
 import { type SystemDesktop } from "./desktop.js";
 type ServiceEndpoint = ServiceKey["endpoint"];
@@ -16,8 +16,8 @@ export interface System {
     readonly desktop: SystemDesktop;
     /** Permission-guarded desktop pointer reads and live movement. */
     readonly pointer: SystemPointer;
-    /** Stores one value as a publicly reachable file. */
-    serve(value: unknown): Promise<ServedFile>;
+    /** Flat System-owned public uploads capability. */
+    readonly uploads: SystemUploads;
     /** Performs an unrestricted server-side fetch on behalf of this Client. */
     fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
     /** Returns a precisely typed stable handle for either service endpoint. */

package/dist/system.js

@@ -1,31 +1,18 @@
 import ClientAppearance from "./appearance.js";
-import { content } from "./content.js";
 import ClientTheme from "./theme.js";
 import wire from "./wire.js";
 import ClientPointer, {} from "./pointer.js";
 import ClientDesktop, {} from "./desktop.js";
 import { prepareService } from "./service.js";
+import { uploads } from "./uploads.js";
+import controlledStream from "./controlled-stream.js";
 class ClientSystem {
     appearance = new ClientAppearance();
     theme = new ClientTheme();
     desktop = new ClientDesktop();
     pointer = new ClientPointer();
+    uploads = uploads;
     service(key) { return prepareService(key); }
-    async serve(value) {
-        const source = content(value);
-        const channel = new MessageChannel();
-        const abort = () => channel.port1.postMessage("abort");
-        try {
-            const answer = await wire.request(["serve", source.body, { extension: source.extension, type: source.type }, channel.port2], undefined, source.body instanceof ReadableStream ? [source.body, channel.port2] : [channel.port2]);
-            channel.port1.close();
-            return answer[0];
-        }
-        catch (error) {
-            abort();
-            channel.port1.close();
-            throw error;
-        }
-    }
     async fetch(input, init) {
         const request = new Request(input, {
             ...init,
@@ -65,7 +52,7 @@ class ClientSystem {
             throw request.signal.aborted ? request.signal.reason : error;
         }
         const responseBody = result.body
-            ? controlled(result.body, abort, () => closeControl(request.signal, control.port1, abort))
+            ? controlledStream(result.body, abort, () => closeControl(request.signal, control.port1, abort))
             : null;
         if (!responseBody)
             closeControl(request.signal, control.port1, abort);
@@ -93,31 +80,6 @@ function requestHeaders(normalized, supplied) {
     const names = new Set(explicit.map(([name]) => name.toLowerCase()));
     return [...normalized.entries()].filter(([name]) => !names.has(name.toLowerCase())).concat(explicit);
 }
-function controlled(body, abort, close) {
-    const reader = body.getReader();
-    return new ReadableStream({
-        async pull(controller) {
-            try {
-                const next = await reader.read();
-                if (next.done) {
-                    close();
-                    controller.close();
-                }
-                else
-                    controller.enqueue(next.value);
-            }
-            catch (error) {
-                close();
-                controller.error(error);
-            }
-        },
-        async cancel(reason) {
-            abort();
-            close();
-            await reader.cancel(reason);
-        }
-    });
-}
 function closeControl(signal, port, abort) {
     signal.removeEventListener("abort", abort);
     port.close();

package/dist/uploads.d.ts

@@ -0,0 +1,12 @@
+import { type SystemUploads, type Upload } from "@phreshos/core";
+/** Flat upload access transported through the Client's Desktop boundary. */
+declare class ClientUploads implements SystemUploads {
+    write(value: unknown): Promise<Upload>;
+    stream(file: string): Promise<ReadableStream<Uint8Array>>;
+    bytes(file: string): Promise<Uint8Array<ArrayBuffer>>;
+    text(file: string): Promise<string>;
+    json<Value>(file: string): Promise<Value>;
+    stat(file: string): Promise<Upload | null>;
+}
+export declare const uploads: ClientUploads;
+export {};

package/dist/uploads.js

@@ -0,0 +1,58 @@
+import { isUploadFile } from "@phreshos/core";
+import { content } from "./content.js";
+import controlledStream from "./controlled-stream.js";
+import wire from "./wire.js";
+/** Flat upload access transported through the Client's Desktop boundary. */
+class ClientUploads {
+    async write(value) {
+        const source = content(value);
+        const channel = new MessageChannel();
+        const abort = () => channel.port1.postMessage("abort");
+        try {
+            const answer = await wire.request(["uploads", "write", source.body, { extension: source.extension, type: source.type }, channel.port2], undefined, source.body instanceof ReadableStream ? [source.body, channel.port2] : [channel.port2]);
+            channel.port1.close();
+            return answer[0];
+        }
+        catch (error) {
+            abort();
+            channel.port1.close();
+            throw error;
+        }
+    }
+    async stream(file) {
+        requireFile(file);
+        const channel = new MessageChannel();
+        const abort = () => channel.port1.postMessage("abort");
+        const close = () => channel.port1.close();
+        try {
+            const answer = await wire.request(["uploads", "stream", file, channel.port2], undefined, [channel.port2]);
+            if (!(answer[0] instanceof ReadableStream))
+                throw new Error("The upload response has no byte stream");
+            return controlledStream(answer[0], abort, close);
+        }
+        catch (error) {
+            abort();
+            close();
+            throw error;
+        }
+    }
+    async bytes(file) {
+        return new Uint8Array(await new Response(await this.stream(file)).arrayBuffer());
+    }
+    async text(file) {
+        return new Response(await this.stream(file)).text();
+    }
+    async json(file) {
+        return JSON.parse(await this.text(file));
+    }
+    async stat(file) {
+        requireFile(file);
+        const answer = await wire.request(["uploads", "stat", file]);
+        return answer[0];
+    }
+}
+function requireFile(file) {
+    if (!isUploadFile(file))
+        throw new Error("That is not an upload file");
+}
+export const uploads = new ClientUploads();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phreshos/client",
-  "version": "0.1.20",
+  "version": "0.1.22",
   "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.17"
+    "@phreshos/core": "^0.1.19"
   },
   "dependencies": {
     "@msgpack/msgpack": "^3.1.3"
   },
   "devDependencies": {
-    "@phreshos/core": "^0.1.17",
+    "@phreshos/core": "^0.1.19",
     "typescript": "^6.0.3"
   }
 }