@rebasepro/common 0.28.2 → 0.29.0

package/dist/data/buildRebaseData.d.ts

@@ -1,13 +1,9 @@
 import { DataDriver, RebaseData, RebaseSdkData } from "@rebasepro/types";
 /**
- * Derive the response key an aggregate comes back under.
- *
- * `sum(total)` → `sum_total`, `count()` → `count`. Written once, here, because
- * the REST parser derives the same alias from `?select=sum(total)` and the two
- * have to agree — a caller reading `row.sum_total` off an SDK result and off an
- * HTTP response is reading the same key or the SDK is broken.
+ * The key an aggregate comes back under — `@rebasepro/types`' derivation,
+ * which the REST parser and the HTTP client use too.
  */
-export declare function aggregateAlias(fn: string, field?: string): string;
+export { aggregateAlias } from "@rebasepro/types";
 export interface EntityDataOptions {
     /**
      * Look up a collection's config by slug, to derive row addresses from its
@@ -45,6 +41,18 @@ export interface EntityDataOptions {
      */
     resolveAccessor?: (property: string) => string;
 }
+/**
+ * A row as the server sends it, in the admin's view model of its collection:
+ * the `values` `buildRebaseData` and `wrapAsEntityData` give an `Entity` of
+ * that collection — a date as a `Date`, a relation as an `EntityRelation`,
+ * also under its property's key where the row carries only the foreign key —
+ * and a `reference` property's id as an `EntityReference`. A collection the
+ * resolver does not know leaves the row as it is.
+ *
+ * For code that holds a flat row and hands it to what expects the admin's
+ * values, such as a collection's `browserCallbacks` or a preview.
+ */
+export declare function rowToViewModel(row: Record<string, unknown>, slug: string, resolveCollection: NonNullable<EntityDataOptions["resolveCollection"]>): Record<string, unknown>;
 export declare function buildRebaseData(driver: DataDriver, options?: EntityDataOptions): RebaseData;
 /**
  * Wrap a flat {@link RebaseSdkData} into a Entity-shaped {@link RebaseData}.

package/dist/data/buildRebaseData.es.js

@@ -1,5 +1,5 @@
 import { buildCompositeId, resolvePrimaryKeys } from "../util/identity.es.js";
-import { resolveCollectionRelations } from "../util/relations.es.js";
+import { fieldKeyForColumn, resolveCollectionRelations } from "../util/relations.es.js";
 import { cursorToStartAfter, decodeCursor, reconcileCursorOrder } from "./cursor.es.js";
 import { normalizeOrderBy } from "./sort-dialect.es.js";
 import { mergeIncludeSpecs } from "./include-spec.es.js";
@@ -7,7 +7,7 @@ import { etagOf } from "./row-etag.es.js";
 import { QueryBuilder } from "./query_builder.es.js";
 import { collectAllPages, paginateFind, resolveFindWindow } from "./paginate.es.js";
 import { deserializeFilter } from "./filter-dialect.es.js";
-import { DEFAULT_VECTOR_LIST_LIMIT, EntityRelation, RebaseApiError, RebaseClientError, isUnsupported, sortKeyToString, unsupportedMethod } from "@rebasepro/types";
+import { DEFAULT_VECTOR_LIST_LIMIT, EntityReference, EntityRelation, RebaseApiError, RebaseClientError, aggregateAlias, isUnsupported, sortKeyToString, toDriverAggregate, toDriverAggregateGroup, unsupportedMethod } from "@rebasepro/types";
 import { toSnakeCase, toWireKey } from "@rebasepro/utils";
 //#region src/data/buildRebaseData.ts
 /**
@@ -20,25 +20,6 @@ var noRealtime = (slug) => `Realtime is not available for "${slug}": its data so
 /** What a client says when its data source cannot count. */
 var noCount = (slug) => `Counting is not available for "${slug}": its data source does not support it.`;
 /**
-* Derive the response key an aggregate comes back under.
-*
-* `sum(total)` → `sum_total`, `count()` → `count`. Written once, here, because
-* the REST parser derives the same alias from `?select=sum(total)` and the two
-* have to agree — a caller reading `row.sum_total` off an SDK result and off an
-* HTTP response is reading the same key or the SDK is broken.
-*/
-function aggregateAlias(fn, field) {
-	return field ? `${fn}_${field}` : fn;
-}
-function toDriverAggregate(select) {
-	const field = select.field;
-	return {
-		fn: select.fn,
-		field,
-		alias: aggregateAlias(select.fn, field)
-	};
-}
-/**
 * What a client says when its data source cannot aggregate.
 *
 * A stub rather than a fallback that fetches and reduces in JavaScript: that
@@ -50,6 +31,8 @@ var noTrash = (slug) => `The trash is not available for "${slug}": its data sour
 /** What `softDelete: true` names the field a delete stamps; a restore clears it. */
 var DEFAULT_SOFT_DELETE_FIELD = "deletedAt";
 var noAggregate = (slug) => `Aggregates are not available for "${slug}": its data source does not implement them.`;
+/** What a client says when its data source has no materialized views to refresh. */
+var noRefresh = (slug) => `"${slug}" cannot be refreshed: its data source has no materialized views.`;
 function createPrimaryKeyResolver(options) {
 	const cache = /* @__PURE__ */ new Map();
 	const warned = /* @__PURE__ */ new Set();
@@ -109,7 +92,7 @@ function toViewModelValues(values, properties, collection, resolveCollection) {
 		if (!(key in values)) {
 			const fkRelation = relations[key];
 			const column = fkRelation && "localKey" in fkRelation ? fkRelation.localKey : void 0;
-			const fk = column !== void 0 ? values[column] ?? values[toWireKey(column)] : void 0;
+			const fk = column !== void 0 ? values[fieldKeyForColumn(collection, column)] ?? values[column] ?? values[toWireKey(column)] : void 0;
 			const fkTarget = fkRelation?.targetSlug;
 			if (fkTarget && (typeof fk === "string" || typeof fk === "number")) write(key, new EntityRelation(fk, fkTarget));
 			continue;
@@ -175,6 +158,10 @@ function rowToEntity(row, slug, primaryKeys = [], toViewModel) {
 		...etag ? { etag } : {}
 	};
 }
+/** {@link rowToEntity} over a page of rows, the primary keys looked up once for all of them. */
+function rowsToEntities(rows, slug, primaryKeys, toViewModel) {
+	return rows.map((row) => rowToEntity(row, slug, primaryKeys, toViewModel));
+}
 /**
 * The relation envelope `toFlatRow` writes where a relation was:
 * `{ id, path, __type: "relation", data: { id, path, values } }`. It is the
@@ -274,14 +261,14 @@ function createDriverAccessor(driver, slug, getPks = () => [], toViewModel, stor
 				}) : void 0
 			};
 		};
-		const { fetched, counted } = driver.readTogether ? await driver.readTogether(read) : await read(driver);
+		const { fetched, counted } = counting && driver.readTogether ? await driver.readTogether(read) : await read(driver);
 		const rows = probing ? fetched.slice(0, limit) : fetched;
 		const total = counted ?? rows.length + offset;
 		const hasMore = probing ? fetched.length > limit : offset + rows.length < total;
 		const last = rows[rows.length - 1];
 		const nextCursor = hasMore && last && driver.restFetchService?.cursorFor ? driver.restFetchService.cursorFor(storedPath(), last, orderBy) : void 0;
 		return {
-			data: rows.map((row) => rowToEntity(row, slug, getPks(), toViewModel)),
+			data: rowsToEntities(rows, slug, getPks(), toViewModel),
 			meta: {
 				total,
 				limit,
@@ -319,7 +306,7 @@ function createDriverAccessor(driver, slug, getPks = () => [], toViewModel, stor
 			const limit = (params.groupBy?.length ?? 0) > 0 ? params.limit : void 0;
 			const rows = await driver.restFetchService.aggregate(storedPath(), {
 				aggregates: params.select.map(toDriverAggregate),
-				groupBy: params.groupBy,
+				groupBy: params.groupBy?.map((group) => toDriverAggregateGroup(group)),
 				filter: params.where ? deserializeFilter(params.where) : void 0,
 				logical: params.logical,
 				searchString: params.searchString,
@@ -340,6 +327,7 @@ function createDriverAccessor(driver, slug, getPks = () => [], toViewModel, stor
 			});
 			return page;
 		} : void 0,
+		refresh: driver.refreshView ? (options) => driver.refreshView(storedPath(), options) : void 0,
 		async create(data, id) {
 			return rowToEntity(await driver.save({
 				path: storedPath(),
@@ -349,12 +337,12 @@ function createDriverAccessor(driver, slug, getPks = () => [], toViewModel, stor
 			}), slug, getPks(), toViewModel);
 		},
 		createMany: driver.saveMany ? async (data, options) => {
-			return (await driver.saveMany({
+			return rowsToEntities(await driver.saveMany({
 				path: storedPath(),
 				rows: data,
 				upsert: options?.upsert,
 				onConflict: options?.onConflict
-			})).map((row) => rowToEntity(row, slug, getPks(), toViewModel));
+			}), slug, getPks(), toViewModel);
 		} : void 0,
 		async update(id, data) {
 			return rowToEntity(await driver.save({
@@ -371,13 +359,13 @@ function createDriverAccessor(driver, slug, getPks = () => [], toViewModel, stor
 			} });
 		},
 		updateMany: driver.updateMany ? async (updates) => {
-			return (await driver.updateMany({
+			return rowsToEntities(await driver.updateMany({
 				path: storedPath(),
 				updates: updates.map((u) => ({
 					id: u.id,
 					values: u.data
 				}))
-			})).map((row) => rowToEntity(row, slug, getPks(), toViewModel));
+			}), slug, getPks(), toViewModel);
 		} : void 0,
 		deleteMany: driver.deleteMany ? async (ids) => {
 			await driver.deleteMany({
@@ -497,6 +485,69 @@ function createViewModelConverter(options) {
 		};
 	};
 }
+/**
+* A row as the server sends it, in the admin's view model of its collection:
+* the `values` `buildRebaseData` and `wrapAsEntityData` give an `Entity` of
+* that collection — a date as a `Date`, a relation as an `EntityRelation`,
+* also under its property's key where the row carries only the foreign key —
+* and a `reference` property's id as an `EntityReference`. A collection the
+* resolver does not know leaves the row as it is.
+*
+* For code that holds a flat row and hands it to what expects the admin's
+* values, such as a collection's `browserCallbacks` or a preview.
+*/
+function rowToViewModel(row, slug, resolveCollection) {
+	const collection = resolveCollection(slug);
+	if (!collection) return row;
+	return withReferences(toViewModelValues(row, collection.properties, collection, resolveCollection), collection.properties);
+}
+/**
+* Each `reference` property's value — the referenced id, or `{ id, path }` —
+* as the `EntityReference` the admin's reference field and preview read; an
+* array of references item by item.
+*/
+function withReferences(values, properties) {
+	if (!properties) return values;
+	let out;
+	for (const [key, property] of Object.entries(properties)) {
+		if (!(key in values)) continue;
+		const value = values[key];
+		const path = referencePath(property);
+		const arrayPath = isPlainRecord(property) && property.type === "array" ? referencePath(property.of) : void 0;
+		if (path !== void 0) {
+			out = out ?? { ...values };
+			out[key] = toReference(value, path);
+		} else if (arrayPath !== void 0 && Array.isArray(value)) {
+			out = out ?? { ...values };
+			out[key] = value.map((item) => toReference(item, arrayPath));
+		}
+	}
+	return out ?? values;
+}
+/** The target path of a `reference` property; `undefined` for any other. */
+function referencePath(property) {
+	if (!isPlainRecord(property) || property.type !== "reference") return void 0;
+	return typeof property.path === "string" ? property.path : "";
+}
+function toReference(value, path) {
+	if (value === null || value === void 0 || value === "") return null;
+	if (value instanceof EntityReference) return value;
+	if ((typeof value === "string" || typeof value === "number") && path) return new EntityReference({
+		id: String(value),
+		path
+	});
+	if (isPlainRecord(value) && (typeof value.id === "string" || typeof value.id === "number")) {
+		const target = typeof value.path === "string" ? value.path : path;
+		if (target) return new EntityReference({
+			id: String(value.id),
+			path: target
+		});
+	}
+	return value;
+}
+function isPlainRecord(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
 function buildRebaseData(driver, options) {
 	const cache = /* @__PURE__ */ new Map();
 	const primaryKeysFor = createPrimaryKeyResolver(options);
@@ -797,6 +848,7 @@ function toSdkCollectionClient(snap, slug = "collection") {
 		distinct: (enabled) => new SdkQueryBuilder(client).distinct(enabled),
 		after: (cursor) => new SdkQueryBuilder(client).after(cursor),
 		aggregate: snap.aggregate ? (params) => snap.aggregate(params) : unsupportedMethod(noAggregate(slug)),
+		refresh: snap.refresh ? (options) => snap.refresh(options) : unsupportedMethod(noRefresh(slug)),
 		trash: toSdkTrashClient(snap, slug, () => client)
 	};
 	return client;
@@ -865,7 +917,7 @@ function toEntityAccessor(sdk, slug, getPks = () => [], toViewModel, viewModelSo
 		async find(params) {
 			const res = await sdk.find(params);
 			return {
-				data: res.data.map((row) => rowToEntity(row, slug, getPks(), toViewModel)),
+				data: rowsToEntities(res.data, slug, getPks(), toViewModel),
 				meta: res.meta
 			};
 		},
@@ -877,7 +929,7 @@ function toEntityAccessor(sdk, slug, getPks = () => [], toViewModel, viewModelSo
 			return rowToEntity(await sdk.create(data, id), slug, getPks(), toViewModel);
 		},
 		createMany: sdk.createMany ? async (data, options) => {
-			return (await sdk.createMany(data, options)).map((row) => rowToEntity(row, slug, getPks(), toViewModel));
+			return rowsToEntities(await sdk.createMany(data, options), slug, getPks(), toViewModel);
 		} : void 0,
 		async update(id, data, options) {
 			const row = options?.ifMatch ? await sdk.update(id, data, { ifMatch: options.ifMatch }) : await sdk.update(id, data);
@@ -889,6 +941,7 @@ function toEntityAccessor(sdk, slug, getPks = () => [], toViewModel, viewModelSo
 		},
 		count: isUnsupported(sdk.count) ? void 0 : (params) => sdk.count(params),
 		aggregate: isUnsupported(sdk.aggregate) ? void 0 : (params) => sdk.aggregate(params),
+		refresh: isUnsupported(sdk.refresh) ? void 0 : (options) => sdk.refresh(options),
 		listen: isUnsupported(sdk.listen) ? void 0 : (params, onUpdate, onError) => {
 			let built = /* @__PURE__ */ new WeakMap();
 			let builtWith;
@@ -918,7 +971,7 @@ function toEntityAccessor(sdk, slug, getPks = () => [], toViewModel, viewModelSo
 			async find(params) {
 				const res = await sdk.trash.find(params);
 				return {
-					data: res.data.map((row) => rowToEntity(row, slug, getPks(), toViewModel)),
+					data: rowsToEntities(res.data, slug, getPks(), toViewModel),
 					meta: res.meta
 				};
 			},
@@ -1033,6 +1086,6 @@ function buildSdkData(driver, options) {
 	return wrapAsSdkData(buildRebaseData(driver), options);
 }
 //#endregion
-export { aggregateAlias, buildRebaseData, buildSdkData, wrapAsEntityData, wrapAsSdkData };
+export { aggregateAlias, buildRebaseData, buildSdkData, rowToViewModel, wrapAsEntityData, wrapAsSdkData };
 
 //# sourceMappingURL=buildRebaseData.es.js.map