@orkestrel/form 0.0.5 → 0.0.7

package/dist/src/core/index.d.cts

@@ -1,8 +1,8 @@
-import { EmitterErrorHandler } from '@orkestrel/emitter';
-import { EmitterHooks } from '@orkestrel/emitter';
-import { EmitterInterface } from '@orkestrel/emitter';
-import { JSONRecord } from '@orkestrel/contract';
-import { Result } from '@orkestrel/contract';
+import type { EmitterErrorHandler } from '@orkestrel/emitter';
+import type { EmitterHooks } from '@orkestrel/emitter';
+import type { EmitterInterface } from '@orkestrel/emitter';
+import type { JSONRecord } from '@orkestrel/contract';
+import type { Result } from '@orkestrel/contract';
 
 /** Matches one or more ASCII letters or digits. */
 export declare const ALPHANUMERIC_PATTERN: Readonly<RegExp>;
@@ -41,7 +41,7 @@ export declare interface CheckboxField extends FieldBase {
     readonly default?: readonly string[];
 }
 
-/** Caps the number of choices one `select` or `checkbox` field may offer. */
+/** Caps the number of choices one `select` or `checkbox` field may offer, at 1024. */
 export declare const CHOICE_LIMIT = 1024;
 
 /**
@@ -82,7 +82,7 @@ export declare function cloneValue(value: FieldValue): FieldValue;
 /** Matches a six-digit hexadecimal color string. */
 export declare const COLOR_PATTERN: Readonly<RegExp>;
 
-/** Represents a color, held as the control's own string. */
+/** Represents a color, held as the control's own six-digit `#rrggbb` string. */
 export declare interface ColorField extends FieldBase {
     readonly control: 'color';
     readonly default?: string;
@@ -91,6 +91,10 @@ export declare interface ColorField extends FieldBase {
 /**
  * Computes the values explicitly seeded by a schema.
  *
+ * @remarks
+ * `password` and `file` declare no default, so a field of either control never appears in the
+ * result.
+ *
  * @param schema - The schema whose defaults to collect.
  * @returns A value record containing only fields with defaults.
  */
@@ -136,8 +140,10 @@ export declare function createFieldError(field: FormField, rule: FieldRuleName,
  * @throws A {@link FormError} coded `SCHEMA` when the schema is malformed, `FIELD` when
  *   `options.values` names a field the schema does not declare, and `CONTROL` when a seeded value
  *   is one its field's control cannot hold.
- * @example
+ * @example Open a form, answer it, and settle it
  * ```ts
+ * import { createForm } from '@orkestrel/form'
+ *
  * const form = createForm({
  * 	label: 'Sign up',
  * 	fields: [
@@ -147,7 +153,8 @@ export declare function createFieldError(field: FormField, rule: FieldRuleName,
  * })
  *
  * form.fill({ email: 'ada@example.com', terms: true })
- * form.submit() // { success: true, value: { email: 'ada@example.com', terms: true } }
+ * const result = form.submit() // { success: true, value: { email: 'ada@example.com', terms: true } }
+ * const answers = await form.answer // { email: 'ada@example.com', terms: true }
  * ```
  */
 export declare function createForm(schema: FormSchema, options?: FormOptions): FormInterface;
@@ -155,7 +162,7 @@ export declare function createForm(schema: FormSchema, options?: FormOptions): F
 /** Matches an ISO calendar date string in `YYYY-MM-DD` form. */
 export declare const DATE_PATTERN: Readonly<RegExp>;
 
-/** Represents a calendar date, held as the control's own string. */
+/** Represents a calendar date, held as the control's own `YYYY-MM-DD` string. */
 export declare interface DateField extends FieldBase {
     readonly control: 'date';
     readonly default?: string;
@@ -284,7 +291,7 @@ export declare const FIELD_CONTROLS: readonly FieldControl[];
  */
 export declare const FIELD_KEYS: Readonly<Record<FieldControl, readonly string[]>>;
 
-/** Caps the number of fields one schema may declare. */
+/** Caps the number of fields one schema may declare, at 512. */
 export declare const FIELD_LIMIT = 512;
 
 /**
@@ -439,11 +446,11 @@ export declare type FieldValidator = (value: FieldValue | undefined, values: For
 export declare type FieldValue = string | number | boolean | readonly string[];
 
 /**
- * Represents one or more files.
+ * Represents one or more files, by name.
  *
  * @remarks
- * `accept` lists the media types and extensions the control offers, in the form the host
- * expects.
+ * A value is the names alone: bytes never enter the document. `accept` lists the media types
+ * and extensions the control offers, in the form the host expects.
  */
 export declare interface FileField extends FieldBase {
     readonly control: 'file';
@@ -452,7 +459,8 @@ export declare interface FileField extends FieldBase {
 }
 
 /**
- * Represents a form: a schema, the answers given against it, and the errors they carry.
+ * Implements `FormInterface` exactly, over an owned schema, the answers given against it, and the
+ * errors they carry.
  *
  * @remarks
  * The form owns its schema, so a later edit to the schema the caller passed changes nothing here.
@@ -626,6 +634,10 @@ export declare const FORM_STATUSES: readonly FormStatus[];
 /**
  * Resolves and interpolates one rule message.
  *
+ * @remarks
+ * A replacement in `messages` is read first and {@link RULE_MESSAGES} supplies the copy otherwise,
+ * and `{limit}` in whichever text wins is replaced with the rule's operand.
+ *
  * @param rule - The rule whose message to resolve.
  * @param limit - The optional operand substituted for `{limit}`.
  * @param messages - Optional rule-specific message replacements.
@@ -721,7 +733,7 @@ export declare interface FormGroup {
 }
 
 /**
- * Represents a form: a schema, the answers given against it, and the errors they carry.
+ * Declares the contract a form exposes: the state it holds and the calls that move it.
  *
  * @remarks
  * `valid` is true when the last completed evaluation found no error, and `dirty` is true once
@@ -787,7 +799,7 @@ export declare interface FormInterface {
      */
     field(name: string): FormField | undefined;
     /**
-     * Answers several fields at once.
+     * Answers one field, or several at once.
      *
      * @param values - The answers to write, each keyed by its field name.
      */
@@ -808,12 +820,16 @@ export declare interface FormInterface {
     /**
      * Fails a field from outside, for what the rules cannot see.
      *
+     * @remarks
+     * One field holds one external failure, so a second call replaces the first, and the failure
+     * lasts until that field is filled again or the form is cleared.
+     *
      * @param name - The field's name.
      * @param message - What to tell the person.
      */
     invalidate(name: string, message: string): void;
     /**
-     * Takes every field out of the form.
+     * Takes one field, several fields, or every field out of the form.
      *
      * @remarks
      * A disabled field is neither evaluated nor submitted. Its answer is kept, and so is any
@@ -839,7 +855,7 @@ export declare interface FormInterface {
      */
     disable(names: readonly string[]): void;
     /**
-     * Puts every field back into the form.
+     * Puts one field, several fields, or every field back into the form.
      *
      * @remarks
      * An enabled field is evaluated and submitted again, and any invalidation held while it was
@@ -869,19 +885,20 @@ export declare interface FormInterface {
      */
     submit(): FormResult;
     /**
-     * Returns every answer to {@link FormInterface.baseline}, the answers the form opened with.
+     * Returns every answer to the ones the form opened with.
      *
      * @remarks
-     * The runtime disabled overlay resets with them, so {@link FormInterface.disabled} reads the
-     * schema's declarations again.
+     * Those answers are {@link FormInterface.baseline}. The runtime disabled overlay resets with
+     * them, so {@link FormInterface.disabled} reads the schema's declarations again.
      */
     clear(): void;
     /**
      * Tears the form down, abandoning it when it has not settled.
      *
      * @remarks
-     * A request from inside a listener defers teardown until the outermost mutation batch closes,
-     * so an in-flight settlement can win and leave the form `settled` rather than `abandoned`.
+     * Tearing down twice does nothing the second time. A request from inside a listener defers
+     * teardown until the outermost mutation batch closes, so an in-flight settlement can win and
+     * leave the form `settled` rather than `abandoned`.
      */
     destroy(): void;
 }
@@ -984,7 +1001,7 @@ export declare type FormValues = Readonly<Record<string, FieldValue>>;
  *
  * @remarks
  * The prototype-safe write of {@link defineEntry}, frozen: the entry is neither writable nor
- * configurable, so the record a parser hands back cannot be edited through the key it just filled.
+ * configurable, so the record a parser hands back cannot be edited through the key it filled.
  *
  * @example
  * ```ts
@@ -995,7 +1012,7 @@ export declare type FormValues = Readonly<Record<string, FieldValue>>;
  */
 export declare function freezeEntry<T>(target: Record<string, T>, name: string, value: T): void;
 
-/** Caps the number of groups one schema may declare. */
+/** Caps the number of groups one schema may declare, at 64. */
 export declare const GROUP_LIMIT = 64;
 
 /** Matches a signed or unsigned base-ten integer string. */
@@ -1036,6 +1053,10 @@ export declare function isFieldRule(input: unknown): input is FieldRule;
 /**
  * Determines whether an unknown value has a form field value shape.
  *
+ * @remarks
+ * A string, a finite number, a boolean, and a list of strings each qualify. A number that is not
+ * finite does not, so `NaN` and `Infinity` are refused.
+ *
  * @param input - The value to inspect.
  * @returns True if the value is a field value; false otherwise.
  */
@@ -1073,6 +1094,10 @@ export declare function isFormGroup(input: unknown): input is FormGroup;
 /**
  * Determines whether an unknown value is one exact structural form schema.
  *
+ * @remarks
+ * Structure alone is read. Domain soundness — a duplicate name, a bound no answer satisfies, a
+ * breached budget — is {@link auditSchema}'s question.
+ *
  * @param input - The value to inspect.
  * @returns True if the value is a structurally valid form schema; false otherwise.
  */
@@ -1094,7 +1119,7 @@ export declare function isFormStatus(input: unknown): input is FormStatus;
  */
 export declare function isFormValues(input: unknown): input is FormValues;
 
-/** Caps the number of entries one list-valued answer may hold. */
+/** Caps the number of entries one list-valued answer may hold, at 1024. */
 export declare const LIST_LIMIT = 1024;
 
 /**
@@ -1114,6 +1139,10 @@ export declare function matchesAnswer(value: FieldValue | undefined): boolean;
 /**
  * Checks whether a value has the shape required by one field control.
  *
+ * @remarks
+ * Every write and every seeded value passes through this gate, and it reads `STRING_LIMIT` and
+ * `LIST_LIMIT` before it consults the control, so no regular expression sees an over-long value.
+ *
  * @param field - The field that owns the value.
  * @param value - The unknown value to inspect.
  * @returns True if the control can hold the value; false otherwise.
@@ -1138,10 +1167,10 @@ export declare function matchesValue(a: FieldValue, b: FieldValue): boolean;
  */
 export declare function matchesValues(a: FormValues, b: FormValues): boolean;
 
-/** Caps the length, in UTF-16 code units, of a schema, group, or field name. */
+/** Caps the length, in UTF-16 code units, of a schema, group, or field name, at 128. */
 export declare const NAME_LIMIT = 128;
 
-/** Caps the total number of records, arrays, and leaves one schema retains. */
+/** Caps the total number of records, arrays, and leaves one schema retains, at 16384. */
 export declare const NODE_LIMIT = 16384;
 
 /** Represents a number. */
@@ -1162,6 +1191,10 @@ export declare function parseForm(input: unknown): FormSchema | undefined;
 /**
  * Parses one answer against its field control.
  *
+ * @remarks
+ * A numeric string coerces to a number for a `number` field, and `'true'` and `'false'` coerce to
+ * a boolean for a `confirm` field. Every other value must already have its control's shape.
+ *
  * @param field - The field that defines the accepted value.
  * @param input - The unknown value to parse.
  * @returns The typed or lexically coerced field value, or `undefined` on refusal.
@@ -1189,7 +1222,7 @@ export declare interface PasswordField extends FieldBase {
     readonly mask?: string;
 }
 
-/** Caps the accepted source length for an authored regular expression. */
+/** Caps the accepted source length for an authored regular expression, at 256. */
 export declare const PATTERN_LIMIT = 256;
 
 /** Holds the default failure copy for every named field rule. */
@@ -1219,10 +1252,10 @@ export declare interface SelectField extends FieldBase {
  */
 export declare function serializeForm(schema: FormSchema): JSONRecord;
 
-/** Caps the length, in UTF-16 code units, of any single retained string. */
+/** Caps the length, in UTF-16 code units, of any single retained string, at 65536. */
 export declare const STRING_LIMIT = 65536;
 
-/** Caps the total length, in UTF-16 code units, of every string one schema retains. */
+/** Caps the total length, in UTF-16 code units, of every string one schema retains, at 1048576. */
 export declare const TEXT_LIMIT = 1048576;
 
 /** Represents a single line of text. */
@@ -1235,7 +1268,7 @@ export declare interface TextField extends FieldBase {
 /** Matches a 24-hour time string with optional seconds. */
 export declare const TIME_PATTERN: Readonly<RegExp>;
 
-/** Represents a time of day, held as the control's own string. */
+/** Represents a time of day, held as the control's own `HH:MM` string, with seconds optional. */
 export declare interface TimeField extends FieldBase {
     readonly control: 'time';
     readonly default?: string;

package/dist/src/core/index.d.ts

@@ -1,8 +1,8 @@
-import { EmitterErrorHandler } from '@orkestrel/emitter';
-import { EmitterHooks } from '@orkestrel/emitter';
-import { EmitterInterface } from '@orkestrel/emitter';
-import { JSONRecord } from '@orkestrel/contract';
-import { Result } from '@orkestrel/contract';
+import type { EmitterErrorHandler } from '@orkestrel/emitter';
+import type { EmitterHooks } from '@orkestrel/emitter';
+import type { EmitterInterface } from '@orkestrel/emitter';
+import type { JSONRecord } from '@orkestrel/contract';
+import type { Result } from '@orkestrel/contract';
 
 /** Matches one or more ASCII letters or digits. */
 export declare const ALPHANUMERIC_PATTERN: Readonly<RegExp>;
@@ -41,7 +41,7 @@ export declare interface CheckboxField extends FieldBase {
     readonly default?: readonly string[];
 }
 
-/** Caps the number of choices one `select` or `checkbox` field may offer. */
+/** Caps the number of choices one `select` or `checkbox` field may offer, at 1024. */
 export declare const CHOICE_LIMIT = 1024;
 
 /**
@@ -82,7 +82,7 @@ export declare function cloneValue(value: FieldValue): FieldValue;
 /** Matches a six-digit hexadecimal color string. */
 export declare const COLOR_PATTERN: Readonly<RegExp>;
 
-/** Represents a color, held as the control's own string. */
+/** Represents a color, held as the control's own six-digit `#rrggbb` string. */
 export declare interface ColorField extends FieldBase {
     readonly control: 'color';
     readonly default?: string;
@@ -91,6 +91,10 @@ export declare interface ColorField extends FieldBase {
 /**
  * Computes the values explicitly seeded by a schema.
  *
+ * @remarks
+ * `password` and `file` declare no default, so a field of either control never appears in the
+ * result.
+ *
  * @param schema - The schema whose defaults to collect.
  * @returns A value record containing only fields with defaults.
  */
@@ -136,8 +140,10 @@ export declare function createFieldError(field: FormField, rule: FieldRuleName,
  * @throws A {@link FormError} coded `SCHEMA` when the schema is malformed, `FIELD` when
  *   `options.values` names a field the schema does not declare, and `CONTROL` when a seeded value
  *   is one its field's control cannot hold.
- * @example
+ * @example Open a form, answer it, and settle it
  * ```ts
+ * import { createForm } from '@orkestrel/form'
+ *
  * const form = createForm({
  * 	label: 'Sign up',
  * 	fields: [
@@ -147,7 +153,8 @@ export declare function createFieldError(field: FormField, rule: FieldRuleName,
  * })
  *
  * form.fill({ email: 'ada@example.com', terms: true })
- * form.submit() // { success: true, value: { email: 'ada@example.com', terms: true } }
+ * const result = form.submit() // { success: true, value: { email: 'ada@example.com', terms: true } }
+ * const answers = await form.answer // { email: 'ada@example.com', terms: true }
  * ```
  */
 export declare function createForm(schema: FormSchema, options?: FormOptions): FormInterface;
@@ -155,7 +162,7 @@ export declare function createForm(schema: FormSchema, options?: FormOptions): F
 /** Matches an ISO calendar date string in `YYYY-MM-DD` form. */
 export declare const DATE_PATTERN: Readonly<RegExp>;
 
-/** Represents a calendar date, held as the control's own string. */
+/** Represents a calendar date, held as the control's own `YYYY-MM-DD` string. */
 export declare interface DateField extends FieldBase {
     readonly control: 'date';
     readonly default?: string;
@@ -284,7 +291,7 @@ export declare const FIELD_CONTROLS: readonly FieldControl[];
  */
 export declare const FIELD_KEYS: Readonly<Record<FieldControl, readonly string[]>>;
 
-/** Caps the number of fields one schema may declare. */
+/** Caps the number of fields one schema may declare, at 512. */
 export declare const FIELD_LIMIT = 512;
 
 /**
@@ -439,11 +446,11 @@ export declare type FieldValidator = (value: FieldValue | undefined, values: For
 export declare type FieldValue = string | number | boolean | readonly string[];
 
 /**
- * Represents one or more files.
+ * Represents one or more files, by name.
  *
  * @remarks
- * `accept` lists the media types and extensions the control offers, in the form the host
- * expects.
+ * A value is the names alone: bytes never enter the document. `accept` lists the media types
+ * and extensions the control offers, in the form the host expects.
  */
 export declare interface FileField extends FieldBase {
     readonly control: 'file';
@@ -452,7 +459,8 @@ export declare interface FileField extends FieldBase {
 }
 
 /**
- * Represents a form: a schema, the answers given against it, and the errors they carry.
+ * Implements `FormInterface` exactly, over an owned schema, the answers given against it, and the
+ * errors they carry.
  *
  * @remarks
  * The form owns its schema, so a later edit to the schema the caller passed changes nothing here.
@@ -626,6 +634,10 @@ export declare const FORM_STATUSES: readonly FormStatus[];
 /**
  * Resolves and interpolates one rule message.
  *
+ * @remarks
+ * A replacement in `messages` is read first and {@link RULE_MESSAGES} supplies the copy otherwise,
+ * and `{limit}` in whichever text wins is replaced with the rule's operand.
+ *
  * @param rule - The rule whose message to resolve.
  * @param limit - The optional operand substituted for `{limit}`.
  * @param messages - Optional rule-specific message replacements.
@@ -721,7 +733,7 @@ export declare interface FormGroup {
 }
 
 /**
- * Represents a form: a schema, the answers given against it, and the errors they carry.
+ * Declares the contract a form exposes: the state it holds and the calls that move it.
  *
  * @remarks
  * `valid` is true when the last completed evaluation found no error, and `dirty` is true once
@@ -787,7 +799,7 @@ export declare interface FormInterface {
      */
     field(name: string): FormField | undefined;
     /**
-     * Answers several fields at once.
+     * Answers one field, or several at once.
      *
      * @param values - The answers to write, each keyed by its field name.
      */
@@ -808,12 +820,16 @@ export declare interface FormInterface {
     /**
      * Fails a field from outside, for what the rules cannot see.
      *
+     * @remarks
+     * One field holds one external failure, so a second call replaces the first, and the failure
+     * lasts until that field is filled again or the form is cleared.
+     *
      * @param name - The field's name.
      * @param message - What to tell the person.
      */
     invalidate(name: string, message: string): void;
     /**
-     * Takes every field out of the form.
+     * Takes one field, several fields, or every field out of the form.
      *
      * @remarks
      * A disabled field is neither evaluated nor submitted. Its answer is kept, and so is any
@@ -839,7 +855,7 @@ export declare interface FormInterface {
      */
     disable(names: readonly string[]): void;
     /**
-     * Puts every field back into the form.
+     * Puts one field, several fields, or every field back into the form.
      *
      * @remarks
      * An enabled field is evaluated and submitted again, and any invalidation held while it was
@@ -869,19 +885,20 @@ export declare interface FormInterface {
      */
     submit(): FormResult;
     /**
-     * Returns every answer to {@link FormInterface.baseline}, the answers the form opened with.
+     * Returns every answer to the ones the form opened with.
      *
      * @remarks
-     * The runtime disabled overlay resets with them, so {@link FormInterface.disabled} reads the
-     * schema's declarations again.
+     * Those answers are {@link FormInterface.baseline}. The runtime disabled overlay resets with
+     * them, so {@link FormInterface.disabled} reads the schema's declarations again.
      */
     clear(): void;
     /**
      * Tears the form down, abandoning it when it has not settled.
      *
      * @remarks
-     * A request from inside a listener defers teardown until the outermost mutation batch closes,
-     * so an in-flight settlement can win and leave the form `settled` rather than `abandoned`.
+     * Tearing down twice does nothing the second time. A request from inside a listener defers
+     * teardown until the outermost mutation batch closes, so an in-flight settlement can win and
+     * leave the form `settled` rather than `abandoned`.
      */
     destroy(): void;
 }
@@ -984,7 +1001,7 @@ export declare type FormValues = Readonly<Record<string, FieldValue>>;
  *
  * @remarks
  * The prototype-safe write of {@link defineEntry}, frozen: the entry is neither writable nor
- * configurable, so the record a parser hands back cannot be edited through the key it just filled.
+ * configurable, so the record a parser hands back cannot be edited through the key it filled.
  *
  * @example
  * ```ts
@@ -995,7 +1012,7 @@ export declare type FormValues = Readonly<Record<string, FieldValue>>;
  */
 export declare function freezeEntry<T>(target: Record<string, T>, name: string, value: T): void;
 
-/** Caps the number of groups one schema may declare. */
+/** Caps the number of groups one schema may declare, at 64. */
 export declare const GROUP_LIMIT = 64;
 
 /** Matches a signed or unsigned base-ten integer string. */
@@ -1036,6 +1053,10 @@ export declare function isFieldRule(input: unknown): input is FieldRule;
 /**
  * Determines whether an unknown value has a form field value shape.
  *
+ * @remarks
+ * A string, a finite number, a boolean, and a list of strings each qualify. A number that is not
+ * finite does not, so `NaN` and `Infinity` are refused.
+ *
  * @param input - The value to inspect.
  * @returns True if the value is a field value; false otherwise.
  */
@@ -1073,6 +1094,10 @@ export declare function isFormGroup(input: unknown): input is FormGroup;
 /**
  * Determines whether an unknown value is one exact structural form schema.
  *
+ * @remarks
+ * Structure alone is read. Domain soundness — a duplicate name, a bound no answer satisfies, a
+ * breached budget — is {@link auditSchema}'s question.
+ *
  * @param input - The value to inspect.
  * @returns True if the value is a structurally valid form schema; false otherwise.
  */
@@ -1094,7 +1119,7 @@ export declare function isFormStatus(input: unknown): input is FormStatus;
  */
 export declare function isFormValues(input: unknown): input is FormValues;
 
-/** Caps the number of entries one list-valued answer may hold. */
+/** Caps the number of entries one list-valued answer may hold, at 1024. */
 export declare const LIST_LIMIT = 1024;
 
 /**
@@ -1114,6 +1139,10 @@ export declare function matchesAnswer(value: FieldValue | undefined): boolean;
 /**
  * Checks whether a value has the shape required by one field control.
  *
+ * @remarks
+ * Every write and every seeded value passes through this gate, and it reads `STRING_LIMIT` and
+ * `LIST_LIMIT` before it consults the control, so no regular expression sees an over-long value.
+ *
  * @param field - The field that owns the value.
  * @param value - The unknown value to inspect.
  * @returns True if the control can hold the value; false otherwise.
@@ -1138,10 +1167,10 @@ export declare function matchesValue(a: FieldValue, b: FieldValue): boolean;
  */
 export declare function matchesValues(a: FormValues, b: FormValues): boolean;
 
-/** Caps the length, in UTF-16 code units, of a schema, group, or field name. */
+/** Caps the length, in UTF-16 code units, of a schema, group, or field name, at 128. */
 export declare const NAME_LIMIT = 128;
 
-/** Caps the total number of records, arrays, and leaves one schema retains. */
+/** Caps the total number of records, arrays, and leaves one schema retains, at 16384. */
 export declare const NODE_LIMIT = 16384;
 
 /** Represents a number. */
@@ -1162,6 +1191,10 @@ export declare function parseForm(input: unknown): FormSchema | undefined;
 /**
  * Parses one answer against its field control.
  *
+ * @remarks
+ * A numeric string coerces to a number for a `number` field, and `'true'` and `'false'` coerce to
+ * a boolean for a `confirm` field. Every other value must already have its control's shape.
+ *
  * @param field - The field that defines the accepted value.
  * @param input - The unknown value to parse.
  * @returns The typed or lexically coerced field value, or `undefined` on refusal.
@@ -1189,7 +1222,7 @@ export declare interface PasswordField extends FieldBase {
     readonly mask?: string;
 }
 
-/** Caps the accepted source length for an authored regular expression. */
+/** Caps the accepted source length for an authored regular expression, at 256. */
 export declare const PATTERN_LIMIT = 256;
 
 /** Holds the default failure copy for every named field rule. */
@@ -1219,10 +1252,10 @@ export declare interface SelectField extends FieldBase {
  */
 export declare function serializeForm(schema: FormSchema): JSONRecord;
 
-/** Caps the length, in UTF-16 code units, of any single retained string. */
+/** Caps the length, in UTF-16 code units, of any single retained string, at 65536. */
 export declare const STRING_LIMIT = 65536;
 
-/** Caps the total length, in UTF-16 code units, of every string one schema retains. */
+/** Caps the total length, in UTF-16 code units, of every string one schema retains, at 1048576. */
 export declare const TEXT_LIMIT = 1048576;
 
 /** Represents a single line of text. */
@@ -1235,7 +1268,7 @@ export declare interface TextField extends FieldBase {
 /** Matches a 24-hour time string with optional seconds. */
 export declare const TIME_PATTERN: Readonly<RegExp>;
 
-/** Represents a time of day, held as the control's own string. */
+/** Represents a time of day, held as the control's own `HH:MM` string, with seconds optional. */
 export declare interface TimeField extends FieldBase {
     readonly control: 'time';
     readonly default?: string;