@bpmn-io/form-js-viewer 1.1.0 → 1.3.0-alpha.0

package/dist/types/Form.d.ts

@@ -139,6 +139,10 @@ export default class Form {
      * @internal
      */
     _applyConditions(toFilter: any, data: any): any;
+    /**
+     * @internal
+     */
+    _initializeFieldData(data: any): any;
 }
 export type Injector = import('./types').Injector;
 export type Data = import('./types').Data;

package/dist/types/core/FieldFactory.d.ts

@@ -0,0 +1,19 @@
+declare class FieldFactory {
+    /**
+     * @constructor
+     *
+     * @param  formFieldRegistry
+     * @param  formFields
+     */
+    constructor(formFieldRegistry: any, pathRegistry: any, formFields: any);
+    _formFieldRegistry: any;
+    _pathRegistry: any;
+    _formFields: any;
+    create(attrs: any, applyDefaults?: boolean): any;
+    _ensureId(field: any): void;
+    _ensureKey(field: any): void;
+}
+declare namespace FieldFactory {
+    const $inject: string[];
+}
+export default FieldFactory;

package/dist/types/core/FormFieldRegistry.d.ts

@@ -3,7 +3,6 @@ declare class FormFieldRegistry {
     _eventBus: any;
     _formFields: {};
     _ids: any;
-    _keys: any;
     add(formField: any): void;
     remove(formField: any): void;
     get(id: any): any;

package/dist/types/core/Importer.d.ts

@@ -0,0 +1,56 @@
+declare class Importer {
+    /**
+     * @constructor
+     * @param { import('./FormFieldRegistry').default } formFieldRegistry
+     * @param { import('./PathRegistry').default } pathRegistry
+     * @param { import('./FieldFactory').default } fieldFactory
+     * @param { import('./FormLayouter').default } formLayouter
+     */
+    constructor(formFieldRegistry: import('./FormFieldRegistry').default, pathRegistry: import('./PathRegistry').default, fieldFactory: import('./FieldFactory').default, formLayouter: import('./FormLayouter').default);
+    _formFieldRegistry: import("./FormFieldRegistry").default;
+    _pathRegistry: import("./PathRegistry").default;
+    _fieldFactory: import("./FieldFactory").default;
+    _formLayouter: import("./FormLayouter").default;
+    /**
+     * Import schema creating rows, fields, attaching additional
+     * information to each field and adding fields to the
+     * field registry.
+     *
+     * Additional information attached:
+     *
+     *   * `id` (unless present)
+     *   * `_parent`
+     *   * `_path`
+     *
+     * @param {any} schema
+     *
+     * @typedef {{ warnings: Error[], schema: any }} ImportResult
+     * @returns {ImportResult}
+     */
+    importSchema(schema: any): {
+        warnings: Error[];
+        schema: any;
+    };
+    _cleanup(): void;
+    /**
+     * @param {{[x: string]: any}} fieldAttrs
+     * @param {String} [parentId]
+     * @param {number} [index]
+     *
+     * @return {any} field
+     */
+    importFormField(fieldAttrs: {
+        [x: string]: any;
+    }, parentId?: string, index?: number): any;
+    /**
+     * @param {Array<any>} components
+     * @param {string} parentId
+     *
+     * @return {Array<any>} imported components
+     */
+    importFormFields(components: Array<any>, parentId: string): Array<any>;
+}
+declare namespace Importer {
+    const $inject: string[];
+}
+export default Importer;

package/dist/types/core/PathRegistry.d.ts

@@ -0,0 +1,71 @@
+/**
+ * The PathRegistry class manages a hierarchical structure of paths associated with form fields.
+ * It enables claiming, unclaiming, and validating paths within this structure.
+ *
+ * Example Tree Structure:
+ *
+ *   [
+ *     {
+ *       segment: 'root',
+ *       claimCount: 1,
+ *       children: [
+ *         {
+ *           segment: 'child1',
+ *           claimCount: 2,
+ *           children: null  // A leaf node (closed path)
+ *         },
+ *         {
+ *           segment: 'child2',
+ *           claimCount: 1,
+ *           children: [
+ *             {
+ *               segment: 'subChild1',
+ *               claimCount: 1,
+ *               children: []  // An open node (open path)
+ *             }
+ *           ]
+ *         }
+ *       ]
+ *     }
+ *   ]
+ */
+declare class PathRegistry {
+    constructor(formFieldRegistry: any, formFields: any);
+    _formFieldRegistry: any;
+    _formFields: any;
+    _dataPaths: any[];
+    canClaimPath(path: any, closed?: boolean): boolean;
+    claimPath(path: any, closed?: boolean): void;
+    unclaimPath(path: any): void;
+    /**
+     * Applies a function (fn) recursively on a given field and its children.
+     *
+     * - `field`: Starting field object.
+     * - `fn`: Function to apply.
+     * - `context`: Optional object for passing data between calls.
+     *
+     * Stops early if `fn` returns `false`. Useful for traversing the form field tree.
+     *
+     * @returns {boolean} Success status based on function execution.
+     */
+    executeRecursivelyOnFields(field: any, fn: any, context?: {}): boolean;
+    /**
+     * Generates an array representing the binding path to an underlying data object for a form field.
+     *
+     * @param {Object} field - The field object with properties: `key`, `path`, `id`, and optionally `_parent`.
+     * @param {Object} [options={}] - Configuration options.
+     * @param {Object} [options.replacements={}] - A map of field IDs to alternative path arrays.
+     * @param {Object} [options.cutoffNode] - The ID of the parent field at which to stop generating the path.
+     *
+     * @returns {(Array<string>|undefined)} An array of strings representing the binding path, or undefined if not determinable.
+     */
+    getValuePath(field: any, options?: {
+        replacements?: any;
+        cutoffNode?: any;
+    }): (Array<string> | undefined);
+    clear(): void;
+}
+declare namespace PathRegistry {
+    const $inject: string[];
+}
+export default PathRegistry;

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

@@ -1,19 +1,23 @@
 declare namespace _default {
-    const __depends__: ({
-        importer: (string | typeof import("../import/Importer").default)[];
-    } | {
+    const __depends__: {
         __init__: string[];
         formFields: (string | typeof import("../render").FormFields)[];
         renderer: (string | typeof import("../render/Renderer").default)[];
-    })[];
+    }[];
     const eventBus: (string | typeof EventBus)[];
+    const importer: (string | typeof Importer)[];
+    const fieldFactory: (string | typeof FieldFactory)[];
     const formFieldRegistry: (string | typeof FormFieldRegistry)[];
+    const pathRegistry: (string | typeof PathRegistry)[];
     const formLayouter: (string | typeof FormLayouter)[];
     const validator: (string | typeof Validator)[];
 }
 export default _default;
+import Importer from './Importer';
+import FieldFactory from './FieldFactory';
 import FormFieldRegistry from './FormFieldRegistry';
+import PathRegistry from './PathRegistry';
 import FormLayouter from './FormLayouter';
 import EventBus from './EventBus';
 import Validator from './Validator';
-export { FormFieldRegistry, FormLayouter };
+export { Importer, FieldFactory, FormFieldRegistry, PathRegistry, FormLayouter };

package/dist/types/features/expression-language/ConditionChecker.d.ts

@@ -3,8 +3,9 @@
  * @property {string} [hide]
  */
 declare class ConditionChecker {
-    constructor(formFieldRegistry: any, eventBus: any);
+    constructor(formFieldRegistry: any, pathRegistry: any, eventBus: any);
     _formFieldRegistry: any;
+    _pathRegistry: any;
     _eventBus: any;
     /**
      * For given data, remove properties based on condition.
@@ -38,7 +39,7 @@ declare class ConditionChecker {
     _checkHideCondition(condition: Condition, data: {
         [x: string]: any;
     }): boolean;
-    _getConditions(): any;
+    _clearObjectValueRecursively(valuePath: any, obj: any): void;
 }
 declare namespace ConditionChecker {
     const $inject: string[];

package/dist/types/index.d.ts

@@ -14,6 +14,6 @@ export * from "./util";
 export * from "./features";
 export type CreateFormOptions = import('./types').CreateFormOptions;
 import Form from './Form';
-export const schemaVersion: 10;
+export const schemaVersion: 11;
 export { Form };
-export { FormFieldRegistry, FormLayouter } from "./core";
+export { FormFieldRegistry, FormLayouter, Importer, FieldFactory, PathRegistry } from "./core";

package/dist/types/render/components/form-fields/Checklist.d.ts

@@ -7,14 +7,10 @@ declare namespace Checklist {
         export const group: string;
         export const emptyValue: any[];
         export { sanitizeMultiSelectValue as sanitizeValue };
-        export function create(options?: {}): {
-            values: {
-                label: string;
-                value: string;
-            }[];
-        };
+        export { createEmptyOptions as create };
     }
 }
 export default Checklist;
 declare const type: "checklist";
 import { sanitizeMultiSelectValue } from '../util/sanitizerUtil';
+import { createEmptyOptions } from '../util/valuesUtil';

package/dist/types/render/components/form-fields/Default.d.ts

@@ -1,5 +1,5 @@
-declare function Default(props: any): import("preact").JSX.Element;
-declare namespace Default {
+declare function FormComponent(props: any): import("preact").JSX.Element;
+declare namespace FormComponent {
     namespace config {
         const type: string;
         const keyed: boolean;
@@ -10,4 +10,4 @@ declare namespace Default {
         };
     }
 }
-export default Default;
+export default FormComponent;

package/dist/types/render/components/form-fields/Group.d.ts

@@ -0,0 +1,14 @@
+declare function Group(props: any): import("preact").JSX.Element;
+declare namespace Group {
+    namespace config {
+        const type: string;
+        const pathed: boolean;
+        const label: string;
+        const group: string;
+        function create(options?: {}): {
+            components: any[];
+            showOutline: boolean;
+        };
+    }
+}
+export default Group;

package/dist/types/render/components/form-fields/Radio.d.ts

@@ -7,14 +7,10 @@ declare namespace Radio {
         export const group: string;
         export const emptyValue: any;
         export { sanitizeSingleSelectValue as sanitizeValue };
-        export function create(options?: {}): {
-            values: {
-                label: string;
-                value: string;
-            }[];
-        };
+        export { createEmptyOptions as create };
     }
 }
 export default Radio;
 declare const type: "radio";
 import { sanitizeSingleSelectValue } from '../util/sanitizerUtil';
+import { createEmptyOptions } from '../util/valuesUtil';

package/dist/types/render/components/form-fields/Select.d.ts

@@ -7,14 +7,10 @@ declare namespace Select {
         export const group: string;
         export const emptyValue: any;
         export { sanitizeSingleSelectValue as sanitizeValue };
-        export function create(options?: {}): {
-            values: {
-                label: string;
-                value: string;
-            }[];
-        };
+        export { createEmptyOptions as create };
     }
 }
 export default Select;
 declare const type: "select";
 import { sanitizeSingleSelectValue } from '../util/sanitizerUtil';
+import { createEmptyOptions } from '../util/valuesUtil';

package/dist/types/render/components/form-fields/Taglist.d.ts

@@ -7,14 +7,10 @@ declare namespace Taglist {
         export const group: string;
         export const emptyValue: any[];
         export { sanitizeMultiSelectValue as sanitizeValue };
-        export function create(options?: {}): {
-            values: {
-                label: string;
-                value: string;
-            }[];
-        };
+        export { createEmptyOptions as create };
     }
 }
 export default Taglist;
 declare const type: "taglist";
 import { sanitizeMultiSelectValue } from '../util/sanitizerUtil';
+import { createEmptyOptions } from '../util/valuesUtil';

package/dist/types/render/components/form-fields/parts/Grid.d.ts

@@ -0,0 +1 @@
+export default function Grid(props: any): import("preact").JSX.Element;

package/dist/types/render/components/index.d.ts

@@ -1,4 +1,4 @@
-export const formFields: (typeof Default | typeof Image)[];
+export const formFields: (typeof Default | typeof Group | typeof Image)[];
 export * from "./icons";
 import Button from './form-fields/Button';
 import Checkbox from './form-fields/Checkbox';
@@ -6,6 +6,7 @@ import Checklist from './form-fields/Checklist';
 import Default from './form-fields/Default';
 import Datetime from './form-fields/Datetime';
 import FormComponent from './FormComponent';
+import Group from './form-fields/Group';
 import Image from './form-fields/Image';
 import Numberfield from './form-fields/Number';
 import Radio from './form-fields/Radio';
@@ -15,4 +16,4 @@ import Taglist from './form-fields/Taglist';
 import Text from './form-fields/Text';
 import Textfield from './form-fields/Textfield';
 import Textarea from './form-fields/Textarea';
-export { Button, Checkbox, Checklist, Default, Datetime, FormComponent, Image, Numberfield, Radio, Select, Spacer, Taglist, Text, Textfield, Textarea };
+export { Button, Checkbox, Checklist, Default, Datetime, FormComponent, Group, Image, Numberfield, Radio, Select, Spacer, Taglist, Text, Textfield, Textarea };

package/dist/types/render/components/util/localisationUtil.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Returns date format for the provided locale.
+ * If the locale is not provided, uses the browser's locale.
+ *
+ * @param {string} [locale] - The locale to get date format for.
+ * @returns {string} The date format for the locale.
+ */
+export function getLocaleDateFormat(locale?: string): string;
+/**
+ * Returns readable date format for the provided locale.
+ * If the locale is not provided, uses the browser's locale.
+ *
+ * @param {string} [locale] - The locale to get readable date format for.
+ * @returns {string} The readable date format for the locale.
+ */
+export function getLocaleReadableDateFormat(locale?: string): string;
+/**
+ * Returns flatpickr config for the provided locale.
+ * If the locale is not provided, uses the browser's locale.
+ *
+ * @param {string} [locale] - The locale to get flatpickr config for.
+ * @returns {object} The flatpickr config for the locale.
+ */
+export function getLocaleDateFlatpickrConfig(locale?: string): object;

package/dist/types/render/components/util/valuesUtil.d.ts

@@ -1,2 +1,8 @@
 export function getValuesData(formField: any, formData: any): any;
 export function normalizeValuesData(valuesData: any): any;
+export function createEmptyOptions(options?: {}): {
+    values: {
+        label: string;
+        value: string;
+    }[];
+};

package/dist/types/render/context/FormRenderContext.d.ts

@@ -1,8 +1,11 @@
 export default FormRenderContext;
 declare const FormRenderContext: import("preact").Context<{
+    EmptyRoot: (props: any) => any;
     Empty: (props: any) => any;
     Children: (props: any) => import("preact").JSX.Element;
     Element: (props: any) => import("preact").JSX.Element;
     Row: (props: any) => import("preact").JSX.Element;
     Column: (props: any) => any;
+    hoveredId: any[];
+    setHoveredId: (newValue: any) => void;
 }>;

package/dist/types/types.d.ts

@@ -1,36 +1,36 @@
-import { Injector } from 'didi';
-
-export type Module = any;
-export type Schema = any;
-
-export interface Data {
-  [x: string]: any;
-}
-
-export interface Errors {
-  [x: string]: string[];
-}
-
-export type FormProperty = ('readOnly' | 'disabled' | string);
-export type FormEvent = ('submit' | 'changed' | string);
-
-export interface FormProperties {
-  [x: string]: any;
-}
-
-export interface FormOptions {
-  additionalModules?: Module[];
-  container?: Element | null | string;
-  injector?: Injector;
-  modules?: Module[];
-  properties?: FormProperties;
-}
-
-export interface CreateFormOptions extends FormOptions {
-  data?: Data;
-  schema: Schema;
-}
-
-export {
-  Injector
+import { Injector } from 'didi';
+
+export type Module = any;
+export type Schema = any;
+
+export interface Data {
+  [x: string]: any;
+}
+
+export interface Errors {
+  [x: string]: string[];
+}
+
+export type FormProperty = ('readOnly' | 'disabled' | string);
+export type FormEvent = ('submit' | 'changed' | string);
+
+export interface FormProperties {
+  [x: string]: any;
+}
+
+export interface FormOptions {
+  additionalModules?: Module[];
+  container?: Element | null | string;
+  injector?: Injector;
+  modules?: Module[];
+  properties?: FormProperties;
+}
+
+export interface CreateFormOptions extends FormOptions {
+  data?: Data;
+  schema: Schema;
+}
+
+export {
+  Injector
 };

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

@@ -1,8 +1,6 @@
-export function findErrors(errors: any, path: any): any;
 export function isRequired(field: any): any;
 export function pathParse(path: any): any;
 export function pathsEqual(a: any, b: any): any;
-export function pathStringify(path: any): any;
 export function generateIndexForType(type: any): any;
 export function generateIdForType(type: any): string;
 /**
@@ -20,6 +18,7 @@ export function clone<T>(data: T, replacer?: (this: any, key: string, value: any
  * @return {string[]}
  */
 export function getSchemaVariables(schema: any, options?: {}): string[];
+export function runRecursively(formField: any, fn: any): void;
 export * from "./constants";
 export * from "./injector";
 export * from "./form";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bpmn-io/form-js-viewer",
-  "version": "1.1.0",
+  "version": "1.3.0-alpha.0",
   "description": "View forms - powered by bpmn.io",
   "exports": {
     ".": {
@@ -22,6 +22,7 @@
     "all": "run-s test build",
     "build": "run-p bundle bundle:scss generate-types",
     "start": "SINGLE_START=basic npm run dev",
+    "start:groups": "SINGLE_START=groups npm run dev",
     "bundle": "rollup -c --failAfterWarnings --bundleConfigAsCjs",
     "bundle:scss": "sass --no-source-map --load-path=\"../../node_modules\" assets/index.scss dist/assets/form-js.css",
     "bundle:watch": "run-p bundle:watch-js bundle:watch-scss",
@@ -62,5 +63,5 @@
   "files": [
     "dist"
   ],
-  "gitHead": "6bfb194e07fe44d3309744507f9f874cf8e94169"
+  "gitHead": "dd5504e512c13945767159900dc8cf884834b937"
 }

package/dist/types/import/Importer.d.ts

@@ -1,45 +0,0 @@
-declare class Importer {
-    /**
-     * @constructor
-     * @param { import('../core').FormFieldRegistry } formFieldRegistry
-     * @param { import('../render/FormFields').default } formFields
-     * @param { import('../core').FormLayouter } formLayouter
-     */
-    constructor(formFieldRegistry: import('../core').FormFieldRegistry, formFields: import('../render/FormFields').default, formLayouter: import('../core').FormLayouter);
-    _formFieldRegistry: import("../core").FormFieldRegistry;
-    _formFields: import("../render/FormFields").default;
-    _formLayouter: import("../core").FormLayouter;
-    /**
-     * Import schema adding `id`, `_parent` and `_path`
-     * information to each field and adding it to the
-     * form field registry.
-     *
-     * @param {any} schema
-     * @param {any} [data]
-     *
-     * @return { { warnings: Array<any>, schema: any, data: any } }
-     */
-    importSchema(schema: any, data?: any): {
-        warnings: Array<any>;
-        schema: any;
-        data: any;
-    };
-    /**
-     * @param {any} formField
-     * @param {string} [parentId]
-     *
-     * @return {any} importedField
-     */
-    importFormField(formField: any, parentId?: string): any;
-    importFormFields(components: any, parentId: any): void;
-    /**
-     * @param {Object} data
-     *
-     * @return {Object} initializedData
-     */
-    initializeFieldValues(data: any): any;
-}
-declare namespace Importer {
-    const $inject: string[];
-}
-export default Importer;

package/dist/types/import/index.d.ts

@@ -1,5 +0,0 @@
-declare namespace _default {
-    const importer: (string | typeof Importer)[];
-}
-export default _default;
-import Importer from './Importer';