@genesislcap/foundation-forms 14.116.1 → 14.117.0

package/README.md

@@ -356,7 +356,7 @@ const arrayUISchema = {
   type: "VerticalLayout",
   elements: [
     {
-      type: "array",
+      type: "Control",
       scope: "#/properties/users",
       options: {
         childUiSchema: {
@@ -421,7 +421,7 @@ const categoryUISchema = {
   type: "Categorization",
   elements: [
     {
-      type: "Category",
+      type: "Control",
       scope: "#/properties/basic",
       label: "Personal information",
       options: {
@@ -443,7 +443,7 @@ const categoryUISchema = {
       },
     },
     {
-      type: "Category",
+      type: "Control",
       label: "Address",
       scope: "#/properties/address",
       options: {
@@ -540,7 +540,7 @@ const uiSchemaStepper = {
   type: 'Stepper',
   elements: [
     {
-      type: 'Step',
+      type: 'Control',
       scope: '#/properties/person',
       label: 'Entity',
       options: {
@@ -575,7 +575,7 @@ const uiSchemaStepper = {
       },
     },
     {
-      type: 'Step',
+      type: 'Control',
       label: 'Doc',
       scope: '#/properties/address',
       options: {
@@ -610,7 +610,7 @@ const uiSchemaStepper = {
       },
     },
     {
-      type: 'Step',
+      type: 'Control',
       label: 'Primary doc',
       scope: '#/properties/vegetarianOptions',
       options: {

package/dist/dts/jsonforms/renderers/StringControlRenderer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StringControlRenderer.d.ts","sourceRoot":"","sources":["../../../../src/jsonforms/renderers/StringControlRenderer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAIvD,eAAO,MAAM,gCAAgC,YAAY,MAAM,0EAwB9D,CAAC;AACF,eAAO,MAAM,6BAA6B,uEAEzC,CAAC"}
+{"version":3,"file":"StringControlRenderer.d.ts","sourceRoot":"","sources":["../../../../src/jsonforms/renderers/StringControlRenderer.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AASvD,eAAO,MAAM,gCAAgC,YAAY,MAAM,0EAsC9D,CAAC;AACF,eAAO,MAAM,6BAA6B,uEAEzC,CAAC"}

package/dist/dts/types.d.ts

@@ -3,43 +3,195 @@ import { JsonFormsState, OwnPropsOfControl, RankedTester, StatePropsOfControl }
 import { ViewTemplate } from '@microsoft/fast-element';
 import { ErrorObject } from 'ajv';
 import { DispatchRenderer } from './jsonforms/renderers/dispatch-renderer';
-/** @public */
-export type UiSchemaElementType = 'Control' | 'VerticalLayout' | any;
-/** @public */
+/**
+ * The layouts and control types, which allow you to customize the arrangement of forms.
+ * @public
+ * */
+export type UiSchemaElementType = 'Control' | 'VerticalLayout' | 'LayoutVertical2Columns' | 'Categorization' | 'Group' | 'Stepper' | 'HorizontalLayout';
+/**
+ * Available orientation for stepper renderer.
+ * @public
+ */
 export type StepperOrientationType = 'vertical' | 'horizontal';
-/** @public */
-export type UiSchemaElementOptions = {
+/**
+ * Available configuration options for connected combobox/multiselect.
+ * @public
+ */
+export type ConnectedRenderersOptions = {
+    /**
+     * Activates the async search by changing the criteria based on the value from the search-bar.
+     * @public
+     */
     async?: boolean;
-    orientation?: StepperOrientationType;
+    /**
+     * 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;
-    hidden?: boolean;
-    isPassword?: boolean;
-    validateFn?: (data: any, path: string, label: string) => ErrorObject[];
+    /**
+     * 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;
-    textarea?: boolean;
+    /**
+     * Property to which we can provide the data to be used instead of data from the server.
+     * @public
+     */
     data?: any[];
+};
+/**
+ * Configuration options available for array renderer.
+ * @public
+ */
+export 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;
+};
+/**
+ * Orientation options available for stepper renderer.
+ * @public
+ */
+export type StepperOrientationOptions = {
+    /**
+     * Configuration options available for the stepper renderer which set the renderer horizontally or vertically.
+     * @public
+     */
+    orientation?: StepperOrientationType;
+};
+/**
+ * Configuration options available for categorization renderer.
+ * @public
+ */
+export type CategorizationRendererOptions = {
+    /**
+     * childElements allows you to pass the UiSchema array in which the renderers groups will be located
+     * @public
+     */
     childElements?: UiSchema[];
+};
+/**
+ * Configuration options available for group renderer.
+ * @public
+ */
+export type GroupRendererOptions = CategorizationRendererOptions;
+/**
+ * Configuration options available for stepper renderer.
+ * @public
+ */
+export type StepperRendererOptions = CategorizationRendererOptions;
+/**
+ * Configuration options available for string renderer.
+ * @public
+ */
+export 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;
+};
+/**
+ * Standard configuration options available for all renderers.
+ * @public
+ */
+export 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;
     };
 };
-/** @public */
+/**
+ * All configuration options that are available.
+ * @public
+ */
+export type UiSchemaElementOptions = ConnectedRenderersOptions | ArrayRendererOptions | CategorizationRendererOptions | GroupRendererOptions | StepperRendererOptions | StringRendererOptions | StandardRendererOptions;
+/**
+ * A UiSchemaElement that displays property values in a user interface element.
+ * @public
+ */
 export 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 */
+/**
+ * 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 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 */
 export type RendererEntry = {

package/dist/dts/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,mBAAmB,EACpB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,KAAK,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAE3E,cAAc;AACd,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,gBAAgB,GAAG,GAAG,CAAC;AAErE,cAAc;AACd,MAAM,MAAM,sBAAsB,GAAG,UAAU,GAAG,YAAY,CAAC;AAE/D,cAAc;AACd,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,sBAAsB,CAAC;IACrC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IACrC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,WAAW,EAAE,CAAC;IACvE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,aAAa,CAAC,EAAE,QAAQ,CAAC;IACzB,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC3B,IAAI,CAAC,EAAE;QACL,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH,CAAC;AAEF,cAAc;AACd,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,mBAAmB,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,sBAAsB,CAAC;CAClC,CAAC;AAEF,cAAc;AACd,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,mBAAmB,CAAC;IAC1B,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,sBAAsB,CAAC;CAClC,CAAC;AAEF,cAAc;AACd,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,YAAY,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;IAC9C,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,iBAAiB,KAAK,mBAAmB,CAAC;CACrF,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,mBAAmB,EACpB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,KAAK,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAE3E;;;KAGK;AACL,MAAM,MAAM,mBAAmB,GAC3B,SAAS,GACT,gBAAgB,GAChB,wBAAwB,GACxB,gBAAgB,GAChB,OAAO,GACP,SAAS,GACT,kBAAkB,CAAC;AAEvB;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,GAAG,YAAY,CAAC;AAE/D;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IACrC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;CACd,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;OAIG;IACH,aAAa,CAAC,EAAE,QAAQ,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;;OAGG;IACH,WAAW,CAAC,EAAE,sBAAsB,CAAC;CACtC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;OAGG;IACH,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC;CAC5B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,6BAA6B,CAAC;AAEjE;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,6BAA6B,CAAC;AAEnE;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,WAAW,EAAE,CAAC;IACvE,IAAI,CAAC,EAAE;QACL,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAC9B,yBAAyB,GACzB,oBAAoB,GACpB,6BAA6B,GAC7B,oBAAoB,GACpB,sBAAsB,GACtB,qBAAqB,GACrB,uBAAuB,CAAC;AAE5B;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;SAGK;IACL,IAAI,EAAE,mBAAmB,CAAC;IAC1B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAC;CAClC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;;SAGK;IACL,IAAI,EAAE,mBAAmB,CAAC;IAC1B;;;;OAIG;IACH,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,yBAAyB,CAAC;CACrC,CAAC;AAEF,cAAc;AACd,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,YAAY,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;IAC9C,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,iBAAiB,KAAK,mBAAmB,CAAC;CACrF,CAAC"}

package/dist/esm/jsonforms/renderers/StringControlRenderer.js

@@ -1,5 +1,10 @@
+import { whenElse } from '@genesislcap/foundation-utils';
 import { html } from '@microsoft/fast-element';
 //   <pre>${(x) => JSON.stringify(x.control, null, 2)}</pre>
+function changeHandler(x, c) {
+    const inputValue = c.event.target.value;
+    x.control.handleChange(x.control.path, inputValue === '' ? null : inputValue);
+}
 export const getStringControlRendererTemplate = (prefix = 'zero') => html `
   <template>
     <control-wrapper
@@ -7,21 +12,31 @@ export const getStringControlRendererTemplate = (prefix = 'zero') => html `
       :touched=${(x) => x.touched}
       ?submitted=${(x) => x.submitted}
     >
-      <${prefix}-text-field
-        type=${(x) => { var _a, _b; return (((_b = (_a = x.control.uischema) === null || _a === void 0 ? void 0 : _a.options) === null || _b === void 0 ? void 0 : _b.isPassword) ? 'password' : 'text'); }}
-        :value=${(x) => x.control.data || ''}
-        @change=${(x, c) => {
-    const inputValue = c.event.target.value;
-    x.control.handleChange(x.control.path, inputValue === '' ? null : inputValue);
-}}
-        placeholder=${(x) => x.control.uischema.placeholder || x.control.label}
-        id=${(x) => x.control.path}
-        data-test-id=${(x) => x.control.path}
-        ?required=${(x) => x.control.required}
-        ?disabled=${(x) => !x.control.enabled}
-        style="width: 100%"
-        @blur=${(x) => x.onBlur()}
-      ></${prefix}-text-field>
+      ${whenElse((x) => { var _a, _b; return !((_b = (_a = x.control.uischema) === null || _a === void 0 ? void 0 : _a.options) === null || _b === void 0 ? void 0 : _b.textarea); }, html `
+          <${prefix}-text-field
+            type=${(x) => { var _a, _b; return (((_b = (_a = x.control.uischema) === null || _a === void 0 ? void 0 : _a.options) === null || _b === void 0 ? void 0 : _b.isPassword) ? 'password' : 'text'); }}
+            :value=${(x) => x.control.data || ''}
+            @change=${changeHandler}
+            placeholder=${(x) => x.control.uischema.placeholder || x.control.label}
+            id=${(x) => x.control.path}
+            data-test-id=${(x) => x.control.path}
+            ?required=${(x) => x.control.required}
+            ?disabled=${(x) => !x.control.enabled}
+            style="width: 100%"
+            @blur=${(x) => x.onBlur()}
+          ></${prefix}-text-field>`, html `
+          <${prefix}-text-area
+            :value=${(x) => x.control.data || ''}
+            @change=${changeHandler}
+            placeholder=${(x) => x.control.uischema.placeholder || x.control.label}
+            id=${(x) => x.control.path}
+            data-test-id=${(x) => x.control.path}
+            ?required=${(x) => x.control.required}
+            ?disabled=${(x) => !x.control.enabled}
+            style="width: 100%"
+            @blur=${(x) => x.onBlur()}
+          ></${prefix}-text-area>
+        `)}
     </control-wrapper>
   </template>
 `;