raain-model 2.6.8 → 2.6.10

package/{gauge/GaugeNode.js → src/gauge/GaugeNode.ts}

@@ -1,7 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GaugeNode = void 0;
-const organization_1 = require("../organization");
+import {Link, RaainNode, TeamNode} from '../organization';
+
 /**
  * Represents a rain gauge station in the RAAIN system.
  * This class manages gauge data collection and configuration.
@@ -21,7 +19,29 @@ const organization_1 = require("../organization");
  * });
  * ```
  */
-class GaugeNode extends organization_1.RaainNode {
+export class GaugeNode extends RaainNode {
+
+    /** Type identifier for gauge nodes */
+    public static TYPE = 'gauge';
+
+    /** Name of the gauge station */
+    public name: string;
+
+    /** Description of the gauge station */
+    public description: string;
+
+    /** Latitude of the gauge station */
+    public latitude: number;
+
+    /** Longitude of the gauge station */
+    public longitude: number;
+
+    /** Associated team */
+    public team: TeamNode;
+
+    /** Internal configuration storage */
+    private configurationAsJSON: string;
+
     /**
      * Creates a new GaugeNode instance.
      *
@@ -36,7 +56,17 @@ class GaugeNode extends organization_1.RaainNode {
      * @param json.version - Optional version string
      * @param json.configurationAsJSON - Optional configuration object
      */
-    constructor(json) {
+    constructor(json: {
+        id: string,
+        latitude: number,
+        longitude: number,
+        name: string,
+        team: TeamNode,
+        description?: string,
+        links?: Link[] | RaainNode[],
+        version?: string,
+        configurationAsJSON?: any,
+    }) {
         super(json);
         this.latitude = json.latitude;
         this.longitude = json.longitude;
@@ -45,61 +75,59 @@ class GaugeNode extends organization_1.RaainNode {
         this.team = json.team;
         this.setConfiguration(json.configurationAsJSON);
     }
+
     /**
      * Sets the configuration for the gauge node.
      *
      * @param configuration - Configuration object or JSON string
      */
-    setConfiguration(configuration) {
+    public setConfiguration(configuration: string | any) {
         let conf = configuration;
         try {
             conf = JSON.parse(configuration);
+        } catch (ignored) {
         }
-        catch (ignored) {
-        }
+
         if (conf) {
             this.configurationAsJSON = JSON.stringify(conf);
         }
     }
+
     /**
      * Gets the configuration of the gauge node.
      *
      * @returns The configuration object or null if not set
      */
-    getConfiguration() {
+    public getConfiguration(): any {
         try {
             return JSON.parse(this.configurationAsJSON);
-        }
-        catch (e) {
+        } catch (e) {
         }
         return null;
     }
+
     /**
      * Converts the gauge node to a JSON object.
      *
      * @returns A JSON object containing the gauge node's data
      */
-    toJSON() {
-        var _a;
+    public toJSON(): any {
         const json = super.toJSON();
         json['name'] = this.name;
         json['description'] = this.description;
         json['latitude'] = this.latitude;
         json['longitude'] = this.longitude;
-        json['team'] = ((_a = this.team) === null || _a === void 0 ? void 0 : _a.id) || this.team;
+        json['team'] = this.team?.id || this.team;
         json['configurationAsJSON'] = this.configurationAsJSON;
         return json;
     }
+
     /**
      * Returns the link type for gauge nodes.
      *
      * @returns The string 'gauge'
      */
-    getLinkType() {
+    protected getLinkType(): string {
         return GaugeNode.TYPE;
     }
 }
-exports.GaugeNode = GaugeNode;
-/** Type identifier for gauge nodes */
-GaugeNode.TYPE = 'gauge';
-//# sourceMappingURL=GaugeNode.js.map

package/src/gauge/GaugeNodeMap.ts

@@ -0,0 +1,55 @@
+import {Link, RaainNode, TeamNode} from '../organization';
+import {GaugeNode} from './GaugeNode';
+import {GaugeMeasure} from './GaugeMeasure';
+
+/**
+ * api/gauges/:id?format=map&begin=...
+ */
+export class GaugeNodeMap extends GaugeNode {
+
+    private map: string; // GaugeMeasure[]; stringified
+
+    constructor(json: {
+        id: string,
+        latitude: number,
+        longitude: number,
+        name: string,
+        description: string,
+        team: TeamNode,
+        configurationAsJSON?: any,
+        map?: string,
+        links?: Link[] | RaainNode[],
+        version?: string,
+    }) {
+        super(json);
+        this.setMapData(json.map);
+    }
+
+    public toJSON(): any {
+        const json = super.toJSON();
+        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/src/organization/EventNode.ts

@@ -0,0 +1,43 @@
+/**
+ * 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(): any {
+        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,31 +5,34 @@ 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) {
-        return (object === null || object === void 0 ? void 0 : object.rel) && (object === null || object === void 0 ? void 0 : object.href);
+
+    public static isCloneable(object: any): boolean {
+        return object?.rel && object?.href;
     }
-    static clone(object) {
-        if (!(object === null || object === void 0 ? void 0 : object.rel) || !(object === null || object === void 0 ? void 0 : object.href)) {
+
+    public static clone(object: any): Link | null {
+        if (!object?.rel || !object?.href) {
             return null;
         }
         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[1].substring(0, urls[1].length - 1);
         return this.rel;
     }
 }
-exports.Link = Link;
-//# sourceMappingURL=Link.js.map

package/src/organization/Measure.ts

@@ -0,0 +1,61 @@
+import {IPolarMeasureValue} from '../polar';
+import {RaainNode} from './RaainNode';
+import {ICartesianMeasureValue} from '../cartesian';
+
+export class Measure extends RaainNode {
+    public date: Date;
+    //   -> why array ? because you have different angle/axis from the Radar
+    public values: IPolarMeasureValue[] | ICartesianMeasureValue[] | number[];
+    public validity: number;
+
+    // internal
+    private configurationAsJSON: string;
+
+    constructor(json: {
+                    id: string,
+                    values: IPolarMeasureValue[] | ICartesianMeasureValue[] | number[],
+                    date?: Date,
+                    validity?: number,
+                    configurationAsJSON?: string,
+                    version?: string,
+                }
+    ) {
+        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) {
+        }
+
+        if (conf) {
+            this.configurationAsJSON = JSON.stringify(conf);
+        }
+    }
+
+    public toJSON(options: { removeValues?: boolean } = {}): any {
+        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;
+    }
+
+    public getConfiguration(): any {
+        try {
+            return JSON.parse(this.configurationAsJSON);
+        } catch (e) {
+        }
+        return null;
+    }
+}

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

@@ -1,17 +1,27 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PeopleNode = void 0;
 /**
  *  api/teams/:id => contacts
  */
-class PeopleNode {
-    constructor(json) {
+export class PeopleNode {
+
+    public id: string;
+    public roles: string[];
+    public email: string;
+    public name: string;
+
+    constructor(json: {
+                    id: string,
+                    roles: string[],
+                    email: string,
+                    name: string,
+                }
+    ) {
         this.id = json.id;
         this.roles = json.roles;
         this.email = json.email;
         this.name = json.name;
     }
-    toJSON() {
+
+    public toJSON(): any {
         return {
             id: this.id,
             roles: this.roles,
@@ -19,14 +29,14 @@ class PeopleNode {
             name: this.name,
         };
     }
-    hasRole(role) {
+
+    hasRole(role: string): boolean {
         return this.roles.indexOf(role) >= 0;
     }
-    addRole(role) {
+
+    addRole(role: string) {
         if (!this.hasRole(role)) {
             this.roles.push(role);
         }
     }
 }
-exports.PeopleNode = PeopleNode;
-//# sourceMappingURL=PeopleNode.js.map

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

@@ -1,7 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RaainNode = void 0;
-const Link_1 = require("./Link");
+import {Link} from './Link';
+import {IVersion} from './IVersion';
+
 /**
  * Base class for all RAAIN nodes in the system.
  * Implements versioning and link management functionality.
@@ -24,7 +23,12 @@ const Link_1 = require("./Link");
  * });
  * ```
  */
-class RaainNode {
+export class RaainNode implements IVersion {
+    /** Unique identifier for the node */
+    public id: string;
+    /** Version string of the node */
+    public version: string;
+
     /**
      * Creates a new RaainNode instance.
      *
@@ -33,42 +37,69 @@ class RaainNode {
      * @param json.links - Array of HATEOAS links
      * @param json.version - Version string
      */
-    constructor(json) {
-        if (!(json === null || json === void 0 ? void 0 : json.id)) {
+    constructor(json: {
+        id: string,
+        links?: Link[] | RaainNode[],
+        version?: string,
+    }) {
+        if (!json?.id) {
             throw new Error('RaainNode needs a valid Object or ID');
         }
+
         this.id = json.id;
         this.links = json.links ? json.links : [];
         this.version = json.version ? json.version : undefined;
     }
-    static _getPurifiedLinks(linksToPurify) {
+
+    /** Array of HATEOAS links associated with the node */
+    protected _links: Link[];
+
+    /**
+     * Gets all links associated with the node.
+     *
+     * @returns Array of HATEOAS links
+     */
+    public get links(): Link[] {
+        return this._links;
+    }
+
+    /**
+     * Sets the links for the node.
+     *
+     * @param links - Array of links to set
+     */
+    public set links(links: Link[] | RaainNode[]) {
+        this._links = RaainNode._getPurifiedLinks(links);
+    }
+
+    private static _getPurifiedLinks(linksToPurify: any[]): Link[] {
         if (!linksToPurify || linksToPurify.length === 0) {
             return [];
         }
+
         const linksPurified = linksToPurify
             .filter(l => l !== null && l !== undefined)
             .map(l => {
-            var _a;
-            if (l instanceof Link_1.Link || Link_1.Link.isCloneable(l)) {
-                return Link_1.Link.clone(l);
-            }
-            else if (l && typeof l.getLinkType === 'function' && l.id) {
-                const linkType = l.getLinkType();
-                let href = '../' + linkType + 's';
-                const l2 = l;
-                if ((_a = l2.date) === null || _a === void 0 ? void 0 : _a.toISOString) {
-                    href += '/' + l2.date.toISOString();
-                    if (l2.version) {
-                        href += '/' + l2.version;
+                if (l instanceof Link || Link.isCloneable(l)) {
+                    return Link.clone(l);
+                } else if (l && typeof l.getLinkType === 'function' && l.id) {
+                    const linkType = l.getLinkType();
+                    let href = '../' + linkType + 's';
+                    const l2 = l;
+                    if (l2.date?.toISOString) {
+                        href += '/' + l2.date.toISOString();
+                        if (l2.version) {
+                            href += '/' + l2.version;
+                        }
                     }
+                    href += '/' + l2.id;
+                    return new Link(linkType, href);
                 }
-                href += '/' + l2.id;
-                return new Link_1.Link(linkType, href);
-            }
-            return null;
-        })
+                return null;
+            })
             .filter(l => l !== null);
-        function uniqBy(a, key) {
+
+        function uniqBy(a: Link[], key: (a: any) => string) {
             const seen = {};
             return a.filter((item) => {
                 if (!item) {
@@ -82,64 +113,65 @@ class RaainNode {
                 return true;
             });
         }
+
         return uniqBy(linksPurified, JSON.stringify);
     }
+
     /**
      * Converts the node to a JSON object.
      *
      * @returns A JSON object containing the node's data
      */
-    toJSON() {
-        const json = {
+    public toJSON(): any {
+        const json: any = {
             id: this.id,
             links: this.links
         };
+
         if (this.version) {
             json.version = this.version;
         }
+
         return json;
     }
-    /**
-     * Gets all links associated with the node.
-     *
-     * @returns Array of HATEOAS links
-     */
-    get links() {
-        return this._links;
-    }
-    /**
-     * Sets the links for the node.
-     *
-     * @param links - Array of links to set
-     */
-    set links(links) {
-        this._links = RaainNode._getPurifiedLinks(links);
+
+    public getLinks(linkType?: string): Link[] {
+        if (!this._links) {
+            return [];
+        }
+        if (!linkType) {
+            return this._links;
+        }
+        // return this.links.filter(l => l && l.rel && linkType === l.rel);
+        return this._links.filter(l => l.getLinkType() === linkType);
+
     }
-    /**
-     * Gets the ID from a link by its relationship type.
-     *
-     * @param rel - Relationship type of the link
-     * @returns The ID from the link, or undefined if not found
-     */
-    getLinkId(rel) {
-        const link = this._links.find(l => l.getLinkType() === rel);
-        return link ? link.getId() : undefined;
+
+    public getLink(linkType: string, index?: number): Link {
+        index = !index ? 0 : index;
+        const linksFound = this.getLinks(linkType);
+        if (linksFound.length <= index) {
+            return null;
+        }
+        return linksFound[index];
     }
+
     /**
      * Gets all link IDs associated with the node.
      *
      * @returns Array of link IDs
      */
-    getLinkIds() {
+    public getLinkIds(): string[] {
         return this._links.map(l => l.getId());
     }
+
     /**
      * Gets the count of links, optionally filtered by type.
      *
      * @param linkType - Optional type of links to count
      * @returns The number of links
      */
-    getLinksCount(linkType) {
+    public getLinksCount(linkType?: string): number {
         if (!this._links) {
             return 0;
         }
@@ -148,25 +180,26 @@ class RaainNode {
         }
         return this._links.filter(l => l.getLinkType() === linkType).length;
     }
+
     /**
      * Adds new links to the node.
      *
      * @param links - Array of links to add
      */
-    addLinks(links) {
+    public addLinks(links: Link[] | RaainNode[]) {
         if (!links) {
             return;
         }
+
         this._links = RaainNode._getPurifiedLinks([...this._links, ...links]);
     }
+
     /**
      * Gets the version string of the node.
      *
      * @returns The version string
      */
-    getVersion() {
+    public getVersion(): string | undefined {
         return this.version;
     }
 }
-exports.RaainNode = RaainNode;
-//# sourceMappingURL=RaainNode.js.map