@bpmn-io/form-js-viewer 1.19.0 → 1.21.0

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

@@ -23,3 +23,4 @@ export class Validator {
 export namespace Validator {
     let $inject: string[];
 }
+export type ExpressionLanguage = import("../types").ExpressionLanguage;

package/dist/types/features/expressionLanguage/ConditionChecker.d.ts

@@ -1,11 +1,21 @@
+/**
+ * @typedef { import('../../types').ExpressionLanguage } ExpressionLanguage
+ */
 /**
  * @typedef {object} Condition
  * @property {string} [hide]
  */
 export class ConditionChecker {
-    constructor(formFieldRegistry: any, pathRegistry: any, eventBus: any);
+    /**
+     * @param {Object} formFieldRegistry
+     * @param {Object} pathRegistry
+     * @param {ExpressionLanguage} expressionLanguage
+     * @param {Object} eventBus
+     */
+    constructor(formFieldRegistry: any, pathRegistry: any, expressionLanguage: ExpressionLanguage, eventBus: any);
     _formFieldRegistry: any;
     _pathRegistry: any;
+    _expressionLanguage: import("../../types").ExpressionLanguage;
     _eventBus: any;
     /**
      * For given data, remove properties based on condition.
@@ -52,6 +62,7 @@ export class ConditionChecker {
 export namespace ConditionChecker {
     let $inject: string[];
 }
+export type ExpressionLanguage = import("../../types").ExpressionLanguage;
 export type Condition = {
     hide?: string;
 };

package/dist/types/features/expressionLanguage/FeelExpressionLanguage.d.ts

@@ -30,6 +30,15 @@ export class FeelExpressionLanguage {
      * @returns {any}
      */
     evaluate(expression: string, data?: import("../../types").Data): any;
+    /**
+     * Evaluate a unary test expression. Returns null for invalid/missing expressions.
+     *
+     * @param {string} expression
+     * @param {import('../../types').Data} [data]
+     *
+     * @returns {boolean|null}
+     */
+    evaluateUnaryTest(expression: string, data?: import("../../types").Data): boolean | null;
 }
 export namespace FeelExpressionLanguage {
     let $inject: string[];

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

@@ -1,6 +1,7 @@
 /**
  * @typedef DocumentEndpointBuilder
- * @property {(document: DocumentMetadata) => string} buildUrl
+ * @property {(document: DocumentMetadata) => string} [buildUrl]
+ * @property {(document: DocumentMetadata) => RequestInit|undefined} [buildRequestInit]
  */
 /**
  * @typedef DocumentMetadata
@@ -37,7 +38,8 @@ export namespace DocumentPreview {
     }
 }
 export type DocumentEndpointBuilder = {
-    buildUrl: (document: DocumentMetadata) => string;
+    buildUrl?: (document: DocumentMetadata) => string;
+    buildRequestInit?: (document: DocumentMetadata) => RequestInit | undefined;
 };
 export type DocumentMetadata = {
     documentId: string;

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

@@ -5,6 +5,7 @@ export { useGetLabelCorrelation } from "./useGetLabelCorrelation";
 export { useScrollIntoView } from "./useScrollIntoView";
 export { useExpressionEvaluation } from "./useExpressionEvaluation";
 export { useBooleanExpressionEvaluation } from "./useBooleanExpressionEvaluation";
+export { useUnaryTestEvaluation } from "./useUnaryTestEvaluation";
 export { useFilteredFormData } from "./useFilteredFormData";
 export { useKeyDownAction } from "./useKeyDownAction";
 export { useReadonly } from "./useReadonly";

package/dist/types/render/hooks/useCondition.d.ts

@@ -1,8 +1,8 @@
 /**
- * Evaluate if condition is met reactively based on the conditionChecker and form data.
+ * Evaluate if condition is met reactively based on the expression language and form data.
  *
  * @param {string | undefined} condition
  *
- * @returns {boolean} true if condition is met or no condition or condition checker exists
+ * @returns {boolean | null} true if condition is met, false if not, null if no condition or expression language
  */
-export function useCondition(condition: string | undefined): boolean;
+export function useCondition(condition: string | undefined): boolean | null;

package/dist/types/render/hooks/useUnaryTestEvaluation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Evaluate a unary test expression reactively. Returns null for invalid/missing expressions.
+ * The function is memoized to minimize re-renders.
+ *
+ * @param {string | undefined} value - A unary test expression to evaluate.
+ * @returns {boolean | null} - Evaluated result, or null if expression is invalid/missing.
+ */
+export function useUnaryTestEvaluation(value: string | undefined): boolean | null;

package/dist/types/types.d.ts

@@ -11,6 +11,23 @@ export interface Errors {
   [x: string]: string[];
 }
 
+export interface ExpressionLanguage {
+  isExpression(value: any): boolean;
+  getVariableNames(expression: string, options?: { type?: string }): string[];
+  evaluate(expression: string, data?: Data): any;
+  evaluateUnaryTest(expression: string, data?: Data): boolean | null;
+}
+
+export interface Templating {
+  isTemplate(value: any): boolean;
+  getVariableNames(template: string): string[];
+  evaluate(
+    template: string,
+    context: Data,
+    options?: { debug?: boolean; strict?: boolean; buildDebugString?: Function; sanitizer?: Function },
+  ): any;
+}
+
 export type FormProperty = 'readOnly' | 'disabled' | string;
 export type FormEvent = 'submit' | 'changed' | string;
 

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

@@ -8,9 +8,19 @@ export function buildExpressionContext(context: any): any;
 /**
  * If the value is a valid expression, it is evaluated and returned. Otherwise, it is returned as-is.
  *
- * @param {any} expressionLanguage - The expression language to use.
+ * @param {import('../types').ExpressionLanguage} expressionLanguage - The expression language to use.
  * @param {any} value - The static value or expression to evaluate.
  * @param {Object} expressionContextInfo - The context information to use.
  * @returns {any} - Evaluated value or the original value if not an expression.
  */
-export function runExpressionEvaluation(expressionLanguage: any, value: any, expressionContextInfo: any): any;
+export function runExpressionEvaluation(expressionLanguage: import("../types").ExpressionLanguage, value: any, expressionContextInfo: any): any;
+/**
+ * Evaluate a value as a unary test expression. Returns null for invalid/missing expressions or
+ * if the expression language is not available.
+ *
+ * @param {import('../types').ExpressionLanguage} expressionLanguage - The expression language to use.
+ * @param {string} value - The unary test expression to evaluate.
+ * @param {Object} expressionContextInfo - The context information to use.
+ * @returns {boolean | null} - Evaluated result, or null if expression is invalid/missing.
+ */
+export function runUnaryTestEvaluation(expressionLanguage: import("../types").ExpressionLanguage, value: string, expressionContextInfo: any): boolean | null;

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

@@ -1,5 +1,7 @@
 /**
  * @typedef { import('../types').Schema } Schema
+ * @typedef { import('../types').ExpressionLanguage } ExpressionLanguage
+ * @typedef { import('../types').Templating } Templating
  */
 /**
  * Parse the schema for variables a form might make use of.
@@ -21,8 +23,8 @@
  *
  * @param {Schema} schema
  * @param {object} [options]
- * @param {any} [options.expressionLanguage]
- * @param {any} [options.templating]
+ * @param {ExpressionLanguage} [options.expressionLanguage]
+ * @param {Templating} [options.templating]
  * @param {any} [options.formFields]
  * @param {boolean} [options.inputs=true]
  * @param {boolean} [options.outputs=true]
@@ -30,10 +32,12 @@
  * @return {string[]}
  */
 export function getSchemaVariables(schema: Schema, options?: {
-    expressionLanguage?: any;
-    templating?: any;
+    expressionLanguage?: ExpressionLanguage;
+    templating?: Templating;
     formFields?: any;
     inputs?: boolean;
     outputs?: boolean;
 }): string[];
 export type Schema = import("../types").Schema;
+export type ExpressionLanguage = import("../types").ExpressionLanguage;
+export type Templating = import("../types").Templating;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bpmn-io/form-js-viewer",
-  "version": "1.19.0",
+  "version": "1.21.0",
   "description": "View forms - powered by bpmn.io",
   "exports": {
     ".": {
@@ -24,7 +24,7 @@
     "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": "rollup -c --failAfterWarnings",
     "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",
     "bundle:watch-js": "rollup -c -w --bundleConfigAsCjs",
@@ -66,5 +66,5 @@
   "files": [
     "dist"
   ],
-  "gitHead": "98dd1308e82a3a65219145f9bc1f71d8e2026215"
+  "gitHead": "19daa3fe06157ae0ae52ae27345fc9dc236b61ca"
 }