raain-model 2.6.10 → 3.0.1

package/CHANGELOG.md

@@ -7,160 +7,247 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [2.6.10] - 2025-03-22
+## [3.0.1] - 2025-04-17
+
 ### Added
+
+- Major version upgrade to 3.0.0
+- Enhanced TypeScript 5.0.4 support
+- Improved documentation and API references
+- Additional test coverage
+
+### Changed
+
+- Refactored core components for better performance
+- Updated dependencies to latest versions
+- Improved error handling and type safety
+
+### Technical Details
+
+- Optimized data structures for radar and rain processing
+- Enhanced coordinate transformation algorithms
+- Improved quality metrics calculation
+
+## [2.6.11] - 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)
+    - 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
+[Unreleased]: https://github.com/raainio/raain-model/compare/v3.0.1...HEAD
+
+[3.0.1]: https://github.com/raainio/raain-model/compare/v2.6.11...v3.0.1
+
+[2.6.11]: https://github.com/raainio/raain-model/compare/v2.6.9...v2.6.11
+
 [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 
+
+[0.0.1]: https://github.com/raainio/raain-model/releases/tag/v0.0.1 

package/README.md

@@ -2,7 +2,7 @@
 
 [![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/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0.4-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)
 
 > A TypeScript library for radar-based rain measurement and analysis, used in [radartorain.com](https://radartorain.com)
@@ -61,6 +61,17 @@ const computation = new RainComputationMap({
 Visit [documentation](https://raainio.github.io/raain-model)
 and [swagger](https://api.sandbox.radartorain.com/v2/docs).
 
+### Memory Bank
+
+This project uses a Memory Bank for comprehensive documentation and context retention. The Memory Bank is located in the `.memory-bank` directory and contains the following files:
+
+- `projectbrief.md`: Overview of the project, core requirements, and goals
+- `productContext.md`: Why the project exists, problems it solves, and how it works
+- `systemPatterns.md`: System architecture, key technical decisions, and design patterns
+- `techContext.md`: Technologies used, development setup, and technical constraints
+- `activeContext.md`: Current work focus, recent changes, and next steps
+- `progress.md`: What works, what's left to build, and known issues
+
 ### Key Components
 
 - `RainNode`: Core class for rain measurement nodes
@@ -79,20 +90,10 @@ npm test
 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
+## 📅 Changelog
 
-- [Website](https://radartorain.com)
-- [API Documentation](https://api.sandbox.radartorain.com/docs)
-- [GitHub Issues](https://github.com/raainio/raain-model/issues)
+See [Changelog](./CHANGELOG.md) for version history and changes.

package/RELEASE_PROCESS.md

@@ -1,5 +1,13 @@
 # Release Process Documentation
 
+⚠️ IMPORTANT: DO NOT PUSH ANY CHANGES OR TAGS UNTIL EXPLICITLY ASKED TO "RELEASE"
+This includes:
+- No git push
+- No git push --tags
+- No npm publish
+- No manual releases
+Wait for the explicit "release" command before pushing anything.
+
 ## Patch Version Release Steps
 
 ### Prerequisites
@@ -27,6 +35,20 @@
     - specs/*.md files
     - CHANGELOG.md
 
+3. **Update Version Number**
+   ```bash
+   npm run build-version
+   ```
+   This command automatically increments the patch version in package.json.
+
+4. **Update CHANGELOG.md**
+   - Move items from [Unreleased] section to a new version section
+   - Run the update-changelog script to automatically add the current system date in ISO format (YYYY-MM-DD):
+     ```bash
+     npm run update-changelog
+     ```
+   - Update the version comparison links at the bottom of the file
+
 5. **Version Control**
    ```bash
    git add .
@@ -35,9 +57,43 @@
    git push
    git push --tags
    ```
-   Replace X.Y.Z with the actual version number and provide a clear explanation of changes.
+   Replace X.Y.Z with the actual version number from package.json and provide a clear explanation of changes.
+
+## Minor and Major Version Release Steps
+
+For minor (feature) and major (breaking change) version releases, follow the same steps as for patch releases, with these differences:
+
+### Minor Version (Features)
+
+1. Use the following command instead of `npm run build-version`:
+   ```bash
+   npm version minor --no-git-tag-version
+   ```
+
+2. In the commit message, use:
+   ```bash
+   git commit -m "release: minor version X.Y.0 with [explanation of new features]"
+   ```
 
-## For all Version Release Steps (Patch or Release)
+3. Ensure all new features are properly documented in the CHANGELOG.md
+
+### Major Version (Breaking Changes)
+
+1. Use the following command instead of `npm run build-version`:
+   ```bash
+   npm version major --no-git-tag-version
+   ```
+
+2. In the commit message, use:
+   ```bash
+   git commit -m "release: major version X.0.0 with [explanation of breaking changes]"
+   ```
+
+3. Ensure all breaking changes are clearly documented in the CHANGELOG.md
+4. Update the README.md to reflect any changes in usage patterns
+5. Consider creating a migration guide for users upgrading from the previous major version
+
+## For all Version Release Steps (Patch, Minor, or Major)
 
 ### Important Notes
 
@@ -48,6 +104,18 @@
 ### Post-Release Verification
 
 - Verify the release is properly tagged
+- Test the build process:
+  ```bash
+  npm run build
+  ```
+- Verify the built package can be installed:
+  ```bash
+  cd dist
+  npm pack
+  # This creates a .tgz file that can be installed locally
+  # Install in a test project to verify it works:
+  # npm install /path/to/raain-model-X.Y.Z.tgz
+  ```
 
 ### Version Management Best Practices
 
@@ -73,8 +141,11 @@
 
 ### Common Pitfalls to Avoid
 
+- Don't push any changes before receiving explicit "release" command
 - Don't create tags with placeholder version numbers (X.Y.Z)
-- Don't forget to push both commits and tags
+- Don't forget to push both commits and tags (only after "release" command)
+- Don't manually publish to npm
+- Don't bypass CI process
 
 ### Recovery Procedures
 
@@ -102,10 +173,26 @@ If merge conflicts occur:
 - Return to the root directory for git operations
 - Use absolute paths when necessary to avoid confusion
 
+### CI/CD Integration
+
+This project uses GitHub Actions for continuous integration and deployment. The CI workflow is defined in `.github/workflows/ci.yml` and is triggered on pushes to the master branch. The workflow includes:
+
+- Running tests
+- Building the project
+- Generating documentation and deploying to GitHub Pages
+- Publishing the package to npm
+
+To ensure successful CI/CD:
+- Always verify that tests pass locally before pushing to master
+- Check the GitHub Actions tab after pushing to monitor the workflow
+- Address any CI failures immediately
+- Ensure you have the necessary secrets configured (NPM_TOKEN) for npm publishing
+
 ### 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 
+- Consider implementing a release automation script
+- Enhance the CI/CD pipeline with additional checks and deployments

package/cartesian/CartesianMeasureValue.d.ts

@@ -0,0 +1,46 @@
+import { ICartesianMeasureValue } from './ICartesianMeasureValue';
+import { CartesianValue } from './CartesianValue';
+import { LatLng } from './LatLng';
+export declare class CartesianMeasureValue implements ICartesianMeasureValue {
+    protected cartesianValues: CartesianValue[];
+    protected limitPoints: [LatLng, LatLng];
+    constructor(json: {
+        cartesianValues: string | CartesianValue[];
+        limitPoints?: [LatLng, LatLng];
+    });
+    static From(obj: ICartesianMeasureValue | any): CartesianMeasureValue;
+    getCartesianValuesStringified(): string;
+    getCartesianValues(): CartesianValue[];
+    setCartesianValues(cartesianValues: CartesianValue[]): void;
+    setCartesianValuesAsString(s: string): void;
+    toJSON(options?: {
+        stringify: boolean;
+    }): {
+        cartesianValues: string | CartesianValue[];
+        limitPoints: [LatLng, LatLng];
+    };
+    toJSONWithCartesianValuesStringified(): {
+        cartesianValues: string | CartesianValue[];
+        limitPoints: [LatLng, LatLng];
+    };
+    getCartesianValue(json: {
+        lat: number;
+        lng: number;
+    }): CartesianValue;
+    getCartesianValueRounded(json: {
+        lat: number;
+        lng: number;
+        scale: LatLng;
+    }): CartesianValue;
+    setCartesianValue(json: {
+        lat: number;
+        lng: number;
+        value: number;
+    }): void;
+    getLimitPoints(options?: {
+        forceCompute: boolean;
+    }): [LatLng, LatLng];
+    setLimitPoints(point1: LatLng, point2: LatLng): void;
+    protected setCartesianValuesAsAny(cartesianValues: any): void;
+    protected computeLimits(): void;
+}

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

@@ -1,88 +1,66 @@
-import {ICartesianMeasureValue} from './ICartesianMeasureValue';
-import {CartesianValue} from './CartesianValue';
-import {LatLng} from './LatLng';
-
-export class CartesianMeasureValue implements ICartesianMeasureValue {
-
-    protected cartesianValues: CartesianValue[];
-    protected limitPoints: [LatLng, LatLng];
-
-    constructor(json: {
-                    cartesianValues: string | CartesianValue[],
-                    limitPoints?: [LatLng, LatLng]
-                }
-    ) {
-
-        if (!json?.cartesianValues) {
+"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) {
+        var _a;
+        if (!(json === null || json === void 0 ? void 0 : json.cartesianValues)) {
             throw new Error('CartesianMeasureValue needs cartesianValues');
         }
-
         this.setCartesianValuesAsAny(json.cartesianValues);
-        if (json.limitPoints?.length === 2) {
+        if (((_a = json.limitPoints) === null || _a === void 0 ? void 0 : _a.length) === 2) {
             this.setLimitPoints(json.limitPoints[0], json.limitPoints[1]);
         }
     }
-
-    static From(obj: ICartesianMeasureValue | any): CartesianMeasureValue {
+    static From(obj) {
         const created = new CartesianMeasureValue({
             cartesianValues: [],
         });
-
         if (typeof obj.cartesianValues !== 'undefined') {
             created.setCartesianValuesAsAny(obj.cartesianValues);
         }
-
         if (Array.isArray(obj.limitPoints) && obj.limitPoints.length === 2) {
             created.setLimitPoints(obj.limitPoints[0], obj.limitPoints[1]);
         }
-
         return created;
     }
-
-    getCartesianValuesStringified(): string {
-        return JSON.stringify({cartesianValues: this.cartesianValues});
+    getCartesianValuesStringified() {
+        return JSON.stringify({ cartesianValues: this.cartesianValues });
     }
-
-    getCartesianValues(): CartesianValue[] {
+    getCartesianValues() {
         return this.cartesianValues;
     }
-
-    setCartesianValues(cartesianValues: CartesianValue[]): void {
+    setCartesianValues(cartesianValues) {
         this.cartesianValues = cartesianValues;
     }
-
-    setCartesianValuesAsString(s: string): void {
+    setCartesianValuesAsString(s) {
         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(v));
+                this.cartesianValues.push(new CartesianValue_1.CartesianValue(v));
             });
         }
     }
-
-    toJSON(options = {stringify: false}): any {
-
-        let cartesianValues: any = this.cartesianValues;
+    toJSON(options = { stringify: false }) {
+        let cartesianValues = this.cartesianValues;
         if (options.stringify) {
-            cartesianValues = JSON.stringify(this.cartesianValues)
+            cartesianValues = JSON.stringify(this.cartesianValues);
         }
-
         return {
             cartesianValues,
             limitPoints: this.getLimitPoints(),
         };
     }
-
-    toJSONWithCartesianValuesStringified(): any {
-        return this.toJSON({stringify: true});
+    toJSONWithCartesianValuesStringified() {
+        return this.toJSON({ stringify: true });
     }
-
-    getCartesianValue(json: { lat: number, lng: number }): CartesianValue {
+    getCartesianValue(json) {
         for (const value of this.cartesianValues) {
             if (value.lat === json.lat && value.lng === json.lng) {
                 return value;
@@ -90,12 +68,7 @@ export class CartesianMeasureValue implements ICartesianMeasureValue {
         }
         return null;
     }
-
-    getCartesianValueRounded(json: {
-        lat: number,
-        lng: number,
-        scale: LatLng
-    }): CartesianValue {
+    getCartesianValueRounded(json) {
         for (const value of this.cartesianValues) {
             const latRounded1 = Math.round(json.lat / json.scale.lat) * json.scale.lat;
             const lngRounded1 = Math.round(json.lng / json.scale.lng) * json.scale.lng;
@@ -107,40 +80,35 @@ export class CartesianMeasureValue implements ICartesianMeasureValue {
         }
         return null;
     }
-
-    setCartesianValue(json: { lat: number, lng: number, value: number }): void {
-        this.cartesianValues.push(new CartesianValue(json));
+    setCartesianValue(json) {
+        this.cartesianValues.push(new CartesianValue_1.CartesianValue(json));
     }
-
-    getLimitPoints(options = {forceCompute: false}): [LatLng, LatLng] {
+    getLimitPoints(options = { forceCompute: false }) {
         if (options.forceCompute || !this.limitPoints || this.limitPoints.length !== 2) {
             this.computeLimits();
         }
         return this.limitPoints;
     }
-
-    setLimitPoints(point1: LatLng, point2: LatLng) {
+    setLimitPoints(point1, point2) {
         this.limitPoints = [
-            new LatLng({lat: point1.lat, lng: point1.lng}),
-            new LatLng({lat: point2.lat, lng: point2.lng})
+            new LatLng_1.LatLng({ lat: point1.lat, lng: point1.lng }),
+            new LatLng_1.LatLng({ lat: point2.lat, lng: point2.lng })
         ];
     }
-
-    protected setCartesianValuesAsAny(cartesianValues: any) {
+    setCartesianValuesAsAny(cartesianValues) {
         if (typeof cartesianValues === 'string') {
             this.setCartesianValuesAsString(cartesianValues);
-        } else {
+        }
+        else {
             this.setCartesianValues(cartesianValues);
         }
     }
-
-    protected computeLimits() {
+    computeLimits() {
         this.limitPoints = undefined;
-        let p1Lat: number;
-        let p1Lng: number;
-        let p2Lat: number;
-        let p2Lng: number;
-
+        let p1Lat;
+        let p1Lng;
+        let p2Lat;
+        let p2Lng;
         for (const cartesianValue of this.cartesianValues) {
             if (typeof p1Lat === 'undefined' || cartesianValue.lat < p1Lat) {
                 p1Lat = cartesianValue.lat;
@@ -155,11 +123,11 @@ export class CartesianMeasureValue implements ICartesianMeasureValue {
                 p2Lng = cartesianValue.lng;
             }
         }
-
         if (typeof p1Lat !== 'undefined' && typeof p1Lng !== 'undefined' &&
             typeof p2Lat !== 'undefined' && typeof p2Lng !== 'undefined') {
-            this.setLimitPoints(new LatLng({lat: p1Lat, lng: p1Lng}),
-                new LatLng({lat: p2Lat, lng: p2Lng}));
+            this.setLimitPoints(new LatLng_1.LatLng({ lat: p1Lat, lng: p1Lng }), new LatLng_1.LatLng({ lat: p2Lat, lng: p2Lng }));
         }
     }
 }
+exports.CartesianMeasureValue = CartesianMeasureValue;
+//# sourceMappingURL=CartesianMeasureValue.js.map