@dxos/react-ui-form 0.8.4-main.c1de068 → 0.8.4-main.c85a9c8dae

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

@@ -0,0 +1,82 @@
+import type * as Schema from 'effect/Schema';
+import type * as SchemaAST from 'effect/SchemaAST';
+import { type AnyProperties } from '@dxos/echo/internal';
+import { type JsonPath } from '@dxos/effect';
+import { type ValidationError } from '@dxos/schema';
+import { type MaybePromise } from '@dxos/util';
+export type FormFieldStatus = {
+    status?: 'error';
+    error?: string;
+};
+/**
+ * Form properties.
+ */
+export interface FormHandlerProps<T extends AnyProperties> {
+    /**
+     * Effect schema (Type literal).
+     */
+    schema?: Schema.Schema<T, any>;
+    /**
+     * Values for the form if controlled.
+     */
+    values?: Partial<T>;
+    /**
+     * Default values for the form which will be used if values is not provided.
+     */
+    defaultValues?: Partial<T>;
+    /**
+     * Auto-save the form when the values change.
+     */
+    autoSave?: boolean;
+    /**
+     * Callback for value changes. Note: This is called even when values are invalid.
+     * Sometimes the parent component may want to know about changes even if the form is
+     * in an invalid state.
+     */
+    onValuesChanged?: (values: Partial<T>, meta: FormUpdateMeta<T>) => void;
+    /**
+     * Custom validation function that runs only after schema validation passes.
+     * Use this for complex validation logic that can't be expressed in the schema.
+     * @returns Array of validation errors, or undefined if validation passes
+     */
+    onValidate?: (values: T) => ValidationError[] | undefined;
+    /**
+     * Called when the form is submitted and passes validation.
+     */
+    onSave?: (values: T, meta: FormUpdateMeta<T>) => MaybePromise<void>;
+    /**
+     * Called when the form is canceled.
+     */
+    onCancel?: () => void;
+}
+export type FormUpdateMeta<T extends AnyProperties> = {
+    changed: FormHandler<T>['changed'];
+    isValid: boolean;
+};
+/**
+ * Form handler properties and methods.
+ */
+export type FormHandler<T extends AnyProperties> = Pick<FormHandlerProps<T>, 'schema' | 'autoSave'> & {
+    /** Initial values (which may not pass validation). */
+    values: Partial<T>;
+    /** Map of changed fields. */
+    changed: Record<JsonPath, boolean>;
+    touched: Record<JsonPath, boolean>;
+    /** Map of error strings. */
+    errors: Record<JsonPath, string>;
+    /** Whether the form can be saved (i.e., data is valid). */
+    isValid: boolean;
+    canSave: boolean;
+    onSave: () => void;
+    onCancel: () => void;
+    getStatus: (path: string | (string | number)[]) => FormFieldStatus;
+    getValue: <V>(path: (string | number)[]) => V | undefined;
+    onBlur: (path: (string | number)[]) => void;
+    onValueChange: <V>(path: (string | number)[], type: SchemaAST.AST, value: V) => void;
+};
+/**
+ * Creates a hook for managing form state, including values, validation, and submission.
+ * Deeply integrated with `@dxos/schema` for schema-based validation.
+ */
+export declare const useFormHandler: <T extends AnyProperties>({ schema, autoSave, values: valuesProp, defaultValues: defaultValuesProp, onValuesChanged, onValidate, onSave, onCancel, ...props }: FormHandlerProps<T>) => FormHandler<T>;
+//# sourceMappingURL=useFormHandler.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useFormHandler.d.ts","sourceRoot":"","sources":["../../../../src/hooks/useFormHandler.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,KAAK,SAAS,MAAM,kBAAkB,CAAC;AAGnD,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,KAAK,QAAQ,EAAmE,MAAM,cAAc,CAAC;AAG9G,OAAO,EAAE,KAAK,eAAe,EAAkB,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,aAAa;IACvD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAExE;;;;OAIG;IACH,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,eAAe,EAAE,GAAG,SAAS,CAAC;IAE1D;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;IAEpE;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;CACvB;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,aAAa,IAAI;IACpD,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACnC,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,aAAa,IAAI,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC,GAAG;IACpG,sDAAsD;IACtD,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAEnB,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAEnC,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAEnC,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAEjC,2DAA2D;IAC3D,OAAO,EAAE,OAAO,CAAC;IAEjB,OAAO,EAAE,OAAO,CAAC;IAEjB,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,QAAQ,EAAE,MAAM,IAAI,CAAC;IAMrB,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAK,eAAe,CAAC;IACnE,QAAQ,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC;IAC1D,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAK,IAAI,CAAC;IAC5C,aAAa,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;CACtF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,aAAa,EAAE,qIAUrD,gBAAgB,CAAC,CAAC,CAAC,KAAG,WAAW,CAAC,CAAC,CA8NrC,CAAC"}

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

@@ -0,0 +1,6 @@
+import { type FormHandler } from './useFormHandler';
+/**
+ * Key handler.
+ */
+export declare const useKeyHandler: (formElement: HTMLDivElement | null, form: FormHandler<any>) => void;
+//# sourceMappingURL=useKeyHandler.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useKeyHandler.d.ts","sourceRoot":"","sources":["../../../../src/hooks/useKeyHandler.tsx"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;GAEG;AACH,eAAO,MAAM,aAAa,GAAI,aAAa,cAAc,GAAG,IAAI,EAAE,MAAM,WAAW,CAAC,GAAG,CAAC,SAuBvF,CAAC"}

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

@@ -1,11 +1,11 @@
-export declare const translationKey = "react-ui-form";
+export declare const translationKey = "@dxos/react-ui-form";
 export declare const translations: [{
     readonly 'en-US': {
-        readonly "react-ui-form": {
+        readonly "@dxos/react-ui-form": {
             readonly 'fields label': "Fields";
             readonly 'hidden fields label': "Hidden Fields";
             readonly 'empty readonly ref field label': "(none)";
-            readonly 'button add property': "Add property";
+            readonly 'add property button label': "Add property";
             readonly 'field property label': "Property";
             readonly 'field property placeholder': "Property name";
             readonly 'field format label': "Type";
@@ -15,8 +15,17 @@ export declare const translations: [{
             readonly 'field limit reached': "Maximum number of fields reached";
             readonly 'boolean input true value': "Yes";
             readonly 'boolean input false value': "No";
-            readonly 'button cancel': "Cancel";
-            readonly 'button save': "Save";
+            readonly 'show field label': "Show field";
+            readonly 'hide field label': "Hide field";
+            readonly 'delete field label': "Delete field";
+            readonly 'ref field combobox input placeholder': "Search…";
+            readonly 'ref field placeholder_one': "Select…";
+            readonly 'ref field placeholder_other': "Select items…";
+            readonly 'example placeholder': "Example";
+            readonly 'latitude placeholder': "Latitude (e.g., 40.7128)";
+            readonly 'longitude placeholder': "Longitude (e.g., -74.0060)";
+            readonly 'cancel button label': "Cancel";
+            readonly 'save button label': "Save";
             readonly 'format boolean': "Boolean";
             readonly 'format currency': "Currency";
             readonly 'format date': "Date";
@@ -29,7 +38,7 @@ export declare const translations: [{
             readonly 'format hostname': "Hostname";
             readonly 'format integer': "Integer";
             readonly 'format json': "JSON";
-            readonly 'format latlng': "Geopoint";
+            readonly 'format lnglat': "Geopoint";
             readonly 'format markdown': "Markdown";
             readonly 'format percent': "Percent";
             readonly 'format ref': "Reference";
@@ -45,15 +54,15 @@ export declare const translations: [{
             readonly 'format uri': "URI";
             readonly 'format url': "URL";
             readonly 'format uuid': "UUID";
-            readonly 'placeholder latitude': "Latitude";
-            readonly 'placeholder longitude': "Longitude";
+            readonly 'latitude label': "Latitude";
+            readonly 'longitude label': "Longitude";
             readonly 'select option label': "Label";
             readonly 'select option label placeholder': "Option label";
             readonly 'select option color': "Color";
             readonly 'select option delete': "Delete";
             readonly 'select option add': "Add option";
-            readonly 'system schema title': "System Schema";
-            readonly 'system schema description': "This is a system schema and cannot be modified.";
+            readonly 'system schema title': "System type";
+            readonly 'system schema description': "System type: cannot add or remove fields.";
         };
     };
 }];

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

@@ -1 +1 @@
-{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../src/translations.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,cAAc,kBAAkB,CAAC;AAE9C,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAuEM,CAAC"}
+{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../src/translations.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,cAAc,wBAAwB,CAAC;AAEpD,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgFM,CAAC"}

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

@@ -1,4 +1,4 @@
-import { FormatEnum, TypeEnum } from '@dxos/echo-schema';
+import { Format, TypeEnum } from '@dxos/echo/internal';
 import { type ValidationError } from '@dxos/schema';
 /**
  * Parse value by field value type.
@@ -8,13 +8,13 @@ import { type ValidationError } from '@dxos/schema';
  */
 export type ParseProps = {
     type?: TypeEnum;
-    format?: FormatEnum;
+    format?: Format.TypeFormat;
     value: any;
 };
 export declare const parseValue: ({ type, format, value }: ParseProps) => any;
 export type CellClassesForFieldTypeProps = {
     type?: TypeEnum;
-    format?: FormatEnum;
+    format?: Format.TypeFormat;
 };
 export declare const cellClassesForFieldType: ({ type, format }: CellClassesForFieldTypeProps) => string[] | undefined;
 export declare const pathNotUniqueError: (path: string) => ValidationError;

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

@@ -1 +1 @@
-{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../../../src/util/field.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAe,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,KAAK,EAAE,GAAG,CAAC;CACZ,CAAC;AAEF,eAAO,MAAM,UAAU,GAAI,yBAAyB,UAAU,QAsF7D,CAAC;AAGF,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,MAAM,CAAC,EAAE,UAAU,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAAI,kBAAkB,4BAA4B,KAAG,MAAM,EAAE,GAAG,SAmCnG,CAAC;AAGF,eAAO,MAAM,kBAAkB,GAAI,MAAM,MAAM,KAAG,eAGhD,CAAC"}
+{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../../../src/util/field.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAe,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAC3B,KAAK,EAAE,GAAG,CAAC;CACZ,CAAC;AAEF,eAAO,MAAM,UAAU,GAAI,yBAAyB,UAAU,QAsF7D,CAAC;AAGF,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAAI,kBAAkB,4BAA4B,KAAG,MAAM,EAAE,GAAG,SAyBnG,CAAC;AAGF,eAAO,MAAM,kBAAkB,GAAI,MAAM,MAAM,KAAG,eAGhD,CAAC"}

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

@@ -1,7 +1,7 @@
-import { FormatEnum, TypeEnum } from '@dxos/echo-schema';
+import { Format, TypeEnum } from '@dxos/echo/internal';
 type ValueFormatProps = {
     type: TypeEnum;
-    format?: FormatEnum | undefined;
+    format?: Format.TypeFormat | undefined;
     value: any;
     locale?: string | undefined;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"formatting.d.ts","sourceRoot":"","sources":["../../../../src/util/formatting.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAe,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAEtE,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAChC,KAAK,EAAE,GAAG,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF;;;GAGG;AAGH,eAAO,MAAM,gBAAgB,GAAI,iCAA6C,gBAAgB,KAAG,MAqFhG,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,iCAA6C,gBAAgB,KAAG,MA8DhG,CAAC"}
+{"version":3,"file":"formatting.d.ts","sourceRoot":"","sources":["../../../../src/util/formatting.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,MAAM,EAAe,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEpE,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,SAAS,CAAC;IACvC,KAAK,EAAE,GAAG,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF;;;GAGG;AAGH,eAAO,MAAM,gBAAgB,GAAI,iCAA6C,gBAAgB,KAAG,MAqFhG,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,iCAA6C,gBAAgB,KAAG,MA8DhG,CAAC"}

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

@@ -1,5 +1,5 @@
 export * from './field';
 export * from './formatting';
+export * from './properties';
 export * from './refs';
-export * from './schema';
 //# 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,QAAQ,CAAC;AACvB,cAAc,UAAU,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,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC"}

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

@@ -0,0 +1,7 @@
+import type * as SchemaAST from 'effect/SchemaAST';
+import { type SchemaProperty } from '@dxos/effect';
+/**
+ * Get the property types of an AST and filter out properties that are not form inputs.
+ */
+export declare const getFormProperties: (ast: SchemaAST.AST) => SchemaProperty[];
+//# sourceMappingURL=properties.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"properties.d.ts","sourceRoot":"","sources":["../../../../src/util/properties.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,KAAK,SAAS,MAAM,kBAAkB,CAAC;AAGnD,OAAO,EAAE,KAAK,cAAc,EAAiB,MAAM,cAAc,CAAC;AAElE;;GAEG;AACH,eAAO,MAAM,iBAAiB,GAAI,KAAK,SAAS,CAAC,GAAG,KAAG,cAAc,EAIpE,CAAC"}

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

@@ -1,9 +1,8 @@
-import { type SchemaAST } from 'effect';
-import { type SchemaProperty } from '@dxos/schema';
+import type * as SchemaAST from 'effect/SchemaAST';
 type RefProps = {
     ast: SchemaAST.AST;
     isArray: boolean;
 };
-export declare const getRefProps: (property: SchemaProperty<any>) => RefProps | undefined;
+export declare const getRefProps: (ast: SchemaAST.AST) => RefProps | undefined;
 export {};
 //# sourceMappingURL=refs.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"refs.d.ts","sourceRoot":"","sources":["../../../../src/util/refs.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,QAAQ,CAAC;AAIxC,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,cAAc,CAAC;AAInD,KAAK,QAAQ,GAAG;IACd,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,eAAO,MAAM,WAAW,GAAI,UAAU,cAAc,CAAC,GAAG,CAAC,KAAG,QAAQ,GAAG,SAoBtE,CAAC"}
+{"version":3,"file":"refs.d.ts","sourceRoot":"","sources":["../../../../src/util/refs.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,SAAS,MAAM,kBAAkB,CAAC;AAKnD,KAAK,QAAQ,GAAG;IACd,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,eAAO,MAAM,WAAW,GAAI,KAAK,SAAS,CAAC,GAAG,KAAG,QAAQ,GAAG,SAiB3D,CAAC"}