ResourceBuilder

Defined in: packages/schema/src/resource.ts:31

A resource as resource(name) builds it. Every method returns a new builder, so a resource is one chain. See resource().

Type Parameters

F

F extends FieldsInput = { }

K

K = never

Properties

$fields

readonly $fields: F

Defined in: packages/schema/src/resource.ts:33

The fields, for the compiler only, which InferRecord reads; never set.

---

$key

readonly $key: K

Defined in: packages/schema/src/resource.ts:35

The fields of the key, for the compiler only, which RecordKey reads; never set.

Methods

access()

access(rules): ResourceBuilder<F, K>

Defined in: packages/schema/src/resource.ts:187

Rules per operation (list, read, create, update, delete). A rule returns true, false, or a filter that limits the rows. An operation without a rule needs its capability when the app has roles. See Access.

Parameters

rules

Access<F>

Returns

ResourceBuilder<F, K>

Example

.access({
  read: roles.can('work_orders.read'),
  update: roles.can('work_orders.update').and((_ctx, record) => (record as { status: string }).status !== 'done'),
  delete: roles.is('admin'),
})

---

comments()

comments(): ResourceBuilder<F, K>

Defined in: packages/schema/src/resource.ts:151

Lets the people who may read a record comment on it, and mention others who may read it too, who get an email. The record page shows the thread with l.comments(), and admins list every comment as Comments. See Record comments.

Returns

ResourceBuilder<F, K>

---

eventMatches()

eventMatches(): Record<string, EventMatch<any>>

Defined in: packages/schema/src/resource.ts:156

The code predicates (match) of its events, by event name.

Returns

Record<string, EventMatch<any>>

---

events()

events(define): ResourceBuilder<F, K>

Defined in: packages/schema/src/resource.ts:133

The events changes to its records raise, captured in the database for every write, from the API or elsewhere. See Declaring events.

Parameters

define

(e, r) => EventSpec[]

Returns

ResourceBuilder<F, K>

Example

.events((e, r) => [
  ...e.crud(),
  e.becomes('large', 'total > 1000'),
  e.updated('statusChanged', { changed: [r.status] }),
  e.updated('reopened', { from: 'status = "cancelled"', when: 'status != "cancelled"' }),
])

---

fieldAccess()

fieldAccess(): Record<string, FieldAccess>

Defined in: packages/schema/src/resource.ts:192

Role-based rules per field, for fields that declared .access(...).

Returns

Record<string, FieldAccess>

---

fields()

fields<N>(fields): ResourceBuilder<N, never>

Defined in: packages/schema/src/resource.ts:56

The columns, by field name, each built with f. name: null ignores a column on purpose. The column is the snake_case of the name unless .column() says otherwise. Required, and called before the methods that pick fields.

Type Parameters

N

N extends FieldsInput

Parameters

fields

N

Returns

ResourceBuilder<N, never>

---

history()

history(): ResourceBuilder<F, K>

Defined in: packages/schema/src/resource.ts:142

Keeps every change of its records, from the API or elsewhere: the fields before and after, and who made it. The record page shows it as History, and admins list every change as Activity. See Record history.

Returns

ResourceBuilder<F, K>

---

ignoredColumns()

ignoredColumns(): string[]

Defined in: packages/schema/src/resource.ts:214

The columns of the fields given as null, which the resource ignores on purpose.

Returns

string[]

---

owner()

owner(pick): ResourceBuilder<F, K>

Defined in: packages/schema/src/resource.ts:99

The field holding the owning user’s id, which .own capability scopes filter on.

Parameters

pick

(r) => Ref

Returns

ResourceBuilder<F, K>

---

position()

position(pick, o?): ResourceBuilder<F, K>

Defined in: packages/schema/src/resource.ts:114

The integer field holding the records’ order, 1 the first, which a list’s Sort button changes by dragging the records; a move renumbers them 1, 2, 3, … in one batch reorder. With within, a relation, each parent’s records have an order of their own, as an invoice’s items do, sorted in the parent’s related section. The field must be sortable and within filterable. See Sorting by hand.

Parameters

pick

(r) => Ref

o?

within?

(r) => Ref

Returns

ResourceBuilder<F, K>

Example

.position((r) => r.position, { within: (r) => r.invoice_id })

---

primaryKey()

primaryKey<P>(pick): ResourceBuilder<F, P>

Defined in: packages/schema/src/resource.ts:61

The key: one field, or a list for a key of several columns ((r) => [r.order_id, r.line_no]). Required.

Type Parameters

P

P extends KeyRefs

Parameters

pick

(r) => P

Returns

ResourceBuilder<F, P>

---

recordSchema()

recordSchema(): ZodType<{ [K in string | number | symbol]: { [K in string | number | symbol]: ActiveFields<F>[K] extends Field<V> ? V : never }[K] }, unknown, $ZodTypeInternals<{ [K in string | number | symbol]: { [K in string | number | symbol]: ActiveFields<F>[K] extends Field<V> ? V : never }[K] }, unknown>>

Defined in: packages/schema/src/resource.ts:204

The Zod schema of a whole record, from its fields’ schemas.

Returns

ZodType<{ [K in string | number | symbol]: { [K in string | number | symbol]: ActiveFields<F>[K] extends Field<V> ? V : never }[K] }, unknown, $ZodTypeInternals<{ [K in string | number | symbol]: { [K in string | number | symbol]: ActiveFields<F>[K] extends Field<V> ? V : never }[K] }, unknown>>

---

search()

search(pick): ResourceBuilder<F, K>

Defined in: packages/schema/src/resource.ts:91

Fields matched by search("...") and bare words in filters. Authoritative over the UI’s list search defaults. r.phone.digitsEnd() matches only the end of the field’s digits, for phone numbers.

Parameters

pick

(r) => SearchRef[]

Returns

ResourceBuilder<F, K>

---

softDelete()

softDelete(pick): ResourceBuilder<F, K>

Defined in: packages/schema/src/resource.ts:75

A nullable timestamp or date that marks a record deleted: deleting sets it, lists leave such rows out and :undelete clears it.

Parameters

pick

(r) => Ref

Returns

ResourceBuilder<F, K>

---

table()

table(table): ResourceBuilder<F, K>

Defined in: packages/schema/src/resource.ts:48

The table, with or without its schema: 'shop.repairs' or 'repairs'. Required.

Parameters

table

string

Returns

ResourceBuilder<F, K>

---

tenant()

tenant(pick): ResourceBuilder<F, K>

Defined in: packages/schema/src/resource.ts:83

The field that separates tenants: every query is limited to the caller’s tenant, creates set it, and a request body may not.

Parameters

pick

(r) => Ref

Returns

ResourceBuilder<F, K>

---

toModel()

toModel(): ResourceModel

Defined in: packages/schema/src/resource.ts:199

The resource as the server and the app read it. Throws when the table, fields or key are missing, or a field option conflicts with another.

Returns

ResourceModel

---

validate()

validate(validator): ResourceBuilder<F, K>

Defined in: packages/schema/src/resource.ts:169

A rule over the whole record, run after the field checks on every create and update. Its issues answer 400 with the field named. Each call adds a rule.

Parameters

validator

Validator<F>

Returns

ResourceBuilder<F, K>

Example

.validate((repair) => (repair.status === 'collected' && !repair.paid ? [{ field: 'paid', message: 'A bike leaves the shop paid' }] : undefined))