@protobase/client 0.59.1 → 0.59.3

package/dist/channel-binary-frame.js

@@ -0,0 +1,29 @@
+//#region src/channel-binary-frame.ts
+const encoder = new TextEncoder();
+const decoder = new TextDecoder();
+const lengthBytes = 4;
+/**
+* A binary frame of `/api/channels`, which carries a broadcast of bytes: the byte length of a JSON header, the header,
+* the message without its payload, then the payload's bytes.
+*/
+const encodeBinaryFrame = (header, bytes) => {
+	const head = encoder.encode(JSON.stringify(header));
+	const body = bytes instanceof ArrayBuffer ? new Uint8Array(bytes) : new Uint8Array(bytes.buffer, bytes.byteOffset, bytes.byteLength);
+	const frame = new Uint8Array(lengthBytes + head.length + body.length);
+	new DataView(frame.buffer).setUint32(0, head.length);
+	frame.set(head, lengthBytes);
+	frame.set(body, lengthBytes + head.length);
+	return frame.buffer;
+};
+/** The message a binary frame from the server carries, its bytes as its `payload`. */
+const decodeBinaryFrame = (frame) => {
+	const end = lengthBytes + new DataView(frame).getUint32(0);
+	return {
+		...JSON.parse(decoder.decode(new Uint8Array(frame, lengthBytes, end - lengthBytes))),
+		payload: frame.slice(end)
+	};
+};
+/** Whether a payload is bytes, sent as a binary frame. */
+const isBytes = (payload) => payload instanceof ArrayBuffer || ArrayBuffer.isView(payload);
+//#endregion
+export { decodeBinaryFrame, encodeBinaryFrame, isBytes };

package/dist/channel-connection.d.ts

@@ -2,7 +2,8 @@
 /** The part of the browser's `WebSocket` a connection uses, which a test hands its own of. */
 export type SocketLike = {
   readonly readyState: number;
-  send(data: string): void;
+  binaryType: string;
+  send(data: string | ArrayBuffer): void;
   close(code?: number): void;
   onopen: ((event: unknown) => void) | null;
   onmessage: ((event: {

package/dist/channel-connection.js

@@ -1,3 +1,4 @@
+import { decodeBinaryFrame, encodeBinaryFrame } from "./channel-binary-frame.js";
 import { ChannelRefusal } from "./channel-types.js";
 //#region src/channel-connection.ts
 /** How often the client pings, the server's `channelBounds.pingMs`; no pong in twice that drops the connection. */
@@ -38,6 +39,7 @@ const channelConnection = ({ url, token, socket: open, retryDelay, onOpen, onDow
 		sentToken = offered;
 		const current = open(url(), offered === void 0 ? [protocol] : [protocol, `bearer.${offered}`]);
 		socket = current;
+		current.binaryType = "arraybuffer";
 		current.onopen = () => {
 			failures = 0;
 			heardAt = Date.now();
@@ -50,8 +52,8 @@ const channelConnection = ({ url, token, socket: open, retryDelay, onOpen, onDow
 		};
 		current.onmessage = ({ data }) => {
 			heardAt = Date.now();
-			if (typeof data !== "string") return;
-			const message = JSON.parse(data);
+			if (typeof data !== "string" && !(data instanceof ArrayBuffer)) return;
+			const message = typeof data === "string" ? JSON.parse(data) : decodeBinaryFrame(data);
 			if (message.type !== "reply") return onMessage(message);
 			const waiting = pending.get(message.ref);
 			pending.delete(message.ref);
@@ -71,9 +73,9 @@ const channelConnection = ({ url, token, socket: open, retryDelay, onOpen, onDow
 			}, retryDelay(failures++));
 		};
 	};
-	const sendNow = (message) => {
+	const sendNow = (message, bytes) => {
 		if (socket?.readyState !== openState) return false;
-		socket.send(JSON.stringify(message));
+		socket.send(bytes === void 0 ? JSON.stringify(message) : encodeBinaryFrame(message, bytes));
 		return true;
 	};
 	return {
@@ -93,19 +95,19 @@ const channelConnection = ({ url, token, socket: open, retryDelay, onOpen, onDow
 			dropPending();
 			current?.close(1e3);
 		},
-		/** Sends a message with a ref, and resolves with its reply, or rejects with its refusal. */
-		request: (message) => new Promise((resolve, reject) => {
+		/** Sends a message with a ref, and bytes as its payload if any, and resolves with its reply, or rejects with its refusal. */
+		request: (message, bytes) => new Promise((resolve, reject) => {
 			const ref = String(++lastRef);
 			if (!sendNow({
 				...message,
 				ref
-			})) return reject(new ChannelRefusal("disconnected", "The connection is down"));
+			}, bytes)) return reject(new ChannelRefusal("disconnected", "The connection is down"));
 			pending.set(ref, {
 				resolve,
 				reject
 			});
 		}),
-		/** Sends a message that gets no reply; `false` when the socket is not open. */
+		/** Sends a message that gets no reply, and bytes as its payload if any; `false` when the socket is not open. */
 		post: sendNow
 	};
 };

package/dist/channel-types.d.ts

@@ -18,7 +18,7 @@ export type ChannelError = {
   code: string;
   message: string;
 };
-/** A broadcast as a channel hears it: with `server`, the app's own code sent it, and `user` is `null`. */
+/** A broadcast as a channel hears it, its payload JSON or, for bytes, an `ArrayBuffer`: with `server`, the app's own code sent it, and `user` is `null`. */
 export type ChannelMessage = {
   event: string;
   payload: unknown;

package/dist/channels.d.ts

@@ -14,8 +14,9 @@ export type Channel = {
   track: (state: unknown) => Promise<void>;
   untrack: () => Promise<void>;
   /**
-   * Broadcasts to the others on the channel; with `self` this connection hears it too. With `ack` it resolves once the
-   * server took it, or rejects with its `ChannelRefusal`; without, once it was sent.
+   * Broadcasts to the others on the channel: a JSON payload, or bytes in an `ArrayBuffer` or typed array, which the
+   * others hear as an `ArrayBuffer`. With `self` this connection hears it too. With `ack` it resolves once the server
+   * took it, or rejects with its `ChannelRefusal`; without, once it was sent.
    */
   send: (event: string, payload: unknown, options?: {
     self?: boolean;

package/dist/channels.js

@@ -1,3 +1,4 @@
+import { isBytes } from "./channel-binary-frame.js";
 import { ChannelRefusal } from "./channel-types.js";
 import { channelConnection } from "./channel-connection.js";
 import { encodeKey } from "@protobase/schema/internal";
@@ -145,21 +146,22 @@ const channelsClient = (options) => {
 			send: async (event, payload, { self, ack } = {}) => {
 				const name = joinedName();
 				if (name === void 0) throw notJoined();
+				const bytes = isBytes(payload) ? payload : void 0;
 				const message = {
 					type: "send",
 					channel: name,
 					event,
-					payload,
+					...bytes === void 0 && { payload },
 					...self && { self }
 				};
 				if (ack) {
 					await connection.request({
 						...message,
 						ack
-					});
+					}, bytes);
 					return;
 				}
-				if (!connection.post(message)) throw new ChannelRefusal("disconnected", "The connection is down");
+				if (!connection.post(message, bytes)) throw new ChannelRefusal("disconnected", "The connection is down");
 			},
 			on: (event, listener) => {
 				const listeners = channel.eventListeners.get(event) ?? /* @__PURE__ */ new Set();

package/dist/client.d.ts

@@ -112,6 +112,12 @@ export declare const createClient: (options?: ClientOptions) => {
     markRead: (id: string) => Promise<void>;
     markAllRead: (upTo: string) => Promise<void>;
   };
+  status: {
+    own: () => Promise<import("@protobase/schema/internal").PersonStatus | null>;
+    set: (status: import("@protobase/schema/internal").StatusInput) => Promise<import("@protobase/schema/internal").PersonStatus | null>;
+    clear: () => Promise<void>;
+    people: () => Promise<import("@protobase/schema/internal").PersonStatus[]>;
+  };
 };
 export type Client = ReturnType<typeof createClient>;
 //#endregion

package/dist/client.js

@@ -6,6 +6,7 @@ import { followLive } from "./live.js";
 import { sharedLive } from "./shared-live.js";
 import { channelsClient } from "./channels.js";
 import { devicesClient } from "./devices.js";
+import { statusClient } from "./status.js";
 import { notificationHistoryClient } from "./notification-history.js";
 import { encodeKey } from "@protobase/schema/internal";
 //#region src/client.ts
@@ -460,7 +461,8 @@ const createClient = (options = {}) => {
 		live,
 		channel,
 		devices: devicesClient(send),
-		notifications: notificationHistoryClient(send)
+		notifications: notificationHistoryClient(send),
+		status: statusClient(send)
 	};
 };
 //#endregion

package/dist/index.d.ts

@@ -9,6 +9,7 @@ import { UploadProgress } from "./upload-request.js";
 import { LiveChange, LiveHandlers } from "./live.js";
 import { Aggregate, AggregateGroup, AggregateParams, AggregateSplitTotal, BatchOp, BatchRef, BatchResult, CommentPage, CommentPerson, Facet, FormChallenge, FormProof, Histogram, HistogramBucket, HistoryChange, HistoryPage, ListPage, MapBounds, MapBucket, MapLayerModel, MapResult, MentionableUser, Meta, MetaResult, PluginRef, PublicForm, RecordComment, RecordOf, RecordPermissions, RecordPhotos, RelatedLabels, ResourcePermissions, ResourceRef, Series, SeriesParams, SeriesPoint, SourceRef, Stored, StoredFile, StoredFileVariant } from "./types.js";
 import { Client, InvokeOptions, UploadOptions, UploadResult, createClient } from "./client.js";
+import { Availability, PersonStatus, StatusClient, StatusInput } from "./status.js";
 import { ApiError, PreconditionFailedError, ProblemDetails, ProblemError, isApiError } from "./problem.js";
 import { fileUrl } from "./file-urls.js";
 import { routedClient } from "./routed-client.js";
@@ -27,4 +28,5 @@ import { AuthSession, AuthSessionOptions, createAuthSession, tokenExpiry } from
 import { createStaticSession } from "./static-session.js";
 import { AssistantClient, AssistantClientOptions, AssistantConnection, createAssistantClient } from "./assistant.js";
 import { RuntimeClient, RuntimeClientOptions, RuntimeLastUpdate, RuntimePolicy, RuntimeStatus, RuntimeUpdateStage, createRuntimeClient } from "./runtime.js";
-export { type AccountSecurity, type AccountSignIn, type ActiveRole, type Aggregate, type AggregateGroup, type AggregateParams, type AggregateSplitTotal, ApiError, type AppUser, type AssistantClient, type AssistantClientOptions, type AssistantConnection, AuthError, type AuthSession, type AuthSessionOptions, type AuthUser, type AuthenticatorSetup, type BatchOp, type BatchRef, type BatchResult, type Channel, type ChannelError, type ChannelMessage, ChannelRefusal, type ChannelStatus, type ChannelUser, type Client, type ClientOptions, type CommentPage, type CommentPerson, type ConnectClient, type ConnectedApp, type ConnectingClient, type CurrentOrganization, type DeviceSession, type DevicesClient, type Facet, type FilterInput, type FormChallenge, type FormProof, type Histogram, type HistogramBucket, type HistoryChange, type HistoryPage, type InboxNotification, type InboxPage, type InvitationPreview, type InvitationSent, type InvokeOptions, type ListPage, type ListParams, type LiveChange, type LiveHandlers, type MapBounds, type MapBucket, type MapLayerModel, type MapParams, type MapResult, type MentionableUser, type Meta, type MetaResult, type NotificationHistoryClient, type Organization, type OrganizationInvitation, type OrganizationMember, type OrganizationPerson, type OrganizationRole, type OrganizationsClient, type OrganizationsFound, type Passkey, type PlatformSignIn, type PluginRef, PreconditionFailedError, type PresenceChange, type PresenceEntry, type ProblemDetails, type ProblemError, type PublicForm, type RecordComment, type RecordOf, type RecordPermissions, type RecordPhotos, type RegisteredDevice, type RelatedLabels, type RequiredSetup, type ResourcePermissions, type ResourceRef, type RoleLabel, type RoleOption, type RolesClient, type RuntimeClient, type RuntimeClientOptions, type RuntimeLastUpdate, type RuntimePolicy, type RuntimeStatus, type RuntimeUpdateStage, type SamlSignIn, type Series, type SeriesParams, type SeriesPoint, type SetupStatus, type SignInMethod, type SignInPolicy, type SignInPolicyClient, type SignInPolicyState, type SignInResult, type SignInRule, type SocketLike, type SourceMeta, type SourceRef, type StaffAccessRule, type StaffSignIn, type StaffSignInClient, type Stored, type StoredFile, type StoredFileVariant, type TwoFactorMethod, type UploadOptions, type UploadProgress, type UploadResult, type UserInvitation, type UserInvitationSent, type UsersClient, type UsersFound, type WebDeviceRegistration, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, fileUrl, filterText, isApiError, listWire, routedClient, sourceMeta, tokenExpiry };
+import { availabilities, heldStatus, maxStatusText, statusTextProblem } from "@protobase/schema/internal";
+export { type AccountSecurity, type AccountSignIn, type ActiveRole, type Aggregate, type AggregateGroup, type AggregateParams, type AggregateSplitTotal, ApiError, type AppUser, type AssistantClient, type AssistantClientOptions, type AssistantConnection, AuthError, type AuthSession, type AuthSessionOptions, type AuthUser, type AuthenticatorSetup, type Availability, type BatchOp, type BatchRef, type BatchResult, type Channel, type ChannelError, type ChannelMessage, ChannelRefusal, type ChannelStatus, type ChannelUser, type Client, type ClientOptions, type CommentPage, type CommentPerson, type ConnectClient, type ConnectedApp, type ConnectingClient, type CurrentOrganization, type DeviceSession, type DevicesClient, type Facet, type FilterInput, type FormChallenge, type FormProof, type Histogram, type HistogramBucket, type HistoryChange, type HistoryPage, type InboxNotification, type InboxPage, type InvitationPreview, type InvitationSent, type InvokeOptions, type ListPage, type ListParams, type LiveChange, type LiveHandlers, type MapBounds, type MapBucket, type MapLayerModel, type MapParams, type MapResult, type MentionableUser, type Meta, type MetaResult, type NotificationHistoryClient, type Organization, type OrganizationInvitation, type OrganizationMember, type OrganizationPerson, type OrganizationRole, type OrganizationsClient, type OrganizationsFound, type Passkey, type PersonStatus, type PlatformSignIn, type PluginRef, PreconditionFailedError, type PresenceChange, type PresenceEntry, type ProblemDetails, type ProblemError, type PublicForm, type RecordComment, type RecordOf, type RecordPermissions, type RecordPhotos, type RegisteredDevice, type RelatedLabels, type RequiredSetup, type ResourcePermissions, type ResourceRef, type RoleLabel, type RoleOption, type RolesClient, type RuntimeClient, type RuntimeClientOptions, type RuntimeLastUpdate, type RuntimePolicy, type RuntimeStatus, type RuntimeUpdateStage, type SamlSignIn, type Series, type SeriesParams, type SeriesPoint, type SetupStatus, type SignInMethod, type SignInPolicy, type SignInPolicyClient, type SignInPolicyState, type SignInResult, type SignInRule, type SocketLike, type SourceMeta, type SourceRef, type StaffAccessRule, type StaffSignIn, type StaffSignInClient, type StatusClient, type StatusInput, type Stored, type StoredFile, type StoredFileVariant, type TwoFactorMethod, type UploadOptions, type UploadProgress, type UploadResult, type UserInvitation, type UserInvitationSent, type UsersClient, type UsersFound, type WebDeviceRegistration, availabilities, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, fileUrl, filterText, heldStatus, isApiError, listWire, maxStatusText, routedClient, sourceMeta, statusTextProblem, tokenExpiry };

package/dist/index.js

@@ -10,4 +10,5 @@ import { createAuthSession, tokenExpiry } from "./auth.js";
 import { createStaticSession } from "./static-session.js";
 import { createAssistantClient } from "./assistant.js";
 import { createRuntimeClient } from "./runtime.js";
-export { ApiError, AuthError, ChannelRefusal, PreconditionFailedError, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, fileUrl, filterText, isApiError, listWire, routedClient, sourceMeta, tokenExpiry };
+import { availabilities, heldStatus, maxStatusText, statusTextProblem } from "@protobase/schema/internal";
+export { ApiError, AuthError, ChannelRefusal, PreconditionFailedError, availabilities, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, fileUrl, filterText, heldStatus, isApiError, listWire, maxStatusText, routedClient, sourceMeta, statusTextProblem, tokenExpiry };

package/dist/routed-client.d.ts

@@ -3,7 +3,7 @@ import { Client } from "./client.js";
 /**
  * One client over the app's own API and the sources it draws resources from: a call about a resource goes to the API
  * that serves it (`sourceOf` gives a source's client, or `undefined` for the app's own), and `meta`, `invoke`, the
- * public forms, `live` and the user's devices and notifications go to the app's own. A batch goes to the one API all its writes are for; one that writes to two cannot be atomic, so it is
+ * public forms, `live` and the user's devices, notifications and status go to the app's own. A batch goes to the one API all its writes are for; one that writes to two cannot be atomic, so it is
  * refused before anything is sent.
  */
 export declare const routedClient: (own: Client, sourceOf: (resource: string) => Client | undefined) => Client;

package/dist/routed-client.js

@@ -3,7 +3,7 @@ const nameOf = (resource) => typeof resource === "string" ? resource : resource.
 /**
 * One client over the app's own API and the sources it draws resources from: a call about a resource goes to the API
 * that serves it (`sourceOf` gives a source's client, or `undefined` for the app's own), and `meta`, `invoke`, the
-* public forms, `live` and the user's devices and notifications go to the app's own. A batch goes to the one API all its writes are for; one that writes to two cannot be atomic, so it is
+* public forms, `live` and the user's devices, notifications and status go to the app's own. A batch goes to the one API all its writes are for; one that writes to two cannot be atomic, so it is
 * refused before anything is sent.
 */
 const routedClient = (own, sourceOf) => {
@@ -42,7 +42,8 @@ const routedClient = (own, sourceOf) => {
 		live: (handlers) => own.live(handlers),
 		channel: (resource, key) => own.channel(resource, key),
 		devices: own.devices,
-		notifications: own.notifications
+		notifications: own.notifications,
+		status: own.status
 	};
 };
 //#endregion

package/dist/status.d.ts

@@ -0,0 +1,19 @@
+import { Transport } from "./transport.js";
+import { Availability, PersonStatus, PersonStatus as PersonStatus$1, StatusInput, StatusInput as StatusInput$1 } from "@protobase/schema/internal";
+//#region src/status.d.ts
+/**
+ * People's own status (`/api/status`), in an app with `status: {}`: `own` the signed-in person's, `set` replaces it
+ * and answers it, `clear` removes it, and `people` the statuses of everyone who shares an organization with them, those
+ * without one left out. A status past its clear time is none. `set` rejects with an `ApiError` of slug
+ * `invalid-status-text` for a text with control characters or over `maxStatusText` characters, and
+ * `own-sign-in-only` for staff signed in as the person.
+ */
+export declare const statusClient: (send: Transport) => {
+  own: () => Promise<PersonStatus | null>;
+  set: (status: StatusInput) => Promise<PersonStatus | null>;
+  clear: () => Promise<void>;
+  people: () => Promise<PersonStatus[]>;
+};
+export type StatusClient = ReturnType<typeof statusClient>;
+//#endregion
+export type { Availability, PersonStatus$1 as PersonStatus, StatusInput$1 as StatusInput };

package/dist/status.js

@@ -0,0 +1,36 @@
+import { statusPath } from "@protobase/schema/internal";
+//#region src/status.ts
+/**
+* People's own status (`/api/status`), in an app with `status: {}`: `own` the signed-in person's, `set` replaces it
+* and answers it, `clear` removes it, and `people` the statuses of everyone who shares an organization with them, those
+* without one left out. A status past its clear time is none. `set` rejects with an `ApiError` of slug
+* `invalid-status-text` for a text with control characters or over `maxStatusText` characters, and
+* `own-sign-in-only` for staff signed in as the person.
+*/
+const statusClient = (send) => ({
+	own: async () => (await (await send({
+		method: "GET",
+		path: statusPath(""),
+		system: true
+	})).json()).status,
+	set: async (status) => (await (await send({
+		method: "PUT",
+		path: statusPath(""),
+		system: true,
+		body: status
+	})).json()).status,
+	clear: async () => {
+		await send({
+			method: "DELETE",
+			path: statusPath(""),
+			system: true
+		});
+	},
+	people: async () => (await (await send({
+		method: "GET",
+		path: statusPath("", "people"),
+		system: true
+	})).json()).statuses
+});
+//#endregion
+export { statusClient };

package/dist/types.d.ts

@@ -284,6 +284,7 @@ export type Meta = {
     bell?: true;
     webPushKey?: string;
   };
+  status?: true;
   locale?: 'en' | 'nl';
   files?: {
     trustedHosts: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/client",
-  "version": "0.59.1",
+  "version": "0.59.3",
   "description": "Typed fetch client for the Protobase REST API.",
   "license": "Apache-2.0",
   "repository": {
@@ -31,8 +31,8 @@
   },
   "dependencies": {
     "@better-auth/passkey": "^1.7.12",
-    "@protobase/layout": "0.59.1",
-    "@protobase/schema": "0.59.1",
+    "@protobase/layout": "0.59.3",
+    "@protobase/schema": "0.59.3",
     "@simplewebauthn/browser": "^13.3.0",
     "better-auth": "^1.7.12"
   }