@bpmn-io/form-js-viewer 1.3.2 → 1.4.0

package/dist/types/index.d.ts

@@ -14,6 +14,6 @@ export * from "./util";
 export * from "./features";
 export type CreateFormOptions = import('./types').CreateFormOptions;
 import Form from './Form';
-export const schemaVersion: 11;
+export const schemaVersion: 12;
 export { Form };
 export { FormFieldRegistry, FormLayouter, Importer, FieldFactory, PathRegistry } from "./core";

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

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

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

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

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

@@ -1,5 +1,9 @@
 export const formFields: (typeof Default | typeof Group | typeof Image)[];
 export * from "./icons";
+export * from "./Sanitizer";
+import Label from './Label';
+import Description from './Description';
+import Errors from './Errors';
 import Button from './form-fields/Button';
 import Checkbox from './form-fields/Checkbox';
 import Checklist from './form-fields/Checklist';
@@ -12,9 +16,10 @@ import Image from './form-fields/Image';
 import Numberfield from './form-fields/Number';
 import Radio from './form-fields/Radio';
 import Select from './form-fields/Select';
+import Separator from './form-fields/Separator';
 import Spacer from './form-fields/Spacer';
 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 { Button, Checkbox, Checklist, Default, Datetime, FormComponent, FormField, Group, Image, Numberfield, Radio, Select, Spacer, Taglist, Text, Textfield, Textarea };
+export { Label, Description, Errors, Button, Checkbox, Checklist, Default, Datetime, FormComponent, FormField, Group, Image, Numberfield, Radio, Select, Separator, Spacer, Taglist, Text, Textfield, Textarea };

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

@@ -11,14 +11,45 @@ export function generateIdForType(type: any): string;
  */
 export function clone<T>(data: T, replacer?: (this: any, key: string, value: any) => any): T;
 /**
- * Parse the schema for input variables a form might make use of
+ * @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 {any} schema
+ * @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: any, options?: {}): 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bpmn-io/form-js-viewer",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "description": "View forms - powered by bpmn.io",
   "exports": {
     ".": {
@@ -63,5 +63,5 @@
   "files": [
     "dist"
   ],
-  "gitHead": "9a3a4503421fde61e91e398d43a16b5a8cacfd47"
+  "gitHead": "cf256b38f256abf7b4d676ea5cd2bdf796b08f31"
 }