Skip to content

armgit / macro

Public Imported from GitHub
0

Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.

feat(databases): add formula columns (#7767)

Wolf Mermelstein9f2a13df4218
diff --git a/apps/web/src/features/database/components/column-type-menu.tsx b/apps/web/src/features/database/components/column-type-menu.tsx
index 917e16a80c..d01892d5ab 100644
--- a/apps/web/src/features/database/components/column-type-menu.tsx
+++ b/apps/web/src/features/database/components/column-type-menu.tsx
@@ -1,5 +1,6 @@
import CaretRightIcon from '@phosphor/caret-right.svg';
import CheckIcon from '@phosphor/check.svg';
+import FunctionIcon from '@phosphor/function.svg';
import { Dropdown } from '@ui/components/Dropdown';
import { type Accessor, createSignal, For, type JSX, Show } from 'solid-js';
import {
@@ -51,6 +52,8 @@ export function ColumnTypeMenu(props: {
* it is not offered.
*/
onConvertToNewColumn?: (choice: DatabaseColumnConversionChoice) => void;
+ /** Offer a formula; the host decides where the formula column goes. */
+ onFormula?: () => void;
}) {
const [open, setOpen] = createSignal(false);
const protectedType = () =>
@@ -150,6 +153,21 @@ export function ColumnTypeMenu(props: {
)}
</For>
</Dropdown.Group>
+ <Show when={props.onFormula}>
+ {(onFormula) => (
+ <Dropdown.Group>
+ <Dropdown.Item
+ disabled={protectedType()}
+ onSelect={() => onFormula()()}
+ >
+ <FunctionIcon class="size-3.5 shrink-0 text-ink-muted" />
+ <Dropdown.ItemLabel class="flex-1">
+ Formula
+ </Dropdown.ItemLabel>
+ </Dropdown.Item>
+ </Dropdown.Group>
+ )}
+ </Show>
<Show when={offeredTables().length}>
<Dropdown.Group>
<Dropdown.GroupLabel>Related table</Dropdown.GroupLabel>
diff --git a/apps/web/src/features/database/components/database-column-header.tsx b/apps/web/src/features/database/components/database-column-header.tsx
index 5ea4386b6a..0ef416df89 100644
--- a/apps/web/src/features/database/components/database-column-header.tsx
+++ b/apps/web/src/features/database/components/database-column-header.tsx
@@ -7,6 +7,7 @@ import ArrowUpIcon from '@phosphor/arrow-up.svg';
import CaretDownIcon from '@phosphor/caret-down.svg';
import ColumnsPlusLeftIcon from '@phosphor/columns-plus-left.svg';
import ColumnsPlusRightIcon from '@phosphor/columns-plus-right.svg';
+import FunctionIcon from '@phosphor/function.svg';
import ListBulletsIcon from '@phosphor/list-bullets.svg';
import PencilIcon from '@phosphor/pencil-simple.svg';
import TrashIcon from '@phosphor/trash.svg';
@@ -24,6 +25,7 @@ import {
MenuSeparator,
} from '../../../lib/core/component/ContextMenu';
import { useColumnUsage } from '../context/column-usage';
+import { useFormulaEditing } from '../context/formula-editing';
import { useOptionEditing } from '../context/option-editing';
import {
columnSchemaMessage,
@@ -34,10 +36,12 @@ import {
} from '../core/column-schema';
import { type DatabaseViewColumn, isOptionColumn } from '../core/database-view';
import { columnDeleteNote } from '../core/forms-usage';
+import { defaultFormulaColumnName } from '../core/property-creation';
import {
ColumnTypeMenu,
type DatabaseColumnConversionChoice,
} from './column-type-menu';
+import { FormulaEditor } from './formula-editor';
import { createInlineRename } from './inline-rename';
import { OptionEditor } from './option-editor';
import { PropertyIcon } from './property-icon';
@@ -88,14 +92,24 @@ export function DatabaseColumnHeader(props: DatabaseColumnHeaderProps) {
const [converting, setConverting] =
createSignal<DatabaseColumnConversionChoice>();
const [optionsOpen, setOptionsOpen] = createSignal(false);
- /** The options open once the menu has closed, instead of the menu giving focus back. */
- let optionsRequested = false;
+ /** A new formula column takes this one's place, or goes beside it; an existing one is edited. */
+ const [formulaEditing, setFormulaEditing] = createSignal<
+ { kind: 'edit' } | { kind: 'create'; replace: boolean }
+ >();
+ const formulas = useFormulaEditing();
+ /** What opens once the menu has closed, instead of the menu giving focus back. */
+ let requested: 'options' | (() => void) | undefined;
const openRequestedOptions = (event: Event) => {
- if (!optionsRequested) return;
- optionsRequested = false;
+ const open = requested;
+ if (!open) return;
+ requested = undefined;
event.preventDefault();
- setOptionsOpen(true);
+ if (open === 'options') setOptionsOpen(true);
+ else open();
};
+ /** A formula may take the place of a column that never held a value, unless it is the table's only one. */
+ const formulaReplaces = () =>
+ !!props.column.inferType && (formulas?.columns().length ?? 0) > 1;
const editing = useOptionEditing();
const errorId = createUniqueId();
let header!: HTMLDivElement;
@@ -206,6 +220,18 @@ export function DatabaseColumnHeader(props: DatabaseColumnHeaderProps) {
},
]
: []),
+ ...(canRename() && formulas && props.column.formula
+ ? [
+ {
+ label: 'Edit formula',
+ icon: FunctionIcon,
+ group: 'edit',
+ run: () => {
+ requested = () => setFormulaEditing({ kind: 'edit' });
+ },
+ },
+ ]
+ : []),
...(canRename() && editing && isOptionColumn(props.column)
? [
{
@@ -213,7 +239,7 @@ export function DatabaseColumnHeader(props: DatabaseColumnHeaderProps) {
icon: ListBulletsIcon,
group: 'edit',
run: () => {
- optionsRequested = true;
+ requested = 'options';
},
},
]
@@ -348,6 +374,7 @@ export function DatabaseColumnHeader(props: DatabaseColumnHeaderProps) {
>
<PropertyIcon
relation={!!props.column.relation}
+ formula={!!props.column.formula}
type={props.column.dataType}
entityType={props.column.specificEntityType}
/>
@@ -427,7 +454,8 @@ export function DatabaseColumnHeader(props: DatabaseColumnHeaderProps) {
when={
group === 'edit' &&
props.onChangeType &&
- canRename()
+ canRename() &&
+ !props.column.formula
}
>
<ColumnTypeMenu
@@ -437,6 +465,18 @@ export function DatabaseColumnHeader(props: DatabaseColumnHeaderProps) {
props.columnCasts?.(props.column.id, open)
}
onChange={(change) => void changeType(change)}
+ onFormula={
+ formulas &&
+ (() => {
+ const replace = formulaReplaces();
+ requested = () =>
+ setFormulaEditing({
+ kind: 'create',
+ replace,
+ });
+ setMenuOpen(false);
+ })
+ }
onConvertToNewColumn={
props.onConvert &&
((choice) => {
@@ -462,6 +502,7 @@ export function DatabaseColumnHeader(props: DatabaseColumnHeaderProps) {
>
<PropertyIcon
relation={!!props.column.relation}
+ formula={!!props.column.formula}
type={props.column.dataType}
entityType={props.column.specificEntityType}
/>
@@ -589,6 +630,80 @@ export function DatabaseColumnHeader(props: DatabaseColumnHeaderProps) {
</Popover>
)}
</Show>
+ <Show when={formulas}>
+ {(editing) => (
+ <Popover
+ open={!!formulaEditing()}
+ onOpenChange={(open) => {
+ if (!open) setFormulaEditing(undefined);
+ }}
+ anchorRef={() => header}
+ placement="bottom-start"
+ gutter={4}
+ >
+ <Popover.Portal>
+ <Popover.Content
+ aria-label={
+ props.column.formula
+ ? `${props.column.name} formula`
+ : 'New formula column'
+ }
+ onFocusOutside={(event) => event.preventDefault()}
+ onCloseAutoFocus={(event) => {
+ event.preventDefault();
+ restoreFocus();
+ }}
+ class="z-action-menu rounded-lg border border-edge bg-menu shadow-menu outline-none"
+ >
+ <Show when={formulaEditing()}>
+ {(mode) => (
+ <FormulaEditor
+ tableId={editing().tableId}
+ columns={editing().columns()}
+ {...match(mode())
+ .with({ kind: 'edit' }, () => ({
+ own: props.column.id,
+ formula: props.column.formula,
+ }))
+ .with({ kind: 'create' }, ({ replace }) => ({
+ name: replace
+ ? props.column.name
+ : defaultFormulaColumnName(
+ editing()
+ .columns()
+ .map((column) => column.name)
+ ),
+ }))
+ .exhaustive()}
+ onCancel={() => setFormulaEditing(undefined)}
+ onSave={({ name, formula }) => {
+ const saved = match(mode())
+ .with({ kind: 'edit' }, () =>
+ editing().setFormula(props.column.id, formula)
+ )
+ .with({ kind: 'create' }, ({ replace }) =>
+ editing()
+ .createFormulaColumn({
+ name,
+ formula,
+ beside: props.column.id,
+ replace,
+ })
+ .map(() => undefined)
+ )
+ .exhaustive();
+ return saved.map(() => {
+ setFormulaEditing(undefined);
+ });
+ }}
+ />
+ )}
+ </Show>
+ </Popover.Content>
+ </Popover.Portal>
+ </Popover>
+ )}
+ </Show>
<ConfirmDialog
open={!!converting()}
onOpenChange={(open) => {
diff --git a/apps/web/src/features/database/components/formula-editor.test.tsx b/apps/web/src/features/database/components/formula-editor.test.tsx
new file mode 100644
index 0000000000..ec67575eeb
--- /dev/null
+++ b/apps/web/src/features/database/components/formula-editor.test.tsx
@@ -0,0 +1,147 @@
+import type {
+ Formula,
+ FormulaReading,
+} from '@core/database-sql/generated/types';
+import {
+ cleanup,
+ render,
+ screen,
+ waitFor,
+ within,
+} from '@solidjs/testing-library';
+import userEvent from '@testing-library/user-event';
+import { okAsync } from 'neverthrow';
+import { afterEach, describe, expect, it, vi } from 'vitest';
+import type { DatabaseViewColumn } from '../core/database-view';
+import { FormulaEditor } from './formula-editor';
+
+// The engine is wasm, which the test runner cannot load; this stands in for
+// its reading of the one formula the tests type.
+const total: Formula = {
+ kind: 'binary',
+ operator: 'multiply',
+ left: { kind: 'column', column: 'price' },
+ right: { kind: 'column', column: 'quantity' },
+};
+vi.mock('../core/formula', async (importOriginal) => ({
+ ...(await importOriginal<typeof import('../core/formula')>()),
+ loadFormulaTools: async () => ({
+ read: (text: string): FormulaReading =>
+ text === '{Unit price} * Quantity'
+ ? { status: 'valid', formula: total, result: 'number' }
+ : {
+ status: 'invalid',
+ message: 'The formula ends too soon.',
+ span: { start: text.length, end: text.length },
+ },
+ render: (formula: Formula) =>
+ formula.kind === 'column' && formula.column === 'price'
+ ? '{Unit price}'
+ : 'Quantity',
+ }),
+}));
+
+afterEach(cleanup);
+
+const columns: DatabaseViewColumn[] = [
+ {
+ id: 'name',
+ name: 'Name',
+ dataType: 'STRING',
+ isMultiSelect: false,
+ options: [],
+ writable: true,
+ },
+ {
+ id: 'price',
+ name: 'Unit price',
+ dataType: 'NUMBER',
+ isMultiSelect: false,
+ options: [],
+ writable: true,
+ },
+ {
+ id: 'quantity',
+ name: 'Quantity',
+ dataType: 'NUMBER',
+ isMultiSelect: false,
+ options: [],
+ writable: true,
+ },
+];
+
+describe('formula editor', () => {
+ it('suggests columns as their names are typed and saves the formula with its name', async () => {
+ const onSave = vi.fn(() => okAsync(undefined));
+ render(() => (
+ <FormulaEditor
+ tableId="orders"
+ columns={columns}
+ name="Total"
+ onSave={onSave}
+ onCancel={() => {}}
+ />
+ ));
+ const input = (await screen.findByRole('combobox', {
+ name: 'Formula',
+ })) as HTMLInputElement;
+ await waitFor(() => expect(input.disabled).toBe(false));
+
+ await userEvent.type(input, 'un');
+ const suggested = screen.getByRole('listbox', { name: 'Columns' });
+ expect(
+ within(suggested)
+ .getAllByRole('option')
+ .map((option) => option.textContent)
+ ).toEqual(['Unit price']);
+ await userEvent.keyboard('{Enter}');
+ expect(input.value).toBe('{Unit price}');
+ expect(screen.queryByRole('listbox')).toBeNull();
+
+ // Only number and date columns are suggested.
+ await userEvent.type(input, ' * na');
+ expect(screen.queryByRole('listbox')).toBeNull();
+ expect(screen.getByText('The formula ends too soon.')).toBeTruthy();
+ const save = screen.getByRole('button', { name: 'Save' });
+ expect((save as HTMLButtonElement).disabled).toBe(true);
+
+ await userEvent.type(input, '{Backspace}{Backspace}q');
+ await userEvent.keyboard('{Tab}');
+ expect(input.value).toBe('{Unit price} * Quantity');
+ expect(screen.getByText('number')).toBeTruthy();
+
+ await userEvent.click(save);
+ expect(onSave).toHaveBeenCalledExactlyOnceWith({
+ name: 'Total',
+ formula: total,
+ });
+ });
+
+ it('edits an existing formula, saving on Enter only once it changed', async () => {
+ const onSave = vi.fn(() => okAsync(undefined));
+ render(() => (
+ <FormulaEditor
+ tableId="orders"
+ columns={columns}
+ own="total"
+ formula={{ kind: 'column', column: 'quantity' }}
+ onSave={onSave}
+ onCancel={() => {}}
+ />
+ ));
+ const input = (await screen.findByDisplayValue(
+ 'Quantity'
+ )) as HTMLInputElement;
+ expect(screen.queryByRole('textbox', { name: 'Column name' })).toBeNull();
+
+ await userEvent.type(input, '{Enter}');
+ expect(onSave).not.toHaveBeenCalled();
+
+ await userEvent.clear(input);
+ await userEvent.type(input, '{{Unit price} * Quantity{Enter}');
+ expect(onSave).toHaveBeenCalledExactlyOnceWith({
+ name: '',
+ formula: total,
+ });
+ });
+});
diff --git a/apps/web/src/features/database/components/formula-editor.tsx b/apps/web/src/features/database/components/formula-editor.tsx
new file mode 100644
index 0000000000..5f3dfdf4c8
--- /dev/null
+++ b/apps/web/src/features/database/components/formula-editor.tsx
@@ -0,0 +1,359 @@
+import type { Formula } from '@core/database-sql/generated/types';
+import FunctionIcon from '@phosphor/function.svg';
+import { Button } from '@ui/components/Button';
+import { inputClasses } from '@ui/components/Input';
+import {
+ createSignal,
+ createUniqueId,
+ For,
+ Match,
+ onMount,
+ Show,
+ Switch,
+} from 'solid-js';
+import {
+ columnSchemaMessage,
+ type DatabaseSchemaChange,
+} from '../core/column-schema';
+import type { DatabaseViewColumn } from '../core/database-view';
+import {
+ type FormulaTools,
+ formulaCompletion,
+ formulaInputs,
+ loadFormulaTools,
+} from '../core/formula';
+import { PropertyIcon } from './property-icon';
+
+/**
+ * Writes a derived column's formula, suggesting columns as their names are
+ * typed and checking it with the engine on every change.
+ */
+export function FormulaEditor(props: {
+ tableId: string;
+ columns: readonly DatabaseViewColumn[];
+ /** The derived column being edited; a new one has none. */
+ own?: string;
+ /** Asked for when the column is new. */
+ name?: string;
+ formula?: Formula;
+ onSave: (change: { name: string; formula: Formula }) => DatabaseSchemaChange;
+ onCancel: () => void;
+}) {
+ const [tools, setTools] = createSignal<FormulaTools>();
+ const [loadError, setLoadError] = createSignal(false);
+ const [name, setName] = createSignal(props.name ?? '');
+ const [text, setText] = createSignal('');
+ const [initial, setInitial] = createSignal('');
+ const [pending, setPending] = createSignal(false);
+ const [saveError, setSaveError] = createSignal('');
+ const [caret, setCaret] = createSignal(0);
+ const [focused, setFocused] = createSignal(false);
+ /** Escape hides the suggestions until the next edit. */
+ const [dismissed, setDismissed] = createSignal(false);
+ const [active, setActive] = createSignal(0);
+ const statusId = createUniqueId();
+ const listId = createUniqueId();
+ let input!: HTMLInputElement;
+
+ onMount(async () => {
+ let loaded: FormulaTools;
+ try {
+ loaded = await loadFormulaTools(props.tableId, props.columns);
+ } catch {
+ setLoadError(true);
+ return;
+ }
+ setTools(() => loaded);
+ if (props.formula) {
+ const rendered = loaded.render(props.formula);
+ setText(rendered);
+ setInitial(rendered);
+ }
+ // Enabled now; the name comes first for a new column.
+ queueMicrotask(() => {
+ if (!naming()) input.focus();
+ });
+ });
+
+ const reading = () => {
+ const loaded = tools();
+ if (!loaded || !text().trim()) return undefined;
+ return loaded.read(text(), props.own);
+ };
+ const valid = () => {
+ const read = reading();
+ return read?.status === 'valid' ? read : undefined;
+ };
+ const invalid = () => {
+ const read = reading();
+ return read?.status === 'invalid' ? read : undefined;
+ };
+ const naming = () => props.name !== undefined;
+ const canSave = () =>
+ !!valid() &&
+ !pending() &&
+ (!naming() || !!name().trim()) &&
+ (naming() || text() !== initial());
+
+ const completion = () =>
+ focused() && !dismissed() && tools()
+ ? formulaCompletion(
+ text(),
+ caret(),
+ formulaInputs(props.columns, props.own)
+ )
+ : undefined;
+ const activeIndex = () =>
+ Math.min(active(), (completion()?.matches.length ?? 1) - 1);
+ const optionId = (index: number) => `${listId}-${index}`;
+
+ function edit(value: string, at: number) {
+ setText(value);
+ setCaret(at);
+ setActive(0);
+ setDismissed(false);
+ }
+
+ /** Replace the partly typed name with `column`, as the formula writes it. */
+ function accept(column: DatabaseViewColumn) {
+ const loaded = tools();
+ const open = completion();
+ if (!loaded || !open) return;
+ const reference = loaded.render({ kind: 'column', column: column.id });
+ const value =
+ text().slice(0, open.start) + reference + text().slice(caret());
+ const at = open.start + reference.length;
+ edit(value, at);
+ queueMicrotask(() => input.setSelectionRange(at, at));
+ }
+
+ /** Put `insertion` at the caret, spaced from what is around it. */
+ function insert(insertion: string) {
+ const start = input.selectionStart ?? text().length;
+ const end = input.selectionEnd ?? start;
+ const before = text().slice(0, start);
+ const after = text().slice(end);
+ const lead = before && !/[\s(]$/.test(before) ? ' ' : '';
+ const trail = after && !/^[\s)]/.test(after) ? ' ' : '';
+ const inserted = `${lead}${insertion}${trail}`;
+ const at = before.length + inserted.length;
+ edit(before + inserted + after, at);
+ input.focus();
+ queueMicrotask(() => input.setSelectionRange(at, at));
+ }
+
+ async function save() {
+ const formula = valid()?.formula;
+ if (!formula || !canSave()) return;
+ setPending(true);
+ setSaveError('');
+ const saved = await props.onSave({ name: name().trim(), formula });
+ setPending(false);
+ if (saved.isErr()) setSaveError(columnSchemaMessage(saved.error));
+ }
+
+ const onFormulaKeyDown = (event: KeyboardEvent) => {
+ const open = completion();
+ if (!open || event.isComposing) return onKeyDown(event);
+ const count = open.matches.length;
+ if (event.key === 'ArrowDown' || event.key === 'ArrowUp') {
+ event.preventDefault();
+ event.stopPropagation();
+ const step = event.key === 'ArrowDown' ? 1 : count - 1;
+ setActive((activeIndex() + step) % count);
+ } else if (event.key === 'Enter' || event.key === 'Tab') {
+ event.preventDefault();
+ event.stopPropagation();
+ accept(open.matches[activeIndex()]);
+ } else if (event.key === 'Escape') {
+ event.preventDefault();
+ event.stopPropagation();
+ setDismissed(true);
+ } else {
+ onKeyDown(event);
+ }
+ };
+
+ const onKeyDown = (event: KeyboardEvent) => {
+ event.stopPropagation();
+ if (event.isComposing) return;
+ if (event.key === 'Enter') {
+ event.preventDefault();
+ void save();
+ } else if (event.key === 'Escape') {
+ event.preventDefault();
+ props.onCancel();
+ }
+ };
+
+ return (
+ <div class="flex w-[22rem] max-w-[calc(100vw-2rem)] flex-col gap-3 p-3 text-xs text-ink">
+ <div class="flex items-center gap-2 font-medium">
+ <FunctionIcon class="size-4 text-ink-muted" />
+ {props.own ? 'Edit formula' : 'New formula column'}
+ </div>
+ <Show when={naming()}>
+ <label class="flex flex-col gap-1">
+ <span class="text-ink-muted">Name</span>
+ <input
+ class={inputClasses({ size: 'sm' })}
+ value={name()}
+ maxlength={200}
+ aria-label="Column name"
+ ref={(element) => queueMicrotask(() => element.select())}
+ onInput={(event) => setName(event.currentTarget.value)}
+ onKeyDown={onKeyDown}
+ />
+ </label>
+ </Show>
+ <label class="flex flex-col gap-1">
+ <span class="text-ink-muted">Formula</span>
+ <div class="relative">
+ <input
+ ref={input}
+ class={inputClasses({ size: 'md', class: 'font-mono text-sm' })}
+ value={text()}
+ spellcheck={false}
+ autocomplete="off"
+ role="combobox"
+ aria-label="Formula"
+ aria-autocomplete="list"
+ aria-expanded={!!completion()}
+ aria-controls={listId}
+ aria-activedescendant={
+ completion() ? optionId(activeIndex()) : undefined
+ }
+ aria-invalid={!!invalid()}
+ aria-describedby={statusId}
+ disabled={!tools()}
+ onInput={(event) =>
+ edit(
+ event.currentTarget.value,
+ event.currentTarget.selectionStart ?? 0
+ )
+ }
+ onKeyUp={(event) =>
+ setCaret(event.currentTarget.selectionStart ?? 0)
+ }
+ onClick={(event) =>
+ setCaret(event.currentTarget.selectionStart ?? 0)
+ }
+ onFocus={() => setFocused(true)}
+ onBlur={() => setFocused(false)}
+ onKeyDown={onFormulaKeyDown}
+ />
+ <Show when={completion()}>
+ {(open) => (
+ <ul
+ id={listId}
+ role="listbox"
+ aria-label="Columns"
+ class="absolute top-full right-0 left-0 z-1 mt-1 max-h-48 overflow-y-auto rounded-lg border border-edge bg-menu p-1 shadow-menu"
+ >
+ <For each={open().matches}>
+ {(column, index) => (
+ <li
+ id={optionId(index())}
+ role="option"
+ aria-selected={index() === activeIndex()}
+ class="flex h-7 items-center gap-1.5 rounded-md px-2 aria-selected:bg-hover"
+ // Keep focus in the formula while picking.
+ onMouseDown={(event) => event.preventDefault()}
+ onMouseEnter={() => setActive(index())}
+ onClick={() => accept(column)}
+ >
+ <PropertyIcon
+ type={column.dataType}
+ formula={!!column.formula}
+ class="size-3.5 shrink-0 text-ink-muted"
+ />
+ <span class="truncate">{column.name}</span>
+ </li>
+ )}
+ </For>
+ </ul>
+ )}
+ </Show>
+ </div>
+ <p id={statusId} class="min-h-4" aria-live="polite">
+ <Switch>
+ <Match when={loadError()}>
+ <span class="text-failure-ink">
+ Formulas could not load. Try again.
+ </span>
+ </Match>
+ <Match when={valid()}>
+ {(read) => (
+ <span class="text-ink-muted">
+ Gives a{' '}
+ <span class="font-medium text-ink">{read().result}</span>
+ </span>
+ )}
+ </Match>
+ <Match when={invalid()}>
+ {(read) => <span class="text-failure-ink">{read().message}</span>}
+ </Match>
+ </Switch>
+ </p>
+ </label>
+ <div class="flex flex-col gap-1.5">
+ <span class="text-ink-muted">Columns</span>
+ <div class="flex max-h-28 flex-wrap gap-1 overflow-y-auto">
+ <For
+ each={formulaInputs(props.columns, props.own)}
+ fallback={
+ <span class="text-ink-placeholder">
+ Add a number or date column to use it here.
+ </span>
+ }
+ >
+ {(column) => (
+ <Button
+ variant="outline"
+ size="xs"
+ disabled={!tools()}
+ onClick={() => {
+ const loaded = tools();
+ if (loaded)
+ insert(
+ loaded.render({ kind: 'column', column: column.id })
+ );
+ }}
+ >
+ <PropertyIcon
+ type={column.dataType}
+ formula={!!column.formula}
+ class="size-3 shrink-0 text-ink-muted"
+ />
+ <span class="max-w-40 truncate">{column.name}</span>
+ </Button>
+ )}
+ </For>
+ </div>
+ <p class="text-ink-placeholder">
+ Add days to a date with <code class="font-mono">Due + 7</code>; count
+ the days between dates with <code class="font-mono">Due - Start</code>
+ .
+ </p>
+ </div>
+ <Show when={saveError()}>
+ <p role="alert" class="text-failure-ink">
+ {saveError()}
+ </p>
+ </Show>
+ <div class="flex justify-end gap-2">
+ <Button variant="ghost" size="sm" onClick={() => props.onCancel()}>
+ Cancel
+ </Button>
+ <Button
+ variant="cta"
+ size="sm"
+ disabled={!canSave()}
+ onClick={() => void save()}
+ >
+ {pending() ? 'Saving…' : 'Save'}
+ </Button>
+ </div>
+ </div>
+ );
+}
diff --git a/apps/web/src/features/database/components/property-icon.tsx b/apps/web/src/features/database/components/property-icon.tsx
index 5e737073be..f94c3b54f9 100644
--- a/apps/web/src/features/database/components/property-icon.tsx
+++ b/apps/web/src/features/database/components/property-icon.tsx
@@ -1,3 +1,4 @@
+import FunctionIcon from '@phosphor/function.svg';
import LinkIcon from '@phosphor/link-simple.svg';
import { PropertyDataTypeIcon } from '@property/utils/PropertyDataTypeIcon';
import { DataType } from '@service-properties/generated/schemas/dataType';
@@ -7,11 +8,12 @@ import type { DatabaseEntityType } from '../core/column-inference';
const dataTypes = new Set<string>(Object.values(DataType));
const isDataType = (type: string): type is DataType => dataTypes.has(type);
-/** A column's type icon: the shared property icon, or a link for relations. */
+/** A column's type icon: the shared property icon, a link for relations, or ƒ for formulas. */
export function PropertyIcon(props: {
type: string;
entityType?: DatabaseEntityType | null;
relation?: boolean;
+ formula?: boolean;
class?: string;
}) {
const valueType = () => (isDataType(props.type) ? props.type : 'STRING');
@@ -20,14 +22,16 @@ export function PropertyIcon(props: {
aria-hidden="true"
class={props.class ?? 'size-3.5 shrink-0 text-ink-muted'}
>
- <Show when={!props.relation} fallback={<LinkIcon class="size-full" />}>
- <PropertyDataTypeIcon
- property={{
- valueType: valueType(),
- specificEntityType: props.entityType,
- }}
- class="size-full"
- />
+ <Show when={!props.formula} fallback={<FunctionIcon class="size-full" />}>
+ <Show when={!props.relation} fallback={<LinkIcon class="size-full" />}>
+ <PropertyDataTypeIcon
+ property={{
+ valueType: valueType(),
+ specificEntityType: props.entityType,
+ }}
+ class="size-full"
+ />
+ </Show>
</Show>
</span>
);
diff --git a/apps/web/src/features/database/context/formula-editing.ts b/apps/web/src/features/database/context/formula-editing.ts
new file mode 100644
index 0000000000..4cc2e99fec
--- /dev/null
+++ b/apps/web/src/features/database/context/formula-editing.ts
@@ -0,0 +1,31 @@
+import type { Formula } from '@core/database-sql/generated/types';
+import { type Accessor, createContext, useContext } from 'solid-js';
+import type { DatabaseSchemaChange } from '../core/column-schema';
+import type { DatabaseViewColumn } from '../core/database-view';
+
+/** A formula column to add next to `beside`, or in its place. */
+export type NewFormulaColumn = {
+ name: string;
+ formula: Formula;
+ beside: string;
+ /** Take `beside`'s place: only for a column that never held a value. */
+ replace: boolean;
+};
+
+/** Derived columns of the table the grid shows. */
+export type FormulaEditing = {
+ tableId: string;
+ /** Every column of the table, in table order, hidden ones too. */
+ columns: Accessor<readonly DatabaseViewColumn[]>;
+ setFormula: (columnId: string, formula: Formula) => DatabaseSchemaChange;
+ createFormulaColumn: (
+ column: NewFormulaColumn
+ ) => DatabaseSchemaChange<string>;
+};
+
+export const FormulaEditingContext = createContext<FormulaEditing>();
+
+/** Formula editing where the grid offers it; viewers and tests have none. */
+export function useFormulaEditing(): FormulaEditing | undefined {
+ return useContext(FormulaEditingContext);
+}
diff --git a/apps/web/src/features/database/core/database-view.ts b/apps/web/src/features/database/core/database-view.ts
index 194195a565..5a9d3965ea 100644
--- a/apps/web/src/features/database/core/database-view.ts
+++ b/apps/web/src/features/database/core/database-view.ts
@@ -1,3 +1,4 @@
+import type { Formula } from '@core/database-sql/generated/types';
import type { DataType } from '@service-storage/generated/schemas/dataType';
import type { DatabaseEntityType } from './column-inference';
import { relatedRowIds } from './database-relations';
@@ -30,6 +31,8 @@ export type DatabaseViewColumn = {
protections?: ('delete' | 'change_type')[];
/** The column's definition is used beyond this database, so its options change everywhere. */
sharedOutsideDatabase?: boolean;
+ /** A derived column's formula: its cells are computed, and nothing writes them. */
+ formula?: Formula;
/** A relationship points to rows in a table, independently of the property's scalar type. */
relation?: {
databaseId: string;
diff --git a/apps/web/src/features/database/core/formula.test.ts b/apps/web/src/features/database/core/formula.test.ts
new file mode 100644
index 0000000000..4ec0541873
--- /dev/null
+++ b/apps/web/src/features/database/core/formula.test.ts
@@ -0,0 +1,45 @@
+import { describe, expect, it } from 'vitest';
+import type { DatabaseViewColumn } from './database-view';
+import { formulaCompletion } from './formula';
+
+const column = (id: string, name: string): DatabaseViewColumn => ({
+ id,
+ name,
+ dataType: 'NUMBER',
+ isMultiSelect: false,
+ options: [],
+ writable: true,
+});
+const columns = [
+ column('testa', 'Testa'),
+ column('price', 'Unit price'),
+ column('latest', 'Latest total'),
+];
+
+describe('formula completion', () => {
+ it('offers columns starting with the word being typed, then those containing it', () => {
+ expect(formulaCompletion('te', 2, columns)).toEqual({
+ start: 0,
+ matches: [columns[0], columns[2]],
+ });
+ expect(formulaCompletion('Testa * un', 10, columns)).toEqual({
+ start: 8,
+ matches: [columns[1]],
+ });
+ });
+
+ it('completes a braced name, spaces included', () => {
+ expect(formulaCompletion('2 * {unit p', 11, columns)).toEqual({
+ start: 4,
+ matches: [columns[1]],
+ });
+ expect(formulaCompletion('{', 1, columns)?.matches).toEqual(columns);
+ });
+
+ it('offers nothing after an operator, a complete name or a closed brace', () => {
+ expect(formulaCompletion('Testa * ', 8, columns)).toBeUndefined();
+ expect(formulaCompletion('testa', 5, columns)).toBeUndefined();
+ expect(formulaCompletion('{Unit price}', 12, columns)).toBeUndefined();
+ expect(formulaCompletion('zz', 2, columns)).toBeUndefined();
+ });
+});
diff --git a/apps/web/src/features/database/core/formula.ts b/apps/web/src/features/database/core/formula.ts
new file mode 100644
index 0000000000..c73988dc20
--- /dev/null
+++ b/apps/web/src/features/database/core/formula.ts
@@ -0,0 +1,136 @@
+/**
+ * Derived columns in the editor: the engine reads and renders their formulas
+ * against a catalog of the one table, built from the columns the grid has, so
+ * every host that draws columns can edit formulas.
+ */
+
+import type {
+ Catalog,
+ ColumnKind,
+ Formula,
+ FormulaReading,
+} from '@core/database-sql/generated/types';
+import { loadDatabaseSqlWasm } from '@core/database-sql/wasm-module';
+import { match, P } from 'ts-pattern';
+import type { DatabaseViewColumn } from './database-view';
+
+/** A table's formulas, read and rendered by the engine once it has loaded. */
+export type FormulaTools = {
+ /** What `text` reads as for the derived column `own`, or a new one. */
+ read(text: string, own?: string): FormulaReading;
+ /** `formula` as users write it, with the current column names. */
+ render(formula: Formula): string;
+};
+
+/** The engine's formula tools for `columns` of `tableId`, loading it on first use. */
+export async function loadFormulaTools(
+ tableId: string,
+ columns: readonly DatabaseViewColumn[]
+): Promise<FormulaTools> {
+ const wasm = await loadDatabaseSqlWasm();
+ const catalog = formulaCatalog(tableId, columns);
+ return {
+ read: (text, own) => wasm.readFormula(catalog, tableId, own, text),
+ render: (formula) => wasm.renderFormula(catalog, tableId, formula),
+ };
+}
+
+/** The columns a formula can use: numbers, dates and other derived columns. */
+export function formulaInputs(
+ columns: readonly DatabaseViewColumn[],
+ own?: string
+): DatabaseViewColumn[] {
+ return columns.filter(
+ (column) =>
+ column.id !== own &&
+ !column.relation &&
+ (column.dataType === 'NUMBER' || column.dataType === 'DATE')
+ );
+}
+
+/**
+ * A catalog holding only this table. Formulas name columns by placement, so
+ * the placement stands in for the definition too.
+ */
+export function formulaCatalog(
+ tableId: string,
+ columns: readonly DatabaseViewColumn[]
+): Catalog {
+ return {
+ tables: [
+ {
+ id: tableId,
+ databaseId: tableId,
+ database: '',
+ name: '',
+ columns: columns.map((column) => ({
+ id: column.id,
+ placement: column.id,
+ name: column.name,
+ kind: engineKind(column),
+ ...(column.formula ? { formula: column.formula } : {}),
+ })),
+ },
+ ],
+ };
+}
+
+function engineKind(column: DatabaseViewColumn): ColumnKind {
+ if (column.relation)
+ return { kind: 'entity', multi: true, target: 'DATABASE_ROW' };
+ return match(column.dataType)
+ .returnType<ColumnKind>()
+ .with('STRING', () => ({ kind: 'text' }))
+ .with('NUMBER', () => ({ kind: 'number' }))
+ .with('BOOLEAN', () => ({ kind: 'boolean' }))
+ .with('DATE', () => ({ kind: 'date' }))
+ .with('LINK', () => ({ kind: 'link' }))
+ .with(P.union('SELECT_STRING', 'SELECT_NUMBER', 'TAG'), () => ({
+ kind: 'select',
+ multi: column.isMultiSelect,
+ options: [],
+ }))
+ .with('ENTITY', () => ({
+ kind: 'entity',
+ multi: column.isMultiSelect,
+ target: column.specificEntityType ?? 'USER',
+ }))
+ .exhaustive();
+}
+
+/** Columns the name being typed at the caret could mean, and where it starts. */
+export type FormulaCompletion = {
+ /** Where the partial name starts, its `{` included. */
+ start: number;
+ matches: DatabaseViewColumn[];
+};
+
+/**
+ * The columns matching the name typed just before `caret`: a word, or
+ * anything after an unclosed `{`. Names starting with it come first, then
+ * names containing it. Nothing is offered once the name is complete.
+ */
+export function formulaCompletion(
+ text: string,
+ caret: number,
+ columns: readonly DatabaseViewColumn[]
+): FormulaCompletion | undefined {
+ const before = text.slice(0, caret);
+ const braced = /\{([^{}]*)$/.exec(before);
+ const word = braced ? undefined : /[\p{L}_][\p{L}\p{N}_]*$/u.exec(before);
+ const found = braced ?? word;
+ if (!found) return undefined;
+ const query = (braced ? braced[1] : found[0]).trim().toLocaleLowerCase();
+ if (!braced && !query) return undefined;
+ const named = (column: DatabaseViewColumn) => column.name.toLocaleLowerCase();
+ if (!braced && columns.some((column) => named(column) === query))
+ return undefined;
+ const matches = [
+ ...columns.filter((column) => named(column).startsWith(query)),
+ ...columns.filter(
+ (column) =>
+ !named(column).startsWith(query) && named(column).includes(query)
+ ),
+ ];
+ return matches.length ? { start: found.index, matches } : undefined;
+}
diff --git a/apps/web/src/features/database/core/property-creation.ts b/apps/web/src/features/database/core/property-creation.ts
index c7e054368c..5b9aa91dff 100644
--- a/apps/web/src/features/database/core/property-creation.ts
+++ b/apps/web/src/features/database/core/property-creation.ts
@@ -14,3 +14,10 @@ export function defaultDatabaseColumnName(names: readonly string[]): string {
while (isDatabaseNameTaken(name, names)) name = `Unnamed ${suffix++}`;
return name;
}
+
+export function defaultFormulaColumnName(names: readonly string[]): string {
+ let name = 'Formula';
+ let suffix = 2;
+ while (isDatabaseNameTaken(name, names)) name = `Formula ${suffix++}`;
+ return name;
+}
diff --git a/apps/web/src/features/database/primitives/database-controller.ts b/apps/web/src/features/database/primitives/database-controller.ts
index bc716eb5ed..0c29f06f2f 100644
--- a/apps/web/src/features/database/primitives/database-controller.ts
+++ b/apps/web/src/features/database/primitives/database-controller.ts
@@ -2,6 +2,7 @@ import type { DatabaseOp } from '@core/database-sql/generated/types';
import { errAsync, ok } from 'neverthrow';
import type { Accessor } from 'solid-js';
import { v7 as uuidv7 } from 'uuid';
+import type { FormulaEditing } from '../context/formula-editing';
import type { OptionEditing } from '../context/option-editing';
import type { DatabaseApi, DatabaseCapabilities } from '../core/api';
import { mergeDatabaseColumnOrder } from '../core/column-order';
@@ -104,6 +105,47 @@ export function createDatabaseController(args: {
);
},
};
+ const formulaEditing: FormulaEditing = {
+ tableId,
+ columns: () => data.table()?.columns ?? [],
+ setFormula: (column, formula) =>
+ change(column, { kind: 'set_formula', formula }),
+ createFormulaColumn: ({ name, formula, beside, replace }) => {
+ const column = uuidv7();
+ const create: DatabaseOp = {
+ kind: 'column',
+ table: tableId,
+ column,
+ change: {
+ kind: 'create',
+ definition: { source: 'derived', name, formula },
+ ...(replace ? {} : { after: beside }),
+ },
+ };
+ const ops: DatabaseOp[] = replace
+ ? [
+ {
+ kind: 'column',
+ table: tableId,
+ column: beside,
+ change: { kind: 'delete' },
+ },
+ create,
+ {
+ kind: 'table',
+ table: tableId,
+ change: {
+ kind: 'reorder_columns',
+ order: (data.table()?.columns ?? []).map((existing) =>
+ existing.id === beside ? column : existing.id
+ ),
+ },
+ },
+ ]
+ : [create];
+ return schemaApply(ops, data.table()?.version).map(() => column);
+ },
+ };
const optionEditing: OptionEditing = {
update: (column, option, request) =>
change(column, { kind: 'update_option', option, ...request }).mapErr(
@@ -119,6 +161,8 @@ export function createDatabaseController(args: {
data,
optionEditing: () =>
args.capabilities().editColumns ? optionEditing : undefined,
+ formulaEditing: () =>
+ args.capabilities().editColumns ? formulaEditing : undefined,
capabilities: args.capabilities,
apply,
schemaEditing: () =>
diff --git a/apps/web/src/features/database/queries/column-detail.ts b/apps/web/src/features/database/queries/column-detail.ts
index 56511b3c0f..ef84ac77ad 100644
--- a/apps/web/src/features/database/queries/column-detail.ts
+++ b/apps/web/src/features/database/queries/column-detail.ts
@@ -2,8 +2,9 @@ import type { ColumnDetail } from '@service-storage/generated/schemas/columnDeta
import type { DatabaseViewColumn } from '../core/database-view';
export function toViewColumn(column: ColumnDetail): DatabaseViewColumn {
- const relation =
- column.column.config?.kind === 'link' ? column.column.config : undefined;
+ const config = column.column.config;
+ const relation = config?.kind === 'link' ? config : undefined;
+ const formula = config?.kind === 'derived' ? config.formula : undefined;
return {
id: column.column.id,
name:
@@ -15,8 +16,9 @@ export function toViewColumn(column: ColumnDetail): DatabaseViewColumn {
label: String(option.value.value),
color: option.color,
})),
- writable: column.writable,
+ writable: column.writable && !formula,
sharedOutsideDatabase: column.shared_outside_database,
+ ...(formula ? { formula } : {}),
...(relation
? {
relation: {
diff --git a/apps/web/src/features/database/views/database-records.tsx b/apps/web/src/features/database/views/database-records.tsx
index 0dfa793e22..19b6044093 100644
--- a/apps/web/src/features/database/views/database-records.tsx
+++ b/apps/web/src/features/database/views/database-records.tsx
@@ -1,6 +1,7 @@
import { Show } from 'solid-js';
import { AddColumnButton } from '../components/add-column-button';
import { useDatabase } from '../context/database';
+import { FormulaEditingContext } from '../context/formula-editing';
import {
OptionEditingContext,
useOptionEditing,
@@ -31,32 +32,34 @@ export function DatabaseRecords(props: HostProps) {
<OptionEditingContext.Provider
value={hostOptions ?? database.optionEditing()}
>
- <DatabaseRecordsView
- {...props}
- name={database.data.table()?.name ?? ''}
- source={database.data.rows}
- canEdit={database.capabilities().editRows}
- onChangeColumnType={database.schemaEditing()?.changeType}
- onDeleteColumn={database.schemaEditing()?.remove}
- onReorderColumns={database.schemaEditing()?.reorder}
- onRenameColumn={database.schemaEditing()?.rename}
- createColumn={database.schemaEditing()?.createDefaultColumn}
- addColumn={
- database.schemaEditing()
- ? (label, onCreated) => (
- <Show when={database.schemaEditing()}>
- {(schema) => (
- <AddColumnButton
- create={schema().createDefaultColumn}
- label={label}
- onCreated={onCreated}
- />
- )}
- </Show>
- )
- : undefined
- }
- />
+ <FormulaEditingContext.Provider value={database.formulaEditing()}>
+ <DatabaseRecordsView
+ {...props}
+ name={database.data.table()?.name ?? ''}
+ source={database.data.rows}
+ canEdit={database.capabilities().editRows}
+ onChangeColumnType={database.schemaEditing()?.changeType}
+ onDeleteColumn={database.schemaEditing()?.remove}
+ onReorderColumns={database.schemaEditing()?.reorder}
+ onRenameColumn={database.schemaEditing()?.rename}
+ createColumn={database.schemaEditing()?.createDefaultColumn}
+ addColumn={
+ database.schemaEditing()
+ ? (label, onCreated) => (
+ <Show when={database.schemaEditing()}>
+ {(schema) => (
+ <AddColumnButton
+ create={schema().createDefaultColumn}
+ label={label}
+ onCreated={onCreated}
+ />
+ )}
+ </Show>
+ )
+ : undefined
+ }
+ />
+ </FormulaEditingContext.Provider>
</OptionEditingContext.Provider>
);
}
diff --git a/apps/web/src/lib/core/database-sql/catalog.ts b/apps/web/src/lib/core/database-sql/catalog.ts
index 4748ca102e..c62b784b79 100644
--- a/apps/web/src/lib/core/database-sql/catalog.ts
+++ b/apps/web/src/lib/core/database-sql/catalog.ts
@@ -28,6 +28,9 @@ export function databaseSqlSchema(
value: option.value,
order: option.display_order,
})),
+ ...(column.config?.kind === 'derived'
+ ? { formula: column.config.formula }
+ : {}),
})),
})),
})),
diff --git a/apps/web/src/lib/core/database-sql/generated/types.ts b/apps/web/src/lib/core/database-sql/generated/types.ts
index ec1a35c4aa..5f7aaa2e18 100644
--- a/apps/web/src/lib/core/database-sql/generated/types.ts
+++ b/apps/web/src/lib/core/database-sql/generated/types.ts
@@ -128,8 +128,13 @@ export type Column = {
placement: ColumnId;
/** The column's display name. */
name: string;
- /** What the column holds. */
+ /**
+ * What the column holds; for a derived column, what its formula
+ * yields.
+ */
kind: ColumnKind;
+ /** For a derived column, how its cells are computed: it stores none. */
+ formula?: Formula | null;
};
/** A change to one column. */
@@ -213,6 +218,15 @@ export type ColumnChange =
*/
color?: string | null;
}
+ /**
+ * Give a derived column a new formula. Its cells follow at once: it
+ * stores none.
+ */
+ | {
+ kind: 'set_formula';
+ /** The formula, over the table's other columns. */
+ formula: Formula;
+ }
/**
* Remove one option of a select or tag column, and take it out of every
* cell holding it: a single-valued cell is emptied, a multi-valued one
@@ -283,7 +297,9 @@ export type ColumnResult =
/** One of its options was relabelled or recoloured. */
| { kind: 'option_updated' }
/** One of its options was removed. */
- | { kind: 'option_deleted' };
+ | { kind: 'option_deleted' }
+ /** Its formula changed. */
+ | { kind: 'formula_set' };
/** One column placement and the property definition behind it. */
export type ColumnSchema = {
@@ -297,6 +313,11 @@ export type ColumnSchema = {
property: PropertyType;
/** The definition's options, in any order. */
options: OptionSchema[];
+ /**
+ * For a derived column, its formula; its definition says what the
+ * formula yields.
+ */
+ formula?: Formula | null;
};
/** How a group's conditions combine. */
@@ -587,6 +608,69 @@ export type FilterTest =
entities: string[];
};
+/** An expression over one row's cells. */
+export type Formula =
+ /**
+ * The row's cell in another column of the table: a number, date or
+ * derived column.
+ */
+ | {
+ kind: 'column';
+ /** The column placement. */
+ column: ColumnId;
+ }
+ /** A constant. Added to or subtracted from a date, it counts days. */
+ | {
+ kind: 'number';
+ /** The value; finite. */
+ value: number;
+ }
+ /** Two expressions combined. */
+ | {
+ kind: 'binary';
+ /** How. */
+ operator: Operator;
+ /** The left operand. */
+ left: Formula;
+ /** The right operand. */
+ right: Formula;
+ }
+ /** An expression's negation. */
+ | {
+ kind: 'negate';
+ /** The expression negated; a number. */
+ operand: Formula;
+ };
+
+/** What a formula typed into a derived column's editor reads as. */
+export type FormulaReading =
+ /** It parses and its types fit. */
+ | {
+ status: 'valid';
+ /** The formula, columns by id. */
+ formula: Formula;
+ /** What its cells hold. */
+ result: FormulaType;
+ }
+ /** It does not, and why. */
+ | {
+ status: 'invalid';
+ /** What is wrong, in words for the person typing. */
+ message: string;
+ /**
+ * The part of the text it is about, in UTF-16 code units as a
+ * browser counts them, when it is about a part.
+ */
+ span?: Span | null;
+ };
+
+/** What a formula's cells hold. */
+export type FormulaType =
+ /** A number. */
+ | 'number'
+ /** A date-time. */
+ | 'date';
+
/** Every GraphQL query a plan can send. */
export type GqlQuery =
/** `Query.soup` scoped to one table, paged to completion. */
@@ -646,7 +730,9 @@ export type Input =
/** What a view's read produced. */
| 'outcome'
/** The stored positions of a board's cards. */
- | 'positions';
+ | 'positions'
+ /** A derived column's formula, or the table or column it is for. */
+ | 'formula';
/** The values a joined relation is matched on. */
export type KeyHint = {
@@ -703,6 +789,20 @@ export type NewColumn =
*/
inferType?: boolean;
}
+ /**
+ * A derived column: its cells are what `formula` computes from the
+ * row's other cells, and nothing writes them.
+ */
+ | {
+ source: 'derived';
+ /** The column's name, unique within the table ignoring case. */
+ name: string;
+ /**
+ * How its cells are computed: arithmetic over the table's number,
+ * date and other derived columns.
+ */
+ formula: Formula;
+ }
/**
* An existing property, a person's, a team's or a system one, bound
* into the table under its own name.
@@ -929,7 +1029,20 @@ export type OpResultKind =
/** [`ViewResult::CardMoved`] of an [`OpResult::View`]. */
| 'cardMoved'
/** [`OpResult::ReorderTables`]. */
- | 'tablesReordered';
+ | 'tablesReordered'
+ /** [`ColumnResult::FormulaSet`] of an [`OpResult::Column`]. */
+ | 'formulaSet';
+
+/** An arithmetic operator. */
+export type Operator =
+ /** `+`: numbers, or days onto a date. */
+ | 'add'
+ /** `-`: numbers, days off a date, or the days between two dates. */
+ | 'subtract'
+ /** `*`: numbers. */
+ | 'multiply'
+ /** `/`: numbers; dividing by zero leaves the cell empty. */
+ | 'divide';
/** Identifier of an option of a select or tag column. */
export type OptionId = string;
@@ -1296,6 +1409,15 @@ export type ResolveError =
/** The column. */
column: string;
}
+ /**
+ * An `INSERT` or `UPDATE` writes a derived column, whose cells its
+ * formula computes.
+ */
+ | {
+ kind: 'derivedColumn';
+ /** The column. */
+ column: string;
+ }
/** Two tables of a `SELECT` share an alias. */
| {
kind: 'duplicateAlias';
diff --git a/apps/web/src/lib/core/database-sql/wasm-module.ts b/apps/web/src/lib/core/database-sql/wasm-module.ts
index 44fec0a079..f66364cb79 100644
--- a/apps/web/src/lib/core/database-sql/wasm-module.ts
+++ b/apps/web/src/lib/core/database-sql/wasm-module.ts
@@ -9,6 +9,8 @@ import type {
CardPosition,
Catalog,
DatabaseView,
+ Formula,
+ FormulaReading,
Outcome,
Page,
Schema,
@@ -47,6 +49,18 @@ interface DatabaseSqlWasmModule {
) => Board;
/** A position key between two others; `null` leaves that side open. Throws an `Error`. */
keyBetween: (before: string | null, after: string | null) => string;
+ /**
+ * What `text` reads as, typed as the formula of a derived column of `table`;
+ * `own` is that column once it exists. Throws an `EngineError`.
+ */
+ readFormula: (
+ catalog: Catalog,
+ table: string,
+ own: string | undefined,
+ text: string
+ ) => FormulaReading;
+ /** A formula as users write it, with the table's current column names. Throws an `EngineError`. */
+ renderFormula: (catalog: Catalog, table: string, formula: Formula) => string;
}
let modulePromise: Promise<DatabaseSqlWasmModule> | undefined;
diff --git a/apps/web/src/lib/service-clients/service-cognition/generated/tools/schemas.ts b/apps/web/src/lib/service-clients/service-cognition/generated/tools/schemas.ts
index 2f6fe11c34..f716ffcfcc 100644
--- a/apps/web/src/lib/service-clients/service-cognition/generated/tools/schemas.ts
+++ b/apps/web/src/lib/service-clients/service-cognition/generated/tools/schemas.ts
@@ -3995,6 +3995,7 @@ export const ToolDatabaseSchema = z.object({
z.null(),
])
.optional(),
+ formula: z.union([z.string(), z.null()]).optional(),
safeTypes: z.array(z.string()).optional(),
checkedTypes: z.array(z.string()).optional(),
})
diff --git a/apps/web/src/lib/service-clients/service-cognition/generated/tools/types.ts b/apps/web/src/lib/service-clients/service-cognition/generated/tools/types.ts
index a647f3a0c1..1ac6a6551d 100644
--- a/apps/web/src/lib/service-clients/service-cognition/generated/tools/types.ts
+++ b/apps/web/src/lib/service-clients/service-cognition/generated/tools/types.ts
@@ -7315,6 +7315,11 @@ export interface ToolColumn {
* A database-row relationship; distinct from a Macro entity reference.
*/
relation?: ToolRelation | null;
+ /**
+ * A derived column's formula: SQL reads its values, nothing writes
+ * them.
+ */
+ formula?: string | null;
/**
* Types ALTER COLUMN TYPE converts every value to, spelled as SQL types
* (`select[]` is a multi-valued select, `entity(USER)` a person).
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChange.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChange.ts
index 4a4d526dcc..09e3585eb8 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChange.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChange.ts
@@ -9,6 +9,7 @@ import type { ColumnChangeOneOfFive } from './columnChangeOneOfFive';
import type { ColumnChangeOneOfNine } from './columnChangeOneOfNine';
import type { ColumnChangeOneOfOnefour } from './columnChangeOneOfOnefour';
import type { ColumnChangeOneOfOneone } from './columnChangeOneOfOneone';
+import type { ColumnChangeOneOfOnesix } from './columnChangeOneOfOnesix';
import type { ColumnChangeOneOfSeven } from './columnChangeOneOfSeven';
import type { ColumnChangeOneOfThree } from './columnChangeOneOfThree';
@@ -22,4 +23,5 @@ export type ColumnChange =
| ColumnChangeOneOfSeven
| ColumnChangeOneOfNine
| ColumnChangeOneOfOneone
- | ColumnChangeOneOfOnefour;
+ | ColumnChangeOneOfOnefour
+ | ColumnChangeOneOfOnesix;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeKind.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeKind.ts
index 76cf85cfd1..fef8e44c2d 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeKind.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeKind.ts
@@ -16,6 +16,7 @@ export const ColumnChangeKind = {
create: 'create',
rename: 'rename',
change_type: 'change_type',
+ set_formula: 'set_formula',
delete: 'delete',
add_options: 'add_options',
update_option: 'update_option',
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeOneOfOnefour.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeOneOfOnefour.ts
index 3c2d07c197..faf3fc1ab3 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeOneOfOnefour.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeOneOfOnefour.ts
@@ -4,16 +4,16 @@
* document_storage_service
* OpenAPI spec version: 0.1.0
*/
+
import type { ColumnChangeOneOfOnefourKind } from './columnChangeOneOfOnefourKind';
+import type { Formula } from './formula';
/**
- * Remove one option of a select or tag column, and take it out of every
-cell holding it: a single-valued cell is emptied, a multi-valued one
-keeps its other options. Like [`ColumnChange::UpdateOption`], an
-option of a shared property goes everywhere it is used.
+ * Give a derived column a new formula. Its cells follow at once: it
+stores none.
*/
export type ColumnChangeOneOfOnefour = {
+ /** The formula, over the table's other columns. */
+ formula: Formula;
kind: ColumnChangeOneOfOnefourKind;
- /** The option. */
- option: string;
};
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeOneOfOnefourKind.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeOneOfOnefourKind.ts
index 559d2f6493..f997701a10 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeOneOfOnefourKind.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeOneOfOnefourKind.ts
@@ -10,5 +10,5 @@ export type ColumnChangeOneOfOnefourKind =
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const ColumnChangeOneOfOnefourKind = {
- delete_option: 'delete_option',
+ set_formula: 'set_formula',
} as const;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeOneOfOnesix.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeOneOfOnesix.ts
new file mode 100644
index 0000000000..9a3cc116ca
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeOneOfOnesix.ts
@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+import type { ColumnChangeOneOfOnesixKind } from './columnChangeOneOfOnesixKind';
+
+/**
+ * Remove one option of a select or tag column, and take it out of every
+cell holding it: a single-valued cell is emptied, a multi-valued one
+keeps its other options. Like [`ColumnChange::UpdateOption`], an
+option of a shared property goes everywhere it is used.
+ */
+export type ColumnChangeOneOfOnesix = {
+ kind: ColumnChangeOneOfOnesixKind;
+ /** The option. */
+ option: string;
+};
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeOneOfOnesixKind.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeOneOfOnesixKind.ts
new file mode 100644
index 0000000000..8af1ce7302
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnChangeOneOfOnesixKind.ts
@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+
+export type ColumnChangeOneOfOnesixKind =
+ (typeof ColumnChangeOneOfOnesixKind)[keyof typeof ColumnChangeOneOfOnesixKind];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ColumnChangeOneOfOnesixKind = {
+ delete_option: 'delete_option',
+} as const;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnConfig.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnConfig.ts
index 2ac237bc6a..1a390b3f8f 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnConfig.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnConfig.ts
@@ -5,8 +5,9 @@
* OpenAPI spec version: 0.1.0
*/
import type { ColumnConfigOneOf } from './columnConfigOneOf';
+import type { ColumnConfigOneOfThree } from './columnConfigOneOfThree';
/**
* Column-kind specific configuration stored on the placement.
*/
-export type ColumnConfig = ColumnConfigOneOf;
+export type ColumnConfig = ColumnConfigOneOf | ColumnConfigOneOfThree;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnConfigOneOfThree.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnConfigOneOfThree.ts
new file mode 100644
index 0000000000..cc97ea83d5
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnConfigOneOfThree.ts
@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+
+import type { ColumnConfigOneOfThreeKind } from './columnConfigOneOfThreeKind';
+import type { Formula } from './formula';
+
+/**
+ * A derived column: its cells are computed from the row's others, and
+its definition, a number or date one, never holds a value.
+ */
+export type ColumnConfigOneOfThree = {
+ /** How its cells are computed. */
+ formula: Formula;
+ kind: ColumnConfigOneOfThreeKind;
+};
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnConfigOneOfThreeKind.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnConfigOneOfThreeKind.ts
new file mode 100644
index 0000000000..d0e2665f0a
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnConfigOneOfThreeKind.ts
@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+
+export type ColumnConfigOneOfThreeKind =
+ (typeof ColumnConfigOneOfThreeKind)[keyof typeof ColumnConfigOneOfThreeKind];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ColumnConfigOneOfThreeKind = {
+ derived: 'derived',
+} as const;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnResult.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnResult.ts
index c8d97538ec..3f5a3171e6 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnResult.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnResult.ts
@@ -7,6 +7,7 @@
import type { ColumnResultOneOf } from './columnResultOneOf';
import type { ColumnResultOneOfFive } from './columnResultOneOfFive';
import type { ColumnResultOneOfNine } from './columnResultOneOfNine';
+import type { ColumnResultOneOfOnefive } from './columnResultOneOfOnefive';
import type { ColumnResultOneOfOneone } from './columnResultOneOfOneone';
import type { ColumnResultOneOfOnethree } from './columnResultOneOfOnethree';
import type { ColumnResultOneOfSeven } from './columnResultOneOfSeven';
@@ -22,4 +23,5 @@ export type ColumnResult =
| ColumnResultOneOfSeven
| ColumnResultOneOfNine
| ColumnResultOneOfOneone
- | ColumnResultOneOfOnethree;
+ | ColumnResultOneOfOnethree
+ | ColumnResultOneOfOnefive;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnResultOneOfOnefive.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnResultOneOfOnefive.ts
new file mode 100644
index 0000000000..866c581d43
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnResultOneOfOnefive.ts
@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+import type { ColumnResultOneOfOnefiveKind } from './columnResultOneOfOnefiveKind';
+
+/**
+ * Its formula changed.
+ */
+export type ColumnResultOneOfOnefive = {
+ kind: ColumnResultOneOfOnefiveKind;
+};
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnResultOneOfOnefiveKind.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnResultOneOfOnefiveKind.ts
new file mode 100644
index 0000000000..95022460df
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/columnResultOneOfOnefiveKind.ts
@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+
+export type ColumnResultOneOfOnefiveKind =
+ (typeof ColumnResultOneOfOnefiveKind)[keyof typeof ColumnResultOneOfOnefiveKind];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ColumnResultOneOfOnefiveKind = {
+ formula_set: 'formula_set',
+} as const;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/formula.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formula.ts
new file mode 100644
index 0000000000..c4d58e584c
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formula.ts
@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+import type { FormulaOneOf } from './formulaOneOf';
+import type { FormulaOneOfFive } from './formulaOneOfFive';
+import type { FormulaOneOfSeven } from './formulaOneOfSeven';
+import type { FormulaOneOfThree } from './formulaOneOfThree';
+
+/**
+ * An expression over one row's cells.
+ */
+export type Formula =
+ | FormulaOneOf
+ | FormulaOneOfThree
+ | FormulaOneOfFive
+ | FormulaOneOfSeven;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOf.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOf.ts
new file mode 100644
index 0000000000..ab012b5040
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOf.ts
@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+import type { FormulaOneOfKind } from './formulaOneOfKind';
+
+/**
+ * The row's cell in another column of the table: a number, date or
+derived column.
+ */
+export type FormulaOneOf = {
+ /** The column placement. */
+ column: string;
+ kind: FormulaOneOfKind;
+};
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfFive.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfFive.ts
new file mode 100644
index 0000000000..4890dc935e
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfFive.ts
@@ -0,0 +1,23 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+
+import type { Formula } from './formula';
+import type { FormulaOneOfFiveKind } from './formulaOneOfFiveKind';
+import type { Operator } from './operator';
+
+/**
+ * Two expressions combined.
+ */
+export type FormulaOneOfFive = {
+ kind: FormulaOneOfFiveKind;
+ /** The left operand. */
+ left: Formula;
+ /** How. */
+ operator: Operator;
+ /** The right operand. */
+ right: Formula;
+};
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfFiveKind.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfFiveKind.ts
new file mode 100644
index 0000000000..b2434de276
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfFiveKind.ts
@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+
+export type FormulaOneOfFiveKind =
+ (typeof FormulaOneOfFiveKind)[keyof typeof FormulaOneOfFiveKind];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const FormulaOneOfFiveKind = {
+ binary: 'binary',
+} as const;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfKind.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfKind.ts
new file mode 100644
index 0000000000..a18b3c9dea
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfKind.ts
@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+
+export type FormulaOneOfKind =
+ (typeof FormulaOneOfKind)[keyof typeof FormulaOneOfKind];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const FormulaOneOfKind = {
+ column: 'column',
+} as const;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfSeven.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfSeven.ts
new file mode 100644
index 0000000000..bcde9ff1c2
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfSeven.ts
@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+
+import type { Formula } from './formula';
+import type { FormulaOneOfSevenKind } from './formulaOneOfSevenKind';
+
+/**
+ * An expression's negation.
+ */
+export type FormulaOneOfSeven = {
+ kind: FormulaOneOfSevenKind;
+ /** The expression negated; a number. */
+ operand: Formula;
+};
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfSevenKind.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfSevenKind.ts
new file mode 100644
index 0000000000..8757177034
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfSevenKind.ts
@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+
+export type FormulaOneOfSevenKind =
+ (typeof FormulaOneOfSevenKind)[keyof typeof FormulaOneOfSevenKind];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const FormulaOneOfSevenKind = {
+ negate: 'negate',
+} as const;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfThree.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfThree.ts
new file mode 100644
index 0000000000..55c27ca643
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfThree.ts
@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+import type { FormulaOneOfThreeKind } from './formulaOneOfThreeKind';
+
+/**
+ * A constant. Added to or subtracted from a date, it counts days.
+ */
+export type FormulaOneOfThree = {
+ kind: FormulaOneOfThreeKind;
+ /** The value; finite. */
+ value: number;
+};
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfThreeKind.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfThreeKind.ts
new file mode 100644
index 0000000000..e2188b497d
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/formulaOneOfThreeKind.ts
@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+
+export type FormulaOneOfThreeKind =
+ (typeof FormulaOneOfThreeKind)[keyof typeof FormulaOneOfThreeKind];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const FormulaOneOfThreeKind = {
+ number: 'number',
+} as const;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/index.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/index.ts
index cc3c81c2c0..6ed2435346 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/schemas/index.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/index.ts
@@ -380,6 +380,8 @@ export * from './columnChangeOneOfOnefourKind';
export * from './columnChangeOneOfOneone';
export * from './columnChangeOneOfOneoneColor';
export * from './columnChangeOneOfOneoneKind';
+export * from './columnChangeOneOfOnesix';
+export * from './columnChangeOneOfOnesixKind';
export * from './columnChangeOneOfSeven';
export * from './columnChangeOneOfSevenKind';
export * from './columnChangeOneOfThree';
@@ -387,6 +389,8 @@ export * from './columnChangeOneOfThreeKind';
export * from './columnConfig';
export * from './columnConfigOneOf';
export * from './columnConfigOneOfKind';
+export * from './columnConfigOneOfThree';
+export * from './columnConfigOneOfThreeKind';
export * from './columnConfigProperty';
export * from './columnConversion';
export * from './columnConversionRequest';
@@ -421,6 +425,8 @@ export * from './columnResultOneOfFiveKind';
export * from './columnResultOneOfKind';
export * from './columnResultOneOfNine';
export * from './columnResultOneOfNineKind';
+export * from './columnResultOneOfOnefive';
+export * from './columnResultOneOfOnefiveKind';
export * from './columnResultOneOfOneone';
export * from './columnResultOneOfOneoneKind';
export * from './columnResultOneOfOnethree';
@@ -905,6 +911,15 @@ export * from './formSourceOneOfThreeKind';
export * from './formStatus';
export * from './formSubmittedColumnId';
export * from './formTally';
+export * from './formula';
+export * from './formulaOneOf';
+export * from './formulaOneOfFive';
+export * from './formulaOneOfFiveKind';
+export * from './formulaOneOfKind';
+export * from './formulaOneOfSeven';
+export * from './formulaOneOfSevenKind';
+export * from './formulaOneOfThree';
+export * from './formulaOneOfThreeKind';
export * from './genericErrorResponse';
export * from './genericResponse';
export * from './genericResponseMessage';
@@ -1232,6 +1247,8 @@ export * from './newAttachmentHeight';
export * from './newAttachmentWidth';
export * from './newColumn';
export * from './newColumnOneOf';
+export * from './newColumnOneOfFive';
+export * from './newColumnOneOfFiveSource';
export * from './newColumnOneOfSource';
export * from './newColumnOneOfThree';
export * from './newColumnOneOfThreeSource';
@@ -1255,6 +1272,7 @@ export * from './notificationState';
export * from './numberOperator';
export * from './opBatch';
export * from './opBatchBaseVersions';
+export * from './operator';
export * from './opRefusalResponse';
export * from './opRefusalResponseColumn';
export * from './opRefusalResponseRow';
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumn.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumn.ts
index 64a6fd61cb..981ad840ed 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumn.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumn.ts
@@ -5,9 +5,13 @@
* OpenAPI spec version: 0.1.0
*/
import type { NewColumnOneOf } from './newColumnOneOf';
+import type { NewColumnOneOfFive } from './newColumnOneOfFive';
import type { NewColumnOneOfThree } from './newColumnOneOfThree';
/**
* What a new column holds.
*/
-export type NewColumn = NewColumnOneOf | NewColumnOneOfThree;
+export type NewColumn =
+ | NewColumnOneOf
+ | NewColumnOneOfThree
+ | NewColumnOneOfFive;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumnOneOfFive.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumnOneOfFive.ts
new file mode 100644
index 0000000000..29d036a54b
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumnOneOfFive.ts
@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+import type { NewColumnOneOfFiveSource } from './newColumnOneOfFiveSource';
+
+/**
+ * An existing property, a person's, a team's or a system one, bound
+into the table under its own name.
+ */
+export type NewColumnOneOfFive = {
+ /** The property's definition. */
+ property: string;
+ source: NewColumnOneOfFiveSource;
+};
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumnOneOfFiveSource.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumnOneOfFiveSource.ts
new file mode 100644
index 0000000000..8e10947c0a
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumnOneOfFiveSource.ts
@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+
+export type NewColumnOneOfFiveSource =
+ (typeof NewColumnOneOfFiveSource)[keyof typeof NewColumnOneOfFiveSource];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const NewColumnOneOfFiveSource = {
+ existing: 'existing',
+} as const;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumnOneOfThree.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumnOneOfThree.ts
index b53590871d..761b0c4611 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumnOneOfThree.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumnOneOfThree.ts
@@ -4,14 +4,18 @@
* document_storage_service
* OpenAPI spec version: 0.1.0
*/
+import type { Formula } from './formula';
import type { NewColumnOneOfThreeSource } from './newColumnOneOfThreeSource';
/**
- * An existing property, a person's, a team's or a system one, bound
-into the table under its own name.
+ * A derived column: its cells are what `formula` computes from the
+row's other cells, and nothing writes them.
*/
export type NewColumnOneOfThree = {
- /** The property's definition. */
- property: string;
+ /** How its cells are computed: arithmetic over the table's number,
+date and other derived columns. */
+ formula: Formula;
+ /** The column's name, unique within the table ignoring case. */
+ name: string;
source: NewColumnOneOfThreeSource;
};
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumnOneOfThreeSource.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumnOneOfThreeSource.ts
index 05e03d5ed0..f648c14dc8 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumnOneOfThreeSource.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newColumnOneOfThreeSource.ts
@@ -10,5 +10,5 @@ export type NewColumnOneOfThreeSource =
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const NewColumnOneOfThreeSource = {
- existing: 'existing',
+ derived: 'derived',
} as const;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/operator.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/operator.ts
new file mode 100644
index 0000000000..6d1040e435
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/operator.ts
@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+
+/**
+ * An arithmetic operator.
+ */
+export type Operator = (typeof Operator)[keyof typeof Operator];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const Operator = {
+ add: 'add',
+ subtract: 'subtract',
+ multiply: 'multiply',
+ divide: 'divide',
+} as const;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/zod.ts b/apps/web/src/lib/service-clients/service-storage/generated/zod.ts
index bd207a6991..c4a0f12d20 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/zod.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/zod.ts
@@ -5067,6 +5067,65 @@ export const applyCrmPipelineOpsBody = zod
.describe('A type a column can have.'),
})
.describe('A new property the database owns.'),
+ zod
+ .object({
+ formula: zod
+ .union([
+ zod
+ .object({
+ column: zod
+ .uuid()
+ .describe('The column placement.'),
+ kind: zod.enum(['column']),
+ })
+ .describe(
+ "The row's cell in another column of the table: a number, date or\nderived column."
+ ),
+ zod
+ .object({
+ kind: zod.enum(['number']),
+ value: zod
+ .number()
+ .describe('The value; finite.'),
+ })
+ .describe(
+ 'A constant. Added to or subtracted from a date, it counts days.'
+ ),
+ zod
+ .object({
+ kind: zod.enum(['binary']),
+ left: zod.unknown(),
+ operator: zod
+ .enum([
+ 'add',
+ 'subtract',
+ 'multiply',
+ 'divide',
+ ])
+ .describe('An arithmetic operator.'),
+ right: zod.unknown(),
+ })
+ .describe('Two expressions combined.'),
+ zod
+ .object({
+ kind: zod.enum(['negate']),
+ operand: zod.unknown(),
+ })
+ .describe("An expression's negation."),
+ ])
+ .describe(
+ "An expression over one row's cells."
+ ),
+ name: zod
+ .string()
+ .describe(
+ "The column's name, unique within the table ignoring case."
+ ),
+ source: zod.enum(['derived']),
+ })
+ .describe(
+ "A derived column: its cells are what `formula` computes from the\nrow's other cells, and nothing writes them."
+ ),
zod
.object({
property: zod
@@ -5260,6 +5319,58 @@ export const applyCrmPipelineOpsBody = zod
.describe(
'Relabel or recolour one option of a select or tag column. Every cell\nholding it keeps it. A column bound to a property shared outside the\ndatabase changes wherever that property is used, so it takes the\nright to edit that property.'
),
+ zod
+ .object({
+ formula: zod
+ .union([
+ zod
+ .object({
+ column: zod
+ .uuid()
+ .describe('The column placement.'),
+ kind: zod.enum(['column']),
+ })
+ .describe(
+ "The row's cell in another column of the table: a number, date or\nderived column."
+ ),
+ zod
+ .object({
+ kind: zod.enum(['number']),
+ value: zod
+ .number()
+ .describe('The value; finite.'),
+ })
+ .describe(
+ 'A constant. Added to or subtracted from a date, it counts days.'
+ ),
+ zod
+ .object({
+ kind: zod.enum(['binary']),
+ left: zod.unknown(),
+ operator: zod
+ .enum([
+ 'add',
+ 'subtract',
+ 'multiply',
+ 'divide',
+ ])
+ .describe('An arithmetic operator.'),
+ right: zod.unknown(),
+ })
+ .describe('Two expressions combined.'),
+ zod
+ .object({
+ kind: zod.enum(['negate']),
+ operand: zod.unknown(),
+ })
+ .describe("An expression's negation."),
+ ])
+ .describe("An expression over one row's cells."),
+ kind: zod.enum(['set_formula']),
+ })
+ .describe(
+ 'Give a derived column a new formula. Its cells follow at once: it\nstores none.'
+ ),
zod
.object({
kind: zod.enum(['delete_option']),
@@ -6835,6 +6946,11 @@ export const applyCrmPipelineOpsResponse = zod
kind: zod.enum(['option_deleted']),
})
.describe('One of its options was removed.'),
+ zod
+ .object({
+ kind: zod.enum(['formula_set']),
+ })
+ .describe('Its formula changed.'),
])
.describe('What happened to a column.'),
column: zod.uuid().describe('The column.'),
@@ -8345,14 +8461,69 @@ export const getCrmPipelineTableResponse = zod
config: zod.union([
zod.null(),
zod
- .object({
- database_id: zod.uuid().describe('Target database.'),
- kind: zod.enum(['link']),
- table_id: zod.uuid().describe('Target table.'),
- })
- .describe(
- 'A relation column: its cells reference rows of another table.'
- )
+ .union([
+ zod
+ .object({
+ database_id: zod.uuid().describe('Target database.'),
+ kind: zod.enum(['link']),
+ table_id: zod.uuid().describe('Target table.'),
+ })
+ .describe(
+ 'A relation column: its cells reference rows of another table.'
+ ),
+ zod
+ .object({
+ formula: zod
+ .union([
+ zod
+ .object({
+ column: zod
+ .uuid()
+ .describe('The column placement.'),
+ kind: zod.enum(['column']),
+ })
+ .describe(
+ "The row's cell in another column of the table: a number, date or\nderived column."
+ ),
+ zod
+ .object({
+ kind: zod.enum(['number']),
+ value: zod
+ .number()
+ .describe('The value; finite.'),
+ })
+ .describe(
+ 'A constant. Added to or subtracted from a date, it counts days.'
+ ),
+ zod
+ .object({
+ kind: zod.enum(['binary']),
+ left: zod.unknown(),
+ operator: zod
+ .enum([
+ 'add',
+ 'subtract',
+ 'multiply',
+ 'divide',
+ ])
+ .describe('An arithmetic operator.'),
+ right: zod.unknown(),
+ })
+ .describe('Two expressions combined.'),
+ zod
+ .object({
+ kind: zod.enum(['negate']),
+ operand: zod.unknown(),
+ })
+ .describe("An expression's negation."),
+ ])
+ .describe("An expression over one row's cells."),
+ kind: zod.enum(['derived']),
+ })
+ .describe(
+ "A derived column: its cells are computed from the row's others, and\nits definition, a number or date one, never holds a value."
+ ),
+ ])
.describe(
'Column-kind specific configuration stored on the placement.'
),
@@ -9307,16 +9478,77 @@ export const getDatabaseResponse = zod
config: zod.union([
zod.null(),
zod
- .object({
- database_id: zod
- .uuid()
- .describe('Target database.'),
- kind: zod.enum(['link']),
- table_id: zod.uuid().describe('Target table.'),
- })
- .describe(
- 'A relation column: its cells reference rows of another table.'
- )
+ .union([
+ zod
+ .object({
+ database_id: zod
+ .uuid()
+ .describe('Target database.'),
+ kind: zod.enum(['link']),
+ table_id: zod
+ .uuid()
+ .describe('Target table.'),
+ })
+ .describe(
+ 'A relation column: its cells reference rows of another table.'
+ ),
+ zod
+ .object({
+ formula: zod
+ .union([
+ zod
+ .object({
+ column: zod
+ .uuid()
+ .describe('The column placement.'),
+ kind: zod.enum(['column']),
+ })
+ .describe(
+ "The row's cell in another column of the table: a number, date or\nderived column."
+ ),
+ zod
+ .object({
+ kind: zod.enum(['number']),
+ value: zod
+ .number()
+ .describe('The value; finite.'),
+ })
+ .describe(
+ 'A constant. Added to or subtracted from a date, it counts days.'
+ ),
+ zod
+ .object({
+ kind: zod.enum(['binary']),
+ left: zod.unknown(),
+ operator: zod
+ .enum([
+ 'add',
+ 'subtract',
+ 'multiply',
+ 'divide',
+ ])
+ .describe(
+ 'An arithmetic operator.'
+ ),
+ right: zod.unknown(),
+ })
+ .describe('Two expressions combined.'),
+ zod
+ .object({
+ kind: zod.enum(['negate']),
+ operand: zod.unknown(),
+ })
+ .describe("An expression's negation."),
+ ])
+ .describe(
+ "An expression over one row's cells."
+ ),
+ kind: zod.enum(['derived']),
+ })
+ .describe(
+ "A derived column: its cells are computed from the row's others, and\nits definition, a number or date one, never holds a value."
+ ),
+ ])
.describe(
'Column-kind specific configuration stored on the placement.'
),
@@ -10374,6 +10606,65 @@ export const applyDatabaseOpsBody = zod
.describe('A type a column can have.'),
})
.describe('A new property the database owns.'),
+ zod
+ .object({
+ formula: zod
+ .union([
+ zod
+ .object({
+ column: zod
+ .uuid()
+ .describe('The column placement.'),
+ kind: zod.enum(['column']),
+ })
+ .describe(
+ "The row's cell in another column of the table: a number, date or\nderived column."
+ ),
+ zod
+ .object({
+ kind: zod.enum(['number']),
+ value: zod
+ .number()
+ .describe('The value; finite.'),
+ })
+ .describe(
+ 'A constant. Added to or subtracted from a date, it counts days.'
+ ),
+ zod
+ .object({
+ kind: zod.enum(['binary']),
+ left: zod.unknown(),
+ operator: zod
+ .enum([
+ 'add',
+ 'subtract',
+ 'multiply',
+ 'divide',
+ ])
+ .describe('An arithmetic operator.'),
+ right: zod.unknown(),
+ })
+ .describe('Two expressions combined.'),
+ zod
+ .object({
+ kind: zod.enum(['negate']),
+ operand: zod.unknown(),
+ })
+ .describe("An expression's negation."),
+ ])
+ .describe(
+ "An expression over one row's cells."
+ ),
+ name: zod
+ .string()
+ .describe(
+ "The column's name, unique within the table ignoring case."
+ ),
+ source: zod.enum(['derived']),
+ })
+ .describe(
+ "A derived column: its cells are what `formula` computes from the\nrow's other cells, and nothing writes them."
+ ),
zod
.object({
property: zod
@@ -10567,6 +10858,58 @@ export const applyDatabaseOpsBody = zod
.describe(
'Relabel or recolour one option of a select or tag column. Every cell\nholding it keeps it. A column bound to a property shared outside the\ndatabase changes wherever that property is used, so it takes the\nright to edit that property.'
),
+ zod
+ .object({
+ formula: zod
+ .union([
+ zod
+ .object({
+ column: zod
+ .uuid()
+ .describe('The column placement.'),
+ kind: zod.enum(['column']),
+ })
+ .describe(
+ "The row's cell in another column of the table: a number, date or\nderived column."
+ ),
+ zod
+ .object({
+ kind: zod.enum(['number']),
+ value: zod
+ .number()
+ .describe('The value; finite.'),
+ })
+ .describe(
+ 'A constant. Added to or subtracted from a date, it counts days.'
+ ),
+ zod
+ .object({
+ kind: zod.enum(['binary']),
+ left: zod.unknown(),
+ operator: zod
+ .enum([
+ 'add',
+ 'subtract',
+ 'multiply',
+ 'divide',
+ ])
+ .describe('An arithmetic operator.'),
+ right: zod.unknown(),
+ })
+ .describe('Two expressions combined.'),
+ zod
+ .object({
+ kind: zod.enum(['negate']),
+ operand: zod.unknown(),
+ })
+ .describe("An expression's negation."),
+ ])
+ .describe("An expression over one row's cells."),
+ kind: zod.enum(['set_formula']),
+ })
+ .describe(
+ 'Give a derived column a new formula. Its cells follow at once: it\nstores none.'
+ ),
zod
.object({
kind: zod.enum(['delete_option']),
@@ -12146,6 +12489,11 @@ export const applyDatabaseOpsResponse = zod
kind: zod.enum(['option_deleted']),
})
.describe('One of its options was removed.'),
+ zod
+ .object({
+ kind: zod.enum(['formula_set']),
+ })
+ .describe('Its formula changed.'),
])
.describe('What happened to a column.'),
column: zod.uuid().describe('The column.'),
@@ -13264,6 +13612,7 @@ export const getDatabaseTableChangesResponse = zod
'create',
'rename',
'change_type',
+ 'set_formula',
'delete',
'add_options',
'update_option',
@@ -13729,14 +14078,64 @@ export const inferDatabaseColumnTypeResponse = zod
config: zod.union([
zod.null(),
zod
- .object({
- database_id: zod.uuid().describe('Target database.'),
- kind: zod.enum(['link']),
- table_id: zod.uuid().describe('Target table.'),
- })
- .describe(
- 'A relation column: its cells reference rows of another table.'
- )
+ .union([
+ zod
+ .object({
+ database_id: zod.uuid().describe('Target database.'),
+ kind: zod.enum(['link']),
+ table_id: zod.uuid().describe('Target table.'),
+ })
+ .describe(
+ 'A relation column: its cells reference rows of another table.'
+ ),
+ zod
+ .object({
+ formula: zod
+ .union([
+ zod
+ .object({
+ column: zod
+ .uuid()
+ .describe('The column placement.'),
+ kind: zod.enum(['column']),
+ })
+ .describe(
+ "The row's cell in another column of the table: a number, date or\nderived column."
+ ),
+ zod
+ .object({
+ kind: zod.enum(['number']),
+ value: zod
+ .number()
+ .describe('The value; finite.'),
+ })
+ .describe(
+ 'A constant. Added to or subtracted from a date, it counts days.'
+ ),
+ zod
+ .object({
+ kind: zod.enum(['binary']),
+ left: zod.unknown(),
+ operator: zod
+ .enum(['add', 'subtract', 'multiply', 'divide'])
+ .describe('An arithmetic operator.'),
+ right: zod.unknown(),
+ })
+ .describe('Two expressions combined.'),
+ zod
+ .object({
+ kind: zod.enum(['negate']),
+ operand: zod.unknown(),
+ })
+ .describe("An expression's negation."),
+ ])
+ .describe("An expression over one row's cells."),
+ kind: zod.enum(['derived']),
+ })
+ .describe(
+ "A derived column: its cells are computed from the row's others, and\nits definition, a number or date one, never holds a value."
+ ),
+ ])
.describe(
'Column-kind specific configuration stored on the placement.'
),
diff --git a/apps/web/src/lib/service-clients/service-storage/openapi.json b/apps/web/src/lib/service-clients/service-storage/openapi.json
index ae00aa50a2..512fe2b3a8 100644
--- a/apps/web/src/lib/service-clients/service-storage/openapi.json
+++ b/apps/web/src/lib/service-clients/service-storage/openapi.json
@@ -21849,6 +21849,21 @@
}
}
},
+ {
+ "type": "object",
+ "description": "Give a derived column a new formula. Its cells follow at once: it\nstores none.",
+ "required": ["formula", "kind"],
+ "properties": {
+ "formula": {
+ "$ref": "#/components/schemas/Formula",
+ "description": "The formula, over the table's other columns."
+ },
+ "kind": {
+ "type": "string",
+ "enum": ["set_formula"]
+ }
+ }
+ },
{
"type": "object",
"description": "Remove one option of a select or tag column, and take it out of every\ncell holding it: a single-valued cell is emptied, a multi-valued one\nkeeps its other options. Like [`ColumnChange::UpdateOption`], an\noption of a shared property goes everywhere it is used.",
@@ -21875,6 +21890,7 @@
"create",
"rename",
"change_type",
+ "set_formula",
"delete",
"add_options",
"update_option",
@@ -21906,6 +21922,21 @@
"description": "Target table."
}
}
+ },
+ {
+ "type": "object",
+ "description": "A derived column: its cells are computed from the row's others, and\nits definition, a number or date one, never holds a value.",
+ "required": ["formula", "kind"],
+ "properties": {
+ "formula": {
+ "$ref": "#/components/schemas/Formula",
+ "description": "How its cells are computed."
+ },
+ "kind": {
+ "type": "string",
+ "enum": ["derived"]
+ }
+ }
}
],
"description": "Column-kind specific configuration stored on the placement."
@@ -22217,6 +22248,17 @@
"enum": ["option_deleted"]
}
}
+ },
+ {
+ "type": "object",
+ "description": "Its formula changed.",
+ "required": ["kind"],
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["formula_set"]
+ }
+ }
}
],
"description": "What happened to a column."
@@ -28015,6 +28057,81 @@
}
}
},
+ "Formula": {
+ "oneOf": [
+ {
+ "type": "object",
+ "description": "The row's cell in another column of the table: a number, date or\nderived column.",
+ "required": ["column", "kind"],
+ "properties": {
+ "column": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The column placement."
+ },
+ "kind": {
+ "type": "string",
+ "enum": ["column"]
+ }
+ }
+ },
+ {
+ "type": "object",
+ "description": "A constant. Added to or subtracted from a date, it counts days.",
+ "required": ["value", "kind"],
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["number"]
+ },
+ "value": {
+ "type": "number",
+ "format": "double",
+ "description": "The value; finite."
+ }
+ }
+ },
+ {
+ "type": "object",
+ "description": "Two expressions combined.",
+ "required": ["operator", "left", "right", "kind"],
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["binary"]
+ },
+ "left": {
+ "$ref": "#/components/schemas/Formula",
+ "description": "The left operand."
+ },
+ "operator": {
+ "$ref": "#/components/schemas/Operator",
+ "description": "How."
+ },
+ "right": {
+ "$ref": "#/components/schemas/Formula",
+ "description": "The right operand."
+ }
+ }
+ },
+ {
+ "type": "object",
+ "description": "An expression's negation.",
+ "required": ["operand", "kind"],
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["negate"]
+ },
+ "operand": {
+ "$ref": "#/components/schemas/Formula",
+ "description": "The expression negated; a number."
+ }
+ }
+ }
+ ],
+ "description": "An expression over one row's cells."
+ },
"GenericErrorResponse": {
"type": "object",
"required": ["error", "message"],
@@ -31701,6 +31818,25 @@
}
}
},
+ {
+ "type": "object",
+ "description": "A derived column: its cells are what `formula` computes from the\nrow's other cells, and nothing writes them.",
+ "required": ["name", "formula", "source"],
+ "properties": {
+ "formula": {
+ "$ref": "#/components/schemas/Formula",
+ "description": "How its cells are computed: arithmetic over the table's number,\ndate and other derived columns."
+ },
+ "name": {
+ "type": "string",
+ "description": "The column's name, unique within the table ignoring case."
+ },
+ "source": {
+ "type": "string",
+ "enum": ["derived"]
+ }
+ }
+ },
{
"type": "object",
"description": "An existing property, a person's, a team's or a system one, bound\ninto the table under its own name.",
@@ -32118,6 +32254,11 @@
],
"description": "What one op did, in the order the ops were sent, grouped as the ops are:\na result's `kind` is its op's, naming the same resource, and its\n`change` says what happened to it."
},
+ "Operator": {
+ "type": "string",
+ "description": "An arithmetic operator.",
+ "enum": ["add", "subtract", "multiply", "divide"]
+ },
"OptionRef": {
"oneOf": [
{
diff --git a/crates/database_sql/examples/gql.rs b/crates/database_sql/examples/gql.rs
index 014c331c65..0a329d4293 100644
--- a/crates/database_sql/examples/gql.rs
+++ b/crates/database_sql/examples/gql.rs
@@ -211,6 +211,7 @@ impl Api {
relation: false,
},
options: Vec::new(),
+ formula: None,
}];
for definition in definitions
.into_iter()
@@ -251,6 +252,7 @@ impl Api {
relation: false,
},
options,
+ formula: None,
});
}
let schema = Schema {
diff --git a/crates/database_sql/examples/repl.rs b/crates/database_sql/examples/repl.rs
index 5abde10182..a1f6463c31 100644
--- a/crates/database_sql/examples/repl.rs
+++ b/crates/database_sql/examples/repl.rs
@@ -57,12 +57,14 @@ fn catalog() -> Catalog {
placement: ColumnId::from_uuid(NAME),
name: "name".into(),
kind: ColumnKind::Text,
+ formula: None,
},
Column {
id: AMOUNT,
placement: ColumnId::from_uuid(AMOUNT),
name: "amount".into(),
kind: ColumnKind::Number,
+ formula: None,
},
Column {
id: STAGE,
@@ -85,12 +87,14 @@ fn catalog() -> Catalog {
},
],
},
+ formula: None,
},
Column {
id: CLOSED_AT,
placement: ColumnId::from_uuid(CLOSED_AT),
name: "closed at".into(),
kind: ColumnKind::Date,
+ formula: None,
},
Column {
id: OWNER,
@@ -100,6 +104,7 @@ fn catalog() -> Catalog {
multi: false,
target: EntityKind::User,
},
+ formula: None,
},
Column {
id: TAGS,
@@ -118,12 +123,14 @@ fn catalog() -> Catalog {
},
],
},
+ formula: None,
},
Column {
id: DONE,
placement: ColumnId::from_uuid(DONE),
name: "done".into(),
kind: ColumnKind::Boolean,
+ formula: None,
},
],
source: TableSource::Database,
diff --git a/crates/database_sql/src/bin/database_sql_types.rs b/crates/database_sql/src/bin/database_sql_types.rs
index 6a02e5d3a4..d724a25781 100644
--- a/crates/database_sql/src/bin/database_sql_types.rs
+++ b/crates/database_sql/src/bin/database_sql_types.rs
@@ -7,9 +7,10 @@
//! ```
use database_sql::catalog::Schema;
+use database_sql::formula::FormulaReading;
use database_sql::{Bin, Board, Catalog, EngineError, Outcome, Page, Step};
-use models_databases::OpResult;
use models_databases::views::{CardPosition, DatabaseView};
+use models_databases::{Formula, OpResult};
use specta::Types;
use specta::datatype::{DataType, Fields};
use specta_typescript::Typescript;
@@ -35,7 +36,9 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
.register::<DatabaseView>()
.register::<CardPosition>()
.register::<Board>()
- .register::<EngineError>();
+ .register::<EngineError>()
+ .register::<FormulaReading>()
+ .register::<Formula>();
// serde-wasm-bindgen hands `NaN` and the infinities across as numbers,
// so an `f64` is a plain `number` rather than JSON's `number | null`.
let types = Configuration::empty()
diff --git a/crates/database_sql/src/catalog.rs b/crates/database_sql/src/catalog.rs
index 22a0cfc25e..5aa691c96c 100644
--- a/crates/database_sql/src/catalog.rs
+++ b/crates/database_sql/src/catalog.rs
@@ -8,7 +8,7 @@ mod schema;
use models_databases::EntityKind as OpEntityKind;
use models_databases::cast::CastKind;
-use models_databases::{ColumnId, DatabaseId, OptionId, TableId};
+use models_databases::{ColumnId, DatabaseId, Formula, OptionId, TableId};
use serde::{Deserialize, Serialize};
use specta::Type;
use uuid::Uuid;
@@ -19,7 +19,7 @@ pub use schema::{
};
/// Every table a statement may name.
-#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize, Type)]
+#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct Catalog {
/// The visible tables.
@@ -27,7 +27,7 @@ pub struct Catalog {
}
/// One table and its columns, in display order.
-#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Type)]
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct Table {
/// The table id.
@@ -89,18 +89,21 @@ pub fn people_table() -> Table {
multi: false,
target: EntityKind::User,
},
+ formula: None,
},
Column {
id: PEOPLE_NAME,
placement: ColumnId::from_uuid(PEOPLE_NAME),
name: "name".into(),
kind: ColumnKind::Text,
+ formula: None,
},
Column {
id: PEOPLE_EMAIL,
placement: ColumnId::from_uuid(PEOPLE_EMAIL),
name: "email".into(),
kind: ColumnKind::Text,
+ formula: None,
},
],
source: TableSource::People,
@@ -108,7 +111,7 @@ pub fn people_table() -> Table {
}
/// One column: a property definition bound to the table.
-#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Type)]
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct Column {
/// The property definition id: what reads key cells by.
@@ -117,8 +120,13 @@ pub struct Column {
pub placement: ColumnId,
/// The column's display name.
pub name: String,
- /// What the column holds.
+ /// What the column holds; for a derived column, what its formula
+ /// yields.
pub kind: ColumnKind,
+ /// For a derived column, how its cells are computed: it stores none.
+ #[serde(default, skip_serializing_if = "Option::is_none")]
+ #[specta(optional)]
+ pub formula: Option<Formula>,
}
/// The value type of a column, mirroring the property data types a query can
diff --git a/crates/database_sql/src/catalog/schema.rs b/crates/database_sql/src/catalog/schema.rs
index 286260248e..62f3d0be07 100644
--- a/crates/database_sql/src/catalog/schema.rs
+++ b/crates/database_sql/src/catalog/schema.rs
@@ -9,7 +9,7 @@ mod test;
use models_databases::EntityKind as OpEntityKind;
use models_databases::property::stored_cast_kind;
pub use models_databases::property::{DataType, OptionValue};
-use models_databases::{ColumnId, DatabaseId, OptionId, TableId};
+use models_databases::{ColumnId, DatabaseId, Formula, OptionId, TableId};
use serde::{Deserialize, Serialize};
use specta::Type;
use uuid::Uuid;
@@ -69,6 +69,11 @@ pub struct ColumnSchema {
pub property: PropertyType,
/// The definition's options, in any order.
pub options: Vec<OptionSchema>,
+ /// For a derived column, its formula; its definition says what the
+ /// formula yields.
+ #[serde(default, skip_serializing_if = "Option::is_none")]
+ #[specta(optional)]
+ pub formula: Option<Formula>,
}
/// A column's type as the properties system stores it.
@@ -174,6 +179,7 @@ pub fn build(schema: &Schema, scope: Option<DatabaseId>) -> Catalog {
placement: column.id,
name: column.name.clone(),
kind: column.kind(),
+ formula: column.formula.clone(),
})
.collect(),
source: TableSource::Database,
diff --git a/crates/database_sql/src/engine/test/transcripts.rs b/crates/database_sql/src/engine/test/transcripts.rs
index ed14828072..b8727ab120 100644
--- a/crates/database_sql/src/engine/test/transcripts.rs
+++ b/crates/database_sql/src/engine/test/transcripts.rs
@@ -68,12 +68,14 @@ fn crm() -> Catalog {
placement: NAME_COLUMN,
name: "name".into(),
kind: ColumnKind::Text,
+ formula: None,
},
Column {
id: AMOUNT,
placement: AMOUNT_COLUMN,
name: "amount".into(),
kind: ColumnKind::Number,
+ formula: None,
},
Column {
id: STAGE,
@@ -92,6 +94,7 @@ fn crm() -> Catalog {
},
],
},
+ formula: None,
},
Column {
id: OWNER,
@@ -101,12 +104,14 @@ fn crm() -> Catalog {
multi: true,
target: EntityKind::Row,
},
+ formula: None,
},
Column {
id: PITCH,
placement: PITCH_COLUMN,
name: "pitch".into(),
kind: ColumnKind::Text,
+ formula: None,
},
],
source: TableSource::Database,
@@ -121,6 +126,7 @@ fn crm() -> Catalog {
placement: PEOPLE_NAME_COLUMN,
name: "name".into(),
kind: ColumnKind::Text,
+ formula: None,
}],
source: TableSource::Database,
},
diff --git a/crates/database_sql/src/fold.rs b/crates/database_sql/src/fold.rs
index b1343c6559..c5c0238fc3 100644
--- a/crates/database_sql/src/fold.rs
+++ b/crates/database_sql/src/fold.rs
@@ -19,13 +19,14 @@ use std::collections::{HashMap, HashSet};
use chrono::{DateTime, Utc};
use models_databases::position::Position;
-use models_databases::{OptionId, RowId};
+use models_databases::{Formula, OptionId, RowId};
use serde::{Deserialize, Serialize};
use specta::Type;
use uuid::Uuid;
use crate::catalog::Catalog;
-use crate::resolve::{AggregateFunction, OrderKey, SelectItem};
+use crate::formula;
+use crate::resolve::{AggregateFunction, OrderKey, SelectItem, binding, column_key};
use crate::run::RunError;
use crate::split::{Plan, Shape};
@@ -122,11 +123,42 @@ pub type Table = Vec<Vec<Option<Cell>>>;
pub fn fold_relations(
catalog: &Catalog,
plan: &Plan,
- fetched: Vec<Vec<Row>>,
+ mut fetched: Vec<Vec<Row>>,
) -> (Table, Vec<RowId>) {
+ for (index, rows) in fetched.iter_mut().enumerate() {
+ derive(catalog, plan, index, rows);
+ }
fold_joined(catalog, plan, join::join(plan, fetched))
}
+/// Give the rows of relation `index` the cells of its table's derived
+/// columns the plan reads, computed from their other cells.
+fn derive(catalog: &Catalog, plan: &Plan, index: usize, rows: &mut [Row]) {
+ let Some(table) = catalog
+ .tables
+ .iter()
+ .find(|table| table.id == plan.relations[index].relation.table)
+ else {
+ return;
+ };
+ let key = |definition: Uuid| column_key(index, definition);
+ let derived: Vec<(Uuid, &Formula)> = formula::derived(table)
+ .map(|(column, formula)| (key(column.id), formula))
+ .filter(|(derived_key, _)| binding(&plan.bindings, *derived_key).is_some())
+ .collect();
+ if derived.is_empty() {
+ return;
+ }
+ for row in rows {
+ for (derived_key, formula) in &derived {
+ match formula::evaluate(table, formula, &row.cells, key) {
+ Some(cell) => row.cells.insert(*derived_key, cell),
+ None => row.cells.remove(derived_key),
+ };
+ }
+ }
+}
+
/// Finish a plan over rows that are already joined (or come from one
/// relation).
#[cfg(test)]
diff --git a/crates/database_sql/src/formula.rs b/crates/database_sql/src/formula.rs
new file mode 100644
index 0000000000..517bd3e66b
--- /dev/null
+++ b/crates/database_sql/src/formula.rs
@@ -0,0 +1,426 @@
+//! Derived columns: a [`Formula`]'s text form, its type, and its value on a
+//! row.
+//!
+//! ```text
+//! formula := term {('+' | '-') term}
+//! term := unary {('*' | '/') unary}
+//! unary := '-' unary | atom
+//! atom := number | '{' name '}' | word | '(' formula ')'
+//! ```
+//!
+//! A `word` is a column name of letters, digits and `_`; any other name is
+//! written in braces, `{Unit price}`. Names match ignoring case.
+//!
+//! Numbers combine with `+ - * /`. A number added to or subtracted from a
+//! date counts days, and one date minus another is the days between them.
+//! An empty number reads as `0`, so a new row's total does not vanish
+//! because one input is blank, but a formula whose every column is empty is
+//! empty, and so is anything involving an empty date or dividing by zero.
+
+mod lexer;
+mod parser;
+#[cfg(test)]
+mod test;
+
+use std::collections::HashMap;
+use std::ops::Range;
+
+use chrono::{DateTime, Duration, Utc};
+use models_databases::{ColumnId, Formula, FormulaType, Operator};
+use serde::{Deserialize, Serialize};
+use specta::Type;
+use uuid::Uuid;
+
+use crate::catalog::{Column, ColumnKind, Table};
+use crate::fold::Cell;
+use crate::parse::ParseError;
+
+/// How deep derived columns may nest within one another before a formula is
+/// refused, as a guard against a cycle that slipped into stored data.
+const MAX_DEPTH: usize = 32;
+
+/// What a formula typed into a derived column's editor reads as.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Type)]
+#[serde(tag = "status", rename_all = "camelCase")]
+pub enum FormulaReading {
+ /// It parses and its types fit.
+ Valid {
+ /// The formula, columns by id.
+ formula: Formula,
+ /// What its cells hold.
+ result: FormulaType,
+ },
+ /// It does not, and why.
+ Invalid {
+ /// What is wrong, in words for the person typing.
+ message: String,
+ /// The part of the text it is about, in UTF-16 code units as a
+ /// browser counts them, when it is about a part.
+ #[serde(default, skip_serializing_if = "Option::is_none")]
+ #[specta(optional, type = Option<crate::parse::Span>)]
+ span: Option<Range<usize>>,
+ },
+}
+
+/// Parse and check `text` as the formula of a derived column of `table`:
+/// `own`, when it exists already.
+pub fn read(table: &Table, own: Option<ColumnId>, text: &str) -> FormulaReading {
+ let formula = match parse(table, text) {
+ Ok(formula) => formula,
+ Err(error) => {
+ let utf16 = |byte: usize| text[..byte].encode_utf16().count();
+ return FormulaReading::Invalid {
+ message: error.message,
+ span: Some(utf16(error.span.start)..utf16(error.span.end)),
+ };
+ }
+ };
+ match check(table, own, &formula) {
+ Ok(result) => FormulaReading::Valid { formula, result },
+ Err(message) => FormulaReading::Invalid {
+ message,
+ span: None,
+ },
+ }
+}
+
+/// A formula typed for `table`, its column names resolved to ids.
+pub fn parse(table: &Table, text: &str) -> Result<Formula, ParseError> {
+ parser::formula(table, text)
+}
+
+/// The formula as users write it, with `table`'s current column names; a
+/// column the table no longer has reads `{?}`.
+pub fn render(table: &Table, formula: &Formula) -> String {
+ render_named(formula, &|column| {
+ placement(table, column).map(|found| found.name.as_str())
+ })
+}
+
+/// The formula as users write it, each column under the name `name` gives
+/// it.
+pub fn render_named<'name>(
+ formula: &Formula,
+ name: &impl Fn(ColumnId) -> Option<&'name str>,
+) -> String {
+ render_at(formula, name, Precedence::Sum)
+}
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
+enum Precedence {
+ Sum,
+ Product,
+ Unary,
+}
+
+fn precedence(operator: Operator) -> Precedence {
+ match operator {
+ Operator::Add | Operator::Subtract => Precedence::Sum,
+ Operator::Multiply | Operator::Divide => Precedence::Product,
+ }
+}
+
+fn render_at<'name>(
+ formula: &Formula,
+ name: &impl Fn(ColumnId) -> Option<&'name str>,
+ outer: Precedence,
+) -> String {
+ match formula {
+ Formula::Column { column } => match name(*column) {
+ Some(name) if lexer::is_word(name) => name.to_owned(),
+ Some(name) => format!("{{{name}}}"),
+ None => "{?}".into(),
+ },
+ Formula::Number { value } => value.to_string(),
+ Formula::Binary {
+ operator,
+ left,
+ right,
+ } => {
+ let own = precedence(*operator);
+ // Left-associative: an equal-precedence right operand keeps its
+ // parentheses, `a - (b - c)`.
+ let right_floor = match own {
+ Precedence::Sum => Precedence::Product,
+ _ => Precedence::Unary,
+ };
+ let text = format!(
+ "{} {} {}",
+ render_at(left, name, own),
+ operator.symbol(),
+ render_at(right, name, right_floor)
+ );
+ if own < outer {
+ format!("({text})")
+ } else {
+ text
+ }
+ }
+ Formula::Negate { operand } => {
+ format!("-{}", render_at(operand, name, Precedence::Unary))
+ }
+ }
+}
+
+/// What the formula's cells hold, if its columns and operators fit. `own`
+/// is the derived column the formula is for, when it exists already, so a
+/// formula reading it, directly or through another derived column, is
+/// refused as a cycle.
+pub fn check(
+ table: &Table,
+ own: Option<ColumnId>,
+ formula: &Formula,
+) -> Result<FormulaType, String> {
+ let mut path: Vec<ColumnId> = own.into_iter().collect();
+ check_in(table, formula, &mut path).map_err(|error| match error {
+ CheckError::Cycle(name) => {
+ format!("{name} can't be used here: its value depends on this column.")
+ }
+ CheckError::Other(message) => message,
+ })
+}
+
+/// Why a formula does not check. A cycle names the column the formula
+/// itself reads, however deep the loop closes.
+enum CheckError {
+ Cycle(String),
+ Other(String),
+}
+
+fn check_in(
+ table: &Table,
+ formula: &Formula,
+ path: &mut Vec<ColumnId>,
+) -> Result<FormulaType, CheckError> {
+ match formula {
+ Formula::Column { column } => {
+ let found = placement(table, *column).ok_or_else(|| {
+ CheckError::Other("The formula names a column this table no longer has.".into())
+ })?;
+ if path.contains(column) {
+ return Err(CheckError::Cycle(found.name.clone()));
+ }
+ match &found.formula {
+ Some(inner) => {
+ if path.len() >= MAX_DEPTH {
+ return Err(CheckError::Other("Formulas nest too deeply.".into()));
+ }
+ path.push(*column);
+ let result = check_in(table, inner, path);
+ path.pop();
+ result.map_err(|error| match error {
+ CheckError::Cycle(_) => CheckError::Cycle(found.name.clone()),
+ other => other,
+ })
+ }
+ None => match found.kind {
+ ColumnKind::Number => Ok(FormulaType::Number),
+ ColumnKind::Date => Ok(FormulaType::Date),
+ ref other => Err(CheckError::Other(format!(
+ "{} is {} {} column; formulas use number and date columns.",
+ found.name,
+ article(other.describe()),
+ other.describe()
+ ))),
+ },
+ }
+ }
+ Formula::Number { value } if value.is_finite() => Ok(FormulaType::Number),
+ Formula::Number { .. } => Err(CheckError::Other(
+ "Numbers in a formula must be finite.".into(),
+ )),
+ Formula::Negate { operand } => match check_in(table, operand, path)? {
+ FormulaType::Number => Ok(FormulaType::Number),
+ FormulaType::Date => Err(CheckError::Other("A date can't be negated.".into())),
+ },
+ Formula::Binary {
+ operator,
+ left,
+ right,
+ } => {
+ let left = check_in(table, left, path)?;
+ let right = check_in(table, right, path)?;
+ combine(*operator, left, right).ok_or_else(|| {
+ let (left, right) = (describe(left), describe(right));
+ CheckError::Other(match operator {
+ Operator::Add => format!("A {right} can't be added to a {left}."),
+ Operator::Subtract => {
+ format!("A {right} can't be subtracted from a {left}.")
+ }
+ Operator::Multiply => format!("A {left} can't be multiplied by a {right}."),
+ Operator::Divide => format!("A {left} can't be divided by a {right}."),
+ })
+ })
+ }
+ }
+}
+
+fn article(word: &str) -> &'static str {
+ match word.chars().next() {
+ Some('a' | 'e' | 'i' | 'o' | 'u') => "an",
+ _ => "a",
+ }
+}
+
+fn describe(kind: FormulaType) -> &'static str {
+ match kind {
+ FormulaType::Number => "number",
+ FormulaType::Date => "date",
+ }
+}
+
+/// The type of `left operator right`, if the operator takes those types.
+fn combine(operator: Operator, left: FormulaType, right: FormulaType) -> Option<FormulaType> {
+ use FormulaType::{Date, Number};
+ match (operator, left, right) {
+ (_, Number, Number) => Some(Number),
+ (Operator::Add, Date, Number) | (Operator::Add, Number, Date) => Some(Date),
+ (Operator::Subtract, Date, Number) => Some(Date),
+ (Operator::Subtract, Date, Date) => Some(Number),
+ _ => None,
+ }
+}
+
+fn placement(table: &Table, column: ColumnId) -> Option<&Column> {
+ table
+ .columns
+ .iter()
+ .find(|candidate| candidate.placement == column)
+}
+
+/// The formula's value on a row whose cells `cells` holds, each column's
+/// under `key(definition)`. `None` is an empty cell.
+pub fn evaluate(
+ table: &Table,
+ formula: &Formula,
+ cells: &HashMap<Uuid, Cell>,
+ key: impl Fn(Uuid) -> Uuid + Copy,
+) -> Option<Cell> {
+ let row = Row { table, cells, key };
+ if !row.any_present(formula, 0) {
+ return None;
+ }
+ match row.value(formula, 0)? {
+ Value::Number(number) if number.is_finite() => Some(Cell::Number(number)),
+ Value::Number(_) => None,
+ Value::Date(date) => Some(Cell::Date(date)),
+ }
+}
+
+/// A value mid-evaluation.
+#[derive(Debug, Clone, Copy)]
+enum Value {
+ Number(f64),
+ Date(DateTime<Utc>),
+}
+
+struct Row<'a, Key> {
+ table: &'a Table,
+ cells: &'a HashMap<Uuid, Cell>,
+ key: Key,
+}
+
+impl<Key: Fn(Uuid) -> Uuid + Copy> Row<'_, Key> {
+ /// Whether any column the formula reads, through derived columns too,
+ /// has a value on this row.
+ fn any_present(&self, formula: &Formula, depth: usize) -> bool {
+ if depth > MAX_DEPTH {
+ return false;
+ }
+ formula.columns().into_iter().any(|column| {
+ let Some(found) = placement(self.table, column) else {
+ return false;
+ };
+ match &found.formula {
+ Some(inner) => self.any_present(inner, depth + 1),
+ None => self.cells.contains_key(&(self.key)(found.id)),
+ }
+ })
+ }
+
+ fn value(&self, formula: &Formula, depth: usize) -> Option<Value> {
+ if depth > MAX_DEPTH {
+ return None;
+ }
+ match formula {
+ Formula::Number { value } => Some(Value::Number(*value)),
+ Formula::Column { column } => {
+ let found = placement(self.table, *column)?;
+ match (&found.formula, &found.kind) {
+ (Some(inner), _) => self.value(inner, depth + 1),
+ (None, ColumnKind::Number) => match self.cells.get(&(self.key)(found.id)) {
+ Some(Cell::Number(number)) => Some(Value::Number(*number)),
+ None => Some(Value::Number(0.0)),
+ Some(_) => None,
+ },
+ (None, ColumnKind::Date) => match self.cells.get(&(self.key)(found.id)) {
+ Some(Cell::Date(date)) => Some(Value::Date(*date)),
+ _ => None,
+ },
+ (None, _) => None,
+ }
+ }
+ Formula::Negate { operand } => match self.value(operand, depth)? {
+ Value::Number(number) => Some(Value::Number(-number)),
+ Value::Date(_) => None,
+ },
+ Formula::Binary {
+ operator,
+ left,
+ right,
+ } => apply(
+ *operator,
+ self.value(left, depth)?,
+ self.value(right, depth)?,
+ ),
+ }
+ }
+}
+
+fn apply(operator: Operator, left: Value, right: Value) -> Option<Value> {
+ match (operator, left, right) {
+ (Operator::Add, Value::Number(left), Value::Number(right)) => {
+ Some(Value::Number(left + right))
+ }
+ (Operator::Subtract, Value::Number(left), Value::Number(right)) => {
+ Some(Value::Number(left - right))
+ }
+ (Operator::Multiply, Value::Number(left), Value::Number(right)) => {
+ Some(Value::Number(left * right))
+ }
+ (Operator::Divide, Value::Number(left), Value::Number(right)) => {
+ Some(Value::Number(left / right))
+ }
+ (Operator::Add, Value::Date(date), Value::Number(days))
+ | (Operator::Add, Value::Number(days), Value::Date(date)) => {
+ shift(date, days).map(Value::Date)
+ }
+ (Operator::Subtract, Value::Date(date), Value::Number(days)) => {
+ shift(date, -days).map(Value::Date)
+ }
+ (Operator::Subtract, Value::Date(left), Value::Date(right)) => Some(Value::Number(
+ (left - right).num_milliseconds() as f64 / MILLISECONDS_PER_DAY,
+ )),
+ _ => None,
+ }
+}
+
+const MILLISECONDS_PER_DAY: f64 = 86_400_000.0;
+
+/// `date` moved by `days`, which may be fractional; `None` past the range
+/// a date can hold.
+fn shift(date: DateTime<Utc>, days: f64) -> Option<DateTime<Utc>> {
+ let milliseconds = days * MILLISECONDS_PER_DAY;
+ if !milliseconds.is_finite() || milliseconds.abs() > i64::MAX as f64 {
+ return None;
+ }
+ date.checked_add_signed(Duration::milliseconds(milliseconds.round() as i64))
+}
+
+/// The derived columns of `table`, each with its formula.
+pub fn derived(table: &Table) -> impl Iterator<Item = (&Column, &Formula)> {
+ table
+ .columns
+ .iter()
+ .filter_map(|column| column.formula.as_ref().map(|formula| (column, formula)))
+}
diff --git a/crates/database_sql/src/formula/lexer.rs b/crates/database_sql/src/formula/lexer.rs
new file mode 100644
index 0000000000..5e6ffb9dec
--- /dev/null
+++ b/crates/database_sql/src/formula/lexer.rs
@@ -0,0 +1,72 @@
+//! Formula tokens: numbers, column names (a word, or anything in braces),
+//! the four operators and parentheses.
+
+use std::ops::Range;
+
+use logos::Logos;
+
+use crate::parse::ParseError;
+
+/// A token kind; a name holds its text, braces removed.
+#[derive(Logos, Debug, Clone, PartialEq)]
+#[logos(skip r"[ \t\r\n]+")]
+pub(super) enum TokenKind {
+ #[token("+")]
+ Plus,
+ #[token("-")]
+ Minus,
+ #[token("*")]
+ Star,
+ #[token("/")]
+ Slash,
+ #[token("(")]
+ LeftParen,
+ #[token(")")]
+ RightParen,
+ #[regex(r"([0-9]+\.?[0-9]*|\.[0-9]+)([eE][+-]?[0-9]+)?", |lexer| lexer.slice().parse().ok())]
+ Number(f64),
+ #[regex(r"\{[^{}]*\}", |lexer| { let slice = lexer.slice(); slice[1..slice.len() - 1].trim().to_owned() })]
+ Braced(String),
+ #[regex(r"[\p{L}_][\p{L}\p{N}_]*", |lexer| lexer.slice().to_owned())]
+ Word(String),
+}
+
+/// A token with the byte range it came from.
+#[derive(Debug, Clone, PartialEq)]
+pub(super) struct Token {
+ pub(super) kind: TokenKind,
+ pub(super) span: Range<usize>,
+}
+
+/// Tokenize the whole formula, failing on the first character no token
+/// matches.
+pub(super) fn lex(text: &str) -> Result<Vec<Token>, ParseError> {
+ let mut lexer = TokenKind::lexer(text);
+ let mut tokens = Vec::new();
+ while let Some(result) = lexer.next() {
+ let span = lexer.span();
+ match result {
+ Ok(kind) => tokens.push(Token { kind, span }),
+ Err(()) if text[span.start..].starts_with('{') => {
+ return Err(ParseError {
+ span: span.start..text.len(),
+ message: "A `{` needs a closing `}`.".into(),
+ });
+ }
+ Err(()) => {
+ let found = &text[span.clone()];
+ return Err(ParseError {
+ span,
+ message: format!("`{found}` can't be used in a formula."),
+ });
+ }
+ }
+ }
+ Ok(tokens)
+}
+
+/// Whether `name` reads back as one bare word, so it needs no braces.
+pub(super) fn is_word(name: &str) -> bool {
+ let mut lexer = TokenKind::lexer(name);
+ matches!(lexer.next(), Some(Ok(TokenKind::Word(_)))) && lexer.span() == (0..name.len())
+}
diff --git a/crates/database_sql/src/formula/parser.rs b/crates/database_sql/src/formula/parser.rs
new file mode 100644
index 0000000000..b65578fbee
--- /dev/null
+++ b/crates/database_sql/src/formula/parser.rs
@@ -0,0 +1,231 @@
+//! nom combinators over the formula's tokens, one function per grammar rule.
+//! A rule that declines its first token fails recoverably, so `alt` can try
+//! the next; once a rule has committed (read an operator or a `(`), what
+//! follows is `cut`, and its failure is final.
+
+use nom::branch::alt;
+use nom::combinator::{cut, opt};
+use nom::multi::many0;
+use nom::{Finish, IResult, Input, Parser};
+
+use models_databases::{Formula, Operator};
+
+use super::lexer::{self, Token, TokenKind};
+use crate::catalog::Table;
+use crate::parse::ParseError;
+use crate::parse::tokens::Tokens;
+
+type Formulas<'a> = Tokens<'a, Token>;
+type Parsed<'a, Output> = IResult<Formulas<'a>, Output, ParseError>;
+
+impl nom::error::ParseError<Formulas<'_>> for ParseError {
+ fn from_error_kind(input: Formulas<'_>, _: nom::error::ErrorKind) -> Self {
+ expected_operand(input)
+ }
+
+ fn append(_: Formulas<'_>, _: nom::error::ErrorKind, other: Self) -> Self {
+ other
+ }
+}
+
+pub(super) fn formula(table: &Table, text: &str) -> Result<Formula, ParseError> {
+ if text.trim().is_empty() {
+ return Err(ParseError {
+ span: 0..0,
+ message: "Write a formula, like `Price * Quantity`.".into(),
+ });
+ }
+ let tokens = lexer::lex(text)?;
+ let input = Tokens {
+ tokens: &tokens,
+ end: text.len(),
+ };
+ let (rest, formula) = sum(table, input).finish()?;
+ match rest.first() {
+ None => Ok(formula),
+ Some(token) => Err(ParseError {
+ span: token.span.clone(),
+ message: format!(
+ "Expected an operator (+ - * /), found `{}`.",
+ &text[token.span.clone()]
+ ),
+ }),
+ }
+}
+
+/// What the next token should have been: something to compute with.
+fn expected_operand(input: Formulas<'_>) -> ParseError {
+ match input.first() {
+ Some(token) => ParseError {
+ span: token.span.clone(),
+ message: "Expected a column, a number or `(` here.".into(),
+ },
+ None => ParseError {
+ span: input.end..input.end,
+ message: "The formula ends too soon.".into(),
+ },
+ }
+}
+
+/// The next token as `read` takes it; a recoverable failure when it
+/// declines it or none is left.
+fn next<'a, Output>(
+ read: impl Fn(&'a Token) -> Option<Output>,
+) -> impl FnMut(Formulas<'a>) -> Parsed<'a, Output> {
+ move |input: Formulas<'a>| match input.tokens.first().and_then(&read) {
+ Some(output) => Ok((input.take_from(1), output)),
+ None => Err(nom::Err::Error(expected_operand(input))),
+ }
+}
+
+fn operator<'a>(
+ operators: &'static [(TokenKind, Operator)],
+) -> impl FnMut(Formulas<'a>) -> Parsed<'a, Operator> {
+ next(move |token: &Token| {
+ operators
+ .iter()
+ .find(|(kind, _)| *kind == token.kind)
+ .map(|(_, operator)| *operator)
+ })
+}
+
+fn binary(operator: Operator, left: Formula, right: Formula) -> Formula {
+ Formula::Binary {
+ operator,
+ left: Box::new(left),
+ right: Box::new(right),
+ }
+}
+
+/// `term {(+ | -) term}`, grouping to the left.
+fn sum<'a>(table: &Table, input: Formulas<'a>) -> Parsed<'a, Formula> {
+ let (input, first) = product(table, input)?;
+ let (input, rest) = many0((
+ operator(&[
+ (TokenKind::Plus, Operator::Add),
+ (TokenKind::Minus, Operator::Subtract),
+ ]),
+ cut(|input| product(table, input)),
+ ))
+ .parse(input)?;
+ Ok((
+ input,
+ rest.into_iter().fold(first, |left, (operator, right)| {
+ binary(operator, left, right)
+ }),
+ ))
+}
+
+/// `unary {(* | /) unary}`, grouping to the left.
+fn product<'a>(table: &Table, input: Formulas<'a>) -> Parsed<'a, Formula> {
+ let (input, first) = unary(table, input)?;
+ let (input, rest) = many0((
+ operator(&[
+ (TokenKind::Star, Operator::Multiply),
+ (TokenKind::Slash, Operator::Divide),
+ ]),
+ cut(|input| unary(table, input)),
+ ))
+ .parse(input)?;
+ Ok((
+ input,
+ rest.into_iter().fold(first, |left, (operator, right)| {
+ binary(operator, left, right)
+ }),
+ ))
+}
+
+/// `- unary | atom`; a negated number is just a negative number.
+fn unary<'a>(table: &Table, input: Formulas<'a>) -> Parsed<'a, Formula> {
+ let (input, minus) = opt(next(|token: &Token| {
+ (token.kind == TokenKind::Minus).then_some(())
+ }))
+ .parse(input)?;
+ if minus.is_none() {
+ return atom(table, input);
+ }
+ let (input, operand) = cut(|input| unary(table, input)).parse(input)?;
+ Ok((
+ input,
+ match operand {
+ Formula::Number { value } => Formula::Number { value: -value },
+ operand => Formula::Negate {
+ operand: Box::new(operand),
+ },
+ },
+ ))
+}
+
+/// `number | name | ( sum )`.
+fn atom<'a>(table: &Table, input: Formulas<'a>) -> Parsed<'a, Formula> {
+ alt((
+ number,
+ |input| column(table, input),
+ |input| parenthesized(table, input),
+ ))
+ .parse(input)
+}
+
+fn number(input: Formulas<'_>) -> Parsed<'_, Formula> {
+ let (rest, (value, span)) = next(|token: &Token| match token.kind {
+ TokenKind::Number(value) => Some((value, token.span.clone())),
+ _ => None,
+ })(input)?;
+ if !value.is_finite() {
+ return Err(nom::Err::Failure(ParseError {
+ span,
+ message: "That number is too large.".into(),
+ }));
+ }
+ Ok((rest, Formula::Number { value }))
+}
+
+/// A word or a braced name, as the table's column it names, ignoring case.
+fn column<'a>(table: &Table, input: Formulas<'a>) -> Parsed<'a, Formula> {
+ let (rest, (name, braced, span)) = next(|token: &Token| match &token.kind {
+ TokenKind::Word(name) => Some((name.as_str(), false, token.span.clone())),
+ TokenKind::Braced(name) => Some((name.as_str(), true, token.span.clone())),
+ _ => None,
+ })(input)?;
+ let wanted = name.to_lowercase();
+ match table
+ .columns
+ .iter()
+ .find(|column| column.name.to_lowercase() == wanted)
+ {
+ Some(column) => Ok((
+ rest,
+ Formula::Column {
+ column: column.placement,
+ },
+ )),
+ None => Err(nom::Err::Failure(ParseError {
+ span,
+ message: if braced {
+ format!("There's no column called {name}.")
+ } else {
+ format!(
+ "There's no column called {name}. Write a name with spaces in braces, like {{Unit price}}."
+ )
+ },
+ })),
+ }
+}
+
+fn parenthesized<'a>(table: &Table, input: Formulas<'a>) -> Parsed<'a, Formula> {
+ let (input, open) =
+ next(|token: &Token| (token.kind == TokenKind::LeftParen).then(|| token.span.clone()))(
+ input,
+ )?;
+ let (input, inner) = cut(|input| sum(table, input)).parse(input)?;
+ let (input, _) = next(|token: &Token| (token.kind == TokenKind::RightParen).then_some(()))(
+ input,
+ )
+ .map_err(|_| {
+ nom::Err::Failure(ParseError {
+ span: open,
+ message: "A `(` needs a closing `)`.".into(),
+ })
+ })?;
+ Ok((input, inner))
+}
diff --git a/crates/database_sql/src/formula/test.rs b/crates/database_sql/src/formula/test.rs
new file mode 100644
index 0000000000..fa7dceedce
--- /dev/null
+++ b/crates/database_sql/src/formula/test.rs
@@ -0,0 +1,304 @@
+use std::collections::HashMap;
+
+use chrono::{TimeZone, Utc};
+use models_databases::{ColumnId, DatabaseId, Formula, FormulaType, Operator, TableId};
+use uuid::Uuid;
+
+use super::*;
+use crate::catalog::{Column, ColumnKind, Table, TableSource};
+use crate::fold::Cell;
+
+const PRICE: Uuid = Uuid::from_u128(0x1);
+const QUANTITY: Uuid = Uuid::from_u128(0x2);
+const DUE: Uuid = Uuid::from_u128(0x3);
+const STARTED: Uuid = Uuid::from_u128(0x4);
+const NAME: Uuid = Uuid::from_u128(0x5);
+const TOTAL: Uuid = Uuid::from_u128(0x6);
+const WITH_TAX: Uuid = Uuid::from_u128(0x7);
+
+fn placement(definition: Uuid) -> ColumnId {
+ ColumnId::from_uuid(Uuid::from_u128(definition.as_u128() + 0x100))
+}
+
+fn column(id: Uuid) -> Formula {
+ Formula::Column {
+ column: placement(id),
+ }
+}
+
+fn binary(operator: Operator, left: Formula, right: Formula) -> Formula {
+ Formula::Binary {
+ operator,
+ left: Box::new(left),
+ right: Box::new(right),
+ }
+}
+
+/// `orders`: two numbers, two dates, a text column, `Total = Unit price *
+/// Quantity` and `With tax = Total * 1.2`.
+fn orders() -> Table {
+ let stored = |id: Uuid, name: &str, kind: ColumnKind| Column {
+ id,
+ placement: placement(id),
+ name: name.into(),
+ kind,
+ formula: None,
+ };
+ Table {
+ id: TableId::from_uuid(Uuid::from_u128(0xd0)),
+ database_id: DatabaseId::from_uuid(Uuid::from_u128(0xdb)),
+ database: "shop".into(),
+ name: "orders".into(),
+ columns: vec![
+ stored(PRICE, "Unit price", ColumnKind::Number),
+ stored(QUANTITY, "Quantity", ColumnKind::Number),
+ stored(DUE, "Due", ColumnKind::Date),
+ stored(STARTED, "Started", ColumnKind::Date),
+ stored(NAME, "Name", ColumnKind::Text),
+ Column {
+ id: TOTAL,
+ placement: placement(TOTAL),
+ name: "Total".into(),
+ kind: ColumnKind::Number,
+ formula: Some(binary(Operator::Multiply, column(PRICE), column(QUANTITY))),
+ },
+ Column {
+ id: WITH_TAX,
+ placement: placement(WITH_TAX),
+ name: "With tax".into(),
+ kind: ColumnKind::Number,
+ formula: Some(binary(
+ Operator::Multiply,
+ column(TOTAL),
+ Formula::Number { value: 1.2 },
+ )),
+ },
+ ],
+ source: TableSource::Database,
+ }
+}
+
+#[test]
+fn parses_precedence_braces_and_case() {
+ let parsed = parse(&orders(), "{unit price} * quantity + 2 - -Due / (1 + 1)").unwrap();
+
+ assert_eq!(
+ parsed,
+ binary(
+ Operator::Subtract,
+ binary(
+ Operator::Add,
+ binary(Operator::Multiply, column(PRICE), column(QUANTITY)),
+ Formula::Number { value: 2.0 },
+ ),
+ binary(
+ Operator::Divide,
+ Formula::Negate {
+ operand: Box::new(column(DUE)),
+ },
+ binary(
+ Operator::Add,
+ Formula::Number { value: 1.0 },
+ Formula::Number { value: 1.0 },
+ ),
+ ),
+ )
+ );
+}
+
+#[test]
+fn subtraction_is_left_associative() {
+ assert_eq!(
+ parse(&orders(), "Quantity - 1 - 2").unwrap(),
+ binary(
+ Operator::Subtract,
+ binary(
+ Operator::Subtract,
+ column(QUANTITY),
+ Formula::Number { value: 1.0 },
+ ),
+ Formula::Number { value: 2.0 },
+ )
+ );
+}
+
+#[test]
+fn parse_errors_point_at_the_problem() {
+ let error = parse(&orders(), "Quantity * Price").unwrap_err();
+ assert_eq!(error.span, 11..16);
+ assert_eq!(
+ error.message,
+ "There's no column called Price. Write a name with spaces in braces, like {Unit price}."
+ );
+
+ let error = parse(&orders(), "Quantity *").unwrap_err();
+ assert_eq!(error.message, "The formula ends too soon.");
+
+ let error = parse(&orders(), "Quantity 2").unwrap_err();
+ assert_eq!(error.span, 9..10);
+ assert_eq!(error.message, "Expected an operator (+ - * /), found `2`.");
+
+ let error = parse(&orders(), "(Quantity + 1").unwrap_err();
+ assert_eq!(error.message, "A `(` needs a closing `)`.");
+
+ let error = parse(&orders(), "{Unit price * 2").unwrap_err();
+ assert_eq!(error.message, "A `{` needs a closing `}`.");
+
+ let error = parse(&orders(), "Quantity % 2").unwrap_err();
+ assert_eq!(error.span, 9..10);
+ assert_eq!(error.message, "`%` can't be used in a formula.");
+
+ let error = parse(&orders(), "Quantity * * 2").unwrap_err();
+ assert_eq!(error.span, 11..12);
+ assert_eq!(error.message, "Expected a column, a number or `(` here.");
+
+ let error = parse(&orders(), " ").unwrap_err();
+ assert_eq!(error.message, "Write a formula, like `Price * Quantity`.");
+}
+
+#[test]
+fn renders_with_current_names_and_minimal_parentheses() {
+ let table = orders();
+ for text in [
+ "{Unit price} * Quantity + 2",
+ "{Unit price} * (Quantity + 2)",
+ "Quantity - (1 - 2)",
+ "Quantity - 1 - 2",
+ "-Quantity * 1.5",
+ "-(Quantity + 1)",
+ "Due + 7",
+ ] {
+ assert_eq!(render(&table, &parse(&table, text).unwrap()), text);
+ }
+
+ let mut renamed = orders();
+ renamed.columns[1].name = "Qty".into();
+ assert_eq!(
+ render(&renamed, &parse(&table, "Quantity * 2").unwrap()),
+ "Qty * 2"
+ );
+}
+
+#[test]
+fn checks_types() {
+ let table = orders();
+ let check_text = |text: &str| check(&table, None, &parse(&table, text).unwrap());
+
+ assert_eq!(
+ check_text("{Unit price} * Quantity"),
+ Ok(FormulaType::Number)
+ );
+ assert_eq!(check_text("Due + 7"), Ok(FormulaType::Date));
+ assert_eq!(check_text("7 + Due"), Ok(FormulaType::Date));
+ assert_eq!(check_text("Due - 1.5"), Ok(FormulaType::Date));
+ assert_eq!(check_text("Due - Started"), Ok(FormulaType::Number));
+ assert_eq!(check_text("{With tax} / 2"), Ok(FormulaType::Number));
+ assert_eq!(
+ check_text("Due + Started"),
+ Err("A date can't be added to a date.".into())
+ );
+ assert_eq!(
+ check_text("Due * 2"),
+ Err("A date can't be multiplied by a number.".into())
+ );
+ assert_eq!(
+ check_text("1 - Due"),
+ Err("A date can't be subtracted from a number.".into())
+ );
+ assert_eq!(
+ check_text("2 / Due"),
+ Err("A number can't be divided by a date.".into())
+ );
+ assert_eq!(check_text("-Due"), Err("A date can't be negated.".into()));
+ assert_eq!(
+ check_text("Name + 1"),
+ Err("Name is a text column; formulas use number and date columns.".into())
+ );
+}
+
+#[test]
+fn refuses_cycles_through_derived_columns() {
+ let table = orders();
+ let reads_with_tax = parse(&table, "{With tax} + 1").unwrap();
+
+ assert_eq!(
+ check(&table, Some(placement(TOTAL)), &reads_with_tax),
+ Err("With tax can't be used here: its value depends on this column.".into())
+ );
+ assert_eq!(
+ check(&table, Some(placement(TOTAL)), &column(TOTAL)),
+ Err("Total can't be used here: its value depends on this column.".into())
+ );
+ assert_eq!(
+ check(&table, Some(placement(QUANTITY)), &reads_with_tax),
+ Err("With tax can't be used here: its value depends on this column.".into())
+ );
+ assert_eq!(
+ check(&table, Some(placement(STARTED)), &reads_with_tax),
+ Ok(FormulaType::Number)
+ );
+}
+
+#[test]
+fn evaluates_numbers_dates_and_empties() {
+ let table = orders();
+ let due = Utc.with_ymd_and_hms(2026, 10, 1, 9, 0, 0).unwrap();
+ let started = Utc.with_ymd_and_hms(2026, 9, 21, 9, 0, 0).unwrap();
+ let cells = HashMap::from([
+ (PRICE, Cell::Number(2.5)),
+ (QUANTITY, Cell::Number(4.0)),
+ (DUE, Cell::Date(due)),
+ (STARTED, Cell::Date(started)),
+ ]);
+ let value = |text: &str, cells: &HashMap<Uuid, Cell>| {
+ evaluate(&table, &parse(&table, text).unwrap(), cells, |id| id)
+ };
+
+ assert_eq!(
+ value("{Unit price} * Quantity", &cells),
+ Some(Cell::Number(10.0))
+ );
+ assert_eq!(value("{With tax}", &cells), Some(Cell::Number(12.0)));
+ assert_eq!(
+ value("Due + 7", &cells),
+ Some(Cell::Date(
+ Utc.with_ymd_and_hms(2026, 10, 8, 9, 0, 0).unwrap()
+ ))
+ );
+ assert_eq!(
+ value("Due - 0.5", &cells),
+ Some(Cell::Date(
+ Utc.with_ymd_and_hms(2026, 9, 30, 21, 0, 0).unwrap()
+ ))
+ );
+ assert_eq!(value("Due - Started", &cells), Some(Cell::Number(10.0)));
+ assert_eq!(value("Quantity / 0", &cells), None);
+
+ // An empty number reads as 0 while another input has a value...
+ let only_price = HashMap::from([(PRICE, Cell::Number(2.5))]);
+ assert_eq!(
+ value("{Unit price} + Quantity", &only_price),
+ Some(Cell::Number(2.5))
+ );
+ // ...but with every input empty, so is the result.
+ assert_eq!(value("{Unit price} + Quantity", &HashMap::new()), None);
+ assert_eq!(value("{With tax}", &HashMap::new()), None);
+ // An empty date has no stand-in.
+ assert_eq!(value("Due - Started", &only_price), None);
+ assert_eq!(value("Due + Quantity", &only_price), None);
+}
+
+#[test]
+fn evaluates_under_relation_keys() {
+ let table = orders();
+ let key = |id: Uuid| Uuid::new_v5(&id, &[1]);
+ let cells = HashMap::from([
+ (key(PRICE), Cell::Number(3.0)),
+ (key(QUANTITY), Cell::Number(2.0)),
+ ]);
+
+ assert_eq!(
+ evaluate(&table, &column(TOTAL), &cells, key),
+ Some(Cell::Number(6.0))
+ );
+}
diff --git a/crates/database_sql/src/lib.rs b/crates/database_sql/src/lib.rs
index 21bd68223d..3ae7f79d84 100644
--- a/crates/database_sql/src/lib.rs
+++ b/crates/database_sql/src/lib.rs
@@ -19,6 +19,7 @@
pub mod catalog;
pub mod engine;
pub mod fold;
+pub mod formula;
pub mod parse;
pub mod resolve;
pub mod run;
diff --git a/crates/database_sql/src/parse.rs b/crates/database_sql/src/parse.rs
index 0be2099540..4ad8c2ec74 100644
--- a/crates/database_sql/src/parse.rs
+++ b/crates/database_sql/src/parse.rs
@@ -43,11 +43,12 @@
//! it.
pub mod ast;
-mod lexer;
+pub(crate) mod lexer;
mod parser;
pub mod schema;
#[cfg(test)]
mod test;
+pub(crate) mod tokens;
use std::ops::Range;
@@ -77,9 +78,9 @@ impl std::error::Error for ParseError {}
#[derive(specta::Type)]
#[expect(
dead_code,
- reason = "only its shape is exported, for the span of a ParseError"
+ reason = "only its shape is exported, for the spans of a ParseError and a FormulaReading"
)]
-struct Span {
+pub(crate) struct Span {
start: u32,
end: u32,
}
diff --git a/crates/database_sql/src/parse/parser.rs b/crates/database_sql/src/parse/parser.rs
index 3e6b0d0420..ed62a35fda 100644
--- a/crates/database_sql/src/parse/parser.rs
+++ b/crates/database_sql/src/parse/parser.rs
@@ -21,77 +21,12 @@ use nom::bytes::complete::take;
use nom::combinator::{cut, eof, map_opt, opt, peek};
use nom::multi::separated_list1;
use nom::sequence::{delimited, preceded, terminated};
-use nom::{Finish, IResult, Input, Parser};
+use nom::{Finish, IResult, Parser};
use super::ParseError;
use super::ast::{ColumnRef, Identifier, Literal, Statement, TableName};
use super::lexer::{Token, TokenKind};
-
-/// The input: the statement's tokens and where the statement ends. A
-/// newtype because nom implements [`Input`] only for bytes and `&str`.
-#[derive(Debug, Clone, Copy)]
-pub struct Tokens<'a> {
- tokens: &'a [Token],
- end: usize,
-}
-
-impl std::ops::Deref for Tokens<'_> {
- type Target = [Token];
- fn deref(&self) -> &Self::Target {
- self.tokens
- }
-}
-
-impl<'a> Input for Tokens<'a> {
- type Item = &'a Token;
- type Iter = std::slice::Iter<'a, Token>;
- type IterIndices = std::iter::Enumerate<std::slice::Iter<'a, Token>>;
-
- fn input_len(&self) -> usize {
- self.tokens.len()
- }
- fn take(&self, index: usize) -> Self {
- Tokens {
- tokens: &self.tokens[..index],
- end: self.end,
- }
- }
- fn take_from(&self, index: usize) -> Self {
- Tokens {
- tokens: &self.tokens[index..],
- end: self.end,
- }
- }
- fn take_split(&self, index: usize) -> (Self, Self) {
- let (head, tail) = self.tokens.split_at(index);
- (
- Tokens {
- tokens: tail,
- end: self.end,
- },
- Tokens {
- tokens: head,
- end: self.end,
- },
- )
- }
- fn position<Predicate: Fn(Self::Item) -> bool>(&self, predicate: Predicate) -> Option<usize> {
- self.tokens.iter().position(predicate)
- }
- fn iter_elements(&self) -> Self::Iter {
- self.tokens.iter()
- }
- fn iter_indices(&self) -> Self::IterIndices {
- self.tokens.iter().enumerate()
- }
- fn slice_index(&self, count: usize) -> Result<usize, nom::Needed> {
- if count <= self.tokens.len() {
- Ok(count)
- } else {
- Err(nom::Needed::new(count - self.tokens.len()))
- }
- }
-}
+pub(crate) use super::tokens::Tokens;
type ParseResult<'a, Output> = IResult<Tokens<'a>, Output, ParseError>;
diff --git a/crates/database_sql/src/parse/tokens.rs b/crates/database_sql/src/parse/tokens.rs
new file mode 100644
index 0000000000..3db190ac98
--- /dev/null
+++ b/crates/database_sql/src/parse/tokens.rs
@@ -0,0 +1,82 @@
+//! A token slice as nom input, for the SQL statement parser and the formula
+//! parser alike.
+
+use nom::Input;
+
+use super::lexer::Token;
+
+/// The input: the tokens left and where the source ends, so an error at the
+/// end has a position. A newtype because nom implements [`Input`] only for
+/// bytes and `&str`.
+#[derive(Debug)]
+pub(crate) struct Tokens<'a, Item = Token> {
+ pub(crate) tokens: &'a [Item],
+ pub(crate) end: usize,
+}
+
+// By hand: a derive would ask `Item: Copy`, though only a reference is held.
+impl<Item> Clone for Tokens<'_, Item> {
+ fn clone(&self) -> Self {
+ *self
+ }
+}
+
+impl<Item> Copy for Tokens<'_, Item> {}
+
+impl<Item> std::ops::Deref for Tokens<'_, Item> {
+ type Target = [Item];
+ fn deref(&self) -> &Self::Target {
+ self.tokens
+ }
+}
+
+impl<'a, Item> Input for Tokens<'a, Item> {
+ type Item = &'a Item;
+ type Iter = std::slice::Iter<'a, Item>;
+ type IterIndices = std::iter::Enumerate<std::slice::Iter<'a, Item>>;
+
+ fn input_len(&self) -> usize {
+ self.tokens.len()
+ }
+ fn take(&self, index: usize) -> Self {
+ Tokens {
+ tokens: &self.tokens[..index],
+ end: self.end,
+ }
+ }
+ fn take_from(&self, index: usize) -> Self {
+ Tokens {
+ tokens: &self.tokens[index..],
+ end: self.end,
+ }
+ }
+ fn take_split(&self, index: usize) -> (Self, Self) {
+ let (head, tail) = self.tokens.split_at(index);
+ (
+ Tokens {
+ tokens: tail,
+ end: self.end,
+ },
+ Tokens {
+ tokens: head,
+ end: self.end,
+ },
+ )
+ }
+ fn position<Predicate: Fn(Self::Item) -> bool>(&self, predicate: Predicate) -> Option<usize> {
+ self.tokens.iter().position(predicate)
+ }
+ fn iter_elements(&self) -> Self::Iter {
+ self.tokens.iter()
+ }
+ fn iter_indices(&self) -> Self::IterIndices {
+ self.tokens.iter().enumerate()
+ }
+ fn slice_index(&self, count: usize) -> Result<usize, nom::Needed> {
+ if count <= self.tokens.len() {
+ Ok(count)
+ } else {
+ Err(nom::Needed::new(count - self.tokens.len()))
+ }
+ }
+}
diff --git a/crates/database_sql/src/resolve.rs b/crates/database_sql/src/resolve.rs
index af247d997c..6ec7fd0203 100644
--- a/crates/database_sql/src/resolve.rs
+++ b/crates/database_sql/src/resolve.rs
@@ -342,7 +342,7 @@ pub fn resolve(catalog: &Catalog, statement: Statement) -> Result<Query, Resolve
}
Statement::AlterColumnType(alter) => {
let table = writable(names::table(catalog, &alter.table)?)?;
- let column = names::column(table, &alter.column)?;
+ let column = write::stored_column(names::column(table, &alter.column)?)?;
// No data is read here, so the column is taken to hold values;
// the writer knows better and lets an empty one take any type.
if let Cast::Never(reason) = cast(
diff --git a/crates/database_sql/src/resolve/error.rs b/crates/database_sql/src/resolve/error.rs
index 306333763c..b8c272b41c 100644
--- a/crates/database_sql/src/resolve/error.rs
+++ b/crates/database_sql/src/resolve/error.rs
@@ -137,6 +137,12 @@ pub enum ResolveError {
/// The column.
column: String,
},
+ /// An `INSERT` or `UPDATE` writes a derived column, whose cells its
+ /// formula computes.
+ DerivedColumn {
+ /// The column.
+ column: String,
+ },
/// Two tables of a `SELECT` share an alias.
DuplicateAlias {
/// The alias.
@@ -327,6 +333,10 @@ impl fmt::Display for ResolveError {
Self::DuplicateColumn { column } => {
write!(f, "\"{column}\" is listed twice")
}
+ Self::DerivedColumn { column } => write!(
+ f,
+ "\"{column}\" is computed by its formula and can't be written; write the columns it reads instead"
+ ),
Self::DuplicateAlias { alias, table } => write!(
f,
"\"{alias}\" already names {table}; give the other table an alias, like JOIN crm.people p"
diff --git a/crates/database_sql/src/resolve/names.rs b/crates/database_sql/src/resolve/names.rs
index 6471c97544..963f811089 100644
--- a/crates/database_sql/src/resolve/names.rs
+++ b/crates/database_sql/src/resolve/names.rs
@@ -30,12 +30,14 @@ pub fn virtual_columns(table: TableId) -> [Column; 2] {
multi: false,
target: EntityKind::Row,
},
+ formula: None,
},
Column {
id: row_position_key(table),
placement: ColumnId::from_uuid(row_position_key(table)),
name: ROW_POSITION.into(),
kind: ColumnKind::Text,
+ formula: None,
},
]
}
diff --git a/crates/database_sql/src/resolve/test.rs b/crates/database_sql/src/resolve/test.rs
index dd5248e907..6dbcbb2e19 100644
--- a/crates/database_sql/src/resolve/test.rs
+++ b/crates/database_sql/src/resolve/test.rs
@@ -850,6 +850,7 @@ fn exact_case_resolves_a_case_insensitive_collision() {
placement: ColumnId::from_uuid(Uuid::from_u128(id + 0x100)),
name: "Name".into(),
kind: ColumnKind::Text,
+ formula: None,
}],
};
let catalog = Catalog {
diff --git a/crates/database_sql/src/resolve/write.rs b/crates/database_sql/src/resolve/write.rs
index ddd867ac61..23db82ecc3 100644
--- a/crates/database_sql/src/resolve/write.rs
+++ b/crates/database_sql/src/resolve/write.rs
@@ -18,7 +18,7 @@ use super::{
pub fn resolve_insert(table: &Table, insert: Insert) -> Result<InsertQuery, ResolveError> {
let mut columns = Vec::with_capacity(insert.columns.len());
for name in &insert.columns {
- let column = names::column(table, name)?;
+ let column = stored_column(names::column(table, name)?)?;
if columns
.iter()
.any(|seen: &&crate::catalog::Column| seen.id == column.id)
@@ -53,7 +53,7 @@ pub fn resolve_update(catalog: &Catalog, update: Update) -> Result<UpdateQuery,
let table = names::table(catalog, &update.table)?;
let mut assignments: Vec<Assignment> = Vec::with_capacity(update.assignments.len());
for (name, value) in update.assignments {
- let column = names::column(table, &name)?;
+ let column = stored_column(names::column(table, &name)?)?;
if assignments.iter().any(|seen| seen.column == column.id) {
return Err(ResolveError::DuplicateColumn {
column: column.name.clone(),
@@ -88,6 +88,18 @@ pub fn resolve_update(catalog: &Catalog, update: Update) -> Result<UpdateQuery,
})
}
+/// The column, unless a formula computes its cells.
+pub(super) fn stored_column(
+ column: &crate::catalog::Column,
+) -> Result<&crate::catalog::Column, ResolveError> {
+ match column.formula {
+ Some(_) => Err(ResolveError::DerivedColumn {
+ column: column.name.clone(),
+ }),
+ None => Ok(column),
+ }
+}
+
pub fn resolve_delete(catalog: &Catalog, delete: Delete) -> Result<DeleteQuery, ResolveError> {
let read = rows_where(catalog, &delete.table, delete.where_)?;
Ok(DeleteQuery {
diff --git a/crates/database_sql/src/run.rs b/crates/database_sql/src/run.rs
index 0d26a48b85..9d037835c2 100644
--- a/crates/database_sql/src/run.rs
+++ b/crates/database_sql/src/run.rs
@@ -311,6 +311,9 @@ pub enum OpResultKind {
/// [`OpResult::ReorderTables`].
#[strum(serialize = "tables reordered")]
TablesReordered,
+ /// [`ColumnResult::FormulaSet`] of an [`OpResult::Column`].
+ #[strum(serialize = "a formula set")]
+ FormulaSet,
}
impl From<&OpResult> for OpResultKind {
@@ -352,6 +355,10 @@ impl From<&OpResult> for OpResultKind {
change: ColumnResult::Deleted,
..
} => OpResultKind::ColumnDeleted,
+ OpResult::Column {
+ change: ColumnResult::FormulaSet,
+ ..
+ } => OpResultKind::FormulaSet,
OpResult::Column {
change: ColumnResult::OptionsAdded { .. },
..
@@ -418,6 +425,8 @@ pub enum Input {
Outcome,
/// The stored positions of a board's cards.
Positions,
+ /// A derived column's formula, or the table or column it is for.
+ Formula,
}
impl From<CompileError> for RunError {
diff --git a/crates/database_sql/src/run/test.rs b/crates/database_sql/src/run/test.rs
index c9378266c0..934853c065 100644
--- a/crates/database_sql/src/run/test.rs
+++ b/crates/database_sql/src/run/test.rs
@@ -858,3 +858,104 @@ fn a_result_of_another_kind_than_the_op_is_refused() {
"a column type change was sent, but rows updated came back"
);
}
+
+/// `crm.deals` with `doubled = amount * 2` and `follow up = "closed at" + 7`.
+fn catalog_with_derived() -> Catalog {
+ use models_databases::{Formula, Operator};
+ let mut catalog = catalog();
+ let deals = catalog
+ .tables
+ .iter_mut()
+ .find(|table| table.id == DEALS)
+ .unwrap();
+ deals.columns.push(crate::catalog::Column {
+ id: DOUBLED,
+ placement: ColumnId::from_uuid(DOUBLED),
+ name: "doubled".into(),
+ kind: crate::catalog::ColumnKind::Number,
+ formula: Some(Formula::Binary {
+ operator: Operator::Multiply,
+ left: Box::new(Formula::Column {
+ column: ColumnId::from_uuid(AMOUNT),
+ }),
+ right: Box::new(Formula::Number { value: 2.0 }),
+ }),
+ });
+ deals.columns.push(crate::catalog::Column {
+ id: FOLLOW_UP,
+ placement: ColumnId::from_uuid(FOLLOW_UP),
+ name: "follow up".into(),
+ kind: crate::catalog::ColumnKind::Date,
+ formula: Some(Formula::Binary {
+ operator: Operator::Add,
+ left: Box::new(Formula::Column {
+ column: ColumnId::from_uuid(CLOSED_AT),
+ }),
+ right: Box::new(Formula::Number { value: 7.0 }),
+ }),
+ });
+ catalog
+}
+
+const DOUBLED: Uuid = Uuid::from_u128(0x0d);
+const FOLLOW_UP: Uuid = Uuid::from_u128(0x0e);
+
+#[test]
+fn derived_columns_are_computed_filtered_and_sorted_in_the_fold() {
+ let source = source(deals());
+ let sink = FakeSink::new();
+
+ let outcome = pollster::block_on(run(
+ &catalog_with_derived(),
+ "SELECT name, doubled, \"follow up\" FROM crm.deals WHERE doubled > 10000 OR \"follow up\" IS NOT NULL ORDER BY doubled DESC",
+ &source,
+ &sink,
+ ))
+ .unwrap();
+
+ assert_eq!(
+ outcome.rows,
+ vec![
+ vec![
+ Some(Cell::Text("Acme".into())),
+ Some(Cell::Number(24000.0)),
+ None,
+ ],
+ vec![
+ Some(Cell::Text("Initech".into())),
+ Some(Cell::Number(14000.0)),
+ None,
+ ],
+ // Hooli has no amount: with every input empty, `doubled` is
+ // empty and sorts last.
+ vec![
+ Some(Cell::Text("Hooli".into())),
+ None,
+ Some(Cell::Date(
+ Utc.with_ymd_and_hms(2026, 9, 22, 0, 0, 0).unwrap()
+ )),
+ ],
+ ]
+ );
+ assert_eq!(outcome.row_ids, vec![ACME, INITECH, HOOLI]);
+}
+
+#[test]
+fn derived_columns_cannot_be_written() {
+ let source = source(deals());
+ let sink = FakeSink::new();
+
+ let error = pollster::block_on(run(
+ &catalog_with_derived(),
+ "UPDATE crm.deals SET doubled = 1 WHERE name = 'Acme'",
+ &source,
+ &sink,
+ ))
+ .unwrap_err();
+
+ assert_eq!(
+ error.to_string(),
+ "\"doubled\" is computed by its formula and can't be written; write the columns it reads instead"
+ );
+ assert!(sink.applied.lock().unwrap().is_empty());
+}
diff --git a/crates/database_sql/src/test_support.rs b/crates/database_sql/src/test_support.rs
index 22ac82ca06..30d4a942cb 100644
--- a/crates/database_sql/src/test_support.rs
+++ b/crates/database_sql/src/test_support.rs
@@ -50,12 +50,14 @@ pub fn catalog() -> Catalog {
placement: ColumnId::from_uuid(NAME),
name: "name".into(),
kind: ColumnKind::Text,
+ formula: None,
},
Column {
id: AMOUNT,
placement: ColumnId::from_uuid(AMOUNT),
name: "amount".into(),
kind: ColumnKind::Number,
+ formula: None,
},
Column {
id: STAGE,
@@ -74,12 +76,14 @@ pub fn catalog() -> Catalog {
},
],
},
+ formula: None,
},
Column {
id: CLOSED_AT,
placement: ColumnId::from_uuid(CLOSED_AT),
name: "closed at".into(),
kind: ColumnKind::Date,
+ formula: None,
},
Column {
id: OWNER,
@@ -89,6 +93,7 @@ pub fn catalog() -> Catalog {
multi: false,
target: EntityKind::User,
},
+ formula: None,
},
Column {
id: TAGS,
@@ -101,18 +106,21 @@ pub fn catalog() -> Catalog {
label: "vip".into(),
}],
},
+ formula: None,
},
Column {
id: DONE,
placement: ColumnId::from_uuid(DONE),
name: "done".into(),
kind: ColumnKind::Boolean,
+ formula: None,
},
Column {
id: WEBSITE,
placement: ColumnId::from_uuid(WEBSITE),
name: "website".into(),
kind: ColumnKind::Link,
+ formula: None,
},
],
source: TableSource::Database,
@@ -127,6 +135,7 @@ pub fn catalog() -> Catalog {
placement: ColumnId::from_uuid(NAME),
name: "name".into(),
kind: ColumnKind::Text,
+ formula: None,
}],
source: TableSource::Database,
},
@@ -149,6 +158,7 @@ pub fn catalog() -> Catalog {
placement: ColumnId::from_uuid(TITLE),
name: "title".into(),
kind: ColumnKind::Text,
+ formula: None,
},
Column {
id: PRIORITY,
@@ -167,6 +177,7 @@ pub fn catalog() -> Catalog {
},
],
},
+ formula: None,
},
Column {
id: ASSIGNEES,
@@ -176,6 +187,7 @@ pub fn catalog() -> Catalog {
multi: true,
target: EntityKind::User,
},
+ formula: None,
},
Column {
id: DEAL,
@@ -185,6 +197,7 @@ pub fn catalog() -> Catalog {
multi: false,
target: EntityKind::Row,
},
+ formula: None,
},
],
source: TableSource::Database,
@@ -238,12 +251,14 @@ pub fn issues_catalog() -> Catalog {
placement: SUMMARY_PLACEMENT,
name: "summary".into(),
kind: ColumnKind::Text,
+ formula: None,
},
Column {
id: POINTS,
placement: POINTS_PLACEMENT,
name: "points".into(),
kind: ColumnKind::Number,
+ formula: None,
},
Column {
id: STATUS,
@@ -266,18 +281,21 @@ pub fn issues_catalog() -> Catalog {
},
],
},
+ formula: None,
},
Column {
id: DUE,
placement: DUE_PLACEMENT,
name: "due date".into(),
kind: ColumnKind::Date,
+ formula: None,
},
Column {
id: BLOCKED,
placement: BLOCKED_PLACEMENT,
name: "blocked".into(),
kind: ColumnKind::Boolean,
+ formula: None,
},
Column {
id: LABELS,
@@ -296,6 +314,7 @@ pub fn issues_catalog() -> Catalog {
},
],
},
+ formula: None,
},
Column {
id: ASSIGNEE,
@@ -305,6 +324,7 @@ pub fn issues_catalog() -> Catalog {
multi: false,
target: EntityKind::User,
},
+ formula: None,
},
Column {
id: REVIEWERS,
@@ -314,12 +334,14 @@ pub fn issues_catalog() -> Catalog {
multi: true,
target: EntityKind::User,
},
+ formula: None,
},
Column {
id: SPEC,
placement: SPEC_PLACEMENT,
name: "\"spec\" link".into(),
kind: ColumnKind::Link,
+ formula: None,
},
Column {
id: PARENT,
@@ -329,6 +351,7 @@ pub fn issues_catalog() -> Catalog {
multi: false,
target: EntityKind::Row,
},
+ formula: None,
},
],
source: TableSource::Database,
diff --git a/crates/database_sql/src/wasm.rs b/crates/database_sql/src/wasm.rs
index 934f77c3a8..4c884d1d70 100644
--- a/crates/database_sql/src/wasm.rs
+++ b/crates/database_sql/src/wasm.rs
@@ -13,17 +13,19 @@
//!
//! Only the wasm-bindgen glue lives here; the engine knows nothing of it.
-use models_databases::DatabaseId;
use models_databases::position::{self, Position};
+use models_databases::views::ViewProblem;
use models_databases::views::{CardPosition, DatabaseView};
+use models_databases::{ColumnId, DatabaseId, Formula, TableId};
use serde::Serialize;
use serde::de::DeserializeOwned;
use serde_wasm_bindgen::Serializer;
use wasm_bindgen::prelude::*;
-use crate::catalog::{Catalog, Schema, build};
+use crate::catalog::{Catalog, Schema, Table, build};
use crate::engine::{Engine, Step};
use crate::fold::Bin;
+use crate::formula;
use crate::run::{EngineError, Input, Outcome, Page, RunError};
use crate::view;
@@ -142,6 +144,65 @@ pub fn board(
)
}
+/// What `text` reads as, a `FormulaReading`, typed as the formula of a
+/// derived column of the table `table` (an id) in `catalog`; `own` is that
+/// column's placement id once it exists, so the formula cannot read itself.
+///
+/// # Errors
+///
+/// Throws an `EngineError` when the catalog cannot be read or has no such
+/// table.
+#[wasm_bindgen(js_name = readFormula)]
+pub fn read_formula(
+ catalog: JsValue,
+ table: &str,
+ own: Option<String>,
+ text: &str,
+) -> Result<JsValue, JsValue> {
+ let catalog: Catalog = read(Input::Catalog, catalog)?;
+ let table = formula_table(&catalog, table)?;
+ let own = own
+ .map(|own| own.parse::<ColumnId>())
+ .transpose()
+ .map_err(|error| unreadable(Input::Formula, error))?;
+ to_js(&formula::read(table, own, text))
+}
+
+/// `formula` (a `Formula` as JSON) as users write it, with the current
+/// names of the columns of `table` (an id) in `catalog`.
+///
+/// # Errors
+///
+/// Throws an `EngineError` when an argument cannot be read or the catalog
+/// has no such table.
+#[wasm_bindgen(js_name = renderFormula)]
+pub fn render_formula(catalog: JsValue, table: &str, formula: JsValue) -> Result<String, JsValue> {
+ let catalog: Catalog = read(Input::Catalog, catalog)?;
+ let formula: Formula = read(Input::Formula, formula)?;
+ Ok(formula::render(formula_table(&catalog, table)?, &formula))
+}
+
+fn formula_table<'catalog>(
+ catalog: &'catalog Catalog,
+ table: &str,
+) -> Result<&'catalog Table, JsValue> {
+ let id = table
+ .parse::<TableId>()
+ .map_err(|error| unreadable(Input::Formula, error))?;
+ catalog
+ .tables
+ .iter()
+ .find(|candidate| candidate.id == id)
+ .ok_or_else(|| thrown(RunError::from(ViewProblem::UnknownTable { table: id })))
+}
+
+fn unreadable(what: Input, error: impl std::fmt::Display) -> JsValue {
+ thrown(RunError::Unreadable {
+ what,
+ message: error.to_string(),
+ })
+}
+
/// A position key that sorts after `before` and before `after`; leave one
/// out to place it first or last.
///
diff --git a/crates/databases/src/domain/catalog.rs b/crates/databases/src/domain/catalog.rs
index 9a80721609..5a75da0b43 100644
--- a/crates/databases/src/domain/catalog.rs
+++ b/crates/databases/src/domain/catalog.rs
@@ -165,6 +165,36 @@ pub fn storage_schema_columns(columns: &[ColumnEntry]) -> Vec<SchemaColumn> {
.collect()
}
+/// The table as the SQL engine's catalog has it, so a view, a fold or a
+/// formula reads its columns as a statement would.
+pub fn engine_table(entry: &StorageTable, database: &str) -> database_sql::catalog::Table {
+ use database_sql::catalog::{Column, ColumnKind as EngineKind, SelectOption, TableSource};
+ database_sql::catalog::Table {
+ id: entry.table.id,
+ database_id: entry.table.database_id,
+ database: database.to_owned(),
+ name: entry.table.name.clone(),
+ source: TableSource::Database,
+ columns: entry
+ .columns
+ .iter()
+ .map(|column| Column {
+ id: column.column.property_definition_id,
+ placement: column.column.id,
+ name: column.name().to_owned(),
+ kind: EngineKind::of(
+ PropertyType::of(&column.column, &column.definition).cast_kind(),
+ option_labels(&column.definition)
+ .into_iter()
+ .map(|(id, label)| SelectOption { id, label })
+ .collect(),
+ ),
+ formula: column.column.formula().cloned(),
+ })
+ .collect(),
+ }
+}
+
/// Assemble the viewer's entries from what the repository returned.
pub fn build_entries(
databases: &[Database],
@@ -363,6 +393,7 @@ pub fn storage_schema_image<'a>(
definition_name: column.definition.definition.display_name.clone(),
definition: column.definition.definition.id,
kind: column_kind(&column.column, &column.definition),
+ formula: column.column.formula().cloned(),
options: options
.into_iter()
.map(|option| OptionImage {
diff --git a/crates/databases/src/domain/journal.rs b/crates/databases/src/domain/journal.rs
index 894cfd631a..bf86b4c827 100644
--- a/crates/databases/src/domain/journal.rs
+++ b/crates/databases/src/domain/journal.rs
@@ -135,6 +135,9 @@ pub struct RestoredColumn {
/// Whether this column permits absent values.
#[serde(default = "super::models::column_nullable_default")]
pub nullable: bool,
+ /// A derived column's formula.
+ #[serde(default, skip_serializing_if = "Option::is_none")]
+ pub formula: Option<models_databases::Formula>,
}
/// A row a delete removed: its id and place.
@@ -192,6 +195,8 @@ pub enum ColumnChangeKind {
Rename,
/// Its type changed, and its cells with it.
ChangeType,
+ /// Its formula changed.
+ SetFormula,
/// It was removed.
Delete,
/// It gained options.
@@ -388,6 +393,8 @@ pub struct ColumnImage {
pub kind: Option<ColumnKind>,
/// Its options, in order.
pub options: Vec<OptionImage>,
+ /// A derived column's formula.
+ pub formula: Option<models_databases::Formula>,
}
/// An option as the planner read it.
diff --git a/crates/databases/src/domain/journal/entries.rs b/crates/databases/src/domain/journal/entries.rs
index 682ccce49a..adecdf556c 100644
--- a/crates/databases/src/domain/journal/entries.rs
+++ b/crates/databases/src/domain/journal/entries.rs
@@ -427,6 +427,7 @@ fn column_touches(planned: &[Planned<'_>]) -> Vec<ColumnTouch> {
ColumnChange::Create { .. } => ColumnChangeKind::Create,
ColumnChange::Rename { .. } => ColumnChangeKind::Rename,
ColumnChange::ChangeType { .. } => ColumnChangeKind::ChangeType,
+ ColumnChange::SetFormula { .. } => ColumnChangeKind::SetFormula,
ColumnChange::Delete => ColumnChangeKind::Delete,
ColumnChange::AddOptions { .. } => ColumnChangeKind::AddOptions,
ColumnChange::UpdateOption { .. } => ColumnChangeKind::UpdateOption,
diff --git a/crates/databases/src/domain/journal/guard.rs b/crates/databases/src/domain/journal/guard.rs
index b47ecbf05e..1b3de71d2c 100644
--- a/crates/databases/src/domain/journal/guard.rs
+++ b/crates/databases/src/domain/journal/guard.rs
@@ -279,6 +279,16 @@ pub fn guard(
);
}
}
+ ColumnChange::SetFormula { .. } => {
+ if present.is_none() {
+ continue;
+ }
+ if let Some(writer) = later.iter().rev().find(|record| {
+ record.columns.iter().any(|touch| touch.column == *column)
+ }) {
+ return refused(UndoRefusal::ChangedSince, Some(writer));
+ }
+ }
ColumnChange::ChangeType { .. } => {
if let Some(writer) = later.iter().rev().find(|record| {
record
diff --git a/crates/databases/src/domain/journal/invert.rs b/crates/databases/src/domain/journal/invert.rs
index 32ea3a93f7..dc84927c5f 100644
--- a/crates/databases/src/domain/journal/invert.rs
+++ b/crates/databases/src/domain/journal/invert.rs
@@ -226,6 +226,19 @@ impl Inverter<'_> {
});
}
}
+ ColumnChange::SetFormula { .. } => {
+ if later.iter().any(|step| !matches!(step.write, Write::Unchanged { .. }) && matches!(step.op, DatabaseOp::Column { column: named, change: ColumnChange::SetFormula { .. }, .. } if *named == column)) {
+ return;
+ }
+ let Some(formula) = image.and_then(|image| image.formula) else {
+ return;
+ };
+ self.push(DatabaseOp::Column {
+ table,
+ column,
+ change: ColumnChange::SetFormula { formula },
+ });
+ }
ColumnChange::ChangeType { .. } => {
let Some(image) = image else { return };
let Some(kind) = image.kind else { return };
@@ -248,6 +261,7 @@ impl Inverter<'_> {
kind: image.kind,
infer_type: image.infer_type,
nullable: image.nullable,
+ formula: image.formula.clone(),
},
);
self.push(DatabaseOp::Column {
diff --git a/crates/databases/src/domain/journal/test.rs b/crates/databases/src/domain/journal/test.rs
index efe2a23535..902c09f6a5 100644
--- a/crates/databases/src/domain/journal/test.rs
+++ b/crates/databases/src/domain/journal/test.rs
@@ -122,6 +122,7 @@ fn schema() -> SchemaImage {
definition: NAME_DEFINITION,
kind: Some(ColumnKind::Text),
options: Vec::new(),
+ formula: None,
},
ColumnImage {
nullable: true,
@@ -149,6 +150,7 @@ fn schema() -> SchemaImage {
color: None,
},
],
+ formula: None,
},
ColumnImage {
nullable: true,
@@ -160,6 +162,7 @@ fn schema() -> SchemaImage {
definition: PLUS_ONES_DEFINITION,
kind: Some(ColumnKind::Number),
options: Vec::new(),
+ formula: None,
},
],
views: views().to_vec(),
diff --git a/crates/databases/src/domain/models.rs b/crates/databases/src/domain/models.rs
index b324953db5..7554eac69a 100644
--- a/crates/databases/src/domain/models.rs
+++ b/crates/databases/src/domain/models.rs
@@ -157,6 +157,14 @@ impl Column {
pub fn is_relation(&self) -> bool {
matches!(self.config, Some(ColumnConfig::Link { .. }))
}
+
+ /// A derived column's formula.
+ pub fn formula(&self) -> Option<&models_databases::Formula> {
+ match &self.config {
+ Some(ColumnConfig::Derived { formula }) => Some(formula),
+ _ => None,
+ }
+ }
}
/// What changing a column to one type would do to its values: the dry run
@@ -241,7 +249,7 @@ pub struct ColumnReplacement {
}
/// Column-kind specific configuration stored on the placement.
-#[derive(utoipa::ToSchema, Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[derive(utoipa::ToSchema, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case", tag = "kind")]
pub enum ColumnConfig {
/// A relation column: its cells reference rows of another table.
@@ -253,6 +261,12 @@ pub enum ColumnConfig {
#[schema(value_type = Uuid)]
table_id: TableId,
},
+ /// A derived column: its cells are computed from the row's others, and
+ /// its definition, a number or date one, never holds a value.
+ Derived {
+ /// How its cells are computed.
+ formula: models_databases::Formula,
+ },
}
/// A row's identity and place in its table. Cells are not here: they are
diff --git a/crates/databases/src/domain/service/ops.rs b/crates/databases/src/domain/service/ops.rs
index 39351ce1ba..1b818913bb 100644
--- a/crates/databases/src/domain/service/ops.rs
+++ b/crates/databases/src/domain/service/ops.rs
@@ -733,6 +733,7 @@ fn op_results(
ColumnChange::Create { .. } => ColumnResult::Created,
ColumnChange::Rename { .. } => ColumnResult::Renamed,
ColumnChange::ChangeType { .. } => ColumnResult::TypeChanged,
+ ColumnChange::SetFormula { .. } => ColumnResult::FormulaSet,
ColumnChange::Delete => ColumnResult::Deleted,
ColumnChange::AddOptions { .. } => ColumnResult::OptionsAdded {
added: match write {
@@ -1043,6 +1044,9 @@ impl Planner {
} => self.rename_column(place, entry, target?, name, previous_name.as_deref()),
ColumnChange::Delete => self.delete_column(place, entry, target?),
ColumnChange::ChangeType { to } => self.change_type(place, entry, target?, *to),
+ ColumnChange::SetFormula { formula } => {
+ self.set_formula(place, entry, target?, formula)
+ }
ColumnChange::AddOptions { options } => {
self.add_options(place, entry, target?, options)
}
diff --git a/crates/databases/src/domain/service/ops/cells.rs b/crates/databases/src/domain/service/ops/cells.rs
index 8d797314b8..5a6941013d 100644
--- a/crates/databases/src/domain/service/ops/cells.rs
+++ b/crates/databases/src/domain/service/ops/cells.rs
@@ -60,6 +60,12 @@ impl Planner {
column: &ColumnEntry,
value: &CellValue,
) -> Result<Option<PropertyValue>, DatabaseError> {
+ if column.column.formula().is_some() {
+ return Err(place.refuse(format!(
+ "\"{}\" is computed by its formula; write the columns it uses instead",
+ column.name()
+ )));
+ }
let data_type = column.definition.definition.data_type;
let misfit = || {
place.refuse(format!(
diff --git a/crates/databases/src/domain/service/ops/columns.rs b/crates/databases/src/domain/service/ops/columns.rs
index 64417df6d8..491a86cb55 100644
--- a/crates/databases/src/domain/service/ops/columns.rs
+++ b/crates/databases/src/domain/service/ops/columns.rs
@@ -6,7 +6,7 @@ use std::collections::{HashMap, HashSet};
use models_databases::cast::{Cast, Contents, cast};
use models_databases::position::{key_between, keys_between};
-use models_databases::{ColumnKind, NewColumn, NewOption, TakenId};
+use models_databases::{ColumnKind, Formula, FormulaType, NewColumn, NewOption, TakenId};
use models_properties::api::is_valid_hex_color;
use models_properties::service::property_definition::PropertyDefinition;
use models_properties::service::property_definition_with_options::PropertyDefinitionWithOptions;
@@ -47,14 +47,7 @@ impl Planner {
options,
infer_type,
} => {
- let name = validate_name(name).map_err(|error| schema_refusal(place, error))?;
- if entry
- .columns
- .iter()
- .any(|column| same_name(column.name(), &name))
- {
- return Err(place.refuse(SchemaError::ColumnNameTaken { name }.to_string()));
- }
+ let name = fresh_name(place, entry, name)?;
let target = PropertyType::from_column_kind(*kind);
let config = match kind {
ColumnKind::Relation { database, table } => {
@@ -88,6 +81,19 @@ impl Planner {
*infer_type,
)
}
+ NewColumn::Derived { name, formula } => {
+ let name = fresh_name(place, entry, name)?;
+ let result = check_formula(place, entry, None, formula)?;
+ let created = derived_definition(name, result);
+ (
+ stored_definition(self.database_id, &created),
+ Some(created),
+ Some(ColumnConfig::Derived {
+ formula: formula.clone(),
+ }),
+ false,
+ )
+ }
NewColumn::Existing { property } => {
let definition = self
.found
@@ -104,8 +110,10 @@ impl Planner {
return Err(place.refuse(SchemaError::DefinitionAlreadyBound.to_string()));
}
let restored = self.restoration.columns.get(&id);
- let config = match restored.and_then(|column| column.kind) {
- Some(ColumnKind::Relation { database, table }) => {
+ let formula = restored.and_then(|column| column.formula.clone());
+ let config = match (formula, restored.and_then(|column| column.kind)) {
+ (Some(formula), _) => Some(ColumnConfig::Derived { formula }),
+ (None, Some(ColumnKind::Relation { database, table })) => {
self.link_target(place, database, table)?;
Some(ColumnConfig::Link {
database_id: database,
@@ -208,6 +216,19 @@ impl Planner {
.to_string(),
));
}
+ if let Some(reader) = entry.columns.iter().find(|other| {
+ other.column.id != column_id
+ && other
+ .column
+ .formula()
+ .is_some_and(|formula| formula.columns().contains(&column_id))
+ }) {
+ return Err(place.refuse(format!(
+ "{}'s formula uses {}; change that formula first",
+ reader.name(),
+ column.name()
+ )));
+ }
let now = self.now;
let next_title = entry
.columns
@@ -323,6 +344,11 @@ impl Planner {
to: ColumnKind,
) -> Result<Write, DatabaseError> {
let column_id = place.column;
+ if column.column.formula().is_some() {
+ return Err(place.refuse(
+ "a derived column's type follows its formula; change the formula instead",
+ ));
+ }
let source = column.definition.definition.id;
if self.written_tables.contains(&entry.table.id) || self.changed_options.contains(&source) {
return Err(place.refuse(SchemaError::RetypeAfterWrites.to_string()));
@@ -534,6 +560,68 @@ impl Planner {
})
}
+ pub(super) fn set_formula(
+ &mut self,
+ place: Place,
+ entry: &StorageTable,
+ column: &ColumnEntry,
+ formula: &Formula,
+ ) -> Result<Write, DatabaseError> {
+ let Some(current) = column.column.formula() else {
+ return Err(
+ place.refuse("only a derived column has a formula; create one to compute values")
+ );
+ };
+ if current == formula {
+ return Ok(Write::Unchanged {
+ table_id: entry.table.id,
+ });
+ }
+ let result = check_formula(place, entry, Some(place.column), formula)?;
+ let config = Some(ColumnConfig::Derived {
+ formula: formula.clone(),
+ });
+ let read_version =
+ (!self.created_tables.contains(&entry.table.id)).then_some(entry.table.version);
+ let retyped = derived_data_type(result) != column.definition.definition.data_type;
+ let (definition, definition_id, views) = if retyped {
+ // Filters comparing the old type's values no longer fit.
+ let now = self.now;
+ let views = views_without_tests_of(self.views_of(entry), place.column, now)
+ .map_err(|reason| place.refuse(reason.to_string()))?;
+ let created =
+ derived_definition(column.definition.definition.display_name.clone(), result);
+ let id = created.id;
+ (Some(created), id, views)
+ } else {
+ (None, column.definition.definition.id, Vec::new())
+ };
+ let replacement = ColumnReplacement {
+ column: column.column.clone(),
+ definition_id,
+ config: config.clone(),
+ values: Vec::new(),
+ };
+ self.store_views(entry.table.id, &views);
+ let stored = definition
+ .as_ref()
+ .map(|definition| stored_definition(self.database_id, definition));
+ if let Some(planned) = self.column_mut(entry.table.id, place.column) {
+ planned.column.property_definition_id = definition_id;
+ planned.column.config = config;
+ if let Some(stored) = stored {
+ planned.definition = stored;
+ }
+ }
+ Ok(Write::ReplaceColumn {
+ table_id: entry.table.id,
+ read_version,
+ definition,
+ replacement,
+ views,
+ })
+ }
+
pub(super) fn update_option(
&mut self,
place: Place,
@@ -750,6 +838,51 @@ fn column_position(
}
/// The definition a write creates, as the catalog holds it once stored.
+/// A name for a new column of `entry`: valid, and no other column's.
+fn fresh_name(place: Place, entry: &StorageTable, name: &str) -> Result<String, DatabaseError> {
+ let name = validate_name(name).map_err(|error| schema_refusal(place, error))?;
+ if entry
+ .columns
+ .iter()
+ .any(|column| same_name(column.name(), &name))
+ {
+ return Err(place.refuse(SchemaError::ColumnNameTaken { name }.to_string()));
+ }
+ Ok(name)
+}
+
+/// What `formula` yields over `entry`'s columns, as the ops so far leave
+/// them, for the derived column `own` when it exists.
+fn check_formula(
+ place: Place,
+ entry: &StorageTable,
+ own: Option<ColumnId>,
+ formula: &Formula,
+) -> Result<FormulaType, DatabaseError> {
+ database_sql::formula::check(&catalog::engine_table(entry, ""), own, formula)
+ .map_err(|reason| place.refuse(reason))
+}
+
+/// The definition behind a derived column: owned by the database, of the
+/// type its formula yields, never holding a value.
+fn derived_definition(name: String, result: FormulaType) -> NewDefinition {
+ NewDefinition {
+ id: macro_uuid::generate_uuid_v7(),
+ name,
+ data_type: derived_data_type(result),
+ is_multi_select: false,
+ specific_entity_type: None,
+ options: Vec::new(),
+ }
+}
+
+fn derived_data_type(result: FormulaType) -> DataType {
+ match result {
+ FormulaType::Number => DataType::Number,
+ FormulaType::Date => DataType::Date,
+ }
+}
+
fn stored_definition(
database: DatabaseId,
definition: &NewDefinition,
diff --git a/crates/databases/src/domain/service/storage/query.rs b/crates/databases/src/domain/service/storage/query.rs
index 8bad925604..3fe0872eb0 100644
--- a/crates/databases/src/domain/service/storage/query.rs
+++ b/crates/databases/src/domain/service/storage/query.rs
@@ -1,13 +1,10 @@
//! Reuse the database query compiler and fold for host-owned storage reads.
use crate::domain::{
- catalog::{PropertyType, StorageTable, option_labels},
+ catalog::{StorageTable, engine_table},
models::{DatabaseError, RowRef},
storage::StorageRowsQuery,
};
-use database_sql::{
- Catalog, Cell, Row,
- catalog::{Column, ColumnKind, SelectOption, Table, TableSource},
-};
+use database_sql::{Catalog, Cell, Row};
use models_databases::{
OptionId, RowId, ViewId,
views::{DatabaseView, ViewLayout},
@@ -51,29 +48,7 @@ pub(super) fn rows(
request: &StorageRowsQuery,
) -> Result<Vec<RowId>, DatabaseError> {
let catalog = Catalog {
- tables: vec![Table {
- id: entry.table.id,
- database_id: entry.table.database_id,
- database: String::new(),
- name: entry.table.name.clone(),
- source: TableSource::Database,
- columns: entry
- .columns
- .iter()
- .map(|column| Column {
- id: column.column.property_definition_id,
- placement: column.column.id,
- name: column.name().to_owned(),
- kind: ColumnKind::of(
- PropertyType::of(&column.column, &column.definition).cast_kind(),
- option_labels(&column.definition)
- .into_iter()
- .map(|(id, label)| SelectOption { id, label })
- .collect(),
- ),
- })
- .collect(),
- }],
+ tables: vec![engine_table(entry, "")],
};
let query = if request.row_ids.is_some() {
Default::default()
diff --git a/crates/databases/src/domain/service/test.rs b/crates/databases/src/domain/service/test.rs
index 3236e16836..baf2d6a5e1 100644
--- a/crates/databases/src/domain/service/test.rs
+++ b/crates/databases/src/domain/service/test.rs
@@ -37,6 +37,7 @@ mod column_options;
mod columns;
mod databases;
mod delete_table;
+mod derived_columns;
mod discovery;
mod domain_events;
mod fakes;
diff --git a/crates/databases/src/domain/service/test/derived_columns.rs b/crates/databases/src/domain/service/test/derived_columns.rs
new file mode 100644
index 0000000000..75804a884d
--- /dev/null
+++ b/crates/databases/src/domain/service/test/derived_columns.rs
@@ -0,0 +1,338 @@
+//! Derived columns: a formula instead of cells, checked against the table
+//! as the ops before it leave it, and undone like any schema change.
+
+use models_databases::{Formula, Operator};
+
+use super::*;
+use crate::domain::journal::UndoOutcome;
+use crate::domain::models::ColumnConfig;
+
+fn plus_ones_times(seeded: &Seeded, factor: f64) -> Formula {
+ Formula::Binary {
+ operator: Operator::Multiply,
+ left: Box::new(Formula::Column {
+ column: seeded.plus_ones_column.id,
+ }),
+ right: Box::new(Formula::Number { value: factor }),
+ }
+}
+
+async fn apply(seeded: &Seeded, ops: Vec<DatabaseOp>) -> Result<Vec<OpResult>, DatabaseError> {
+ seeded
+ .service
+ .apply_ops(edit(seeded.database_id), viewer(OWNER), ops.into())
+ .await
+}
+
+fn refusal(result: Result<Vec<OpResult>, DatabaseError>) -> String {
+ match result {
+ Err(DatabaseError::InvalidOp(refusal)) => refusal.reason,
+ other => panic!("expected a refusal, got {other:?}"),
+ }
+}
+
+#[tokio::test]
+async fn a_derived_column_is_created_with_a_number_definition_and_its_formula() {
+ let seeded = seeded().await;
+ let seats = ColumnId::new();
+
+ let results = apply(
+ &seeded,
+ vec![DatabaseOp::Column {
+ table: seeded.table_id,
+ column: seats,
+ change: ColumnChange::Create {
+ definition: NewColumn::Derived {
+ name: "Seats".into(),
+ formula: plus_ones_times(&seeded, 2.0),
+ },
+ after: None,
+ },
+ }],
+ )
+ .await
+ .unwrap();
+
+ assert!(matches!(
+ results.as_slice(),
+ [OpResult::Column {
+ change: ColumnResult::Created,
+ ..
+ }]
+ ));
+ let world = seeded.world.lock().unwrap();
+ let column = world
+ .columns
+ .iter()
+ .find(|column| column.id == seats)
+ .unwrap();
+ assert_eq!(
+ column.config,
+ Some(ColumnConfig::Derived {
+ formula: plus_ones_times(&seeded, 2.0),
+ })
+ );
+ let definition = &world.definitions[&column.property_definition_id].definition;
+ assert_eq!(definition.data_type, DataType::Number);
+ assert_eq!(definition.display_name, "Seats");
+}
+
+#[tokio::test]
+async fn formulas_that_do_not_fit_are_refused() {
+ let seeded = seeded().await;
+ let create = |formula: Formula| {
+ vec![DatabaseOp::Column {
+ table: seeded.table_id,
+ column: ColumnId::new(),
+ change: ColumnChange::Create {
+ definition: NewColumn::Derived {
+ name: "Bad".into(),
+ formula,
+ },
+ after: None,
+ },
+ }]
+ };
+
+ let text = refusal(
+ apply(
+ &seeded,
+ create(Formula::Binary {
+ operator: Operator::Add,
+ left: Box::new(Formula::Column {
+ column: seeded.name_column.id,
+ }),
+ right: Box::new(Formula::Number { value: 1.0 }),
+ }),
+ )
+ .await,
+ );
+ assert_eq!(
+ text,
+ "Name is a text column; formulas use number and date columns."
+ );
+
+ let missing = refusal(
+ apply(
+ &seeded,
+ create(Formula::Column {
+ column: ColumnId::new(),
+ }),
+ )
+ .await,
+ );
+ assert_eq!(
+ missing,
+ "The formula names a column this table no longer has."
+ );
+}
+
+#[tokio::test]
+async fn a_derived_column_takes_no_writes_and_keeps_its_inputs() {
+ let seeded = seeded().await;
+ let seats = ColumnId::new();
+ apply(
+ &seeded,
+ vec![DatabaseOp::Column {
+ table: seeded.table_id,
+ column: seats,
+ change: ColumnChange::Create {
+ definition: NewColumn::Derived {
+ name: "Seats".into(),
+ formula: plus_ones_times(&seeded, 2.0),
+ },
+ after: None,
+ },
+ }],
+ )
+ .await
+ .unwrap();
+
+ let written = refusal(
+ apply(
+ &seeded,
+ vec![DatabaseOp::Rows {
+ table: seeded.table_id,
+ change: RowsChange::Update {
+ changes: RowChanges::Uniform {
+ rows: vec![seeded.row_id],
+ cells: vec![CellWrite {
+ column: seats,
+ value: CellValue::Number(4.0),
+ }],
+ },
+ },
+ }],
+ )
+ .await,
+ );
+ assert_eq!(
+ written,
+ "\"Seats\" is computed by its formula; write the columns it uses instead"
+ );
+
+ let retyped = refusal(
+ apply(
+ &seeded,
+ vec![DatabaseOp::Column {
+ table: seeded.table_id,
+ column: seats,
+ change: ColumnChange::ChangeType {
+ to: ColumnKind::Text,
+ },
+ }],
+ )
+ .await,
+ );
+ assert_eq!(
+ retyped,
+ "a derived column's type follows its formula; change the formula instead"
+ );
+
+ let input_deleted = refusal(
+ apply(
+ &seeded,
+ vec![DatabaseOp::Column {
+ table: seeded.table_id,
+ column: seeded.plus_ones_column.id,
+ change: ColumnChange::Delete,
+ }],
+ )
+ .await,
+ );
+ assert_eq!(
+ input_deleted,
+ "Seats's formula uses Plus ones; change that formula first"
+ );
+}
+
+#[tokio::test]
+async fn setting_a_formula_keeps_the_definition_and_undo_puts_the_old_one_back() {
+ let seeded = seeded().await;
+ let seats = ColumnId::new();
+ apply(
+ &seeded,
+ vec![DatabaseOp::Column {
+ table: seeded.table_id,
+ column: seats,
+ change: ColumnChange::Create {
+ definition: NewColumn::Derived {
+ name: "Seats".into(),
+ formula: plus_ones_times(&seeded, 2.0),
+ },
+ after: None,
+ },
+ }],
+ )
+ .await
+ .unwrap();
+ let definition = seeded
+ .world
+ .lock()
+ .unwrap()
+ .columns
+ .iter()
+ .find(|column| column.id == seats)
+ .unwrap()
+ .property_definition_id;
+
+ let applied = seeded
+ .service
+ .apply_ops_with_changes(
+ edit(seeded.database_id),
+ viewer(OWNER),
+ vec![DatabaseOp::Column {
+ table: seeded.table_id,
+ column: seats,
+ change: ColumnChange::SetFormula {
+ formula: plus_ones_times(&seeded, 3.0),
+ },
+ }]
+ .into(),
+ )
+ .await
+ .unwrap();
+ assert!(matches!(
+ applied.results.as_slice(),
+ [OpResult::Column {
+ change: ColumnResult::FormulaSet,
+ ..
+ }]
+ ));
+ {
+ let world = seeded.world.lock().unwrap();
+ let column = world
+ .columns
+ .iter()
+ .find(|column| column.id == seats)
+ .unwrap();
+ assert_eq!(column.property_definition_id, definition);
+ assert_eq!(column.formula(), Some(&plus_ones_times(&seeded, 3.0)));
+ }
+
+ let outcome = seeded
+ .service
+ .undo_change(
+ edit(seeded.database_id),
+ viewer(OWNER),
+ applied.changes[0].change,
+ )
+ .await
+ .unwrap();
+
+ assert!(
+ matches!(outcome, UndoOutcome::Reverted { .. }),
+ "{outcome:?}"
+ );
+ let world = seeded.world.lock().unwrap();
+ let column = world
+ .columns
+ .iter()
+ .find(|column| column.id == seats)
+ .unwrap();
+ assert_eq!(column.formula(), Some(&plus_ones_times(&seeded, 2.0)));
+}
+
+#[tokio::test]
+async fn a_formula_cannot_read_its_own_column() {
+ let seeded = seeded().await;
+ let seats = ColumnId::new();
+ apply(
+ &seeded,
+ vec![DatabaseOp::Column {
+ table: seeded.table_id,
+ column: seats,
+ change: ColumnChange::Create {
+ definition: NewColumn::Derived {
+ name: "Seats".into(),
+ formula: plus_ones_times(&seeded, 2.0),
+ },
+ after: None,
+ },
+ }],
+ )
+ .await
+ .unwrap();
+
+ let cycle = refusal(
+ apply(
+ &seeded,
+ vec![DatabaseOp::Column {
+ table: seeded.table_id,
+ column: seats,
+ change: ColumnChange::SetFormula {
+ formula: Formula::Binary {
+ operator: Operator::Add,
+ left: Box::new(Formula::Column { column: seats }),
+ right: Box::new(Formula::Number { value: 1.0 }),
+ },
+ },
+ }],
+ )
+ .await,
+ );
+ assert_eq!(
+ cycle,
+ "Seats can't be used here: its value depends on this column."
+ );
+}
diff --git a/crates/databases/src/inbound/toolset.rs b/crates/databases/src/inbound/toolset.rs
index b65cb74fdf..0aa70f96ec 100644
--- a/crates/databases/src/inbound/toolset.rs
+++ b/crates/databases/src/inbound/toolset.rs
@@ -417,6 +417,10 @@ pub struct ToolColumn {
/// A database-row relationship; distinct from a Macro entity reference.
#[serde(skip_serializing_if = "Option::is_none")]
pub relation: Option<ToolRelation>,
+ /// A derived column's formula: SQL reads its values, nothing writes
+ /// them.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub formula: Option<String>,
/// Types ALTER COLUMN TYPE converts every value to, spelled as SQL types
/// (`select[]` is a multi-valued select, `entity(USER)` a person).
#[serde(default, skip_serializing_if = "Vec::is_empty")]
@@ -503,7 +507,7 @@ impl From<DatabaseDetail> for ToolDatabaseSchema {
version: table.table.version.0,
name: table.table.name,
writable,
- columns: table.columns.into_iter().map(ToolColumn::from).collect(),
+ columns: tool_columns(table.columns),
views: table.views,
})
.collect(),
@@ -511,9 +515,39 @@ impl From<DatabaseDetail> for ToolDatabaseSchema {
}
}
+/// A table's columns as the tool shows them, formulas written with the
+/// table's column names.
+fn tool_columns(columns: Vec<ColumnDetail>) -> Vec<ToolColumn> {
+ let names: Vec<(ColumnId, String)> = columns
+ .iter()
+ .map(|column| (column.column.id, column.name().to_string()))
+ .collect();
+ columns
+ .into_iter()
+ .map(|column| {
+ let formula = column.column.formula().map(|formula| {
+ database_sql::formula::render_named(formula, &|id| {
+ names
+ .iter()
+ .find(|(candidate, _)| *candidate == id)
+ .map(|(_, name)| name.as_str())
+ })
+ });
+ ToolColumn {
+ formula,
+ ..ToolColumn::from(column)
+ }
+ })
+ .collect()
+}
+
impl From<ColumnDetail> for ToolColumn {
fn from(column: ColumnDetail) -> Self {
- let (safe_types, checked_types) = cast_targets(&column.column, &column.definition);
+ // A derived column's type follows its formula.
+ let (safe_types, checked_types) = match column.column.formula() {
+ Some(_) => (Vec::new(), Vec::new()),
+ None => cast_targets(&column.column, &column.definition),
+ };
Self {
safe_types: safe_types.into_iter().map(SpelledColumnType).collect(),
checked_types: checked_types.into_iter().map(SpelledColumnType).collect(),
@@ -522,7 +556,7 @@ impl From<ColumnDetail> for ToolColumn {
data_type: column.definition.definition.data_type.into(),
specific_entity_type: column.entity_type(),
is_multi_select: column.is_multi_valued(),
- writable: column.writable,
+ writable: column.writable && column.column.formula().is_none(),
// The catalog's labels, not the raw option text: duplicates are
// disambiguated there, and a label that does not round-trip is
// one SQL rejects.
@@ -540,6 +574,7 @@ impl From<ColumnDetail> for ToolColumn {
}),
_ => None,
},
+ formula: None,
sql_name: column.sql_name,
}
}
diff --git a/crates/databases/src/outbound/pg_databases_repo/test/schema_ops.rs b/crates/databases/src/outbound/pg_databases_repo/test/schema_ops.rs
index 909332e407..9a5bd68264 100644
--- a/crates/databases/src/outbound/pg_databases_repo/test/schema_ops.rs
+++ b/crates/databases/src/outbound/pg_databases_repo/test/schema_ops.rs
@@ -826,3 +826,109 @@ async fn protected_columns_refuse_direct_sql_but_allow_parent_deletion(pool: PgP
.await
.unwrap();
}
+
+#[sqlx::test(migrator = "MACRO_DB_MIGRATIONS")]
+async fn a_derived_column_stores_its_formula_and_keeps_its_definition_across_edits(pool: PgPool) {
+ use crate::domain::models::ColumnConfig;
+ use models_databases::{Formula, Operator};
+ let guests = guests(&pool).await;
+ let (seats, doubled) = (ColumnId::new(), ColumnId::new());
+ let times = |factor: f64| Formula::Binary {
+ operator: Operator::Multiply,
+ left: Box::new(Formula::Column { column: seats }),
+ right: Box::new(Formula::Number { value: factor }),
+ };
+ service(&pool)
+ .apply_ops(
+ edit(guests.database_id),
+ viewer(),
+ vec![
+ DatabaseOp::Column {
+ table: guests.table_id,
+ column: seats,
+ change: ColumnChange::Create {
+ definition: NewColumn::New {
+ name: "Seats".into(),
+ kind: ColumnKind::Number,
+ options: vec![],
+ infer_type: false,
+ },
+ after: None,
+ },
+ },
+ DatabaseOp::Column {
+ table: guests.table_id,
+ column: doubled,
+ change: ColumnChange::Create {
+ definition: NewColumn::Derived {
+ name: "Doubled".into(),
+ formula: times(2.0),
+ },
+ after: None,
+ },
+ },
+ ]
+ .into(),
+ )
+ .await
+ .unwrap();
+ let repository = PgDatabasesRepo::new(pool.clone(), PropertiesPgRepo::new(pool.clone()));
+ let stored = |columns: Vec<crate::domain::models::Column>| {
+ columns
+ .into_iter()
+ .find(|column| column.id == doubled)
+ .unwrap()
+ };
+ let created = stored(
+ repository
+ .columns_for_tables(&[guests.table_id])
+ .await
+ .unwrap(),
+ );
+ assert_eq!(
+ created.config,
+ Some(ColumnConfig::Derived {
+ formula: times(2.0)
+ })
+ );
+
+ let results = service(&pool)
+ .apply_ops(
+ edit(guests.database_id),
+ viewer(),
+ vec![DatabaseOp::Column {
+ table: guests.table_id,
+ column: doubled,
+ change: ColumnChange::SetFormula {
+ formula: times(3.0),
+ },
+ }]
+ .into(),
+ )
+ .await
+ .unwrap();
+
+ assert!(matches!(
+ results.as_slice(),
+ [OpResult::Column {
+ change: ColumnResult::FormulaSet,
+ ..
+ }]
+ ));
+ let edited = stored(
+ repository
+ .columns_for_tables(&[guests.table_id])
+ .await
+ .unwrap(),
+ );
+ assert_eq!(
+ edited.config,
+ Some(ColumnConfig::Derived {
+ formula: times(3.0)
+ })
+ );
+ assert_eq!(
+ edited.property_definition_id,
+ created.property_definition_id
+ );
+}
diff --git a/crates/databases_sql/src/catalog.rs b/crates/databases_sql/src/catalog.rs
index d453f63bbe..2c23ea0754 100644
--- a/crates/databases_sql/src/catalog.rs
+++ b/crates/databases_sql/src/catalog.rs
@@ -125,5 +125,6 @@ fn column_schema(column: &ColumnDetail) -> ColumnSchema {
order: option.display_order,
})
.collect(),
+ formula: column.column.formula().cloned(),
}
}
diff --git a/crates/databases_sql/src/catalog/test.rs b/crates/databases_sql/src/catalog/test.rs
index 58451f4b7a..56f6d96574 100644
--- a/crates/databases_sql/src/catalog/test.rs
+++ b/crates/databases_sql/src/catalog/test.rs
@@ -214,6 +214,7 @@ fn details_become_the_schema_the_engine_builds_its_catalog_from() {
relation: false,
},
options: vec![],
+ formula: None,
},
ColumnSchema {
id: ColumnId::from_uuid(Uuid::from_u128(0xb002)),
@@ -237,6 +238,7 @@ fn details_become_the_schema_the_engine_builds_its_catalog_from() {
order: 1,
},
],
+ formula: None,
},
ColumnSchema {
id: ColumnId::from_uuid(Uuid::from_u128(0xb003)),
@@ -249,6 +251,7 @@ fn details_become_the_schema_the_engine_builds_its_catalog_from() {
relation: false,
},
options: vec![],
+ formula: None,
},
ColumnSchema {
id: ColumnId::from_uuid(Uuid::from_u128(0xb004)),
@@ -261,6 +264,7 @@ fn details_become_the_schema_the_engine_builds_its_catalog_from() {
relation: true,
},
options: vec![],
+ formula: None,
},
],
}],
diff --git a/crates/models_databases/src/formula.rs b/crates/models_databases/src/formula.rs
new file mode 100644
index 0000000000..9df2850d1b
--- /dev/null
+++ b/crates/models_databases/src/formula.rs
@@ -0,0 +1,111 @@
+//! A derived column's formula: arithmetic over the other columns of the same
+//! row. It names columns by id, so renaming one keeps the formula; the text
+//! users read and type (`{Unit price} * Quantity`) is rendered and parsed by
+//! the engine, against the table's current names.
+
+use serde::{Deserialize, Serialize};
+
+use crate::ids::ColumnId;
+
+/// An expression over one row's cells.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, utoipa::ToSchema, specta::Type)]
+#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
+#[serde(tag = "kind", rename_all = "snake_case")]
+pub enum Formula {
+ /// The row's cell in another column of the table: a number, date or
+ /// derived column.
+ Column {
+ /// The column placement.
+ #[schema(value_type = Uuid)]
+ column: ColumnId,
+ },
+ /// A constant. Added to or subtracted from a date, it counts days.
+ Number {
+ /// The value; finite.
+ value: f64,
+ },
+ /// Two expressions combined.
+ Binary {
+ /// How.
+ operator: Operator,
+ /// The left operand.
+ #[schema(no_recursion)]
+ left: Box<Formula>,
+ /// The right operand.
+ #[schema(no_recursion)]
+ right: Box<Formula>,
+ },
+ /// An expression's negation.
+ Negate {
+ /// The expression negated; a number.
+ #[schema(no_recursion)]
+ operand: Box<Formula>,
+ },
+}
+
+/// An arithmetic operator.
+#[derive(
+ Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, utoipa::ToSchema, specta::Type,
+)]
+#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
+#[serde(rename_all = "snake_case")]
+pub enum Operator {
+ /// `+`: numbers, or days onto a date.
+ Add,
+ /// `-`: numbers, days off a date, or the days between two dates.
+ Subtract,
+ /// `*`: numbers.
+ Multiply,
+ /// `/`: numbers; dividing by zero leaves the cell empty.
+ Divide,
+}
+
+impl Operator {
+ /// The symbol it is written with.
+ pub fn symbol(self) -> char {
+ match self {
+ Operator::Add => '+',
+ Operator::Subtract => '-',
+ Operator::Multiply => '*',
+ Operator::Divide => '/',
+ }
+ }
+}
+
+/// What a formula's cells hold.
+#[derive(
+ Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, utoipa::ToSchema, specta::Type,
+)]
+#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
+#[serde(rename_all = "snake_case")]
+pub enum FormulaType {
+ /// A number.
+ Number,
+ /// A date-time.
+ Date,
+}
+
+impl Formula {
+ /// Every column the formula reads, first use first, each once.
+ pub fn columns(&self) -> Vec<ColumnId> {
+ let mut columns = Vec::new();
+ self.visit_columns(&mut |column| {
+ if !columns.contains(&column) {
+ columns.push(column);
+ }
+ });
+ columns
+ }
+
+ fn visit_columns(&self, visit: &mut impl FnMut(ColumnId)) {
+ match self {
+ Formula::Column { column } => visit(*column),
+ Formula::Number { .. } => {}
+ Formula::Binary { left, right, .. } => {
+ left.visit_columns(visit);
+ right.visit_columns(visit);
+ }
+ Formula::Negate { operand } => operand.visit_columns(visit),
+ }
+ }
+}
diff --git a/crates/models_databases/src/lib.rs b/crates/models_databases/src/lib.rs
index 3f678f636d..51fa69f608 100644
--- a/crates/models_databases/src/lib.rs
+++ b/crates/models_databases/src/lib.rs
@@ -3,12 +3,14 @@
//! position keys, shared by the SQL engine, the HTTP API and the domain.
pub mod cast;
+pub mod formula;
mod ids;
mod ops;
pub mod position;
pub mod property;
pub mod views;
+pub use formula::{Formula, FormulaType, Operator};
pub use ids::{
ChangeId, ColumnId, DatabaseId, OptionId, PropertyId, QueryId, RowId, TableId, TableVersion,
ViewId,
diff --git a/crates/models_databases/src/ops.rs b/crates/models_databases/src/ops.rs
index 748e850f39..76af8a1937 100644
--- a/crates/models_databases/src/ops.rs
+++ b/crates/models_databases/src/ops.rs
@@ -13,6 +13,7 @@ mod test;
use chrono::{DateTime, Utc};
use serde::{Deserialize, Deserializer, Serialize};
+use crate::formula::Formula;
use crate::ids::{ColumnId, DatabaseId, OptionId, PropertyId, RowId, TableId, TableVersion};
use crate::views::{
CardPosition, DatabaseView, LaneKey, NewView, RequestedLayout, ViewId, ViewPosition, ViewQuery,
@@ -195,6 +196,12 @@ pub enum ColumnChange {
#[specta(type = Option<String>, optional)]
color: Option<Option<String>>,
},
+ /// Give a derived column a new formula. Its cells follow at once: it
+ /// stores none.
+ SetFormula {
+ /// The formula, over the table's other columns.
+ formula: Formula,
+ },
/// Remove one option of a select or tag column, and take it out of every
/// cell holding it: a single-valued cell is emptied, a multi-valued one
/// keeps its other options. Like [`ColumnChange::UpdateOption`], an
@@ -327,6 +334,15 @@ pub enum NewColumn {
#[specta(optional)]
infer_type: bool,
},
+ /// A derived column: its cells are what `formula` computes from the
+ /// row's other cells, and nothing writes them.
+ Derived {
+ /// The column's name, unique within the table ignoring case.
+ name: String,
+ /// How its cells are computed: arithmetic over the table's number,
+ /// date and other derived columns.
+ formula: Formula,
+ },
/// An existing property, a person's, a team's or a system one, bound
/// into the table under its own name.
Existing {
@@ -654,6 +670,8 @@ pub enum ColumnResult {
OptionUpdated,
/// One of its options was removed.
OptionDeleted,
+ /// Its formula changed.
+ FormulaSet,
}
/// What happened to a table's rows.
diff --git a/crates/models_databases/tests/wire_schema.rs b/crates/models_databases/tests/wire_schema.rs
index d3bab2cab5..8bb9399e9c 100644
--- a/crates/models_databases/tests/wire_schema.rs
+++ b/crates/models_databases/tests/wire_schema.rs
@@ -12,9 +12,9 @@ use models_databases::views::{
};
use models_databases::{
CellValue, CellWrite, ColumnChange, ColumnId, ColumnKind, ColumnResult, DatabaseId, DatabaseOp,
- EntityKind, EntityRef, NewColumn, NewOption, OpResult, OptionId, OptionRef, PropertyId,
- RowChange, RowChanges, RowId, RowsChange, RowsResult, TableChange, TableId, TableResult,
- TableVersion, VersionedTable, ViewChange, ViewId, ViewResult,
+ EntityKind, EntityRef, Formula, NewColumn, NewOption, OpResult, Operator, OptionId, OptionRef,
+ PropertyId, RowChange, RowChanges, RowId, RowsChange, RowsResult, TableChange, TableId,
+ TableResult, TableVersion, VersionedTable, ViewChange, ViewId, ViewResult,
};
use serde_json::{Map, Value};
use utoipa::OpenApi;
@@ -208,6 +208,16 @@ fn ops() -> Vec<DatabaseOp> {
definition: NewColumn::Existing { property: PROPERTY },
after: None,
}),
+ column(ColumnChange::Create {
+ definition: NewColumn::Derived {
+ name: "Total".into(),
+ formula: every_formula(),
+ },
+ after: Some(NAME),
+ }),
+ column(ColumnChange::SetFormula {
+ formula: every_formula(),
+ }),
column(ColumnChange::Rename {
name: "Title".into(),
previous_name: Some("Name".into()),
@@ -411,6 +421,7 @@ fn results() -> Vec<OpResult> {
column(ColumnResult::OptionsAdded { added: vec![] }),
column(ColumnResult::OptionUpdated),
column(ColumnResult::OptionDeleted),
+ column(ColumnResult::FormulaSet),
rows(RowsResult::Inserted { rows: vec![ROW] }),
rows(RowsResult::Updated { affected: 1 }),
rows(RowsResult::Deleted { affected: 2 }),
@@ -578,6 +589,21 @@ fn assert_every_kind_sampled(component: &str, samples: &[Value]) {
}
}
+/// `-(Name + 2) * Name`: every kind of formula node.
+fn every_formula() -> Formula {
+ Formula::Binary {
+ operator: Operator::Multiply,
+ left: Box::new(Formula::Negate {
+ operand: Box::new(Formula::Binary {
+ operator: Operator::Add,
+ left: Box::new(Formula::Column { column: NAME }),
+ right: Box::new(Formula::Number { value: 2.0 }),
+ }),
+ }),
+ right: Box::new(Formula::Column { column: NAME }),
+ }
+}
+
fn components() -> Map<String, Value> {
let openapi = serde_json::to_value(Schemas::openapi()).unwrap();
openapi["components"]["schemas"]
diff --git a/docs/AGENT_GUIDE/databases.md b/docs/AGENT_GUIDE/databases.md
index ee8e7faadf..a8644ce882 100644
--- a/docs/AGENT_GUIDE/databases.md
+++ b/docs/AGENT_GUIDE/databases.md
@@ -135,7 +135,23 @@ type change never empties a value; only deleting a cell, row, column, table or
option does. Plain number strings can become numbers; padding, leading zeros and
ambiguous values count as values that don't fit. A date becomes its `YYYY-MM-DD`
text. Changing a placement never changes another table that uses the same property.
-A relation can hold multiple records. **Delete column** opens a confirmation;
+A relation can hold multiple records.
+
+**Formula columns.** **Change type → Formula** opens the formula editor under the
+header. On a new, never-filled column the formula column takes its place and name;
+on any other column it is added right after it (named "Formula"). Type the formula
+(`{Unit price} * Quantity`, `Due + 7`, `Due - Started`) or click the column and
+`+ − × ÷ ( )` buttons below the input; only number, date and other formula columns
+are offered. The line under the input says whether it gives a number or a date, or
+why it does not parse (`The formula ends too soon.`, `A date can't be multiplied
+by a number.`); **Save** stays disabled until it does, and Enter saves. Names with
+spaces go in braces. Numbers added to a date count days; a date minus a date is
+the days between them. An empty number counts as 0 unless every input is empty.
+Formula columns show an ƒ icon, their cells are read-only, and their header menu
+has **Edit formula** instead of **Change type**. Values follow edits to their inputs
+at once, and sort and filter like numbers or dates. Deleting a column a formula uses
+is refused ("Total's formula uses Quantity; change that formula first").
+**Delete column** opens a confirmation;
it removes this table’s column and values while preserving other tables.
Drag a column header left or right to reorder it, or use **Move left / Move right**.
To add a column next to another, right-click its header and choose **Insert left** or
diff --git a/packages/sdk/generated/storage/index.ts b/packages/sdk/generated/storage/index.ts
index 1371d308db..d5220d1bb4 100644
--- a/packages/sdk/generated/storage/index.ts
+++ b/packages/sdk/generated/storage/index.ts
@@ -1,4 +1,4 @@
// This file is auto-generated by @hey-api/openapi-ts
export { type Options, Sdk } from './sdk.gen';
-export type { AccessiblePipeline, AccessLevel, ActiveCallsResponse, ActiveCallSummary, ActiveMeeting, ActiveMeetingsResponse, ActivityType, AddFavoriteData, AddFavoriteError, AddFavoriteErrors, AddFavoriteRequest, AddFavoriteResponse, AddFavoriteResponses, AddParticipantsData, AddParticipantsError, AddParticipantsErrors, AddParticipantsRequest, AddParticipantsResponses, AddPinHandlerData, AddPinHandlerError, AddPinHandlerErrors, AddPinHandlerResponse, AddPinHandlerResponses, AddPinRequest, Agent, AgentActionId, AgentChannelScope, AgentMcpServer, AgentMcpServers, AgentPullRequestState, AgentSessionFilters, AgentSessionLifecycleEvent, Anchor, AnchorId, AnchorResponse, AnnotationIncrementalUpdate, Answer, ApiActivity, ApiAttachmentChannelReference, ApiAttachmentEntityReference, ApiAttachmentGenericReference, ApiChannelAttachment, ApiChannelAttachmentsPage, ApiChannelDetail, ApiChannelListMessage, ApiChannelListPage, ApiChannelListParticipant, ApiChannelListType, ApiChannelParticipant, ApiChannelWithLatest, ApiEntityFilterAst, ApiGroupByField, ApiGroupMeta, ApiParticipantListRole, ApiParticipantRole, ApiPropertyEntityType, AppliedOps, ApplyCrmPipelineOpsData, ApplyCrmPipelineOpsResponse, ApplyCrmPipelineOpsResponses, ApplyDatabaseOpsData, ApplyDatabaseOpsError, ApplyDatabaseOpsErrors, ApplyDatabaseOpsResponse, ApplyDatabaseOpsResponses, ApplyOpsRequest, ApplyOpsResponse, ApproveHarnessPairingData, ApproveHarnessPairingError, ApproveHarnessPairingErrors, ApproveHarnessPairingResponse, ApproveHarnessPairingResponses, ApprovePairingRequest, AttachmentChange, AttendeeResponseStatus, Audience, Awareness, AwarenessRelay, BasicDocument, BasicDocumentSubType, BomPart, BookingTarget, Bot, BotChannel, BotChannelType, BotId, BotKind, BotOwner, BotOwnerProfile, BotSenderProfile, BotToken, BranchNameResponse, BTreeMap, BulkWakeupRequest, BulkWakeupResponse, BulkWakeupSyncServiceDocumentsData, BulkWakeupSyncServiceDocumentsErrors, BulkWakeupSyncServiceDocumentsResponse, BulkWakeupSyncServiceDocumentsResponses, CalendarAttendee, CalendarEvent, CalendarEventFilters, CalendarEventSourceContent, CalendarMentionEvent, CalendarMentionPreviewItem, CalendarMentionPreviewKind, CalendarMentionPreviewRequest, CalendarMentionPreviewRequestItem, CalendarMentionPreviewResponse, CalendarOccurrence, CalendarOccurrenceItem, CalendarOccurrenceResponse, CalendarSyncStatus, CallActiveResponse, CallFilters, CallRecord, CallRecordGuest, CallRecordParticipant, CallRecordPreview, CallRecordPreviewData, CallRecordTranscriptSegment, CallStatus, CallTokenResponse, CallWebhookData, CallWebhookError, CallWebhookErrors, CallWebhookResponses, CancelSlackImportData, CancelSlackImportErrors, CancelSlackImportResponse, CancelSlackImportResponses, CardPosition, CastVerdict, CellValue, CellWrite, ChangedFileDto, ChangesetDto, ChangesetSourceDto, Channel, ChannelCreatedMetadata, ChannelDeletedMetadata, ChannelFilters, ChannelJoinCodeResponse, ChannelLabel, ChannelLabelRule, ChannelLabelsList, ChannelMessage, ChannelParticipant, ChannelParticipantAddedMetadata, ChannelParticipantRemovedMetadata, ChannelPictureChangedMetadata, ChannelPreview, ChannelPreviewData, ChannelSender, ChannelSharePermission, ChannelThreadFilters, ChannelTopicEvent, ChannelType, ChannelUpdatedMetadata, ChannelWebhookRequest, ChannelWebhookResponse, ChannelWithParticipants, Chat, ChatFilters, CheckActiveCallData, CheckActiveCallError, CheckActiveCallErrors, CheckActiveCallResponse, CheckActiveCallResponses, ClaimedPairing, ClaimHarnessPairingData, ClaimHarnessPairingError, ClaimHarnessPairingErrors, ClaimHarnessPairingResponse, ClaimHarnessPairingResponses, ClaimPairingRequest, ClientOptions, CloudStorageItemType, CollaborateFormData, CollaborateFormError, CollaborateFormErrors, CollaborateFormResponse, CollaborateFormResponses, CollabSurfaceResponse, CollabSurfaceTokenResponse, Column, ColumnCast, ColumnChange, ColumnChangeKind, ColumnConfig, ColumnConversion, ColumnConversionRequest, ColumnDetail, ColumnKind, ColumnProtection, ColumnResult, CommandFailure, CommandRejectedMetadata, CommittedChange, CompleteSlackImportUploadsData, CompleteSlackImportUploadsErrors, CompleteSlackImportUploadsResponse, CompleteSlackImportUploadsResponses, CompleteUploads, ConferenceProvider, Conjunction, ConversationId, ConversationKind, ConversationMetadata, ConversationProgress, ConversationSeal, ConversationStatus, ConvertDatabaseColumnData, ConvertDatabaseColumnError, ConvertDatabaseColumnErrors, ConvertDatabaseColumnResponse, ConvertDatabaseColumnResponses, ConvertedCell, CopyDocumentData, CopyDocumentError, CopyDocumentErrors, CopyDocumentQueryParams, CopyDocumentRequest, CopyDocumentResponse, CopyDocumentResponse2, CopyDocumentResponses, CountedReaction, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentRequest, CreateAgentResponse, CreateAgentResponses, CreateAnchorData, CreateAnchorError, CreateAnchorErrors, CreateAnchorResponse, CreateAnchorResponses, CreateBotRequest, CreateBulkDocumentResponse, CreateBulkDocumentResponseData, CreateChannelData, CreateChannelError, CreateChannelErrors, CreateChannelLabelData, CreateChannelLabelError, CreateChannelLabelErrors, CreateChannelLabelRequest, CreateChannelLabelResponse, CreateChannelLabelResponses, CreateChannelRequest, CreateChannelResponse, CreateChannelResponse2, CreateChannelResponses, CreateChannelScopedBotData, CreateChannelScopedBotError, CreateChannelScopedBotErrors, CreateChannelScopedBotRequest, CreateChannelScopedBotResponse, CreateChannelScopedBotResponse2, CreateChannelScopedBotResponses, CreateCollabSurfaceTokenData, CreateCollabSurfaceTokenError, CreateCollabSurfaceTokenErrors, CreateCollabSurfaceTokenResponse, CreateCollabSurfaceTokenResponses, CreateCrmCompanyData, CreateCrmCompanyError, CreateCrmCompanyErrors, CreateCrmCompanyRequest, CreateCrmCompanyResponse, CreateCrmCompanyResponses, CreateCrmContactData, CreateCrmContactError, CreateCrmContactErrors, CreateCrmContactRequest, CreateCrmContactResponse, CreateCrmContactResponses, CreateCrmPipelineData, CreateCrmPipelineResponse, CreateCrmPipelineResponses, CreateDatabaseData, CreateDatabaseError, CreateDatabaseErrors, CreateDatabaseRequest, CreateDatabaseResponse, CreateDatabaseResponses, CreateDocumentData, CreateDocumentError, CreateDocumentErrors, CreateDocumentRequest, CreateDocumentResponse, CreateDocumentResponseData, CreateDocumentResponses, CreatedPairing, CreatedUserApiKey, CreateEntityMentionData, CreateEntityMentionError, CreateEntityMentionErrors, CreateEntityMentionRequest, CreateEntityMentionResponse, CreateEntityMentionResponse2, CreateEntityMentionResponses, CreateForm, CreateFormData, CreateFormError, CreateFormErrors, CreateFormResponse, CreateFormResponses, CreateHarnessPairingData, CreateHarnessPairingError, CreateHarnessPairingErrors, CreateHarnessPairingResponse, CreateHarnessPairingResponses, CreateImport, CreateInitiativeData, CreateInitiativeError, CreateInitiativeErrors, CreateInitiativeRequest, CreateInitiativeResponse, CreateInitiativeResponses, CreateInstructionsDocumentResponse, CreateInstructionsHandlerData, CreateInstructionsHandlerError, CreateInstructionsHandlerErrors, CreateInstructionsHandlerResponse, CreateInstructionsHandlerResponses, CreateMarkdownDocumentRequest, CreateMarkdownDocumentResponse, CreateMarkdownHandlerData, CreateMarkdownHandlerError, CreateMarkdownHandlerErrors, CreateMarkdownHandlerResponse, CreateMarkdownHandlerResponses, CreateMeetingRequest, CreatePairingRequest, CreatePipeline, CreateProjectHandlerData, CreateProjectHandlerError, CreateProjectHandlerErrors, CreateProjectHandlerResponse, CreateProjectHandlerResponses, CreateProjectRequest, CreateProjectResponse, CreateSkillHandlerData, CreateSkillHandlerError, CreateSkillHandlerErrors, CreateSkillHandlerResponse, CreateSkillHandlerResponses, CreateSkillRequest, CreateSkillResponse, CreateSlackImportData, CreateSlackImportErrors, CreateSlackImportResponse, CreateSlackImportResponses, CreateSnippetHandlerData, CreateSnippetHandlerError, CreateSnippetHandlerErrors, CreateSnippetHandlerResponse, CreateSnippetHandlerResponses, CreateSnippetRequest, CreateSnippetResponse, CreateTaskHandlerData, CreateTaskHandlerError, CreateTaskHandlerErrors, CreateTaskHandlerResponse, CreateTaskHandlerResponses, CreateTaskRequest, CreateTaskResponse, CreateToken, CreateUnthreadedAnchorRequest, CreateUnthreadedAnchorResponse, CreateUnthreadedPdfAnchorRequest, CreateUserApiKeyData, CreateUserApiKeyError, CreateUserApiKeyErrors, CreateUserApiKeyRequest, CreateUserApiKeyResponse, CreateUserApiKeyResponses, CreateViewHandlerData, CreateViewHandlerError, CreateViewHandlerErrors, CreateViewHandlerResponse, CreateViewHandlerResponses, CreateViewRequest, CreateWebhookData, CreateWebhookError, CreateWebhookErrors, CreateWebhookRequest, CreateWebhookResponse, CreateWebhookResponse2, CreateWebhookResponses, CrmCompanyFilters, CrmCompanyResponse, CrmContactResponse, CrmDomainResponse, CrmPermissionRole, CrmStageInput, CrmStageResponse, CrmStagesResponse, CrmTeamSettingsResponse, CustomSpeakerAssignment, Database, DatabaseDetail, DatabaseOp, DatabaseView, DataType, DateOperator, DeleteAnchorData, DeleteAnchorError, DeleteAnchorErrors, DeleteAnchorResponse, DeleteAnchorResponses, DeleteCallRecordData, DeleteCallRecordError, DeleteCallRecordErrors, DeleteCallRecordResponse, DeleteCallRecordResponses, DeleteChannelData, DeleteChannelError, DeleteChannelErrors, DeleteChannelLabelData, DeleteChannelLabelError, DeleteChannelLabelErrors, DeleteChannelLabelResponse, DeleteChannelLabelResponses, DeleteChannelResponse, DeleteChannelResponses, DeleteCollabSurfaceData, DeleteCollabSurfaceError, DeleteCollabSurfaceErrors, DeleteCollabSurfaceResponse, DeleteCollabSurfaceResponses, DeleteDocumentData, DeleteDocumentError, DeleteDocumentErrors, DeleteDocumentResponse, DeleteDocumentResponses, DeleteEntityMentionData, DeleteEntityMentionError, DeleteEntityMentionErrors, DeleteEntityMentionResponse, DeleteEntityMentionResponse2, DeleteEntityMentionResponses, DeleteHarnessData, DeleteHarnessError, DeleteHarnessErrors, DeleteHarnessResponse, DeleteHarnessResponses, DeleteHistoryHandlerData, DeleteHistoryHandlerError, DeleteHistoryHandlerErrors, DeleteHistoryHandlerResponse, DeleteHistoryHandlerResponses, DeleteInitiativeData, DeleteInitiativeError, DeleteInitiativeErrors, DeleteInitiativeResponse, DeleteInitiativeResponses, DeleteProjectHandlerData, DeleteProjectHandlerError, DeleteProjectHandlerErrors, DeleteProjectHandlerResponse, DeleteProjectHandlerResponses, DeleteSelfHarnessData, DeleteSelfHarnessError, DeleteSelfHarnessErrors, DeleteSelfHarnessResponse, DeleteSelfHarnessResponses, DeleteUnthreadedAnchorRequest, DeleteUnthreadedAnchorResponse, DeleteUnthreadedPdfAnchorRequest, DeleteUserApiKeyData, DeleteUserApiKeyError, DeleteUserApiKeyErrors, DeleteUserApiKeyResponse, DeleteUserApiKeyResponses, DeleteUserDocumentViewLocationData, DeleteUserDocumentViewLocationError, DeleteUserDocumentViewLocationErrors, DeleteUserDocumentViewLocationResponse, DeleteUserDocumentViewLocationResponses, DeleteViewHandlerData, DeleteViewHandlerError, DeleteViewHandlerErrors, DeleteViewHandlerResponses, DeleteWebhookData, DeleteWebhookError, DeleteWebhookErrors, DeleteWebhookResponse, DeleteWebhookResponses, DocumentBasic, DocumentContent, DocumentContentLocation, DocumentContentState, DocumentContentUploadedMetadata, DocumentCopiedMetadata, DocumentCreatedMetadata, DocumentDeletedMetadata, DocumentFilters, DocumentId, DocumentInteractionMetadata, DocumentMetadata, DocumentMetadataWithContent, DocumentPermissionsToken, DocumentPermissionsTokenRequest, DocumentPermissionsTokenResponse, DocumentPreview, DocumentPreviewData, DocumentPreviewDataSubType, DocumentPurgedMetadata, DocumentResponse, DocumentResponseMetadata, DocumentResponseMetadataWithContent, DocumentStorageServiceApiVersion, DocumentSubType, DocumentSyncContentUpdatedMetadata, DocumentSyncEditor, DocumentTeamShareResponse, DocumentTopicEvent, DocumentUpdatedMetadata, EditAnchorData, EditAnchorError, EditAnchorErrors, EditAnchorRequest, EditAnchorResponse, EditAnchorResponse2, EditAnchorResponses, EditCallRecordData, EditCallRecordError, EditCallRecordErrors, EditCallRecordRequest, EditCallRecordResponse, EditCallRecordResponses, EditCallTranscriptData, EditCallTranscriptError, EditCallTranscriptErrors, EditCallTranscriptRequest, EditCallTranscriptResponse, EditCallTranscriptResponses, EditDocumentData, EditDocumentError, EditDocumentErrors, EditDocumentResponse, EditDocumentResponse2, EditDocumentResponses, EditDocumentServiceArgs, EditMyFormResponseData, EditMyFormResponseError, EditMyFormResponseErrors, EditMyFormResponseResponse, EditMyFormResponseResponses, EditPdfAnchorRequest, EditPdfPlaceableCommentAnchorRequest, EditProjectV2Data, EditProjectV2Error, EditProjectV2Errors, EditProjectV2Response, EditProjectV2Responses, EditThreadV2Data, EditThreadV2Error, EditThreadV2Errors, EditThreadV2Response, EditThreadV2Responses, EmailFilters, EmailFollowup, EmailFollowupCommand, EmailFollowupResponse, EmailReminderCondition, EmailReminderPage, EmailReminderSummary, EmptyResponse, EnsureCollabSurfaceData, EnsureCollabSurfaceError, EnsureCollabSurfaceErrors, EnsureCollabSurfaceRequest, EnsureCollabSurfaceResponse, EnsureCollabSurfaceResponses, EnsureStarterHandlerData, EnsureStarterHandlerErrors, EnsureStarterHandlerResponse, EnsureStarterHandlerResponses, EntityFilters, EntityKind, EntityMessageCreateData, EntityMessageCreateResponse, EntityMessageCreateResponses, EntityMessageDeleteMessageData, EntityMessageDeleteMessageResponse, EntityMessageDeleteMessageResponses, EntityMessageDeleteThreadData, EntityMessageDeleteThreadResponse, EntityMessageDeleteThreadResponses, EntityMessageEditData, EntityMessageEditResponse, EntityMessageEditResponses, EntityMessageGetMessageData, EntityMessageGetMessageResponse, EntityMessageGetMessageResponses, EntityMessageGetThreadData, EntityMessageGetThreadResponse, EntityMessageGetThreadResponses, EntityMessageLegacyData, EntityMessageLegacyResponse, EntityMessageLegacyResponses, EntityMessagePatchThreadData, EntityMessagePatchThreadResponse, EntityMessagePatchThreadResponses, EntityMessageReactData, EntityMessageReactResponse, EntityMessageReactResponses, EntityMessageTypingData, EntityMessageTypingResponse, EntityMessageTypingResponses, EntityPermission, EntityPermissionResponse, EntityRef, EntityReference, EntityType, ErrorResponse, EventReminderOverride, EventReminders, EventStatus, EventTime, EventTransparency, EventType, EventVisibility, ExcludedDefaultView, ExcludeDefaultViewHandlerData, ExcludeDefaultViewHandlerError, ExcludeDefaultViewHandlerErrors, ExcludeDefaultViewHandlerResponses, ExcludeDefaultViewRequest, ExportDocumentData, ExportDocumentError, ExportDocumentErrors, ExportDocumentResponse, ExportDocumentResponse2, ExportDocumentResponses, Favorite, FavoriteEntityRef, FavoritesList, FileChangeKindDto, FileSystemNodeWithIds, FileType, FileTypeUpdate, FilterCondition, FilterGroup, FilterNode, FilterTest, FinalizeSlackImportData, FinalizeSlackImportErrors, FinalizeSlackImportResponse, FinalizeSlackImportResponses, FolderItem, FollowupState, ForeignEntity, ForeignEntityFilters, Form, FormAccess, FormCollaboration, FormDetail, FormErrorCode, FormErrorResponse, FormLayout, FormPublicationProblem, FormQuestionDetail, FormResponse, FormSection, FormSectionDetail, FormSource, FormStatus, FormTally, GenericErrorResponse, GenericResponse, GenericSuccessResponse, GetActiveCallsData, GetActiveCallsError, GetActiveCallsErrors, GetActiveCallsResponse, GetActiveCallsResponses, GetActivityData, GetActivityError, GetActivityErrors, GetActivityResponse, GetActivityResponses, GetAttachmentReferencesData, GetAttachmentReferencesError, GetAttachmentReferencesErrors, GetAttachmentReferencesResponse, GetAttachmentReferencesResponse2, GetAttachmentReferencesResponses, GetBatchCallRecordPreviewData, GetBatchCallRecordPreviewError, GetBatchCallRecordPreviewErrors, GetBatchCallRecordPreviewRequest, GetBatchCallRecordPreviewResponse, GetBatchCallRecordPreviewResponse2, GetBatchCallRecordPreviewResponses, GetBatchChannelPreviewData, GetBatchChannelPreviewError, GetBatchChannelPreviewErrors, GetBatchChannelPreviewRequest, GetBatchChannelPreviewResponse, GetBatchChannelPreviewResponse2, GetBatchChannelPreviewResponses, GetBatchPreviewHandlerData, GetBatchPreviewHandlerError, GetBatchPreviewHandlerErrors, GetBatchPreviewHandlerResponse, GetBatchPreviewHandlerResponses, GetBatchPreviewRequest, GetBatchPreviewResponse, GetBatchProjectPreviewData, GetBatchProjectPreviewError, GetBatchProjectPreviewErrors, GetBatchProjectPreviewRequest, GetBatchProjectPreviewResponse, GetBatchProjectPreviewResponse2, GetBatchProjectPreviewResponses, GetBotOwnerProfilesData, GetBotOwnerProfilesError, GetBotOwnerProfilesErrors, GetBotOwnerProfilesResponse, GetBotOwnerProfilesResponses, GetCallRecordData, GetCallRecordError, GetCallRecordErrors, GetCallRecordResponse, GetCallRecordResponses, GetChannelAttachmentsData, GetChannelAttachmentsError, GetChannelAttachmentsErrors, GetChannelAttachmentsResponse, GetChannelAttachmentsResponses, GetChannelData, GetChannelError, GetChannelErrors, GetChannelJoinLinkData, GetChannelJoinLinkError, GetChannelJoinLinkErrors, GetChannelJoinLinkResponse, GetChannelJoinLinkResponses, GetChannelParticipantsData, GetChannelParticipantsError, GetChannelParticipantsErrors, GetChannelParticipantsResponse, GetChannelParticipantsResponses, GetChannelResponse, GetChannelResponses, GetChannelsData, GetChannelsError, GetChannelsErrors, GetChannelsResponse, GetChannelsResponses, GetCollabSurfaceData, GetCollabSurfaceError, GetCollabSurfaceErrors, GetCollabSurfaceResponse, GetCollabSurfaceResponses, GetCompanyData, GetCompanyError, GetCompanyErrors, GetCompanyResponse, GetCompanyResponses, GetContactByEmailData, GetContactByEmailError, GetContactByEmailErrors, GetContactByEmailResponse, GetContactByEmailResponse2, GetContactByEmailResponses, GetContactData, GetContactError, GetContactErrors, GetContactResponse, GetContactResponses, GetCrmPipelineData, GetCrmPipelineResponse, GetCrmPipelineResponses, GetCrmPipelineRowsData, GetCrmPipelineRowsResponse, GetCrmPipelineRowsResponses, GetCrmPipelineTableData, GetCrmPipelineTableResponse, GetCrmPipelineTableResponses, GetCrmTeamSettingsData, GetCrmTeamSettingsError, GetCrmTeamSettingsErrors, GetCrmTeamSettingsResponse, GetCrmTeamSettingsResponses, GetDatabaseData, GetDatabaseError, GetDatabaseErrors, GetDatabasePermissionsData, GetDatabasePermissionsError, GetDatabasePermissionsErrors, GetDatabasePermissionsResponse, GetDatabasePermissionsResponses, GetDatabaseQueryData, GetDatabaseQueryError, GetDatabaseQueryErrors, GetDatabaseQueryResponse, GetDatabaseQueryResponses, GetDatabaseResponse, GetDatabaseResponses, GetDatabaseRowHistoryData, GetDatabaseRowHistoryError, GetDatabaseRowHistoryErrors, GetDatabaseRowHistoryResponse, GetDatabaseRowHistoryResponses, GetDatabaseTableChangesData, GetDatabaseTableChangesError, GetDatabaseTableChangesErrors, GetDatabaseTableChangesResponse, GetDatabaseTableChangesResponses, GetDatabaseViewPositionsData, GetDatabaseViewPositionsError, GetDatabaseViewPositionsErrors, GetDatabaseViewPositionsResponse, GetDatabaseViewPositionsResponses, GetDocumentAnchorsData, GetDocumentAnchorsError, GetDocumentAnchorsErrors, GetDocumentAnchorsResponse, GetDocumentAnchorsResponses, GetDocumentBranchNameData, GetDocumentBranchNameError, GetDocumentBranchNameErrors, GetDocumentBranchNameResponse, GetDocumentBranchNameResponses, GetDocumentByTeamSlugData, GetDocumentByTeamSlugError, GetDocumentByTeamSlugErrors, GetDocumentByTeamSlugResponse, GetDocumentByTeamSlugResponses, GetDocumentData, GetDocumentError, GetDocumentErrors, GetDocumentGithubPullRequestsData, GetDocumentGithubPullRequestsError, GetDocumentGithubPullRequestsErrors, GetDocumentGithubPullRequestsResponse, GetDocumentGithubPullRequestsResponses, GetDocumentKeyResponse, GetDocumentKeyResponseData, GetDocumentListHandlerData, GetDocumentListHandlerError, GetDocumentListHandlerErrors, GetDocumentListHandlerResponse, GetDocumentListHandlerResponses, GetDocumentListResult, GetDocumentLocationV3Data, GetDocumentLocationV3Error, GetDocumentLocationV3Errors, GetDocumentLocationV3Response, GetDocumentLocationV3Responses, GetDocumentPermissionsResponseDataV2, GetDocumentPermissionsTokenData, GetDocumentPermissionsTokenError, GetDocumentPermissionsTokenErrors, GetDocumentPermissionsTokenResponse, GetDocumentPermissionsTokenResponses, GetDocumentPermissionsV2Data, GetDocumentPermissionsV2Error, GetDocumentPermissionsV2Errors, GetDocumentPermissionsV2Response, GetDocumentPermissionsV2Responses, GetDocumentProcessingResult, GetDocumentProcessingResultData, GetDocumentProcessingResultError, GetDocumentProcessingResultErrors, GetDocumentProcessingResultResponse, GetDocumentProcessingResultResponse2, GetDocumentProcessingResultResponses, GetDocumentResponse, GetDocumentResponse2, GetDocumentResponseData, GetDocumentResponses, GetDocumentSearchResponse, GetDocumentShortIdData, GetDocumentShortIdError, GetDocumentShortIdErrors, GetDocumentShortIdResponse, GetDocumentShortIdResponses, GetDocumentsResponse, GetDocumentTeamShareData, GetDocumentTeamShareError, GetDocumentTeamShareErrors, GetDocumentTeamShareResponse, GetDocumentTeamShareResponses, GetDocumentUserAccessLevelResponse, GetDocumentVersionData, GetDocumentVersionError, GetDocumentVersionErrors, GetDocumentVersionResponse, GetDocumentVersionResponses, GetDocumentViewsHandlerData, GetDocumentViewsHandlerError, GetDocumentViewsHandlerErrors, GetDocumentViewsHandlerResponse, GetDocumentViewsHandlerResponses, GetEmailFollowupData, GetEmailFollowupError, GetEmailFollowupErrors, GetEmailFollowupResponse, GetEmailFollowupResponses, GetEntityPermissionData, GetEntityPermissionErrors, GetEntityPermissionResponse, GetEntityPermissionResponses, GetForeignEntityBySourceData, GetForeignEntityBySourceError, GetForeignEntityBySourceErrors, GetForeignEntityBySourceResponse, GetForeignEntityBySourceResponses, GetForeignEntityData, GetForeignEntityError, GetForeignEntityErrors, GetForeignEntityResponse, GetForeignEntityResponses, GetFormData, GetFormError, GetFormErrors, GetFormPermissionsData, GetFormPermissionsError, GetFormPermissionsErrors, GetFormPermissionsResponse, GetFormPermissionsResponses, GetFormResponse, GetFormResponses, GetFormResponseSummaryData, GetFormResponseSummaryError, GetFormResponseSummaryErrors, GetFormResponseSummaryResponse, GetFormResponseSummaryResponses, GetFormTallyData, GetFormTallyError, GetFormTallyErrors, GetFormTallyResponse, GetFormTallyResponses, GetGithubPullRequestChangesData, GetGithubPullRequestChangesError, GetGithubPullRequestChangesErrors, GetGithubPullRequestChangesPatchData, GetGithubPullRequestChangesPatchError, GetGithubPullRequestChangesPatchErrors, GetGithubPullRequestChangesPatchResponse, GetGithubPullRequestChangesPatchResponses, GetGithubPullRequestChangesResponse, GetGithubPullRequestChangesResponses, GetGithubPullRequestData, GetGithubPullRequestError, GetGithubPullRequestErrors, GetGithubPullRequestFacetsData, GetGithubPullRequestFacetsError, GetGithubPullRequestFacetsErrors, GetGithubPullRequestFacetsResponse, GetGithubPullRequestFacetsResponses, GetGithubPullRequestResponse, GetGithubPullRequestResponses, GetGithubPullRequestTasksData, GetGithubPullRequestTasksError, GetGithubPullRequestTasksErrors, GetGithubPullRequestTasksResponse, GetGithubPullRequestTasksResponses, GetHarnessPairingData, GetHarnessPairingError, GetHarnessPairingErrors, GetHarnessPairingResponse, GetHarnessPairingResponses, GetHistoryHandlerData, GetHistoryHandlerError, GetHistoryHandlerErrors, GetHistoryHandlerResponse, GetHistoryHandlerResponses, GetInitiativeData, GetInitiativeError, GetInitiativeErrors, GetInitiativeResponse, GetInitiativeResponses, GetInstructionsDocumentResponse, GetInstructionsHandlerData, GetInstructionsHandlerError, GetInstructionsHandlerErrors, GetInstructionsHandlerResponse, GetInstructionsHandlerResponses, GetItemsSoupData, GetItemsSoupError, GetItemsSoupErrors, GetItemsSoupResponse, GetItemsSoupResponses, GetLocationHandlerData, GetLocationHandlerError, GetLocationHandlerErrors, GetLocationHandlerResponse, GetLocationHandlerResponses, GetMyFormResponseData, GetMyFormResponseError, GetMyFormResponseErrors, GetMyFormResponseResponse, GetMyFormResponseResponses, GetOrCreateAction, GetOrCreateCallData, GetOrCreateCallError, GetOrCreateCallErrors, GetOrCreateCallResponse, GetOrCreateCallResponses, GetOrCreateChannelResponse, GetOrCreateDmData, GetOrCreateDmError, GetOrCreateDmErrors, GetOrCreateDmRequest, GetOrCreateDmResponse, GetOrCreateDmResponses, GetOrCreatePrivateData, GetOrCreatePrivateError, GetOrCreatePrivateErrors, GetOrCreatePrivateRequest, GetOrCreatePrivateResponse, GetOrCreatePrivateResponses, GetPendingProjectsHandlerData, GetPendingProjectsHandlerError, GetPendingProjectsHandlerErrors, GetPendingProjectsHandlerResponse, GetPendingProjectsHandlerResponses, GetPinsHandlerData, GetPinsHandlerError, GetPinsHandlerErrors, GetPinsHandlerResponse, GetPinsHandlerResponses, GetPinsResponse, GetProjectContentHandlerData, GetProjectContentHandlerError, GetProjectContentHandlerErrors, GetProjectContentHandlerResponse, GetProjectContentHandlerResponses, GetProjectContentResponse, GetProjectHandlerData, GetProjectHandlerError, GetProjectHandlerErrors, GetProjectHandlerResponse, GetProjectHandlerResponses, GetProjectPermissionsV2Data, GetProjectPermissionsV2Error, GetProjectPermissionsV2Errors, GetProjectPermissionsV2Response, GetProjectPermissionsV2Responses, GetProjectResponse, GetProjectResponseData, GetProjectsHandlerData, GetProjectsHandlerError, GetProjectsHandlerErrors, GetProjectsHandlerResponse, GetProjectsHandlerResponses, GetProjectsResponse, GetProjectUserAccessLevelData, GetProjectUserAccessLevelError, GetProjectUserAccessLevelErrors, GetProjectUserAccessLevelResponse, GetProjectUserAccessLevelResponses, GetRingStatusData, GetRingStatusError, GetRingStatusErrors, GetRingStatusResponse, GetRingStatusResponses, GetSelfBotData, GetSelfBotError, GetSelfBotErrors, GetSelfBotResponse, GetSelfBotResponses, GetSelfHarnessData, GetSelfHarnessError, GetSelfHarnessErrors, GetSelfHarnessResponse, GetSelfHarnessResponses, GetSlackImportData, GetSlackImportErrors, GetSlackImportResponse, GetSlackImportResponses, GetSystemSkillsHandlerData, GetSystemSkillsHandlerError, GetSystemSkillsHandlerErrors, GetSystemSkillsHandlerResponse, GetSystemSkillsHandlerResponses, GetUserDocumentsHandlerData, GetUserDocumentsHandlerError, GetUserDocumentsHandlerErrors, GetUserDocumentsHandlerResponse, GetUserDocumentsHandlerResponses, GetUserDocumentViewLocationData, GetUserDocumentViewLocationError, GetUserDocumentViewLocationErrors, GetUserDocumentViewLocationResponse, GetUserDocumentViewLocationResponses, GetUserHistoryResponse, GetViewsHandlerData, GetViewsHandlerError, GetViewsHandlerErrors, GetViewsHandlerResponse, GetViewsHandlerResponses, GetWebhookData, GetWebhookError, GetWebhookErrors, GetWebhookResponse, GetWebhookResponses, GithubLabelFacet, GithubPullRequest, GithubPullRequestChangesPatchResponse, GithubPullRequestChangesResponse, GithubPullRequestCheckRun, GithubPullRequestComment, GithubPullRequestFacets, GithubPullRequestLabel, GithubPullRequestReview, GithubPullRequestReviewDecision, GithubPullRequestReviewState, GithubPullRequestsResponse, GithubPullRequestTasks, GithubPullRequestTasksRequest, GithubPullRequestTasksResponse, GithubPullRequestUser, GithubRepositoryFacet, GithubUserFacet, GitRefDto, GroupedInitialParams, GroupedPageParams, GroupedSoupGroupPage, GroupedSoupInitialPage, GroupedSoupPage, GroupedSoupSort, GuestId, GuestJoinRequest, HandlerData, HandlerError, HandlerErrors, HandlerResponse, HandlerResponses, Harness, HarnessAgent, HarnessId, HarnessOwner, HarnessSession, HashMap, HealthHandlerData, HealthHandlerResponse, HealthHandlerResponses, HighlightType, ImportCounters, ImportDatabaseTableData, ImportDatabaseTableError, ImportDatabaseTableErrors, ImportDatabaseTableResponse, ImportDatabaseTableResponses, ImportedAuthor, ImportError, ImportLimits, ImportPage, ImportProgress, ImportTable, ImportWarning, InferColumnTypeOutcome, InferColumnTypeRequest, InferDatabaseColumnTypeData, InferDatabaseColumnTypeError, InferDatabaseColumnTypeErrors, InferDatabaseColumnTypeResponse, InferDatabaseColumnTypeResponses, InFlightTurnSummary, IngestTranscriptData, IngestTranscriptError, IngestTranscriptErrors, IngestTranscriptResponses, InitializeUserDocumentsData, InitializeUserDocumentsError, InitializeUserDocumentsErrors, InitializeUserDocumentsResponse, InitializeUserDocumentsResponses, InitialPropertyValue, InitiativeDetail, InitiativeFilters, InitiativeId, InitiativeList, InitiativeSummary, InputReceivedMetadata, InstallSyncData, InstallSyncErrors, InteractionReason, InviteMeetingRequest, InviteMeetingUsersRequest, Item, ItemWithUserAccessLevel, JobId, JobProcessingResultHandlerData, JobProcessingResultHandlerError, JobProcessingResultHandlerErrors, JobProcessingResultHandlerResponse, JobProcessingResultHandlerResponses, JobStatus, JoinChannelByCodeData, JoinChannelByCodeError, JoinChannelByCodeErrors, JoinChannelByCodeResponses, JoinChannelData, JoinChannelError, JoinChannelErrors, JoinChannelResponses, KeySegment, Lane, LaneKey, LatestMessage, LayoutProblem, LeaveCallResponse, LeaveChannelData, LeaveChannelError, LeaveChannelErrors, LeaveChannelResponses, LeaveOrEndCallData, LeaveOrEndCallError, LeaveOrEndCallErrors, LeaveOrEndCallResponse, LeaveOrEndCallResponses, LinkShare, ListAccessibleFormsData, ListAccessibleFormsError, ListAccessibleFormsErrors, ListAccessibleFormsResponse, ListAccessibleFormsResponses, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListBotChannelsData, ListBotChannelsError, ListBotChannelsErrors, ListBotChannelsResponse, ListBotChannelsResponses, ListChannelLabelsData, ListChannelLabelsError, ListChannelLabelsErrors, ListChannelLabelsResponse, ListChannelLabelsResponses, ListCompanyContactsData, ListCompanyContactsError, ListCompanyContactsErrors, ListCompanyContactsResponse, ListCompanyContactsResponses, ListCrmPipelinesData, ListCrmPipelinesResponse, ListCrmPipelinesResponses, ListDatabaseColumnCastsData, ListDatabaseColumnCastsError, ListDatabaseColumnCastsErrors, ListDatabaseColumnCastsResponse, ListDatabaseColumnCastsResponses, ListDatabasesData, ListDatabasesError, ListDatabasesErrors, ListDatabasesResponse, ListDatabasesResponses, ListedDatabase, ListedForm, ListEmailRemindersData, ListEmailRemindersError, ListEmailRemindersErrors, ListEmailRemindersResponse, ListEmailRemindersResponses, ListFavoritesData, ListFavoritesError, ListFavoritesErrors, ListFavoritesResponse, ListFavoritesResponses, ListFormsData, ListFormsError, ListFormsErrors, ListFormsResponse, ListFormsResponses, ListHarnessAgentsData, ListHarnessAgentsError, ListHarnessAgentsErrors, ListHarnessAgentsResponse, ListHarnessAgentsResponses, ListHarnessesData, ListHarnessesError, ListHarnessesErrors, ListHarnessesResponse, ListHarnessesResponses, ListHarnessSessionsData, ListHarnessSessionsError, ListHarnessSessionsErrors, ListHarnessSessionsResponse, ListHarnessSessionsResponses, ListInitiativesData, ListInitiativesError, ListInitiativesErrors, ListInitiativesResponse, ListInitiativesResponses, ListOccurrencesData, ListOccurrencesErrors, ListOccurrencesResponse, ListOccurrencesResponses, ListSlackImportsData, ListSlackImportsResponse, ListSlackImportsResponses, ListTeamCalendarData, ListTeamCalendarResponse, ListTeamCalendarResponses, ListTeamOutOfOfficeData, ListTeamOutOfOfficeErrors, ListTeamOutOfOfficeResponse, ListTeamOutOfOfficeResponses, ListUserApiKeysData, ListUserApiKeysError, ListUserApiKeysErrors, ListUserApiKeysResponse, ListUserApiKeysResponses, ListWebhooksData, ListWebhooksError, ListWebhooksErrors, ListWebhooksResponse, ListWebhooksResponse2, ListWebhooksResponses, LocationResponseData, LocationResponseV3, MacroUserIdStr, Meeting, MeetingCancelData, MeetingCancelError, MeetingCancelErrors, MeetingCancelPreparationData, MeetingCancelPreparationError, MeetingCancelPreparationErrors, MeetingCancelPreparationResponse, MeetingCancelPreparationResponses, MeetingCancelResponse, MeetingCancelResponses, MeetingCreateData, MeetingCreateError, MeetingCreateErrors, MeetingCreateResponse, MeetingCreateResponses, MeetingGuestJoinData, MeetingGuestJoinError, MeetingGuestJoinErrors, MeetingGuestJoinResponse, MeetingGuestJoinResponses, MeetingGuestParticipantsData, MeetingGuestParticipantsError, MeetingGuestParticipantsErrors, MeetingGuestParticipantsResponse, MeetingGuestParticipantsResponses, MeetingInviteData, MeetingInviteError, MeetingInviteErrors, MeetingInvitePermissions, MeetingInvitePermissionsData, MeetingInvitePermissionsError, MeetingInvitePermissionsErrors, MeetingInvitePermissionsResponse, MeetingInvitePermissionsResponses, MeetingInviteResponse, MeetingInviteResponses, MeetingInviteUsersData, MeetingInviteUsersError, MeetingInviteUsersErrors, MeetingInviteUsersResponse, MeetingInviteUsersResponses, MeetingJoinData, MeetingJoinError, MeetingJoinErrors, MeetingJoinResponse, MeetingJoinResponses, MeetingLeaveData, MeetingLeaveError, MeetingLeaveErrors, MeetingLeaveResponse, MeetingLeaveResponses, MeetingListActiveData, MeetingListActiveError, MeetingListActiveErrors, MeetingListActiveResponse, MeetingListActiveResponses, MeetingListData, MeetingListError, MeetingListErrors, MeetingListResponse, MeetingListResponses, MeetingLookupData, MeetingLookupError, MeetingLookupErrors, MeetingLookupResponse, MeetingLookupResponses, MeetingParticipant, MeetingParticipants, MeetingParticipantsData, MeetingParticipantsError, MeetingParticipantsErrors, MeetingParticipantsResponse, MeetingParticipantsResponses, MeetingPreparation, MeetingPrepareData, MeetingPrepareError, MeetingPrepareErrors, MeetingPrepareResponse, MeetingPrepareResponses, MeetingShareData, MeetingShareError, MeetingShareErrors, MeetingShareResponse, MeetingShareResponses, MeetingsResponse, MeetingToken, MeetingUpdateData, MeetingUpdateError, MeetingUpdateErrors, MeetingUpdateResponse, MeetingUpdateResponses, MentionPreviewsData, MentionPreviewsErrors, MentionPreviewsResponse, MentionPreviewsResponses, Message, MessageAttachment, MessageAttachmentCreatedMetadata, MessageAttachmentRemovedMetadata, MessageChange, MessageCursor, MessageDeletedMetadata, MessageDirection, MessageEvent, MessageEventAttachment, MessageListItem, MessageMentionedMetadata, MessagePage, MessageParent, MessagePatch, MessagePatchedMetadata, MessagePostedMetadata, MessageThread, MessageThreadPreview, MessageTimelineData, MessageTimelineEntriesData, MessageTimelineEntriesResponse, MessageTimelineEntriesResponses, MessageTimelineEntry, MessageTimelinePage, MessageTimelineQuery, MessageTimelineResponse, MessageTimelineResponses, MessageTopicEvent, MyResponse, NewAttachment, NewColumn, NewOption, NewThreadAnchor, NewView, NotificationFilters, NotificationState, NumberOperator, OpBatch, OpRefusalResponse, OpResult, OptionRef, PairingDetails, Params, ParticipantRole, PatchBotRequest, PatchChannelData, PatchChannelError, PatchChannelErrors, PatchChannelRequest, PatchChannelResponse, PatchChannelResponses, PatchMessageNotificationPolicy, PatchProjectRequestV2, PatchThreadRequestV2, PatchViewHandlerData, PatchViewHandlerError, PatchViewHandlerErrors, PatchViewHandlerResponses, PatchWebhookData, PatchWebhookError, PatchWebhookErrors, PatchWebhookRequest, PatchWebhookResponse, PatchWebhookResponses, PdfAnchor, PdfAnchorId, PdfHighlightAnchor, PdfHighlightAnchorRequest, PdfHighlightRect, PdfHighlightRectAnchorRequest, PdfPlaceableCommentAnchor, PendingClaimResponse, PermanentlyDeleteDocumentData, PermanentlyDeleteDocumentError, PermanentlyDeleteDocumentErrors, PermanentlyDeleteDocumentResponse, PermanentlyDeleteDocumentResponses, PermanentlyDeleteProjectData, PermanentlyDeleteProjectError, PermanentlyDeleteProjectErrors, PermanentlyDeleteProjectResponse, PermanentlyDeleteProjectResponses, PinnedItem, PinRequest, Pipeline, PipelineRecordType, PipelineSharing, PostActivityData, PostActivityError, PostActivityErrors, PostActivityRequest, PostActivityResponse, PostActivityResponses, PostChannelBotWebhookData, PostChannelBotWebhookError, PostChannelBotWebhookErrors, PostChannelBotWebhookResponse, PostChannelBotWebhookResponses, PostGroupedSoupAstGroupPageRequest, PostGroupedSoupAstInitialRequest, PostGroupedSoupAstRequest, PostItemsSoupAstData, PostItemsSoupAstError, PostItemsSoupAstErrors, PostItemsSoupAstGroupedData, PostItemsSoupAstGroupedError, PostItemsSoupAstGroupedErrors, PostItemsSoupAstGroupedResponse, PostItemsSoupAstGroupedResponses, PostItemsSoupAstResponse, PostItemsSoupAstResponses, PostItemsSoupData, PostItemsSoupError, PostItemsSoupErrors, PostItemsSoupResponse, PostItemsSoupResponses, PostMessage, PostMessageNotificationPolicy, PostSoupAstRequest, PostSoupRequest, PresaveDocumentHandlerData, PresaveDocumentHandlerError, PresaveDocumentHandlerErrors, PresaveDocumentHandlerResponse, PresaveDocumentHandlerResponses, PreSaveDocumentRequest, PreSaveDocumentResponse, PreSaveDocumentResponseData, PresenceOperator, PresignedUrl, PreviewSmartTagData, PreviewSmartTagError, PreviewSmartTagErrors, PreviewSmartTagResponse, PreviewSmartTagResponses, Project, ProjectDeleteResponseData, ProjectDocumentStatus, ProjectFilters, ProjectPreview, ProjectPreviewData, PropertyDefinition, PropertyDefinitionWithOptions, PropertyFilter, PropertyInput, PropertyOption, PropertyOptionValue, PropertyOwner, PropertyValue, PutCrmTeamSettingsData, PutCrmTeamSettingsError, PutCrmTeamSettingsErrors, PutCrmTeamSettingsResponse, PutCrmTeamSettingsResponses, PutCrmTeamStagesData, PutCrmTeamStagesError, PutCrmTeamStagesErrors, PutCrmTeamStagesResponse, PutCrmTeamStagesResponses, PutFormLayoutData, PutFormLayoutError, PutFormLayoutErrors, PutFormLayoutResponse, PutFormLayoutResponses, QueryCrmPipelineRowsData, QueryCrmPipelineRowsResponse, QueryCrmPipelineRowsResponses, QueryDefinition, QuestionLayout, QuestionOption, QuestionTally, ReactionInput, RecentlyDeletedData, RecentlyDeletedError, RecentlyDeletedErrors, RecentlyDeletedResponse, RecentlyDeletedResponseData, RecentlyDeletedResponses, RegisterSlackImportUploadsData, RegisterSlackImportUploadsErrors, RegisterSlackImportUploadsResponse, RegisterSlackImportUploadsResponses, RegisterUploads, RemoveBotFromChannelByBotData, RemoveBotFromChannelByBotError, RemoveBotFromChannelByBotErrors, RemoveBotFromChannelByBotResponse, RemoveBotFromChannelByBotResponses, RemoveFavoriteByEntityData, RemoveFavoriteByEntityError, RemoveFavoriteByEntityErrors, RemoveFavoriteByEntityResponses, RemoveParticipantsData, RemoveParticipantsError, RemoveParticipantsErrors, RemoveParticipantsRequest, RemoveParticipantsResponses, RemovePinHandlerData, RemovePinHandlerError, RemovePinHandlerErrors, RemovePinHandlerResponse, RemovePinHandlerResponses, RenameChannelLabelData, RenameChannelLabelError, RenameChannelLabelErrors, RenameChannelLabelRequest, RenameChannelLabelResponse, RenameChannelLabelResponses, RenameCrmPipelineData, RenameCrmPipelineResponse, RenameCrmPipelineResponses, RenamePipeline, ReorderFavoritesData, ReorderFavoritesError, ReorderFavoritesErrors, ReorderFavoritesRequest, ReorderFavoritesResponses, ReorderPinRequest, ReorderPinsHandlerData, ReorderPinsHandlerError, ReorderPinsHandlerErrors, ReorderPinsHandlerResponse, ReorderPinsHandlerResponses, ReplaceCrmStagesRequest, RequestedHarnessScope, RequestedLayout, ResetCrmTeamStagesData, ResetCrmTeamStagesError, ResetCrmTeamStagesErrors, ResetCrmTeamStagesResponse, ResetCrmTeamStagesResponses, ResponseStatus, ResponseSummary, RevertDeleteDocumentData, RevertDeleteDocumentError, RevertDeleteDocumentErrors, RevertDeleteDocumentResponse, RevertDeleteDocumentResponses, RevertDeleteProjectData, RevertDeleteProjectError, RevertDeleteProjectErrors, RevertDeleteProjectResponse, RevertDeleteProjectResponses, RingStatus, RingStatusResponse, RowChange, RowChangeKind, RowChanges, RowHistoryEntry, RowHistoryResponse, RowId, RowsChange, RowsResult, S3ObjectInfo, SaveBomPart, SaveDatabaseQueryData, SaveDatabaseQueryError, SaveDatabaseQueryErrors, SaveDatabaseQueryResponse, SaveDatabaseQueryResponses, SaveDocumentHandlerData, SaveDocumentHandlerError, SaveDocumentHandlerErrors, SaveDocumentHandlerResponse, SaveDocumentHandlerResponses, SaveDocumentRequest, SaveDocumentResponse, SaveDocumentResponseData, SavedQuery, SaveQueryRequest, SearchContactsData, SearchContactsError, SearchContactsErrors, SearchContactsResponse, SearchContactsResponse2, SearchContactsResponses, SearchState, SectionCount, SessionDeletedMetadata, SessionIdentity, SessionMentionedMetadata, SessionOpenedMetadata, SessionRenamedMetadata, SessionSettledMetadata, SessionStoppedMetadata, SetChannelLabelData, SetChannelLabelError, SetChannelLabelErrors, SetChannelLabelRequest, SetChannelLabelResponse, SetChannelLabelResponses, SetChannelPictureData, SetChannelPictureError, SetChannelPictureErrors, SetChannelPictureRequest, SetChannelPictureResponse, SetChannelPictureResponses, SetCompanyHiddenData, SetCompanyHiddenError, SetCompanyHiddenErrors, SetCompanyHiddenRequest, SetCompanyHiddenResponse, SetCompanyHiddenResponses, SetCompanyNameRequest, SetContactHiddenData, SetContactHiddenError, SetContactHiddenErrors, SetContactHiddenRequest, SetContactHiddenResponse, SetContactHiddenResponses, SetContactNameRequest, SetCrmCompanyNameData, SetCrmCompanyNameError, SetCrmCompanyNameErrors, SetCrmCompanyNameResponse, SetCrmCompanyNameResponses, SetCrmContactNameData, SetCrmContactNameError, SetCrmContactNameErrors, SetCrmContactNameResponse, SetCrmContactNameResponses, SetDocumentTeamShareData, SetDocumentTeamShareError, SetDocumentTeamShareErrors, SetDocumentTeamShareRequest, SetDocumentTeamShareResponse, SetDocumentTeamShareResponses, SetEmailFollowupData, SetEmailFollowupError, SetEmailFollowupErrors, SetEmailFollowupResponse, SetEmailFollowupResponses, SetEmailSyncData, SetEmailSyncError, SetEmailSyncErrors, SetEmailSyncRequest, SetEmailSyncResponse, SetEmailSyncResponses, SetOperator, SetPropertyValue, Sha256Digest, ShareCrmPipelineData, ShareCrmPipelineResponse, ShareCrmPipelineResponses, ShareDatabaseAwarenessData, ShareDatabaseAwarenessError, ShareDatabaseAwarenessErrors, ShareDatabaseAwarenessResponse, ShareDatabaseAwarenessResponses, SharedEmailFilter, SharePermissionV2, SharePipeline, ShortIdResponse, SimpleMention, SimpleSaveData, SimpleSaveError, SimpleSaveErrors, SimpleSaveResponse, SimpleSaveResponses, SkippedCell, SlackCompleteRequest, SlackCreateRequest, SlackRegisterRequest, SlackTimestamp, SlackUserId, SmartTagChannelMatch, SmartTagPreview, SortDirection, SortKey, SoupAgentSessionSoupPropertiesField, SoupApiItem, SoupApiSort, SoupApiSortDirection, SoupAttachment, SoupCalendarEventSoupPropertiesField, SoupCalendarEventTime, SoupCallRecordGuest, SoupCallRecordParticipant, SoupCallRecordSoupPropertiesField, SoupChannel, SoupChannelThread, SoupChatSoupPropertiesField, SoupContact, SoupCountedReaction, SoupCrmCompanySoupPropertiesField, SoupCrmContactSoupPropertiesField, SoupCrmDomain, SoupDatabaseRowSoupPropertiesField, SoupDocumentSoupPropertiesField, SoupDocumentSubType, SoupEmailThreadPreview, SoupEnrichedEmailThreadPreviewSoupPropertiesField, SoupForeignEntity, SoupInitiativeSoupPropertiesField, SoupItem, SoupLabel, SoupLabelListVisibility, SoupLabelType, SoupMessageAttachment, SoupMessageListVisibility, SoupMessageSender, SoupMessageSenderType, SoupPage, SoupProjectSoupPropertiesField, SoupPropertiesField, SoupProperty, SoupThreadInfo, SoupThreadReply, SourceBinding, SourceId, SourceIdentity, StarterDatabase, StarterDocumentsResponse, StorageRow, StorageRows, StorageRowsQuery, StoredGithubPullRequest, StreamEventsData, StreamEventsError, StreamEventsErrors, StreamEventsResponse, StreamEventsResponses, String, Submission, SubmissionOutcome, SubmitFormResponseData, SubmitFormResponseError, SubmitFormResponseErrors, SubmitFormResponseResponse, SubmitFormResponseResponses, SuccessResponse, SurfaceState, SyncServiceVersionId, SystemSkillSummary, Table, TableChange, TableChanged, TableChanges, TableDetail, TableResult, TableVersion, TagFilterMode, TakenId, TallyBucket, TallyValue, TaskFilters, TeamCalendarContent, TeamCalendarCoverage, TeamCalendarDetails, TeamCalendarItem, TeamCalendarMember, TeamCalendarPage, TeamCalendarSharing, TeamOutOfOfficeItem, TeamOutOfOfficeResponse, TeamRole, TextOperator, ThreadAnchor, ThreadOrigin, ThreadPatch, ThreadState, TimelineActivity, ToggleShareWithTeamData, ToggleShareWithTeamError, ToggleShareWithTeamErrors, ToggleShareWithTeamResponse, ToggleShareWithTeamResponses, TouchedColumn, TouchedRow, TranscribeDictationData, TranscribeDictationError, TranscribeDictationErrors, TranscribeDictationResponse, TranscribeDictationResponses, TranscribeResponse, TranscriptSegmentRequest, TrashCrmPipelineData, TrashCrmPipelineResponse, TrashCrmPipelineResponses, TrashPipeline, TurnEndedMetadata, TurnStartedMetadata, TurnSummary, TypedSuccessResponse, TypedSuccessResponseGetDocumentResponseData, TypingInput, UndoChangeResponse, UndoDatabaseChangeData, UndoDatabaseChangeError, UndoDatabaseChangeErrors, UndoDatabaseChangeResponse, UndoDatabaseChangeResponses, UndoOutcome, UndoRefusal, UnlockedBooking, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentRequest, UpdateAgentResponse, UpdateAgentResponses, UpdateChannelSharePermission, UpdateCrmTeamSettingsRequest, UpdateDatabasePermissionsData, UpdateDatabasePermissionsError, UpdateDatabasePermissionsErrors, UpdateDatabasePermissionsResponse, UpdateDatabasePermissionsResponses, UpdateForm, UpdateFormData, UpdateFormError, UpdateFormErrors, UpdateFormPermissionsData, UpdateFormPermissionsError, UpdateFormPermissionsErrors, UpdateFormPermissionsResponse, UpdateFormPermissionsResponses, UpdateFormResponse, UpdateFormResponses, UpdateInitiativeData, UpdateInitiativeError, UpdateInitiativeErrors, UpdateInitiativeRequest, UpdateInitiativeResponse, UpdateInitiativeResponses, UpdateMeetingRequest, UpdateOperation, UpdateSharePermissionRequestV2, UploadDescriptor, UploadDocumentStatus, UploadExtractFolderHandlerData, UploadExtractFolderHandlerError, UploadExtractFolderHandlerErrors, UploadExtractFolderHandlerResponse, UploadExtractFolderHandlerResponses, UploadExtractFolderRequest, UploadFolderHandlerData, UploadFolderHandlerError, UploadFolderHandlerErrors, UploadFolderHandlerResponse, UploadFolderHandlerResponses, UploadFolderRequest, UploadGrant, UploadId, UpsertHistoryHandlerData, UpsertHistoryHandlerError, UpsertHistoryHandlerErrors, UpsertHistoryHandlerResponse, UpsertHistoryHandlerResponses, UpsertUserDocumentViewLocationData, UpsertUserDocumentViewLocationError, UpsertUserDocumentViewLocationErrors, UpsertUserDocumentViewLocationRequest, UpsertUserDocumentViewLocationResponse, UpsertUserDocumentViewLocationResponses, UserApiKeyId, UserApiKeyInfo, UserApiKeysList, UserDocumentsResponse, UserDocumentViewLocation, UserDocumentViewLocationResponse, UserPinsResponse, UserViewsResponse, ValidateDocumentPermissionsTokenData, ValidateDocumentPermissionsTokenError, ValidateDocumentPermissionsTokenErrors, ValidateDocumentPermissionsTokenResponse, ValidateDocumentPermissionsTokenResponses, ValidateWebhookData, ValidateWebhookError, ValidateWebhookErrors, ValidateWebhookResponse, ValidateWebhookResponse2, ValidateWebhookResponses, Vec, VersionedTable, View, ViewChange, ViewColumn, ViewLayout, ViewPatch, ViewPosition, ViewPositionsResponse, ViewQuery, ViewResult, ViewsResponse, WaitingForInputMetadata, Webhook, WebhookEvent, WebhookFilter, WebhookScope, WebhookStatus, WebhookValidationTestEvent, Widget, WithCallId, WithChannelId, WithDocumentId, WithProjectId } from './types.gen';
+export type { AccessiblePipeline, AccessLevel, ActiveCallsResponse, ActiveCallSummary, ActiveMeeting, ActiveMeetingsResponse, ActivityType, AddFavoriteData, AddFavoriteError, AddFavoriteErrors, AddFavoriteRequest, AddFavoriteResponse, AddFavoriteResponses, AddParticipantsData, AddParticipantsError, AddParticipantsErrors, AddParticipantsRequest, AddParticipantsResponses, AddPinHandlerData, AddPinHandlerError, AddPinHandlerErrors, AddPinHandlerResponse, AddPinHandlerResponses, AddPinRequest, Agent, AgentActionId, AgentChannelScope, AgentMcpServer, AgentMcpServers, AgentPullRequestState, AgentSessionFilters, AgentSessionLifecycleEvent, Anchor, AnchorId, AnchorResponse, AnnotationIncrementalUpdate, Answer, ApiActivity, ApiAttachmentChannelReference, ApiAttachmentEntityReference, ApiAttachmentGenericReference, ApiChannelAttachment, ApiChannelAttachmentsPage, ApiChannelDetail, ApiChannelListMessage, ApiChannelListPage, ApiChannelListParticipant, ApiChannelListType, ApiChannelParticipant, ApiChannelWithLatest, ApiEntityFilterAst, ApiGroupByField, ApiGroupMeta, ApiParticipantListRole, ApiParticipantRole, ApiPropertyEntityType, AppliedOps, ApplyCrmPipelineOpsData, ApplyCrmPipelineOpsResponse, ApplyCrmPipelineOpsResponses, ApplyDatabaseOpsData, ApplyDatabaseOpsError, ApplyDatabaseOpsErrors, ApplyDatabaseOpsResponse, ApplyDatabaseOpsResponses, ApplyOpsRequest, ApplyOpsResponse, ApproveHarnessPairingData, ApproveHarnessPairingError, ApproveHarnessPairingErrors, ApproveHarnessPairingResponse, ApproveHarnessPairingResponses, ApprovePairingRequest, AttachmentChange, AttendeeResponseStatus, Audience, Awareness, AwarenessRelay, BasicDocument, BasicDocumentSubType, BomPart, BookingTarget, Bot, BotChannel, BotChannelType, BotId, BotKind, BotOwner, BotOwnerProfile, BotSenderProfile, BotToken, BranchNameResponse, BTreeMap, BulkWakeupRequest, BulkWakeupResponse, BulkWakeupSyncServiceDocumentsData, BulkWakeupSyncServiceDocumentsErrors, BulkWakeupSyncServiceDocumentsResponse, BulkWakeupSyncServiceDocumentsResponses, CalendarAttendee, CalendarEvent, CalendarEventFilters, CalendarEventSourceContent, CalendarMentionEvent, CalendarMentionPreviewItem, CalendarMentionPreviewKind, CalendarMentionPreviewRequest, CalendarMentionPreviewRequestItem, CalendarMentionPreviewResponse, CalendarOccurrence, CalendarOccurrenceItem, CalendarOccurrenceResponse, CalendarSyncStatus, CallActiveResponse, CallFilters, CallRecord, CallRecordGuest, CallRecordParticipant, CallRecordPreview, CallRecordPreviewData, CallRecordTranscriptSegment, CallStatus, CallTokenResponse, CallWebhookData, CallWebhookError, CallWebhookErrors, CallWebhookResponses, CancelSlackImportData, CancelSlackImportErrors, CancelSlackImportResponse, CancelSlackImportResponses, CardPosition, CastVerdict, CellValue, CellWrite, ChangedFileDto, ChangesetDto, ChangesetSourceDto, Channel, ChannelCreatedMetadata, ChannelDeletedMetadata, ChannelFilters, ChannelJoinCodeResponse, ChannelLabel, ChannelLabelRule, ChannelLabelsList, ChannelMessage, ChannelParticipant, ChannelParticipantAddedMetadata, ChannelParticipantRemovedMetadata, ChannelPictureChangedMetadata, ChannelPreview, ChannelPreviewData, ChannelSender, ChannelSharePermission, ChannelThreadFilters, ChannelTopicEvent, ChannelType, ChannelUpdatedMetadata, ChannelWebhookRequest, ChannelWebhookResponse, ChannelWithParticipants, Chat, ChatFilters, CheckActiveCallData, CheckActiveCallError, CheckActiveCallErrors, CheckActiveCallResponse, CheckActiveCallResponses, ClaimedPairing, ClaimHarnessPairingData, ClaimHarnessPairingError, ClaimHarnessPairingErrors, ClaimHarnessPairingResponse, ClaimHarnessPairingResponses, ClaimPairingRequest, ClientOptions, CloudStorageItemType, CollaborateFormData, CollaborateFormError, CollaborateFormErrors, CollaborateFormResponse, CollaborateFormResponses, CollabSurfaceResponse, CollabSurfaceTokenResponse, Column, ColumnCast, ColumnChange, ColumnChangeKind, ColumnConfig, ColumnConversion, ColumnConversionRequest, ColumnDetail, ColumnKind, ColumnProtection, ColumnResult, CommandFailure, CommandRejectedMetadata, CommittedChange, CompleteSlackImportUploadsData, CompleteSlackImportUploadsErrors, CompleteSlackImportUploadsResponse, CompleteSlackImportUploadsResponses, CompleteUploads, ConferenceProvider, Conjunction, ConversationId, ConversationKind, ConversationMetadata, ConversationProgress, ConversationSeal, ConversationStatus, ConvertDatabaseColumnData, ConvertDatabaseColumnError, ConvertDatabaseColumnErrors, ConvertDatabaseColumnResponse, ConvertDatabaseColumnResponses, ConvertedCell, CopyDocumentData, CopyDocumentError, CopyDocumentErrors, CopyDocumentQueryParams, CopyDocumentRequest, CopyDocumentResponse, CopyDocumentResponse2, CopyDocumentResponses, CountedReaction, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentRequest, CreateAgentResponse, CreateAgentResponses, CreateAnchorData, CreateAnchorError, CreateAnchorErrors, CreateAnchorResponse, CreateAnchorResponses, CreateBotRequest, CreateBulkDocumentResponse, CreateBulkDocumentResponseData, CreateChannelData, CreateChannelError, CreateChannelErrors, CreateChannelLabelData, CreateChannelLabelError, CreateChannelLabelErrors, CreateChannelLabelRequest, CreateChannelLabelResponse, CreateChannelLabelResponses, CreateChannelRequest, CreateChannelResponse, CreateChannelResponse2, CreateChannelResponses, CreateChannelScopedBotData, CreateChannelScopedBotError, CreateChannelScopedBotErrors, CreateChannelScopedBotRequest, CreateChannelScopedBotResponse, CreateChannelScopedBotResponse2, CreateChannelScopedBotResponses, CreateCollabSurfaceTokenData, CreateCollabSurfaceTokenError, CreateCollabSurfaceTokenErrors, CreateCollabSurfaceTokenResponse, CreateCollabSurfaceTokenResponses, CreateCrmCompanyData, CreateCrmCompanyError, CreateCrmCompanyErrors, CreateCrmCompanyRequest, CreateCrmCompanyResponse, CreateCrmCompanyResponses, CreateCrmContactData, CreateCrmContactError, CreateCrmContactErrors, CreateCrmContactRequest, CreateCrmContactResponse, CreateCrmContactResponses, CreateCrmPipelineData, CreateCrmPipelineResponse, CreateCrmPipelineResponses, CreateDatabaseData, CreateDatabaseError, CreateDatabaseErrors, CreateDatabaseRequest, CreateDatabaseResponse, CreateDatabaseResponses, CreateDocumentData, CreateDocumentError, CreateDocumentErrors, CreateDocumentRequest, CreateDocumentResponse, CreateDocumentResponseData, CreateDocumentResponses, CreatedPairing, CreatedUserApiKey, CreateEntityMentionData, CreateEntityMentionError, CreateEntityMentionErrors, CreateEntityMentionRequest, CreateEntityMentionResponse, CreateEntityMentionResponse2, CreateEntityMentionResponses, CreateForm, CreateFormData, CreateFormError, CreateFormErrors, CreateFormResponse, CreateFormResponses, CreateHarnessPairingData, CreateHarnessPairingError, CreateHarnessPairingErrors, CreateHarnessPairingResponse, CreateHarnessPairingResponses, CreateImport, CreateInitiativeData, CreateInitiativeError, CreateInitiativeErrors, CreateInitiativeRequest, CreateInitiativeResponse, CreateInitiativeResponses, CreateInstructionsDocumentResponse, CreateInstructionsHandlerData, CreateInstructionsHandlerError, CreateInstructionsHandlerErrors, CreateInstructionsHandlerResponse, CreateInstructionsHandlerResponses, CreateMarkdownDocumentRequest, CreateMarkdownDocumentResponse, CreateMarkdownHandlerData, CreateMarkdownHandlerError, CreateMarkdownHandlerErrors, CreateMarkdownHandlerResponse, CreateMarkdownHandlerResponses, CreateMeetingRequest, CreatePairingRequest, CreatePipeline, CreateProjectHandlerData, CreateProjectHandlerError, CreateProjectHandlerErrors, CreateProjectHandlerResponse, CreateProjectHandlerResponses, CreateProjectRequest, CreateProjectResponse, CreateSkillHandlerData, CreateSkillHandlerError, CreateSkillHandlerErrors, CreateSkillHandlerResponse, CreateSkillHandlerResponses, CreateSkillRequest, CreateSkillResponse, CreateSlackImportData, CreateSlackImportErrors, CreateSlackImportResponse, CreateSlackImportResponses, CreateSnippetHandlerData, CreateSnippetHandlerError, CreateSnippetHandlerErrors, CreateSnippetHandlerResponse, CreateSnippetHandlerResponses, CreateSnippetRequest, CreateSnippetResponse, CreateTaskHandlerData, CreateTaskHandlerError, CreateTaskHandlerErrors, CreateTaskHandlerResponse, CreateTaskHandlerResponses, CreateTaskRequest, CreateTaskResponse, CreateToken, CreateUnthreadedAnchorRequest, CreateUnthreadedAnchorResponse, CreateUnthreadedPdfAnchorRequest, CreateUserApiKeyData, CreateUserApiKeyError, CreateUserApiKeyErrors, CreateUserApiKeyRequest, CreateUserApiKeyResponse, CreateUserApiKeyResponses, CreateViewHandlerData, CreateViewHandlerError, CreateViewHandlerErrors, CreateViewHandlerResponse, CreateViewHandlerResponses, CreateViewRequest, CreateWebhookData, CreateWebhookError, CreateWebhookErrors, CreateWebhookRequest, CreateWebhookResponse, CreateWebhookResponse2, CreateWebhookResponses, CrmCompanyFilters, CrmCompanyResponse, CrmContactResponse, CrmDomainResponse, CrmPermissionRole, CrmStageInput, CrmStageResponse, CrmStagesResponse, CrmTeamSettingsResponse, CustomSpeakerAssignment, Database, DatabaseDetail, DatabaseOp, DatabaseView, DataType, DateOperator, DeleteAnchorData, DeleteAnchorError, DeleteAnchorErrors, DeleteAnchorResponse, DeleteAnchorResponses, DeleteCallRecordData, DeleteCallRecordError, DeleteCallRecordErrors, DeleteCallRecordResponse, DeleteCallRecordResponses, DeleteChannelData, DeleteChannelError, DeleteChannelErrors, DeleteChannelLabelData, DeleteChannelLabelError, DeleteChannelLabelErrors, DeleteChannelLabelResponse, DeleteChannelLabelResponses, DeleteChannelResponse, DeleteChannelResponses, DeleteCollabSurfaceData, DeleteCollabSurfaceError, DeleteCollabSurfaceErrors, DeleteCollabSurfaceResponse, DeleteCollabSurfaceResponses, DeleteDocumentData, DeleteDocumentError, DeleteDocumentErrors, DeleteDocumentResponse, DeleteDocumentResponses, DeleteEntityMentionData, DeleteEntityMentionError, DeleteEntityMentionErrors, DeleteEntityMentionResponse, DeleteEntityMentionResponse2, DeleteEntityMentionResponses, DeleteHarnessData, DeleteHarnessError, DeleteHarnessErrors, DeleteHarnessResponse, DeleteHarnessResponses, DeleteHistoryHandlerData, DeleteHistoryHandlerError, DeleteHistoryHandlerErrors, DeleteHistoryHandlerResponse, DeleteHistoryHandlerResponses, DeleteInitiativeData, DeleteInitiativeError, DeleteInitiativeErrors, DeleteInitiativeResponse, DeleteInitiativeResponses, DeleteProjectHandlerData, DeleteProjectHandlerError, DeleteProjectHandlerErrors, DeleteProjectHandlerResponse, DeleteProjectHandlerResponses, DeleteSelfHarnessData, DeleteSelfHarnessError, DeleteSelfHarnessErrors, DeleteSelfHarnessResponse, DeleteSelfHarnessResponses, DeleteUnthreadedAnchorRequest, DeleteUnthreadedAnchorResponse, DeleteUnthreadedPdfAnchorRequest, DeleteUserApiKeyData, DeleteUserApiKeyError, DeleteUserApiKeyErrors, DeleteUserApiKeyResponse, DeleteUserApiKeyResponses, DeleteUserDocumentViewLocationData, DeleteUserDocumentViewLocationError, DeleteUserDocumentViewLocationErrors, DeleteUserDocumentViewLocationResponse, DeleteUserDocumentViewLocationResponses, DeleteViewHandlerData, DeleteViewHandlerError, DeleteViewHandlerErrors, DeleteViewHandlerResponses, DeleteWebhookData, DeleteWebhookError, DeleteWebhookErrors, DeleteWebhookResponse, DeleteWebhookResponses, DocumentBasic, DocumentContent, DocumentContentLocation, DocumentContentState, DocumentContentUploadedMetadata, DocumentCopiedMetadata, DocumentCreatedMetadata, DocumentDeletedMetadata, DocumentFilters, DocumentId, DocumentInteractionMetadata, DocumentMetadata, DocumentMetadataWithContent, DocumentPermissionsToken, DocumentPermissionsTokenRequest, DocumentPermissionsTokenResponse, DocumentPreview, DocumentPreviewData, DocumentPreviewDataSubType, DocumentPurgedMetadata, DocumentResponse, DocumentResponseMetadata, DocumentResponseMetadataWithContent, DocumentStorageServiceApiVersion, DocumentSubType, DocumentSyncContentUpdatedMetadata, DocumentSyncEditor, DocumentTeamShareResponse, DocumentTopicEvent, DocumentUpdatedMetadata, EditAnchorData, EditAnchorError, EditAnchorErrors, EditAnchorRequest, EditAnchorResponse, EditAnchorResponse2, EditAnchorResponses, EditCallRecordData, EditCallRecordError, EditCallRecordErrors, EditCallRecordRequest, EditCallRecordResponse, EditCallRecordResponses, EditCallTranscriptData, EditCallTranscriptError, EditCallTranscriptErrors, EditCallTranscriptRequest, EditCallTranscriptResponse, EditCallTranscriptResponses, EditDocumentData, EditDocumentError, EditDocumentErrors, EditDocumentResponse, EditDocumentResponse2, EditDocumentResponses, EditDocumentServiceArgs, EditMyFormResponseData, EditMyFormResponseError, EditMyFormResponseErrors, EditMyFormResponseResponse, EditMyFormResponseResponses, EditPdfAnchorRequest, EditPdfPlaceableCommentAnchorRequest, EditProjectV2Data, EditProjectV2Error, EditProjectV2Errors, EditProjectV2Response, EditProjectV2Responses, EditThreadV2Data, EditThreadV2Error, EditThreadV2Errors, EditThreadV2Response, EditThreadV2Responses, EmailFilters, EmailFollowup, EmailFollowupCommand, EmailFollowupResponse, EmailReminderCondition, EmailReminderPage, EmailReminderSummary, EmptyResponse, EnsureCollabSurfaceData, EnsureCollabSurfaceError, EnsureCollabSurfaceErrors, EnsureCollabSurfaceRequest, EnsureCollabSurfaceResponse, EnsureCollabSurfaceResponses, EnsureStarterHandlerData, EnsureStarterHandlerErrors, EnsureStarterHandlerResponse, EnsureStarterHandlerResponses, EntityFilters, EntityKind, EntityMessageCreateData, EntityMessageCreateResponse, EntityMessageCreateResponses, EntityMessageDeleteMessageData, EntityMessageDeleteMessageResponse, EntityMessageDeleteMessageResponses, EntityMessageDeleteThreadData, EntityMessageDeleteThreadResponse, EntityMessageDeleteThreadResponses, EntityMessageEditData, EntityMessageEditResponse, EntityMessageEditResponses, EntityMessageGetMessageData, EntityMessageGetMessageResponse, EntityMessageGetMessageResponses, EntityMessageGetThreadData, EntityMessageGetThreadResponse, EntityMessageGetThreadResponses, EntityMessageLegacyData, EntityMessageLegacyResponse, EntityMessageLegacyResponses, EntityMessagePatchThreadData, EntityMessagePatchThreadResponse, EntityMessagePatchThreadResponses, EntityMessageReactData, EntityMessageReactResponse, EntityMessageReactResponses, EntityMessageTypingData, EntityMessageTypingResponse, EntityMessageTypingResponses, EntityPermission, EntityPermissionResponse, EntityRef, EntityReference, EntityType, ErrorResponse, EventReminderOverride, EventReminders, EventStatus, EventTime, EventTransparency, EventType, EventVisibility, ExcludedDefaultView, ExcludeDefaultViewHandlerData, ExcludeDefaultViewHandlerError, ExcludeDefaultViewHandlerErrors, ExcludeDefaultViewHandlerResponses, ExcludeDefaultViewRequest, ExportDocumentData, ExportDocumentError, ExportDocumentErrors, ExportDocumentResponse, ExportDocumentResponse2, ExportDocumentResponses, Favorite, FavoriteEntityRef, FavoritesList, FileChangeKindDto, FileSystemNodeWithIds, FileType, FileTypeUpdate, FilterCondition, FilterGroup, FilterNode, FilterTest, FinalizeSlackImportData, FinalizeSlackImportErrors, FinalizeSlackImportResponse, FinalizeSlackImportResponses, FolderItem, FollowupState, ForeignEntity, ForeignEntityFilters, Form, FormAccess, FormCollaboration, FormDetail, FormErrorCode, FormErrorResponse, FormLayout, FormPublicationProblem, FormQuestionDetail, FormResponse, FormSection, FormSectionDetail, FormSource, FormStatus, FormTally, Formula, GenericErrorResponse, GenericResponse, GenericSuccessResponse, GetActiveCallsData, GetActiveCallsError, GetActiveCallsErrors, GetActiveCallsResponse, GetActiveCallsResponses, GetActivityData, GetActivityError, GetActivityErrors, GetActivityResponse, GetActivityResponses, GetAttachmentReferencesData, GetAttachmentReferencesError, GetAttachmentReferencesErrors, GetAttachmentReferencesResponse, GetAttachmentReferencesResponse2, GetAttachmentReferencesResponses, GetBatchCallRecordPreviewData, GetBatchCallRecordPreviewError, GetBatchCallRecordPreviewErrors, GetBatchCallRecordPreviewRequest, GetBatchCallRecordPreviewResponse, GetBatchCallRecordPreviewResponse2, GetBatchCallRecordPreviewResponses, GetBatchChannelPreviewData, GetBatchChannelPreviewError, GetBatchChannelPreviewErrors, GetBatchChannelPreviewRequest, GetBatchChannelPreviewResponse, GetBatchChannelPreviewResponse2, GetBatchChannelPreviewResponses, GetBatchPreviewHandlerData, GetBatchPreviewHandlerError, GetBatchPreviewHandlerErrors, GetBatchPreviewHandlerResponse, GetBatchPreviewHandlerResponses, GetBatchPreviewRequest, GetBatchPreviewResponse, GetBatchProjectPreviewData, GetBatchProjectPreviewError, GetBatchProjectPreviewErrors, GetBatchProjectPreviewRequest, GetBatchProjectPreviewResponse, GetBatchProjectPreviewResponse2, GetBatchProjectPreviewResponses, GetBotOwnerProfilesData, GetBotOwnerProfilesError, GetBotOwnerProfilesErrors, GetBotOwnerProfilesResponse, GetBotOwnerProfilesResponses, GetCallRecordData, GetCallRecordError, GetCallRecordErrors, GetCallRecordResponse, GetCallRecordResponses, GetChannelAttachmentsData, GetChannelAttachmentsError, GetChannelAttachmentsErrors, GetChannelAttachmentsResponse, GetChannelAttachmentsResponses, GetChannelData, GetChannelError, GetChannelErrors, GetChannelJoinLinkData, GetChannelJoinLinkError, GetChannelJoinLinkErrors, GetChannelJoinLinkResponse, GetChannelJoinLinkResponses, GetChannelParticipantsData, GetChannelParticipantsError, GetChannelParticipantsErrors, GetChannelParticipantsResponse, GetChannelParticipantsResponses, GetChannelResponse, GetChannelResponses, GetChannelsData, GetChannelsError, GetChannelsErrors, GetChannelsResponse, GetChannelsResponses, GetCollabSurfaceData, GetCollabSurfaceError, GetCollabSurfaceErrors, GetCollabSurfaceResponse, GetCollabSurfaceResponses, GetCompanyData, GetCompanyError, GetCompanyErrors, GetCompanyResponse, GetCompanyResponses, GetContactByEmailData, GetContactByEmailError, GetContactByEmailErrors, GetContactByEmailResponse, GetContactByEmailResponse2, GetContactByEmailResponses, GetContactData, GetContactError, GetContactErrors, GetContactResponse, GetContactResponses, GetCrmPipelineData, GetCrmPipelineResponse, GetCrmPipelineResponses, GetCrmPipelineRowsData, GetCrmPipelineRowsResponse, GetCrmPipelineRowsResponses, GetCrmPipelineTableData, GetCrmPipelineTableResponse, GetCrmPipelineTableResponses, GetCrmTeamSettingsData, GetCrmTeamSettingsError, GetCrmTeamSettingsErrors, GetCrmTeamSettingsResponse, GetCrmTeamSettingsResponses, GetDatabaseData, GetDatabaseError, GetDatabaseErrors, GetDatabasePermissionsData, GetDatabasePermissionsError, GetDatabasePermissionsErrors, GetDatabasePermissionsResponse, GetDatabasePermissionsResponses, GetDatabaseQueryData, GetDatabaseQueryError, GetDatabaseQueryErrors, GetDatabaseQueryResponse, GetDatabaseQueryResponses, GetDatabaseResponse, GetDatabaseResponses, GetDatabaseRowHistoryData, GetDatabaseRowHistoryError, GetDatabaseRowHistoryErrors, GetDatabaseRowHistoryResponse, GetDatabaseRowHistoryResponses, GetDatabaseTableChangesData, GetDatabaseTableChangesError, GetDatabaseTableChangesErrors, GetDatabaseTableChangesResponse, GetDatabaseTableChangesResponses, GetDatabaseViewPositionsData, GetDatabaseViewPositionsError, GetDatabaseViewPositionsErrors, GetDatabaseViewPositionsResponse, GetDatabaseViewPositionsResponses, GetDocumentAnchorsData, GetDocumentAnchorsError, GetDocumentAnchorsErrors, GetDocumentAnchorsResponse, GetDocumentAnchorsResponses, GetDocumentBranchNameData, GetDocumentBranchNameError, GetDocumentBranchNameErrors, GetDocumentBranchNameResponse, GetDocumentBranchNameResponses, GetDocumentByTeamSlugData, GetDocumentByTeamSlugError, GetDocumentByTeamSlugErrors, GetDocumentByTeamSlugResponse, GetDocumentByTeamSlugResponses, GetDocumentData, GetDocumentError, GetDocumentErrors, GetDocumentGithubPullRequestsData, GetDocumentGithubPullRequestsError, GetDocumentGithubPullRequestsErrors, GetDocumentGithubPullRequestsResponse, GetDocumentGithubPullRequestsResponses, GetDocumentKeyResponse, GetDocumentKeyResponseData, GetDocumentListHandlerData, GetDocumentListHandlerError, GetDocumentListHandlerErrors, GetDocumentListHandlerResponse, GetDocumentListHandlerResponses, GetDocumentListResult, GetDocumentLocationV3Data, GetDocumentLocationV3Error, GetDocumentLocationV3Errors, GetDocumentLocationV3Response, GetDocumentLocationV3Responses, GetDocumentPermissionsResponseDataV2, GetDocumentPermissionsTokenData, GetDocumentPermissionsTokenError, GetDocumentPermissionsTokenErrors, GetDocumentPermissionsTokenResponse, GetDocumentPermissionsTokenResponses, GetDocumentPermissionsV2Data, GetDocumentPermissionsV2Error, GetDocumentPermissionsV2Errors, GetDocumentPermissionsV2Response, GetDocumentPermissionsV2Responses, GetDocumentProcessingResult, GetDocumentProcessingResultData, GetDocumentProcessingResultError, GetDocumentProcessingResultErrors, GetDocumentProcessingResultResponse, GetDocumentProcessingResultResponse2, GetDocumentProcessingResultResponses, GetDocumentResponse, GetDocumentResponse2, GetDocumentResponseData, GetDocumentResponses, GetDocumentSearchResponse, GetDocumentShortIdData, GetDocumentShortIdError, GetDocumentShortIdErrors, GetDocumentShortIdResponse, GetDocumentShortIdResponses, GetDocumentsResponse, GetDocumentTeamShareData, GetDocumentTeamShareError, GetDocumentTeamShareErrors, GetDocumentTeamShareResponse, GetDocumentTeamShareResponses, GetDocumentUserAccessLevelResponse, GetDocumentVersionData, GetDocumentVersionError, GetDocumentVersionErrors, GetDocumentVersionResponse, GetDocumentVersionResponses, GetDocumentViewsHandlerData, GetDocumentViewsHandlerError, GetDocumentViewsHandlerErrors, GetDocumentViewsHandlerResponse, GetDocumentViewsHandlerResponses, GetEmailFollowupData, GetEmailFollowupError, GetEmailFollowupErrors, GetEmailFollowupResponse, GetEmailFollowupResponses, GetEntityPermissionData, GetEntityPermissionErrors, GetEntityPermissionResponse, GetEntityPermissionResponses, GetForeignEntityBySourceData, GetForeignEntityBySourceError, GetForeignEntityBySourceErrors, GetForeignEntityBySourceResponse, GetForeignEntityBySourceResponses, GetForeignEntityData, GetForeignEntityError, GetForeignEntityErrors, GetForeignEntityResponse, GetForeignEntityResponses, GetFormData, GetFormError, GetFormErrors, GetFormPermissionsData, GetFormPermissionsError, GetFormPermissionsErrors, GetFormPermissionsResponse, GetFormPermissionsResponses, GetFormResponse, GetFormResponses, GetFormResponseSummaryData, GetFormResponseSummaryError, GetFormResponseSummaryErrors, GetFormResponseSummaryResponse, GetFormResponseSummaryResponses, GetFormTallyData, GetFormTallyError, GetFormTallyErrors, GetFormTallyResponse, GetFormTallyResponses, GetGithubPullRequestChangesData, GetGithubPullRequestChangesError, GetGithubPullRequestChangesErrors, GetGithubPullRequestChangesPatchData, GetGithubPullRequestChangesPatchError, GetGithubPullRequestChangesPatchErrors, GetGithubPullRequestChangesPatchResponse, GetGithubPullRequestChangesPatchResponses, GetGithubPullRequestChangesResponse, GetGithubPullRequestChangesResponses, GetGithubPullRequestData, GetGithubPullRequestError, GetGithubPullRequestErrors, GetGithubPullRequestFacetsData, GetGithubPullRequestFacetsError, GetGithubPullRequestFacetsErrors, GetGithubPullRequestFacetsResponse, GetGithubPullRequestFacetsResponses, GetGithubPullRequestResponse, GetGithubPullRequestResponses, GetGithubPullRequestTasksData, GetGithubPullRequestTasksError, GetGithubPullRequestTasksErrors, GetGithubPullRequestTasksResponse, GetGithubPullRequestTasksResponses, GetHarnessPairingData, GetHarnessPairingError, GetHarnessPairingErrors, GetHarnessPairingResponse, GetHarnessPairingResponses, GetHistoryHandlerData, GetHistoryHandlerError, GetHistoryHandlerErrors, GetHistoryHandlerResponse, GetHistoryHandlerResponses, GetInitiativeData, GetInitiativeError, GetInitiativeErrors, GetInitiativeResponse, GetInitiativeResponses, GetInstructionsDocumentResponse, GetInstructionsHandlerData, GetInstructionsHandlerError, GetInstructionsHandlerErrors, GetInstructionsHandlerResponse, GetInstructionsHandlerResponses, GetItemsSoupData, GetItemsSoupError, GetItemsSoupErrors, GetItemsSoupResponse, GetItemsSoupResponses, GetLocationHandlerData, GetLocationHandlerError, GetLocationHandlerErrors, GetLocationHandlerResponse, GetLocationHandlerResponses, GetMyFormResponseData, GetMyFormResponseError, GetMyFormResponseErrors, GetMyFormResponseResponse, GetMyFormResponseResponses, GetOrCreateAction, GetOrCreateCallData, GetOrCreateCallError, GetOrCreateCallErrors, GetOrCreateCallResponse, GetOrCreateCallResponses, GetOrCreateChannelResponse, GetOrCreateDmData, GetOrCreateDmError, GetOrCreateDmErrors, GetOrCreateDmRequest, GetOrCreateDmResponse, GetOrCreateDmResponses, GetOrCreatePrivateData, GetOrCreatePrivateError, GetOrCreatePrivateErrors, GetOrCreatePrivateRequest, GetOrCreatePrivateResponse, GetOrCreatePrivateResponses, GetPendingProjectsHandlerData, GetPendingProjectsHandlerError, GetPendingProjectsHandlerErrors, GetPendingProjectsHandlerResponse, GetPendingProjectsHandlerResponses, GetPinsHandlerData, GetPinsHandlerError, GetPinsHandlerErrors, GetPinsHandlerResponse, GetPinsHandlerResponses, GetPinsResponse, GetProjectContentHandlerData, GetProjectContentHandlerError, GetProjectContentHandlerErrors, GetProjectContentHandlerResponse, GetProjectContentHandlerResponses, GetProjectContentResponse, GetProjectHandlerData, GetProjectHandlerError, GetProjectHandlerErrors, GetProjectHandlerResponse, GetProjectHandlerResponses, GetProjectPermissionsV2Data, GetProjectPermissionsV2Error, GetProjectPermissionsV2Errors, GetProjectPermissionsV2Response, GetProjectPermissionsV2Responses, GetProjectResponse, GetProjectResponseData, GetProjectsHandlerData, GetProjectsHandlerError, GetProjectsHandlerErrors, GetProjectsHandlerResponse, GetProjectsHandlerResponses, GetProjectsResponse, GetProjectUserAccessLevelData, GetProjectUserAccessLevelError, GetProjectUserAccessLevelErrors, GetProjectUserAccessLevelResponse, GetProjectUserAccessLevelResponses, GetRingStatusData, GetRingStatusError, GetRingStatusErrors, GetRingStatusResponse, GetRingStatusResponses, GetSelfBotData, GetSelfBotError, GetSelfBotErrors, GetSelfBotResponse, GetSelfBotResponses, GetSelfHarnessData, GetSelfHarnessError, GetSelfHarnessErrors, GetSelfHarnessResponse, GetSelfHarnessResponses, GetSlackImportData, GetSlackImportErrors, GetSlackImportResponse, GetSlackImportResponses, GetSystemSkillsHandlerData, GetSystemSkillsHandlerError, GetSystemSkillsHandlerErrors, GetSystemSkillsHandlerResponse, GetSystemSkillsHandlerResponses, GetUserDocumentsHandlerData, GetUserDocumentsHandlerError, GetUserDocumentsHandlerErrors, GetUserDocumentsHandlerResponse, GetUserDocumentsHandlerResponses, GetUserDocumentViewLocationData, GetUserDocumentViewLocationError, GetUserDocumentViewLocationErrors, GetUserDocumentViewLocationResponse, GetUserDocumentViewLocationResponses, GetUserHistoryResponse, GetViewsHandlerData, GetViewsHandlerError, GetViewsHandlerErrors, GetViewsHandlerResponse, GetViewsHandlerResponses, GetWebhookData, GetWebhookError, GetWebhookErrors, GetWebhookResponse, GetWebhookResponses, GithubLabelFacet, GithubPullRequest, GithubPullRequestChangesPatchResponse, GithubPullRequestChangesResponse, GithubPullRequestCheckRun, GithubPullRequestComment, GithubPullRequestFacets, GithubPullRequestLabel, GithubPullRequestReview, GithubPullRequestReviewDecision, GithubPullRequestReviewState, GithubPullRequestsResponse, GithubPullRequestTasks, GithubPullRequestTasksRequest, GithubPullRequestTasksResponse, GithubPullRequestUser, GithubRepositoryFacet, GithubUserFacet, GitRefDto, GroupedInitialParams, GroupedPageParams, GroupedSoupGroupPage, GroupedSoupInitialPage, GroupedSoupPage, GroupedSoupSort, GuestId, GuestJoinRequest, HandlerData, HandlerError, HandlerErrors, HandlerResponse, HandlerResponses, Harness, HarnessAgent, HarnessId, HarnessOwner, HarnessSession, HashMap, HealthHandlerData, HealthHandlerResponse, HealthHandlerResponses, HighlightType, ImportCounters, ImportDatabaseTableData, ImportDatabaseTableError, ImportDatabaseTableErrors, ImportDatabaseTableResponse, ImportDatabaseTableResponses, ImportedAuthor, ImportError, ImportLimits, ImportPage, ImportProgress, ImportTable, ImportWarning, InferColumnTypeOutcome, InferColumnTypeRequest, InferDatabaseColumnTypeData, InferDatabaseColumnTypeError, InferDatabaseColumnTypeErrors, InferDatabaseColumnTypeResponse, InferDatabaseColumnTypeResponses, InFlightTurnSummary, IngestTranscriptData, IngestTranscriptError, IngestTranscriptErrors, IngestTranscriptResponses, InitializeUserDocumentsData, InitializeUserDocumentsError, InitializeUserDocumentsErrors, InitializeUserDocumentsResponse, InitializeUserDocumentsResponses, InitialPropertyValue, InitiativeDetail, InitiativeFilters, InitiativeId, InitiativeList, InitiativeSummary, InputReceivedMetadata, InstallSyncData, InstallSyncErrors, InteractionReason, InviteMeetingRequest, InviteMeetingUsersRequest, Item, ItemWithUserAccessLevel, JobId, JobProcessingResultHandlerData, JobProcessingResultHandlerError, JobProcessingResultHandlerErrors, JobProcessingResultHandlerResponse, JobProcessingResultHandlerResponses, JobStatus, JoinChannelByCodeData, JoinChannelByCodeError, JoinChannelByCodeErrors, JoinChannelByCodeResponses, JoinChannelData, JoinChannelError, JoinChannelErrors, JoinChannelResponses, KeySegment, Lane, LaneKey, LatestMessage, LayoutProblem, LeaveCallResponse, LeaveChannelData, LeaveChannelError, LeaveChannelErrors, LeaveChannelResponses, LeaveOrEndCallData, LeaveOrEndCallError, LeaveOrEndCallErrors, LeaveOrEndCallResponse, LeaveOrEndCallResponses, LinkShare, ListAccessibleFormsData, ListAccessibleFormsError, ListAccessibleFormsErrors, ListAccessibleFormsResponse, ListAccessibleFormsResponses, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListBotChannelsData, ListBotChannelsError, ListBotChannelsErrors, ListBotChannelsResponse, ListBotChannelsResponses, ListChannelLabelsData, ListChannelLabelsError, ListChannelLabelsErrors, ListChannelLabelsResponse, ListChannelLabelsResponses, ListCompanyContactsData, ListCompanyContactsError, ListCompanyContactsErrors, ListCompanyContactsResponse, ListCompanyContactsResponses, ListCrmPipelinesData, ListCrmPipelinesResponse, ListCrmPipelinesResponses, ListDatabaseColumnCastsData, ListDatabaseColumnCastsError, ListDatabaseColumnCastsErrors, ListDatabaseColumnCastsResponse, ListDatabaseColumnCastsResponses, ListDatabasesData, ListDatabasesError, ListDatabasesErrors, ListDatabasesResponse, ListDatabasesResponses, ListedDatabase, ListedForm, ListEmailRemindersData, ListEmailRemindersError, ListEmailRemindersErrors, ListEmailRemindersResponse, ListEmailRemindersResponses, ListFavoritesData, ListFavoritesError, ListFavoritesErrors, ListFavoritesResponse, ListFavoritesResponses, ListFormsData, ListFormsError, ListFormsErrors, ListFormsResponse, ListFormsResponses, ListHarnessAgentsData, ListHarnessAgentsError, ListHarnessAgentsErrors, ListHarnessAgentsResponse, ListHarnessAgentsResponses, ListHarnessesData, ListHarnessesError, ListHarnessesErrors, ListHarnessesResponse, ListHarnessesResponses, ListHarnessSessionsData, ListHarnessSessionsError, ListHarnessSessionsErrors, ListHarnessSessionsResponse, ListHarnessSessionsResponses, ListInitiativesData, ListInitiativesError, ListInitiativesErrors, ListInitiativesResponse, ListInitiativesResponses, ListOccurrencesData, ListOccurrencesErrors, ListOccurrencesResponse, ListOccurrencesResponses, ListSlackImportsData, ListSlackImportsResponse, ListSlackImportsResponses, ListTeamCalendarData, ListTeamCalendarResponse, ListTeamCalendarResponses, ListTeamOutOfOfficeData, ListTeamOutOfOfficeErrors, ListTeamOutOfOfficeResponse, ListTeamOutOfOfficeResponses, ListUserApiKeysData, ListUserApiKeysError, ListUserApiKeysErrors, ListUserApiKeysResponse, ListUserApiKeysResponses, ListWebhooksData, ListWebhooksError, ListWebhooksErrors, ListWebhooksResponse, ListWebhooksResponse2, ListWebhooksResponses, LocationResponseData, LocationResponseV3, MacroUserIdStr, Meeting, MeetingCancelData, MeetingCancelError, MeetingCancelErrors, MeetingCancelPreparationData, MeetingCancelPreparationError, MeetingCancelPreparationErrors, MeetingCancelPreparationResponse, MeetingCancelPreparationResponses, MeetingCancelResponse, MeetingCancelResponses, MeetingCreateData, MeetingCreateError, MeetingCreateErrors, MeetingCreateResponse, MeetingCreateResponses, MeetingGuestJoinData, MeetingGuestJoinError, MeetingGuestJoinErrors, MeetingGuestJoinResponse, MeetingGuestJoinResponses, MeetingGuestParticipantsData, MeetingGuestParticipantsError, MeetingGuestParticipantsErrors, MeetingGuestParticipantsResponse, MeetingGuestParticipantsResponses, MeetingInviteData, MeetingInviteError, MeetingInviteErrors, MeetingInvitePermissions, MeetingInvitePermissionsData, MeetingInvitePermissionsError, MeetingInvitePermissionsErrors, MeetingInvitePermissionsResponse, MeetingInvitePermissionsResponses, MeetingInviteResponse, MeetingInviteResponses, MeetingInviteUsersData, MeetingInviteUsersError, MeetingInviteUsersErrors, MeetingInviteUsersResponse, MeetingInviteUsersResponses, MeetingJoinData, MeetingJoinError, MeetingJoinErrors, MeetingJoinResponse, MeetingJoinResponses, MeetingLeaveData, MeetingLeaveError, MeetingLeaveErrors, MeetingLeaveResponse, MeetingLeaveResponses, MeetingListActiveData, MeetingListActiveError, MeetingListActiveErrors, MeetingListActiveResponse, MeetingListActiveResponses, MeetingListData, MeetingListError, MeetingListErrors, MeetingListResponse, MeetingListResponses, MeetingLookupData, MeetingLookupError, MeetingLookupErrors, MeetingLookupResponse, MeetingLookupResponses, MeetingParticipant, MeetingParticipants, MeetingParticipantsData, MeetingParticipantsError, MeetingParticipantsErrors, MeetingParticipantsResponse, MeetingParticipantsResponses, MeetingPreparation, MeetingPrepareData, MeetingPrepareError, MeetingPrepareErrors, MeetingPrepareResponse, MeetingPrepareResponses, MeetingShareData, MeetingShareError, MeetingShareErrors, MeetingShareResponse, MeetingShareResponses, MeetingsResponse, MeetingToken, MeetingUpdateData, MeetingUpdateError, MeetingUpdateErrors, MeetingUpdateResponse, MeetingUpdateResponses, MentionPreviewsData, MentionPreviewsErrors, MentionPreviewsResponse, MentionPreviewsResponses, Message, MessageAttachment, MessageAttachmentCreatedMetadata, MessageAttachmentRemovedMetadata, MessageChange, MessageCursor, MessageDeletedMetadata, MessageDirection, MessageEvent, MessageEventAttachment, MessageListItem, MessageMentionedMetadata, MessagePage, MessageParent, MessagePatch, MessagePatchedMetadata, MessagePostedMetadata, MessageThread, MessageThreadPreview, MessageTimelineData, MessageTimelineEntriesData, MessageTimelineEntriesResponse, MessageTimelineEntriesResponses, MessageTimelineEntry, MessageTimelinePage, MessageTimelineQuery, MessageTimelineResponse, MessageTimelineResponses, MessageTopicEvent, MyResponse, NewAttachment, NewColumn, NewOption, NewThreadAnchor, NewView, NotificationFilters, NotificationState, NumberOperator, OpBatch, Operator, OpRefusalResponse, OpResult, OptionRef, PairingDetails, Params, ParticipantRole, PatchBotRequest, PatchChannelData, PatchChannelError, PatchChannelErrors, PatchChannelRequest, PatchChannelResponse, PatchChannelResponses, PatchMessageNotificationPolicy, PatchProjectRequestV2, PatchThreadRequestV2, PatchViewHandlerData, PatchViewHandlerError, PatchViewHandlerErrors, PatchViewHandlerResponses, PatchWebhookData, PatchWebhookError, PatchWebhookErrors, PatchWebhookRequest, PatchWebhookResponse, PatchWebhookResponses, PdfAnchor, PdfAnchorId, PdfHighlightAnchor, PdfHighlightAnchorRequest, PdfHighlightRect, PdfHighlightRectAnchorRequest, PdfPlaceableCommentAnchor, PendingClaimResponse, PermanentlyDeleteDocumentData, PermanentlyDeleteDocumentError, PermanentlyDeleteDocumentErrors, PermanentlyDeleteDocumentResponse, PermanentlyDeleteDocumentResponses, PermanentlyDeleteProjectData, PermanentlyDeleteProjectError, PermanentlyDeleteProjectErrors, PermanentlyDeleteProjectResponse, PermanentlyDeleteProjectResponses, PinnedItem, PinRequest, Pipeline, PipelineRecordType, PipelineSharing, PostActivityData, PostActivityError, PostActivityErrors, PostActivityRequest, PostActivityResponse, PostActivityResponses, PostChannelBotWebhookData, PostChannelBotWebhookError, PostChannelBotWebhookErrors, PostChannelBotWebhookResponse, PostChannelBotWebhookResponses, PostGroupedSoupAstGroupPageRequest, PostGroupedSoupAstInitialRequest, PostGroupedSoupAstRequest, PostItemsSoupAstData, PostItemsSoupAstError, PostItemsSoupAstErrors, PostItemsSoupAstGroupedData, PostItemsSoupAstGroupedError, PostItemsSoupAstGroupedErrors, PostItemsSoupAstGroupedResponse, PostItemsSoupAstGroupedResponses, PostItemsSoupAstResponse, PostItemsSoupAstResponses, PostItemsSoupData, PostItemsSoupError, PostItemsSoupErrors, PostItemsSoupResponse, PostItemsSoupResponses, PostMessage, PostMessageNotificationPolicy, PostSoupAstRequest, PostSoupRequest, PresaveDocumentHandlerData, PresaveDocumentHandlerError, PresaveDocumentHandlerErrors, PresaveDocumentHandlerResponse, PresaveDocumentHandlerResponses, PreSaveDocumentRequest, PreSaveDocumentResponse, PreSaveDocumentResponseData, PresenceOperator, PresignedUrl, PreviewSmartTagData, PreviewSmartTagError, PreviewSmartTagErrors, PreviewSmartTagResponse, PreviewSmartTagResponses, Project, ProjectDeleteResponseData, ProjectDocumentStatus, ProjectFilters, ProjectPreview, ProjectPreviewData, PropertyDefinition, PropertyDefinitionWithOptions, PropertyFilter, PropertyInput, PropertyOption, PropertyOptionValue, PropertyOwner, PropertyValue, PutCrmTeamSettingsData, PutCrmTeamSettingsError, PutCrmTeamSettingsErrors, PutCrmTeamSettingsResponse, PutCrmTeamSettingsResponses, PutCrmTeamStagesData, PutCrmTeamStagesError, PutCrmTeamStagesErrors, PutCrmTeamStagesResponse, PutCrmTeamStagesResponses, PutFormLayoutData, PutFormLayoutError, PutFormLayoutErrors, PutFormLayoutResponse, PutFormLayoutResponses, QueryCrmPipelineRowsData, QueryCrmPipelineRowsResponse, QueryCrmPipelineRowsResponses, QueryDefinition, QuestionLayout, QuestionOption, QuestionTally, ReactionInput, RecentlyDeletedData, RecentlyDeletedError, RecentlyDeletedErrors, RecentlyDeletedResponse, RecentlyDeletedResponseData, RecentlyDeletedResponses, RegisterSlackImportUploadsData, RegisterSlackImportUploadsErrors, RegisterSlackImportUploadsResponse, RegisterSlackImportUploadsResponses, RegisterUploads, RemoveBotFromChannelByBotData, RemoveBotFromChannelByBotError, RemoveBotFromChannelByBotErrors, RemoveBotFromChannelByBotResponse, RemoveBotFromChannelByBotResponses, RemoveFavoriteByEntityData, RemoveFavoriteByEntityError, RemoveFavoriteByEntityErrors, RemoveFavoriteByEntityResponses, RemoveParticipantsData, RemoveParticipantsError, RemoveParticipantsErrors, RemoveParticipantsRequest, RemoveParticipantsResponses, RemovePinHandlerData, RemovePinHandlerError, RemovePinHandlerErrors, RemovePinHandlerResponse, RemovePinHandlerResponses, RenameChannelLabelData, RenameChannelLabelError, RenameChannelLabelErrors, RenameChannelLabelRequest, RenameChannelLabelResponse, RenameChannelLabelResponses, RenameCrmPipelineData, RenameCrmPipelineResponse, RenameCrmPipelineResponses, RenamePipeline, ReorderFavoritesData, ReorderFavoritesError, ReorderFavoritesErrors, ReorderFavoritesRequest, ReorderFavoritesResponses, ReorderPinRequest, ReorderPinsHandlerData, ReorderPinsHandlerError, ReorderPinsHandlerErrors, ReorderPinsHandlerResponse, ReorderPinsHandlerResponses, ReplaceCrmStagesRequest, RequestedHarnessScope, RequestedLayout, ResetCrmTeamStagesData, ResetCrmTeamStagesError, ResetCrmTeamStagesErrors, ResetCrmTeamStagesResponse, ResetCrmTeamStagesResponses, ResponseStatus, ResponseSummary, RevertDeleteDocumentData, RevertDeleteDocumentError, RevertDeleteDocumentErrors, RevertDeleteDocumentResponse, RevertDeleteDocumentResponses, RevertDeleteProjectData, RevertDeleteProjectError, RevertDeleteProjectErrors, RevertDeleteProjectResponse, RevertDeleteProjectResponses, RingStatus, RingStatusResponse, RowChange, RowChangeKind, RowChanges, RowHistoryEntry, RowHistoryResponse, RowId, RowsChange, RowsResult, S3ObjectInfo, SaveBomPart, SaveDatabaseQueryData, SaveDatabaseQueryError, SaveDatabaseQueryErrors, SaveDatabaseQueryResponse, SaveDatabaseQueryResponses, SaveDocumentHandlerData, SaveDocumentHandlerError, SaveDocumentHandlerErrors, SaveDocumentHandlerResponse, SaveDocumentHandlerResponses, SaveDocumentRequest, SaveDocumentResponse, SaveDocumentResponseData, SavedQuery, SaveQueryRequest, SearchContactsData, SearchContactsError, SearchContactsErrors, SearchContactsResponse, SearchContactsResponse2, SearchContactsResponses, SearchState, SectionCount, SessionDeletedMetadata, SessionIdentity, SessionMentionedMetadata, SessionOpenedMetadata, SessionRenamedMetadata, SessionSettledMetadata, SessionStoppedMetadata, SetChannelLabelData, SetChannelLabelError, SetChannelLabelErrors, SetChannelLabelRequest, SetChannelLabelResponse, SetChannelLabelResponses, SetChannelPictureData, SetChannelPictureError, SetChannelPictureErrors, SetChannelPictureRequest, SetChannelPictureResponse, SetChannelPictureResponses, SetCompanyHiddenData, SetCompanyHiddenError, SetCompanyHiddenErrors, SetCompanyHiddenRequest, SetCompanyHiddenResponse, SetCompanyHiddenResponses, SetCompanyNameRequest, SetContactHiddenData, SetContactHiddenError, SetContactHiddenErrors, SetContactHiddenRequest, SetContactHiddenResponse, SetContactHiddenResponses, SetContactNameRequest, SetCrmCompanyNameData, SetCrmCompanyNameError, SetCrmCompanyNameErrors, SetCrmCompanyNameResponse, SetCrmCompanyNameResponses, SetCrmContactNameData, SetCrmContactNameError, SetCrmContactNameErrors, SetCrmContactNameResponse, SetCrmContactNameResponses, SetDocumentTeamShareData, SetDocumentTeamShareError, SetDocumentTeamShareErrors, SetDocumentTeamShareRequest, SetDocumentTeamShareResponse, SetDocumentTeamShareResponses, SetEmailFollowupData, SetEmailFollowupError, SetEmailFollowupErrors, SetEmailFollowupResponse, SetEmailFollowupResponses, SetEmailSyncData, SetEmailSyncError, SetEmailSyncErrors, SetEmailSyncRequest, SetEmailSyncResponse, SetEmailSyncResponses, SetOperator, SetPropertyValue, Sha256Digest, ShareCrmPipelineData, ShareCrmPipelineResponse, ShareCrmPipelineResponses, ShareDatabaseAwarenessData, ShareDatabaseAwarenessError, ShareDatabaseAwarenessErrors, ShareDatabaseAwarenessResponse, ShareDatabaseAwarenessResponses, SharedEmailFilter, SharePermissionV2, SharePipeline, ShortIdResponse, SimpleMention, SimpleSaveData, SimpleSaveError, SimpleSaveErrors, SimpleSaveResponse, SimpleSaveResponses, SkippedCell, SlackCompleteRequest, SlackCreateRequest, SlackRegisterRequest, SlackTimestamp, SlackUserId, SmartTagChannelMatch, SmartTagPreview, SortDirection, SortKey, SoupAgentSessionSoupPropertiesField, SoupApiItem, SoupApiSort, SoupApiSortDirection, SoupAttachment, SoupCalendarEventSoupPropertiesField, SoupCalendarEventTime, SoupCallRecordGuest, SoupCallRecordParticipant, SoupCallRecordSoupPropertiesField, SoupChannel, SoupChannelThread, SoupChatSoupPropertiesField, SoupContact, SoupCountedReaction, SoupCrmCompanySoupPropertiesField, SoupCrmContactSoupPropertiesField, SoupCrmDomain, SoupDatabaseRowSoupPropertiesField, SoupDocumentSoupPropertiesField, SoupDocumentSubType, SoupEmailThreadPreview, SoupEnrichedEmailThreadPreviewSoupPropertiesField, SoupForeignEntity, SoupInitiativeSoupPropertiesField, SoupItem, SoupLabel, SoupLabelListVisibility, SoupLabelType, SoupMessageAttachment, SoupMessageListVisibility, SoupMessageSender, SoupMessageSenderType, SoupPage, SoupProjectSoupPropertiesField, SoupPropertiesField, SoupProperty, SoupThreadInfo, SoupThreadReply, SourceBinding, SourceId, SourceIdentity, StarterDatabase, StarterDocumentsResponse, StorageRow, StorageRows, StorageRowsQuery, StoredGithubPullRequest, StreamEventsData, StreamEventsError, StreamEventsErrors, StreamEventsResponse, StreamEventsResponses, String, Submission, SubmissionOutcome, SubmitFormResponseData, SubmitFormResponseError, SubmitFormResponseErrors, SubmitFormResponseResponse, SubmitFormResponseResponses, SuccessResponse, SurfaceState, SyncServiceVersionId, SystemSkillSummary, Table, TableChange, TableChanged, TableChanges, TableDetail, TableResult, TableVersion, TagFilterMode, TakenId, TallyBucket, TallyValue, TaskFilters, TeamCalendarContent, TeamCalendarCoverage, TeamCalendarDetails, TeamCalendarItem, TeamCalendarMember, TeamCalendarPage, TeamCalendarSharing, TeamOutOfOfficeItem, TeamOutOfOfficeResponse, TeamRole, TextOperator, ThreadAnchor, ThreadOrigin, ThreadPatch, ThreadState, TimelineActivity, ToggleShareWithTeamData, ToggleShareWithTeamError, ToggleShareWithTeamErrors, ToggleShareWithTeamResponse, ToggleShareWithTeamResponses, TouchedColumn, TouchedRow, TranscribeDictationData, TranscribeDictationError, TranscribeDictationErrors, TranscribeDictationResponse, TranscribeDictationResponses, TranscribeResponse, TranscriptSegmentRequest, TrashCrmPipelineData, TrashCrmPipelineResponse, TrashCrmPipelineResponses, TrashPipeline, TurnEndedMetadata, TurnStartedMetadata, TurnSummary, TypedSuccessResponse, TypedSuccessResponseGetDocumentResponseData, TypingInput, UndoChangeResponse, UndoDatabaseChangeData, UndoDatabaseChangeError, UndoDatabaseChangeErrors, UndoDatabaseChangeResponse, UndoDatabaseChangeResponses, UndoOutcome, UndoRefusal, UnlockedBooking, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentRequest, UpdateAgentResponse, UpdateAgentResponses, UpdateChannelSharePermission, UpdateCrmTeamSettingsRequest, UpdateDatabasePermissionsData, UpdateDatabasePermissionsError, UpdateDatabasePermissionsErrors, UpdateDatabasePermissionsResponse, UpdateDatabasePermissionsResponses, UpdateForm, UpdateFormData, UpdateFormError, UpdateFormErrors, UpdateFormPermissionsData, UpdateFormPermissionsError, UpdateFormPermissionsErrors, UpdateFormPermissionsResponse, UpdateFormPermissionsResponses, UpdateFormResponse, UpdateFormResponses, UpdateInitiativeData, UpdateInitiativeError, UpdateInitiativeErrors, UpdateInitiativeRequest, UpdateInitiativeResponse, UpdateInitiativeResponses, UpdateMeetingRequest, UpdateOperation, UpdateSharePermissionRequestV2, UploadDescriptor, UploadDocumentStatus, UploadExtractFolderHandlerData, UploadExtractFolderHandlerError, UploadExtractFolderHandlerErrors, UploadExtractFolderHandlerResponse, UploadExtractFolderHandlerResponses, UploadExtractFolderRequest, UploadFolderHandlerData, UploadFolderHandlerError, UploadFolderHandlerErrors, UploadFolderHandlerResponse, UploadFolderHandlerResponses, UploadFolderRequest, UploadGrant, UploadId, UpsertHistoryHandlerData, UpsertHistoryHandlerError, UpsertHistoryHandlerErrors, UpsertHistoryHandlerResponse, UpsertHistoryHandlerResponses, UpsertUserDocumentViewLocationData, UpsertUserDocumentViewLocationError, UpsertUserDocumentViewLocationErrors, UpsertUserDocumentViewLocationRequest, UpsertUserDocumentViewLocationResponse, UpsertUserDocumentViewLocationResponses, UserApiKeyId, UserApiKeyInfo, UserApiKeysList, UserDocumentsResponse, UserDocumentViewLocation, UserDocumentViewLocationResponse, UserPinsResponse, UserViewsResponse, ValidateDocumentPermissionsTokenData, ValidateDocumentPermissionsTokenError, ValidateDocumentPermissionsTokenErrors, ValidateDocumentPermissionsTokenResponse, ValidateDocumentPermissionsTokenResponses, ValidateWebhookData, ValidateWebhookError, ValidateWebhookErrors, ValidateWebhookResponse, ValidateWebhookResponse2, ValidateWebhookResponses, Vec, VersionedTable, View, ViewChange, ViewColumn, ViewLayout, ViewPatch, ViewPosition, ViewPositionsResponse, ViewQuery, ViewResult, ViewsResponse, WaitingForInputMetadata, Webhook, WebhookEvent, WebhookFilter, WebhookScope, WebhookStatus, WebhookValidationTestEvent, Widget, WithCallId, WithChannelId, WithDocumentId, WithProjectId } from './types.gen';
diff --git a/packages/sdk/generated/storage/types.gen.ts b/packages/sdk/generated/storage/types.gen.ts
index ac9409d482..031da37b0f 100644
--- a/packages/sdk/generated/storage/types.gen.ts
+++ b/packages/sdk/generated/storage/types.gen.ts
@@ -3057,6 +3057,12 @@ export type ColumnChange = {
* The option.
*/
option: string;
+} | {
+ /**
+ * The formula, over the table's other columns.
+ */
+ formula: Formula;
+ kind: 'set_formula';
} | {
kind: 'delete_option';
/**
@@ -3068,10 +3074,10 @@ export type ColumnChange = {
/**
* How a change touched a column.
*/
-export type ColumnChangeKind = 'create' | 'rename' | 'change_type' | 'delete' | 'add_options' | 'update_option' | 'delete_option' | 'reorder' | 'infer_type' | 'related';
+export type ColumnChangeKind = 'create' | 'rename' | 'change_type' | 'set_formula' | 'delete' | 'add_options' | 'update_option' | 'delete_option' | 'reorder' | 'infer_type' | 'related';
/**
- * A relation column: its cells reference rows of another table.
+ * Column-kind specific configuration stored on the placement.
*/
export type ColumnConfig = {
/**
@@ -3083,6 +3089,12 @@ export type ColumnConfig = {
* Target table.
*/
table_id: string;
+} | {
+ /**
+ * How its cells are computed.
+ */
+ formula: Formula;
+ kind: 'derived';
};
/**
@@ -3225,6 +3237,8 @@ export type ColumnResult = {
kind: 'option_updated';
} | {
kind: 'option_deleted';
+} | {
+ kind: 'formula_set';
};
/**
@@ -6793,6 +6807,43 @@ export type FormTally = {
questions: Array<QuestionTally>;
};
+/**
+ * An expression over one row's cells.
+ */
+export type Formula = {
+ /**
+ * The column placement.
+ */
+ column: string;
+ kind: 'column';
+} | {
+ kind: 'number';
+ /**
+ * The value; finite.
+ */
+ value: number;
+} | {
+ kind: 'binary';
+ /**
+ * The left operand.
+ */
+ left: Formula;
+ /**
+ * How.
+ */
+ operator: Operator;
+ /**
+ * The right operand.
+ */
+ right: Formula;
+} | {
+ kind: 'negate';
+ /**
+ * The expression negated; a number.
+ */
+ operand: Formula;
+};
+
export type GenericErrorResponse = {
/**
* Indicates if an error occurred
@@ -9249,6 +9300,17 @@ export type NewColumn = {
* caller can see.
*/
type: ColumnKind;
+} | {
+ /**
+ * How its cells are computed: arithmetic over the table's number,
+ * date and other derived columns.
+ */
+ formula: Formula;
+ /**
+ * The column's name, unique within the table ignoring case.
+ */
+ name: string;
+ source: 'derived';
} | {
/**
* The property's definition.
@@ -9514,6 +9576,11 @@ export type OpResult = {
tables: Array<VersionedTable>;
};
+/**
+ * An arithmetic operator.
+ */
+export type Operator = 'add' | 'subtract' | 'multiply' | 'divide';
+
/**
* A select option, by its id or by its label.
*/
diff --git a/packages/sdk/specs/storage.json b/packages/sdk/specs/storage.json
index ae00aa50a2..512fe2b3a8 100644
--- a/packages/sdk/specs/storage.json
+++ b/packages/sdk/specs/storage.json
@@ -21849,6 +21849,21 @@
}
}
},
+ {
+ "type": "object",
+ "description": "Give a derived column a new formula. Its cells follow at once: it\nstores none.",
+ "required": ["formula", "kind"],
+ "properties": {
+ "formula": {
+ "$ref": "#/components/schemas/Formula",
+ "description": "The formula, over the table's other columns."
+ },
+ "kind": {
+ "type": "string",
+ "enum": ["set_formula"]
+ }
+ }
+ },
{
"type": "object",
"description": "Remove one option of a select or tag column, and take it out of every\ncell holding it: a single-valued cell is emptied, a multi-valued one\nkeeps its other options. Like [`ColumnChange::UpdateOption`], an\noption of a shared property goes everywhere it is used.",
@@ -21875,6 +21890,7 @@
"create",
"rename",
"change_type",
+ "set_formula",
"delete",
"add_options",
"update_option",
@@ -21906,6 +21922,21 @@
"description": "Target table."
}
}
+ },
+ {
+ "type": "object",
+ "description": "A derived column: its cells are computed from the row's others, and\nits definition, a number or date one, never holds a value.",
+ "required": ["formula", "kind"],
+ "properties": {
+ "formula": {
+ "$ref": "#/components/schemas/Formula",
+ "description": "How its cells are computed."
+ },
+ "kind": {
+ "type": "string",
+ "enum": ["derived"]
+ }
+ }
}
],
"description": "Column-kind specific configuration stored on the placement."
@@ -22217,6 +22248,17 @@
"enum": ["option_deleted"]
}
}
+ },
+ {
+ "type": "object",
+ "description": "Its formula changed.",
+ "required": ["kind"],
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["formula_set"]
+ }
+ }
}
],
"description": "What happened to a column."
@@ -28015,6 +28057,81 @@
}
}
},
+ "Formula": {
+ "oneOf": [
+ {
+ "type": "object",
+ "description": "The row's cell in another column of the table: a number, date or\nderived column.",
+ "required": ["column", "kind"],
+ "properties": {
+ "column": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The column placement."
+ },
+ "kind": {
+ "type": "string",
+ "enum": ["column"]
+ }
+ }
+ },
+ {
+ "type": "object",
+ "description": "A constant. Added to or subtracted from a date, it counts days.",
+ "required": ["value", "kind"],
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["number"]
+ },
+ "value": {
+ "type": "number",
+ "format": "double",
+ "description": "The value; finite."
+ }
+ }
+ },
+ {
+ "type": "object",
+ "description": "Two expressions combined.",
+ "required": ["operator", "left", "right", "kind"],
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["binary"]
+ },
+ "left": {
+ "$ref": "#/components/schemas/Formula",
+ "description": "The left operand."
+ },
+ "operator": {
+ "$ref": "#/components/schemas/Operator",
+ "description": "How."
+ },
+ "right": {
+ "$ref": "#/components/schemas/Formula",
+ "description": "The right operand."
+ }
+ }
+ },
+ {
+ "type": "object",
+ "description": "An expression's negation.",
+ "required": ["operand", "kind"],
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["negate"]
+ },
+ "operand": {
+ "$ref": "#/components/schemas/Formula",
+ "description": "The expression negated; a number."
+ }
+ }
+ }
+ ],
+ "description": "An expression over one row's cells."
+ },
"GenericErrorResponse": {
"type": "object",
"required": ["error", "message"],
@@ -31701,6 +31818,25 @@
}
}
},
+ {
+ "type": "object",
+ "description": "A derived column: its cells are what `formula` computes from the\nrow's other cells, and nothing writes them.",
+ "required": ["name", "formula", "source"],
+ "properties": {
+ "formula": {
+ "$ref": "#/components/schemas/Formula",
+ "description": "How its cells are computed: arithmetic over the table's number,\ndate and other derived columns."
+ },
+ "name": {
+ "type": "string",
+ "description": "The column's name, unique within the table ignoring case."
+ },
+ "source": {
+ "type": "string",
+ "enum": ["derived"]
+ }
+ }
+ },
{
"type": "object",
"description": "An existing property, a person's, a team's or a system one, bound\ninto the table under its own name.",
@@ -32118,6 +32254,11 @@
],
"description": "What one op did, in the order the ops were sent, grouped as the ops are:\na result's `kind` is its op's, naming the same resource, and its\n`change` says what happened to it."
},
+ "Operator": {
+ "type": "string",
+ "description": "An arithmetic operator.",
+ "enum": ["add", "subtract", "multiply", "divide"]
+ },
"OptionRef": {
"oneOf": [
{