@protobase/client 0.19.16 → 0.21.0

package/dist/client.d.ts

@@ -1,7 +1,7 @@
 import { FilterInput, ListParams, MapParams } from "./query-string.js";
 import { ClientOptions } from "./transport.js";
 import { UploadProgress } from "./upload-request.js";
-import { BatchOp, BatchResult, Facet, Histogram, ListPage, MapResult, MetaResult, RecordOf, ResourceRef, Series, SeriesParams, Stored } from "./types.js";
+import { Aggregate, AggregateParams, BatchOp, BatchResult, Facet, Histogram, HistoryPage, ListPage, MapResult, MetaResult, RecordOf, ResourceRef, Series, SeriesParams, Stored } from "./types.js";
 import { KeyValue } from "@protobase/schema";
 //#region src/client.d.ts
 /** How `invoke` calls a function: GET without a body, POST with one, unless `method` says otherwise. */
@@ -53,12 +53,17 @@ export declare const createClient: (options?: ClientOptions) => {
   }) => Promise<void>;
   undelete: <R extends ResourceRef>(resource: R, key: KeyValue | readonly KeyValue[]) => Promise<Stored<RecordOf<R>>>;
   reveal: (resource: ResourceRef, key: KeyValue | readonly KeyValue[], field: string) => Promise<unknown>;
+  history: (resource: ResourceRef, key: KeyValue | readonly KeyValue[], { pageSize, pageToken }?: {
+    pageSize?: number;
+    pageToken?: string;
+  }) => Promise<HistoryPage>;
   batchWrite: (ops: BatchOp[]) => Promise<BatchResult>;
   facets: (resource: ResourceRef, field: string, o?: {
     filter?: FilterInput;
     limit?: number;
     label?: string;
   }) => Promise<Facet[]>;
+  aggregate: (resource: ResourceRef, params: AggregateParams) => Promise<Aggregate>;
   series: (resource: ResourceRef, params: SeriesParams & {
     filter?: FilterInput;
   }) => Promise<Series>;

package/dist/client.js

@@ -123,6 +123,25 @@ const createClient = (options = {}) => {
 			body: { field }
 		})).json()).value;
 	};
+	/** A page of a record's changes, newest first, for a resource with `.history()`; `pageToken` is the previous page's `nextPageToken`. */
+	const history = async (resource, key, { pageSize, pageToken } = {}) => {
+		const query = queryString({
+			page_size: pageSize,
+			page_token: pageToken || void 0
+		});
+		const body = await (await send({
+			method: "GET",
+			path: `${keyPath(resource, key)}:history`,
+			query
+		})).json();
+		return {
+			items: body.items.map(({ database_role, ...change }) => ({
+				...change,
+				databaseRole: database_role
+			})),
+			nextPageToken: body.next_page_token
+		};
+	};
 	/** Applies several writes atomically (`POST /api/v1:batchWrite`), for example a record and its lines on Save. */
 	const batchWrite = async (ops) => {
 		const keyText = (key) => typeof key === "object" && key !== null && "$ref" in key ? key : encodeKey(key);
@@ -152,6 +171,32 @@ const createClient = (options = {}) => {
 			})
 		})).json()).facets;
 	};
+	/** Totals per value of a field, or per bucket of a date field (`:aggregate`). */
+	const aggregate = async (resource, params) => {
+		const body = await (await send({
+			method: "GET",
+			path: `/${nameOf(resource)}:aggregate`,
+			query: queryString({
+				group_by: params.groupBy,
+				filter: filterText(params.filter) || void 0,
+				sum: params.sum,
+				average: params.average,
+				limit: params.limit,
+				label: params.label,
+				granularity: params.granularity,
+				range: params.range,
+				from: params.from,
+				to: params.to,
+				time_zone: params.timeZone
+			})
+		})).json();
+		return {
+			groupBy: body.group_by,
+			granularity: body.granularity,
+			timeZone: body.time_zone,
+			groups: body.groups
+		};
+	};
 	const series = async (resource, params) => {
 		const body = await (await send({
 			method: "GET",
@@ -287,8 +332,10 @@ const createClient = (options = {}) => {
 		remove,
 		undelete,
 		reveal,
+		history,
 		batchWrite,
 		facets,
+		aggregate,
 		series,
 		histogram,
 		map,

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { FilterInput, ListParams, MapParams, filterText, listWire } from "./query-string.js";
 import { ClientOptions } from "./transport.js";
 import { UploadProgress } from "./upload-request.js";
-import { BatchOp, BatchRef, BatchResult, Facet, Histogram, HistogramBucket, ListPage, MapBounds, MapBucket, MapLayerModel, MapResult, Meta, MetaResult, PluginRef, RecordOf, RecordPermissions, RecordPhotos, RelatedLabels, ResourcePermissions, ResourceRef, Series, SeriesParams, SeriesPoint, SourceRef, Stored, StoredFile, StoredFileVariant } from "./types.js";
+import { Aggregate, AggregateGroup, AggregateParams, BatchOp, BatchRef, BatchResult, Facet, Histogram, HistogramBucket, HistoryChange, HistoryPage, ListPage, MapBounds, MapBucket, MapLayerModel, MapResult, Meta, MetaResult, PluginRef, 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 { ApiError, PreconditionFailedError, ProblemDetails, ProblemError, isApiError } from "./problem.js";
 import { fileUrl } from "./file-urls.js";
@@ -18,4 +18,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, ApiError, 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 CurrentOrganization, type Facet, type FilterInput, type Histogram, type HistogramBucket, type InvitationPreview, type InvitationSent, type InvokeOptions, type ListPage, type ListParams, type MapBounds, type MapBucket, type MapLayerModel, type MapParams, type MapResult, type Meta, type MetaResult, type Organization, type OrganizationInvitation, type OrganizationMember, type OrganizationRole, type OrganizationsClient, type Passkey, type PlatformSignIn, type PluginRef, PreconditionFailedError, type ProblemDetails, type ProblemError, 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 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, 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, ApiError, 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 CurrentOrganization, type Facet, type FilterInput, type Histogram, type HistogramBucket, type HistoryChange, type HistoryPage, type InvitationPreview, type InvitationSent, type InvokeOptions, type ListPage, type ListParams, type MapBounds, type MapBucket, type MapLayerModel, type MapParams, type MapResult, type Meta, type MetaResult, type Organization, type OrganizationInvitation, type OrganizationMember, type OrganizationRole, type OrganizationsClient, type Passkey, type PlatformSignIn, type PluginRef, PreconditionFailedError, type ProblemDetails, type ProblemError, 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 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, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, fileUrl, filterText, isApiError, listWire, routedClient, sourceMeta, tokenExpiry };

package/dist/routed-client.js

@@ -17,12 +17,14 @@ const routedClient = (own, sourceOf) => {
 		remove: (resource, key, options) => to(resource).remove(resource, key, options),
 		undelete: (resource, key) => to(resource).undelete(resource, key),
 		reveal: (resource, key, field) => to(resource).reveal(resource, key, field),
+		history: (resource, key, options) => to(resource).history(resource, key, options),
 		batchWrite: (ops) => {
 			const apis = [...new Set(ops.map((op) => to(op.resource)))];
 			if (apis.length > 1) return Promise.reject(/* @__PURE__ */ new Error(`A batch writes to one API, but these writes are for ${[...new Set(ops.map((op) => nameOf(op.resource)))].join(", ")}, which different APIs serve`));
 			return (apis[0] ?? own).batchWrite(ops);
 		},
 		facets: (resource, field, options) => to(resource).facets(resource, field, options),
+		aggregate: (resource, params) => to(resource).aggregate(resource, params),
 		series: (resource, params) => to(resource).series(resource, params),
 		histogram: (resource, field, options) => to(resource).histogram(resource, field, options),
 		map: (resource, params) => to(resource).map(resource, params),

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import { FilterInput } from "./query-string.js";
 import { BottomBarModel, InferRecord, ResourceModel, SignInViewModel, UserMenuModel, ViewModel } from "@protobase/schema";
 import { PageModel } from "@protobase/layout";
 //#region src/types.d.ts
@@ -14,6 +15,31 @@ export type RecordOf<R extends ResourceRef> = R extends {
 export type RelatedLabels = Record<string, Record<string, string>>;
 /** Per record, by key as text, the files of its first photos in their order; a record without any is absent. */
 export type RecordPhotos = Record<string, StoredFile[]>;
+/** One change of a record, as `history` reads it: only the fields the caller may read. */
+export type HistoryChange = {
+  id: string;
+  /** When its transaction started, ISO 8601. */
+  at: string;
+  operation: 'create' | 'update' | 'delete' | 'undelete';
+  /** The fields an update changed, sensitive ones included; none for a create or delete. */
+  changed: string[];
+  /** The fields before and after, without sensitive and file fields; none before a create, or after a delete. */
+  before?: Record<string, unknown>;
+  after?: Record<string, unknown>;
+  /** Who made it through the API, with their name when the server knows it; `null` for a write from elsewhere. */
+  actor: {
+    id: string;
+    name?: string;
+  } | null;
+  /** The database role that wrote; `null` when unknown. */
+  databaseRole: string | null;
+};
+/** A page of a record's history, newest first. */
+export type HistoryPage = {
+  items: HistoryChange[];
+  /** `""` on the last page. */
+  nextPageToken: string;
+};
 export type ListPage<T> = {
   items: T[];
   /** `""` on the last page. */
@@ -54,6 +80,39 @@ export type SeriesParams = {
   granularity?: 'hour' | 'day' | 'week' | 'month';
   timeZone?: string;
 };
+export type AggregateParams = {
+  /** A filterable field: its values make the groups, or for a date or timestamp field its buckets. */
+  groupBy: string;
+  filter?: FilterInput;
+  /** A numeric field to add up per group. */
+  sum?: string;
+  /** A numeric field to average per group, instead of `sum`. */
+  average?: string;
+  /** Value groups only: the most to return, default 100. */
+  limit?: number;
+  /** Value groups only: for a relation, the field of the related record that names each group. */
+  label?: string;
+  /** Date groups only. */
+  granularity?: 'hour' | 'day' | 'week' | 'month' | 'year';
+  range?: '7d' | '30d' | '90d' | '1y' | 'all';
+  from?: string;
+  to?: string;
+  timeZone?: string;
+};
+/** One group: its value (a date group's bucket in local ISO time), how many records it holds and its sum or average. */
+export type AggregateGroup = {
+  value: string | number | boolean | null;
+  label?: string;
+  count: number;
+  sum?: number | null;
+  average?: number | null;
+};
+export type Aggregate = {
+  groupBy: string;
+  granularity?: string;
+  timeZone?: string;
+  groups: AggregateGroup[];
+};
 export type HistogramBucket = {
   from: number;
   to: number;

package/package.json

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