Skip to content

Commit

Permalink
fix: lint errors for AID
Browse files Browse the repository at this point in the history
  • Loading branch information
@danielpeintner
danielpeintner committed Sep 14, 2023
1 parent 6b4b010 commit 4204a90
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 39 deletions.
89 changes: 51 additions & 38 deletions packages/td-tools/src/util/asset-interface-description.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ export class AssetInterfaceDescriptionUtil {
public transformTD2SM(tdAsString: string, protocols?: string[]): string {
const td: ThingDescription = TDParser.parseTD(tdAsString);

const aidID = td.id ? td.id : "ID" + Math.random();
const aidID = td.id != null ? td.id : "ID" + Math.random();

logInfo("TD " + td.title + " parsed...");

Expand Down Expand Up @@ -218,9 +218,9 @@ export class AssetInterfaceDescriptionUtil {
}

private updateProtocolPrefixes(forms: [FormElementBase, ...FormElementBase[]], protocols: string[]): void {
if (forms) {
if (forms !== undefined) {
for (const interactionForm of forms) {
if (interactionForm.href) {
if (interactionForm.href != null) {
const positionColon = interactionForm.href.indexOf(":");
if (positionColon > 0) {
const prefix = interactionForm.href.substring(0, positionColon);
Expand All @@ -234,7 +234,7 @@ export class AssetInterfaceDescriptionUtil {
}

private getBaseFromEndpointMetadata(endpointMetadata?: Record<string, unknown>): string {
if (endpointMetadata?.value && endpointMetadata.value instanceof Array) {
if (endpointMetadata?.value !== undefined && endpointMetadata.value instanceof Array) {
for (const v of endpointMetadata.value) {
if (v.idShort === "base") {
// e.g., "value": "modbus+tcp://192.168.1.187:502"
Expand All @@ -246,7 +246,7 @@ export class AssetInterfaceDescriptionUtil {
}

private getContentTypeFromEndpointMetadata(endpointMetadata?: Record<string, unknown>): string {
if (endpointMetadata?.value && endpointMetadata.value instanceof Array) {
if (endpointMetadata?.value !== undefined && endpointMetadata.value instanceof Array) {
for (const v of endpointMetadata.value) {
if (v.idShort === "contentType") {
// e.g., "value": "application/octet-stream;byteSeq=BIG_ENDIAN"
Expand All @@ -264,18 +264,18 @@ export class AssetInterfaceDescriptionUtil {
[k: string]: SecurityScheme;
} = {};

if (endpointMetadata?.value && endpointMetadata.value instanceof Array) {
if (endpointMetadata?.value !== undefined && endpointMetadata.value instanceof Array) {
for (const v of endpointMetadata.value) {
if (v.idShort === "securityDefinitions") {
// const securitySchemes: Array<SecurityScheme> = [];
if (v.value && v.value instanceof Array) {
if (v.value !== undefined && v.value instanceof Array) {
for (const securityDefinitionsValues of v.value) {
if (securityDefinitionsValues.idShort) {
if (securityDefinitionsValues.idShort !== undefined) {
// key
if (securityDefinitionsValues.value instanceof Array) {
for (const securityDefinitionsValue of securityDefinitionsValues.value) {
if (securityDefinitionsValue.idShort === "scheme") {
if (securityDefinitionsValue.value) {
if (securityDefinitionsValue.value !== undefined) {
const ss: SecurityScheme = { scheme: securityDefinitionsValue.value };
securityDefinitions[securityDefinitionsValues.idShort] = ss;
}
Expand All @@ -295,12 +295,12 @@ export class AssetInterfaceDescriptionUtil {
endpointMetadata?: Record<string, unknown>
): string | [string, ...string[]] {
const security: string[] = [];
if (endpointMetadata?.value && endpointMetadata.value instanceof Array) {
if (endpointMetadata?.value !== undefined && endpointMetadata.value instanceof Array) {
for (const v of endpointMetadata.value) {
if (v.idShort === "security") {
if (v.value && v.value instanceof Array) {
if (v.value !== undefined && v.value instanceof Array) {
for (const securityValue of v.value) {
if (securityValue.value) {
if (securityValue.value !== undefined) {
security.push(securityValue.value);
}
}
Expand Down Expand Up @@ -346,17 +346,16 @@ export class AssetInterfaceDescriptionUtil {
}
} else if (typeof v.idShort === "string" && v.idShort.length > 0) {
// TODO is this still relevant?
// pick *any* value (and possibly override, e.g, contentType)
// pick *any* value (and possibly override, e. g, contentType)
// TODO Should we add all value's (e.g., dataMapping might be empty array) ?
// if (typeof v.value === "string" ||typeof v.value === "number" || typeof v.value === "boolean") {
if (v.value) {
if (v.value !== undefined) {
form[v.idShort] = v.value;
// use valueType to convert the string value
if (
v.valueType &&
v.valueType &&
v.valueType.dataObjectType &&
v.valueType.dataObjectType.name &&
v.valueType !== undefined &&
v.valueType.dataObjectType !== undefined &&
v.valueType.dataObjectType.name !== undefined &&
typeof v.valueType.dataObjectType.name === "string"
) {
// XSD schemaTypes, https://www.w3.org/TR/xmlschema-2/#built-in-datatypes
Expand Down Expand Up @@ -400,12 +399,20 @@ export class AssetInterfaceDescriptionUtil {
submodel: Record<string, unknown>,
submodelRegex?: string
): void {
if (submodel instanceof Object && submodel.idShort && submodel.idShort === "AssetInterfacesDescription") {
if (submodel.submodelElements && submodel.submodelElements instanceof Array) {
if (
submodel instanceof Object &&
submodel.idShort !== undefined &&
submodel.idShort === "AssetInterfacesDescription"
) {
if (submodel.submodelElements !== undefined && submodel.submodelElements instanceof Array) {
for (const submodelElement of submodel.submodelElements) {
if (submodelElement instanceof Object) {
logDebug("SubmodelElement.idShort: " + submodelElement.idShort);
if (submodelRegex && typeof submodelRegex === "string" && submodelRegex.length > 0) {
if (
submodelRegex !== undefined &&
typeof submodelRegex === "string" &&
submodelRegex.length > 0
) {
const regex = new RegExp(submodelRegex);
if (!regex.test(submodelElement.idShort)) {
logInfo("submodel not of interest");
Expand All @@ -422,7 +429,7 @@ export class AssetInterfaceDescriptionUtil {

private processSubmodelElement(smInformation: SubmodelInformation, submodelElement: Record<string, unknown>): void {
// EndpointMetadata vs. InterfaceMetadata
if (submodelElement.value && submodelElement.value instanceof Array) {
if (submodelElement.value !== undefined && submodelElement.value instanceof Array) {
// Note: iterate twice over to collect first EndpointMetadata
let endpointMetadata: Record<string, unknown> = {};
for (const smValue of submodelElement.value) {
Expand All @@ -446,7 +453,7 @@ export class AssetInterfaceDescriptionUtil {
if (smValue instanceof Object) {
if (smValue.idShort === "InterfaceMetadata") {
logInfo("InterfaceMetadata");
if (smValue.value && smValue.value instanceof Array) {
if (smValue.value !== undefined && smValue.value instanceof Array) {
for (const interactionValue of smValue.value) {
if (interactionValue.idShort === "Properties") {
if (interactionValue.value instanceof Array) {
Expand Down Expand Up @@ -510,7 +517,7 @@ export class AssetInterfaceDescriptionUtil {
thing: new Map<string, Record<string, unknown>>(),
};

if (aidModel instanceof Object && aidModel.submodels) {
if (aidModel instanceof Object && aidModel.submodels !== undefined) {
if (aidModel.submodels instanceof Array) {
for (const submodel of aidModel.submodels) {
this.processSubmodel(smInformation, submodel, submodelRegex);
Expand All @@ -522,7 +529,7 @@ export class AssetInterfaceDescriptionUtil {
}

private _transform(smInformation: SubmodelInformation, template?: string): string {
const thing: Thing = template ? JSON.parse(template) : {};
const thing: Thing = template !== undefined ? JSON.parse(template) : {};

// walk over thing information and set them
for (const [key, value] of smInformation.thing) {
Expand All @@ -534,7 +541,7 @@ export class AssetInterfaceDescriptionUtil {
}

// required TD fields
if (!thing["@context"]) {
if (thing["@context"] === undefined) {
thing["@context"] = "https://www.w3.org/2022/wot/td/v1.1";
}
if (!thing.title) {
Expand All @@ -544,7 +551,7 @@ export class AssetInterfaceDescriptionUtil {
// Security in AID is defined for each submodel
// add "securityDefinitions" globally and add them on form level if necessary
// TODO: possible collisions for "security" names *could* be handled by cnt
if (!thing.securityDefinitions) {
if (thing.securityDefinitions === undefined) {
thing.securityDefinitions = {};
}
// let cnt = 1;
Expand Down Expand Up @@ -595,7 +602,10 @@ export class AssetInterfaceDescriptionUtil {
const tdDescription: Record<string, string> = {};
if (aasDescription instanceof Array) {
for (const aasDescriptionEntry of aasDescription) {
if (aasDescriptionEntry.language && aasDescriptionEntry.text) {
if (
aasDescriptionEntry.language !== undefined &&
aasDescriptionEntry.text !== undefined
) {
const language: string = aasDescriptionEntry.language;
const text: string = aasDescriptionEntry.text;
tdDescription[language] = text;
Expand All @@ -613,10 +623,10 @@ export class AssetInterfaceDescriptionUtil {
thing.properties[key].type = interactionValue.value;
}
} else if (interactionValue.idShort === "range") {
if (interactionValue.min) {
if (interactionValue.min !== undefined) {
thing.properties[key].min = interactionValue.min;
}
if (interactionValue.max) {
if (interactionValue.max !== undefined) {
thing.properties[key].max = interactionValue.max;
}
} else if (interactionValue.idShort === "observable") {
Expand Down Expand Up @@ -694,7 +704,7 @@ export class AssetInterfaceDescriptionUtil {
const values: Array<unknown> = [];

// base ?
if (td.base) {
if (td.base !== undefined) {
values.push({
idShort: "base",
valueType: "xs:anyURI",
Expand All @@ -715,7 +725,7 @@ export class AssetInterfaceDescriptionUtil {

// security
const securityValues: Array<unknown> = [];
if (td.security) {
if (td.security !== undefined) {
for (const secKey of td.security) {
securityValues.push({
valueType: "xs:string",
Expand Down Expand Up @@ -779,7 +789,10 @@ export class AssetInterfaceDescriptionUtil {
let formElementPicked: FormElementBase | undefined;
if (propertyValue.forms) {
for (const formElementProperty of propertyValue.forms) {
if (formElementProperty.href?.startsWith(protocol)) {
if (
formElementProperty.href !== undefined &&
formElementProperty.href.startsWith(protocol)
) {
formElementPicked = formElementProperty;
// found matching form --> abort loop
break;
Expand All @@ -793,7 +806,7 @@ export class AssetInterfaceDescriptionUtil {

const propertyValues: Array<unknown> = [];
// type
if (propertyValue.type) {
if (propertyValue.type !== undefined) {
propertyValues.push({
idShort: "type",
valueType: "xs:string",
Expand All @@ -802,7 +815,7 @@ export class AssetInterfaceDescriptionUtil {
});
}
// title
if (propertyValue.title) {
if (propertyValue.title !== undefined) {
propertyValues.push({
idShort: "title",
valueType: "xs:string",
Expand All @@ -811,7 +824,7 @@ export class AssetInterfaceDescriptionUtil {
});
}
// observable
if (propertyValue.observable) {
if (propertyValue.observable !== undefined) {
propertyValues.push({
idShort: "observable",
valueType: "xs:boolean",
Expand All @@ -823,7 +836,7 @@ export class AssetInterfaceDescriptionUtil {
// range and others? Simply add them as is?

// forms
if (formElementPicked) {
if (formElementPicked !== undefined) {
const propertyForm: Array<unknown> = [];

// TODO AID for now supports just *one* href/form
Expand Down Expand Up @@ -861,7 +874,7 @@ export class AssetInterfaceDescriptionUtil {
text: langValue,
});
}
} else if (propertyValue.description) {
} else if (propertyValue.description !== undefined) {
// fallback
description = [];
description.push({
Expand Down
2 changes: 1 addition & 1 deletion packages/td-tools/test/AssetInterfaceDescriptionTest.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ class AssetInterfaceDescriptionUtilTest {
expect(hasObservable).to.equal(true);
expect(hasForms).to.equal(true);
}
if (propertyValue.description) {
if (propertyValue.description !== undefined) {
hasPropertyStatusDescription = true;
expect(propertyValue)
.to.have.property("description")
Expand Down

0 comments on commit 4204a90

Please sign in to comment.