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

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

@@ -0,0 +1,71 @@
+/**
+ * @typedef {('asc'|'desc')} Direction
+ *
+ * @typedef Sorting
+ * @property {string} key
+ * @property {Direction} direction
+ *
+ * @typedef Column
+ * @property {string} label
+ * @property {string} key
+ *
+ * @typedef Props
+ * @property {Object} field
+ * @property {string} field.id
+ * @property {Array<Column>} [field.columns]
+ * @property {string} [field.columnsExpression]
+ * @property {string} [field.label]
+ * @property {number} [field.rowCount]
+ * @property {string} [field.dataSource]
+ *
+ * @param {Props} props
+ * @returns {import("preact").JSX.Element}
+ */
+declare function Table(props: Props): import("preact").JSX.Element;
+declare namespace Table {
+    namespace config {
+        export { type };
+        export let keyed: boolean;
+        export let label: string;
+        export let group: string;
+        export function create(options?: {}): {
+            id: any;
+            columnsExpression: string;
+        } | {
+            id: any;
+            columns: Column[];
+        } | {
+            rowCount: number;
+            columns: {
+                label: string;
+                key: string;
+            }[];
+        };
+        export let initialDemoData: {
+            id: number;
+            name: string;
+            date: string;
+        }[];
+    }
+}
+export default Table;
+export type Direction = ('asc' | 'desc');
+export type Sorting = {
+    key: string;
+    direction: Direction;
+};
+export type Column = {
+    label: string;
+    key: string;
+};
+export type Props = {
+    field: {
+        id: string;
+        columns?: Array<Column>;
+        columnsExpression?: string;
+        label?: string;
+        rowCount?: number;
+        dataSource?: string;
+    };
+};
+declare const type: "table";

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

@@ -2,10 +2,10 @@ declare function Taglist(props: any): import("preact").JSX.Element;
 declare namespace Taglist {
     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 Taglist {
 export default Taglist;
 declare const type: "taglist";
 import { sanitizeMultiSelectValue } from '../util/sanitizerUtil';
-import { createEmptyOptions } from '../util/valuesUtil';
+import { createEmptyOptions } from '../util/optionsUtil';

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

@@ -2,9 +2,9 @@ declare function Text(props: any): import("preact").JSX.Element;
 declare namespace Text {
     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?: {}): {
             text: string;
         };

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

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

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

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

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

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

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

@@ -1,4 +1,4 @@
-export const formFields: (typeof Default | typeof Group | typeof Image)[];
+export const formFields: (typeof Default | typeof Group | typeof IFrame)[];
 export * from "./icons";
 export * from "./Sanitizer";
 import Label from './Label';
@@ -12,6 +12,8 @@ import Datetime from './form-fields/Datetime';
 import FormComponent from './FormComponent';
 import FormField from './FormField';
 import Group from './form-fields/Group';
+import IFrame from './form-fields/IFrame';
+import DynamicList from './form-fields/DynamicList';
 import Image from './form-fields/Image';
 import Numberfield from './form-fields/Number';
 import Radio from './form-fields/Radio';
@@ -22,4 +24,5 @@ import Taglist from './form-fields/Taglist';
 import Text from './form-fields/Text';
 import Textfield from './form-fields/Textfield';
 import Textarea from './form-fields/Textarea';
-export { Label, Description, Errors, Button, Checkbox, Checklist, Default, Datetime, FormComponent, FormField, Group, Image, Numberfield, Radio, Select, Separator, Spacer, Taglist, Text, Textfield, Textarea };
+import Table from './form-fields/Table';
+export { Label, Description, Errors, Button, Checkbox, Checklist, Default, Datetime, FormComponent, FormField, Group, IFrame, DynamicList, Image, Numberfield, Radio, Select, Separator, Spacer, Taglist, Text, Textfield, Textarea, Table };

package/dist/types/render/components/util/optionsUtil.d.ts

@@ -0,0 +1,8 @@
+export function getOptionsData(formField: any, formData: any): any;
+export function normalizeOptionsData(optionsData: any): any;
+export function createEmptyOptions(options?: {}): {
+    values: {
+        label: string;
+        value: string;
+    }[];
+};

package/dist/types/render/context/FormRenderContext.d.ts

@@ -1,11 +1,12 @@
 export default FormRenderContext;
 declare const FormRenderContext: import("preact").Context<{
-    EmptyRoot: (props: any) => any;
     Empty: (props: any) => any;
+    Hidden: (props: any) => any;
     Children: (props: any) => import("preact").JSX.Element;
     Element: (props: any) => import("preact").JSX.Element;
     Row: (props: any) => import("preact").JSX.Element;
     Column: (props: any) => any;
-    hoveredId: any[];
-    setHoveredId: (newValue: any) => void;
+    hoverInfo: {
+        cleanup: () => void;
+    };
 }>;

package/dist/types/render/context/LocalExpressionContext.d.ts

@@ -0,0 +1,7 @@
+export default LocalExpressionContext;
+declare const LocalExpressionContext: import("preact").Context<{
+    data: any;
+    this: any;
+    parent: any;
+    i: any;
+}>;

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

@@ -1,2 +1,3 @@
 export { default as FormRenderContext } from "./FormRenderContext";
+export { default as LocalExpressionContext } from "./LocalExpressionContext";
 export { default as FormContext } from "./FormContext";

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

@@ -1,4 +1,5 @@
 export { default as useCondition } from "./useCondition";
+export { default as useScrollIntoView } from "./useScrollIntoView";
 export { default as useExpressionEvaluation } from "./useExpressionEvaluation";
 export { default as useFilteredFormData } from "./useFilteredFormData";
 export { default as useKeyDownAction } from "./useKeyDownAction";

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

@@ -0,0 +1 @@
+export default function _default(props: any): void;

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

@@ -0,0 +1 @@
+export default function _default(props: any): void;

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

@@ -1,9 +1,9 @@
 /**
  * Evaluate a string reactively based on the expressionLanguage and form data.
  * If the string is not an expression, it is returned as is.
- * Memoised to minimize re-renders.
- *
- * @param {string} value
+ * The function is memoized to minimize re-renders.
  *
+ * @param {string} value - The string to evaluate.
+ * @returns {any} - Evaluated value or the original value if not an expression.
  */
 export default function useExpressionEvaluation(value: string): any;

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

@@ -2,5 +2,6 @@
  * Returns the conditionally filtered data of a form reactively.
  * Memoised to minimize re-renders
  *
+ * Warning: costly operation, use with care
  */
 export default function useFilteredFormData(): any;

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

@@ -0,0 +1,28 @@
+/**
+ * @typedef {Object} OptionsGetter
+ * @property {Object[]} options - The options data
+ * @property {(LOAD_STATES)} loadState - The options data's loading state, to use for conditional rendering
+ */
+/**
+ * A hook to load options for single and multiselect components.
+ *
+ * @param {Object} field - The form field to handle options for
+ * @return {OptionsGetter} optionsGetter - A options getter object providing loading state and options
+ */
+export default function _default(field: any): OptionsGetter;
+export type LOAD_STATES = string;
+export namespace LOAD_STATES {
+    let LOADING: string;
+    let LOADED: string;
+    let ERROR: string;
+}
+export type OptionsGetter = {
+    /**
+     * - The options data
+     */
+    options: any[];
+    /**
+     * - The options data's loading state, to use for conditional rendering
+     */
+    loadState: (LOAD_STATES);
+};

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

@@ -0,0 +1,18 @@
+/**
+ * Custom hook to scroll an element into view only when it is not visible within the viewport.
+ *
+ * @param {Object} targetRef - A ref pointing to the DOM element to scroll into view.
+ * @param {Array} deps - An array of dependencies that trigger the effect.
+ * @param {Array} flagRefs - An array of refs that are used as flags to control when to scroll.
+ * @param {Object} [scrollOptions={}] - Options defining the behavior of the scrolling.
+ * @param {String} [scrollOptions.align='center'] - The alignment of the element within the viewport.
+ * @param {String} [scrollOptions.behavior='auto'] - The scrolling behavior.
+ * @param {Number} [scrollOptions.offset=0] - An offset that is added to the scroll position.
+ * @param {Boolean} [scrollOptions.scrollIfVisible=false] - Whether to scroll even if the element is visible.
+ */
+export default function useScrollIntoView(targetRef: any, deps: any[], scrollOptions?: {
+    align?: string;
+    behavior?: string;
+    offset?: number;
+    scrollIfVisible?: boolean;
+}, flagRefs?: any[]): void;

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

@@ -9,7 +9,7 @@
  * @param {Function} [options.buildDebugString]
  *
  */
-export default function useTemplateEvaluation(value: string, options: {
+export default function useTemplateEvaluation(value: string, options?: {
     debug?: boolean;
     strict?: boolean;
     buildDebugString?: Function;

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

@@ -2,10 +2,11 @@ export { FormFields };
 export * from "./components";
 export * from "./context";
 declare namespace _default {
-    const __init__: string[];
-    const formFields: (string | typeof FormFields)[];
-    const renderer: (string | typeof Renderer)[];
+    let __init__: string[];
+    let formFields: (string | typeof FormFields)[];
+    let renderer: (string | typeof Renderer)[];
 }
 export default _default;
 import FormFields from './FormFields';
 import Renderer from './Renderer';
+export { useExpressionEvaluation, useSingleLineTemplateEvaluation, useTemplateEvaluation } from "./hooks";

package/dist/types/util/constants/DatetimeConstants.d.ts

@@ -1,13 +1,13 @@
 export const MINUTES_IN_DAY: number;
 export namespace DATETIME_SUBTYPES {
-    const DATE: string;
-    const TIME: string;
-    const DATETIME: string;
+    let DATE: string;
+    let TIME: string;
+    let DATETIME: string;
 }
 export namespace TIME_SERIALISING_FORMATS {
-    const UTC_OFFSET: string;
-    const UTC_NORMALIZED: string;
-    const NO_TIMEZONE: string;
+    let UTC_OFFSET: string;
+    let UTC_NORMALIZED: string;
+    let NO_TIMEZONE: string;
 }
 export const DATETIME_SUBTYPES_LABELS: {
     [x: string]: string;

package/dist/types/util/constants/OptionsSourceConstants.d.ts

@@ -0,0 +1,19 @@
+export function getOptionsSource(field: any): string;
+export namespace OPTIONS_SOURCES {
+    let STATIC: string;
+    let INPUT: string;
+    let EXPRESSION: string;
+}
+export const OPTIONS_SOURCE_DEFAULT: string;
+export const OPTIONS_SOURCES_LABELS: {
+    [x: string]: string;
+};
+export const OPTIONS_SOURCES_PATHS: {
+    [x: string]: string[];
+};
+export const OPTIONS_SOURCES_DEFAULTS: {
+    [x: string]: string | {
+        label: string;
+        value: string;
+    }[];
+};

package/dist/types/util/constants/index.d.ts

@@ -1,2 +1,2 @@
 export * from "./DatetimeConstants";
-export * from "./ValuesSourceConstants";
+export * from "./OptionsSourceConstants";

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

@@ -0,0 +1,39 @@
+/**
+ * @typedef { import('../types').Schema } Schema
+ */
+/**
+ * Parse the schema for variables a form might make use of.
+ *
+ * @example
+ *
+ * // retrieve variables from schema
+ * const variables = getSchemaVariables(schema);
+ *
+ * @example
+ *
+ * // retrieve input variables from schema
+ * const inputVariables = getSchemaVariables(schema, { outputs: false });
+ *
+ * @example
+ *
+ * // retrieve output variables from schema
+ * const outputVariables = getSchemaVariables(schema, { inputs: false });
+ *
+ * @param {Schema} schema
+ * @param {object} [options]
+ * @param {any} [options.expressionLanguage]
+ * @param {any} [options.templating]
+ * @param {any} [options.formFields]
+ * @param {boolean} [options.inputs=true]
+ * @param {boolean} [options.outputs=true]
+ *
+ * @return {string[]}
+ */
+export function getSchemaVariables(schema: Schema, options?: {
+    expressionLanguage?: any;
+    templating?: any;
+    formFields?: any;
+    inputs?: boolean;
+    outputs?: boolean;
+}): string[];
+export type Schema = import('../types').Schema;

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

@@ -1,55 +1,6 @@
-export function isRequired(field: any): any;
-export function pathParse(path: any): any;
-export function pathsEqual(a: any, b: any): any;
-export function generateIndexForType(type: any): any;
-export function generateIdForType(type: any): string;
-/**
- * @template T
- * @param {T} data
- * @param {(this: any, key: string, value: any) => any} [replacer]
- * @return {T}
- */
-export function clone<T>(data: T, replacer?: (this: any, key: string, value: any) => any): T;
-/**
- * @typedef { import('../types').Schema } Schema
- */
-/**
- * Parse the schema for variables a form might make use of.
- *
- * @example
- *
- * // retrieve variables from schema
- * const variables = getSchemaVariables(schema);
- *
- * @example
- *
- * // retrieve input variables from schema
- * const inputVariables = getSchemaVariables(schema, { outputs: false });
- *
- * @example
- *
- * // retrieve output variables from schema
- * const outputVariables = getSchemaVariables(schema, { inputs: false });
- *
- * @param {Schema} schema
- * @param {object} [options]
- * @param {any} [options.expressionLanguage]
- * @param {any} [options.templating]
- * @param {any} [options.formFields]
- * @param {boolean} [options.inputs=true]
- * @param {boolean} [options.outputs=true]
- *
- * @return {string[]}
- */
-export function getSchemaVariables(schema: Schema, options?: {
-    expressionLanguage?: any;
-    templating?: any;
-    formFields?: any;
-    inputs?: boolean;
-    outputs?: boolean;
-}): string[];
-export function runRecursively(formField: any, fn: any): void;
 export * from "./constants";
 export * from "./injector";
 export * from "./form";
-export type Schema = import('../types').Schema;
+export * from "./getSchemaVariables";
+export * from "./simple";
+export * from "./structure";

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

@@ -0,0 +1,20 @@
+export function isRequired(field: any): any;
+export function pathParse(path: any): any;
+export function pathsEqual(a: any, b: any): any;
+export function generateIndexForType(type: any): any;
+export function generateIdForType(type: any): string;
+/**
+ * @template T
+ * @param {T} data
+ * @param {(this: any, key: string, value: any) => any} [replacer]
+ * @return {T}
+ */
+export function clone<T>(data: T, replacer?: (this: any, key: string, value: any) => any): T;
+/**
+ * Transform a LocalExpressionContext object into a usable FEEL context.
+ *
+ * @param {Object} context - The LocalExpressionContext object.
+ * @returns {Object} The usable FEEL context.
+ */
+export function buildExpressionContext(context: any): any;
+export function runRecursively(formField: any, fn: any): void;

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

@@ -0,0 +1 @@
+export function getAncestryList(formFieldId: string, formFieldRegistry: import('../core/FormFieldRegistry').default): Array<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bpmn-io/form-js-viewer",
-  "version": "1.5.0-alpha.0",
+  "version": "1.6.0",
   "description": "View forms - powered by bpmn.io",
   "exports": {
     ".": {
@@ -47,9 +47,9 @@
     "@carbon/grid": "^11.11.0",
     "big.js": "^6.2.1",
     "classnames": "^2.3.1",
-    "didi": "^9.0.0",
-    "feelers": "^1.0.0",
-    "feelin": "^1.2.0",
+    "didi": "^10.0.1",
+    "feelers": "^1.2.0",
+    "feelin": "^3.0.0",
     "flatpickr": "^4.6.13",
     "ids": "^1.0.0",
     "min-dash": "^4.0.0",
@@ -63,5 +63,5 @@
   "files": [
     "dist"
   ],
-  "gitHead": "dd79ef1e87281d69eef0c052069ce4347d1a7468"
+  "gitHead": "0f868b4c5679af5366998253e7a602f1375754a7"
 }

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

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

package/dist/types/render/components/util/valuesUtil.d.ts

@@ -1,8 +0,0 @@
-export function getValuesData(formField: any, formData: any): any;
-export function normalizeValuesData(valuesData: any): any;
-export function createEmptyOptions(options?: {}): {
-    values: {
-        label: string;
-        value: string;
-    }[];
-};

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

@@ -1,28 +0,0 @@
-/**
- * @typedef {Object} ValuesGetter
- * @property {Object[]} values - The values data
- * @property {(LOAD_STATES)} state - The values data's loading state, to use for conditional rendering
- */
-/**
- * A hook to load values for single and multiselect components.
- *
- * @param {Object} field - The form field to handle values for
- * @return {ValuesGetter} valuesGetter - A values getter object providing loading state and values
- */
-export default function _default(field: any): ValuesGetter;
-export type LOAD_STATES = string;
-export namespace LOAD_STATES {
-    const LOADING: string;
-    const LOADED: string;
-    const ERROR: string;
-}
-export type ValuesGetter = {
-    /**
-     * - The values data
-     */
-    values: any[];
-    /**
-     * - The values data's loading state, to use for conditional rendering
-     */
-    state: (LOAD_STATES);
-};

package/dist/types/util/constants/ValuesSourceConstants.d.ts

@@ -1,19 +0,0 @@
-export function getValuesSource(field: any): string;
-export namespace VALUES_SOURCES {
-    const STATIC: string;
-    const INPUT: string;
-    const EXPRESSION: string;
-}
-export const VALUES_SOURCE_DEFAULT: string;
-export const VALUES_SOURCES_LABELS: {
-    [x: string]: string;
-};
-export const VALUES_SOURCES_PATHS: {
-    [x: string]: string[];
-};
-export const VALUES_SOURCES_DEFAULTS: {
-    [x: string]: string | {
-        label: string;
-        value: string;
-    }[];
-};