[REFACTOR] Remove json2typescript dependency (#443)

* Remove json2typescript dependency
* Change return type in some converters
* Update doc

docs/architecture/bpmn-parsing.adoc

@@ -8,7 +8,7 @@ You can see the implementation in *BpmnXmlParser.ts*.
 
 ==== Json Parser
 
-To parse a JSON data, we use the library https://github.com/AppVision-GmbH/json2typescript[json2typescript].
+To parse a JSON data, we use a custom parser.
 
 You can see the implementation in *BpmnJsonParser.ts*.
-We create our custom _converters_ (in the *converter* folder where the *BpmnJsonParser* file is) in order to match the BPMN model to our internal model.
+We have different _converters_ (in the *converter* folder where the *BpmnJsonParser* file is) in order to match the BPMN model to our internal model.

package.json

@@ -78,7 +78,6 @@
   "dependencies": {
     "entities": "^2.0.0",
     "fast-xml-parser": "^3.16.0",
-    "json2typescript": "^1.2.5",
     "mxgraph": "4.1.0"
   }
 }

src/component/parser/json/BpmnJsonParser.ts

@@ -13,22 +13,25 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Definitions } from './Definitions';
 import BpmnModel from '../../../model/bpmn/BpmnModel';
-import JsonConvertConfig from './converter/JsonConvertConfig';
-import { JsonConvert } from 'json2typescript';
-import { BpmnJsonModel } from '../xml/bpmn-json-model/BPMN20';
+import { BpmnJsonModel, TDefinitions } from '../xml/bpmn-json-model/BPMN20';
+import CollaborationConverter from './converter/CollaborationConverter';
+import ProcessConverter from './converter/ProcessConverter';
+import DiagramConverter from './converter/DiagramConverter';
 
 export default class BpmnJsonParser {
-  constructor(readonly jsonConvert: JsonConvert) {}
+  constructor(readonly collaborationConverter: CollaborationConverter, readonly processConverter: ProcessConverter, readonly diagramConverter: DiagramConverter) {}
 
   public parse(json: BpmnJsonModel): BpmnModel {
-    const definitions = this.jsonConvert.deserializeObject(json.definitions, Definitions);
-    return definitions.bpmnModel;
+    const definitions: TDefinitions = json.definitions;
+
+    this.collaborationConverter.deserialize(definitions.collaboration);
+    this.processConverter.deserialize(definitions.process);
+    return this.diagramConverter.deserialize(definitions.BPMNDiagram);
   }
 }
 
 export function defaultBpmnJsonParser(): BpmnJsonParser {
   // TODO replace the function by dependency injection, see #110
-  return new BpmnJsonParser(JsonConvertConfig.jsonConvert());
+  return new BpmnJsonParser(new CollaborationConverter(), new ProcessConverter(), new DiagramConverter());
 }

src/component/parser/json/converter/AbstractConverter.ts

@@ -13,9 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { JsonConverter, JsonCustomConvert } from 'json2typescript';
-import JsonConvertConfig from './JsonConvertConfig';
-
 function convertEmptyStringAndObject<T>(element: string | T, acceptEmptyString: boolean): T {
   if (element === '') {
     return acceptEmptyString ? ({} as T) : undefined;
@@ -37,17 +34,7 @@ export function ensureIsArray<T>(elements: (T | string)[] | T | string, acceptEm
   return returnedArray.filter(value => value);
 }
 
-@JsonConverter
-export abstract class AbstractConverter<T> implements JsonCustomConvert<T> {
-  // TODO find a way to inject JsonConvert, see #110
-  protected readonly jsonConvert = JsonConvertConfig.jsonConvert();
-
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars,@typescript-eslint/no-explicit-any
-  serialize(data: T): any {
-    // TODO throw exception
-    console.error('Not implemented !!');
-  }
-
+export abstract class AbstractConverter<T> {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   abstract deserialize(data: any): T;
 }

src/component/parser/json/converter/CollaborationConverter.ts

@@ -13,10 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { JsonConverter } from 'json2typescript';
 import { AbstractConverter, ensureIsArray } from './AbstractConverter';
 import { Participant } from '../../../../model/bpmn/shape/ShapeBpmnElement';
-import { Collaboration } from '../Definitions';
 import { MessageFlow } from '../../../../model/bpmn/edge/Flow';
 import { FlowKind } from '../../../../model/bpmn/edge/FlowKind';
 import { TCollaboration } from '../../xml/bpmn-json-model/baseElement/rootElement/collaboration';
@@ -38,17 +36,14 @@ export function findMessageFlow(id: string): MessageFlow {
   return convertedMessageFlows.find(i => i.id === id);
 }
 
-@JsonConverter
-export default class CollaborationConverter extends AbstractConverter<Collaboration> {
-  deserialize(collaborations: string | TCollaboration | (string | TCollaboration)[]): Collaboration {
+export default class CollaborationConverter extends AbstractConverter<void> {
+  deserialize(collaborations: string | TCollaboration | (string | TCollaboration)[]): void {
     try {
       // Deletes everything in the array, which does hit other references. For better performance.
       convertedProcessRefParticipants.length = 0;
       convertedMessageFlows.length = 0;
 
       ensureIsArray(collaborations).forEach(collaboration => this.parseCollaboration(collaboration));
-
-      return {};
     } catch (e) {
       // TODO error management
       console.error(e as Error);

src/component/parser/json/converter/DiagramConverter.ts

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { JsonConverter } from 'json2typescript';
 import { AbstractConverter, ensureIsArray } from './AbstractConverter';
 import Shape from '../../../../model/bpmn/shape/Shape';
 import Bounds from '../../../../model/bpmn/Bounds';
@@ -37,7 +36,6 @@ function findProcessElement(participantId: string): ShapeBpmnElement {
   }
 }
 
-@JsonConverter
 export default class DiagramConverter extends AbstractConverter<BpmnModel> {
   private convertedFonts: Map<string, Font> = new Map();
 
@@ -134,7 +132,7 @@ export default class DiagramConverter extends AbstractConverter<BpmnModel> {
   private deserializeBounds(boundedElement: BPMNShape | BPMNLabel): Bounds {
     const bounds = boundedElement.Bounds;
     if (bounds) {
-      return this.jsonConvert.deserializeObject(bounds, Bounds);
+      return new Bounds(bounds.x, bounds.y, bounds.width, bounds.height);
     }
   }
 
@@ -151,10 +149,8 @@ export default class DiagramConverter extends AbstractConverter<BpmnModel> {
     });
   }
 
-  private deserializeWaypoints(waypoint: Point[]): Waypoint[] {
-    if (waypoint) {
-      return this.jsonConvert.deserializeArray(ensureIsArray(waypoint), Waypoint);
-    }
+  private deserializeWaypoints(waypoints: Point[]): Waypoint[] {
+    return ensureIsArray(waypoints).map(waypoint => new Waypoint(waypoint.x, waypoint.y));
   }
 
   private deserializeLabel(bpmnLabel: string | BPMNLabel, id: string): Label {

src/component/parser/json/converter/ProcessConverter.ts

@@ -13,11 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { JsonConverter } from 'json2typescript';
 import { AbstractConverter, ensureIsArray } from './AbstractConverter';
 import ShapeBpmnElement, { ShapeBpmnBoundaryEvent, ShapeBpmnEvent, ShapeBpmnSubProcess } from '../../../../model/bpmn/shape/ShapeBpmnElement';
 import { ShapeBpmnElementKind } from '../../../../model/bpmn/shape/ShapeBpmnElementKind';
-import { Process } from '../Definitions';
 import { AssociationFlow, SequenceFlow } from '../../../../model/bpmn/edge/Flow';
 import { ShapeBpmnEventKind, supportedBpmnEventKinds } from '../../../../model/bpmn/shape/ShapeBpmnEventKind';
 import ShapeUtil, { BpmnEventKind } from '../../../../model/bpmn/shape/ShapeUtil';
@@ -68,10 +66,9 @@ interface EventDefinition {
   counter: number;
 }
 
-@JsonConverter
-export default class ProcessConverter extends AbstractConverter<Process> {
+export default class ProcessConverter extends AbstractConverter<void> {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  deserialize(processes: string | TProcess | (string | TProcess)[]): Process {
+  deserialize(processes: string | TProcess | (string | TProcess)[]): void {
     try {
       // Deletes everything in the array, which does hit other references. For better performance.
       convertedFlowNodeBpmnElements.length = 0;
@@ -82,8 +79,6 @@ export default class ProcessConverter extends AbstractConverter<Process> {
       defaultSequenceFlowIds.length = 0;
 
       ensureIsArray(processes).forEach(process => this.parseProcess(process));
-
-      return {};
     } catch (e) {
       // TODO error management
       console.error(e as Error);

src/model/bpmn/Bounds.ts

@@ -13,39 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { JsonObject, JsonProperty } from 'json2typescript';
-
-@JsonObject('Bounds')
 export default class Bounds {
-  @JsonProperty('x', Number)
-  private _x: number;
-
-  @JsonProperty('y', Number)
-  private _y: number;
-
-  @JsonProperty('width', Number)
-  private _width: number;
-
-  @JsonProperty('height', Number)
-  private _height: number;
-
-  public constructor(x?: number, y?: number, width?: number, height?: number) {
-    this._x = x;
-    this._y = y;
-    this._width = width;
-    this._height = height;
-  }
-
-  get height(): number {
-    return this._height;
-  }
-  get width(): number {
-    return this._width;
-  }
-  get y(): number {
-    return this._y;
-  }
-  get x(): number {
-    return this._x;
-  }
+  public constructor(readonly x: number, readonly y: number, readonly width: number, readonly height: number) {}
 }

src/model/bpmn/edge/Waypoint.ts

@@ -13,25 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { JsonProperty } from 'json2typescript';
-
 export default class Waypoint {
-  @JsonProperty('x', Number)
-  private readonly _x: number;
-
-  @JsonProperty('y', Number)
-  private readonly _y: number;
-
-  constructor(x?: number, y?: number) {
-    this._x = x;
-    this._y = y;
-  }
-
-  public get y(): number {
-    return this._y;
-  }
-
-  public get x(): number {
-    return this._x;
-  }
+  constructor(readonly x: number, readonly y: number) {}
 }

test/unit/component/parser/json/BpmnJsonParser.event.test.ts

@@ -152,7 +152,7 @@ function executeEventCommonTests(
       });
 
       it(`should NOT convert, when there are several '${eventDefinitionKind}EventDefinition' in the same element${specificTitle}, ${titleForEventDefinitionIsAttributeOf}`, () => {
-        const eventDefinition = [{}, {}];
+        const eventDefinition = ['', {}];
         const json = buildDefinitionsAndProcessWithTask();
         addEvent(json, bpmnKind, { ...buildEventDefinitionParameter, eventDefinition }, specificBuildEventParameter);
 

test/unit/component/parser/json/JsonBuilder.ts

@@ -21,7 +21,7 @@ import { TFlowNode } from '../../../../../src/component/parser/xml/bpmn-json-mod
 import { BPMNPlane, BPMNShape } from '../../../../../src/component/parser/xml/bpmn-json-model/BPMNDI';
 
 type BPMNTEvent = TCatchEvent | TThrowEvent | TBoundaryEvent;
-type BPMNEventDefinition = string | TEventDefinition | TEventDefinition[];
+type BPMNEventDefinition = string | TEventDefinition | (string | TEventDefinition)[];
 
 export enum EventDefinitionOn {
   NONE,
@@ -140,7 +140,7 @@ export function addEventDefinitionsOnDefinition(jsonModel: BpmnJsonModel, buildP
     const eventDefinition = buildParameter.eventDefinition ? buildParameter.eventDefinition : { id: 'event_definition_id' };
     addEventDefinitions(jsonModel.definitions, { ...buildParameter, eventDefinition });
     if (Array.isArray(eventDefinition)) {
-      event.eventDefinitionRef = eventDefinition.map(eventDefinition => eventDefinition.id);
+      event.eventDefinitionRef = eventDefinition.map(eventDefinition => (typeof eventDefinition === 'string' ? eventDefinition : eventDefinition.id));
     } else {
       event.eventDefinitionRef = (eventDefinition as TEventDefinition).id;
     }