raain-model 1.10.25 → 1.11.4

package/{cartesian/CartesianMeasureValue.js → src/cartesian/CartesianMeasureValue.ts}

@@ -1,70 +1,94 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CartesianMeasureValue = void 0;
-const CartesianValue_1 = require("./CartesianValue");
-const LatLng_1 = require("./LatLng");
-class CartesianMeasureValue {
-    constructor(json) {
-        if (!(json === null || json === void 0 ? void 0 : json.cartesianValues) || !(json === null || json === void 0 ? void 0 : json.cartesianPixelWidth)) {
+import {ICartesianMeasureValue} from './ICartesianMeasureValue';
+import {CartesianValue} from './CartesianValue';
+import {LatLng} from './LatLng';
+
+export class CartesianMeasureValue implements ICartesianMeasureValue {
+
+    protected cartesianValues: CartesianValue[];
+    protected cartesianPixelWidth: LatLng;
+
+    constructor(json: {
+                    cartesianValues: string | CartesianValue[],
+                    cartesianPixelWidth: { lat: number, lng: number } | LatLng,
+                }
+    ) {
+
+        if (!json?.cartesianValues || !json?.cartesianPixelWidth) {
             throw new Error('CartesianMeasureValue needs cartesianValues && cartesianPixelWidth');
         }
+
         this.setCartesianValuesAsAny(json.cartesianValues);
         this.setCartesianPixelWidth(json.cartesianPixelWidth);
+
     }
-    static From(obj) {
+
+    static From(obj: any): CartesianMeasureValue {
         const created = new CartesianMeasureValue({
             cartesianValues: [],
-            cartesianPixelWidth: { lat: 0, lng: 0 }
+            cartesianPixelWidth: {lat: 0, lng: 0}
         });
+
         if (typeof obj.cartesianValues !== 'undefined') {
             created.setCartesianValuesAsAny(obj.cartesianValues);
         }
+
         if (typeof obj.cartesianPixelWidth !== 'undefined' &&
             typeof obj.cartesianPixelWidth.lat !== 'undefined' &&
             typeof obj.cartesianPixelWidth.lng !== 'undefined') {
             created.setCartesianPixelWidth(obj.cartesianPixelWidth);
         }
+
         return created;
     }
-    getCartesianValuesStringified() {
-        return JSON.stringify({ cartesianValues: this.cartesianValues });
+
+    getCartesianValuesStringified(): string {
+        return JSON.stringify({cartesianValues: this.cartesianValues});
     }
-    getCartesianValues() {
+
+    getCartesianValues(): CartesianValue[] {
         return this.cartesianValues;
     }
-    setCartesianValues(cartesianValues) {
+
+    setCartesianValues(cartesianValues: CartesianValue[]): void {
         this.cartesianValues = cartesianValues;
     }
-    setCartesianValuesAsString(s) {
+
+    setCartesianValuesAsString(s: string): void {
         let values = JSON.parse(s);
         if (values.cartesianValues) {
             values = values.cartesianValues;
         }
+
         if (Array.isArray(values)) {
             this.cartesianValues = [];
             values.forEach(v => {
-                this.cartesianValues.push(new CartesianValue_1.CartesianValue(v));
+                this.cartesianValues.push(new CartesianValue(v));
             });
         }
     }
-    toJSON(stringify = false) {
-        let cartesianValues = this.cartesianValues;
+
+    toJSON(stringify = false): JSON {
+
+        let cartesianValues: any = this.cartesianValues;
         if (stringify) {
-            cartesianValues = JSON.stringify(this.cartesianValues);
+            cartesianValues = JSON.stringify(this.cartesianValues)
         }
-        const json = {
+
+        const json: any = {
             cartesianValues,
             cartesianPixelWidth: this.cartesianPixelWidth,
         };
         return json;
     }
-    toJSONWithCartesianValuesStringified() {
+
+    toJSONWithCartesianValuesStringified(): JSON {
         return {
             cartesianValues: JSON.stringify(this.cartesianValues),
             cartesianPixelWidth: this.cartesianPixelWidth,
-        };
+        } as any;
     }
-    getCartesianValue(json) {
+
+    getCartesianValue(json: { lat: number, lng: number }): CartesianValue {
         for (const value of this.cartesianValues) {
             if (value.lat === json.lat && value.lng === json.lng) {
                 return value;
@@ -72,7 +96,12 @@ class CartesianMeasureValue {
         }
         return null;
     }
-    getCartesianValueRounded(json) {
+
+    getCartesianValueRounded(json: {
+        lat: number,
+        lng: number,
+        scale: number
+    }): CartesianValue {
         for (const value of this.cartesianValues) {
             const latRounded1 = Math.round(json.lat / json.scale) * json.scale;
             const lngRounded1 = Math.round(json.lng / json.scale) * json.scale;
@@ -84,23 +113,24 @@ class CartesianMeasureValue {
         }
         return null;
     }
-    setCartesianValue(json) {
-        this.cartesianValues.push(new CartesianValue_1.CartesianValue(json));
+
+    setCartesianValue(json: { lat: number, lng: number, value: number }): void {
+        this.cartesianValues.push(new CartesianValue(json));
     }
-    getCartesianPixelWidth() {
+
+    getCartesianPixelWidth(): LatLng {
         return this.cartesianPixelWidth;
     }
-    setCartesianPixelWidth(latLng) {
-        this.cartesianPixelWidth = new LatLng_1.LatLng(latLng);
+
+    setCartesianPixelWidth(latLng: { lat: number, lng: number } | LatLng): void {
+        this.cartesianPixelWidth = new LatLng(latLng);
     }
-    setCartesianValuesAsAny(cartesianValues) {
+
+    protected setCartesianValuesAsAny(cartesianValues: any) {
         if (typeof cartesianValues === 'string') {
             this.setCartesianValuesAsString(cartesianValues);
-        }
-        else {
+        } else {
             this.setCartesianValues(cartesianValues);
         }
     }
 }
-exports.CartesianMeasureValue = CartesianMeasureValue;
-//# sourceMappingURL=CartesianMeasureValue.js.map

package/src/cartesian/CartesianValue.ts

@@ -0,0 +1,17 @@
+import {LatLng} from './LatLng';
+
+export class CartesianValue extends LatLng {
+
+    public value: number;
+
+    constructor(json: {
+                    value: number,
+                    lat: number,
+                    lng: number
+                }
+    ) {
+        super(json);
+        this.value = json.value;
+    }
+}
+

package/src/cartesian/ICartesianMeasureValue.ts

@@ -0,0 +1,27 @@
+import {CartesianValue} from './CartesianValue';
+import {LatLng} from './LatLng';
+
+export interface ICartesianMeasureValue {
+
+    getCartesianValuesStringified(): string;
+
+    getCartesianValues(): CartesianValue[];
+
+    setCartesianValues(cartesianValues: CartesianValue[]): void;
+
+    setCartesianValuesAsString(s: string): void;
+
+    toJSON(): JSON;
+
+    toJSONWithCartesianValuesStringified(): JSON;
+
+    getCartesianValue(json: { lat: number, lng: number }): CartesianValue;
+
+    getCartesianValueRounded(json: { lat: number, lng: number, scale?: number }): CartesianValue;
+
+    setCartesianValue(json: { lat: number, lng: number, value: number }): void;
+
+    getCartesianPixelWidth(): LatLng;
+
+    setCartesianPixelWidth(json: { lat: number, lng: number }): void;
+}

package/src/cartesian/LatLng.ts

@@ -0,0 +1,39 @@
+import {QualityTools} from '../quality/tools/QualityTools';
+
+export class LatLng {
+
+    public lat: number;
+    public lng: number;
+
+    constructor(json: {
+        lat: number,
+        lng: number,
+    }) {
+        if (typeof json?.lat === 'undefined' || typeof json?.lng === 'undefined') {
+            throw new Error('LatLng needs valid latitude && longitude');
+        }
+
+        this.lat = json.lat;
+        this.lng = json.lng;
+    }
+
+    public equals(v: LatLng) {
+        return this.lat === v.lat && this.lng === v.lng;
+    }
+
+    setPrecision(precision: number = 12) {
+        const tenPower = Math.pow(10, precision);
+        this.lat = Math.round(this.lat * tenPower) / tenPower;
+        this.lng = Math.round(this.lng * tenPower) / tenPower;
+    }
+
+    rounded(scale: LatLng) {
+        this.lat = QualityTools.RoundLatLng(this.lat, scale.lat, true);
+        this.lng = QualityTools.RoundLatLng(this.lng, scale.lng, true);
+    }
+
+    limitPrecision(precision = 12) {
+        this.lat = QualityTools.LimitWithPrecision(this.lat, precision);
+        this.lng = QualityTools.LimitWithPrecision(this.lng, precision);
+    }
+}

package/src/cartesian/RadarCartesianMeasureValue.ts

@@ -0,0 +1,29 @@
+import {CartesianValue} from './CartesianValue';
+import {CartesianMeasureValue} from './CartesianMeasureValue';
+
+export class RadarCartesianMeasureValue extends CartesianMeasureValue {
+
+    public angle: number;
+
+    constructor(json: {
+        cartesianValues: string | CartesianValue[],
+        cartesianPixelWidth: { lat: number, lng: number },
+        angle: number,
+    }) {
+
+        super(json);
+        this.angle = json.angle;
+    }
+
+    toJSON(stringify = false): JSON {
+        const json: any = super.toJSON(stringify);
+        json.angle = this.angle;
+        return json;
+    }
+
+    toJSONWithCartesianValuesStringified(): JSON {
+        const json: any = super.toJSONWithCartesianValuesStringified();
+        json.angle = this.angle;
+        return json;
+    }
+}

package/src/cartesian/RainCartesianMeasureValue.ts

@@ -0,0 +1,33 @@
+import {IVersion} from '../organization/IVersion';
+import {CartesianValue} from './CartesianValue';
+import {CartesianMeasureValue} from './CartesianMeasureValue';
+
+export class RainCartesianMeasureValue extends CartesianMeasureValue implements IVersion {
+
+    private readonly version: string;
+
+    constructor(json: {
+        cartesianValues: string | CartesianValue[],
+        cartesianPixelWidth: { lat: number, lng: number },
+        version?: string,
+    }) {
+        super(json);
+        this.version = json.version;
+    }
+
+    getVersion(): string {
+        return this.version;
+    }
+
+    toJSON(stringify = false): JSON {
+        const json: any = super.toJSON(stringify);
+        json.version = this.getVersion();
+        return json;
+    }
+
+    toJSONWithCartesianValuesStringified(): JSON {
+        const json: any = super.toJSONWithCartesianValuesStringified();
+        json.version = this.getVersion();
+        return json;
+    }
+}

package/src/gauge/GaugeMeasure.ts

@@ -0,0 +1,36 @@
+import {Measure} from '../organization/Measure';
+import {IPolarMeasureValue} from '../polar/IPolarMeasureValue';
+import {ICartesianMeasureValue} from '../cartesian/ICartesianMeasureValue';
+
+/**
+ *  api/gauges/:id/measures/:id
+ */
+export class GaugeMeasure extends Measure {
+
+    public static TYPE = 'gauge-measure';
+    public timeInSec: number;
+
+    constructor(json: {
+                    id: string,
+                    values: IPolarMeasureValue[] | ICartesianMeasureValue[] | Measure[] | number[],
+                    date?: Date,
+                    validity?: number,
+                    timeInSec?: number,
+                    configurationAsJSON?: string | any,
+                }
+    ) {
+        super(json);
+        this.timeInSec = json.timeInSec >= 0 ? json.timeInSec : -1;
+    }
+
+    public toJSON(): JSON {
+        const json = super.toJSON();
+        json['timeInSec'] = this.timeInSec;
+        return json;
+    }
+
+    protected getLinkType(): string {
+        return GaugeMeasure.TYPE;
+    }
+}
+

package/src/gauge/GaugeNode.ts

@@ -0,0 +1,46 @@
+import {RaainNode} from '../organization/RaainNode';
+import {Link} from '../organization/Link';
+import {TeamNode} from '../organization/TeamNode';
+
+/**
+ *  api/gauges/:id
+ */
+export class GaugeNode extends RaainNode {
+
+    public static TYPE = 'gauge';
+
+    public name: string;
+    public latitude: number;
+    public longitude: number;
+    public team: TeamNode;
+
+    constructor(json: {
+        id: string,
+        latitude: number,
+        longitude: number,
+        name?: string,
+        links?: Link[] | RaainNode[],
+        team?: TeamNode,
+        version?: string,
+    }) {
+        super(json);
+        this.latitude = json.latitude;
+        this.longitude = json.longitude;
+        this.name = json.name;
+        this.team = json.team;
+    }
+
+    public toJSON(): JSON {
+        const json = super.toJSON();
+        json['latitude'] = this.latitude;
+        json['longitude'] = this.longitude;
+        json['name'] = this.name;
+        json['team'] = this.team?.id || this.team;
+        return json;
+    }
+
+    protected getLinkType(): string {
+        return GaugeNode.TYPE;
+    }
+
+}

package/src/gauge/GaugeNodeMap.ts

@@ -0,0 +1,55 @@
+import {Link} from '../organization/Link';
+import {GaugeNode} from './GaugeNode';
+import {GaugeMeasure} from './GaugeMeasure';
+import {RaainNode} from '../organization/RaainNode';
+
+/**
+ * api/gauges/:id?format=map&begin=...
+ */
+export class GaugeNodeMap extends GaugeNode {
+
+    private map: string; // GaugeMeasure[]; stringified
+
+    constructor(json: {
+        id: string,
+        latitude: number,
+        longitude: number,
+        map?: string,
+        name?: string,
+        links?: Link[] | RaainNode[],
+        version?: string,
+    }) {
+        super(json);
+        this.setMapData(json.map);
+    }
+
+    public toJSON(): JSON {
+        const json = super.toJSON();
+        if (this.map) {
+            json['map'] = this.map;
+        }
+        return json;
+    }
+
+    public setMapData(mapData: GaugeMeasure[] | string) {
+        if (!mapData) {
+            return;
+        }
+
+        let map = mapData;
+        try {
+            if (typeof (mapData) !== 'string') {
+                map = JSON.stringify(mapData);
+            }
+        } catch (e) {
+        }
+        this.map = map.toString();
+    }
+
+    public getMapData(): GaugeMeasure[] {
+        if (!this.map) {
+            return [];
+        }
+        return JSON.parse(this.map);
+    }
+}

package/{index.d.ts → src/index.ts}

@@ -4,6 +4,7 @@ export * from './organization/PeopleNode';
 export * from './organization/Link';
 export * from './organization/RaainNode';
 export * from './organization/TeamNode';
+
 export * from './quality/QualityPoint';
 export * from './quality/SpeedMatrix';
 export * from './quality/SpeedMatrixContainer';
@@ -14,17 +15,21 @@ export * from './quality/tools/QualityTools';
 export * from './cartesian/LatLng';
 export * from './quality/position/Position';
 export * from './quality/position/PositionValue';
+
 export * from './gauge/GaugeNode';
 export * from './gauge/GaugeMeasure';
 export * from './gauge/GaugeNodeMap';
+
 export * from './radar/RadarMeasure';
 export * from './radar/RadarNodeMap';
 export * from './radar/RadarNode';
+
 export * from './rain/RainMeasure';
 export * from './rain/RainNode';
 export * from './rain/RainComputationQuality';
 export * from './rain/RainComputation';
 export * from './rain/RainComputationMap';
+
 export * from './polar/GaugePolarMeasureValue';
 export * from './polar/MeasureValuePolarContainer';
 export * from './polar/PolarMeasureValue';
@@ -32,6 +37,7 @@ export * from './polar/PolarValue';
 export * from './polar/RadarPolarMeasureValue';
 export * from './polar/RainPolarMeasureValue';
 export * from './polar/IPolarMeasureValue';
+
 export * from './cartesian/CartesianValue';
 export * from './cartesian/CartesianMeasureValue';
 export * from './cartesian/RadarCartesianMeasureValue';

package/src/organization/EventNode.ts

@@ -0,0 +1,44 @@
+/**
+ * api/notifications/:id
+ */
+export class EventNode {
+    public id: string;
+    public title: string;
+    public status: number;
+    public red: boolean;
+    public description: string;
+    public created: Date;
+    public modified: Date;
+
+    constructor(json: {
+                    id: string,
+                    title: string,
+                    status: number,
+                    red: boolean,
+                    description: string,
+                    created: Date,
+                    modified: Date
+                }
+    ) {
+        this.id = json.id;
+        this.title = json.title;
+        this.status = json.status;
+        this.red = json.red;
+        this.description = json.description;
+        this.created = json.created;
+        this.modified = json.modified;
+    }
+
+    public toJSON(): JSON {
+        return {
+            id: this.id,
+            title: this.title,
+            status: this.status,
+            red: this.red,
+            description: this.description,
+            created: this.created,
+            modified: this.modified,
+        } as any;
+    }
+}
+

package/{organization/Link.js → src/organization/Link.ts}

@@ -1,6 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Link = void 0;
 /**
  * Hateoas Links :
  * [ {
@@ -8,27 +5,30 @@ exports.Link = void 0;
  *    href: string // like "https://.../rains/2"
  *  },...]
  */
-class Link {
-    constructor(rel, href) {
-        this.rel = rel;
-        this.href = href;
+export class Link {
+    constructor(
+        public rel: string,
+        public href: string
+    ) {
     }
-    static isCloneable(object) {
+
+    public static isCloneable(object: any): boolean {
         return object && object.rel && object.href;
     }
-    static clone(object) {
+
+    public static clone(object: any): Link {
         return new Link(object.rel, object.href);
     }
-    getId() {
+
+    public getId(): string {
         const urls = this.href.split('/');
         // can be enforced : verify rel in -2 urls ?...
         return urls[urls.length - 1];
     }
-    getLinkType() {
+
+    public getLinkType(): string {
         const urls = this.href.split('/');
         // can be enforced : verify rel in -2 urls ?...
         return urls[0];
     }
 }
-exports.Link = Link;
-//# sourceMappingURL=Link.js.map

package/src/organization/Measure.ts

@@ -0,0 +1,49 @@
+import {IPolarMeasureValue} from '../polar/IPolarMeasureValue';
+import {RaainNode} from './RaainNode';
+import {ICartesianMeasureValue} from '../cartesian/ICartesianMeasureValue';
+
+export class Measure extends RaainNode {
+    public date: Date;
+    public values: IPolarMeasureValue[] | ICartesianMeasureValue[] | Measure[] | number[];
+    //   -> why array ? because you can have potential different angle from the Radar
+
+    public validity: number
+    private configurationAsJSON: string;
+
+    constructor(json: {
+                    id: string,
+                    values: IPolarMeasureValue[] | ICartesianMeasureValue[] | Measure[] | number[],
+                    date?: Date,
+                    validity?: number,
+                    configurationAsJSON?: string | any,
+                }
+    ) {
+        super(json);
+        this.values = json.values ? json.values : [];
+        this.date = json.date ? new Date(json.date) : undefined;
+        this.validity = json.validity >= 0 ? json.validity : -1;
+        this.setConfiguration(json.configurationAsJSON);
+    }
+
+    public setConfiguration(configuration: string | any) {
+        let conf = configuration;
+        try {
+            conf = JSON.parse(configuration);
+        } catch (ignored) {
+        }
+
+        this.configurationAsJSON = JSON.stringify(conf);
+    }
+
+    public toJSON(options: { removeValues?: boolean } = {}): JSON {
+        const json = super.toJSON();
+        json['date'] = this.date?.toISOString();
+        json['validity'] = this.validity;
+        json['configurationAsJSON'] = this.configurationAsJSON;
+
+        if (!options?.removeValues) {
+            json['values'] = this.values;
+        }
+        return json;
+    }
+}

package/src/organization/PeopleNode.ts

@@ -0,0 +1,36 @@
+/**
+ *  api/teams/:id => contacts
+ */
+export class PeopleNode {
+
+    public id: string;
+    public role: string;
+    public email: string;
+    public name: string;
+    public comments: string; // potential additional info
+
+    constructor(json: {
+                    id: string,
+                    role: string,
+                    email: string,
+                    name: string,
+                    comments: string
+                }
+    ) {
+        this.id = json.id;
+        this.role = json.role;
+        this.email = json.email;
+        this.name = json.name;
+        this.comments = json.comments;
+    }
+
+    public toJSON(): JSON {
+        return {
+            id: this.id,
+            role: this.role,
+            email: this.email,
+            name: this.name,
+            comments: this.comments,
+        } as any;
+    }
+}