@bpmn-io/form-js-viewer 0.14.0 → 0.14.1

package/dist/types/Form.d.ts

@@ -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/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/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.14.1",
   "description": "View forms - powered by bpmn.io",
   "exports": {
     ".": {
@@ -60,5 +60,6 @@
   ],
   "files": [
     "dist"
-  ]
+  ],
+  "gitHead": "a9ad771bc8f87d2fc428bd5bd1429b96bb03fe7a"
 }