@bpmn-io/form-js-viewer 0.14.0 → 0.15.0-alpha.0

package/dist/types/Form.d.ts

@@ -28,7 +28,7 @@ export default class Form {
      */
     private _state;
     get: <T>(name: string, strict?: boolean) => T;
-    invoke: <T_1>(func: (...args: unknown[]) => T_1, context: unknown, locals: import("didi").LocalsMap) => T_1;
+    invoke: <T_1>(func: (...args: any[]) => T_1, context?: unknown, locals?: import("didi").LocalsMap) => T_1;
     clear(): void;
     /**
      * Destroy the form, removing it from DOM,
@@ -117,6 +117,28 @@ export default class Form {
     _getModules(): ({
         __init__: string[];
         expressionLanguage: (string | typeof import("./features/expression-language").FeelExpressionLanguage)[];
+        /**
+         * @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
+         *
+         * @typedef { (type:FormEvent, priority:number, handler:Function) => void } OnEventWithPriority
+         * @typedef { (type:FormEvent, handler:Function) => void } OnEventWithOutPriority
+         * @typedef { OnEventWithPriority & OnEventWithOutPriority } OnEventType
+         */
         templating: (string | typeof import("./features/expression-language").FeelersTemplating)[];
         conditionChecker: (string | typeof import("./features/expression-language").ConditionChecker)[];
     } | {

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

@@ -1 +1 @@
-export {};
+export { default } from "diagram-js/lib/core/EventBus";

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

@@ -6,7 +6,7 @@ declare namespace _default {
         formFields: (string | typeof import("../render").FormFields)[];
         renderer: (string | typeof import("../render/Renderer").default)[];
     })[];
-    const eventBus: any[];
+    const eventBus: (string | typeof EventBus)[];
     const formFieldRegistry: (string | typeof FormFieldRegistry)[];
     const formLayouter: (string | typeof FormLayouter)[];
     const validator: (string | typeof Validator)[];
@@ -14,5 +14,6 @@ declare namespace _default {
 export default _default;
 import FormFieldRegistry from './FormFieldRegistry';
 import FormLayouter from './FormLayouter';
+import EventBus from './EventBus';
 import Validator from './Validator';
 export { FormFieldRegistry, FormLayouter };

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

@@ -2,13 +2,13 @@ declare class FeelExpressionLanguage {
     constructor(eventBus: any);
     _eventBus: any;
     /**
-     * Determines if the given string is a FEEL expression.
+     * Determines if the given value is a FEEL expression.
      *
-     * @param {string} value
+     * @param {any} value
      * @returns {boolean}
      *
      */
-    isExpression(value: string): boolean;
+    isExpression(value: any): boolean;
     /**
      * Retrieve variable names from a given FEEL expression.
      *
@@ -30,8 +30,6 @@ declare class FeelExpressionLanguage {
      * @returns {any}
      */
     evaluate(expression: string, data?: import('../../types').Data): any;
-    _getExpressionVariableNames(expression: any): any[];
-    _getUnaryVariableNames(unaryTest: any): any[];
 }
 declare namespace FeelExpressionLanguage {
     const $inject: string[];

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

@@ -1,5 +1,20 @@
 declare class FeelersTemplating {
+    /**
+     * Determines if the given value is a feelers template.
+     *
+     * @param {any} value
+     * @returns {boolean}
+     *
+     */
     isTemplate(value: any): boolean;
+    /**
+     * Retrieve variable names from a given feelers template.
+     *
+     * @param {string} template
+     *
+     * @returns {string[]}
+     */
+    getVariableNames(template: string): string[];
     /**
      * Evaluate a template.
      *
@@ -19,6 +34,33 @@ declare class FeelersTemplating {
         strict?: boolean;
         buildDebugString?: Function;
     }): any;
+    /**
+   * @typedef {Object} ExpressionWithDepth
+   * @property {number} depth - The depth of the expression in the syntax tree.
+   * @property {string} expression - The extracted expression
+   */
+    /**
+   * Extracts all feel expressions in the template along with their depth in the syntax tree.
+   * The depth is incremented for child expressions of loops to account for context drilling.
+  
+   * @name extractExpressionsWithDepth
+   * @param {string} template - A feelers template string.
+   * @returns {Array<ExpressionWithDepth>} An array of objects, each containing the depth and the extracted expression.
+   *
+   * @example
+   * const template = "Hello {{user}}, you have:{{#loop items}}\n- {{amount}} {{name}}{{/loop}}.";
+   * const extractedExpressions = _extractExpressionsWithDepth(template);
+   */
+    _extractExpressionsWithDepth(template: string): {
+        /**
+         * - The depth of the expression in the syntax tree.
+         */
+        depth: number;
+        /**
+         * - The extracted expression
+         */
+        expression: string;
+    }[];
 }
 declare namespace FeelersTemplating {
     const $inject: any[];

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

@@ -0,0 +1 @@
+export function getFlavouredFeelVariableNames(feelString: any, feelFlavour: any, options?: {}): any;

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

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

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

@@ -1,6 +1,6 @@
 export function formFieldClasses(type: any, { errors, disabled }?: {
     errors?: any[];
     disabled?: boolean;
-}): string;
-export function gridColumnClasses(formField: any): string;
+}): any;
+export function gridColumnClasses(formField: any): any;
 export function prefixId(id: any, formId: any): string;

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

@@ -1,12 +1,14 @@
 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 const group: string;
+    namespace config {
+        export { type };
+        export const keyed: boolean;
+        export const label: string;
+        export const group: string;
+        export function create(options?: {}): {
+            action: string;
+        };
+    }
 }
 export default Button;
 declare const type: "button";

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

@@ -1,14 +1,16 @@
 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 function sanitizeValue({ value }: {
-        value: any;
-    }): boolean;
-    export const group: string;
+    namespace config {
+        export { type };
+        export const keyed: boolean;
+        export const label: string;
+        export const group: string;
+        export const emptyValue: boolean;
+        export function sanitizeValue({ value }: {
+            value: any;
+        }): boolean;
+        export function create(options?: {}): {};
+    }
 }
 export default Checkbox;
 declare const type: "checkbox";

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

@@ -1,17 +1,19 @@
 declare function Checklist(props: any): import("preact").JSX.Element;
 declare namespace Checklist {
-    export function create(options?: {}): {
-        values: {
-            label: string;
-            value: string;
-        }[];
-    };
-    export { type };
-    export const label: string;
-    export const keyed: boolean;
-    export const emptyValue: any[];
-    export { sanitizeMultiSelectValue as sanitizeValue };
-    export const group: string;
+    namespace config {
+        export { type };
+        export const keyed: boolean;
+        export const label: string;
+        export const group: string;
+        export const emptyValue: any[];
+        export { sanitizeMultiSelectValue as sanitizeValue };
+        export function create(options?: {}): {
+            values: {
+                label: string;
+                value: string;
+            }[];
+        };
+    }
 }
 export default Checklist;
 declare const type: "checklist";

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

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

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

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

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

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

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

@@ -1,15 +1,17 @@
 declare function Numberfield(props: any): import("preact").JSX.Element;
 declare namespace Numberfield {
-    export function create(options?: {}): {};
-    export function sanitizeValue({ value, formField }: {
-        value: any;
-        formField: any;
-    }): any;
-    export { type };
-    export const keyed: boolean;
-    export const label: string;
-    export const emptyValue: any;
-    export const group: string;
+    namespace config {
+        export { type };
+        export const keyed: boolean;
+        export const label: string;
+        export const group: string;
+        export const emptyValue: any;
+        export function sanitizeValue({ value, formField }: {
+            value: any;
+            formField: any;
+        }): any;
+        export function create(options?: {}): {};
+    }
 }
 export default Numberfield;
 declare const type: "number";

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

@@ -1,17 +1,19 @@
 declare function Radio(props: any): import("preact").JSX.Element;
 declare namespace Radio {
-    export function create(options?: {}): {
-        values: {
-            label: string;
-            value: string;
-        }[];
-    };
-    export { type };
-    export const label: string;
-    export const keyed: boolean;
-    export const emptyValue: any;
-    export { sanitizeSingleSelectValue as sanitizeValue };
-    export const group: string;
+    namespace config {
+        export { type };
+        export const keyed: boolean;
+        export const label: string;
+        export const group: string;
+        export const emptyValue: any;
+        export { sanitizeSingleSelectValue as sanitizeValue };
+        export function create(options?: {}): {
+            values: {
+                label: string;
+                value: string;
+            }[];
+        };
+    }
 }
 export default Radio;
 declare const type: "radio";

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

@@ -1,17 +1,19 @@
 declare function Select(props: any): import("preact").JSX.Element;
 declare namespace Select {
-    export function create(options?: {}): {
-        values: {
-            label: string;
-            value: string;
-        }[];
-    };
-    export { type };
-    export const label: string;
-    export const keyed: boolean;
-    export const emptyValue: any;
-    export { sanitizeSingleSelectValue as sanitizeValue };
-    export const group: string;
+    namespace config {
+        export { type };
+        export const keyed: boolean;
+        export const label: string;
+        export const group: string;
+        export const emptyValue: any;
+        export { sanitizeSingleSelectValue as sanitizeValue };
+        export function create(options?: {}): {
+            values: {
+                label: string;
+                value: string;
+            }[];
+        };
+    }
 }
 export default Select;
 declare const type: "select";

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

@@ -1,17 +1,19 @@
 declare function Taglist(props: any): import("preact").JSX.Element;
 declare namespace Taglist {
-    export function create(options?: {}): {
-        values: {
-            label: string;
-            value: string;
-        }[];
-    };
-    export { type };
-    export const label: string;
-    export const keyed: boolean;
-    export const emptyValue: any[];
-    export { sanitizeMultiSelectValue as sanitizeValue };
-    export const group: string;
+    namespace config {
+        export { type };
+        export const keyed: boolean;
+        export const label: string;
+        export const group: string;
+        export const emptyValue: any[];
+        export { sanitizeMultiSelectValue as sanitizeValue };
+        export function create(options?: {}): {
+            values: {
+                label: string;
+                value: string;
+            }[];
+        };
+    }
 }
 export default Taglist;
 declare const type: "taglist";

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

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

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

@@ -1,14 +1,16 @@
 declare function Textarea(props: any): import("preact").JSX.Element;
 declare namespace Textarea {
-    export function create(options?: {}): {};
-    export { type };
-    export const label: string;
-    export const keyed: boolean;
-    export const emptyValue: string;
-    export function sanitizeValue({ value }: {
-        value: any;
-    }): string;
-    export const group: string;
+    namespace config {
+        export { type };
+        export const keyed: boolean;
+        export const label: string;
+        export const group: string;
+        export const emptyValue: string;
+        export function sanitizeValue({ value }: {
+            value: any;
+        }): string;
+        export function create(options?: {}): {};
+    }
 }
 export default Textarea;
 declare const type: "textarea";

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

@@ -1,14 +1,16 @@
 declare function Textfield(props: any): import("preact").JSX.Element;
 declare namespace Textfield {
-    export function create(options?: {}): {};
-    export { type };
-    export const label: string;
-    export const keyed: boolean;
-    export const emptyValue: string;
-    export function sanitizeValue({ value }: {
-        value: any;
-    }): string;
-    export const group: string;
+    namespace config {
+        export { type };
+        export const keyed: boolean;
+        export const label: string;
+        export const group: string;
+        export const emptyValue: string;
+        export function sanitizeValue({ value }: {
+            value: any;
+        }): string;
+        export function create(options?: {}): {};
+    }
 }
 export default Textfield;
 declare const type: "textfield";

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' | 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' | 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

@@ -19,8 +19,9 @@ export function clone<T>(data: T, replacer?: (this: any, key: string, value: any
  *
  * @return {string[]}
  */
-export function getSchemaVariables(schema: any, expressionLanguage?: FeelExpressionLanguage): string[];
+export function getSchemaVariables(schema: any, expressionLanguage?: FeelExpressionLanguage, templating?: FeelersTemplating): string[];
 export * from "./constants";
 export * from "./injector";
 export * from "./form";
 import FeelExpressionLanguage from '../features/expression-language/FeelExpressionLanguage.js';
+import FeelersTemplating from '../features/expression-language/FeelersTemplating.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bpmn-io/form-js-viewer",
-  "version": "0.14.0",
+  "version": "0.15.0-alpha.0",
   "description": "View forms - powered by bpmn.io",
   "exports": {
     ".": {
@@ -60,5 +60,6 @@
   ],
   "files": [
     "dist"
-  ]
+  ],
+  "gitHead": "205275d1b314a512e662758999cd6667894c3695"
 }