raain-ui 2.3.6 → 2.3.7

package/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+All notable changes to the raain-ui 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).
+
+## [2.3.x] - Current
+
+### Added
+- Cartesian earth optimization for improved performance
+
+## [2.2.x]
+
+### Enhanced
+- Model polar visualization improvements
+
+## [2.1.x]
+
+### Added
+- Support for icons in composite layers
+
+## [2.0.x]
+
+### Changed
+- Updated raain-model integration
+
+## [1.11.x]
+
+### Changed
+- Refactored Factory components
+
+### Added
+- Performance monitoring capabilities
+
+## [1.10.x]
+
+### Fixed
+- Cartesian visualization issues
+
+### Added
+- Show/hide capability for UI elements
+
+## [1.0.x - 1.9.x]
+
+### Added
+- Various factories for UI components:
+  - Map integration
+  - Compare functionality
+  - Configuration options
+
+## [0.x.x]
+
+### Added
+- Initial release with core components extracted from RAAIN project

package/GUIDELINES.md

@@ -0,0 +1,168 @@
+# raain-ui Development Guidelines
+
+This document provides essential information for developers working on the raain-ui project.
+
+## Build and Configuration Instructions
+
+### Prerequisites
+- Node.js and npm
+
+### Setup
+1. Clone the repository
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+
+### Build Commands
+- **Build the project**:
+  ```bash
+  npm run build
+  ```
+  This command:
+  - Removes the existing `dist` directory
+  - Compiles TypeScript files according to `tsconfig.json`
+  - Copies markdown files and package.json to the dist directory
+
+- **Clean and reinstall**:
+  ```bash
+  npm run _clean
+  ```
+  This removes generated directories, logs, and node_modules, then reinstalls dependencies.
+
+- **Build with version increment**:
+  ```bash
+  npm run build-version
+  ```
+  This increments the patch version in package.json before building.
+
+### TypeScript Configuration
+The project uses TypeScript with the following key configurations:
+- Target: ES2017
+- Module: CommonJS
+- Declaration files are generated
+- Entry point: `./src/index.ts`
+- Output directory: `./dist/`
+
+## Testing Information
+
+### Test Configuration
+The project uses:
+- **Mocha**: Test runner
+- **Chai**: Assertion library
+- **NYC (Istanbul)**: Code coverage tool
+- **Mock-Browser**: For mocking browser environment in tests
+
+### Running Tests
+- **Run all tests**:
+  ```bash
+  npm test
+  ```
+
+- **Run specific tests** (using grep pattern):
+  ```bash
+  npm test -- -g "pattern"
+  ```
+  Example:
+  ```bash
+  npm test -- -g "should convert RGB string to hex"
+  ```
+
+### Test Environment
+Tests run in a Node.js environment with:
+- A mocked browser environment for Leaflet and Pixi.js components
+- TypeScript support via ts-node
+
+### Adding New Tests
+1. Create test files in the `specs` directory, mirroring the structure of the `src` directory
+2. Name test files with `.spec.ts` extension
+3. Use Mocha's `describe` and `it` functions for test organization
+4. Use Chai's `expect` for assertions
+
+### Example Test
+Here's a simple test for the `rgbStringToHex` method in the `Tools` class:
+
+```typescript
+import {expect} from 'chai';
+import {Tools} from '../../src';
+
+describe('Factories.Tools', () => {
+    it('should convert RGB string to hex', async () => {
+        // Test basic RGB to hex conversion
+        expect(Tools.rgbStringToHex('rgb(255, 0, 0)')).eq('#ff0000');
+        expect(Tools.rgbStringToHex('rgb(0, 255, 0)')).eq('#00ff00');
+
+        // Test error cases
+        try {
+            Tools.rgbStringToHex('invalid');
+            expect.fail('Should have thrown an error for invalid RGB string');
+        } catch (error) {
+            expect(error.message).eq('Invalid RGB string format');
+        }
+    });
+});
+```
+
+## Code Style and Development Guidelines
+
+### Code Style
+The project uses TSLint with the following key rules:
+- Single quotes for strings
+- Maximum line length of 140 characters
+- Member ordering: static fields, instance fields, static methods, instance methods
+- No requirement for interface names to start with "I"
+- No requirement for explicit member access modifiers
+
+### Documentation
+- Use JSDoc comments for classes, methods, and properties
+- Include parameter descriptions and return types
+- Document thrown exceptions
+
+### Project Structure
+- `src/`: Source code
+  - `drawers/`: Drawing components
+  - `factories/`: Factory classes
+  - `layers/`: Layer components
+  - `timeframes/`: Time-related components
+  - `tools/`: Utility tools
+- `specs/`: Test files (mirrors src structure)
+- `example/`: Example usage
+- `tools/`: Build and test utilities
+- `dist/`: Compiled output (generated)
+
+### Dependencies
+The project uses:
+- Chart.js for charting
+- Leaflet for maps
+- Pixi.js for rendering
+- raain-model for data models
+
+### Example Usage
+The project includes an example application in the `example` directory that demonstrates how to use the library:
+
+1. **Build the library first**:
+   ```bash
+   npm run build
+   ```
+
+2. **Run the example**:
+   ```bash
+   cd example
+   npm start
+   ```
+   This will:
+   - Clean the example directory
+   - Install dependencies
+   - Start a Parcel development server
+   - Open the example in your browser
+
+3. **Build the example for production**:
+   ```bash
+   cd example
+   npm run build
+   ```
+   This creates a production build in the `example/dist` directory.
+
+### Common Issues and Solutions
+- When testing components that use browser APIs, ensure the mock browser environment is properly set up
+- Some tests may fail due to timezone differences; use timezone-independent assertions when testing date formatting

package/README.md

@@ -1,19 +1,73 @@
 # raain-ui
 
-Please read the [specifications](./specs).
+UI components and visualization layers for raain.io applications.
+
+## Description
+
+raain-ui is a library that provides UI components and visualization layers for displaying and interacting with rainfall data. It uses Leaflet for maps, Pixi.js for rendering, and Chart.js for charting.
+
+## Installation
 
-or try the [example](./example) :
 ```bash
-npm i
+npm install raain-ui
+```
+
+## Usage
+
+### Basic Setup
+
+```javascript
+import { MapElement } from 'raain-ui';
+
+// Create a map element
+const mapElement = new MapElement({
+  container: 'map-container',
+  center: [51.505, -0.09],
+  zoom: 13
+});
+```
+
+### Example Application
+
+The project includes an example application that demonstrates how to use the library:
+
+```bash
+# Clone the repository
+git clone https://github.com/raainio/raain-ui.git
+cd raain-ui
+
+# Install dependencies and build the library
+npm install
 npm run build
+
+# Run the example
 cd example/
-npm start 
+npm start
 ```
-=> http://localhost:1234
 
-## History
+This will open the example application at http://localhost:1234
+
+## Development
+
+Please read the [Development Guidelines](./GUIDELINES.md) for detailed information about:
+- Build and configuration instructions
+- Testing information
+- Code style and development guidelines
+- Project structure
+- Dependencies
+
+## Documentation
 
-See [Release notes](./RELEASE.md).
+API documentation is available in the [specifications](./specs) directory.
+
+## Changelog
+
+See the [Changelog](./CHANGELOG.md) for a list of changes in each version.
+
+## Release Process
+
+See the [Release Process](./RELEASE_PROCESS.md) for information about how releases are managed.
 
 ## License
+
 MIT

package/RELEASE_PROCESS.md

@@ -0,0 +1,92 @@
+# Release Process
+
+This document outlines the process for creating and publishing new releases of the raain-ui library.
+
+## Version Numbering
+
+raain-ui follows [Semantic Versioning](https://semver.org/) (SemVer):
+
+- **MAJOR** version for incompatible API changes (X.y.z)
+- **MINOR** version for backwards-compatible functionality additions (x.Y.z)
+- **PATCH** version for backwards-compatible bug fixes (x.y.Z)
+
+## Release Steps
+
+### 1. Preparation
+
+1. Ensure all tests pass:
+   ```bash
+   npm test
+   ```
+
+2. Update documentation if necessary:
+    - README.md
+    - API documentation
+    - Example code
+
+3. Update the CHANGELOG.md file:
+    - Add a new section for the release version
+    - Document all notable changes since the last release
+    - Categorize changes as Added, Changed, Fixed, etc.
+
+### 2. Version Bump
+
+1. Use the built-in version increment script for patch releases:
+   ```bash
+   npm run build-version
+   ```
+
+   Or manually update the version in package.json for minor or major releases.
+
+### 3. Build and Test the Release
+
+1. Clean the project and reinstall dependencies:
+   ```bash
+   npm run _clean
+   ```
+
+2. Build the project:
+   ```bash
+   npm run build
+   ```
+
+3. Run tests again to ensure everything works with the built version:
+   ```bash
+   npm test
+   ```
+
+### 4. Publish to npm
+
+Do not it manually, it's done by GitHub CI by pushing in the master branch.
+
+### 5. Create a Git Tag and Release
+
+1. Create a git tag for the release:
+   ```bash
+   git tag -a v<version> -m "Release v<version>"
+   ```
+
+2. Push the tag to the repository:
+   ```bash
+   git push origin v<version>
+   ```
+
+3. Create a release on GitHub:
+    - Go to the repository's Releases page
+    - Create a new release using the tag
+    - Copy the relevant section from CHANGELOG.md as the release description
+
+## Hotfix Process
+
+For critical bug fixes that need to be released outside the normal release cycle:
+
+1. Create a hotfix branch from the latest release tag
+2. Fix the issue and commit the changes
+3. Follow the normal release process, but increment only the patch version
+4. After publishing, merge the hotfix back into the main development branch
+
+## Post-Release
+
+1. Update the example application to use the new version if necessary
+2. Notify users of the new release through appropriate channels
+3. Monitor for any issues reported by users

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "raain-ui",
-  "version": "2.3.6",
+  "version": "2.3.7",
   "author": "contact@raain.io",
   "homepage": "https://github.com/raainio/raain-ui",
   "description": "raain.io ui layers",

package/RELEASE.md

@@ -1,10 +0,0 @@
-# Release notes
-
-- 0.x.x : first extracts from RAAIN
-- 1.(-)9.x : factories uses in UI (map, compare, config)
-- 1.10.x : UI feedbacks (fix cartesians, add show/hide capability)
-- 1.11.x : Factory refactored, perf monitoring added
-- 2.0.x : change raain-model
-- 2.1.x : composite layer could include icons
-- 2.2.x : model polar enhancement
-- 2.3.x : cartesian earth optimization