@protobase/client 0.45.19 → 0.45.21

package/dist/client.d.ts

@@ -1,5 +1,7 @@
-import { FilterInput, ListParams, MapParams } from "./query-string.js";
 import { ClientOptions } from "./transport.js";
+import { RegisteredDevice, WebDeviceRegistration } from "./devices.js";
+import { InboxPage } from "./notification-history.js";
+import { FilterInput, ListParams, MapParams } from "./query-string.js";
 import { UploadProgress } from "./upload-request.js";
 import { LiveHandlers } from "./live.js";
 import { Aggregate, AggregateParams, BatchOp, BatchResult, CommentPage, Facet, FormChallenge, FormProof, Histogram, HistoryPage, ListPage, MapResult, MentionableUser, MetaResult, PublicForm, RecordComment, RecordOf, ResourceRef, Series, SeriesParams, Stored } from "./types.js";
@@ -95,6 +97,19 @@ export declare const createClient: (options?: ClientOptions) => {
   formChallenge: (name: string) => Promise<FormChallenge>;
   submitForm: (name: string, values: Record<string, unknown>, proof: FormProof) => Promise<void>;
   live: (handlers: LiveHandlers) => () => void;
+  devices: {
+    register: (device: WebDeviceRegistration) => Promise<RegisteredDevice>;
+    remove: (id: string) => Promise<void>;
+  };
+  notifications: {
+    list: ({ cursor, limit }?: {
+      cursor?: string;
+      limit?: number;
+    }) => Promise<InboxPage>;
+    unread: () => Promise<number>;
+    markRead: (id: string) => Promise<void>;
+    markAllRead: (upTo: string) => Promise<void>;
+  };
 };
 export type Client = ReturnType<typeof createClient>;
 //#endregion

package/dist/client.js

@@ -3,6 +3,8 @@ import { originOf, photosWithOrigin, withFileOrigin } from "./file-urls.js";
 import { createTransport } from "./transport.js";
 import { fetchWithProgress } from "./upload-request.js";
 import { followLive } from "./live.js";
+import { devicesClient } from "./devices.js";
+import { notificationHistoryClient } from "./notification-history.js";
 import { encodeKey } from "@protobase/schema/internal";
 //#region src/client.ts
 const nameOf = (resource) => typeof resource === "string" ? resource : resource.toModel().name;
@@ -438,7 +440,9 @@ const createClient = (options = {}) => {
 		form,
 		formChallenge,
 		submitForm,
-		live
+		live,
+		devices: devicesClient(send),
+		notifications: notificationHistoryClient(send)
 	};
 };
 //#endregion

package/dist/devices.d.ts

@@ -0,0 +1,34 @@
+import { Transport } from "./transport.js";
+//#region src/devices.d.ts
+/**
+ * A browser's push subscription as it registers it: its endpoint and keys, what it is, and the user whose click
+ * started the registration, which the server refuses with a 409 when someone else is signed in by then.
+ */
+export type WebDeviceRegistration = {
+  kind: 'web';
+  endpoint: string;
+  keys: {
+    p256dh: string;
+    auth: string;
+  };
+  userAgent?: string;
+  userId?: string;
+};
+/** A device as the server answers it: never its token or keys. */
+export type RegisteredDevice = {
+  id: string;
+  kind: 'web' | 'apns' | 'fcm';
+  createdAt: string;
+  lastSeenAt: string;
+};
+/**
+ * The signed-in user's own devices (`/api/notifications/devices`): `register` adds or refreshes the device the request
+ * comes from, and rejects with an `ApiError` of slug `device-held` when another user holds the browser's endpoint, or
+ * `other-user` when the user it names is not the one signed in; `remove` removes one by its id.
+ */
+export declare const devicesClient: (send: Transport) => {
+  register: (device: WebDeviceRegistration) => Promise<RegisteredDevice>;
+  remove: (id: string) => Promise<void>;
+};
+export type DevicesClient = ReturnType<typeof devicesClient>;
+//#endregion

package/dist/devices.js

@@ -0,0 +1,24 @@
+import { devicesPath } from "@protobase/schema/internal";
+//#region src/devices.ts
+/**
+* The signed-in user's own devices (`/api/notifications/devices`): `register` adds or refreshes the device the request
+* comes from, and rejects with an `ApiError` of slug `device-held` when another user holds the browser's endpoint, or
+* `other-user` when the user it names is not the one signed in; `remove` removes one by its id.
+*/
+const devicesClient = (send) => ({
+	register: async (device) => (await send({
+		method: "POST",
+		path: devicesPath(""),
+		system: true,
+		body: device
+	})).json(),
+	remove: async (id) => {
+		await send({
+			method: "DELETE",
+			path: devicesPath("", id),
+			system: true
+		});
+	}
+});
+//#endregion
+export { devicesClient };

package/dist/index.d.ts

@@ -1,5 +1,7 @@
-import { FilterInput, ListParams, MapParams, filterText, listWire } from "./query-string.js";
 import { ClientOptions } from "./transport.js";
+import { DevicesClient, RegisteredDevice, WebDeviceRegistration } from "./devices.js";
+import { InboxNotification, InboxPage, NotificationHistoryClient } from "./notification-history.js";
+import { FilterInput, ListParams, MapParams, filterText, listWire } from "./query-string.js";
 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";
@@ -21,4 +23,4 @@ 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 Client, type ClientOptions, type CommentPage, type CommentPerson, type ConnectClient, type ConnectedApp, type ConnectingClient, type CurrentOrganization, type Facet, type FilterInput, type FormChallenge, type FormProof, type Histogram, type HistogramBucket, type HistoryChange, type HistoryPage, 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 Organization, type OrganizationInvitation, type OrganizationMember, type OrganizationRole, type OrganizationsClient, type OrganizationsFound, type Passkey, type PlatformSignIn, type PluginRef, PreconditionFailedError, type ProblemDetails, type ProblemError, type PublicForm, type RecordComment, type RecordOf, type RecordPermissions, type RecordPhotos, 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 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, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, fileUrl, filterText, isApiError, listWire, routedClient, sourceMeta, tokenExpiry };
+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 Client, type ClientOptions, type CommentPage, type CommentPerson, type ConnectClient, type ConnectedApp, type ConnectingClient, type CurrentOrganization, 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 OrganizationRole, type OrganizationsClient, type OrganizationsFound, type Passkey, type PlatformSignIn, type PluginRef, PreconditionFailedError, 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 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 };

package/dist/notification-history.d.ts

@@ -0,0 +1,36 @@
+import { Transport } from "./transport.js";
+//#region src/notification-history.d.ts
+/**
+ * One of the signed-in user's inbox notifications, as the server answers it: `title` and `body` are plain text, `url` a
+ * path on the app or an absolute URL on one of its origins, or `null`; `readAt` is `null` while it is unread.
+ */
+export type InboxNotification = {
+  id: string;
+  title: string;
+  body: string | null;
+  url: string | null;
+  data: Record<string, unknown> | null;
+  createdAt: string;
+  readAt: string | null;
+};
+/** A page of the history, newest first; `next` is the cursor of the page after it, `null` on the last one. */
+export type InboxPage = {
+  items: InboxNotification[];
+  next: string | null;
+};
+/**
+ * The signed-in user's own notification history (`/api/notifications/history`): `list` a page of it, `unread` how many
+ * are unread (at most 100), `markRead` one of them by its id, and `markAllRead` those created up to `upTo`, the
+ * `createdAt` of the newest one the user was shown.
+ */
+export declare const notificationHistoryClient: (send: Transport) => {
+  list: ({ cursor, limit }?: {
+    cursor?: string;
+    limit?: number;
+  }) => Promise<InboxPage>;
+  unread: () => Promise<number>;
+  markRead: (id: string) => Promise<void>;
+  markAllRead: (upTo: string) => Promise<void>;
+};
+export type NotificationHistoryClient = ReturnType<typeof notificationHistoryClient>;
+//#endregion

package/dist/notification-history.js

@@ -0,0 +1,45 @@
+import { historyPath } from "@protobase/schema/internal";
+//#region src/notification-history.ts
+/**
+* The signed-in user's own notification history (`/api/notifications/history`): `list` a page of it, `unread` how many
+* are unread (at most 100), `markRead` one of them by its id, and `markAllRead` those created up to `upTo`, the
+* `createdAt` of the newest one the user was shown.
+*/
+const notificationHistoryClient = (send) => ({
+	list: async ({ cursor, limit } = {}) => {
+		const params = new URLSearchParams({
+			...cursor !== void 0 && { cursor },
+			...limit !== void 0 && { limit: String(limit) }
+		});
+		const query = params.size > 0 ? `?${params}` : "";
+		return (await send({
+			method: "GET",
+			path: historyPath(""),
+			query,
+			system: true
+		})).json();
+	},
+	unread: async () => (await (await send({
+		method: "GET",
+		path: historyPath("", "unread"),
+		system: true
+	})).json()).count,
+	markRead: async (id) => {
+		await send({
+			method: "POST",
+			path: historyPath("", { read: id }),
+			body: {},
+			system: true
+		});
+	},
+	markAllRead: async (upTo) => {
+		await send({
+			method: "POST",
+			path: historyPath("", "read"),
+			body: { upTo },
+			system: true
+		});
+	}
+});
+//#endregion
+export { notificationHistoryClient };

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 and `live` 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 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
  * 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 and `live` 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 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
 * refused before anything is sent.
 */
 const routedClient = (own, sourceOf) => {
@@ -39,7 +39,9 @@ const routedClient = (own, sourceOf) => {
 		form: (name) => own.form(name),
 		formChallenge: (name) => own.formChallenge(name),
 		submitForm: (name, values, proof) => own.submitForm(name, values, proof),
-		live: (handlers) => own.live(handlers)
+		live: (handlers) => own.live(handlers),
+		devices: own.devices,
+		notifications: own.notifications
 	};
 };
 //#endregion

package/dist/transport.d.ts

@@ -16,4 +16,22 @@ export type ClientOptions = {
   /** Called when a request is still 401 after the retry: the session is over. */
   onUnauthenticated?: () => void;
 };
+export type Request = {
+  method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+  path: string;
+  query?: string;
+  body?: unknown;
+  headers?: Record<string, string>;
+  /** Statuses other than 2xx that are an answer rather than an error. */
+  accept?: number[];
+  /** A system endpoint such as `/meta`: it lives beside the API (`/api/meta`), not inside it (`/api/v1`). */
+  system?: boolean;
+  /** Sent as it is instead of a JSON `body`, such as a file. */
+  raw?: Blob;
+  /** Sends this request instead of the client's fetch, such as one that reports upload progress. */
+  via?: typeof fetch;
+  signal?: AbortSignal;
+};
+export declare const createTransport: (options?: ClientOptions) => ({ method, path, query, body, headers, accept, system, raw, via, signal }: Request) => Promise<Response>;
+export type Transport = ReturnType<typeof createTransport>;
 //#endregion

package/dist/types.d.ts

@@ -280,7 +280,8 @@ export type Meta = {
     layers?: MapLayerModel[];
   };
   notifications?: {
-    webPushKey: string;
+    bell?: true;
+    webPushKey?: string;
   };
   locale?: 'en' | 'nl';
   files?: {

package/package.json

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