@bpmn-io/form-js-viewer 1.5.0-alpha.0 → 1.6.0

package/dist/types/Form.d.ts

@@ -27,8 +27,15 @@ export default class Form {
      * @type {State}
      */
     private _state;
-    get: <T>(name: string, strict?: boolean) => T;
-    invoke: <T_1>(func: (...args: any[]) => T_1, context?: unknown, locals?: import("didi").LocalsMap) => T_1;
+    get: {
+        <T>(name: string): T;
+        <T_1>(name: string, strict: true): T_1;
+        <T_2>(name: string, strict: boolean): T_2;
+    };
+    invoke: {
+        <T_3>(func: import("didi").FactoryFunction<T_3>, context?: unknown, locals?: import("didi").LocalsMap): T_3;
+        <T_4>(func: import("didi").ArrayFunc<T_4>, context?: unknown, locals?: import("didi").LocalsMap): T_4;
+    };
     clear(): void;
     /**
      * Destroy the form, removing it from DOM,
@@ -95,11 +102,12 @@ export default class Form {
     /**
      * @internal
      *
-     * @param { { add?: boolean, field: any, remove?: number, value?: any } } update
+     * @param { { add?: boolean, field: any, indexes: object, remove?: number, value?: any } } update
      */
     _update(update: {
         add?: boolean;
         field: any;
+        indexes: object;
         remove?: number;
         value?: any;
     }): void;
@@ -126,6 +134,9 @@ export default class Form {
         __depends__: import("didi").ModuleDeclaration[];
         __init__: string[];
         viewerCommands: (string | typeof import("./features").ViewerCommands)[];
+    } | {
+        __init__: string[];
+        repeatRenderManager: (string | typeof import("./features").RepeatRenderManager)[];
     })[];
     /**
      * @internal
@@ -142,7 +153,7 @@ export default class Form {
     /**
      * @internal
      */
-    _initializeFieldData(data: any): any;
+    _getInitializedFieldData(data: any, options?: {}): any;
 }
 export type Injector = import('./types').Injector;
 export type Data = import('./types').Data;

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

@@ -12,8 +12,10 @@ declare class FieldFactory {
     create(attrs: any, applyDefaults?: boolean): any;
     _ensureId(field: any): void;
     _ensureKey(field: any): void;
+    _enforceDefaultPath(field: any): void;
+    _getUniqueKeyPath(field: any): string;
 }
 declare namespace FieldFactory {
-    const $inject: string[];
+    let $inject: string[];
 }
 export default FieldFactory;

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

@@ -7,10 +7,11 @@ declare class FormFieldRegistry {
     remove(formField: any): void;
     get(id: any): any;
     getAll(): any[];
+    getForm(): any;
     forEach(callback: any): void;
     clear(): void;
 }
 declare namespace FormFieldRegistry {
-    const $inject: string[];
+    let $inject: string[];
 }
 export default FormFieldRegistry;

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

@@ -18,7 +18,7 @@
 declare class FormLayouter {
     constructor(eventBus: any);
     /** @type Array<FormRows>  */
-    _rows: FormRows[];
+    _rows: Array<FormRows>;
     _ids: any;
     _eventBus: any;
     /**
@@ -51,7 +51,7 @@ declare class FormLayouter {
     clear(): void;
 }
 declare namespace FormLayouter {
-    const $inject: string[];
+    let $inject: string[];
 }
 export default FormLayouter;
 export type FormRow = {

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

@@ -51,6 +51,6 @@ declare class Importer {
     importFormFields(components: Array<any>, parentId: string): Array<any>;
 }
 declare namespace Importer {
-    const $inject: string[];
+    let $inject: string[];
 }
 export default Importer;

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

@@ -30,12 +30,13 @@
  *   ]
  */
 declare class PathRegistry {
-    constructor(formFieldRegistry: any, formFields: any);
+    constructor(formFieldRegistry: any, formFields: any, injector: any);
     _formFieldRegistry: any;
     _formFields: any;
+    _injector: any;
     _dataPaths: any[];
-    canClaimPath(path: any, closed?: boolean): boolean;
-    claimPath(path: any, closed?: boolean): void;
+    canClaimPath(path: any, options?: {}): boolean;
+    claimPath(path: any, options?: {}): void;
     unclaimPath(path: any): void;
     /**
      * Applies a function (fn) recursively on a given field and its children.
@@ -55,17 +56,20 @@ declare class PathRegistry {
      * @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.indexes=null] - A map of parent IDs to the index of the field within said parent, leave null to get an unindexed path.
      * @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;
+        indexes?: any;
         cutoffNode?: any;
     }): (Array<string> | undefined);
     clear(): void;
+    _addIndexes(localValuePath: any, field: any, indexes: any): any;
 }
 declare namespace PathRegistry {
-    const $inject: string[];
+    let $inject: string[];
 }
 export default PathRegistry;

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

@@ -6,6 +6,6 @@ declare class Validator {
     validateField(field: any, value: any): any[];
 }
 declare namespace Validator {
-    const $inject: string[];
+    let $inject: string[];
 }
 export default Validator;

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

@@ -1,16 +1,16 @@
 declare namespace _default {
-    const __depends__: {
+    let __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)[];
+    let eventBus: (string | typeof EventBus)[];
+    let importer: (string | typeof Importer)[];
+    let fieldFactory: (string | typeof FieldFactory)[];
+    let formFieldRegistry: (string | typeof FormFieldRegistry)[];
+    let pathRegistry: (string | typeof PathRegistry)[];
+    let formLayouter: (string | typeof FormLayouter)[];
+    let validator: (string | typeof Validator)[];
 }
 export default _default;
 import Importer from './Importer';

package/dist/types/features/{expression-language → expressionLanguage}/ConditionChecker.d.ts

@@ -10,17 +10,19 @@ declare class ConditionChecker {
     /**
      * For given data, remove properties based on condition.
      *
-     * @param {Object<string, any>} properties
      * @param {Object<string, any>} data
+     * @param {Object<string, any>} contextData
      * @param {Object} [options]
      * @param {Function} [options.getFilterPath]
+     * @param {boolean} [options.leafNodeDeletionOnly]
      */
-    applyConditions(properties: {
+    applyConditions(data: {
         [x: string]: any;
-    }, data?: {
+    }, contextData?: {
         [x: string]: any;
     }, options?: {
         getFilterPath?: Function;
+        leafNodeDeletionOnly?: boolean;
     }): {
         [x: string]: any;
     };
@@ -43,10 +45,12 @@ declare class ConditionChecker {
     _checkHideCondition(condition: Condition, data: {
         [x: string]: any;
     }): boolean;
-    _clearObjectValueRecursively(valuePath: any, obj: any): void;
+    _cleanlyClearDataAtPath(valuePath: any, obj: any): void;
+    _isEmptyObject(parentObject: any): boolean;
+    _isEmptyArray(parentObject: any): boolean;
 }
 declare namespace ConditionChecker {
-    const $inject: string[];
+    let $inject: string[];
 }
 export default ConditionChecker;
 export type Condition = {

package/dist/types/features/{expression-language → expressionLanguage}/FeelExpressionLanguage.d.ts

@@ -32,6 +32,6 @@ declare class FeelExpressionLanguage {
     evaluate(expression: string, data?: import('../../types').Data): any;
 }
 declare namespace FeelExpressionLanguage {
-    const $inject: string[];
+    let $inject: string[];
 }
 export default FeelExpressionLanguage;

package/dist/types/features/{expression-language → expressionLanguage}/FeelersTemplating.d.ts

@@ -63,6 +63,6 @@ declare class FeelersTemplating {
     }[];
 }
 declare namespace FeelersTemplating {
-    const $inject: any[];
+    let $inject: any[];
 }
 export default FeelersTemplating;

package/dist/types/features/{expression-language → expressionLanguage}/index.d.ts

@@ -1,8 +1,8 @@
 declare namespace _default {
-    const __init__: string[];
-    const expressionLanguage: (string | typeof FeelExpressionLanguage)[];
-    const templating: (string | typeof FeelersTemplating)[];
-    const conditionChecker: (string | typeof ConditionChecker)[];
+    let __init__: string[];
+    let expressionLanguage: (string | typeof FeelExpressionLanguage)[];
+    let templating: (string | typeof FeelersTemplating)[];
+    let conditionChecker: (string | typeof ConditionChecker)[];
 }
 export default _default;
 import FeelExpressionLanguage from './FeelExpressionLanguage';

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

@@ -1,6 +1,8 @@
-export { default as ExpressionLanguageModule } from "./expression-language";
+export { default as ExpressionLanguageModule } from "./expressionLanguage";
 export { default as MarkdownModule } from "./markdown";
 export { default as ViewerCommandsModule } from "./viewerCommands";
-export * from "./expression-language";
+export { default as RepeatRenderModule } from "./repeatRender";
+export * from "./expressionLanguage";
 export * from "./markdown";
 export * from "./viewerCommands";
+export * from "./repeatRender";

package/dist/types/features/markdown/MarkdownRenderer.d.ts

@@ -10,6 +10,6 @@ declare class MarkdownRenderer {
     render(markdown: string): string;
 }
 declare namespace MarkdownRenderer {
-    const $inject: any[];
+    let $inject: any[];
 }
 export default MarkdownRenderer;

package/dist/types/features/markdown/index.d.ts

@@ -1,6 +1,6 @@
 declare namespace _default {
-    const __init__: string[];
-    const markdownRenderer: (string | typeof MarkdownRenderer)[];
+    let __init__: string[];
+    let markdownRenderer: (string | typeof MarkdownRenderer)[];
 }
 export default _default;
 export { MarkdownRenderer };

package/dist/types/features/repeatRender/RepeatRenderManager.d.ts

@@ -0,0 +1,21 @@
+declare class RepeatRenderManager {
+    constructor(form: any, formFields: any, formFieldRegistry: any, pathRegistry: any);
+    _form: any;
+    _formFields: any;
+    _formFieldRegistry: any;
+    _pathRegistry: any;
+    Repeater(props: any): import("preact").JSX.Element;
+    RepeatFooter(props: any): import("preact").JSX.Element;
+    /**
+     * Checks whether a field is currently repeating its children.
+     *
+     * @param {string} id - The id of the field to check
+     * @returns {boolean} - True if repeatable, false otherwise
+     */
+    isFieldRepeating(id: string): boolean;
+    _getNonCollapsedItems(field: any): any;
+}
+declare namespace RepeatRenderManager {
+    let $inject: string[];
+}
+export default RepeatRenderManager;

package/dist/types/features/repeatRender/index.d.ts

@@ -0,0 +1,7 @@
+declare namespace _default {
+    let __init__: string[];
+    let repeatRenderManager: (string | typeof RepeatRenderManager)[];
+}
+export default _default;
+export { RepeatRenderManager };
+import RepeatRenderManager from './RepeatRenderManager';

package/dist/types/features/viewerCommands/ViewerCommands.d.ts

@@ -5,10 +5,10 @@ declare class ViewerCommands {
     getHandlers(): {
         'formField.validation.update': typeof UpdateFieldValidationHandler;
     };
-    updateFieldValidation(field: any, value: any): void;
+    updateFieldValidation(field: any, value: any, indexes: any): void;
 }
 declare namespace ViewerCommands {
-    const $inject: string[];
+    let $inject: string[];
 }
 export default ViewerCommands;
 import UpdateFieldValidationHandler from './cmd/UpdateFieldValidationHandler';

package/dist/types/features/viewerCommands/cmd/UpdateFieldValidationHandler.d.ts

@@ -6,6 +6,6 @@ declare class UpdateFieldValidationHandler {
     revert(context: any): void;
 }
 declare namespace UpdateFieldValidationHandler {
-    const $inject: string[];
+    let $inject: string[];
 }
 export default UpdateFieldValidationHandler;

package/dist/types/features/viewerCommands/index.d.ts

@@ -1,7 +1,7 @@
 declare namespace _default {
-    const __depends__: import("didi").ModuleDeclaration[];
-    const __init__: string[];
-    const viewerCommands: (string | typeof ViewerCommands)[];
+    let __depends__: import("didi").ModuleDeclaration[];
+    let __init__: string[];
+    let viewerCommands: (string | typeof ViewerCommands)[];
 }
 export default _default;
 export { ViewerCommands };

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: 12;
+export const schemaVersion: 14;
 export { Form };
 export { FormFieldRegistry, FormLayouter, Importer, FieldFactory, PathRegistry } from "./core";

package/dist/types/render/Renderer.d.ts

@@ -12,7 +12,7 @@
  */
 declare function Renderer(config: Config, eventBus: EventBus, form: Form, injector: Injector): void;
 declare namespace Renderer {
-    const $inject: string[];
+    let $inject: string[];
 }
 export default Renderer;
 export type Config = {

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

@@ -1 +1,21 @@
-export default function Label(props: any): import("preact").JSX.Element;
+/**
+ * @typedef Props
+ * @property {string} [id]
+ * @property {string|undefined} label
+ * @property {string} [class]
+ * @property {boolean} [collapseOnEmpty]
+ * @property {boolean} [required]
+ * @property {import("preact").VNode} [children]
+ *
+ * @param {Props} props
+ * @returns {import("preact").JSX.Element}
+ */
+export default function Label(props: Props): import("preact").JSX.Element;
+export type Props = {
+    id?: string;
+    label: string | undefined;
+    class?: string;
+    collapseOnEmpty?: boolean;
+    required?: boolean;
+    children?: import("preact").VNode;
+};

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

@@ -15,3 +15,11 @@ export function sanitizeHTML(html: string): string;
  * @returns {string}
  */
 export function sanitizeImageSource(src: string): string;
+/**
+ * Sanitizes an iframe source to ensure we only allow for links
+ * that start with http(s).
+ *
+ * @param {string} src
+ * @returns {string}
+ */
+export function sanitizeIFrameSource(src: string): string;

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

@@ -4,4 +4,4 @@ export function formFieldClasses(type: any, { errors, disabled, readonly }?: {
     readonly?: boolean;
 }): any;
 export function gridColumnClasses(formField: any): any;
-export function prefixId(id: any, formId: any): string;
+export function prefixId(id: any, formId: any, indexes: any): string;

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

@@ -2,9 +2,9 @@ declare function Button(props: any): import("preact").JSX.Element;
 declare namespace Button {
     namespace config {
         export { type };
-        export const keyed: boolean;
-        export const label: string;
-        export const group: string;
+        export let keyed: boolean;
+        export let label: string;
+        export let group: string;
         export function create(options?: {}): {
             action: string;
         };

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

@@ -2,10 +2,10 @@ declare function Checkbox(props: any): import("preact").JSX.Element;
 declare namespace Checkbox {
     namespace config {
         export { type };
-        export const keyed: boolean;
-        export const label: string;
-        export const group: string;
-        export const emptyValue: boolean;
+        export let keyed: boolean;
+        export let label: string;
+        export let group: string;
+        export let emptyValue: boolean;
         export function sanitizeValue({ value }: {
             value: any;
         }): boolean;

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

@@ -2,10 +2,10 @@ declare function Checklist(props: any): import("preact").JSX.Element;
 declare namespace Checklist {
     namespace config {
         export { type };
-        export const keyed: boolean;
-        export const label: string;
-        export const group: string;
-        export const emptyValue: any[];
+        export let keyed: boolean;
+        export let label: string;
+        export let group: string;
+        export let emptyValue: any[];
         export { sanitizeMultiSelectValue as sanitizeValue };
         export { createEmptyOptions as create };
     }
@@ -13,4 +13,4 @@ declare namespace Checklist {
 export default Checklist;
 declare const type: "checklist";
 import { sanitizeMultiSelectValue } from '../util/sanitizerUtil';
-import { createEmptyOptions } from '../util/valuesUtil';
+import { createEmptyOptions } from '../util/optionsUtil';

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

@@ -2,10 +2,10 @@ declare function Datetime(props: any): import("preact").JSX.Element;
 declare namespace Datetime {
     namespace config {
         export { type };
-        export const keyed: boolean;
-        export const label: string;
-        export const group: string;
-        export const emptyValue: any;
+        export let keyed: boolean;
+        export let label: string;
+        export let group: string;
+        export let emptyValue: any;
         export { sanitizeDateTimePickerValue as sanitizeValue };
         export function create(options?: {}): {};
     }

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

@@ -1,10 +1,10 @@
 declare function FormComponent(props: any): import("preact").JSX.Element;
 declare namespace FormComponent {
     namespace config {
-        const type: string;
-        const keyed: boolean;
-        const label: any;
-        const group: any;
+        let type: string;
+        let keyed: boolean;
+        let label: any;
+        let group: any;
         function create(options?: {}): {
             components: any[];
         };

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

@@ -0,0 +1,18 @@
+declare function DynamicList(props: any): import("preact").JSX.Element;
+declare namespace DynamicList {
+    namespace config {
+        let type: string;
+        let pathed: boolean;
+        let repeatable: boolean;
+        let label: string;
+        let group: string;
+        function create(options?: {}): {
+            components: any[];
+            showOutline: boolean;
+            isRepeating: boolean;
+            allowAddRemove: boolean;
+            defaultRepetitions: number;
+        };
+    }
+}
+export default DynamicList;

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

@@ -1,10 +1,10 @@
 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;
+        let type: string;
+        let pathed: boolean;
+        let label: string;
+        let group: string;
         function create(options?: {}): {
             components: any[];
             showOutline: boolean;

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

@@ -0,0 +1,12 @@
+declare function IFrame(props: any): import("preact").JSX.Element;
+declare namespace IFrame {
+    namespace config {
+        export { type };
+        export let keyed: boolean;
+        export let label: string;
+        export let group: string;
+        export function create(options?: {}): {};
+    }
+}
+export default IFrame;
+declare const type: "iframe";

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

@@ -2,9 +2,9 @@ declare function Image(props: any): import("preact").JSX.Element;
 declare namespace Image {
     namespace config {
         export { type };
-        export const keyed: boolean;
-        export const label: string;
-        export const group: string;
+        export let keyed: boolean;
+        export let label: string;
+        export let group: string;
         export function create(options?: {}): {};
     }
 }

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

@@ -2,10 +2,10 @@ declare function Numberfield(props: any): import("preact").JSX.Element;
 declare namespace Numberfield {
     namespace config {
         export { type };
-        export const keyed: boolean;
-        export const label: string;
-        export const group: string;
-        export const emptyValue: any;
+        export let keyed: boolean;
+        export let label: string;
+        export let group: string;
+        export let emptyValue: any;
         export function sanitizeValue({ value, formField }: {
             value: any;
             formField: any;

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

@@ -2,10 +2,10 @@ declare function Radio(props: any): import("preact").JSX.Element;
 declare namespace Radio {
     namespace config {
         export { type };
-        export const keyed: boolean;
-        export const label: string;
-        export const group: string;
-        export const emptyValue: any;
+        export let keyed: boolean;
+        export let label: string;
+        export let group: string;
+        export let emptyValue: any;
         export { sanitizeSingleSelectValue as sanitizeValue };
         export { createEmptyOptions as create };
     }
@@ -13,4 +13,4 @@ declare namespace Radio {
 export default Radio;
 declare const type: "radio";
 import { sanitizeSingleSelectValue } from '../util/sanitizerUtil';
-import { createEmptyOptions } from '../util/valuesUtil';
+import { createEmptyOptions } from '../util/optionsUtil';

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

@@ -2,10 +2,10 @@ declare function Select(props: any): import("preact").JSX.Element;
 declare namespace Select {
     namespace config {
         export { type };
-        export const keyed: boolean;
-        export const label: string;
-        export const group: string;
-        export const emptyValue: any;
+        export let keyed: boolean;
+        export let label: string;
+        export let group: string;
+        export let emptyValue: any;
         export { sanitizeSingleSelectValue as sanitizeValue };
         export { createEmptyOptions as create };
     }
@@ -13,4 +13,4 @@ declare namespace Select {
 export default Select;
 declare const type: "select";
 import { sanitizeSingleSelectValue } from '../util/sanitizerUtil';
-import { createEmptyOptions } from '../util/valuesUtil';
+import { createEmptyOptions } from '../util/optionsUtil';

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

@@ -2,9 +2,9 @@ declare function Separator(): import("preact").JSX.Element;
 declare namespace Separator {
     namespace config {
         export { type };
-        export const keyed: boolean;
-        export const label: string;
-        export const group: string;
+        export let keyed: boolean;
+        export let label: string;
+        export let group: string;
         export function create(options?: {}): {};
     }
 }

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

@@ -2,9 +2,9 @@ declare function Spacer(props: any): import("preact").JSX.Element;
 declare namespace Spacer {
     namespace config {
         export { type };
-        export const keyed: boolean;
-        export const label: string;
-        export const group: string;
+        export let keyed: boolean;
+        export let label: string;
+        export let group: string;
         export function create(options?: {}): {
             height: number;
         };