@dxos/react-ui-form 0.9.0 → 0.9.1-staging.ee54ba693a

package/dist/types/src/types.d.ts

@@ -0,0 +1,161 @@
+import type * as Schema from 'effect/Schema';
+import type * as SchemaAST from 'effect/SchemaAST';
+import { type FC, type FocusEvent, type ReactElement } from 'react';
+import { type Database, type Entity, type Format, type Obj, type Type } from '@dxos/echo';
+import { type URI } from '@dxos/keys';
+import { type Palette } from '@dxos/react-ui';
+import { type ProjectionModel } from '@dxos/schema';
+/**
+ * Validation status of a field.
+ */
+export type FormFieldStatus = {
+    status?: 'error';
+    error?: string;
+};
+/**
+ * FormPresentation mode.
+ * - full: Show label, control, and status.
+ * - compact: Show label and control.
+ * - inline: Control only.
+ * - static: Plain DOM; omit all undefined values.
+ */
+export type FormPresentation = 'full' | 'compact' | 'inline' | 'static';
+/**
+ * Dynamic props passed to input components.
+ */
+export type FormFieldStateProps<T = any> = {
+    getStatus: () => FormFieldStatus;
+    getValue: () => T | undefined;
+    onBlur: (event: FocusEvent<HTMLElement>) => void;
+    onValueChange: (type: SchemaAST.AST, value: T) => void;
+};
+/**
+ * Props passed to input components.
+ */
+export type FormFieldRendererProps<T = any> = {
+    /** Database the form is editing against; populated for fields whose value is an ECHO object/Ref. */
+    db?: Database.Database;
+    type: SchemaAST.AST;
+    format?: Format.TypeFormat;
+    readonly?: boolean;
+    label: string;
+    /**
+     * Human-readable description (from the schema's description annotation). Rendered as visible text
+     * only when the resolved presentation opts in; otherwise it falls back to the input placeholder.
+     */
+    description?: string;
+    /**
+     * Dotted JSON path of this field within the form values (e.g. `runtime.client.storage.persistent`).
+     */
+    jsonPath?: string;
+    placeholder?: string;
+    autoFocus?: boolean;
+    /** Presentation mode for the field (full/compact/inline/static); see {@link FormPresentation}. */
+    presentation?: FormPresentation;
+    /** Whether the field is required (non-optional in the schema); surfaces a trailing asterisk on the label. */
+    required?: boolean;
+} & FormFieldStateProps<T>;
+export type FormFieldRenderer = FC<FormFieldRendererProps>;
+export type FormFieldMap = Record<string, FormFieldRenderer>;
+export type FormFieldProvider = (props: {
+    prop: string;
+    schema: Schema.Schema<any>;
+    fieldProps: FormFieldRendererProps;
+}) => ReactElement | null | undefined;
+/**
+ * Per-typename override for the ref-field inline create form and its submission handler.
+ * The type parameter S links the form schema's decoded type to the createObject values argument,
+ * ensuring the schema and the handler agree on the shape of the form data.
+ */
+export type CreateEntryOverride<S extends Schema.Schema.AnyNoContext = Schema.Schema.AnyNoContext> = {
+    /** Replaces the raw ECHO type schema for the inline create form. */
+    inputSchema?: S;
+    /** Runs instead of the default onCreate(schema, values) path; values are typed from inputSchema. */
+    createObject?: (values: Schema.Schema.Type<S>, db: Database.Database) => Promise<Obj.Unknown>;
+};
+/**
+ * Configuration for the inline "create a new referenced object" affordance, shared by every
+ * surface that can spawn a ref target (the picker, `RefField`, and the `Form*` props that forward
+ * to them). `onCreate` is intentionally NOT part of this group: its signature differs per consumer
+ * (the picker takes `(values)`, `RefField` takes `(schema, values)`).
+ */
+export type CreateOptions = {
+    createOptionLabel?: [string, {
+        ns: string | readonly string[];
+    }];
+    createOptionIcon?: string;
+    createInitialValuePath?: string;
+    createFieldMap?: FormFieldMap;
+};
+export type RefOption = {
+    id: string;
+    label: string;
+    /** Optional secondary line shown beneath the label in the picker list. */
+    description?: string;
+    hue?: Palette;
+};
+/**
+ * Data plumbing for resolving and creating ref targets: how to look up the ref type, query
+ * candidate objects, map them to options, and persist a newly-created one.
+ */
+export type RefFieldDataProps = {
+    useType?: (db?: Database.Database, typeUri?: URI.URI) => Type.AnyEntity;
+    useResults?: (db?: Database.Database, typename?: string) => Entity.Any[];
+    getOptions?: (objects: Entity.Any[], options?: {
+        parentLabel?: boolean;
+        getTypePlaceholder?: (typename: string) => string;
+    }) => RefOption[];
+    /**
+     * Persist a newly-created object. Called after the user fills out the inline create form and
+     * clicks Save. Should add the object to the database and return it (sync or async). The returned
+     * object is then wired into this slot's form value as a Ref.
+     */
+    onCreate?: (schema: Type.AnyEntity, values: any) => Obj.Unknown | Promise<Obj.Unknown> | undefined | void;
+    /**
+     * Supply default values for a newly-created owned object when the user clicks "add" on an owned-ref
+     * array field (see `FormCreateAnnotation`). Keyed by the field's json path so a container can pre-populate
+     * the new object (e.g. a back-reference to the parent). The returned values are passed to
+     * `onCreate(schema, values)` before the object is persisted.
+     */
+    getCreateDefaults?: (props: {
+        jsonPath: string;
+        schema: Type.AnyEntity;
+    }) => Record<string, unknown> | undefined;
+    /**
+     * Optional resolver that maps a ref's typename to a {@link CreateEntryOverride}, replacing the
+     * raw ECHO type schema and/or the default `onCreate` path with plugin-registered create logic
+     * (e.g. `SpaceCapabilities.CreateObjectEntry`). When absent or returning `undefined` for a given
+     * typename the existing fallback behaviour is preserved.
+     */
+    resolveCreateEntry?: (typename: string) => CreateEntryOverride | undefined;
+};
+/**
+ * Form-wide field options carried by the form context and threaded down to every field. The
+ * canonical source for the config that `FormContextValue`, `FormFieldProps`, and `FormFieldSetProps`
+ * all share — so none of them has to reach "up" into another's props to express it.
+ */
+export type FormFieldOptions = {
+    db?: Database.Database;
+    readonly?: boolean;
+    layout?: FormPresentation;
+    projection?: ProjectionModel;
+    fieldMap?: FormFieldMap;
+    fieldProvider?: FormFieldProvider;
+    /**
+     * Typename of the ref type that the create props apply to.
+     * When set, the create affordance is only offered to ref fields whose typename matches.
+     */
+    createTypename?: string;
+};
+/**
+ * The subset of {@link RefFieldDataProps} that is forwarded down the field recursion. `useResults`
+ * is consumed only by `RefField` itself (it defaults internally), so it is not threaded.
+ */
+export type RefThreadedProps = Pick<RefFieldDataProps, 'useType' | 'getOptions' | 'onCreate' | 'getCreateDefaults' | 'resolveCreateEntry'>;
+/**
+ * Form-wide configuration threaded unchanged down the entire field recursion. This is the single
+ * canonical source for the bag that `FormContextValue`, `FormFieldProps`, and `FormFieldSetProps`
+ * all carry — so none of them re-Picks fragments of the others.
+ */
+export type FieldContext = FormFieldOptions & CreateOptions & RefThreadedProps;
+//# sourceMappingURL=types.d.ts.map

package/dist/types/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,KAAK,SAAS,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,KAAK,EAAE,EAAE,KAAK,UAAU,EAAE,KAAK,YAAY,EAAE,MAAM,OAAO,CAAC;AAEpE,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,MAAM,EAAE,KAAK,MAAM,EAAE,KAAK,GAAG,EAAE,KAAK,IAAI,EAAE,MAAM,YAAY,CAAC;AAC1F,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,cAAc,CAAC;AAMpD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,GAAG,IAAI;IACzC,SAAS,EAAE,MAAM,eAAe,CAAC;IACjC,QAAQ,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAC9B,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;IACjD,aAAa,EAAE,CAAC,IAAI,EAAE,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,GAAG,IAAI;IAC5C,oGAAoG;IACpG,EAAE,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;IACvB,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,kGAAkG;IAClG,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,6GAA6G;IAC7G,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;AAE3B,MAAM,MAAM,iBAAiB,GAAG,EAAE,CAAC,sBAAsB,CAAC,CAAC;AAE3D,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAE7D,MAAM,MAAM,iBAAiB,GAAG,CAAC,KAAK,EAAE;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC3B,UAAU,EAAE,sBAAsB,CAAC;CACpC,KAAK,YAAY,GAAG,IAAI,GAAG,SAAS,CAAC;AAMtC;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,IAAI;IACnG,oEAAoE;IACpE,WAAW,CAAC,EAAE,CAAC,CAAC;IAChB,oGAAoG;IACpG,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,QAAQ,CAAC,QAAQ,KAAK,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;CAC/F,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE;QAAE,EAAE,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;IACjE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,cAAc,CAAC,EAAE,YAAY,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,0EAA0E;IAC1E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,OAAO,CAAC;CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAE9B,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,SAAS,CAAC;IACxE,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;IACzE,UAAU,CAAC,EAAE,CACX,OAAO,EAAE,MAAM,CAAC,GAAG,EAAE,EACrB,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAC;QAAC,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAA;KAAE,KACnF,SAAS,EAAE,CAAC;IACjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,KAAK,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC;IAC1G;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAA;KAAE,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IACjH;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,mBAAmB,GAAG,SAAS,CAAC;CAC5E,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CACjC,iBAAiB,EACjB,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,mBAAmB,GAAG,oBAAoB,CACnF,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,gBAAgB,GAAG,aAAa,GAAG,gBAAgB,CAAC"}

package/dist/types/src/util/index.d.ts

@@ -1,6 +1,6 @@
 export * from './field';
-export * from './field-type';
 export * from './formatting';
+export * from './omit';
 export * from './properties';
 export * from './refs';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/util/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/util/index.ts"],"names":[],"mappings":"AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/util/index.ts"],"names":[],"mappings":"AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC"}

package/dist/types/src/util/omit.d.ts

@@ -0,0 +1,12 @@
+import * as Schema from 'effect/Schema';
+import { Type } from '@dxos/echo';
+export type ExcludeId<S extends Schema.Schema.AnyNoContext | Type.AnyEntity> = S extends Type.AnyEntity ? Omit<Type.InstanceType<S>, 'id'> : S extends Schema.Schema.AnyNoContext ? Omit<Schema.Schema.Type<S>, 'id'> : never;
+export declare const omitId: <S extends Schema.Schema.AnyNoContext | Type.AnyEntity>(schemaOrType: S) => Schema.Schema<ExcludeId<S>, ExcludeId<S>>;
+/**
+ * Drop fields annotated with `FormInputAnnotation.set(false)` from a schema so
+ * the form's validator doesn't trip on required-but-hidden fields. Used by
+ * the picker's inline create form, where a `FactoryAnnotation` typically
+ * supplies the hidden values (e.g. a backing-object Ref) outside the form.
+ */
+export declare const omitHiddenFormFields: <S extends Schema.Schema.AnyNoContext>(schema: S) => S;
+//# sourceMappingURL=omit.d.ts.map

package/dist/types/src/util/omit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"omit.d.ts","sourceRoot":"","sources":["../../../../src/util/omit.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,EAAc,IAAI,EAAE,MAAM,YAAY,CAAC;AAK9C,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,GACnG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GAChC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,GAClC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GACjC,KAAK,CAAC;AAGZ,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,gBAC5D,CAAC,KACd,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAO1C,CAAC;AAiBF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,UAAU,CAAC,KAAG,CAQtF,CAAC"}