Merge pull request #1 from oyve/dev

Merge dev into main

Author: oyve

.github/workflows/node.js.yml

@@ -11,19 +11,34 @@ on:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [20.x, 22.x]
+        node-version: [18.x, 20.x, 22.x]
 
     steps:
-    - uses: actions/checkout@v2
+    - name: Checkout code
+      uses: actions/checkout@v4
+
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm test
+
+    - name: Cache Node.js modules
+      uses: actions/cache@v3
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Build project
+      run: npm run build
+
+    - name: Run tests
+      run: npm test

.github/workflows/npm-publish.yml

@@ -1,7 +1,7 @@
 # This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
 # For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
 
-name: Node.js Package
+name: Publish to npm
 
 on:
   release:
@@ -14,20 +14,26 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 'lts/*'
       - run: npm ci
       - run: npm test
 
   publish-npm:
     needs: build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
         with:
-          node-version: 20
+          node-version: 'lts/*'
           registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish
+      - name: install dependencies
+        run: npm ci
+      - name: Build project
+        run: npm run build
+      - name: Publish to npm
+        run: npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.npmignore

@@ -0,0 +1,34 @@
+# Exclude node_modules (npm automatically excludes this)
+node_modules
+
+# Exclude TypeScript source files
+src
+
+# Exclude test files and directories
+tests
+*.test.ts
+
+# Exclude build and configuration files
+tsconfig.json
+jest.config.js
+
+# Exclude environment files
+.env
+.env.local
+
+# Exclude IDE and editor-specific files
+.vscode
+.idea
+
+# Exclude Git-related files
+.git
+.gitignore
+
+# Exclude logs and temporary files
+*.log
+*.tmp
+*.swp
+
+# Exclude other unnecessary files
+.DS_Store
+Thumbs.db

LICENSE

@@ -1,21 +1,17 @@
-MIT License
+GNU GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
 
-Copyright (c) 2020 Øyvind
+Copyright (C) 2025 Øyvind Hansen <oyve-github@outlook.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:
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
 
-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.
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.

README.md

@@ -1,9 +1,9 @@
-![Node.js CI](https://github.com/oyve/weather-formulas/workflows/Node.js%20CI/badge.svg?branch=main)
+![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg) ![Node.js CI](https://github.com/oyve/weather-formulas/workflows/Node.js%20CI/badge.svg?branch=main)
 # weather-formulas
 A library of atmospheric and weather related calculations.
 
-* Test code for all code/algorithms
-* Supports custom valuation sets where needed
+* Test code for all formulas
+* Supports custom valuation sets where supported
 
 ## Features
 
@@ -26,6 +26,7 @@ A library of atmospheric and weather related calculations.
 ### Pressure
 - [Pressure Altitude](https://en.wikipedia.org/wiki/Pressure_altitude)
 - [Density Altitude](https://en.wikipedia.org/wiki/Density_altitude)
+- [Adjust Pressure To Sea Level](https://en.wikipedia.org/wiki/Atmospheric_pressure)
 
 ## Install
 ```
@@ -34,37 +35,39 @@ $ npm install weather-formulas
 
 ## How to use
 ```
-const WF = require('weather-formulas');
+//Option #1 - accessing all
+const wf = require('weather-formulas');
+wf.temperature, wf.humidity, wf.pressure
 
-const TEMPERATURE = 300, HUMIDITY = 60, WINDSPEED = 10; //300 Kelvin, 60% Relative Humidity, 10 M/S
-
-let dewPointMF = WF.dewPointMagnusFormula(TEMPERATURE, HUMIDITY);
-let dewPointAF = WF.dewPointArdenBuckEquation(TEMPERATURE, HUMIDITY);
-let windChill = WF.windChillIndex(TEMPERATURE, WINDSPEED);
-let apparentTemperature = WF.australianAapparentTemperature(TEMPERATURE, HUMIDITY, WINDSPEED);
-let heatIndex = WF.heatIndex(TEMPERATURE, HUMIDITY);
-let heatIndexText = WF.heatIndexText(heatIndex); //output heat index threshold and warning text
+//Option #2 - accessing directly
+import { temperature, humidity, pressure } from 'weather-formulas'
+```
+```
+//With Option #1
+let RH = wf.humidity.relativeHumidity(TEMPERATURE, DEW_POINT);
+...
 
-let humidex = WF.humidex(TEMPERATURE, HUMIDITY);
-let humidexText = WF.humidexText(humidex); //output humidex threshold and warning text
+//With Option #2
+let RH = humidity.relativeHumidity(TEMPERATURE, DEW_POINT);
+...
 
 ```
 
 **Advanced examples**
 
 Use a provided valuation set
 ```
-const valuationSet =  temperature.DEW_POINT_VALUATIONS.DAVID_BOLTON;
-const actual = temperature.dewPointMagnusFormula(TEMPERATURE, HUMIDITY, valuationSet);
+const valuationSet =  wf.temperature.DEW_POINT_VALUATIONS.DAVID_BOLTON;
+const actual = wf.temperature.dewPointMagnusFormula(TEMPERATURE, HUMIDITY, valuationSet);
 ```
 Use a custom valuation set
 ```
-const valuationSet =  { a: 6, b: 17, c: 250, d: 234.5 }; //these values are made up for the sake of example
-const actual = temperature.dewPointArdenBuckEquation(TEMPERATURE, HUMIDITY, valuationSet);
+const valuationSet =  { a: 6, b: 17, c: 250, d: 234.5 };
+const actual = wf.temperature.dewPointArdenBuckEquation(TEMPERATURE, HUMIDITY, valuationSet);
 ```
 
 ## Contribute
-Please feel free to contribute by creating a Pull Request with test code.
+Please feel free to contribute by creating a Pull Request including test code.
 
 ## Disclaimer
 Always verify calculations before using in production as edge cases due to floating point errors may exists for large numbers, and that are not covered by tests today. Please report!

humidity.js

@@ -0,0 +1,14 @@
+export default {
+    preset: 'ts-jest',
+    transform: {
+      '^.+\\.ts$': [
+        'ts-jest', // Transformer for TypeScript files
+        {
+          useESM: true, // Enable ES Modules support for TypeScript
+        },
+      ],
+    },
+    extensionsToTreatAsEsm: ['.ts'], // Treat .ts files as ES modules
+    moduleFileExtensions: ['ts', 'js'], // Include both .ts and .js extensions for Jest
+    testMatch: ['**/*.test.ts'], // Ensure Jest picks up .test.ts files for tests
+  };