@protobase/client 0.14.0 → 0.14.2

package/dist/client.d.ts

@@ -57,6 +57,7 @@ export declare const createClient: (options?: ClientOptions) => {
   facets: (resource: ResourceRef, field: string, o?: {
     filter?: FilterInput;
     limit?: number;
+    label?: string;
   }) => Promise<Facet[]>;
   series: (resource: ResourceRef, params: SeriesParams & {
     filter?: FilterInput;

package/dist/client.js

@@ -1,5 +1,5 @@
-import { filterText, listWire, queryString } from "./query-string.js";
-import { originOf, withFileOrigin } from "./file-urls.js";
+import { filterText, labelEntries, listWire, photosWire, queryString } from "./query-string.js";
+import { originOf, photosWithOrigin, withFileOrigin } from "./file-urls.js";
 import { createTransport } from "./transport.js";
 import { fetchWithProgress } from "./upload-request.js";
 import { encodeKey } from "@protobase/schema/internal";
@@ -12,6 +12,8 @@ const toPage = (body, response, origin) => ({
 	totalSizeEstimate: body.total_size_estimate,
 	...body.prev_page_token !== void 0 && { prevPageToken: body.prev_page_token },
 	...body.total_size !== void 0 && { totalSize: body.total_size },
+	...body.labels !== void 0 && { labels: body.labels },
+	...body.photos !== void 0 && { photos: photosWithOrigin(body.photos, origin) },
 	...response.headers.get("x-protobase-warning") && { warning: response.headers.get("x-protobase-warning") }
 });
 const etagOf = (response) => response.headers.get("etag") ?? "";
@@ -61,7 +63,8 @@ const createClient = (options = {}) => {
 			path: `/${nameOf(resource)}:search`,
 			body: {
 				...wire,
-				fields: params?.fields
+				fields: params?.fields,
+				labels: labelEntries(params?.labels)
 			}
 		});
 		return toPage(await response.json(), response, origin);
@@ -136,6 +139,7 @@ const createClient = (options = {}) => {
 		});
 		return batchResultOf(await response.json(), origin);
 	};
+	/** `label` names a relation's values by that field of the records they point at, as a list's `labels` does. */
 	const facets = async (resource, field, o = {}) => {
 		return (await (await send({
 			method: "GET",
@@ -143,7 +147,8 @@ const createClient = (options = {}) => {
 			query: queryString({
 				field,
 				filter: filterText(o.filter) || void 0,
-				limit: o.limit
+				limit: o.limit,
+				label: o.label
 			})
 		})).json()).facets;
 	};
@@ -193,13 +198,17 @@ const createClient = (options = {}) => {
 				zoom: params.zoom,
 				filter: filterText(params.filter) || void 0,
 				order_by: params.orderBy,
-				fields: params.fields?.join(",")
+				fields: params.fields?.join(","),
+				labels: labelEntries(params.labels)?.join(","),
+				...photosWire(params.photos)
 			})
 		})).json();
 		return {
 			items: body.items.map((item) => withFileOrigin(item, origin)),
 			buckets: body.buckets,
-			totalSize: body.total_size
+			totalSize: body.total_size,
+			...body.labels !== void 0 && { labels: body.labels },
+			...body.photos !== void 0 && { photos: photosWithOrigin(body.photos, origin) }
 		};
 	};
 	/** The page that starts at row `position` of a sort (scrollbar jumps), with the tokens of its own neighbours. Past the end it is empty. */

package/dist/file-urls.js

@@ -24,6 +24,8 @@ const withFileOrigin = (record, origin) => {
 	if (origin === void 0 || typeof record !== "object" || record === null) return record;
 	return Object.fromEntries(Object.entries(record).map(([name, value]) => [name, isFileAtPath(value) ? fromOrigin(value, origin) : value]));
 };
+/** Each record's photos, by key, every file downloading from `origin`, as `withFileOrigin` makes a record's. */
+const photosWithOrigin = (photos, origin) => origin === void 0 ? photos : Object.fromEntries(Object.entries(photos).map(([key, files]) => [key, files.map((file) => isFileAtPath(file) ? fromOrigin(file, origin) : file)]));
 /**
 * The link of a stored file, or of its variant by that name when it has one (`fileUrl(listing.photo, 'card')`); the
 * file's own link otherwise, and `undefined` for a missing file or one without a link.
@@ -33,4 +35,4 @@ const fileUrl = (file, variant) => {
 	return (variant === void 0 ? void 0 : file.variants?.[variant]?.url) ?? file.url;
 };
 //#endregion
-export { fileUrl, originOf, withFileOrigin };
+export { fileUrl, originOf, photosWithOrigin, withFileOrigin };

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, MapResult, Meta, MetaResult, PluginRef, RecordOf, RecordPermissions, ResourcePermissions, ResourceRef, Series, SeriesParams, SeriesPoint, SourceRef, Stored, StoredFile, StoredFileVariant } from "./types.js";
+import { BatchOp, BatchRef, BatchResult, Facet, Histogram, HistogramBucket, ListPage, MapBounds, MapBucket, 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, RuntimePolicy, RuntimeStatus, 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 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 RequiredSetup, type ResourcePermissions, type ResourceRef, type RoleLabel, type RoleOption, type RolesClient, type RuntimeClient, type RuntimeClientOptions, type RuntimePolicy, type RuntimeStatus, 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, 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 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 RuntimePolicy, type RuntimeStatus, 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/query-string.d.ts

@@ -1,4 +1,4 @@
-import { FilterExpr } from "@protobase/schema";
+import { CardPhotosModel, FilterExpr } from "@protobase/schema";
 //#region src/query-string.d.ts
 export type FilterInput = string | FilterExpr;
 export type ListParams = {
@@ -8,6 +8,17 @@ export type ListParams = {
   pageSize?: number;
   pageToken?: string;
   fields?: string[];
+  /**
+   * Names the records relations point at, in the same answer: `{ place_id: 'name' }` gives each place's `name` in the
+   * page's `labels`. A record the caller cannot list, or whose field they cannot read, has no name there.
+   */
+  labels?: Record<string, string>;
+  /**
+   * Brings each record's first photos in the same answer, as a cards display's `photos` names them: the `image` of the
+   * records of `resource` whose relation `field` points at it, in `sort` order, at most ten. The caller gets those they
+   * could list themselves.
+   */
+  photos?: CardPhotosModel;
   count?: 'exact';
 };
 /** What `map` asks for: the fields of the position, the map's zoom, and the bounding box in `filter`. */
@@ -18,15 +29,22 @@ export type MapParams = {
   filter?: FilterInput;
   orderBy?: string;
   fields?: string[];
+  /** As a list's `labels`. */
+  labels?: Record<string, string>;
+  /** As a list's `photos`. */
+  photos?: CardPhotosModel;
 };
 export declare const filterText: (filter: FilterInput | undefined) => string | undefined;
 /** The snake_case parameters of `GET /{resource}` and the body of `POST /{resource}:search`. */
 export declare const listWire: (params?: ListParams) => {
+  count: "exact" | undefined;
+  photos: string | undefined;
+  photos_order_by: string | undefined;
   filter: string | undefined;
   order_by: string | undefined;
   page_size: number | undefined;
   page_token: string | undefined;
   fields: string | undefined;
-  count: "exact" | undefined;
+  labels: string | undefined;
 };
 //#endregion

package/dist/query-string.js

@@ -1,6 +1,16 @@
 import { printFilter } from "@protobase/schema";
 //#region src/query-string.ts
 const filterText = (filter) => typeof filter === "string" ? filter : filter && printFilter(filter);
+/** `labels` as the API takes it: `relation.field` entries. */
+const labelEntries = (labels) => {
+	const entries = Object.entries(labels ?? {}).map(([relation, field]) => `${relation}.${field}`);
+	return entries.length > 0 ? entries : void 0;
+};
+/** `photos` as the API takes it: a `resource.field.image` entry and the order of the photos. */
+const photosWire = (photos) => ({
+	photos: photos && `${photos.resource}.${photos.field}.${photos.image}`,
+	photos_order_by: photos?.sort
+});
 /** The snake_case parameters of `GET /{resource}` and the body of `POST /{resource}:search`. */
 const listWire = (params = {}) => ({
 	filter: filterText(params.filter) || void 0,
@@ -8,6 +18,8 @@ const listWire = (params = {}) => ({
 	page_size: params.pageSize,
 	page_token: params.pageToken || void 0,
 	fields: params.fields?.join(","),
+	labels: labelEntries(params.labels)?.join(","),
+	...photosWire(params.photos),
 	count: params.count
 });
 const queryString = (wire) => {
@@ -17,4 +29,4 @@ const queryString = (wire) => {
 	return text ? `?${text}` : "";
 };
 //#endregion
-export { filterText, listWire, queryString };
+export { filterText, labelEntries, listWire, photosWire, queryString };

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { BottomBarModel, InferRecord, ResourceModel, UserMenuModel, ViewModel } from "@protobase/schema";
+import { BottomBarModel, InferRecord, ResourceModel, SignInViewModel, UserMenuModel, ViewModel } from "@protobase/schema";
 import { PageModel } from "@protobase/layout";
 //#region src/types.d.ts
 /** A resource by name, or the builder from `resource(...)`, which carries its record type. */
@@ -10,6 +10,10 @@ export type ResourceRef = string | {
 export type RecordOf<R extends ResourceRef> = R extends {
   readonly $fields: unknown;
 } ? InferRecord<R> : Record<string, unknown>;
+/** Per relation, the names of the records it points at, by key as text; a record without one is absent. */
+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[]>;
 export type ListPage<T> = {
   items: T[];
   /** `""` on the last page. */
@@ -19,12 +23,18 @@ export type ListPage<T> = {
   totalSizeEstimate: number;
   /** Only with `count: 'exact'`. */
   totalSize?: number;
+  /** Only with `labels`: per relation, the names of the records it points at, by key as text. */
+  labels?: RelatedLabels;
+  /** Only with `photos`: each record's first photos, by key as text. */
+  photos?: RecordPhotos;
   /** `X-Protobase-Warning`, for example a scan-guard notice. */
   warning?: string;
 };
+/** `label`: with the `label` option, the name of the record a relation's value points at, when the caller may read it. */
 export type Facet = {
   value: string | number | boolean | null;
   count: number;
+  label?: string;
 };
 export type SeriesPoint = {
   bucket: string;
@@ -73,6 +83,8 @@ export type MapResult<T> = {
   items: T[];
   buckets: MapBucket[];
   totalSize: number;
+  labels?: RelatedLabels;
+  photos?: RecordPhotos;
 };
 /** What the signed-in user may do with a resource; `conditional` operations are decided per record by the server. */
 export type ResourcePermissions = {
@@ -85,6 +97,7 @@ export type ResourcePermissions = {
 /**
  * `assistant`: the assistant backend, for a caller with the `admin` or `ai` role when the app has one.
  * `runtime`: the runtime updates endpoint, for a caller with the `admin` role when the app has one.
+ * `signIn`: for a visitor who is not signed in, the resources they could use once signed in, with what to tell them.
  * `bottomBar`: the tabs on phones, of the bottom bar that names the caller's active role.
  * `plugins`: the plugins the admin app loads for the caller, each by its plugin.json.
  * `sources`: the other APIs whose resources the admin app draws for the caller.
@@ -95,6 +108,7 @@ export type Meta = {
   pages?: PageModel[];
   permissions?: Record<string, ResourcePermissions>;
   userMenu?: UserMenuModel;
+  signIn?: SignInViewModel[];
   bottomBar?: Omit<BottomBarModel, 'roles'>;
   assistant?: {
     url: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/client",
-  "version": "0.14.0",
+  "version": "0.14.2",
   "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.14.0",
-    "@protobase/schema": "0.14.0",
+    "@protobase/layout": "0.14.2",
+    "@protobase/schema": "0.14.2",
     "@simplewebauthn/browser": "^13.3.0",
     "better-auth": "^1.7.7"
   }