Skip to content

armgit / core

Public Imported from GitHub
0

100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps

UI updates: continued work on or-json-forms

Rich Turner91f06d5d03f4
diff --git a/manager/src/web/shared/locales/en/or.json b/manager/src/web/shared/locales/en/or.json
index 589fda619..43f90681b 100644
--- a/manager/src/web/shared/locales/en/or.json
+++ b/manager/src/web/shared/locales/en/or.json
@@ -408,5 +408,6 @@
"loadFailedRoles": "Failed to load roles",
"loadFailedUsers": "Failed to load users",
"loadFailedServiceUsers": "Failed to load service users",
- "key": "Key"
+ "key": "Key",
+ "anyOfPickerLabel": "{{label}} type"
}
diff --git a/model/src/main/java/org/openremote/model/asset/Asset.java b/model/src/main/java/org/openremote/model/asset/Asset.java
index 7b7452ec4..ddbcb2b5b 100644
--- a/model/src/main/java/org/openremote/model/asset/Asset.java
+++ b/model/src/main/java/org/openremote/model/asset/Asset.java
@@ -36,6 +36,7 @@ import org.openremote.model.jackson.AssetTypeIdResolver;
import org.openremote.model.util.TsIgnore;
import org.openremote.model.validation.AssetValid;
import org.openremote.model.value.AttributeDescriptor;
+import org.openremote.model.value.ValueFormat;
import org.openremote.model.value.ValueType;
import org.openremote.model.util.ValueUtil;
@@ -258,7 +259,7 @@ public abstract class Asset<T extends Asset<?>> implements IdentifiableEntity<T>
public static final AttributeDescriptor<String[]> TAGS = new AttributeDescriptor<>("tags", ValueType.TEXT.asArray()).withOptional(true);
- public static final AttributeDescriptor<String> NOTES = new AttributeDescriptor<>("notes", ValueType.TEXT);
+ public static final AttributeDescriptor<String> NOTES = new AttributeDescriptor<>("notes", ValueType.TEXT).withFormat(ValueFormat.TEXT_MULTILINE());
public static final AttributeDescriptor<String> MANUFACTURER = new AttributeDescriptor<>("manufacturer", ValueType.TEXT).withOptional(true);
public static final AttributeDescriptor<String> MODEL = new AttributeDescriptor<>("model", ValueType.TEXT).withOptional(true);
diff --git a/model/src/main/java/org/openremote/model/value/RegexValueFilter.java b/model/src/main/java/org/openremote/model/value/RegexValueFilter.java
index 9407902eb..ce4eaaae3 100644
--- a/model/src/main/java/org/openremote/model/value/RegexValueFilter.java
+++ b/model/src/main/java/org/openremote/model/value/RegexValueFilter.java
@@ -24,6 +24,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
+import io.swagger.v3.oas.annotations.media.Schema;
import org.openremote.model.util.ValueUtil;
import java.util.Optional;
diff --git a/model/src/main/java/org/openremote/model/value/ValueFormat.java b/model/src/main/java/org/openremote/model/value/ValueFormat.java
index 388bc7204..c9520c0b9 100644
--- a/model/src/main/java/org/openremote/model/value/ValueFormat.java
+++ b/model/src/main/java/org/openremote/model/value/ValueFormat.java
@@ -75,6 +75,7 @@ public class ValueFormat implements Serializable {
public static ValueFormat BOOLEAN_AS_0_1() { return new ValueFormat().setAsNumber(true); }
public static ValueFormat BOOLEAN_AS_OPEN_CLOSED() { return new ValueFormat().setAsOpenClosed(true); }
public static ValueFormat BOOLEAN_AS_PRESSED_RELEASED() { return new ValueFormat().setAsPressedReleased(true); }
+ public static ValueFormat TEXT_MULTILINE() { return new ValueFormat().setMultiline(true); }
/* NUMBER FORMATS */
protected Boolean useGrouping;
@@ -114,6 +115,9 @@ public class ValueFormat implements Serializable {
protected Boolean asOpenClosed;
protected Boolean asMomentary;
+ /* TEXT FORMATS */
+ protected Boolean multiline;
+
public Boolean getUseGrouping() {
return useGrouping;
}
@@ -401,4 +405,13 @@ public class ValueFormat implements Serializable {
this.asSlider = asSlider;
return this;
}
+
+ public Boolean getMultiine() {
+ return multiline;
+ }
+
+ public ValueFormat setMultiline(Boolean multiline) {
+ this.multiline = multiline;
+ return this;
+ }
}
diff --git a/ui/component/or-attribute-input/src/index.ts b/ui/component/or-attribute-input/src/index.ts
index 3b72b6740..96b9540c5 100644
--- a/ui/component/or-attribute-input/src/index.ts
+++ b/ui/component/or-attribute-input/src/index.ts
@@ -185,7 +185,9 @@ export const jsonFormsInputTemplateProvider: (assetDescriptor: AssetDescriptor |
}
// Remove disabled class from container
- containerDiv.value!.classList.remove("disabled");
+ if (containerDiv.value) {
+ containerDiv.value!.classList.remove("disabled");
+ }
return html`
<or-json-forms .renderers="${jsonFormsAttributeRenderers}" ${ref(jsonForms)} .config="${config}"
diff --git a/ui/component/or-json-forms/src/base-element.ts b/ui/component/or-json-forms/src/base-element.ts
index 3b7058306..0b0990d0e 100644
--- a/ui/component/or-json-forms/src/base-element.ts
+++ b/ui/component/or-json-forms/src/base-element.ts
@@ -11,14 +11,15 @@ import {
import {JsonFormsStateContext} from "./index";
/**
- * Adds label and required fields to layouts as well as controls
+ * Adds additional props for layouts which are normally only available for controls
*/
-export interface WithLabelAndRequired {
+export interface AdditionalProps {
label: string;
required: boolean;
+ errors?: string;
}
-export abstract class BaseElement<T extends UISchemaElement, P extends OwnPropsOfRenderer> extends LitElement implements OwnPropsOfRenderer, WithLabelAndRequired {
+export abstract class BaseElement<T extends UISchemaElement, P extends OwnPropsOfRenderer> extends LitElement implements OwnPropsOfRenderer, AdditionalProps {
@property({type: Object})
public state!: JsonFormsStateContext;
@@ -59,6 +60,9 @@ export abstract class BaseElement<T extends UISchemaElement, P extends OwnPropsO
@property({type: Boolean})
public required!: boolean;
+ @property()
+ public errors!: string;
+
public set props(props: P) {
delete (props as any).id;
Object.assign(this, props);
diff --git a/ui/component/or-json-forms/src/controls/control-array-element.ts b/ui/component/or-json-forms/src/controls/control-array-element.ts
index 66b10ffec..7ff3febff 100644
--- a/ui/component/or-json-forms/src/controls/control-array-element.ts
+++ b/ui/component/or-json-forms/src/controls/control-array-element.ts
@@ -23,7 +23,7 @@ import "../json-editor";
import {JsonEditor} from "../json-editor";
import {ControlBaseElement} from "./control-base-element";
import {getTemplateWrapper} from "../index";
-import {WithLabelAndRequired} from "../base-element";
+import {AdditionalProps} from "../base-element";
// language=CSS
const style = css`
@@ -210,7 +210,7 @@ export class ControlArrayElement extends ControlBaseElement {
const childMatchedItemInfo = childConstValue ? this.itemInfos?.find(itemInfo => itemInfo.constValue === childConstValue) : undefined;
const childLabel = childMatchedItemInfo ? childMatchedItemInfo.title : "";
- const props: RendererProps & WithLabelAndRequired = {
+ const props: RendererProps & AdditionalProps = {
renderers: this.renderers,
uischema: controlWithoutLabel("#"),
enabled: this.enabled,
diff --git a/ui/component/or-json-forms/src/controls/control-base-element.ts b/ui/component/or-json-forms/src/controls/control-base-element.ts
index aa666fd3a..2dce042b3 100644
--- a/ui/component/or-json-forms/src/controls/control-base-element.ts
+++ b/ui/component/or-json-forms/src/controls/control-base-element.ts
@@ -17,9 +17,6 @@ export abstract class ControlBaseElement extends BaseElement<ControlElement, Con
@property()
public description?: string | undefined;
- @property()
- public errors!: string;
-
@property()
public rootSchema!: JsonSchema;
diff --git a/ui/component/or-json-forms/src/index.ts b/ui/component/or-json-forms/src/index.ts
index 99b8bfa7a..bf89f7e4f 100644
--- a/ui/component/or-json-forms/src/index.ts
+++ b/ui/component/or-json-forms/src/index.ts
@@ -29,7 +29,7 @@ import {getLabel, getTemplateFromProps} from "./util";
import {useEffect, useMemo, useReducer, useRef} from "haunted";
import {baseStyle} from "./styles";
import {Util} from "@openremote/core";
-import {WithLabelAndRequired} from "./base-element";
+import {AdditionalProps} from "./base-element";
declare global {
interface SymbolConstructor {
@@ -79,7 +79,7 @@ const useEffectAfterFirstRender = (
};
@customElement("or-json-forms")
-export class OrJSONForms extends HauntedLitElement implements OwnPropsOfJsonFormsRenderer, WithLabelAndRequired {
+export class OrJSONForms extends HauntedLitElement implements OwnPropsOfJsonFormsRenderer, AdditionalProps {
@property({type: Object})
public uischema?: UISchemaElement;
@@ -180,7 +180,7 @@ export class OrJSONForms extends HauntedLitElement implements OwnPropsOfJsonForm
}, [core.data, core.errors]);
return html`${guard([contextValue], () => {
- const props: JsonFormsProps & WithLabelAndRequired = {
+ const props: JsonFormsProps & AdditionalProps = {
...mapStateToJsonFormsRendererProps({jsonforms: {...contextValue}}, this),
label: getLabel(schemaToUse, schemaToUse, this.label, undefined) || "",
required: this.required
diff --git a/ui/component/or-json-forms/src/layouts/layout-vertical-element.ts b/ui/component/or-json-forms/src/layouts/layout-vertical-element.ts
index 53b0044de..df2da75d6 100644
--- a/ui/component/or-json-forms/src/layouts/layout-vertical-element.ts
+++ b/ui/component/or-json-forms/src/layouts/layout-vertical-element.ts
@@ -24,7 +24,7 @@ import {ListItem, OrMwcListChangedEvent} from "@openremote/or-mwc-components/or-
import {DefaultColor5} from "@openremote/core";
import "../json-editor";
import {JsonEditor} from "../json-editor";
-import {WithLabelAndRequired} from "../base-element";
+import {AdditionalProps} from "../base-element";
// language=CSS
const style = css`
@@ -50,6 +50,15 @@ const style = css`
margin-left: -5px;
}
+ #errors {
+ color: red;
+ margin-right: 10px;
+ }
+
+ #errors > or-icon {
+ margin-right: 10px;
+ }
+
#header {
display: flex;
align-items: center;
@@ -143,17 +152,21 @@ export class LayoutVerticalElement extends LayoutBaseElement<VerticalLayout | Gr
return html`
<div id="panel">
<div id="header">
- <div id="expander"><or-icon icon="chevron-right"></or-icon><span>${this.label ? computeLabel(this.label, this.required, false) : ""}</span></div>
+ <div id="expander">
+ <or-icon icon="chevron-right"></or-icon>
+ <span>${this.label ? computeLabel(this.label, this.required, false) : ""}</span>
+ </div>
+ ${!this.errors ? `` : html`<div id="errors"><or-icon icon="alert"></or-icon><span>${this.errors}</span></div>`}
<div id="header-buttons"><or-mwc-input .type="${InputType.BUTTON}" outlined .label="${i18next.t("json")}" icon="pencil" @click="${() => this._showJson()}"></or-mwc-input></div>
</div>
<div id="content">
-
- ${dynamic ?
+ ${this.errors ? ``
+ : dynamic ?
this._getDynamicContentTemplate(dynamicValueType)
- : this.getChildProps().map((props: OwnPropsOfRenderer) => {
+ : this.getChildProps().map((props: OwnPropsOfRenderer) => {
- const contentProps: OwnPropsOfRenderer & WithLabelAndRequired = {
+ const contentProps: OwnPropsOfRenderer & AdditionalProps = {
...props,
label: "",
required: false
@@ -177,9 +190,10 @@ export class LayoutVerticalElement extends LayoutBaseElement<VerticalLayout | Gr
})}
</div>
+ ${this.errors ? `` : html`
<div id="add-parameter">
<or-mwc-input .type="${InputType.BUTTON}" .label="${i18next.t("addParameter")}" icon="plus" .disabled="${!dynamic && optionalProps.length === 0}" @click="${() => this._addParameter(optionalProps, dynamicValueType)}"></or-mwc-input>
- </div>
+ </div>`}
</div>
`;
}
diff --git a/ui/component/or-json-forms/src/standard-renderers.ts b/ui/component/or-json-forms/src/standard-renderers.ts
index 6fb4ff41f..3395374d1 100644
--- a/ui/component/or-json-forms/src/standard-renderers.ts
+++ b/ui/component/or-json-forms/src/standard-renderers.ts
@@ -45,7 +45,7 @@ import "./controls/control-input-element";
import "./controls/control-array-element";
import {InputType, OrInputChangedEvent} from "@openremote/or-mwc-components/or-mwc-input";
import {i18next} from "@openremote/or-translate";
-import {WithLabelAndRequired} from "./base-element";
+import {AdditionalProps} from "./base-element";
import {Util} from "@openremote/core";
const hasOneOfItems = (schema: JsonSchema): boolean =>
@@ -81,12 +81,13 @@ export const verticalOrGroupLayoutTester: RankedTester = rankWith(
)
);
-export const verticalLayoutRenderer = (state: JsonFormsStateContext, props: OwnPropsOfJsonFormsRenderer & WithLabelAndRequired) => {
- const contentProps: RendererProps & DispatchPropsOfControl & WithLabelAndRequired = {
+export const verticalLayoutRenderer = (state: JsonFormsStateContext, props: OwnPropsOfJsonFormsRenderer & AdditionalProps) => {
+ const contentProps: RendererProps & DispatchPropsOfControl & AdditionalProps = {
...mapStateToLayoutProps({jsonforms: {...state}}, props),
...mapDispatchToControlProps(state.dispatch),
label: props.label,
- required: props.required
+ required: props.required,
+ errors: props.errors
};
const template = html`<or-json-forms-vertical-layout .state="${state}" .props="${contentProps}"></or-json-forms-vertical-layout>`;
@@ -145,6 +146,7 @@ export const objectControlRenderer = (state: JsonFormsStateContext, props: Contr
uischemas,
schema,
label,
+ errors,
path,
visible,
enabled,
@@ -162,7 +164,7 @@ export const objectControlRenderer = (state: JsonFormsStateContext, props: Contr
rootSchema
);
- const contentProps: OwnPropsOfRenderer & WithLabelAndRequired = {
+ const contentProps: OwnPropsOfRenderer & AdditionalProps = {
visible: visible,
enabled: enabled,
schema: schema,
@@ -171,7 +173,8 @@ export const objectControlRenderer = (state: JsonFormsStateContext, props: Contr
renderers: renderers,
cells: cells,
label: props.label || getLabel(schema, rootSchema, label) || "",
- required: !!props.required || !!required
+ required: !!props.required || !!required,
+ errors: errors
};
return getTemplateFromProps(state, contentProps);
}
@@ -189,14 +192,15 @@ export const anyOfControlRenderer = (state: JsonFormsStateContext, props: Contro
required,
renderers,
cells,
- uischemas,
schema,
label,
path,
+ errors,
visible,
enabled,
uischema,
- rootSchema
+ rootSchema,
+ data
} = mapStateToControlWithDetailProps(jsonFormsContext, props);
const anyOfSchema = resolveSubSchemas(schema, rootSchema, "anyOf");
@@ -211,22 +215,34 @@ export const anyOfControlRenderer = (state: JsonFormsStateContext, props: Contro
anyOfProps.uischemas
);
+ if (data !== undefined && (anyOfProps.indexOfFittingSchema === undefined || anyOfProps.indexOfFittingSchema < 0)) {
+ // Try and match the data using our own combinator info objects
+ const combinatorInfos = getCombinatorInfos(anyOfSchema.anyOf!, rootSchema);
+
+ const constProp = combinatorInfos.length > 0 ? combinatorInfos[0].constProperty : undefined;
+ if (constProp && typeof data === "object" && data[constProp]) {
+ const dataType = data[constProp];
+ anyOfProps.indexOfFittingSchema = combinatorInfos.findIndex((combinatorInfo) => combinatorInfo.constValue === dataType);
+ }
+ }
+
if (anyOfProps.indexOfFittingSchema === undefined || anyOfProps.indexOfFittingSchema < 0) {
- if (props.data !== undefined) {
+ if (data !== undefined) {
// We have data that doesn't match a schema so show invalid template
console.warn("Cannot match anyOf schema to instance data");
- return invalidTemplate();
+ return invalidTemplate(props.label || label);
} else {
// We have no data so show a schema picker
const { handleChange } = mapDispatchToControlProps(state.dispatch);
const combinatorInfos = getCombinatorInfos(anyOfSchema.anyOf!, rootSchema);
- const options: [string, string][] = combinatorInfos.map((combinatorInfo, index) => [index+"", combinatorInfo.title || i18next.t("Item ") + (index+1)]);
+ const options: [string, string][] = combinatorInfos.map((combinatorInfo, index) => [index+"", Util.camelCaseToSentenceCase(combinatorInfo.title) || i18next.t("Item ") + (index+1)]);
const pickerUpdater = (index: number) => {
const matchedInfo = combinatorInfos[index];
handleChange(path, matchedInfo.defaultValueCreator());
};
- return html`
- <or-mwc-input .type="${InputType.SELECT}" .options="${options}" @or-mwc-input-changed="${(ev: OrInputChangedEvent) => pickerUpdater(Number(ev.detail.value))}"></or-mwc-input>
+ const pickerLabel = (props.label || label) ? i18next.t("anyOfPickerLabel", {label: (props.label || label)}) : i18next.t("type");
+ return html`
+ <or-mwc-input class="any-of-picker" .label="${pickerLabel}" .type="${InputType.SELECT}" .options="${options}" @or-mwc-input-changed="${(ev: OrInputChangedEvent) => pickerUpdater(Number(ev.detail.value))}"></or-mwc-input>
`;
}
}
@@ -244,14 +260,15 @@ export const anyOfControlRenderer = (state: JsonFormsStateContext, props: Contro
} as ControlElement;
}
- const contentProps: OwnPropsOfRenderer & WithLabelAndRequired = {
+ const contentProps: OwnPropsOfRenderer & AdditionalProps = {
schema: matchedSchema,
uischema: matchedUischema,
path: path,
renderers: renderers,
cells: cells,
label: props.label || getLabel(matchedSchema, rootSchema, label) || "",
- required: props.required || !!required
+ required: props.required || !!required,
+ errors: errors
}
return getTemplateFromProps(state, contentProps);
@@ -261,7 +278,7 @@ export const allOfControlTester: RankedTester = rankWith(
4,
isAllOfControl
);
-export const allOfControlRenderer = (state: JsonFormsStateContext, props: ControlProps & WithLabelAndRequired) => {
+export const allOfControlRenderer = (state: JsonFormsStateContext, props: ControlProps & AdditionalProps) => {
const jsonFormsContext = {jsonforms: {...state}};
const contentProps = {
...mapStateToControlWithDetailProps(jsonFormsContext, props)
@@ -321,8 +338,8 @@ export function getTemplateWrapper(elementTemplate: TemplateResult, deleteHandle
`;
}
-export function invalidTemplate() {
- return html`<span>No applicable renderer found!</span>`;
+export function invalidTemplate(label: string | undefined) {
+ return html`<span style="padding-right: 5px;">${label}:</span><span><b>Data is invalid!</b></span>`;
}
export function unknownTemplate() {
diff --git a/ui/component/or-json-forms/src/styles.ts b/ui/component/or-json-forms/src/styles.ts
index 468f0b396..f0f1bb622 100644
--- a/ui/component/or-json-forms/src/styles.ts
+++ b/ui/component/or-json-forms/src/styles.ts
@@ -40,4 +40,9 @@ export const baseStyle = css`
.button-clear.hidden {
visibility: hidden;
}
+
+ .any-of-picker {
+ width: 100%;
+ min-width: 200px;
+ }
`;