@apiverve/sunrisesunset 1.1.12 → 1.1.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -5,8 +5,9 @@ Sunrise Sunset is a simple tool for getting the sunrise and sunset times. It ret
5
5
  ![Build Status](https://img.shields.io/badge/build-passing-green)
6
6
  ![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
7
7
  ![Prod Ready](https://img.shields.io/badge/production-ready-blue)
8
+ [![npm version](https://img.shields.io/npm/v/@apiverve/sunrisesunset.svg)](https://www.npmjs.com/package/@apiverve/sunrisesunset)
8
9
 
9
- This is a Javascript Wrapper for the [Sunrise Sunset API](https://apiverve.com/marketplace/sunrisesunset)
10
+ This is a Javascript Wrapper for the [Sunrise Sunset API](https://sunrisesunset.apiverve.com?utm_source=npm&utm_medium=readme)
10
11
 
11
12
  ---
12
13
 
@@ -27,15 +28,15 @@ yarn add @apiverve/sunrisesunset
27
28
  ## Configuration
28
29
 
29
30
  Before using the Sunrise Sunset API client, you have to setup your account and obtain your API Key.
30
- You can get it by signing up at [https://apiverve.com](https://apiverve.com)
31
+ You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=npm&utm_medium=readme)
31
32
 
32
33
  ---
33
34
 
34
35
  ## Quick Start
35
36
 
36
- [Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart)
37
+ [Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart?utm_source=npm&utm_medium=readme)
37
38
 
38
- The Sunrise Sunset API documentation is found here: [https://docs.apiverve.com/ref/sunrisesunset](https://docs.apiverve.com/ref/sunrisesunset).
39
+ The Sunrise Sunset API documentation is found here: [https://docs.apiverve.com/ref/sunrisesunset](https://docs.apiverve.com/ref/sunrisesunset?utm_source=npm&utm_medium=readme).
39
40
  You can find parameters, example responses, and status codes documented here.
40
41
 
41
42
  ### Setup
@@ -59,9 +60,9 @@ Using the API is simple. All you have to do is make a request. The API will retu
59
60
 
60
61
  ```javascript
61
62
  var query = {
62
- lat: 36.7201600,
63
- lon: -4.4203400,
64
- date: "12-02-2025"
63
+ lat: 36.72016,
64
+ lon: -4.42034,
65
+ date: "01-16-2026"
65
66
  };
66
67
 
67
68
  api.execute(query, function (error, data) {
@@ -81,9 +82,9 @@ You can also use promises to make requests. The API returns a promise that you c
81
82
 
82
83
  ```javascript
83
84
  var query = {
84
- lat: 36.7201600,
85
- lon: -4.4203400,
86
- date: "12-02-2025"
85
+ lat: 36.72016,
86
+ lon: -4.42034,
87
+ date: "01-16-2026"
87
88
  };
88
89
 
89
90
  api.execute(query)
@@ -104,9 +105,9 @@ You can also use async/await to make requests. The API returns a promise that yo
104
105
  ```javascript
105
106
  async function makeRequest() {
106
107
  var query = {
107
- lat: 36.7201600,
108
- lon: -4.4203400,
109
- date: "12-02-2025"
108
+ lat: 36.72016,
109
+ lon: -4.42034,
110
+ date: "01-16-2026"
110
111
  };
111
112
 
112
113
  try {
@@ -148,7 +149,7 @@ async function makeRequest() {
148
149
 
149
150
  ## Customer Support
150
151
 
151
- Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).
152
+ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=npm&utm_medium=readme).
152
153
 
153
154
  ---
154
155
 
@@ -160,14 +161,14 @@ Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Tw
160
161
 
161
162
  ## Legal
162
163
 
163
- All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.
164
+ 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=readme), [Privacy Policy](https://apiverve.com/privacy?utm_source=npm&utm_medium=readme), and [Refund Policy](https://apiverve.com/refund?utm_source=npm&utm_medium=readme).
164
165
 
165
166
  ---
166
167
 
167
168
  ## License
168
169
  Licensed under the The MIT License (MIT)
169
170
 
170
- Copyright (©) 2025 APIVerve, and EvlarSoft LLC
171
+ Copyright (©) 2026 APIVerve, and EvlarSoft LLC
171
172
 
172
173
  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:
173
174
 
package/index.js CHANGED
@@ -34,6 +34,102 @@ class sunrisesunsetWrapper {
34
34
 
35
35
  // secure is deprecated, all requests must be made over HTTPS
36
36
  this.baseURL = 'https://api.apiverve.com/v1/sunrisesunset';
37
+
38
+ // Validation rules for parameters (generated from schema)
39
+ this.validationRules = {"lat":{"type":"number","required":true,"min":-90,"max":90},"lon":{"type":"number","required":true,"min":-180,"max":180},"date":{"type":"string","required":false,"format":"date"}};
40
+ }
41
+
42
+ /**
43
+ * Validate query parameters against schema rules
44
+ * @param {Object} query - The query parameters to validate
45
+ * @throws {Error} - If validation fails
46
+ */
47
+ validateParams(query) {
48
+ const errors = [];
49
+
50
+ for (const [paramName, rules] of Object.entries(this.validationRules)) {
51
+ const value = query[paramName];
52
+
53
+ // Check required
54
+ if (rules.required && (value === undefined || value === null || value === '')) {
55
+ errors.push(`Required parameter [${paramName}] is missing.`);
56
+ continue;
57
+ }
58
+
59
+ // Skip validation if value is not provided and not required
60
+ if (value === undefined || value === null) {
61
+ continue;
62
+ }
63
+
64
+ // Type validation
65
+ if (rules.type === 'integer' || rules.type === 'number') {
66
+ const numValue = Number(value);
67
+ if (isNaN(numValue)) {
68
+ errors.push(`Parameter [${paramName}] must be a valid ${rules.type}.`);
69
+ continue;
70
+ }
71
+
72
+ if (rules.type === 'integer' && !Number.isInteger(numValue)) {
73
+ errors.push(`Parameter [${paramName}] must be an integer.`);
74
+ continue;
75
+ }
76
+
77
+ // Min/max validation for numbers
78
+ if (rules.min !== undefined && numValue < rules.min) {
79
+ errors.push(`Parameter [${paramName}] must be at least ${rules.min}.`);
80
+ }
81
+ if (rules.max !== undefined && numValue > rules.max) {
82
+ errors.push(`Parameter [${paramName}] must be at most ${rules.max}.`);
83
+ }
84
+ } else if (rules.type === 'string') {
85
+ if (typeof value !== 'string') {
86
+ errors.push(`Parameter [${paramName}] must be a string.`);
87
+ continue;
88
+ }
89
+
90
+ // Length validation for strings
91
+ if (rules.minLength !== undefined && value.length < rules.minLength) {
92
+ errors.push(`Parameter [${paramName}] must be at least ${rules.minLength} characters.`);
93
+ }
94
+ if (rules.maxLength !== undefined && value.length > rules.maxLength) {
95
+ errors.push(`Parameter [${paramName}] must be at most ${rules.maxLength} characters.`);
96
+ }
97
+
98
+ // Format validation
99
+ if (rules.format) {
100
+ const formatPatterns = {
101
+ 'email': /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
102
+ 'url': /^https?:\/\/.+/i,
103
+ '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}$/,
104
+ 'date': /^\d{4}-\d{2}-\d{2}$/,
105
+ 'hexColor': /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
106
+ };
107
+
108
+ if (formatPatterns[rules.format] && !formatPatterns[rules.format].test(value)) {
109
+ errors.push(`Parameter [${paramName}] must be a valid ${rules.format}.`);
110
+ }
111
+ }
112
+ } else if (rules.type === 'boolean') {
113
+ if (typeof value !== 'boolean' && value !== 'true' && value !== 'false') {
114
+ errors.push(`Parameter [${paramName}] must be a boolean.`);
115
+ }
116
+ } else if (rules.type === 'array') {
117
+ if (!Array.isArray(value)) {
118
+ errors.push(`Parameter [${paramName}] must be an array.`);
119
+ }
120
+ }
121
+
122
+ // Enum validation
123
+ if (rules.enum && Array.isArray(rules.enum)) {
124
+ if (!rules.enum.includes(value)) {
125
+ errors.push(`Parameter [${paramName}] must be one of: ${rules.enum.join(', ')}.`);
126
+ }
127
+ }
128
+ }
129
+
130
+ if (errors.length > 0) {
131
+ throw new Error(`Validation failed: ${errors.join(' ')} See documentation: https://docs.apiverve.com/ref/sunrisesunset`);
132
+ }
37
133
  }
38
134
 
39
135
  async execute(query, callback) {
@@ -58,14 +154,8 @@ class sunrisesunsetWrapper {
58
154
  }
59
155
  }
60
156
 
61
- var requiredParams = ["lat","lon"];
62
- if (requiredParams.length > 0) {
63
- for (var i = 0; i < requiredParams.length; i++) {
64
- if (!query[requiredParams[i]]) {
65
- throw new Error(`Required parameter [${requiredParams[i]}] is missing. See documentation: https://docs.apiverve.com/ref/sunrisesunset`);
66
- }
67
- }
68
- }
157
+ // Validate parameters against schema rules
158
+ this.validateParams(query);
69
159
 
70
160
  const method = 'GET';
71
161
  const url = method === 'POST' ? this.baseURL : this.constructURL(query);
@@ -108,7 +198,7 @@ class sunrisesunsetWrapper {
108
198
  constructURL(query) {
109
199
  let url = this.baseURL;
110
200
 
111
- if(query && typeof query === 'object')
201
+ if(query && typeof query === 'object')
112
202
  {
113
203
  if (Object.keys(query).length > 0) {
114
204
  const queryString = Object.keys(query)
@@ -119,6 +209,7 @@ class sunrisesunsetWrapper {
119
209
  }
120
210
  return url;
121
211
  }
212
+
122
213
  }
123
214
 
124
215
  module.exports = sunrisesunsetWrapper;
package/package.json CHANGED
@@ -1,9 +1,18 @@
1
1
  {
2
2
  "name": "@apiverve/sunrisesunset",
3
- "version": "1.1.12",
3
+ "version": "1.1.13",
4
4
  "description": "Sunrise Sunset is a simple tool for getting the sunrise and sunset times. It returns the sunrise and sunset times for a given location and date.",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
7
+ "sideEffects": false,
8
+ "engines": {
9
+ "node": ">=14.0.0"
10
+ },
11
+ "files": [
12
+ "index.js",
13
+ "index.d.ts",
14
+ "LICENSE"
15
+ ],
7
16
  "scripts": {
8
17
  "test": "mocha",
9
18
  "example": "node examples/basic.js"
@@ -14,14 +23,18 @@
14
23
  "directory": "npm"
15
24
  },
16
25
  "keywords": [
17
- "sunrise sunset", "sunrise sunset api", "sunrise sunset tool", "sunrise sunset software", "sunrise sunset service"
26
+ ""
18
27
  ],
19
- "author": "APIVerve <hello@apiverve.com> (http://apiverve.com/)",
28
+ "author": {
29
+ "name": "APIVerve",
30
+ "email": "hello@apiverve.com",
31
+ "url": "https://apiverve.com"
32
+ },
20
33
  "license": "MIT",
21
34
  "bugs": {
22
35
  "url": "https://github.com/apiverve/sunrisesunset-api/issues"
23
36
  },
24
- "homepage": "https://apiverve.com/marketplace/sunrisesunset?utm_source=npm",
37
+ "homepage": "https://sunrisesunset.apiverve.com?utm_source=npm&utm_medium=homepage",
25
38
  "devDependencies": {
26
39
  "mocha": "^11.0.1",
27
40
  "chai": "^5.1.2",
package/examples/basic.js DELETED
@@ -1,40 +0,0 @@
1
- /**
2
- * Basic Example - Sunrise Sunset API
3
- *
4
- * This example demonstrates how to use the Sunrise Sunset API.
5
- * Make sure to set your API key in the .env file or replace '[YOUR_API_KEY]' below.
6
- */
7
-
8
- require('dotenv').config();
9
- const sunrisesunsetAPI = require('../index.js');
10
-
11
- // Initialize the API client
12
- const api = new sunrisesunsetAPI({
13
- api_key: process.env.API_KEY || '[YOUR_API_KEY]'
14
- });
15
-
16
- // Example query
17
- var query = {
18
- lat: 36.7201600,
19
- lon: -4.4203400,
20
- date: "12-02-2025"
21
- };
22
-
23
- // Make the API request using callback
24
- console.log('Making request to Sunrise Sunset API...\n');
25
-
26
- api.execute(query, function (error, data) {
27
- if (error) {
28
- console.error('Error occurred:');
29
- if (error.error) {
30
- console.error('Message:', error.error);
31
- console.error('Status:', error.status);
32
- } else {
33
- console.error(JSON.stringify(error, null, 2));
34
- }
35
- return;
36
- }
37
-
38
- console.log('Response:');
39
- console.log(JSON.stringify(data, null, 2));
40
- });
package/tmp/build.dat DELETED
@@ -1 +0,0 @@
1
- #