@bpmn-io/form-js-editor 1.3.3 → 1.4.0

package/dist/types/FormEditor.d.ts

@@ -150,6 +150,7 @@ export default class FormEditor {
         __depends__: any[];
         __init__: string[];
         propertiesPanel: (string | typeof import("./features/properties-panel/PropertiesPanelRenderer").default)[];
+        propertiesProvider: (string | typeof import("./features/properties-panel/PropertiesProvider").default)[];
     } | {
         __init__: string[];
         renderInjector: (string | typeof import("./features/render-injection/RenderInjector").default)[];

package/dist/types/features/palette/components/Palette.d.ts

@@ -1,10 +1,40 @@
 export default function Palette(props: any): import("preact").JSX.Element;
-export const PALETTE_ENTRIES: {
-    label: any;
-    type: string;
-    group: any;
-}[];
+/**
+ * Returns a list of palette entries.
+ *
+ * @param {FormFields} formFields
+ * @returns {Array<PaletteEntry>}
+ */
+export function collectPaletteEntries(formFields: FormFields): Array<PaletteEntry>;
+/**
+ * There are various options to specify an icon for a palette entry.
+ *
+ * a) via `iconUrl` property in a form field config
+ * b) via `icon` property in a form field config
+ * c) via statically defined iconsByType (fallback)
+ */
+export function getPaletteIcon(entry: any): any;
+/**
+ * @typedef { import('@bpmn-io/form-js-viewer').FormFields } FormFields
+ *
+ * @typedef { {
+ *  label: string,
+ *  type: string,
+ *  group: ('basic-input'|'selection'|'presentation'|'action'),
+ *  icon: preact.FunctionalComponent,
+ *  iconUrl: string
+ * } } PaletteEntry
+ */
 export const PALETTE_GROUPS: {
     label: string;
     id: string;
 }[];
+export type FormFields = import('@bpmn-io/form-js-viewer').FormFields;
+export type PaletteEntry = {
+    label: string;
+    type: string;
+    group: ('basic-input' | 'selection' | 'presentation' | 'action');
+    icon: preact.FunctionalComponent;
+    iconUrl: string;
+};
+import PaletteEntry from './PaletteEntry';

package/dist/types/features/palette/components/PaletteEntry.d.ts

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

package/dist/types/features/properties-panel/PropertiesPanelHeaderProvider.d.ts

@@ -1,5 +1,5 @@
 export namespace PropertiesPanelHeaderProvider {
     function getElementLabel(field: any): any;
-    function getElementIcon(field: any): () => import("preact").JSX.Element;
+    function getElementIcon(field: any): any;
     function getTypeLabel(field: any): any;
 }

package/dist/types/features/properties-panel/PropertiesPanelRenderer.d.ts

@@ -2,6 +2,7 @@
  * @typedef { { parent: Element } } PropertiesPanelConfig
  * @typedef { import('../../core/EventBus').default } EventBus
  * @typedef { import('../../types').Injector } Injector
+ * @typedef { { getGroups: ({ formField, editFormField }) => ({ groups}) => Array } } PropertiesProvider
  */
 /**
  * @param {PropertiesPanelConfig} propertiesPanelConfig
@@ -25,6 +26,14 @@ declare class PropertiesPanelRenderer {
     detach(): void;
     _render(): void;
     _destroy(): void;
+    /**
+     * Register a new properties provider to the properties panel.
+     *
+     * @param {PropertiesProvider} provider
+     * @param {Number} [priority]
+     */
+    registerProvider(provider: PropertiesProvider, priority?: number): void;
+    _getProviders(): any;
 }
 declare namespace PropertiesPanelRenderer {
     const $inject: string[];
@@ -35,3 +44,11 @@ export type PropertiesPanelConfig = {
 };
 export type EventBus = import('../../core/EventBus').default;
 export type Injector = import('../../types').Injector;
+export type PropertiesProvider = {
+    getGroups: ({ formField, editFormField }: {
+        formField: any;
+        editFormField: any;
+    }) => ({ groups }: {
+        groups: any;
+    }) => any[];
+};

package/dist/types/features/properties-panel/PropertiesProvider.d.ts

@@ -0,0 +1,10 @@
+declare class PropertiesProvider {
+    constructor(propertiesPanel: any, injector: any);
+    _injector: any;
+    _filterVisibleEntries(groups: any, field: any, getService: any): any;
+    getGroups(field: any, editField: any): (groups: any) => any;
+}
+declare namespace PropertiesProvider {
+    const $inject: string[];
+}
+export default PropertiesProvider;

package/dist/types/features/properties-panel/Util.d.ts

@@ -6,5 +6,7 @@ export function isValidNumber(value: any): boolean;
 export function stopPropagation(listener: any): (event: any) => void;
 export function textToLabel(text: any): string;
 export function isValidDotPath(path: any): boolean;
+export function hasEntryConfigured(formFieldDefinition: any, entryId: any): any;
+export function hasValuesGroupsConfigured(formFieldDefinition: any): any;
 export const INPUTS: string[];
 export const VALUES_INPUTS: string[];

package/dist/types/features/properties-panel/entries/ActionEntry.d.ts

@@ -4,6 +4,7 @@ export default function ActionEntry(props: any): {
     editField: any;
     field: any;
     isEdited: any;
+    isDefaultVisible: {};
 }[];
 declare function Action(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/AdornerEntry.d.ts

@@ -6,6 +6,7 @@ export default function AdornerEntry(props: any): {
     field: any;
     onChange: (key: any) => (value: any) => void;
     getValue: (key: any) => () => any;
+    isDefaultVisible: {};
 }[];
 declare function PrefixAdorner(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/AltTextEntry.d.ts

@@ -4,6 +4,7 @@ export default function AltTextEntry(props: any): {
     editField: any;
     field: any;
     isEdited: any;
+    isDefaultVisible: {};
 }[];
 declare function AltText(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/DateTimeConstraintsEntry.d.ts

@@ -4,6 +4,7 @@ export default function DateTimeConstraintsEntry(props: any): {
     isEdited: any;
     editField: any;
     field: any;
+    isDefaultVisible: (field: any) => any;
 }[];
 declare function TimeIntervalSelect(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/DateTimeEntry.d.ts

@@ -4,6 +4,7 @@ export default function DateTimeEntry(props: any): {
     isEdited: any;
     editField: any;
     field: any;
+    isDefaultVisible: (field: any) => boolean;
 }[];
 declare function DateTimeSubtypeSelect(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/DateTimeSerializationEntry.d.ts

@@ -4,6 +4,7 @@ export default function DateTimeFormatEntry(props: any): {
     isEdited: any;
     editField: any;
     field: any;
+    isDefaultVisible: {};
 }[];
 declare function TimeFormatSelect(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/DefaultValueEntry.d.ts

@@ -1,2 +1,12 @@
-export default function DefaultOptionEntry(props: any): any[];
+export default function DefaultOptionEntry(props: any): {
+    component: typeof DefaultValueCheckbox;
+    isEdited: any;
+    isDefaultVisible: (field: any) => any;
+    editField: any;
+    field: any;
+    id: string;
+    label: string;
+}[];
 export const EMPTY_OPTION: any;
+declare function DefaultValueCheckbox(props: any): any;
+export {};

package/dist/types/features/properties-panel/entries/DescriptionEntry.d.ts

@@ -4,6 +4,7 @@ export default function DescriptionEntry(props: any): {
     editField: any;
     field: any;
     isEdited: any;
+    isDefaultVisible: {};
 }[];
 declare function Description(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/DisabledEntry.d.ts

@@ -4,6 +4,7 @@ export default function DisabledEntry(props: any): {
     editField: any;
     field: any;
     isEdited: any;
+    isDefaultVisible: {};
 }[];
 declare function Disabled(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/GroupEntries.d.ts

@@ -7,4 +7,5 @@ export default function GroupEntries(props: any): {
     description: any;
     component: (props: any) => any;
     isEdited: any;
+    isDefaultVisible: any;
 }[];

package/dist/types/features/properties-panel/entries/IdEntry.d.ts

@@ -4,6 +4,7 @@ export default function IdEntry(props: any): {
     editField: any;
     field: any;
     isEdited: any;
+    isDefaultVisible: {};
 }[];
 declare function Id(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/ImageSourceEntry.d.ts

@@ -4,6 +4,7 @@ export default function SourceEntry(props: any): {
     editField: any;
     field: any;
     isEdited: any;
+    isDefaultVisible: {};
 }[];
 declare function Source(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/KeyEntry.d.ts

@@ -4,6 +4,7 @@ export default function KeyEntry(props: any): {
     editField: any;
     field: any;
     isEdited: any;
+    isDefaultVisible: {};
 }[];
 declare function Key(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/LabelEntry.d.ts

@@ -4,6 +4,7 @@ export default function LabelEntry(props: any): {
     editField: any;
     field: any;
     isEdited: any;
+    isDefaultVisible: {};
 }[];
 declare function DateLabel(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/NumberEntries.d.ts

@@ -4,6 +4,7 @@ export default function NumberEntries(props: any): {
     isEdited: any;
     editField: any;
     field: any;
+    isDefaultVisible: {};
 }[];
 declare function NumberDecimalDigits(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/NumberSerializationEntry.d.ts

@@ -4,6 +4,7 @@ export default function NumberSerializationEntry(props: any): {
     isEdited: any;
     editField: any;
     field: any;
+    isDefaultVisible: {};
 }[];
 declare function SerializeToString(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/ReadonlyEntry.d.ts

@@ -4,6 +4,7 @@ export default function ReadonlyEntry(props: any): {
     editField: any;
     field: any;
     isEdited: any;
+    isDefaultVisible: {};
 }[];
 declare function Readonly(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/SelectEntries.d.ts

@@ -7,4 +7,5 @@ export default function SelectEntries(props: any): {
     description: any;
     component: (props: any) => any;
     isEdited: any;
+    isDefaultVisible: any;
 }[];

package/dist/types/features/properties-panel/entries/SpacerEntry.d.ts

@@ -4,6 +4,7 @@ export default function SpacerEntry(props: any): {
     isEdited: any;
     editField: any;
     field: any;
+    isDefaultVisible: {};
 }[];
 declare function SpacerHeight(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/TextEntry.d.ts

@@ -4,6 +4,7 @@ export default function TextEntry(props: any): {
     editField: any;
     field: any;
     isEdited: any;
+    isDefaultVisible: (field: any) => boolean;
 }[];
 declare function Text(props: any): any;
 export {};

package/dist/types/features/properties-panel/entries/factories/simpleBoolEntryFactory.d.ts

@@ -7,4 +7,5 @@ export default function simpleBoolEntryFactory(options: any): {
     description: any;
     component: (props: any) => any;
     isEdited: any;
+    isDefaultVisible: any;
 };

package/dist/types/features/properties-panel/groups/AppearanceGroup.d.ts

@@ -9,5 +9,6 @@ export default function AppearanceGroup(field: any, editField: any): {
         field: any;
         onChange: (key: any) => (value: any) => void;
         getValue: (key: any) => () => any;
+        isDefaultVisible: {};
     }[];
 };

package/dist/types/features/properties-panel/groups/ConstraintsGroup.d.ts

@@ -7,5 +7,6 @@ export default function ConstraintsGroup(field: any, editField: any): {
         isEdited: any;
         editField: any;
         field: any;
+        isDefaultVisible: (field: any) => any;
     }[];
 };

package/dist/types/features/properties-panel/groups/GeneralGroup.d.ts

@@ -1,5 +1,21 @@
 export default function GeneralGroup(field: any, editField: any, getService: any): {
     id: string;
     label: string;
-    entries: any[];
+    entries: ({
+        id: string;
+        component: (props: any) => any;
+        editField: any;
+        field: any;
+        isEdited: any;
+    } | {
+        id: any;
+        label: any;
+        path: any;
+        field: any;
+        editField: any;
+        description: any;
+        component: (props: any) => any;
+        isEdited: any;
+        isDefaultVisible: any;
+    })[];
 };

package/dist/types/features/properties-panel/groups/SerializationGroup.d.ts

@@ -7,5 +7,6 @@ export default function SerializationGroup(field: any, editField: any): {
         isEdited: any;
         editField: any;
         field: any;
+        isDefaultVisible: {};
     }[];
 };

package/dist/types/features/properties-panel/groups/ValidationGroup.d.ts

@@ -8,6 +8,7 @@ export default function ValidationGroup(field: any, editField: any): {
         field: any;
         isEdited: any;
         onChange: (key: any) => (value: any) => void;
+        isDefaultVisible: (field: any) => boolean;
     }[];
 };
 declare function Required(props: any): any;

package/dist/types/features/properties-panel/groups/ValuesGroups.d.ts

@@ -1 +1 @@
-export default function ValuesGroups(field: any, editField: any): any[];
+export default function ValuesGroups(field: any, editField: any, getService: any): any[];

package/dist/types/features/properties-panel/index.d.ts

@@ -2,6 +2,8 @@ declare namespace _default {
     const __depends__: any[];
     const __init__: string[];
     const propertiesPanel: (string | typeof PropertiesPanelModule)[];
+    const propertiesProvider: (string | typeof PropertiesProvider)[];
 }
 export default _default;
 import PropertiesPanelModule from './PropertiesPanelRenderer';
+import PropertiesProvider from './PropertiesProvider';

package/dist/types/index.d.ts

@@ -13,3 +13,5 @@ export type CreateFormEditorOptions = import('./types').CreateFormEditorOptions;
 import FormEditor from './FormEditor';
 import { schemaVersion } from '@bpmn-io/form-js-viewer';
 export { FormEditor, schemaVersion };
+export { useDebounce, usePrevious, useService } from "./render/hooks";
+export { useService as usePropertiesPanelService, useVariables } from "./features/properties-panel/hooks";

package/dist/types/types.d.ts

@@ -1,29 +1,29 @@
-import { Injector } from 'didi';
-
-export type Module = any;
-export type Schema = any;
-
-export interface FormEditorProperties {
-  [x: string]: any
-}
-
-export interface FormEditorOptions {
-  additionalModules?: Module[];
-  container?: Element | null | string;
-  exporter?: {
-    name: string,
-    version: string
-  };
-  injector?: Injector;
-  modules?: Module[];
-  properties?: FormEditorProperties;
-  [x:string]: any;
-}
-
-export interface CreateFormEditorOptions extends FormEditorOptions {
-  schema?: Schema
-}
-
-export {
-  Injector
+import { Injector } from 'didi';
+
+export type Module = any;
+export type Schema = any;
+
+export interface FormEditorProperties {
+  [x: string]: any
+}
+
+export interface FormEditorOptions {
+  additionalModules?: Module[];
+  container?: Element | null | string;
+  exporter?: {
+    name: string,
+    version: string
+  };
+  injector?: Injector;
+  modules?: Module[];
+  properties?: FormEditorProperties;
+  [x:string]: any;
+}
+
+export interface CreateFormEditorOptions extends FormEditorOptions {
+  schema?: Schema
+}
+
+export {
+  Injector
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bpmn-io/form-js-editor",
-  "version": "1.3.3",
+  "version": "1.4.0",
   "description": "Edit forms - powered by bpmn.io",
   "exports": {
     ".": {
@@ -47,8 +47,8 @@
   },
   "dependencies": {
     "@bpmn-io/draggle": "^4.0.0",
-    "@bpmn-io/form-js-viewer": "^1.3.3",
-    "@bpmn-io/properties-panel": "^3.8.0",
+    "@bpmn-io/form-js-viewer": "^1.4.0",
+    "@bpmn-io/properties-panel": "^3.11.0",
     "array-move": "^3.0.1",
     "big.js": "^6.2.1",
     "ids": "^1.0.0",
@@ -62,5 +62,5 @@
   "files": [
     "dist"
   ],
-  "gitHead": "b3d1acdc9e22089409e11b8a84ad8cc615d8732d"
+  "gitHead": "cf256b38f256abf7b4d676ea5cd2bdf796b08f31"
 }