@bpmn-io/form-js-viewer 0.4.2 → 0.6.0

package/dist/types/Form.d.ts

@@ -1,143 +1,130 @@
-/**
- * @typedef { import('./types').Injector } Injector
- * @typedef { import('./types').Data } Data
- * @typedef { import('./types').Errors } Errors
- * @typedef { import('./types').Schema } Schema
- * @typedef { import('./types').FormProperties } FormProperties
- * @typedef { import('./types').FormProperty } FormProperty
- * @typedef { import('./types').FormEvent } FormEvent
- * @typedef { import('./types').FormOptions } FormOptions
- *
- * @typedef { {
- *   data: Data,
- *   initialData: Data,
- *   errors: Errors,
- *   properties: FormProperties,
- *   schema: Schema
- * } } State
- */
-/**
- * The form.
- */
-export default class Form {
-    /**
-     * @constructor
-     * @param {FormOptions} options
-     */
-    constructor(options?: FormOptions);
-    /**
-     * @private
-     * @type {Element}
-     */
-    private _container;
-    /**
-     * @private
-     * @type {State}
-     */
-    private _state;
-    get: any;
-    invoke: any;
-    clear(): void;
-    /**
-     * Destroy the form, removing it from DOM,
-     * if attached.
-     */
-    destroy(): void;
-    /**
-     * Open a form schema with the given initial data.
-     *
-     * @param {Schema} schema
-     * @param {Data} [data]
-     *
-     * @return Promise<{ warnings: Array<any> }>
-     */
-    importSchema(schema: Schema, data?: Data): Promise<any>;
-    /**
-     * Submit the form, triggering all field validations.
-     *
-     * @returns { { data: Data, errors: Errors } }
-     */
-    submit(): {
-        data: Data;
-        errors: Errors;
-    };
-    reset(): void;
-    /**
-     * @returns {Errors}
-     */
-    validate(): Errors;
-    /**
-     * @param {Element|string} parentNode
-     */
-    attachTo(parentNode: Element | string): void;
-    detach(): void;
-    /**
-     * @private
-     *
-     * @param {boolean} [emit]
-     */
-    private _detach;
-    /**
-     * @param {FormProperty} property
-     * @param {any} value
-     */
-    setProperty(property: FormProperty, value: any): void;
-    /**
-     * @param {FormEvent} type
-     * @param {number} priority
-     * @param {Function} handler
-     */
-    on(type: FormEvent, priority: number, handler: Function): void;
-    /**
-     * @param {FormEvent} type
-     * @param {Function} handler
-     */
-    off(type: FormEvent, handler: Function): void;
-    /**
-     * @private
-     *
-     * @param {FormOptions} options
-     * @param {Element} container
-     *
-     * @returns {Injector}
-     */
-    private _createInjector;
-    /**
-     * @private
-     */
-    private _emit;
-    /**
-     * @internal
-     *
-     * @param { { add?: boolean, field: any, remove?: number, value?: any } } update
-     */
-    _update(update: {
-        add?: boolean;
-        field: any;
-        remove?: number;
-        value?: any;
-    }): void;
-    /**
-     * @internal
-     */
-    _getState(): State;
-    /**
-     * @internal
-     */
-    _setState(state: any): void;
-}
-export type Injector = any;
-export type Data = import('./types').Data;
-export type Errors = import('./types').Errors;
-export type Schema = import('./types').Schema;
-export type FormProperties = import('./types').FormProperties;
-export type FormProperty = import('./types').FormProperty;
-export type FormEvent = import('./types').FormEvent;
-export type FormOptions = import('./types').FormOptions;
-export type State = {
-    data: Data;
-    initialData: Data;
-    errors: Errors;
-    properties: FormProperties;
-    schema: Schema;
-};
+/**
+ * The form.
+ */
+export default class Form {
+    /**
+     * @constructor
+     * @param {FormOptions} options
+     */
+    constructor(options?: FormOptions);
+    /**
+     * @public
+     * @type {String}
+     */
+    public _id: string;
+    /**
+     * @private
+     * @type {Element}
+     */
+    private _container;
+    /**
+     * @private
+     * @type {State}
+     */
+    private _state;
+    get: any;
+    invoke: any;
+    clear(): void;
+    /**
+     * Destroy the form, removing it from DOM,
+     * if attached.
+     */
+    destroy(): void;
+    /**
+     * Open a form schema with the given initial data.
+     *
+     * @param {Schema} schema
+     * @param {Data} [data]
+     *
+     * @return Promise<{ warnings: Array<any> }>
+     */
+    importSchema(schema: Schema, data?: Data): Promise<any>;
+    /**
+     * Submit the form, triggering all field validations.
+     *
+     * @returns { { data: Data, errors: Errors } }
+     */
+    submit(): {
+        data: Data;
+        errors: Errors;
+    };
+    reset(): void;
+    /**
+     * @returns {Errors}
+     */
+    validate(): Errors;
+    /**
+     * @param {Element|string} parentNode
+     */
+    attachTo(parentNode: Element | string): void;
+    detach(): void;
+    /**
+     * @private
+     *
+     * @param {boolean} [emit]
+     */
+    private _detach;
+    /**
+     * @param {FormProperty} property
+     * @param {any} value
+     */
+    setProperty(property: FormProperty, value: any): void;
+    /**
+     * @param {FormEvent} type
+     * @param {number} priority
+     * @param {Function} handler
+     */
+    on(type: FormEvent, priority: number, handler: Function): void;
+    /**
+     * @param {FormEvent} type
+     * @param {Function} handler
+     */
+    off(type: FormEvent, handler: Function): void;
+    /**
+     * @private
+     *
+     * @param {FormOptions} options
+     * @param {Element} container
+     *
+     * @returns {Injector}
+     */
+    private _createInjector;
+    /**
+     * @private
+     */
+    private _emit;
+    /**
+     * @internal
+     *
+     * @param { { add?: boolean, field: any, remove?: number, value?: any } } update
+     */
+    _update(update: {
+        add?: boolean;
+        field: any;
+        remove?: number;
+        value?: any;
+    }): void;
+    /**
+     * @internal
+     */
+    _getState(): State;
+    /**
+     * @internal
+     */
+    _setState(state: any): void;
+}
+export type Injector = any;
+export type Data = import('./types').Data;
+export type Errors = import('./types').Errors;
+export type Schema = import('./types').Schema;
+export type FormProperties = import('./types').FormProperties;
+export type FormProperty = import('./types').FormProperty;
+export type FormEvent = import('./types').FormEvent;
+export type FormOptions = import('./types').FormOptions;
+export type State = {
+    data: Data;
+    initialData: Data;
+    errors: Errors;
+    properties: FormProperties;
+    schema: Schema;
+};

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

@@ -1 +1 @@
-export {};
+export {};

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

@@ -1,17 +1,17 @@
-declare class FormFieldRegistry {
-    constructor(eventBus: any);
-    _eventBus: any;
-    _formFields: {};
-    _ids: any;
-    _keys: any;
-    add(formField: any): void;
-    remove(formField: any): void;
-    get(id: any): any;
-    getAll(): any[];
-    forEach(callback: any): void;
-    clear(): void;
-}
-declare namespace FormFieldRegistry {
-    const $inject: string[];
-}
-export default FormFieldRegistry;
+declare class FormFieldRegistry {
+    constructor(eventBus: any);
+    _eventBus: any;
+    _formFields: {};
+    _ids: any;
+    _keys: any;
+    add(formField: any): void;
+    remove(formField: any): void;
+    get(id: any): any;
+    getAll(): any[];
+    forEach(callback: any): void;
+    clear(): void;
+}
+declare namespace FormFieldRegistry {
+    const $inject: string[];
+}
+export default FormFieldRegistry;

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

@@ -1,3 +1,3 @@
-export default class Validator {
-    validateField(field: any, value: any): any[];
-}
+export default class Validator {
+    validateField(field: any, value: any): any[];
+}

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

@@ -1,16 +1,16 @@
-export { FormFieldRegistry };
-declare namespace _default {
-    const __depends__: ({
-        importer: (string | typeof import("../import/Importer").default)[];
-    } | {
-        __init__: string[];
-        formFields: (string | typeof import("../render").FormFields)[];
-        renderer: (string | typeof import("../render/Renderer").default)[];
-    })[];
-    const eventBus: any[];
-    const formFieldRegistry: (string | typeof FormFieldRegistry)[];
-    const validator: (string | typeof Validator)[];
-}
-export default _default;
-import FormFieldRegistry from "./FormFieldRegistry";
-import Validator from "./Validator";
+export { FormFieldRegistry };
+declare namespace _default {
+    const __depends__: ({
+        importer: (string | typeof import("../import/Importer").default)[];
+    } | {
+        __init__: string[];
+        formFields: (string | typeof import("../render").FormFields)[];
+        renderer: (string | typeof import("../render/Renderer").default)[];
+    })[];
+    const eventBus: any[];
+    const formFieldRegistry: (string | typeof FormFieldRegistry)[];
+    const validator: (string | typeof Validator)[];
+}
+export default _default;
+import FormFieldRegistry from "./FormFieldRegistry";
+import Validator from "./Validator";

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

@@ -1,38 +1,43 @@
-declare class Importer {
-    /**
-     * @constructor
-     * @param { import('../core').FormFieldRegistry } formFieldRegistry
-     * @param { import('../render/FormFields').default } formFields
-     */
-    constructor(formFieldRegistry: import('../core').FormFieldRegistry, formFields: import('../render/FormFields').default);
-    _formFieldRegistry: import("../core").FormFieldRegistry;
-    _formFields: import("../render/FormFields").default;
-    /**
-     * 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 {Object} [data]
-     * @param {string} [parentId]
-     *
-     * @return {any} field
-     */
-    importFormField(formField: any, data?: any, parentId?: string): any;
-    importFormFields(components: any, data: {}, parentId: any): void;
-}
-declare namespace Importer {
-    const $inject: string[];
-}
-export default Importer;
+declare class Importer {
+    /**
+     * @constructor
+     * @param { import('../core').FormFieldRegistry } formFieldRegistry
+     * @param { import('../render/FormFields').default } formFields
+     */
+    constructor(formFieldRegistry: import('../core').FormFieldRegistry, formFields: import('../render/FormFields').default);
+    _formFieldRegistry: import("../core").FormFieldRegistry;
+    _formFields: import("../render/FormFields").default;
+    /**
+     * 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} importedData
+     */
+    importData(data: any): any;
+}
+declare namespace Importer {
+    const $inject: string[];
+}
+export default Importer;

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

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

package/dist/types/index.d.ts

@@ -1,18 +1,18 @@
-/**
- * @typedef { import('./types').CreateFormOptions } CreateFormOptions
- */
-/**
- * Create a form.
- *
- * @param {CreateFormOptions} options
- *
- * @return {Promise<Form>}
- */
-export function createForm(options: CreateFormOptions): Promise<Form>;
-export { FormFieldRegistry } from "./core";
-export * from "./render";
-export * from "./util";
-export type CreateFormOptions = import('./types').CreateFormOptions;
-import Form from "./Form";
-export const schemaVersion: 2;
-export { Form };
+/**
+ * @typedef { import('./types').CreateFormOptions } CreateFormOptions
+ */
+/**
+ * Create a form.
+ *
+ * @param {CreateFormOptions} options
+ *
+ * @return {Promise<Form>}
+ */
+export function createForm(options: CreateFormOptions): Promise<Form>;
+export { FormFieldRegistry } from "./core";
+export * from "./render";
+export * from "./util";
+export type CreateFormOptions = import('./types').CreateFormOptions;
+import Form from "./Form";
+export const schemaVersion: 3;
+export { Form };

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

@@ -1,5 +1,5 @@
-export default class FormFields {
-    _formFields: {};
-    register(type: any, formField: any): void;
-    get(type: any): any;
-}
+export default class FormFields {
+    _formFields: {};
+    register(type: any, formField: any): void;
+    get(type: any): any;
+}

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

@@ -1,23 +1,23 @@
-/**
- * @typedef { { container } } Config
- * @typedef { import('didi').Injector } Injector
- * @typedef { import('../core/EventBus').default } EventBus
- * @typedef { import('../Form').default } Form
- */
-/**
- * @param {Config} config
- * @param {EventBus} eventBus
- * @param {Form} form
- * @param {Injector} injector
- */
-declare function Renderer(config: Config, eventBus: any, form: Form, injector: any): void;
-declare namespace Renderer {
-    const $inject: string[];
-}
-export default Renderer;
-export type Config = {
-    container;
-};
-export type Injector = any;
-export type EventBus = any;
-export type Form = import('../Form').default;
+/**
+ * @typedef { { container } } Config
+ * @typedef { import('didi').Injector } Injector
+ * @typedef { import('../core/EventBus').default } EventBus
+ * @typedef { import('../Form').default } Form
+ */
+/**
+ * @param {Config} config
+ * @param {EventBus} eventBus
+ * @param {Form} form
+ * @param {Injector} injector
+ */
+declare function Renderer(config: Config, eventBus: any, form: Form, injector: any): void;
+declare namespace Renderer {
+    const $inject: string[];
+}
+export default Renderer;
+export type Config = {
+    container;
+};
+export type Injector = any;
+export type EventBus = any;
+export type Form = import('../Form').default;

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,7 +1,7 @@
-/**
- * Sanitize a HTML string and return the cleaned, safe version.
- *
- * @param {string} html
- * @return {string}
- */
-export function sanitizeHTML(html: string): string;
+/**
+ * Sanitize a HTML string and return the cleaned, safe version.
+ *
+ * @param {string} html
+ * @return {string}
+ */
+export function sanitizeHTML(html: string): string;

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

@@ -1,4 +1,4 @@
-export function formFieldClasses(type: any, errors?: any[]): string;
-export function prefixId(id: any): string;
-export function markdownToHTML(markdown: any): any;
-export function safeMarkdown(markdown: any): string;
+export function formFieldClasses(type: any, errors?: any[]): string;
+export function prefixId(id: any, formId: any): string;
+export function markdownToHTML(markdown: any): any;
+export function safeMarkdown(markdown: any): string;

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

@@ -1,11 +1,11 @@
-declare function Button(props: any): import("preact").JSX.Element;
-declare namespace Button {
-    export function create(options?: {}): {
-        action: string;
-    };
-    export { type };
-    export const label: string;
-    export const keyed: boolean;
-}
-export default Button;
-declare const type: "button";
+declare function Button(props: any): import("preact").JSX.Element;
+declare namespace Button {
+    export function create(options?: {}): {
+        action: string;
+    };
+    export { type };
+    export const label: string;
+    export const keyed: boolean;
+}
+export default Button;
+declare const type: "button";

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

@@ -1,9 +1,10 @@
-declare function Checkbox(props: any): import("preact").JSX.Element;
-declare namespace Checkbox {
-    export function create(options?: {}): {};
-    export { type };
-    export const label: string;
-    export const keyed: boolean;
-}
-export default Checkbox;
-declare const type: "checkbox";
+declare function Checkbox(props: any): import("preact").JSX.Element;
+declare namespace Checkbox {
+    export function create(options?: {}): {};
+    export { type };
+    export const label: string;
+    export const keyed: boolean;
+    export const emptyValue: boolean;
+}
+export default Checkbox;
+declare const type: "checkbox";