raain-model 2.6.7 → 2.6.10

package/.cursorignore

@@ -0,0 +1,10 @@
+.vscode/
+.idea/
+*gitignored
+*gitignored*
+
+# Always include these files for context
+!README.md
+!CHANGELOG.md
+!RELEASE_PROCESS.md
+!specs/*.md

package/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm install
+      - run: npm test
+      - run: npm run build
+      - run: npm run docs
+      - name: Deploy documentation to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs
+      - run: npm publish
+        working-directory: ./dist
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -0,0 +1,166 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.6.10] - 2025-03-22
+### Added
+- Planning new feature implementations
+- Considering additional testing frameworks
+
+### Changed
+- Ongoing documentation improvements
+- Code structure refinements
+
+### Dependencies
+- Planning to update TypeScript dependencies
+- Considering new quality measurement tools integration
+
+### Technical Details
+- Investigating performance optimizations
+- Exploring new quality metric algorithms
+
+## [2.6.9] - 2025-03-21
+### Added
+- MIT license file
+- TypeDoc configuration for API documentation
+- Enhanced documentation for core components
+
+### Changed
+- Updated CI workflow configuration
+- Improved core components:
+  - Enhanced RainNode computation capabilities
+  - Updated GaugeNode station management
+  - Refined organization structure (RaainNode, TeamNode)
+
+### Dependencies
+- Updated dependencies to latest versions
+- Upgraded TypeScript to ^5.0.4
+- Updated testing frameworks
+
+### Technical Details
+- Improved polar measurement value filtering
+- Enhanced speed matrix container comparison calculations
+- Refined quality control mechanisms
+
+## [2.6.8] - 2025-03-16
+### Fixed
+- PolarMeasureValue getFiltered functionality
+
+### Technical Details
+- Optimized filtering algorithms
+- Improved error handling in measurement processing
+
+## [2.6.7] - 2025-02-24
+### Fixed
+- SpeedMatrixContainer BuildCompares calculations
+- Quality point calculations and metrics
+- CartesianRainHistory tracking improvements
+- QualityTools refinements
+
+### Dependencies
+- Updated dependencies to patch security vulnerabilities
+
+### Technical Details
+- Improved matrix comparison algorithms
+- Enhanced quality metric calculations
+- Optimized history tracking mechanisms
+
+## [2.6.0] - 2024
+### Added
+- Unified Cartesian map tools
+- Improved map manipulation utilities
+
+## [2.5.0] - 2024
+### Added
+- Polar and Cartesian limits (count + offsets)
+- PolarMap for index manipulation
+
+## [2.4.0] - 2024
+### Changed
+- Moved role to roles in PeopleNode
+- Improved role management system
+
+## [2.3.0] - 2024
+### Changed
+- Refactored Angle/Axis system
+- Improved angular calculations
+
+## [2.2.0] - 2024
+### Changed
+- Refactored BuildCompares functionality
+- Enhanced comparison algorithms
+
+## [2.1.0] - 2023
+### Added
+- Extended RainComputationQuality with rainComputation's link
+- Added getQualityPointsByHistoricalPosition method
+
+## [2.0.0] - 2023
+### Changed
+- More flexible configuration system for rain, radar, and gauge
+- Restructured Rain zone to use LatLng rects
+- Removed period usage in favor of date
+
+## [1.11.0] - 2023
+### Changed
+- Modified SpeedMatrixContainer's QualityPoints relation (1:N)
+- Added SpeedMatrix name property
+
+## [1.10.0] - 2023
+### Added
+- Object constructor based on JSON only
+- Added specifications
+
+## [1.9.0] - 2023
+### Added
+- Cartesian improvements
+- Enhanced coordinate system
+
+## [0.4.0] - 2022
+### Changed
+- Implemented Cartesian values
+- Reorganized folders
+- Renamed Polar objects (XX-MeasureValue to XX-PolarMeasureValue)
+
+## [0.3.0] - 2022
+### Added
+- Added IVersion interface
+- Implemented CI/CD pipeline
+
+### Changed
+- Reformatted Links structure
+
+## [0.2.0] - 2022
+### Added
+- Customer teams functionality
+- Radar implementation
+
+## [0.0.1] - 2022
+### Added
+- Initial release
+- First extracts from RAAIN services
+
+[Unreleased]: https://github.com/raainio/raain-model/compare/v2.6.10...HEAD
+[2.6.10]: https://github.com/raainio/raain-model/compare/v2.6.9...v2.6.10
+[2.6.9]: https://github.com/raainio/raain-model/compare/v2.6.8...v2.6.9
+[2.6.8]: https://github.com/raainio/raain-model/compare/v2.6.7...v2.6.8
+[2.6.7]: https://github.com/raainio/raain-model/compare/v2.6.6...v2.6.7
+[2.6.0]: https://github.com/raainio/raain-model/compare/v2.5.0...v2.6.0
+[2.5.0]: https://github.com/raainio/raain-model/compare/v2.4.0...v2.5.0
+[2.4.0]: https://github.com/raainio/raain-model/compare/v2.3.0...v2.4.0
+[2.3.0]: https://github.com/raainio/raain-model/compare/v2.2.0...v2.3.0
+[2.2.0]: https://github.com/raainio/raain-model/compare/v2.1.0...v2.2.0
+[2.1.0]: https://github.com/raainio/raain-model/compare/v2.0.0...v2.1.0
+[2.0.0]: https://github.com/raainio/raain-model/compare/v1.11.0...v2.0.0
+[1.11.0]: https://github.com/raainio/raain-model/compare/v1.10.0...v1.11.0
+[1.10.0]: https://github.com/raainio/raain-model/compare/v1.9.0...v1.10.0
+[1.9.0]: https://github.com/raainio/raain-model/compare/v0.4.0...v1.9.0
+[0.4.0]: https://github.com/raainio/raain-model/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/raainio/raain-model/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/raainio/raain-model/compare/v0.0.1...v0.2.0
+[0.0.1]: https://github.com/raainio/raain-model/releases/tag/v0.0.1 

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 radartorain.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

package/README.md

@@ -1,17 +1,98 @@
-# raain-model
+# 🌧️ RAAIN Model
 
-> RAAIN model used in [radartorain.com](https://api.radartorain.com) services.
+[![npm version](https://badge.fury.io/js/raain-model.svg)](https://badge.fury.io/js/raain-model)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/TypeScript-4.9.5-blue.svg)](https://www.typescriptlang.org/)
+[![Build Status](https://github.com/raainio/raain-model/actions/workflows/ci.yml/badge.svg)](https://github.com/raainio/raain-model/actions)
 
-IN PROGRESS...
+> A TypeScript library for radar-based rain measurement and analysis, used in [radartorain.com](https://radartorain.com)
+> services.
 
-### Usage
+## 🌟 Features
 
-See [Specs](./specs).
+- **Radar Data Processing**: Efficient processing of radar data for rain measurement
+- **Cartesian & Polar Coordinates**: Support for both coordinate systems
+- **Advanced Merging**: Sophisticated merging strategies for rain data
+- **Quality Assessment**: Built-in quality metrics for measurements
+- **TypeScript Support**: Full type safety and modern TypeScript features
+- **Performance Optimized**: Efficient data structures and algorithms
 
-## History
+## 🚀 Installation
 
-See [Release notes](./RELEASE.md).
+```bash
+npm install raain-model
+# or
+yarn add raain-model
+```
 
-## License
+## 📖 Quick Start
 
-MIT
+```typescript
+import {RainComputationMap, RainNode, RadarNode} from 'raain-model';
+
+// Create a radar node
+const radarNode = new RadarNode({
+    id: 'radar1',
+    latitude: 48.8566,
+    longitude: 2.3522,
+    name: 'Paris Radar',
+    team: null
+});
+
+// Create a rain node
+const rainNode = new RainNode({
+    id: 'rain1',
+    name: 'Paris Rain',
+    team: null,
+    radars: [radarNode]
+});
+
+// Process rain data
+const computation = new RainComputationMap({
+    id: 'comp1',
+    date: new Date(),
+    isReady: true,
+    map: [] // Your rain measurement data here
+});
+```
+
+## 📚 Documentation
+
+Visit [documentation](https://raainio.github.io/raain-model)
+and [swagger](https://api.sandbox.radartorain.com/v2/docs).
+
+### Key Components
+
+- `RainNode`: Core class for rain measurement nodes
+- `RadarNode`: Radar station representation
+- `RainComputationMap`: Advanced rain data processing
+- `CartesianTools`: Utilities for coordinate transformations
+- `SpeedMatrix`: Matrix operations for rain data
+
+## 🧪 Testing
+
+```bash
+# Run all tests
+npm test
+
+# Run tests with coverage
+npm run test:coverage
+```
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 📅 Release Notes
+
+See [Release notes](./RELEASE.md) for version history and changes.
+
+## 🔗 Links
+
+- [Website](https://radartorain.com)
+- [API Documentation](https://api.sandbox.radartorain.com/docs)
+- [GitHub Issues](https://github.com/raainio/raain-model/issues)

package/RELEASE_PROCESS.md

@@ -0,0 +1,111 @@
+# Release Process Documentation
+
+## Patch Version Release Steps
+
+### Prerequisites
+
+- Make sure you have all dependencies installed
+- Ensure you're starting from an up-to-date master branch
+
+### Step-by-Step Process
+
+⚠️ If any task fails, you must:
+
+- NOT proceed with any further steps
+- NOT try to fix or set the environment manually
+- Alert the team and request guidance
+
+1. **Initial Verification**
+   ```bash
+   npm test
+   ```
+   This command runs the test suite. Do not proceed if any tests fail.
+
+2. **Documentation Sync**
+   Ensure all documentation is up-to-date with recent changes:
+    - README.md
+    - specs/*.md files
+    - CHANGELOG.md
+
+5. **Version Control**
+   ```bash
+   git add .
+   git commit -m "release: patch version X.Y.Z with [explanation of changes]"
+   git tag -a vX.Y.Z -m "Version X.Y.Z"
+   git push
+   git push --tags
+   ```
+   Replace X.Y.Z with the actual version number and provide a clear explanation of changes.
+
+## For all Version Release Steps (Patch or Release)
+
+### Important Notes
+
+- Always run and verify tests before pushing
+- Document all significant changes in the commit message
+- Monitor the merge process for any conflicts
+
+### Post-Release Verification
+
+- Verify the release is properly tagged
+
+### Version Management Best Practices
+
+- Always check the current version in package.json before starting the release process
+- Use `npm run build-version` to increment the version number automatically
+- Ensure version numbers are consistent across:
+    - package.json
+    - git tags
+    - CHANGELOG.md entries
+- Never manually edit version numbers
+
+### CHANGELOG Management
+
+- Keep the [Unreleased] section at the top of CHANGELOG.md
+- Move unreleased changes to a new version section during release
+- Include the current date in ISO format (YYYY-MM-DD)
+- Organize changes under appropriate categories:
+    - Added
+    - Changed
+    - Fixed
+    - Dependencies
+    - Technical Details
+
+### Common Pitfalls to Avoid
+
+- Don't create tags with placeholder version numbers (X.Y.Z)
+- Don't forget to push both commits and tags
+
+### Recovery Procedures
+
+If incorrect version numbers are used:
+
+1. Delete the incorrect tag locally and remotely:
+   ```bash
+   git tag -d <incorrect_tag>
+   git push origin :<incorrect_tag>
+   ```
+2. Update version numbers in all relevant files
+3. Create new tag with correct version
+4. Push changes and new tag
+
+If merge conflicts occur:
+
+1. Document the conflicting files
+2. Resolve conflicts locally
+3. Commit the resolution with a clear message
+4. Push the changes
+5. Verify the merge was successful
+
+### Directory Navigation
+
+- Return to the root directory for git operations
+- Use absolute paths when necessary to avoid confusion
+
+### Future Improvements
+
+- Consider automating version consistency checks
+- Add pre-commit hooks for version validation
+- Implement automated changelog updates
+- Add automated testing of the release process
+- Consider implementing a release automation script 

package/package.json

@@ -1,36 +1,38 @@
 {
   "name": "raain-model",
-  "version": "2.6.7",
-  "author": "contact@raain.io",
+  "version": "2.6.10",
+  "author": "contact@radartorain.com",
   "homepage": "https://github.com/raainio/raain-model",
-  "description": "raain.io api model",
+  "description": "radartorain.com api model",
   "keywords": [
-    "raain.io",
+    "radartorain.com",
     "api"
   ],
   "private": false,
   "license": "MIT",
   "main": "./index.js",
   "types": "./index.d.ts",
-  "dependencies": {},
   "devDependencies": {
-    "hash-it": "^6.0.0",
+    "@testdeck/mocha": "^0.3.3",
     "@types/chai": "^4.3.10",
     "@types/mocha": "^10.0.1",
     "@types/node": "^20.8.8",
     "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
     "chai-spies": "^1.1.0",
+    "hash-it": "^6.0.0",
     "mocha": "^10.2.0",
-    "mocha-typescript": "^1.1.17",
     "ts-node": "^8.10.2",
     "tslint": "^6.1.3",
+    "typedoc": "^0.25.12",
     "typescript": "^5.0.4"
   },
   "scripts": {
     "build": "npm run build-dist",
     "build-version": "VERSION=\"$(npm version patch --no-git-tag-version)\"",
     "build-dist": "rm -rf dist/ && npx tsc && cp package.json dist/ && cp *.md dist/",
-    "test": "mocha --require ts-node/register 'specs/**/**.spec.ts'"
+    "test": "mocha --require ts-node/register 'specs/**/**.spec.ts'",
+    "docs": "typedoc --out docs src/",
+    "docs:serve": "npx serve docs"
   }
 }

package/specs/REQUIREMENTS.md

@@ -0,0 +1,42 @@
+# Project Requirements
+
+This document serves as the foundation for development and should be updated as requirements evolve or new providers are added to the system.
+
+## Core Requirements
+
+### Rain Data Processing
+1. Must support multiple radar data sources
+2. Must integrate with physical rain gauge stations
+3. Must provide accurate geographic coverage information
+4. Must maintain computation history
+5. Must implement quality control measures
+
+### Gauge Integration
+1. Must support physical rain gauge station management
+2. Must store precise geographic coordinates
+3. Must allow custom configuration per station
+4. Must integrate with team management system
+
+### Quality Control
+1. Must implement speed matrix comparisons
+2. Must calculate and track quality metrics
+3. Must support historical data analysis
+4. Must provide tools for quality assessment
+
+### Organization
+1. Must support team-based access control
+2. Must maintain relationships between different nodes
+3. Must track version information
+4. Must support flexible configuration options
+
+### API Requirements
+1. Must provide RESTful endpoints for all operations
+2. Must implement proper error handling
+3. Must support JSON data format
+4. Must maintain backward compatibility
+
+### Technical Requirements
+1. Must use TypeScript for type safety
+2. Must maintain comprehensive documentation
+3. Must include automated tests
+4. Must follow MIT license requirements

package/specs/TECHNICAL.md

@@ -0,0 +1,57 @@
+# Technical Documentation
+
+This document serves as the technical reminder for development and should be updated as implementation evolves.
+
+## Core Components
+
+### RainNode
+- Extends `RaainNode`
+- Manages rain data computation and configuration
+- Properties:
+  - `name`: Station name
+  - `description`: Optional description
+  - `team`: Associated TeamNode
+  - `status`: Current status number
+  - `quality`: Quality metric
+  - `latLngRectsAsJSON`: Geographic coverage as JSON
+  - `configurationAsJSON`: Private configuration data
+- Key Features:
+  - Radar link management
+  - Gauge integration
+  - Geographic calculations (center, limits)
+  - Computation history tracking
+
+### GaugeNode
+- Extends `RaainNode`
+- Represents physical rain gauge stations
+- Properties:
+  - `name`: Station name
+  - `description`: Station description
+  - `latitude`: Geographic latitude
+  - `longitude`: Geographic longitude
+  - `team`: Associated TeamNode
+  - `configurationAsJSON`: Private configuration data
+- Features:
+  - Configuration management
+  - Location-based services
+  - Team association
+
+### Organization Structure
+- `RaainNode`: Base class for all nodes
+- `TeamNode`: Team management and permissions
+- `Link`: Relationship management between nodes
+
+### Quality Management
+- Enhanced speed matrix comparisons
+- Improved quality point calculations
+- Updated Cartesian rain history tracking
+- Refined quality measurement tools
+
+## API Endpoints
+- `/api/rains/:id`: Rain node management
+- `/api/gauges/:id`: Gauge station management
+
+## Data Processing
+- Polar measurement filtering
+- Cartesian coordinate transformations
+- Quality metric calculations

package/specs/cartesian/Cartesian.spec.ts

@@ -0,0 +1,82 @@
+import {expect} from 'chai';
+import {
+    CartesianMeasureValue,
+    CartesianValue,
+    GaugeMeasure,
+    GaugeNode,
+    ICartesianMeasureValue,
+    LatLng,
+    RadarCartesianMeasureValue,
+    RainCartesianMeasureValue,
+    TeamNode
+} from '../../src';
+
+describe('Cartesian', () => {
+
+    it('should create ones', () => {
+
+        const team1 = new TeamNode({
+            id: 'tid1',
+            name: 'team1',
+            description: 'team...',
+            contracts: ['basic'],
+            contacts: []
+        });
+        const cartesianValue1 = new CartesianValue({
+            value: 123,
+            lat: 10,
+            lng: 20
+        });
+        const cartesianValue2 = new CartesianValue({
+            value: 321,
+            lat: 10.002,
+            lng: 19.9998
+        });
+        const cartesianMeasureValue = new CartesianMeasureValue({
+            cartesianValues: [cartesianValue1, cartesianValue2],
+        });
+        const radarCartesianMeasureValue = new RadarCartesianMeasureValue({
+            cartesianValues: [cartesianValue1, cartesianValue2],
+            angle: 4,
+            axis: 0,
+            limitPoints: undefined
+        });
+        expect(radarCartesianMeasureValue.angle).eq(4);
+        expect(radarCartesianMeasureValue.getCartesianValues().length).eq(2);
+        expect(radarCartesianMeasureValue.getLimitPoints({forceCompute: true})[0].lat).eq(10);
+        expect(radarCartesianMeasureValue.getLimitPoints()[0].lng).eq(19.9998);
+        expect(radarCartesianMeasureValue.getLimitPoints()[1].lat).eq(10.002);
+        expect(radarCartesianMeasureValue.getLimitPoints()[1].lng).eq(20);
+
+        const gaugeNode = new GaugeNode({
+            id: 'GaugeNode looks OK.',
+            name: 'name',
+            links: [],
+            latitude: 1,
+            longitude: 1,
+            team: team1,
+        });
+        expect(gaugeNode.id).eq('GaugeNode looks OK.');
+
+        const gaugeMeasure = new GaugeMeasure({
+            id: 'gaugeMeasure',
+            date: new Date(),
+            values: [cartesianMeasureValue],
+            validity: 1
+        });
+        expect((gaugeMeasure.values[0] as ICartesianMeasureValue).getCartesianValue({lat: 10, lng: 20}).value).eq(123);
+        expect((gaugeMeasure.values[0] as ICartesianMeasureValue).getCartesianValue({lat: 10.0001, lng: 20.00001})).eq(null);
+
+        const rainCartesianMeasureValue = new RainCartesianMeasureValue({
+            cartesianValues: [cartesianValue1, cartesianValue2],
+            version: '',
+            limitPoints: [new LatLng({lat: 0, lng: 1}), new LatLng({lat: 12, lng: 20})]
+        });
+        expect(rainCartesianMeasureValue.getCartesianValues().length).eq(2);
+        expect(rainCartesianMeasureValue.getLimitPoints()[0].lat).eq(0);
+        expect(rainCartesianMeasureValue.getLimitPoints()[0].lng).eq(1);
+        expect(rainCartesianMeasureValue.getLimitPoints()[1].lat).eq(12);
+        expect(rainCartesianMeasureValue.getLimitPoints()[1].lng).eq(20);
+    });
+
+});