Attributes

Every attribute is declared with a factory named after its type. The factory takes { name, label } and returns a builder you chain and hand to object().attribute(). The object builder builds the attributes for you.

import { object, text, number } from "@standards/client";

export const PRODUCT = object("products", "Product")
  .labelExpression("{{ name }}")
  .attribute(text("name", "Name").required())
  .attribute(number("price", "Price").decimal(2).min(0));

The factory validates its config at declaration: name is an identifier (firstName, first_name; no dashes, no dots, 63 characters at most) and must not be one of the record's own fields (id, label, values, metadata, createdAt, ownedBy, …); label is non-empty and 128 characters at most. A bad config throws before any request is made.

The type table on Objects and records is the index of this page: one section per type, in the same order.

Methods on every builder

There is no unique, indexed or computed method. Uniqueness is not a builder concern, every attribute is queryable without an index, and computed values are the formula and rollup builders.

A required attribute is satisfied when it holds something a user would see. A value that passes the type checks but is still blank (an empty or whitespace-only string, an empty array) is refused with <Label> is required. The rule gates creation: an update that clears an attribute is accepted, and nothing re-validates stored records on read. An optional attribute normalizes a blank value to null and skips its format checks.

Every write the API refuses for one of these reasons answers 400 with code SCHEMA_VALIDATION_FAILED and one entry per failing attribute (path, message). Unknown attribute names are refused the same way. From the client this is a StandardsRequestError with status === 400.

import { StandardsRequestError } from "@standards/client";
import { getStandards } from "./client";

try {
  await getStandards().products.create({ name: "   ", price: -1 });
} catch (error) {
  if (error instanceof StandardsRequestError && error.code === "SCHEMA_VALIDATION_FAILED") {
    console.error(error.message); // "Name is required", "Price must be at least 0"
  }
}

text

A single line of text, or a paragraph with .multiline(). The app renders a .url() value as a link that opens in a new tab and an .email() value as a mail link.

The API checks the value is a string within the length bounds and matches the pattern or preset (<Label> must be at least n characters, <Label> format is invalid). Value type: string.

import { text } from "@standards/client";

export const email = text("email", "Email").email().required();
export const website = text("website", "Website").url();
export const bio = text("bio", "Bio").multiline().maxLength(500);

richtext

Long-form content stored as semantic markdown. The app opens it in the rich text editor and parses the markdown to and from the editor's document format.

No type-specific option. The API checks the value is a string (<Label> must be valid rich text content) and applies the required rule to whitespace-only content. Value type: string.

import { richtext } from "@standards/client";

export const notes = richtext("notes", "Notes");

number

A numeric value. The app renders it as a number input, a percentage, or a star rating with .renderAs("rating").

.integer(), .decimal() and .percentage() set the same unit; the last call wins. The API checks the value is a number within the bounds and an integer when asked (<Label> must be at least n, <Label> must be an integer). Value type: number.

import { number } from "@standards/client";

export const quantity = number("quantity", "Qty").integer().min(0);
export const score = number("score", "Score").max(5).renderAs("rating");

checkbox

A boolean. The app renders a checkbox.

No type-specific option. The API refuses anything but true or false. Value type: boolean.

import { checkbox } from "@standards/client";

export const active = checkbox("active", "Active").defaultValue(true);

date

A calendar day, an instant with .includeTime(), or a { start, end } range with .endDate(). The app renders a date picker in the declared format.

.defaultValue() takes a string, never a Date: the default lives in the serialized definition. The static value type is string | Date. You may write either: the client serializes a Date to ISO before sending. On read, JSON delivers an ISO string and the client revives it to a Date (both bounds of a range are revived). Without .endDate() the inferred type is string | Date; with it, DateRangeValue ({ start: string; end: string | null }, an open range leaves end null).

The API checks the value parses as a date, sits within minDate/maxDate ("today" is the current UTC day), and for a range that end is on or after start (<Label> must be a valid date).

import { date } from "@standards/client";

export const dueDate = date("dueDate", "Due date").minDate("today");
export const meeting = date("meeting", "Meeting").includeTime().timeFormat("24h");
export const period = date("period", "Period").endDate(); // { start, end }
export const createdOn = date("createdOn", "Created on").defaultValue("today");

phone

A phone number with its country. The app renders a country picker and a number input, and formats the number for that country. It shows a stored number as a tel: link that opens the dialler.

The API expects { countryCode, phoneNumber }: a valid ISO-3 country code and a non-empty number (<Label> must be a valid phone number, Invalid country code), then stores the number normalized to national digits. Clearing the number of an optional phone stores null. Value type: Phone ({ countryCode: CountryIso3; phoneNumber: string }).

import { phone } from "@standards/client";

export const mobile = phone("mobile", "Mobile").defaultCountry("FRA");

currency

An amount with its currency code. The app renders an amount input with a currency picker and formats the value with its symbol.

The API expects { code, value }: a three-letter code and a number, refused when negative unless .allowNegative() (<Label> must be a valid currency value). allowedCurrencies narrows the picker; the API checks the code's shape, not its membership. Value type: Currency ({ code: CurrencyCode; value: number }).

import { currency } from "@standards/client";

export const amount = currency("amount", "Amount")
  .defaultCurrency("EUR")
  .allowedCurrencies(["EUR", "USD"])
  .allowNegative();

status

One workflow state out of options grouped as idle, in_progress or finished. The app renders a colored badge and reads the groups to tell open work from finished work.

Option shape: { value, label, color?, description?, group?, inverse?, archived? }. color takes one of the eleven ids of the Standards palette: stone, clay, brick, terra, ochre, moss, sage, lagoon, ink, iris, peony; tsc and the API refuse any other value. group takes "idle" | "in_progress" | "finished". inverse names the option set on the other side of a bilateral relation the status qualifies ("parent" → "child"). The builder throws at declaration on an empty value or label, a duplicate value, or an inverse that does not point back symmetrically. tsc refuses any other key on an option passed to .options(), .option() or a rollup's .targetOptions(), whether written inline or declared elsewhere, so { id, value, label } is a type error naming id.

The API refuses a value outside the declared options with <Label> must be one of: <options>, each option written as its code with the label beside it (sent (Envoyé)). Value type: the literal union of your option values.

import { status } from "@standards/client";

export const stage = status("stage", "Stage").options([
  { value: "lead", label: "Lead", color: "ochre", group: "idle" },
  { value: "active", label: "Active", color: "sage", group: "in_progress" },
  { value: "closed", label: "Closed", color: "ink", group: "finished" },
]);

select

One choice out of a fixed list, without workflow semantics. The app renders a dropdown. With .renderAs("badges"), forms show every option as an inline badge; the record page and the table keep the dropdown and show only the selected value.

Options follow the shape and declaration checks described under status. The API refuses a value outside the options with <Label> must be one of: <options>, options written as under status. Value type: the literal union of your option values.

import { select } from "@standards/client";

export const category = select("category", "Category")
  .options([
    { value: "hardware", label: "Hardware" },
    { value: "software", label: "Software", color: "ink" },
  ])
  .renderAs("badges");

multiselect

Several choices out of a fixed list. The app renders a multi-value picker. With .renderAs("badges"), forms show every option as an inline badge; the record page and the table keep the picker and show only the selected values.

The API expects an array whose every item is a declared option value (otherwise <Label> must be one of: <options>, written as under status); a required multiselect refuses [] with <Label> is required. Value type: an array of the literal union.

import { multiselect } from "@standards/client";

export const tags = multiselect("tags", "Tags").options([
  { value: "urgent", label: "Urgent", color: "brick" },
  { value: "review", label: "Review", color: "ink" },
]);

location

A postal address, down to the granularity you declare. The app renders an address form limited to the parts the granularity asks for.

The API expects an object of optional parts (address, address2, city, state, postalCode, country as three letters, latitude within ±90, longitude within ±180) and refuses anything else with <Label> must be a valid location. Granularity and allowed countries shape the form; they are not re-checked on write. Value type: Location.

The form suggests addresses as you type, with no API key to configure. A field limited to France with .allowedCountries(["FRA"]) searches the French national address base (Base Adresse Nationale), which is more precise on French streets. Every other field searches OpenStreetMap worldwide.

import { location } from "@standards/client";

export const address = location("address", "Address")
  .granularity("full")
  .defaultCountry("FRA");

user

A reference to a workspace member or an agent. The app renders a people picker limited to the declared types.

The notification .notifiesOnAssign() sends has the kind fyi and the type record.assigned, and comes from the person who made the write. The 10-second window announces where it ends: an assignment undone, or a record deleted, before it closes sends nothing. One record reads "Bob assigned you to Ada Lovelace (contact)" in the interface's language, opens that record, and carries payload.objectName, payload.objectLabel, payload.recordLabel, payload.actorName and payload.count (1). Several records read "Bob assigned you to 12 contacts", open nothing, and carry payload.objectName, payload.objectLabel, payload.objectPluralLabel when the object declares one, payload.actorName and payload.count.

The API expects a UUID, or an array of UUIDs with .multiple(), and refuses anything else with <Label> must be a valid ID. Value type: string. With .multiple() the stored value is an array, but the inferred type stays string; annotate it yourself when you need string[].

import { user } from "@standards/client";

export const assignee = user("assignee", "Assignee").types(["user"]).required();
export const watchers = user("watchers", "Watchers").multiple();
export const owner = user("owner", "Owner").types(["user"]).notifiesOnAssign();

relation

A link to one record (.to()), to many (.many()), across several objects (several .to() calls) or to any object (.toAny()). The app renders a record picker and shows the linked record's label, or the displayTemplate you declare.

.many() returns a new builder that copies the targets, the required flag and the base options (hidden, placeholder, description, icon, order, metadata, runtime) but not qualifiers, bilateral config or a default value. Chain order matters: call .many() before .qualifyWith(), .bilateral() and .defaultValue().

There is no on-delete option; deleting a record moves it to the trash with its incoming edges, see Relations and documents.

The API accepts a record id or { id, props } for a qualified link, an array of them after .many(), checks every id is a UUID (<Label> must be a valid ID), that the count fits maxItems (<Label> must have at most n items), and that each record exists and belongs to a declared target (Invalid or non-existent records for <Label>).

Value type: string (a record id). A many-relation is typed string too by record inference, but arrives as an array of ids; typeof attr.$infer.value on the many builder is string[]. Cast or annotate when you read it. Qualified properties and bilateral sync are walked through in Relations and documents.

import { number, relation, select } from "@standards/client";

export const company = relation("company", "Company")
  .to("companies", { displayTemplate: "{name}" })
  .bilateral({ attribute: "contacts" })
  .required();

export const members = relation("members", "Members")
  .to("contacts")
  .many()
  .maxItems(50)
  .qualifyWith(
    select("role", "Role")
      .options([
        { value: "admin", label: "Admin" },
        { value: "member", label: "Member" },
      ])
      .required(),
    number("shares", "Shares").min(0),
  );

export const related = relation("related", "Related").toAny().many();

formula

A read-only value computed from the record's own attributes when the record is read. The app renders it in the format of .returns() and never lets it be edited.

.required() throws at declaration: a formula is never required. .defaultValue() is a no-op. On write the API accepts any value for a formula and ignores it, so a formula never fails validation. if(condition, then, else) yields null when the condition is null rather than taking the else branch, and arithmetic or comparison over amounts in different currency codes yields null too. Value type: unknown; narrow it yourself from .returns().

import { formula } from "@standards/client";

export const total = formula("total", "Total")
  .expression("price * quantity")
  .returns("number")
  .decimals(2);

export const lostPension = formula("lostPension", "Pension lost over 25 years")
  .expression("monthlyPensionLost * 12 * 25")
  .returns("number")
  .currency("EUR");

rollup

A read-only aggregate over the records linked by a relation. Unlike a formula the result is stored and refreshed when the linked records change. The app renders it as the aggregate's type, or as the target's badges with .using("original").

.required() throws at declaration. .defaultValue() is a no-op. Building throws a SchemaError when .using("original") is paired with a .targetType() other than select, status or multiselect; use a formula for a plain value. On write the API accepts and ignores any value for a rollup. sum and avg over currency amounts in different codes yield null. A original rollup copies the linked values onto this record and serves them under this record's visibility, so a workspace record rolling up private targets republishes them. Value type: unknown.

import { rollup } from "@standards/client";

export const totalOrders = rollup("totalOrders", "Total orders")
  .from("orders")
  .aggregate("amount")
  .using("sum")
  .decimals(2);

export const orderCount = rollup("orderCount", "Order count")
  .from("orders")
  .using("count");

document

A pack of ordered files attached to the record, always many by construction. The app renders the pack with a preview per file and the upload constraints you declare. See Files and documents for what a document is.

The record write stores the document ids as given. The constraints apply when a file is uploaded into the pack: a file outside accepts answers 400 with DOCUMENT_MIME_NOT_ACCEPTED, a file over maxFileSize answers 400 with DOCUMENT_FILE_TOO_LARGE. A required document with an empty pack is refused with <Label> is required. Value type: string[], or Array<{ id: string; props }> when qualified.

import { date, document, select } from "@standards/client";

export const idDocument = document("idDocument", "ID document")
  .accepts(["image/*", "application/pdf"])
  .maxFileSize(10 * 1024 * 1024);

export const mandate = document("mandate", "Mandate").qualifyWith(
  date("signedOn", "Signed on"),
  select("signature", "Signature").options([
    { value: "pending", label: "Pending" },
    { value: "signed", label: "Signed", color: "sage" },
  ]),
);

Next steps

• Objects: declare the object that carries these attributes.
• Relations and documents: qualified links, bilateral sync and document packs in depth.
• Type safety: what the builder infers and how to read records with those types.
• Objects and records: the record shape every attribute value lands in.
• Book a demo