@protobase/schema 0.50.1 → 0.51.0

package/dist/access/record-probe.js

@@ -0,0 +1,32 @@
+//#region src/access/record-probe.ts
+/** Thrown when a rule called without a record reads the record; a `TypeError`, as a missing record has always thrown. */
+var RecordNeeded = class extends TypeError {
+	constructor() {
+		super("The rule reads the record");
+	}
+};
+/**
+* A stand-in for the record and the input while a rule is called without them: any read of it throws `RecordNeeded`
+* until `disarm`, so `record?.x`, a default parameter and `args[1].x` all show that the rule needs the record. Once
+* disarmed it acts as an empty object, so a rule that kept it trips nothing later.
+*/
+const recordProbe = () => {
+	let armed = true;
+	const trap = (fallback) => () => {
+		if (armed) throw new RecordNeeded();
+		return fallback();
+	};
+	return {
+		value: new Proxy({}, {
+			get: trap(() => void 0),
+			has: trap(() => false),
+			ownKeys: trap(() => []),
+			getOwnPropertyDescriptor: trap(() => void 0)
+		}),
+		disarm: () => {
+			armed = false;
+		}
+	};
+};
+//#endregion
+export { RecordNeeded, recordProbe };

package/dist/access/resolve.d.ts

@@ -44,7 +44,10 @@ export declare const accessWarnings: (options: ResolveOptions) => string[];
 export type RowFilterOperation = 'read' | 'create' | 'update' | 'delete';
 /** What one request may do with one resource, as `resolveAccess` works it out. */
 export type ResolvedAccess = {
-  /** Whether each operation is allowed at all; one in `recordChecks` or `rowFilter` only for some records. */
+  /**
+   * Whether each operation is allowed at all; one in `recordChecks` or `rowFilter` only for some records. `list` is
+   * never record-checked: it is denied when the read or list rule needs the record.
+   */
   operations: Record<AccessAction, boolean>;
   /** Operations whose rule needs the record (or input); check them with `checkRecord`. */
   recordChecks: AccessAction[];

package/dist/access/resolve.js

@@ -1,6 +1,7 @@
 import { checkFilter } from "../filter/check.js";
 import { evaluateFilter } from "../filter/evaluate.js";
 import { andResults, normalize } from "./combine.js";
+import { recordProbe } from "./record-probe.js";
 import "./role-entry.js";
 //#region src/access/resolve.ts
 /** Startup warnings for risky option combinations; the caller decides how to report them. */
@@ -39,11 +40,17 @@ const checked = (model, expr, operation) => {
 	return result.filter;
 };
 const decide = async (rule, ctx) => {
+	const probe = recordProbe();
 	try {
-		return normalize(await rule(ctx));
+		return normalize(await rule({
+			...ctx,
+			record: probe.value
+		}, probe.value, probe.value));
 	} catch (error) {
 		if (error instanceof TypeError) return "record";
 		throw error;
+	} finally {
+		probe.disarm();
 	}
 };
 const verdict = async (rule, ctx, fallback, what) => {
@@ -66,7 +73,6 @@ const resolveAccess = async (source, ctx, options = {}) => {
 	for (const operation of operations) {
 		if (operation === "list" && !source.accessRules.list) {
 			allowed.list = allowed.read;
-			if (recordChecks.includes("read")) recordChecks.push("list");
 			continue;
 		}
 		const context = {
@@ -88,6 +94,10 @@ const resolveAccess = async (source, ctx, options = {}) => {
 			if (typeof combined === "object") filters[operation] = combined;
 		}
 	}
+	if (recordChecks.includes("read") || recordChecks.includes("list")) {
+		allowed.list = false;
+		if (recordChecks.includes("list")) recordChecks.splice(recordChecks.indexOf("list"), 1);
+	}
 	const fieldRules = source.fieldAccess();
 	const fieldContext = (operation) => ({
 		...ctx,

package/dist/access/types.d.ts

@@ -34,8 +34,9 @@ export type AccessContext = {
 export type AccessResult = boolean | string | FilterExpr;
 /**
  * A rule at the resource level. Without a record it decides the operation and may return a row
- * filter; with `(ctx, record, input)` it is a record-level check. Rules that need the record
- * may throw a `TypeError` when it is missing, which marks the operation as record-checked.
+ * filter; with `(ctx, record, input)` it is a record-level check. A rule that reads the record or
+ * input when called without them, or throws a `TypeError`, marks the operation as record-checked;
+ * a list is then refused, since it does not run the rule on each row.
  */
 export type AccessFn<R = any> = (ctx: AccessContext, record?: R, input?: Partial<R>) => AccessResult | Promise<AccessResult>;
 /** A field rule is role-based: it never sees a record, so readable columns are fixed per request. */

package/dist/humanize.d.ts

@@ -0,0 +1,7 @@
+//#region src/humanize.d.ts
+/**
+ * A field's or resource's name in words, where its view gives no label: `companyId` and `company_id` become "Company",
+ * `discountPercent` and `discount_percent` become "Discount percent".
+ */
+export declare const humanize: (name: string) => string;
+//#endregion

package/dist/humanize.js

@@ -0,0 +1,12 @@
+//#region src/humanize.ts
+const capitalise = (text) => text.charAt(0).toUpperCase() + text.slice(1);
+/**
+* A field's or resource's name in words, where its view gives no label: `companyId` and `company_id` become "Company",
+* `discountPercent` and `discount_percent` become "Discount percent".
+*/
+const humanize = (name) => {
+	const words = name.replace(/(Id|Code|_id|_code)$/, "").replace(/([a-z0-9])([A-Z])/g, "$1 $2").replace(/_+/g, " ").trim().toLowerCase();
+	return capitalise(words || name);
+};
+//#endregion
+export { humanize };

package/dist/internal.d.ts

@@ -25,6 +25,8 @@ import { readEventStream } from "./assistant/event-stream.js";
 import { layoutItems } from "./layout-items.js";
 import { viewOfList } from "./named-list.js";
 import { Locale, isLocale, locales, pickLocale } from "./locale.js";
+import { humanize } from "./humanize.js";
+import { labelFieldOf, recordTitle, recordTitleField } from "./record-title.js";
 import { apiOriginMeta } from "./api-origin-meta.js";
 import { MobileReleaseAnswer, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, releaseManifestFile } from "./mobile-release-address.js";
 import { authBasePath } from "./auth-base-path.js";
@@ -32,4 +34,4 @@ import { capacitorOrigin } from "./capacitor-origins.js";
 import { pushRecord, serviceWorkerFile } from "./push-record.js";
 import { deviceIdParam, devicesPath } from "./devices-path.js";
 import { historyIdParam, historyIdPattern, historyPath } from "./history-path.js";
-export { type AddressCheck, type FormulaNode, type Locale, type MobileReleaseAnswer, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, boardErrors, bottomBarFor, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, decodeKey, defaultRecentLimit, deviceIdParam, devicesPath, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, historyIdParam, historyIdPattern, historyPath, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, isLocale, layoutItems, leavesApp, linkActionError, locales, markFieldRefs, matchedSearchField, matchesSearch, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, pushRecord, readEventStream, redactSecrets, releaseManifestFile, renderPrompt, searchTerms, serviceWorkerFile, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };
+export { type AddressCheck, type FormulaNode, type Locale, type MobileReleaseAnswer, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, boardErrors, bottomBarFor, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, decodeKey, defaultRecentLimit, deviceIdParam, devicesPath, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, historyIdParam, historyIdPattern, historyPath, hrefField, hrefPlaceholders, humanize, inRange, isFieldRef, isGroupChart, isLocale, labelFieldOf, layoutItems, leavesApp, linkActionError, locales, markFieldRefs, matchedSearchField, matchesSearch, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, pushRecord, readEventStream, recordTitle, recordTitleField, redactSecrets, releaseManifestFile, renderPrompt, searchTerms, serviceWorkerFile, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/dist/internal.js

@@ -25,6 +25,8 @@ import { addressErrors } from "./address-errors.js";
 import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
 import { readEventStream } from "./assistant/event-stream.js";
 import { isLocale, locales, pickLocale } from "./locale.js";
+import { humanize } from "./humanize.js";
+import { labelFieldOf, recordTitle, recordTitleField } from "./record-title.js";
 import { apiOriginMeta } from "./api-origin-meta.js";
 import { mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, releaseManifestFile } from "./mobile-release-address.js";
 import { authBasePath } from "./auth-base-path.js";
@@ -32,4 +34,4 @@ import { capacitorOrigin } from "./capacitor-origins.js";
 import { pushRecord, serviceWorkerFile } from "./push-record.js";
 import { deviceIdParam, devicesPath } from "./devices-path.js";
 import { historyIdParam, historyIdPattern, historyPath } from "./history-path.js";
-export { actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, boardErrors, bottomBarFor, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, decodeKey, defaultRecentLimit, deviceIdParam, devicesPath, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, historyIdParam, historyIdPattern, historyPath, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, isLocale, layoutItems, leavesApp, linkActionError, locales, markFieldRefs, matchedSearchField, matchesSearch, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, pushRecord, readEventStream, redactSecrets, releaseManifestFile, renderPrompt, searchTerms, serviceWorkerFile, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };
+export { actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, boardErrors, bottomBarFor, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, decodeKey, defaultRecentLimit, deviceIdParam, devicesPath, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, historyIdParam, historyIdPattern, historyPath, hrefField, hrefPlaceholders, humanize, inRange, isFieldRef, isGroupChart, isLocale, labelFieldOf, layoutItems, leavesApp, linkActionError, locales, markFieldRefs, matchedSearchField, matchesSearch, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, pushRecord, readEventStream, recordTitle, recordTitleField, redactSecrets, releaseManifestFile, renderPrompt, searchTerms, serviceWorkerFile, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/dist/record-title.d.ts

@@ -0,0 +1,9 @@
+import { ResourceModel, ViewModel } from "./model.js";
+//#region src/record-title.d.ts
+/** The field that names a record when another record points at it. */
+export declare const labelFieldOf: (model: ResourceModel, view?: ViewModel) => string;
+/** What names a record: the view's `title`, else the first text column of its list, else `labelFieldOf`. */
+export declare const recordTitleField: (model: ResourceModel, view: ViewModel | undefined) => string;
+/** A record's name as shown: its title field's value, an enum's by its label, else `fallback` when the value is missing. */
+export declare const recordTitle: (model: ResourceModel, view: ViewModel | undefined, record: Record<string, unknown>, fallback: string) => string;
+//#endregion

package/dist/record-title.js

@@ -0,0 +1,25 @@
+import { enumLabel } from "./enum-label.js";
+//#region src/record-title.ts
+const labelCandidates = [
+	"name",
+	"title",
+	"number",
+	"sku",
+	"email",
+	"code",
+	"description"
+];
+const namesRecords = (field) => field?.type === "text" && !field.sensitive;
+/** The field that names a record when another record points at it. */
+const labelFieldOf = (model, view) => view?.title ?? labelCandidates.find((name) => namesRecords(model.fields[name])) ?? Object.values(model.fields).find(namesRecords)?.name ?? model.primaryKey[0];
+/** What names a record: the view's `title`, else the first text column of its list, else `labelFieldOf`. */
+const recordTitleField = (model, view) => view?.title ?? view?.list?.columns.find((name) => model.fields[name]?.type === "text") ?? labelFieldOf(model);
+/** A record's name as shown: its title field's value, an enum's by its label, else `fallback` when the value is missing. */
+const recordTitle = (model, view, record, fallback) => {
+	const name = recordTitleField(model, view);
+	const value = record[name];
+	if (value === null || value === void 0) return fallback;
+	return model.fields[name]?.type === "enum" ? enumLabel(String(value), view?.fields[name]?.valueLabels) : String(value);
+};
+//#endregion
+export { labelFieldOf, recordTitle, recordTitleField };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/schema",
-  "version": "0.50.1",
+  "version": "0.51.0",
   "description": "Resource, field, view and access definitions for Protobase configs.",
   "license": "Apache-2.0",
   "repository": {