@satinhq/kit 0.1.0-beta.3 → 0.1.0-beta.4

package/dist/content/content.d.ts

@@ -1,11 +1,11 @@
 import { type CSSProperties, type HTMLAttributes } from 'react';
-/** iOS text styles at the measured default Dynamic Type size. */
+/** The system text styles, sized as iOS draws them at the default text size. */
 export type TextStyle = 'largeTitle' | 'title' | 'title2' | 'title3' | 'headline' | 'subheadline' | 'body' | 'callout' | 'footnote' | 'caption' | 'caption2';
-/** `Font.Weight`. */
+/** A font weight, from `ultraLight` to `black`. */
 export type FontWeight = 'ultraLight' | 'thin' | 'light' | 'regular' | 'medium' | 'semibold' | 'bold' | 'heavy' | 'black';
-/** `Alignment`, for `frame` and `ZStack`. */
+/** Where content sits inside a larger frame. Used by `frame` and `ZStack`. */
 export type ContentAlignment = 'center' | 'leading' | 'trailing' | 'top' | 'bottom' | 'topLeading' | 'topTrailing' | 'bottomLeading' | 'bottomTrailing';
-/** `frame(width:height:alignment:)` and `frame(minWidth:maxWidth:…)`, in points.
+/** A fixed size or size bounds for a view, in points, and how its content aligns inside.
  * `'infinity'` fills the available space. */
 export interface ContentFrame {
     width?: number;
@@ -16,8 +16,8 @@ export interface ContentFrame {
     maxHeight?: number | 'infinity';
     alignment?: ContentAlignment;
 }
-/** `padding`: `true` is the default 16 pt on every edge, a number pads every edge, and an
- * object pads chosen edges. */
+/** The `padding` prop. `true` adds the default 16 pt on every edge, a number pads every edge,
+ * and an object pads the edges it names. */
 export type ContentPadding = boolean | number | {
     top?: number;
     bottom?: number;
@@ -26,8 +26,8 @@ export type ContentPadding = boolean | number | {
     horizontal?: number;
     vertical?: number;
 };
-/** Shared content properties for the framework components. Plain HTML attributes, `style`
- * included, still apply. */
+/** The padding, frame and background props shared by text and stacks. Plain HTML attributes,
+ * `style` included, still apply. */
 export interface ContentProps extends HTMLAttributes<HTMLElement> {
     padding?: ContentPadding;
     frame?: ContentFrame;
@@ -45,8 +45,8 @@ export interface TextProps extends ContentProps {
     truncationMode?: 'tail';
 }
 /**
- * `Text`: inline text in a system text style. Nested Text inherits its enclosing style
- * unless explicitly overridden. A `lineLimit` truncates with an ellipsis.
+ * Inline text in a system text style. Nested Text inherits its enclosing style unless it sets
+ * its own. A `lineLimit` truncates with an ellipsis.
  *
  * @example
  * <Text font="headline" lineLimit={1}>{note.title}</Text>
@@ -63,46 +63,47 @@ export interface HStackProps extends ContentProps {
     spacing?: number;
 }
 /**
- * `VStack`: arranges its children vertically. Give `spacing` explicitly where it matters;
- * wrappers and custom controls do not propagate measured child spacing preferences.
+ * Arranges its children in a column. Set `spacing` where it matters: wrappers and custom
+ * controls do not pass their children's preferred spacing up to the stack.
  *
  * @example
  * <VStack alignment="leading" spacing={4}><Text font="headline">{title}</Text></VStack>
  */
 export declare function VStack(props: VStackProps): import("react").JSX.Element;
-/** `HStack`: arranges its children horizontally. Pair it with `Spacer` to push content to
- * the edges. */
+/** Arranges its children in a row. Add a `Spacer` to push content to the edges. */
 export declare function HStack(props: HStackProps): import("react").JSX.Element;
 /** How ZStack aligns its layers. */
 export interface ZStackProps extends ContentProps {
     alignment?: ContentAlignment;
 }
-/** `ZStack`: overlays its children in one cell, later children on top, keeping source order
- * for assistive technology. */
+/** Layers its children in one cell, later children on top. Assistive technology reads them in
+ * source order. */
 export declare function ZStack({ alignment, padding, frame, background, foregroundStyle, style, ...props }: ZStackProps): import("react").JSX.Element;
 /** Spacer's minimum length in points. */
 export interface SpacerProps extends HTMLAttributes<HTMLDivElement> {
     minLength?: number;
 }
-/** `Spacer`: takes the free space along its parent stack's axis. */
+/** Takes up the free space along its parent stack's axis. */
 export declare function Spacer({ minLength, style, ...props }: SpacerProps): import("react").JSX.Element;
-/** `Divider`: a hairline across its parent stack's axis. Decorative, so hidden from
- * assistive technology. */
+/** A hairline across its parent stack's axis. It is decorative, so assistive technology skips
+ * it. */
 export declare function Divider({ style, ...props }: HTMLAttributes<HTMLDivElement>): import("react").JSX.Element;
 /** LazyVStack's layout props. Every child mounts eagerly; use List for long data. */
 export type LazyVStackProps = VStackProps;
 /** LazyHStack's layout props. Every child mounts eagerly; use List for long data. */
 export type LazyHStackProps = HStackProps;
-/** Vertical stack with eager mounting and retained child state. No viewport virtualization. */
+/** Lays out its children like `VStack`. Every child mounts at once and keeps its state, so use
+ * `List` for long data. */
 export declare function LazyVStack(props: LazyVStackProps): import("react").JSX.Element;
-/** Horizontal stack with eager mounting and retained child state. No viewport virtualization. */
+/** Lays out its children like `HStack`. Every child mounts at once and keeps its state. */
 export declare function LazyHStack(props: LazyHStackProps): import("react").JSX.Element;
-/** Track spacing follows this track; alignment places content within each cell. */
+/** Options every grid track takes. `spacing` is the gap after this track; `alignment` places
+ * content within each cell. */
 export interface GridItemOptions {
     spacing?: number;
     alignment?: ContentAlignment;
 }
-/** A fixed track's dimension in points. */
+/** A fixed track's size in points. */
 export interface FixedGridItemOptions extends GridItemOptions {
     size: number;
 }
@@ -111,13 +112,14 @@ export interface FlexibleGridItemOptions extends GridItemOptions {
     minimum?: number;
     maximum?: number;
 }
-/** Bounds for repeated adaptive tracks. Only one adaptive descriptor is supported. */
+/** Bounds for an adaptive track, which repeats to fit as many columns or rows as the space
+ * allows. A grid with an adaptive track can have no other track. */
 export interface AdaptiveGridItemOptions extends GridItemOptions {
     minimum: number;
     maximum?: number;
 }
 declare const gridItemBrand: unique symbol;
-/** A frozen validated grid track, constructed through GridItem. */
+/** A validated grid track. Make one with `GridItem.fixed`, `.flexible` or `.adaptive`. */
 export type GridItemValue = Readonly<{
     [gridItemBrand]: true;
 } & GridItemOptions & ({
@@ -128,26 +130,29 @@ export type GridItemValue = Readonly<{
     minimum: number;
     maximum?: number;
 })>;
-/** Validated grid tracks. The numeric fixed constructor remains compatible with older apps. */
+/** Makes grid tracks for `LazyVGrid` and `LazyHGrid`: `fixed`, `flexible` or `adaptive`. Each
+ * call validates its options and throws a `RangeError` for bad bounds or spacing. */
 export declare const GridItem: Readonly<{
     fixed(options: number | FixedGridItemOptions): GridItemValue;
     flexible(options?: FlexibleGridItemOptions): GridItemValue;
     adaptive(options: AdaptiveGridItemOptions): GridItemValue;
 }>;
-/** Columns define column spacing; spacing here is the distance between rows. */
+/** The grid's columns and the spacing between rows. Each column sets the gap after itself. */
 export interface LazyVGridProps extends ContentProps {
     columns: readonly GridItemValue[];
     alignment?: VStackProps['alignment'];
     spacing?: number;
 }
-/** Rows define row spacing; spacing here is the distance between columns. */
+/** The grid's rows and the spacing between columns. Each row sets the gap after itself. */
 export interface LazyHGridProps extends ContentProps {
     rows: readonly GridItemValue[];
     alignment?: 'top' | 'center' | 'bottom';
     spacing?: number;
 }
-/** Columns growing vertically. Renders every child eagerly; use List for long data. */
+/** A grid with fixed columns that grows downward. Every child renders at once; use `List` for
+ * long data. */
 export declare function LazyVGrid({ columns, ...props }: LazyVGridProps): import("react").JSX.Element;
-/** Rows growing horizontally. Renders every child eagerly; use List for long data. */
+/** A grid with fixed rows that grows sideways. Every child renders at once; use `List` for long
+ * data. */
 export declare function LazyHGrid({ rows, ...props }: LazyHGridProps): import("react").JSX.Element;
 export {};

package/dist/content/content.js

@@ -60,8 +60,8 @@ function ContentFrameBox({ frame, background, style, inline = false, children, }
         }, children: children }));
 }
 /**
- * `Text`: inline text in a system text style. Nested Text inherits its enclosing style
- * unless explicitly overridden. A `lineLimit` truncates with an ellipsis.
+ * Inline text in a system text style. Nested Text inherits its enclosing style unless it sets
+ * its own. A `lineLimit` truncates with an ellipsis.
  *
  * @example
  * <Text font="headline" lineLimit={1}>{note.title}</Text>
@@ -141,8 +141,8 @@ function Stack({ axis, alignment = 'center', spacing, padding, frame, background
     return frame ? (_jsx(ContentFrameBox, { frame: frame, background: background, style: style, children: content })) : (content);
 }
 /**
- * `VStack`: arranges its children vertically. Give `spacing` explicitly where it matters;
- * wrappers and custom controls do not propagate measured child spacing preferences.
+ * Arranges its children in a column. Set `spacing` where it matters: wrappers and custom
+ * controls do not pass their children's preferred spacing up to the stack.
  *
  * @example
  * <VStack alignment="leading" spacing={4}><Text font="headline">{title}</Text></VStack>
@@ -150,13 +150,12 @@ function Stack({ axis, alignment = 'center', spacing, padding, frame, background
 export function VStack(props) {
     return _jsx(Stack, { ...props, axis: "vertical" });
 }
-/** `HStack`: arranges its children horizontally. Pair it with `Spacer` to push content to
- * the edges. */
+/** Arranges its children in a row. Add a `Spacer` to push content to the edges. */
 export function HStack(props) {
     return _jsx(Stack, { ...props, axis: "horizontal" });
 }
-/** `ZStack`: overlays its children in one cell, later children on top, keeping source order
- * for assistive technology. */
+/** Layers its children in one cell, later children on top. Assistive technology reads them in
+ * source order. */
 export function ZStack({ alignment = 'center', padding, frame, background, foregroundStyle, style, ...props }) {
     const content = (_jsx("div", { ...props, "data-satin-content": "zstack", style: {
             display: 'grid',
@@ -166,23 +165,24 @@ export function ZStack({ alignment = 'center', padding, frame, background, foreg
         } }));
     return frame ? (_jsx(ContentFrameBox, { frame: frame, background: background, style: style, children: content })) : (content);
 }
-/** `Spacer`: takes the free space along its parent stack's axis. */
+/** Takes up the free space along its parent stack's axis. */
 export function Spacer({ minLength, style, ...props }) {
     return (_jsx("div", { ...props, "aria-hidden": "true", "data-satin-content": "spacer", style: {
             ...(minLength === undefined ? {} : { '--satin-spacer-min': `${minLength}px` }),
             ...style,
         } }));
 }
-/** `Divider`: a hairline across its parent stack's axis. Decorative, so hidden from
- * assistive technology. */
+/** A hairline across its parent stack's axis. It is decorative, so assistive technology skips
+ * it. */
 export function Divider({ style, ...props }) {
     return _jsx("div", { ...props, "aria-hidden": "true", "data-satin-content": "divider", style: style });
 }
-/** Vertical stack with eager mounting and retained child state. No viewport virtualization. */
+/** Lays out its children like `VStack`. Every child mounts at once and keeps its state, so use
+ * `List` for long data. */
 export function LazyVStack(props) {
     return _jsx(VStack, { ...props, "data-satin-lazy-stack": "vertical" });
 }
-/** Horizontal stack with eager mounting and retained child state. No viewport virtualization. */
+/** Lays out its children like `HStack`. Every child mounts at once and keeps its state. */
 export function LazyHStack(props) {
     return _jsx(HStack, { ...props, "data-satin-lazy-stack": "horizontal" });
 }
@@ -223,7 +223,8 @@ function boundedGridItem(kind, options) {
     gridItems.add(item);
     return item;
 }
-/** Validated grid tracks. The numeric fixed constructor remains compatible with older apps. */
+/** Makes grid tracks for `LazyVGrid` and `LazyHGrid`: `fixed`, `flexible` or `adaptive`. Each
+ * call validates its options and throws a `RangeError` for bad bounds or spacing. */
 export const GridItem = Object.freeze({
     fixed(options) {
         const { size, spacing, alignment } = typeof options === 'number' ? { size: options } : options;
@@ -305,11 +306,13 @@ function LazyGrid({ axis, items, alignment = 'center', spacing = 8, padding, fra
         }) }));
     return frame ? (_jsx(ContentFrameBox, { frame: frame, background: background, style: style, children: content })) : (content);
 }
-/** Columns growing vertically. Renders every child eagerly; use List for long data. */
+/** A grid with fixed columns that grows downward. Every child renders at once; use `List` for
+ * long data. */
 export function LazyVGrid({ columns, ...props }) {
     return _jsx(LazyGrid, { ...props, axis: "vertical", items: columns });
 }
-/** Rows growing horizontally. Renders every child eagerly; use List for long data. */
+/** A grid with fixed rows that grows sideways. Every child renders at once; use `List` for long
+ * data. */
 export function LazyHGrid({ rows, ...props }) {
     return _jsx(LazyGrid, { ...props, axis: "horizontal", items: rows });
 }

package/dist/content/layout.d.ts

@@ -1,26 +1,34 @@
 import { type HTMLAttributes, type ReactNode } from 'react';
+/** A width and height in points. */
 export interface GeometrySize {
     width: number;
     height: number;
 }
+/** A rectangle in points: origin `x` and `y` plus a size. */
 export interface GeometryFrame extends GeometrySize {
     x: number;
     y: number;
 }
+/** What a `GeometryReader` passes to its children: its size and a way to read its frame. */
 export interface GeometryProxy {
     /** The reader's allocated CSS space, in points on the target runtime. */
     size: GeometrySize;
     /** Global means layout-viewport coordinates. Pass an element for a named local space. */
     frame(inSpace: 'local' | 'global' | HTMLElement): GeometryFrame;
 }
+/** A `GeometryReader`'s render function, plus plain div attributes. */
 export interface GeometryReaderProps extends Omit<HTMLAttributes<HTMLDivElement>, 'children'> {
     children(proxy: GeometryProxy): ReactNode;
 }
-/** A greedy layout container. Give a reader in a scroll view a definite height. */
+/** Fills the space it is offered and calls its children with that size. Its content renders
+ * once the first measurement is in. */
 export declare function GeometryReader({ children, style, ...props }: GeometryReaderProps): import("react").JSX.Element;
+/** The axes a `ViewThatFits` candidate must fit along. */
 export type ViewThatFitsAxis = 'horizontal' | 'vertical' | 'both';
+/** The axes to check, `both` by default, plus plain div attributes. */
 export interface ViewThatFitsProps extends HTMLAttributes<HTMLDivElement> {
     in?: ViewThatFitsAxis;
 }
-/** Select the first ideal size that fits, or the last candidate when none does. */
+/** Shows the first child whose natural size fits the space, or the last child when none fits.
+ * It measures again when the space or a child resizes. */
 export declare function ViewThatFits({ in: axis, children, style, ...props }: ViewThatFitsProps): import("react").JSX.Element;

package/dist/content/layout.js

@@ -1,7 +1,8 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { Children, useContext, useLayoutEffect, useRef, useState, } from 'react';
 import { TabActivityContext } from '../tabs/context.js';
-/** A greedy layout container. Give a reader in a scroll view a definite height. */
+/** Fills the space it is offered and calls its children with that size. Its content renders
+ * once the first measurement is in. */
 export function GeometryReader({ children, style, ...props }) {
     const host = useRef(null);
     const active = useContext(TabActivityContext);
@@ -60,7 +61,8 @@ function idealSize(element, axis) {
     element.style.cssText = previous;
     return { width: bounds.width, height: bounds.height };
 }
-/** Select the first ideal size that fits, or the last candidate when none does. */
+/** Shows the first child whose natural size fits the space, or the last child when none fits.
+ * It measures again when the space or a child resizes. */
 export function ViewThatFits({ in: axis = 'both', children, style, ...props }) {
     const host = useRef(null);
     const parentActive = useContext(TabActivityContext);

package/dist/content/scaledMetric.d.ts

@@ -1,3 +1,4 @@
 import type { TextStyle } from './content.js';
-/** Scale a dimension by the target WebKit system text style's Dynamic Type ratio. */
+/** Scales a dimension with the user's text size, relative to a text style (`body` by default).
+ * Use it for spacing or icon sizes that should grow with text. */
 export declare function useScaledMetric(value: number, relativeTo?: TextStyle): number;

package/dist/content/scaledMetric.js

@@ -54,7 +54,8 @@ function createMetricStore(style) {
     };
 }
 const stores = new Map();
-/** Scale a dimension by the target WebKit system text style's Dynamic Type ratio. */
+/** Scales a dimension with the user's text size, relative to a text style (`body` by default).
+ * Use it for spacing or icon sizes that should grow with text. */
 export function useScaledMetric(value, relativeTo = 'body') {
     if (!Number.isFinite(value))
         throw new Error('useScaledMetric requires a finite value.');

package/dist/controls/ColorPicker.d.ts

@@ -9,10 +9,8 @@ export type ColorPickerProps = {
     disabled?: boolean;
 };
 /**
- * `ColorPicker`: a row with a colour well that opens the system colour picker (grid,
- * spectrum, sliders, eyedropper and, with `supportsOpacity`, opacity).
- *
- * The system picker is titled "Colors", not with the label.
+ * A row with a colour well that opens the system colour picker: grid, spectrum, sliders,
+ * eyedropper and, with `supportsOpacity`, opacity.
  *
  * @example
  * <ColorPicker label="List Colour" selection={color} onSelectionChange={setColor} supportsOpacity={false} />

package/dist/controls/ColorPicker.js

@@ -36,10 +36,8 @@ function writeHex(channels, withAlpha) {
     return '#' + values.map(value => value.toString(16).padStart(2, '0')).join('');
 }
 /**
- * `ColorPicker`: a row with a colour well that opens the system colour picker (grid,
- * spectrum, sliders, eyedropper and, with `supportsOpacity`, opacity).
- *
- * The system picker is titled "Colors", not with the label.
+ * A row with a colour well that opens the system colour picker: grid, spectrum, sliders,
+ * eyedropper and, with `supportsOpacity`, opacity.
  *
  * @example
  * <ColorPicker label="List Colour" selection={color} onSelectionChange={setColor} supportsOpacity={false} />

package/dist/controls/DatePicker.d.ts

@@ -1,7 +1,7 @@
 import { type ReactNode } from 'react';
-/** `DatePickerComponents`. */
+/** A part of the value a `DatePicker` edits: the `date`, or the `hourAndMinute`. */
 export type DatePickerComponent = 'date' | 'hourAndMinute';
-/** `DatePickerStyle`. `automatic` is `compact`. */
+/** How a `DatePicker` draws. Only the compact style exists; `automatic` is `compact`. */
 export type DatePickerStyle = 'automatic' | 'compact';
 /**
  * A DatePicker's selectable range. Omit a bound for a one-sided range
@@ -29,8 +29,8 @@ export type DatePickerProps<Selection extends Date | string = Date> = {
     'aria-label'?: string;
 };
 /**
- * `DatePicker` in its compact style: the row's grey value capsules open the system date
- * or time picker.
+ * A row for picking a date, a time or both. Its grey value capsules open the system date or
+ * time picker.
  *
  * Use a civil string selection (`'2026-10-14'`) for a day that must stay the same day in every
  * time zone, such as a due date; use a `Date` for a moment in time.

package/dist/controls/DatePicker.js

@@ -82,8 +82,8 @@ function displayText(field, fields) {
         .join('');
 }
 /**
- * `DatePicker` in its compact style: the row's grey value capsules open the system date
- * or time picker.
+ * A row for picking a date, a time or both. Its grey value capsules open the system date or
+ * time picker.
  *
  * Use a civil string selection (`'2026-10-14'`) for a day that must stay the same day in every
  * time zone, such as a due date; use a `Date` for a moment in time.

package/dist/controls/ProgressView.d.ts

@@ -1,9 +1,10 @@
 import { type ReactNode } from 'react';
-/** `ProgressViewStyle`: `automatic` is linear with a value, circular without. */
+/** How a `ProgressView` draws: `linear`, `circular` or `automatic`, which is linear with a value
+ * and circular without. */
 export type ProgressViewStyle = 'automatic' | 'linear' | 'circular';
 /** ProgressView's optional label and progress; without `value` it is indeterminate. */
 export type ProgressViewProps = {
-    /** The iOS style. Automatic preserves the value-dependent default. */
+    /** `automatic` is linear with a value and circular without. */
     progressViewStyle?: ProgressViewStyle;
     label?: ReactNode;
     /** Omit value for an indeterminate activity indicator. */
@@ -12,6 +13,5 @@ export type ProgressViewProps = {
     tint?: string;
     'aria-label'?: string;
 };
-/** `ProgressView`: a spinning activity indicator, or a linear bar for `value` of
- * `total` (default 1). */
+/** A spinning activity indicator, or a linear bar showing `value` out of `total` (1 by default). */
 export declare function ProgressView({ label, progressViewStyle, value, total, tint, 'aria-label': accessibleLabel, }: ProgressViewProps): import("react").JSX.Element;

package/dist/controls/ProgressView.js

@@ -5,8 +5,7 @@ import { TabActivityContext } from '../tabs/context.js';
 import { controlTintStyle, useControlStyle } from '../public/controlStyle.js';
 import { ControlRow } from './ControlRow.js';
 import { ActivityIndicatorSegments } from './ActivityIndicatorSegments.js';
-/** `ProgressView`: a spinning activity indicator, or a linear bar for `value` of
- * `total` (default 1). */
+/** A spinning activity indicator, or a linear bar showing `value` out of `total` (1 by default). */
 export function ProgressView({ label, progressViewStyle = 'automatic', value, total = 1, tint, 'aria-label': accessibleLabel, }) {
     const labelId = useId();
     const screen = useContext(ScreenContext);

package/dist/data/database.d.ts

@@ -15,8 +15,8 @@ export interface CollectionDefinition<T extends object, K extends StringProperty
     readonly __row?: T;
 }
 /**
- * Declares a collection of records keyed by one string field, like a SwiftData `@Model` with a
- * unique attribute. The curried form, `collection<Note>()({ key, indexes })`, infers index names.
+ * Declares a collection of records keyed by one unique string field. The curried form,
+ * `collection<Note>()({ key, indexes })`, infers index names.
  *
  * @example
  * notes: collection<Note>()({ key: 'id', indexes: { byDate: 'createdAt' } })
@@ -43,7 +43,8 @@ export type CollectionSchema = Record<string, {
     readonly indexes: Record<string, string>;
     readonly __row?: object;
 }>;
-/** The accepted record updates for a collection. */
+/** A collection's `update` method: a partial record to merge, or a function that returns the
+ * new record. */
 export type CollectionUpdateMethods<T extends object> = {
     update(key: string, update: Partial<T> | ((row: T) => T)): Promise<void>;
 };
@@ -51,7 +52,7 @@ export type CollectionUpdateMethods<T extends object> = {
 export type TransactionCollections<S extends CollectionSchema> = {
     [N in keyof S]: TransactionCollection<RecordOfCollection<S[N]>> & CollectionUpdateMethods<RecordOfCollection<S[N]>>;
 };
-/** An awaited migration over the database transaction collections. */
+/** A schema migration. It runs inside one transaction and may be async. */
 export type DatabaseMigration<S extends CollectionSchema> = (tx: TransactionCollections<S>) => void | Promise<void>;
 /** An immutable query over a collection: `index`, `keyRange`, `reverse`, `limit` and `filter` each
  * return a new query. `useQuery` hands one to its configure callback. */
@@ -99,9 +100,9 @@ export interface ExportDocument {
     collections: Record<string, DatabaseRecord[]>;
 }
 /**
- * Opens the app's local database (IndexedDB), like a SwiftData `ModelContainer`. Each collection
- * becomes a property of the result. Bump `version` with a migration whenever the schema changes.
- * Export and import are built in, so offer them to the user.
+ * Opens the app's local database, stored in IndexedDB. Each collection becomes a property of the
+ * result. Bump `version` with a migration whenever the schema changes. Export and import are
+ * built in, so offer them to the user.
  *
  * @example
  * export const db = defineDatabase({
@@ -126,7 +127,7 @@ export declare function defineDatabase<const S extends CollectionSchema>(config:
     close(): void;
 };
 /**
- * SwiftData `@Query`: a collection's records as `{ data, loading, error }`, kept live. Local writes
+ * Reads a collection's records as `{ data, loading, error }` and keeps them live. Local writes
  * show up synchronously, before they persist.
  *
  * @example

package/dist/data/database.js

@@ -155,9 +155,9 @@ function select(rows, definition, query) {
 }
 const snapshots = new WeakMap();
 /**
- * Opens the app's local database (IndexedDB), like a SwiftData `ModelContainer`. Each collection
- * becomes a property of the result. Bump `version` with a migration whenever the schema changes.
- * Export and import are built in, so offer them to the user.
+ * Opens the app's local database, stored in IndexedDB. Each collection becomes a property of the
+ * result. Bump `version` with a migration whenever the schema changes. Export and import are
+ * built in, so offer them to the user.
  *
  * @example
  * export const db = defineDatabase({
@@ -663,7 +663,7 @@ function createDataObserver(source, empty, readCached, load, initial, reconcile
     return { getSnapshot, subscribe, getServerSnapshot: () => serverSnapshot };
 }
 /**
- * SwiftData `@Query`: a collection's records as `{ data, loading, error }`, kept live. Local writes
+ * Reads a collection's records as `{ data, loading, error }` and keeps them live. Local writes
  * show up synchronously, before they persist.
  *
  * @example