Package exports

mlform has nine entry points. Import from the root unless you need one layer on its own; internal paths are not part of the public API. The value lists below are read from the modules when these docs are built.

Entry point	Use it for
mlform, mlform/kit	The complete form: mountForm, built-in UI, lifecycle, design attachment. Both resolve to the same module.
mlform/view	Headless layout, navigation, descriptors, and declarative extensions.
mlform/runtime	Form state, validation, conditions, submission, pipelines, and errors without UI.
mlform/schema	Schema types, normalization and validation, mappedTo helpers, registries, JSON Schema.
mlform/builtins	Built-in field and report definitions, their registry, and series helpers.
mlform/transport	The transport contract, fan-out, request runner, and transport errors.
mlform/primitives	The Web Components, their base classes, registries, and low-level mounting.
mlform/design	Themes, recipes, tokens, resolution, and attachment to any element.

mlform and mlform/kit

createPrimitiveAdapter defaultKitDesignSystem defaultKitLabels mountForm unmountForm

Types: MountFormOptions, MountedForm, KitLabels, KitDesignSystemSnapshot, PrimitiveAdapter, PrimitiveAdapterOptions. See mountForm.

mlform/view

collectLayoutReferences createBuiltinDescriptorRegistry createFormView defineFieldKind defineMLFormPlugin defineReportKind flattenLayoutNodes walkLayoutNodes

Types: CreateFormViewOptions, FormViewController, FormViewSnapshot, FormViewState, FormViewFieldItem, FormViewReportItem, FormViewNavigationController, FormViewDisclosureController, WizardState, TabsState, DisclosureState, PanelState, ReportFetchMode, the layout types (FormLayoutConfig, WizardLayoutConfig, TabsLayoutConfig, FormLayoutNode and each node type, and their Resolved… forms), LayoutReferences, and the extension types (MLFormPlugin, MLFormFieldKind, MLFormReportKind, DeclarativeFieldKind, DeclarativeReportKind, DefinedFieldKind, DefinedReportKind, ReportRenderSpec, ReportRenderSpecContext, ReportMountContext, ReportMountCleanup). See createFormView.

mlform/runtime

createForm createMultiBackendSubmissionSnapshot createSubmissionSnapshot EngineError executeFormPipeline executeMultiBackendPipeline executeReportFetches RegistryError removeFormSnapshot ReportPayloadError restoreFormSnapshot saveFormSnapshot shallowEquality SubmissionAbortedError SubmitError TransportError transportErrorCodes ValidationError

Types include CreateFormConfig, FormController, FieldController, ReportController, FormState, FieldStateSnapshot, ReportStateSnapshot, FormHooks and the hook contexts, FormValidator, FormValidationResult, SubmitOptions, SubmitRequest, SubmitResult, Transport, TransportResponse, ReportResult, ReportContext, FormSnapshot, FormPersistenceAdapter, FormTransition, RuntimeBehavior, the condition types, and the pipeline and multi-backend option and result types. See Form controller.

mlform/schema

baseFieldConfigSchema baseReportConfigSchema createRegistry createReportContexts createReportFetchRequest defineFieldDefinition defineReportDefinition findUnknownKinds getReportContext mappedToKey mappedToSchema normalizeSchema normalizeSchemaId normalizeSubmissionPath RegistryError resolveMappedReportPayload resolveMappedReportResult resolveMappedRoutes resolveMappedTargets resolveMappedTo SchemaNormalizationError toSchemaJsonSchema validateSchema

Types: FormSchema, NormalizedFormSchema, FieldConfig, BaseFieldConfig, ReportConfig, BaseReportConfig, FieldDefinition, ReportDefinition, Registry, MappedTo, MappedToTarget, SubmissionInputRecord, ReportResult, ReportContext, SubmitResult, SchemaValidationResult, SchemaValidationIssue, UnknownSchemaKind, and the condition and definition context types. See Schema.

mlform/builtins

booleanFieldDefinition builtinFieldDefinitions builtinFieldKinds builtinReportDefinitions builtinReportFallbacks builtinReportKinds builtinReportLabels builtinValidationMessages calculateSeriesAggregation categoryFieldDefinition classifierReportDefinition createBuiltinMlRegistry dateFieldDefinition getSeriesCellErrors longTextFieldDefinition mappedCategoryFieldDefinition multiChoiceFieldDefinition numberFieldDefinition oneHotCategoryFieldDefinition ratingFieldDefinition regressorReportDefinition resolveOneHotDisplayValue seriesFieldDefinition singleChoiceFieldDefinition textFieldDefinition

Types: BuiltinFieldConfig, BuiltinReportConfig, SeriesFieldConfig, SeriesColumnConfig, SeriesPoint, SeriesAggregation, OneHotCategoryFieldConfig, OneHotCategoryOption. See Field kinds and Series.

mlform/transport

createFanoutTransport createTransportRequestRunner extractErrorMessage TransportError transportErrorCodes

Types: Transport, SubmitRequest, TransportResponse, CreateFanoutTransportOptions, FanoutOutcome. See Transports.

mlform/primitives

createBuiltinPrimitiveRegistry createPrimitiveDescriptorRegistry createPrimitiveRegistry executePrimitiveSubmit focusPrimitiveField mountPrimitiveForm PrimitiveAsyncReportElement primitiveDefaultLabels PrimitiveDescriptorRegistry PrimitiveFieldElement PrimitiveFormElement PrimitiveReportElement primitiveStaticText primitiveTagNames resolvePrimitiveText toDescriptorNodes unmountPrimitiveForm

Types: PrimitiveRegistry, PrimitiveText, PrimitiveTextOverrides, PrimitiveLayout, PrimitiveContainerStrategy, the render contexts, the submit event details, PrimitiveReportRequest, PrimitiveReportTransport, and the descriptor types (FieldDescriptor, ReportDescriptor, FieldPresenter, ReportPresenter, DescriptorNode…). See Primitives and events.

mlform/design

applyResolvedDesignSystem attachDesignSystem builtinDesignSystemRegistry builtinRecipes builtinThemes componentKeys componentTokenDefaults createBuiltinDesignSystemRegistry createDesignSystemRegistry createDesignSystemStylesheet createResolvedDesignSystemSignature defineComponentTokens defineGlobalTokens defineRecipe defineTheme DesignSystemController getResolvedDesignSystemHostAttributes globalTokenDefaults hydrateDesignSystem mergeDesignSystemConfig migrateThemeTokens migrateTokens mlfTokenKeys resolveDesignSystem writeDesignSystemTokenDeclarations

Types: DesignSystemConfig, ThemeManifest, RecipeManifest, ThemeVariant, ResolvedDesignSystem, DesignSystemWarning, DesignSystemRegistry, AttachedDesignSystem, AttachDesignSystemOptions, Density, Motion, DesignSystemMode, TokenMap, GlobalTokenMap, ComponentTokenMap, ComponentKey, MlfTokenKey. See Themes and recipes.