@genesislcap/foundation-forms 14.116.1 → 14.117.1-alpha-7cac6ae.0

package/dist/foundation-forms.d.ts

@@ -14,6 +14,68 @@ import { StatePropsOfControl } from '@jsonforms/core';
 import { UISchemaElement } from '@jsonforms/core';
 import { ViewTemplate } from '@microsoft/fast-element';
 
+/**
+ * Configuration options available for array renderer.
+ * @public
+ */
+export declare type ArrayRendererOptions = {
+    /**
+     * ChildUiSchema allows you to pass a UiSchema for a particular element,
+     * which can then be multiplied many times by the renderer.
+     * @public
+     */
+    childUiSchema?: UiSchema;
+};
+
+/**
+ * Configuration options available for categorization renderer.
+ * @public
+ */
+export declare type CategorizationRendererOptions = {
+    /**
+     * childElements allows you to pass the UiSchema array in which the renderers groups will be located
+     * @public
+     */
+    childElements?: UiSchema[];
+};
+
+/**
+ * Available configuration options for connected combobox/multiselect.
+ * @public
+ */
+export declare type ConnectedRenderersOptions = {
+    /**
+     * Activates the async search by changing the criteria based on the value from the search-bar.
+     * @public
+     */
+    async?: boolean;
+    /**
+     * The name of the target Data Server query or Request Server requestReply.
+     * @public
+     */
+    allOptionsResourceName?: string;
+    /**
+     * A property that is set to configure the resource to which combobox/multiselect is connected.
+     * @public
+     */
+    datasourceConfig?: DatasourceOptions;
+    /**
+     * Specifies which field should be used as underlying data used when changing selection.
+     * @public
+     */
+    valueField?: string;
+    /**
+     * Field used to display label for the component.
+     * @public
+     */
+    labelField?: string;
+    /**
+     * Property to which we can provide the data to be used instead of data from the server.
+     * @public
+     */
+    data?: any[];
+};
+
 /**
  * Creates a expressions/criteria from given payload
  * @public
@@ -254,6 +316,12 @@ export declare const foundationFormTemplate: ViewTemplate<Form, any>;
 /** @public */
 export declare const genesisErrorTranslator: ErrorTranslator;
 
+/**
+ * Configuration options available for group renderer.
+ * @public
+ */
+export declare type GroupRendererOptions = CategorizationRendererOptions;
+
 /** @internal */
 export declare const logger: Logger;
 
@@ -281,47 +349,139 @@ export declare type RendererEntry = {
 /** @public */
 export declare const renderers: any[];
 
-/** @public */
+/**
+ * Standard configuration options available for all renderers.
+ * @public
+ */
+export declare type StandardRendererOptions = {
+    /**
+     * Setting this property allows you to hide the renderer.
+     * @public
+     */
+    hidden?: boolean;
+    /**
+     * Setting this property enables client-side validation.
+     * @public
+     */
+    validateFn?: (data: any, path: string, label: string) => ErrorObject[];
+    i18n?: {
+        [key: string]: any;
+    };
+};
+
+/**
+ * Orientation options available for stepper renderer.
+ * @public
+ */
+export declare type StepperOrientationOptions = {
+    /**
+     * Configuration options available for the stepper renderer which set the renderer horizontally or vertically.
+     * @public
+     */
+    orientation?: StepperOrientationType;
+};
+
+/**
+ * Available orientation for stepper renderer.
+ * @public
+ */
 export declare type StepperOrientationType = 'vertical' | 'horizontal';
 
-/** @public */
+/**
+ * Configuration options available for stepper renderer.
+ * @public
+ */
+export declare type StepperRendererOptions = CategorizationRendererOptions;
+
+/**
+ * Configuration options available for string renderer.
+ * @public
+ */
+export declare type StringRendererOptions = {
+    /**
+     * Changes the type attribute in the string renderer from text to password.
+     * @public
+     */
+    isPassword?: boolean;
+    /**
+     * Setting this property enables text-area instead of text-field.
+     * @public
+     */
+    textarea?: boolean;
+};
+
+/**
+ * The UI schema, which is passed to JSON Forms, describes the general layout of a form and is just a regular JSON object.
+ * It describes the form by means of different UI schema elements, which can often be categorized into either Controls or Layouts.
+ * @public
+ */
 export declare type UiSchema = {
+    /**
+     * The layouts and control types, which allow you to customize the arrangement of forms.
+     * @public
+     * */
     type: UiSchemaElementType;
+    /**
+     * All layouts need to declare an elements property which contains the children which are to be arranged by the layout.
+     * It is expected to be an array of UI Schema elements, e.g. controls or other layouts.
+     * @public
+     */
     elements: UiSchemaElement[];
+    /**
+     * Allows changing the design-system for renderers.
+     * @public
+     */
     dsPrefix?: string;
-    options?: UiSchemaElementOptions;
+    /**
+     * Options for changing the orientation for the stepper renderer.
+     * @public
+     */
+    options?: StepperOrientationOptions;
 };
 
-/** @public */
+/**
+ * A UiSchemaElement that displays property values in a user interface element.
+ * @public
+ */
 export declare type UiSchemaElement = {
+    /**
+     * The layouts and control types, which allow you to customize the arrangement of forms.
+     * @public
+     * */
     type: UiSchemaElementType;
+    /**
+     * The mandatory scope property, which expects a JSON schema reference value, defines to which property of the data the control should be bound to.
+     * @public
+     */
     scope: string;
+    /**
+     * By default, controls use the name of property they point to as a label.
+     * Setting this property allows you to change the label.
+     * @public
+     */
     label?: string;
+    /**
+     * Setting this property allows you to change the placeholder in input renderers.
+     * @public
+     */
     placeholder?: string;
+    /**
+     * Optional attribute options that determine how the control is rendered.
+     * @public
+     */
     options?: UiSchemaElementOptions;
 };
 
-/** @public */
-export declare type UiSchemaElementOptions = {
-    async?: boolean;
-    orientation?: StepperOrientationType;
-    allOptionsResourceName?: string;
-    datasourceConfig?: DatasourceOptions;
-    hidden?: boolean;
-    isPassword?: boolean;
-    validateFn?: (data: any, path: string, label: string) => ErrorObject[];
-    valueField?: string;
-    labelField?: string;
-    textarea?: boolean;
-    data?: any[];
-    childUiSchema?: UiSchema;
-    childElements?: UiSchema[];
-    i18n?: {
-        [key: string]: any;
-    };
-};
+/**
+ * All configuration options that are available.
+ * @public
+ */
+export declare type UiSchemaElementOptions = ConnectedRenderersOptions | ArrayRendererOptions | CategorizationRendererOptions | GroupRendererOptions | StepperRendererOptions | StringRendererOptions | StandardRendererOptions;
 
-/** @public */
-export declare type UiSchemaElementType = 'Control' | 'VerticalLayout' | any;
+/**
+ * The layouts and control types, which allow you to customize the arrangement of forms.
+ * @public
+ * */
+export declare type UiSchemaElementType = 'Control' | 'VerticalLayout' | 'LayoutVertical2Columns' | 'Categorization' | 'Group' | 'Stepper' | 'HorizontalLayout';
 
 export { }

package/docs/api/foundation-forms.arrayrendereroptions.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [ArrayRendererOptions](./foundation-forms.arrayrendereroptions.md)
+
+## ArrayRendererOptions type
+
+Configuration options available for array renderer.
+
+**Signature:**
+
+```typescript
+export type ArrayRendererOptions = {
+    childUiSchema?: UiSchema;
+};
+```
+**References:** [UiSchema](./foundation-forms.uischema.md)
+

package/docs/api/foundation-forms.categorizationrendereroptions.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md)
+
+## CategorizationRendererOptions type
+
+Configuration options available for categorization renderer.
+
+**Signature:**
+
+```typescript
+export type CategorizationRendererOptions = {
+    childElements?: UiSchema[];
+};
+```
+**References:** [UiSchema](./foundation-forms.uischema.md)
+

package/docs/api/foundation-forms.connectedrenderersoptions.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [ConnectedRenderersOptions](./foundation-forms.connectedrenderersoptions.md)
+
+## ConnectedRenderersOptions type
+
+Available configuration options for connected combobox/multiselect.
+
+**Signature:**
+
+```typescript
+export type ConnectedRenderersOptions = {
+    async?: boolean;
+    allOptionsResourceName?: string;
+    datasourceConfig?: DatasourceOptions;
+    valueField?: string;
+    labelField?: string;
+    data?: any[];
+};
+```

package/docs/api/foundation-forms.grouprendereroptions.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [GroupRendererOptions](./foundation-forms.grouprendereroptions.md)
+
+## GroupRendererOptions type
+
+Configuration options available for group renderer.
+
+**Signature:**
+
+```typescript
+export type GroupRendererOptions = CategorizationRendererOptions;
+```
+**References:** [CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md)
+

package/docs/api/foundation-forms.md

@@ -25,10 +25,18 @@
 
 |  Type Alias | Description |
 |  --- | --- |
+|  [ArrayRendererOptions](./foundation-forms.arrayrendereroptions.md) | Configuration options available for array renderer. |
+|  [CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md) | Configuration options available for categorization renderer. |
+|  [ConnectedRenderersOptions](./foundation-forms.connectedrenderersoptions.md) | Available configuration options for connected combobox/multiselect. |
+|  [GroupRendererOptions](./foundation-forms.grouprendereroptions.md) | Configuration options available for group renderer. |
 |  [RendererEntry](./foundation-forms.rendererentry.md) |  |
-|  [StepperOrientationType](./foundation-forms.stepperorientationtype.md) |  |
-|  [UiSchema](./foundation-forms.uischema.md) |  |
-|  [UiSchemaElement](./foundation-forms.uischemaelement.md) |  |
-|  [UiSchemaElementOptions](./foundation-forms.uischemaelementoptions.md) |  |
-|  [UiSchemaElementType](./foundation-forms.uischemaelementtype.md) |  |
+|  [StandardRendererOptions](./foundation-forms.standardrendereroptions.md) | Standard configuration options available for all renderers. |
+|  [StepperOrientationOptions](./foundation-forms.stepperorientationoptions.md) | Orientation options available for stepper renderer. |
+|  [StepperOrientationType](./foundation-forms.stepperorientationtype.md) | Available orientation for stepper renderer. |
+|  [StepperRendererOptions](./foundation-forms.stepperrendereroptions.md) | Configuration options available for stepper renderer. |
+|  [StringRendererOptions](./foundation-forms.stringrendereroptions.md) | Configuration options available for string renderer. |
+|  [UiSchema](./foundation-forms.uischema.md) | The UI schema, which is passed to JSON Forms, describes the general layout of a form and is just a regular JSON object. It describes the form by means of different UI schema elements, which can often be categorized into either Controls or Layouts. |
+|  [UiSchemaElement](./foundation-forms.uischemaelement.md) | A UiSchemaElement that displays property values in a user interface element. |
+|  [UiSchemaElementOptions](./foundation-forms.uischemaelementoptions.md) | All configuration options that are available. |
+|  [UiSchemaElementType](./foundation-forms.uischemaelementtype.md) | The layouts and control types, which allow you to customize the arrangement of forms. |
 

package/docs/api/foundation-forms.standardrendereroptions.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [StandardRendererOptions](./foundation-forms.standardrendereroptions.md)
+
+## StandardRendererOptions type
+
+Standard configuration options available for all renderers.
+
+**Signature:**
+
+```typescript
+export type StandardRendererOptions = {
+    hidden?: boolean;
+    validateFn?: (data: any, path: string, label: string) => ErrorObject[];
+    i18n?: {
+        [key: string]: any;
+    };
+};
+```

package/docs/api/foundation-forms.stepperorientationoptions.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [StepperOrientationOptions](./foundation-forms.stepperorientationoptions.md)
+
+## StepperOrientationOptions type
+
+Orientation options available for stepper renderer.
+
+**Signature:**
+
+```typescript
+export type StepperOrientationOptions = {
+    orientation?: StepperOrientationType;
+};
+```
+**References:** [StepperOrientationType](./foundation-forms.stepperorientationtype.md)
+

package/docs/api/foundation-forms.stepperorientationtype.md

@@ -4,6 +4,7 @@
 
 ## StepperOrientationType type
 
+Available orientation for stepper renderer.
 
 **Signature:**
 

package/docs/api/foundation-forms.stepperrendereroptions.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [StepperRendererOptions](./foundation-forms.stepperrendereroptions.md)
+
+## StepperRendererOptions type
+
+Configuration options available for stepper renderer.
+
+**Signature:**
+
+```typescript
+export type StepperRendererOptions = CategorizationRendererOptions;
+```
+**References:** [CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md)
+

package/docs/api/foundation-forms.stringrendereroptions.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [StringRendererOptions](./foundation-forms.stringrendereroptions.md)
+
+## StringRendererOptions type
+
+Configuration options available for string renderer.
+
+**Signature:**
+
+```typescript
+export type StringRendererOptions = {
+    isPassword?: boolean;
+    textarea?: boolean;
+};
+```

package/docs/api/foundation-forms.uischema.md

@@ -4,6 +4,7 @@
 
 ## UiSchema type
 
+The UI schema, which is passed to JSON Forms, describes the general layout of a form and is just a regular JSON object. It describes the form by means of different UI schema elements, which can often be categorized into either Controls or Layouts.
 
 **Signature:**
 
@@ -12,8 +13,8 @@ export type UiSchema = {
     type: UiSchemaElementType;
     elements: UiSchemaElement[];
     dsPrefix?: string;
-    options?: UiSchemaElementOptions;
+    options?: StepperOrientationOptions;
 };
 ```
-**References:** [UiSchemaElementType](./foundation-forms.uischemaelementtype.md)<!-- -->, [UiSchemaElement](./foundation-forms.uischemaelement.md)<!-- -->, [UiSchemaElementOptions](./foundation-forms.uischemaelementoptions.md)
+**References:** [UiSchemaElementType](./foundation-forms.uischemaelementtype.md)<!-- -->, [UiSchemaElement](./foundation-forms.uischemaelement.md)<!-- -->, [StepperOrientationOptions](./foundation-forms.stepperorientationoptions.md)
 

package/docs/api/foundation-forms.uischemaelement.md

@@ -4,6 +4,7 @@
 
 ## UiSchemaElement type
 
+A UiSchemaElement that displays property values in a user interface element.
 
 **Signature:**
 

package/docs/api/foundation-forms.uischemaelementoptions.md

@@ -4,28 +4,12 @@
 
 ## UiSchemaElementOptions type
 
+All configuration options that are available.
 
 **Signature:**
 
 ```typescript
-export type UiSchemaElementOptions = {
-    async?: boolean;
-    orientation?: StepperOrientationType;
-    allOptionsResourceName?: string;
-    datasourceConfig?: DatasourceOptions;
-    hidden?: boolean;
-    isPassword?: boolean;
-    validateFn?: (data: any, path: string, label: string) => ErrorObject[];
-    valueField?: string;
-    labelField?: string;
-    textarea?: boolean;
-    data?: any[];
-    childUiSchema?: UiSchema;
-    childElements?: UiSchema[];
-    i18n?: {
-        [key: string]: any;
-    };
-};
+export type UiSchemaElementOptions = ConnectedRenderersOptions | ArrayRendererOptions | CategorizationRendererOptions | GroupRendererOptions | StepperRendererOptions | StringRendererOptions | StandardRendererOptions;
 ```
-**References:** [StepperOrientationType](./foundation-forms.stepperorientationtype.md)<!-- -->, [UiSchema](./foundation-forms.uischema.md)
+**References:** [ConnectedRenderersOptions](./foundation-forms.connectedrenderersoptions.md)<!-- -->, [ArrayRendererOptions](./foundation-forms.arrayrendereroptions.md)<!-- -->, [CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md)<!-- -->, [GroupRendererOptions](./foundation-forms.grouprendereroptions.md)<!-- -->, [StepperRendererOptions](./foundation-forms.stepperrendereroptions.md)<!-- -->, [StringRendererOptions](./foundation-forms.stringrendereroptions.md)<!-- -->, [StandardRendererOptions](./foundation-forms.standardrendereroptions.md)
 

package/docs/api/foundation-forms.uischemaelementtype.md

@@ -4,9 +4,10 @@
 
 ## UiSchemaElementType type
 
+The layouts and control types, which allow you to customize the arrangement of forms.
 
 **Signature:**
 
 ```typescript
-export type UiSchemaElementType = 'Control' | 'VerticalLayout' | any;
+export type UiSchemaElementType = 'Control' | 'VerticalLayout' | 'LayoutVertical2Columns' | 'Categorization' | 'Group' | 'Stepper' | 'HorizontalLayout';
 ```

package/docs/api-report.md

@@ -20,6 +20,26 @@ import { StatePropsOfControl } from '@jsonforms/core';
 import { UISchemaElement } from '@jsonforms/core';
 import { ViewTemplate } from '@microsoft/fast-element';
 
+// @public
+export type ArrayRendererOptions = {
+    childUiSchema?: UiSchema;
+};
+
+// @public
+export type CategorizationRendererOptions = {
+    childElements?: UiSchema[];
+};
+
+// @public
+export type ConnectedRenderersOptions = {
+    async?: boolean;
+    allOptionsResourceName?: string;
+    datasourceConfig?: DatasourceOptions;
+    valueField?: string;
+    labelField?: string;
+    data?: any[];
+};
+
 // Warning: (ae-forgotten-export) The symbol "Expressions" needs to be exported by the entry point index.d.ts
 //
 // @public
@@ -106,6 +126,9 @@ export const foundationFormTemplate: ViewTemplate<Form, any>;
 // @public (undocumented)
 export const genesisErrorTranslator: ErrorTranslator;
 
+// @public
+export type GroupRendererOptions = CategorizationRendererOptions;
+
 // Warning: (ae-internal-missing-underscore) The name "logger" should be prefixed with an underscore because the declaration is marked as @internal
 //
 // @internal (undocumented)
@@ -130,18 +153,41 @@ export type RendererEntry = {
 // @public (undocumented)
 export const renderers: any[];
 
-// @public (undocumented)
+// @public
+export type StandardRendererOptions = {
+    hidden?: boolean;
+    validateFn?: (data: any, path: string, label: string) => ErrorObject[];
+    i18n?: {
+        [key: string]: any;
+    };
+};
+
+// @public
+export type StepperOrientationOptions = {
+    orientation?: StepperOrientationType;
+};
+
+// @public
 export type StepperOrientationType = 'vertical' | 'horizontal';
 
-// @public (undocumented)
+// @public
+export type StepperRendererOptions = CategorizationRendererOptions;
+
+// @public
+export type StringRendererOptions = {
+    isPassword?: boolean;
+    textarea?: boolean;
+};
+
+// @public
 export type UiSchema = {
     type: UiSchemaElementType;
     elements: UiSchemaElement[];
     dsPrefix?: string;
-    options?: UiSchemaElementOptions;
+    options?: StepperOrientationOptions;
 };
 
-// @public (undocumented)
+// @public
 export type UiSchemaElement = {
     type: UiSchemaElementType;
     scope: string;
@@ -150,32 +196,15 @@ export type UiSchemaElement = {
     options?: UiSchemaElementOptions;
 };
 
-// @public (undocumented)
-export type UiSchemaElementOptions = {
-    async?: boolean;
-    orientation?: StepperOrientationType;
-    allOptionsResourceName?: string;
-    datasourceConfig?: DatasourceOptions;
-    hidden?: boolean;
-    isPassword?: boolean;
-    validateFn?: (data: any, path: string, label: string) => ErrorObject[];
-    valueField?: string;
-    labelField?: string;
-    textarea?: boolean;
-    data?: any[];
-    childUiSchema?: UiSchema;
-    childElements?: UiSchema[];
-    i18n?: {
-        [key: string]: any;
-    };
-};
+// @public
+export type UiSchemaElementOptions = ConnectedRenderersOptions | ArrayRendererOptions | CategorizationRendererOptions | GroupRendererOptions | StepperRendererOptions | StringRendererOptions | StandardRendererOptions;
 
-// @public (undocumented)
-export type UiSchemaElementType = 'Control' | 'VerticalLayout' | any;
+// @public
+export type UiSchemaElementType = 'Control' | 'VerticalLayout' | 'LayoutVertical2Columns' | 'Categorization' | 'Group' | 'Stepper' | 'HorizontalLayout';
 
 // Warnings were encountered during analysis:
 //
-// src/types.ts:57:3 - (ae-forgotten-export) The symbol "DispatchRenderer" needs to be exported by the entry point index.d.ts
+// src/types.ts:231:3 - (ae-forgotten-export) The symbol "DispatchRenderer" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-forms",
   "description": "Genesis Foundation Forms",
-  "version": "14.116.1",
+  "version": "14.117.1-alpha-7cac6ae.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -40,17 +40,17 @@
     "test:debug": "genx test --debug"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.116.1",
-    "@genesislcap/genx": "14.116.1",
+    "@genesislcap/foundation-testing": "14.117.1-alpha-7cac6ae.0",
+    "@genesislcap/genx": "14.117.1-alpha-7cac6ae.0",
     "@types/json-schema": "^7.0.11",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.116.1",
-    "@genesislcap/foundation-criteria": "14.116.1",
-    "@genesislcap/foundation-logger": "14.116.1",
-    "@genesislcap/foundation-ui": "14.116.1",
-    "@genesislcap/foundation-utils": "14.116.1",
+    "@genesislcap/foundation-comms": "14.117.1-alpha-7cac6ae.0",
+    "@genesislcap/foundation-criteria": "14.117.1-alpha-7cac6ae.0",
+    "@genesislcap/foundation-logger": "14.117.1-alpha-7cac6ae.0",
+    "@genesislcap/foundation-ui": "14.117.1-alpha-7cac6ae.0",
+    "@genesislcap/foundation-utils": "14.117.1-alpha-7cac6ae.0",
     "@jsonforms/core": "^3.0.0",
     "@microsoft/fast-components": "^2.21.3",
     "@microsoft/fast-element": "^1.7.0",
@@ -70,5 +70,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "109f83c69f5d71ef796621a92eb43971bed3e25f"
+  "gitHead": "2512159d58bbc359d03ec49dd788ca01b9ea0dbf"
 }