@apiverve/weatheralerts 0.0.0-stage → 1.2.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 APIVerve and EvlarSoft LLC
+
+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,3 +1,242 @@
-# Temporary Holding Version
+# Weather Alerts API
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Weather Alerts returns the severe weather warnings, watches and advisories in effect right now for any point or state in the United States, straight from the National Weather Service. Each alert names the event, how severe and urgent it is, the area covered, when it starts and ends, and what to do.
+
+[![npm version](https://img.shields.io/npm/v/@apiverve/weatheralerts.svg)](https://www.npmjs.com/package/@apiverve/weatheralerts)
+
+This is a JavaScript wrapper for the [Weather Alerts API](https://apiverve.com/marketplace/weatheralerts?utm_source=npm&utm_medium=referral&utm_content=readme)
+
+---
+
+## Installation
+
+Using npm:
+```shell
+npm install @apiverve/weatheralerts
+```
+
+Using yarn:
+```shell
+yarn add @apiverve/weatheralerts
+```
+
+---
+
+## Configuration
+
+Before using the Weather Alerts API client, you have to setup your account and obtain your API Key.
+You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=npm&utm_medium=referral&utm_content=readme)
+
+---
+
+## Quick Start
+
+[Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart?utm_source=npm&utm_medium=referral&utm_content=readme)
+
+The Weather Alerts API documentation is found here: [https://docs.apiverve.com/ref/weatheralerts](https://docs.apiverve.com/ref/weatheralerts?utm_source=npm&utm_medium=referral&utm_content=readme).
+You can find parameters, example responses, and status codes documented here.
+
+### Setup
+
+```javascript
+const weatheralertsAPI = require('@apiverve/weatheralerts');
+const api = new weatheralertsAPI({
+    api_key: '[YOUR_API_KEY]'
+});
+```
+
+---
+
+## Usage
+
+---
+
+### Perform Request
+
+Using the API is simple. All you have to do is make a request. The API will return a response with the data you requested.
+
+```javascript
+var query = {
+  lat: 38.627,
+  lon: -90.1994,
+  state: "TX"
+};
+
+api.execute(query, function (error, data) {
+    if (error) {
+        return console.error(error);
+    } else {
+        console.log(data);
+    }
+});
+```
+
+---
+
+### Using Promises
+
+You can also use promises to make requests. The API returns a promise that you can use to handle the response.
+
+```javascript
+var query = {
+  lat: 38.627,
+  lon: -90.1994,
+  state: "TX"
+};
+
+api.execute(query)
+    .then(data => {
+        console.log(data);
+    })
+    .catch(error => {
+        console.error(error);
+    });
+```
+
+---
+
+### Using Async/Await
+
+You can also use async/await to make requests. The API returns a promise that you can use to handle the response.
+
+```javascript
+async function makeRequest() {
+    var query = {
+  lat: 38.627,
+  lon: -90.1994,
+  state: "TX"
+};
+
+    try {
+        const data = await api.execute(query);
+        console.log(data);
+    } catch (error) {
+        console.error(error);
+    }
+}
+```
+
+---
+
+## Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "location": {
+      "state": "TX"
+    },
+    "count": 2,
+    "highestSeverity": "Severe",
+    "alerts": [
+      {
+        "id": "urn:oid:2.49.0.1.840.0.f9aca49ebcd46d4148ecadc4f42f00d6fee04ca6.001.1",
+        "event": "Flood Warning",
+        "headline": "Flood Warning issued October 2 at 1:51PM CDT until October 3 at 2:51AM CDT by NWS Fort Worth TX",
+        "summary": "FLOOD WARNING NOW IN EFFECT UNTIL LATE TONIGHT",
+        "severity": "Severe",
+        "urgency": "Immediate",
+        "certainty": "Observed",
+        "response": "Avoid",
+        "messageType": "Update",
+        "area": "Dallas, TX",
+        "issuedBy": "NWS Fort Worth TX",
+        "sent": "2026-10-02T13:51:00-05:00",
+        "onset": "2026-10-02T13:51:00-05:00",
+        "expires": "2026-10-03T03:00:00-05:00",
+        "ends": "2026-10-03T02:51:00-05:00",
+        "description": "...The Flood Warning continues for the following rivers in Texas...\n\nTrinity River At Dallas affecting Dallas County.\n\n* WHAT...Minor flooding is occurring and minor flooding is forecast.\n\n* WHERE...Trinity River at Dallas.\n\n* WHEN...Until late tonight.\n\n* IMPACTS...At 30.0 feet, Minor lowland flooding will begin, and\ntrails along the river begin to flood.\n\n* ADDITIONAL DETAILS...\n- At 1:30 PM CDT Friday the stage was 30.9 feet.\n- Forecast...The river is expected to fall below flood stage this\nafternoon and continue falling to 12.7 feet early Wednesday\nafternoon.\n- Bankfull stage is 30.0 feet.\n- Flood stage is 30.0 feet.",
+        "instruction": "Do not drive cars through flooded areas. Caution is urged when\nwalking near riverbanks.\n\nAdditional information is available at water.noaa.gov/wfo/fwd.",
+        "geometry": {
+          "type": "Polygon",
+          "coordinates": [
+            [
+              [
+                -96.93,
+                32.75
+              ],
+              [
+                -96.93,
+                32.81
+              ],
+              [
+                -96.83,
+                32.83
+              ],
+              [
+                -96.71,
+                32.75
+              ],
+              [
+                -96.76,
+                32.69
+              ],
+              [
+                -96.87,
+                32.78
+              ],
+              [
+                -96.93,
+                32.75
+              ]
+            ]
+          ]
+        }
+      },
+      {
+        "id": "urn:oid:2.49.0.1.840.0.b7cdd851a493afa58b5cf5fc13948ba8a35d2b25.001.1",
+        "event": "Flood Watch",
+        "headline": "Flood Watch issued October 2 at 1:36AM CDT until October 2 at 7:00PM CDT by NWS Corpus Christi TX",
+        "summary": "FLOOD WATCH REMAINS IN EFFECT THROUGH THIS EVENING",
+        "severity": "Severe",
+        "urgency": "Future",
+        "certainty": "Possible",
+        "response": "Prepare",
+        "messageType": "Update",
+        "area": "La Salle; McMullen; Live Oak; Bee; Goliad; Victoria; Webb; Duval; Jim Wells; Inland Kleberg; Inland Nueces; Inland San Patricio",
+        "issuedBy": "NWS Corpus Christi TX",
+        "sent": "2026-10-02T01:36:00-05:00",
+        "onset": "2026-10-02T01:36:00-05:00",
+        "expires": "2026-10-02T19:00:00-05:00",
+        "ends": "2026-10-02T19:00:00-05:00",
+        "description": "* WHAT...Flooding caused by excessive rainfall continues to be\npossible.\n\n* WHERE...A portion of south Texas, including the following areas,\nBee, Duval, Goliad, Inland Kleberg, Inland Nueces, Inland San\nPatricio, Jim Wells, La Salle, Live Oak, McMullen, Victoria and\nWebb.\n\n* WHEN...Through this evening.\n\n* IMPACTS...Excessive runoff may result in flooding of rivers,\ncreeks, streams, and other low-lying and flood-prone locations.\nFlooding may occur in poor drainage and urban areas.\n\n* ADDITIONAL DETAILS...\n- Flooding caused by excessive rainfall is possible. Additional\nrainfall totals of 1-3 inches with isolated higher amounts will\nfall over areas that have already seen 2-4\" of rain within the\nwatch area.\n- http://www.weather.gov/safety/flood",
+        "instruction": "You should monitor later forecasts and be alert for possible Flood\nWarnings. Those living in areas prone to flooding should be prepared\nto take action should flooding develop.",
+        "geometry": null
+      }
+    ]
+  }
+}
+```
+
+---
+
+## Customer Support
+
+Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=npm&utm_medium=referral&utm_content=readme).
+
+---
+
+## Updates
+
+Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
+
+---
+
+## Legal
+
+All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=npm&utm_medium=referral&utm_content=readme) and [Privacy Policy](https://apiverve.com/privacy?utm_source=npm&utm_medium=referral&utm_content=readme).
+
+---
+
+## License
+Licensed under the MIT License (MIT)
+
+Copyright (©) 2026 APIVerve, and EvlarSoft LLC
+
+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/index.d.ts

@@ -0,0 +1,71 @@
+declare module '@apiverve/weatheralerts' {
+  export interface weatheralertsOptions {
+    api_key: string;
+    secure?: boolean;
+  }
+
+  /**
+   * Describes fields the current plan does not unlock. Locked fields arrive as null
+   * in `data`; `locked_fields` names them, using dot paths for nested fields.
+   * Absent when the plan unlocks everything.
+   */
+  export interface PremiumInfo {
+    message: string;
+    upgrade_url: string;
+    locked_fields: string[];
+  }
+
+  export interface weatheralertsResponse {
+    status: string;
+    error: string | null;
+    data: WeatherAlertsData;
+    code?: number;
+    premium?: PremiumInfo;
+  }
+
+
+  interface WeatherAlertsData {
+      location:        Location;
+      count:           number | null;
+      highestSeverity: null | string;
+      alerts:          Alert[];
+  }
+  
+  interface Alert {
+      id:          null | string;
+      event:       null | string;
+      headline:    null | string;
+      summary:     null | string;
+      severity:    null | string;
+      urgency:     null | string;
+      certainty:   null | string;
+      response:    null | string;
+      messageType: null | string;
+      area:        null | string;
+      issuedBy:    null | string;
+      sent:        Date | null;
+      onset:       Date | null;
+      expires:     Date | null;
+      ends:        Date | null;
+      description: null | string;
+      instruction: null | string;
+      geometry:    Geometry | null;
+  }
+  
+  interface Geometry {
+      type:        null | string;
+      coordinates: Array<Array<(number | null)[]>>;
+  }
+  
+  interface Location {
+      state: null | string;
+  }
+
+  export default class weatheralertsWrapper {
+    constructor(options: weatheralertsOptions);
+
+    execute(callback: (error: any, data: weatheralertsResponse | null) => void): Promise<weatheralertsResponse>;
+    execute(query: Record<string, any>, callback: (error: any, data: weatheralertsResponse | null) => void): Promise<weatheralertsResponse>;
+    execute(query?: Record<string, any>): Promise<weatheralertsResponse>;
+  }
+}

package/index.js

@@ -0,0 +1,209 @@
+const axios = require('axios');
+
+class weatheralertsWrapper {
+
+    constructor(options) {
+        if (!options || typeof options !== 'object') {
+            throw new Error('Options object must be provided. See documentation: https://docs.apiverve.com/ref/weatheralerts');
+        }
+
+        const { api_key, secure = true } = options;
+
+        if (!api_key || typeof api_key !== 'string') {
+            throw new Error('API key must be provided as a non-empty string. Get your API key at: https://apiverve.com');
+        }
+
+        // Validate API key format (GUID, prefixed keys like apv_xxx, or alphanumeric)
+        const apiKeyPattern = /^[a-zA-Z0-9_-]+$/;
+        if (!apiKeyPattern.test(api_key)) {
+            throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens and underscores. Get your API key at: https://apiverve.com');
+        }
+
+        if (typeof secure !== 'boolean') {
+            throw new Error('Secure parameter must be a boolean value.');
+        }
+
+        this.APIKey = api_key;
+        this.IsSecure = secure;
+
+        // secure is deprecated, all requests must be made over HTTPS
+        this.baseURL = 'https://api.apiverve.com/v1/weatheralerts';
+
+        // Validation rules for parameters (generated from schema)
+        this.validationRules = {"lat":{"type":"number","required":false,"min":-90,"max":90},"lon":{"type":"number","required":false,"min":-180,"max":180},"state":{"type":"string","required":false}};
+    }
+
+    /**
+     * Validate query parameters against schema rules
+     * @param {Object} query - The query parameters to validate
+     * @throws {Error} - If validation fails
+     */
+    validateParams(query) {
+        const errors = [];
+
+        for (const [paramName, rules] of Object.entries(this.validationRules)) {
+            const value = query[paramName];
+
+            // Check required
+            if (rules.required && (value === undefined || value === null || value === '')) {
+                errors.push(`Required parameter [${paramName}] is missing.`);
+                continue;
+            }
+
+            // Skip validation if value is not provided and not required
+            if (value === undefined || value === null) {
+                continue;
+            }
+
+            // Type validation
+            if (rules.type === 'integer' || rules.type === 'number') {
+                const numValue = Number(value);
+                if (isNaN(numValue)) {
+                    errors.push(`Parameter [${paramName}] must be a valid ${rules.type}.`);
+                    continue;
+                }
+
+                if (rules.type === 'integer' && !Number.isInteger(numValue)) {
+                    errors.push(`Parameter [${paramName}] must be an integer.`);
+                    continue;
+                }
+
+                // Min/max validation for numbers
+                if (rules.min !== undefined && numValue < rules.min) {
+                    errors.push(`Parameter [${paramName}] must be at least ${rules.min}.`);
+                }
+                if (rules.max !== undefined && numValue > rules.max) {
+                    errors.push(`Parameter [${paramName}] must be at most ${rules.max}.`);
+                }
+            } else if (rules.type === 'string') {
+                if (typeof value !== 'string') {
+                    errors.push(`Parameter [${paramName}] must be a string.`);
+                    continue;
+                }
+
+                // Length validation for strings
+                if (rules.minLength !== undefined && value.length < rules.minLength) {
+                    errors.push(`Parameter [${paramName}] must be at least ${rules.minLength} characters.`);
+                }
+                if (rules.maxLength !== undefined && value.length > rules.maxLength) {
+                    errors.push(`Parameter [${paramName}] must be at most ${rules.maxLength} characters.`);
+                }
+
+                // Format validation
+                if (rules.format) {
+                    const formatPatterns = {
+                        'email': /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
+                        'url': /^https?:\/\/.+/i,
+                        'ip': /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$/,
+                        'date': /^\d{4}-\d{2}-\d{2}$/,
+                        'hexColor': /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
+                    };
+
+                    if (formatPatterns[rules.format] && !formatPatterns[rules.format].test(value)) {
+                        errors.push(`Parameter [${paramName}] must be a valid ${rules.format}.`);
+                    }
+                }
+            } else if (rules.type === 'boolean') {
+                if (typeof value !== 'boolean' && value !== 'true' && value !== 'false') {
+                    errors.push(`Parameter [${paramName}] must be a boolean.`);
+                }
+            } else if (rules.type === 'array') {
+                if (!Array.isArray(value)) {
+                    errors.push(`Parameter [${paramName}] must be an array.`);
+                }
+            }
+
+            // Enum validation
+            if (rules.enum && Array.isArray(rules.enum)) {
+                if (!rules.enum.includes(value)) {
+                    errors.push(`Parameter [${paramName}] must be one of: ${rules.enum.join(', ')}.`);
+                }
+            }
+        }
+
+        if (errors.length > 0) {
+            throw new Error(`Validation failed: ${errors.join(' ')} See documentation: https://docs.apiverve.com/ref/weatheralerts`);
+        }
+    }
+
+    async execute(query, callback) {
+        // Handle different argument patterns
+        if(arguments.length === 0) {
+            // execute() - no args
+            query = {};
+            callback = null;
+        } else if(arguments.length === 1) {
+            if (typeof query === 'function') {
+                // execute(callback)
+                callback = query;
+                query = {};
+            } else {
+                // execute(query)
+                callback = null;
+            }
+        } else {
+            // execute(query, callback)
+            if (!query || typeof query !== 'object') {
+                throw new Error('Query parameters must be provided as an object.');
+            }
+        }
+
+        // Validate parameters against schema rules
+        this.validateParams(query);
+
+        const method = 'GET';
+        const url = method === 'POST' ? this.baseURL : this.constructURL(query);
+
+        try {
+            const response = await axios({
+                method,
+                url,
+                headers: {
+                    'Content-Type': 'application/json',
+                    'x-api-key': this.APIKey,
+                    'auth-mode': 'npm-package'
+                },
+                data: method === 'POST' ? query : undefined
+            });
+
+            const data = response.data;
+            if (callback) callback(null, data);
+            return data;
+        } catch (error) {
+            let apiError;
+
+            if (error.response && error.response.data) {
+                apiError = error.response.data;
+            } else if (error.message) {
+                apiError = { error: error.message, status: 'error' };
+            } else {
+                apiError = { error: 'An unknown error occurred', status: 'error' };
+            }
+
+            if (callback) {
+                callback(apiError, null);
+                return; // Don't throw if callback is provided
+            }
+
+            throw apiError;
+        }
+    }
+
+    constructURL(query) {
+        let url = this.baseURL;
+
+        if(query && typeof query === 'object')
+        {
+            if (Object.keys(query).length > 0) {
+                const queryString = Object.keys(query)
+                    .map(key => `${encodeURIComponent(key)}=${encodeURIComponent(query[key])}`)
+                    .join('&');
+                url += `?${queryString}`;
+            }
+        }
+        return url;
+    }
+
+}
+
+module.exports = weatheralertsWrapper;

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "@apiverve/weatheralerts",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.2.2",
+  "description": "Weather Alerts returns the severe weather warnings, watches and advisories in effect right now for any point or state in the United States, straight from the National Weather Service. Each alert names the event, how severe and urgent it is, the area covered, when it starts and ends, and what to do.",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "LICENSE"
+  ],
+  "scripts": {
+    "test": "mocha",
+    "example": "node examples/basic.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/apiverve/weatheralerts-api.git",
+    "directory": "npm"
+  },
+  "keywords": [
+    "weather alerts api", "nws alerts api", "nws api", "national weather service api", "severe weather alerts api"
+  ],
+  "author": {
+    "name": "APIVerve",
+    "email": "hello@apiverve.com",
+    "url": "https://apiverve.com"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/apiverve/weatheralerts-api/issues"
+  },
+  "homepage": "https://apiverve.com/marketplace/weatheralerts?utm_source=npm&utm_medium=referral&utm_content=homepage",
+  "devDependencies": {
+    "mocha": "^11.0.1",
+    "chai": "^5.1.2",
+    "dotenv": "^16.4.7"
+  },
+  "dependencies": {
+    "axios": "1.13.2",
+    "form-data": "^4.0.1"
+  }
 }