@protobase/schema 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/access/capability.d.ts

@@ -0,0 +1,10 @@
+//#region src/access/capability.d.ts
+export type CapabilityAction = 'read' | 'create' | 'update' | 'delete';
+export type CapabilityScope = 'own' | 'team';
+/**
+ * `<resource|area>.<action>[.<scope>]` with `*` wildcards, or `*` alone. Pass the names as the
+ * type parameter of `defineRoles` to make unknown names compile-time errors.
+ */
+export type Capability<Name extends string = string> = '*' | `${Name | '*'}.${CapabilityAction | '*'}` | `${Name | '*'}.${CapabilityAction | '*'}.${CapabilityScope | '*'}`;
+export type Grant = 'all' | CapabilityScope;
+//#endregion

package/dist/access/capability.js

@@ -0,0 +1,30 @@
+//#region src/access/capability.ts
+const pattern = /^(\*|[A-Za-z][A-Za-z0-9_]*)\.(\*|read|create|update|delete)(?:\.(\*|own|team))?$/;
+/** Parses and validates a capability string; throws on anything that is not one. */
+const parseCapability = (capability) => {
+	if (capability === "*") return {
+		name: "*",
+		action: "*"
+	};
+	const match = pattern.exec(capability);
+	if (!match) throw new Error(`Invalid capability "${capability}": expected <resource|area>.<read|create|update|delete|*>[.<own|team|*>] or "*"`);
+	return {
+		name: match[1],
+		action: match[2],
+		scope: match[3]
+	};
+};
+const matches = (pattern, value) => pattern === "*" || pattern === value;
+/**
+* The scopes with which `held` grants `wanted`'s resource and action. An unscoped (or `.*`)
+* capability grants everything; `.own` and `.team` narrow to rows.
+*/
+const grantsOf = (held, wanted) => {
+	const have = parseCapability(held);
+	if (!matches(have.name, wanted.name) && wanted.name !== "*") return [];
+	if (!matches(have.action, wanted.action) && wanted.action !== "*") return [];
+	if (have.scope === void 0 || have.scope === "*") return ["all"];
+	return [have.scope];
+};
+//#endregion
+export { grantsOf, parseCapability };

package/dist/access/combine.js

@@ -0,0 +1,39 @@
+import { parseFilter } from "../filter/parse.js";
+import { createWhere } from "../filter/where.js";
+//#region src/access/combine.ts
+const span = {
+	start: 0,
+	end: 0
+};
+/** Turns an access result into a verdict or a `FilterExpr`. */
+const normalize = (result) => {
+	if (typeof result !== "string") return result;
+	const parsed = parseFilter(result);
+	if (!parsed.ok || !parsed.ast) throw new Error(`Access rule returned an invalid filter "${result}": ${parsed.errors[0]?.message ?? "empty"}`);
+	return parsed.ast;
+};
+const andResults = (a, b) => {
+	const [x, y] = [normalize(a), normalize(b)];
+	if (x === false || y === false) return false;
+	if (x === true) return y;
+	if (y === true) return x;
+	return {
+		kind: "and",
+		args: [x, y],
+		span
+	};
+};
+const orResults = (a, b) => {
+	const [x, y] = [normalize(a), normalize(b)];
+	if (x === true || y === true) return true;
+	if (x === false) return y;
+	if (y === false) return x;
+	return {
+		kind: "or",
+		args: [x, y],
+		span
+	};
+};
+const where = createWhere();
+//#endregion
+export { andResults, normalize, orResults, where };

package/dist/access/index.d.ts

@@ -0,0 +1,8 @@
+import { AccessAction, AccessContext, AccessFn, AccessResult, AccessUser, FieldAccess, FieldRule } from "./types.js";
+import { Capability, CapabilityAction, CapabilityScope } from "./capability.js";
+import { Rule, rule } from "./rule.js";
+import { Roles, RolesOptions, defineRoles } from "./roles.js";
+import { pickView } from "./pick-view.js";
+import { AccessSource, ResolveOptions, ResolvedAccess, RowFilterOperation, accessWarnings, checkRecord, fieldsUsedBy, resolveAccess } from "./resolve.js";
+import { restrictModel } from "./restrict.js";
+export { type AccessAction, type AccessContext, type AccessFn, type AccessResult, type AccessSource, type AccessUser, type Capability, type CapabilityAction, type CapabilityScope, type FieldAccess, type FieldRule, type ResolveOptions, type ResolvedAccess, type Roles, type RolesOptions, type RowFilterOperation, type Rule, accessWarnings, checkRecord, defineRoles, fieldsUsedBy, pickView, resolveAccess, restrictModel, rule };

package/dist/access/pick-view.d.ts

@@ -0,0 +1,8 @@
+import { ViewModel } from "../model.js";
+//#region src/access/pick-view.d.ts
+/**
+ * Picks the view for a user: the first role-specific view whose roles intersect the user's,
+ * otherwise the default view (one without roles). With `resource`, only that resource's views count.
+ */
+export declare const pickView: (views: readonly ViewModel[], roles: readonly string[], resource?: string) => ViewModel | undefined;
+//#endregion

package/dist/access/pick-view.js

@@ -0,0 +1,11 @@
+//#region src/access/pick-view.ts
+/**
+* Picks the view for a user: the first role-specific view whose roles intersect the user's,
+* otherwise the default view (one without roles). With `resource`, only that resource's views count.
+*/
+const pickView = (views, roles, resource) => {
+	const candidates = resource === void 0 ? views : views.filter((view) => view.resource === resource);
+	return candidates.find((view) => view.roles?.some((role) => roles.includes(role))) ?? candidates.find((view) => !view.roles?.length);
+};
+//#endregion
+export { pickView };

package/dist/access/resolve.d.ts

@@ -0,0 +1,61 @@
+import { CheckedFilter, ResourceModel } from "../model.js";
+import { AccessAction, AccessContext, AccessFn, FieldAccess } from "./types.js";
+import { EvaluateOptions } from "../filter/evaluate.js";
+import "../filter/index.js";
+import { Rule } from "./rule.js";
+//#region src/access/resolve.d.ts
+/** What the resolver needs from a resource; `ResourceBuilder` satisfies it. */
+export type AccessSource = {
+  toModel: () => ResourceModel;
+  accessRules: Partial<Record<AccessAction, AccessFn>>;
+  fieldAccess: () => Record<string, FieldAccess>;
+};
+export type ResolveOptions = {
+  /**
+   * The project's roles. When given, an operation without a rule is denied unless the user's
+   * roles grant `<resource>.<action>` (so admin's `*` still passes). Fields without a rule
+   * follow their resource.
+   */
+  roles?: {
+    can: (capability: any) => Rule;
+  };
+  /**
+   * Overrides what an operation without a rule does. Without `roles` the default is `allow`,
+   * the single-admin case; with `roles` it is the capability check above. Choosing `allow`
+   * together with `roles` is an explicit opt-in, see `accessWarnings`.
+   */
+  defaultAccess?: 'allow' | 'deny';
+};
+/** Startup warnings for risky option combinations; the caller decides how to report them. */
+export declare const accessWarnings: (options: ResolveOptions) => string[];
+export type RowFilterOperation = 'read' | 'create' | 'update' | 'delete';
+export type ResolvedAccess = {
+  operations: Record<AccessAction, boolean>;
+  /** Operations whose rule needs the record (or input); check them with `checkRecord`. */
+  recordChecks: AccessAction[];
+  /** Columns the caller may see; everything else must be left out of results, filters, sorts and search. */
+  readableFields: string[];
+  writableFields: {
+    create: string[];
+    update: string[];
+  };
+  /** ANDed into queries (`read` covers list and read) or checked against records (`create`). */
+  rowFilter: Partial<Record<RowFilterOperation, CheckedFilter>>;
+};
+/**
+ * Resolves everything a request may do with a resource: operations, row filters, readable and
+ * writable columns. Pure with respect to the database; downstream code applies the result
+ * and must not re-decide access.
+ */
+export declare const resolveAccess: (source: AccessSource, ctx: Omit<AccessContext, "model" | "operation"> & {
+  user: NonNullable<AccessContext["user"]>;
+}, options?: ResolveOptions) => Promise<ResolvedAccess>;
+/**
+ * Record-level check for an operation: runs the rule with the record (and input) and evaluates
+ * a returned filter against it. Creates are checked against the input, other operations
+ * against the existing record.
+ */
+export declare const checkRecord: (source: AccessSource, ctx: Omit<AccessContext, "model" | "operation" | "record">, operation: AccessAction, record: Record<string, unknown> | undefined, input?: Record<string, unknown>, options?: ResolveOptions & EvaluateOptions) => Promise<boolean>;
+/** Names of the fields a checked filter refers to, so callers can reject filters on unreadable columns. */
+export declare const fieldsUsedBy: (filter: CheckedFilter) => string[];
+//#endregion

package/dist/access/resolve.js

@@ -0,0 +1,150 @@
+import { checkFilter } from "../filter/check.js";
+import { evaluateFilter } from "../filter/evaluate.js";
+import { andResults, normalize } from "./combine.js";
+//#region src/access/resolve.ts
+/** Startup warnings for risky option combinations; the caller decides how to report them. */
+const accessWarnings = (options) => options.roles && options.defaultAccess === "allow" ? ["Roles are configured but defaultAccess is \"allow\": operations without an access rule are open to every user."] : [];
+const operations = [
+	"read",
+	"list",
+	"create",
+	"update",
+	"delete"
+];
+const ruleFor = (source, model, operation, options) => {
+	const explicit = source.accessRules[operation] ?? (operation === "list" ? source.accessRules.read : void 0);
+	if (explicit) return explicit;
+	if (options.defaultAccess) return options.defaultAccess === "allow";
+	if (!options.roles) return true;
+	return options.roles.can(`${model.name}.${operation === "list" ? "read" : operation}`);
+};
+const checked = (model, expr, operation) => {
+	const trusted = {
+		...model,
+		fields: Object.fromEntries(Object.entries(model.fields).map(([name, field]) => [name, {
+			...field,
+			filterable: true
+		}]))
+	};
+	const result = checkFilter(trusted, expr);
+	if (!result.ok) throw new Error(`The ${operation} access rule of "${model.name}" returned an invalid filter: ${result.errors[0].message}`);
+	return result.filter;
+};
+const decide = async (rule, ctx) => {
+	try {
+		return normalize(await rule(ctx));
+	} catch (error) {
+		if (error instanceof TypeError) return "record";
+		throw error;
+	}
+};
+const verdict = async (rule, ctx, fallback, what) => {
+	if (!rule) return fallback;
+	const result = normalize(await rule(ctx));
+	if (typeof result !== "boolean") throw new Error(`${what} must be role-based and return a boolean; a row filter (.own, .team) cannot apply to a column`);
+	return result;
+};
+/**
+* Resolves everything a request may do with a resource: operations, row filters, readable and
+* writable columns. Pure with respect to the database; downstream code applies the result
+* and must not re-decide access.
+*/
+const resolveAccess = async (source, ctx, options = {}) => {
+	const model = source.toModel();
+	const allowed = {};
+	const recordChecks = [];
+	const filters = {};
+	for (const operation of operations) {
+		if (operation === "list" && !source.accessRules.list) {
+			allowed.list = allowed.read;
+			if (recordChecks.includes("read")) recordChecks.push("list");
+			continue;
+		}
+		const rule = ruleFor(source, model, operation, options);
+		const decision = typeof rule === "boolean" ? rule : await decide(rule, {
+			...ctx,
+			model,
+			operation
+		});
+		if (decision === "record") {
+			allowed[operation] = true;
+			recordChecks.push(operation);
+		} else if (typeof decision === "boolean") allowed[operation] = decision;
+		else {
+			allowed[operation] = true;
+			filters[operation] = decision;
+		}
+	}
+	const fieldRules = source.fieldAccess();
+	const fieldContext = (operation) => ({
+		...ctx,
+		model,
+		operation
+	});
+	const names = Object.keys(model.fields);
+	const readableFields = [];
+	const writable = {
+		create: [],
+		update: []
+	};
+	for (const name of names) {
+		const rules = fieldRules[name];
+		const field = model.fields[name];
+		if (allowed.list || allowed.read) {
+			if (await verdict(rules?.read, fieldContext("read"), true, `The read rule of field "${name}"`)) readableFields.push(name);
+		}
+		for (const operation of ["create", "update"]) {
+			if (!allowed[operation] || field.readOnly) continue;
+			if (await verdict(rules?.[operation], fieldContext(operation), true, `The ${operation} rule of field "${name}"`)) writable[operation].push(name);
+		}
+	}
+	const readFilter = filters.list && filters.read ? andResults(filters.list, filters.read) : filters.read ?? filters.list;
+	const rowFilter = {};
+	const byOperation = [
+		["read", readFilter],
+		["create", filters.create],
+		["update", filters.update],
+		["delete", filters.delete]
+	];
+	for (const [operation, filter] of byOperation) if (filter && typeof filter === "object") rowFilter[operation] = checked(model, filter, operation);
+	else if (filter === false) allowed[operation === "read" ? "read" : operation] = false;
+	return {
+		operations: allowed,
+		recordChecks,
+		readableFields,
+		writableFields: writable,
+		rowFilter
+	};
+};
+/**
+* Record-level check for an operation: runs the rule with the record (and input) and evaluates
+* a returned filter against it. Creates are checked against the input, other operations
+* against the existing record.
+*/
+const checkRecord = async (source, ctx, operation, record, input, options = {}) => {
+	const model = source.toModel();
+	const rule = ruleFor(source, model, operation, options);
+	if (typeof rule === "boolean") return rule;
+	const result = normalize(await rule({
+		...ctx,
+		model,
+		operation,
+		record
+	}, record, input));
+	if (typeof result === "boolean") return result;
+	const subject = operation === "create" ? input : record;
+	if (!subject) throw new Error(`Checking a ${operation} filter for "${model.name}" needs ${operation === "create" ? "the input" : "the record"}`);
+	return evaluateFilter(checked(model, result, operation), subject, options);
+};
+/** Names of the fields a checked filter refers to, so callers can reject filters on unreadable columns. */
+const fieldsUsedBy = (filter) => {
+	switch (filter.kind) {
+		case "and":
+		case "or": return [...new Set(filter.args.flatMap(fieldsUsedBy))];
+		case "not": return fieldsUsedBy(filter.arg);
+		case "search": return [];
+		default: return [filter.field.name];
+	}
+};
+//#endregion
+export { accessWarnings, checkRecord, fieldsUsedBy, resolveAccess };

package/dist/access/restrict.d.ts

@@ -0,0 +1,16 @@
+import { ResourceModel } from "../model.js";
+import { ResolvedAccess } from "./resolve.js";
+//#region src/access/restrict.d.ts
+/**
+ * The resource as one user may see it: only readable fields remain, and a field is `readOnly`
+ * unless it is writable on create or update. `search` (and `searchMatch`) shrinks to readable fields, and `tenant`,
+ * `softDelete` and `owner` are dropped when their field is hidden. Key columns always stay,
+ * because records are addressed by them.
+ *
+ * Use the restricted model for everything user-facing (checking filters, sorts, queries,
+ * OpenAPI, `/meta`), so hidden fields cannot be referenced at all. Row filters from access
+ * rules (`access.rowFilter`) are checked against the full model instead and kept separate:
+ * they may use hidden or non-filterable columns.
+ */
+export declare const restrictModel: (model: ResourceModel, access: Pick<ResolvedAccess, "readableFields" | "writableFields">) => ResourceModel;
+//#endregion

package/dist/access/restrict.js

@@ -0,0 +1,37 @@
+//#region src/access/restrict.ts
+/**
+* The resource as one user may see it: only readable fields remain, and a field is `readOnly`
+* unless it is writable on create or update. `search` (and `searchMatch`) shrinks to readable fields, and `tenant`,
+* `softDelete` and `owner` are dropped when their field is hidden. Key columns always stay,
+* because records are addressed by them.
+*
+* Use the restricted model for everything user-facing (checking filters, sorts, queries,
+* OpenAPI, `/meta`), so hidden fields cannot be referenced at all. Row filters from access
+* rules (`access.rowFilter`) are checked against the full model instead and kept separate:
+* they may use hidden or non-filterable columns.
+*/
+const restrictModel = (model, access) => {
+	const visible = /* @__PURE__ */ new Set([...access.readableFields, ...model.primaryKey]);
+	const writable = /* @__PURE__ */ new Set([...access.writableFields.create, ...access.writableFields.update]);
+	const keep = (name) => name !== void 0 && visible.has(name) ? name : void 0;
+	const search = model.search?.filter((name) => visible.has(name));
+	const searchMatch = model.searchMatch && Object.entries(model.searchMatch).filter(([name]) => visible.has(name));
+	const { search: _search, searchMatch: _searchMatch, tenant: _tenant, softDelete: _softDelete, owner: _owner, ...rest } = model;
+	const tenant = keep(model.tenant);
+	const softDelete = keep(model.softDelete);
+	const owner = keep(model.owner);
+	return {
+		...rest,
+		fields: Object.fromEntries(Object.entries(model.fields).filter(([name]) => visible.has(name)).map(([name, field]) => [name, {
+			...field,
+			readOnly: !writable.has(name)
+		}])),
+		...search?.length && { search },
+		...searchMatch?.length && { searchMatch: Object.fromEntries(searchMatch) },
+		...tenant && { tenant },
+		...softDelete && { softDelete },
+		...owner && { owner }
+	};
+};
+//#endregion
+export { restrictModel };

package/dist/access/roles.d.ts

@@ -0,0 +1,30 @@
+import { AccessUser } from "./types.js";
+import { Capability, Grant } from "./capability.js";
+import { Rule } from "./rule.js";
+//#region src/access/roles.d.ts
+export type RolesOptions = {
+  /** Ids of the users in `user`'s team; `.team` scopes become `owner IN teamOf(user)`. */
+  teamOf?: (user: AccessUser) => readonly (string | number)[] | Promise<readonly (string | number)[]>;
+  /** Resource and area names; when given, unknown names in capabilities throw at definition. */
+  names?: readonly string[];
+};
+/**
+ * Defines roles as bundles of capability strings. Pass the resource and area names as the type
+ * parameter to reject unknown names at compile time:
+ * `defineRoles<'orders' | 'costs'>({ sales: ['orders.read.own'] })`.
+ */
+export declare const defineRoles: <Name extends string = string>(definitions: Record<string, readonly Capability<Name>[]>, options?: RolesOptions) => {
+  definitions: Record<string, readonly Capability<Name>[]>;
+  grants: (user: AccessUser, capability: string) => Set<Grant>;
+  /** Whether the user holds the capability at all, in any scope. For areas and field rules. */
+  has: (user: AccessUser, capability: Capability<Name>) => boolean;
+  /**
+   * A rule that allows when the user's roles grant the capability: `true` for an unscoped
+   * grant, a row filter for `.own` and `.team`, `false` otherwise.
+   */
+  can: (capability: Capability<Name>) => Rule;
+  /** A rule that allows when the user has any of the roles. */
+  is: (...roles: string[]) => Rule;
+};
+export type Roles = ReturnType<typeof defineRoles>;
+//#endregion