@apiverve/babynamegenerator 1.1.9 → 1.1.10

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
@@ -1,5 +1,4 @@
1
- Baby Name Generator API
2
- ============
1
+ # Baby Name Generator API
3
2
 
4
3
  Baby Name Generator is a simple tool for generating baby names. It returns a list of baby names.
5
4
 
@@ -7,55 +6,63 @@ Baby Name Generator is a simple tool for generating baby names. It returns a lis
7
6
  ![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
8
7
  ![Prod Ready](https://img.shields.io/badge/production-ready-blue)
9
8
 
10
- This is a Javascript Wrapper for the [Baby Name Generator API](https://apiverve.com/marketplace/api/babynamegenerator)
9
+ This is a Javascript Wrapper for the [Baby Name Generator API](https://apiverve.com/marketplace/babynamegenerator)
11
10
 
12
11
  ---
13
12
 
14
13
  ## Installation
15
- npm install @apiverve/babynamegenerator --save
14
+
15
+ Using npm:
16
+ ```shell
17
+ npm install @apiverve/babynamegenerator
18
+ ```
19
+
20
+ Using yarn:
21
+ ```shell
22
+ yarn add @apiverve/babynamegenerator
23
+ ```
16
24
 
17
25
  ---
18
26
 
19
27
  ## Configuration
20
28
 
21
- Before using the babynamegenerator API client, you have to setup your account and obtain your API Key.
29
+ Before using the Baby Name Generator API client, you have to setup your account and obtain your API Key.
22
30
  You can get it by signing up at [https://apiverve.com](https://apiverve.com)
23
31
 
24
32
  ---
25
33
 
26
- ## Usage
34
+ ## Quick Start
27
35
 
28
- The Baby Name Generator API documentation is found here: [https://docs.apiverve.com/api/babynamegenerator](https://docs.apiverve.com/api/babynamegenerator).
36
+ [Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart)
37
+
38
+ The Baby Name Generator API documentation is found here: [https://docs.apiverve.com/ref/babynamegenerator](https://docs.apiverve.com/ref/babynamegenerator).
29
39
  You can find parameters, example responses, and status codes documented here.
30
40
 
31
41
  ### Setup
32
42
 
33
- ```
34
- var babynamegeneratorAPI = require('@apiverve/babynamegenerator');
35
- var api = new babynamegeneratorAPI({
36
- api_key: [YOUR_API_KEY],
37
- secure: true //(Optional, defaults to true)
43
+ ```javascript
44
+ const babynamegeneratorAPI = require('@apiverve/babynamegenerator');
45
+ const api = new babynamegeneratorAPI({
46
+ api_key: '[YOUR_API_KEY]'
38
47
  });
39
48
  ```
40
49
 
41
50
  ---
42
51
 
52
+ ## Usage
53
+
54
+ ---
43
55
 
44
56
  ### Perform Request
45
- Using the API client, you can perform requests to the API.
46
57
 
47
- ###### Define Query
58
+ 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.
48
59
 
49
- ```
60
+ ```javascript
50
61
  var query = {
51
62
  gender: "male",
52
63
  count: 1
53
64
  };
54
- ```
55
-
56
- ###### Simple Request (using Callback)
57
65
 
58
- ```
59
66
  api.execute(query, function (error, data) {
60
67
  if (error) {
61
68
  return console.error(error);
@@ -65,33 +72,77 @@ api.execute(query, function (error, data) {
65
72
  });
66
73
  ```
67
74
 
68
- ###### Example Response
75
+ ---
76
+
77
+ ### Using Promises
78
+
79
+ You can also use promises to make requests. The API returns a promise that you can use to handle the response.
80
+
81
+ ```javascript
82
+ var query = {
83
+ gender: "male",
84
+ count: 1
85
+ };
86
+
87
+ api.execute(query)
88
+ .then(data => {
89
+ console.log(data);
90
+ })
91
+ .catch(error => {
92
+ console.error(error);
93
+ });
94
+ ```
95
+
96
+ ---
97
+
98
+ ### Using Async/Await
99
+
100
+ You can also use async/await to make requests. The API returns a promise that you can use to handle the response.
101
+
102
+ ```javascript
103
+ async function makeRequest() {
104
+ var query = {
105
+ gender: "male",
106
+ count: 1
107
+ };
69
108
 
109
+ try {
110
+ const data = await api.execute(query);
111
+ console.log(data);
112
+ } catch (error) {
113
+ console.error(error);
114
+ }
115
+ }
70
116
  ```
71
- {
72
- "status": "ok",
73
- "error": null,
74
- "data": {
75
- "count": 3,
76
- "names": [
77
- {
78
- "firstName": "Gladys",
79
- "middleName": "Emily",
80
- "fullName": "Gladys Emily"
81
- },
82
- {
83
- "firstName": "Sandra",
84
- "middleName": "Tasha",
85
- "fullName": "Sandra Tasha"
86
- },
87
- {
88
- "firstName": "Patricia",
89
- "middleName": "Rosemary",
90
- "fullName": "Patricia Rosemary"
91
- }
92
- ]
93
- },
94
- "code": 200
117
+
118
+ ---
119
+
120
+ ## Example Response
121
+
122
+ ```json
123
+ {
124
+ "status": "ok",
125
+ "error": null,
126
+ "data": {
127
+ "count": 3,
128
+ "names": [
129
+ {
130
+ "firstName": "Gladys",
131
+ "middleName": "Emily",
132
+ "fullName": "Gladys Emily"
133
+ },
134
+ {
135
+ "firstName": "Sandra",
136
+ "middleName": "Tasha",
137
+ "fullName": "Sandra Tasha"
138
+ },
139
+ {
140
+ "firstName": "Patricia",
141
+ "middleName": "Rosemary",
142
+ "fullName": "Patricia Rosemary"
143
+ }
144
+ ]
145
+ }
95
146
  }
96
147
  ```
97
148
 
@@ -104,6 +155,7 @@ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/c
104
155
  ---
105
156
 
106
157
  ## Updates
158
+
107
159
  Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
108
160
 
109
161
  ---
@@ -117,10 +169,10 @@ All usage of the APIVerve website, API, and services is subject to the [APIVerve
117
169
  ## License
118
170
  Licensed under the The MIT License (MIT)
119
171
 
120
- Copyright (©) 2025 APIVerve, and EvlarSoft LLC
172
+ Copyright (©) 2025 APIVerve, and Evlar LLC
121
173
 
122
174
  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:
123
175
 
124
176
  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
125
177
 
126
- 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.
178
+ 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.
@@ -0,0 +1,39 @@
1
+ /**
2
+ * Basic Example - Baby Name Generator API
3
+ *
4
+ * This example demonstrates how to use the Baby Name Generator 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 babynamegeneratorAPI = require('../index.js');
10
+
11
+ // Initialize the API client
12
+ const api = new babynamegeneratorAPI({
13
+ api_key: process.env.API_KEY || '[YOUR_API_KEY]'
14
+ });
15
+
16
+ // Example query
17
+ var query = {
18
+ gender: "male",
19
+ count: 1
20
+ };
21
+
22
+ // Make the API request using callback
23
+ console.log('Making request to Baby Name Generator API...\n');
24
+
25
+ api.execute(query, function (error, data) {
26
+ if (error) {
27
+ console.error('Error occurred:');
28
+ if (error.error) {
29
+ console.error('Message:', error.error);
30
+ console.error('Status:', error.status);
31
+ } else {
32
+ console.error(JSON.stringify(error, null, 2));
33
+ }
34
+ return;
35
+ }
36
+
37
+ console.log('Response:');
38
+ console.log(JSON.stringify(data, null, 2));
39
+ });
package/index.d.ts ADDED
@@ -0,0 +1,21 @@
1
+ declare module '@apiverve/babynamegenerator' {
2
+ export interface babynamegeneratorOptions {
3
+ api_key: string;
4
+ secure?: boolean;
5
+ }
6
+
7
+ export interface babynamegeneratorResponse {
8
+ status: string;
9
+ error: string | null;
10
+ data: any;
11
+ code?: number;
12
+ }
13
+
14
+ export default class babynamegeneratorWrapper {
15
+ constructor(options: babynamegeneratorOptions);
16
+
17
+ execute(callback: (error: any, data: babynamegeneratorResponse | null) => void): Promise<babynamegeneratorResponse>;
18
+ execute(query: Record<string, any>, callback: (error: any, data: babynamegeneratorResponse | null) => void): Promise<babynamegeneratorResponse>;
19
+ execute(query?: Record<string, any>): Promise<babynamegeneratorResponse>;
20
+ }
21
+ }
package/index.js CHANGED
@@ -4,14 +4,27 @@ class babynamegeneratorWrapper {
4
4
 
5
5
  constructor(options) {
6
6
  if (!options || typeof options !== 'object') {
7
- throw new Error('Options object must be provided.');
7
+ throw new Error('Options object must be provided. See documentation: https://docs.apiverve.com/ref/babynamegenerator');
8
8
  }
9
9
 
10
10
  const { api_key, secure = true } = options;
11
11
 
12
12
  if (!api_key || typeof api_key !== 'string') {
13
- throw new Error('API key must be provided as a non-empty string.');
13
+ throw new Error('API key must be provided as a non-empty string. Get your API key at: https://apiverve.com');
14
14
  }
15
+
16
+ // Validate API key format (GUID or alphanumeric with hyphens)
17
+ const apiKeyPattern = /^[a-zA-Z0-9-]+$/;
18
+ if (!apiKeyPattern.test(api_key)) {
19
+ throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens. Get your API key at: https://apiverve.com');
20
+ }
21
+
22
+ // Check minimum length (GUIDs are typically 36 chars with hyphens, or 32 without)
23
+ const trimmedKey = api_key.replace(/-/g, '');
24
+ if (trimmedKey.length < 32) {
25
+ throw new Error('Invalid API key. API key appears to be too short. Get your API key at: https://apiverve.com');
26
+ }
27
+
15
28
  if (typeof secure !== 'boolean') {
16
29
  throw new Error('Secure parameter must be a boolean value.');
17
30
  }
@@ -24,20 +37,32 @@ class babynamegeneratorWrapper {
24
37
  }
25
38
 
26
39
  async execute(query, callback) {
27
- if(arguments.length > 1) {
40
+ // Handle different argument patterns
41
+ if(arguments.length === 0) {
42
+ // execute() - no args
43
+ query = {};
44
+ callback = null;
45
+ } else if(arguments.length === 1) {
46
+ if (typeof query === 'function') {
47
+ // execute(callback)
48
+ callback = query;
49
+ query = {};
50
+ } else {
51
+ // execute(query)
52
+ callback = null;
53
+ }
54
+ } else {
55
+ // execute(query, callback)
28
56
  if (!query || typeof query !== 'object') {
29
57
  throw new Error('Query parameters must be provided as an object.');
30
58
  }
31
- } else {
32
- callback = query;
33
- query = {};
34
59
  }
35
60
 
36
61
  var requiredParams = ["gender"];
37
62
  if (requiredParams.length > 0) {
38
63
  for (var i = 0; i < requiredParams.length; i++) {
39
64
  if (!query[requiredParams[i]]) {
40
- throw new Error(`Required parameter [${requiredParams[i]}] is missing.`);
65
+ throw new Error(`Required parameter [${requiredParams[i]}] is missing. See documentation: https://docs.apiverve.com/ref/babynamegenerator`);
41
66
  }
42
67
  }
43
68
  }
@@ -58,16 +83,25 @@ class babynamegeneratorWrapper {
58
83
  });
59
84
 
60
85
  const data = response.data;
61
- callback(null, data);
86
+ if (callback) callback(null, data);
62
87
  return data;
63
88
  } catch (error) {
64
- if (error.response.data) {
65
- callback(error.response.data, null);
66
- throw error.response.data;
89
+ let apiError;
90
+
91
+ if (error.response && error.response.data) {
92
+ apiError = error.response.data;
93
+ } else if (error.message) {
94
+ apiError = { error: error.message, status: 'error' };
67
95
  } else {
68
- callback(error, null);
69
- throw error;
70
- }
96
+ apiError = { error: 'An unknown error occurred', status: 'error' };
97
+ }
98
+
99
+ if (callback) {
100
+ callback(apiError, null);
101
+ return; // Don't throw if callback is provided
102
+ }
103
+
104
+ throw apiError;
71
105
  }
72
106
  }
73
107
 
package/package.json CHANGED
@@ -1,24 +1,26 @@
1
1
  {
2
2
  "name": "@apiverve/babynamegenerator",
3
- "version": "1.1.9",
3
+ "version": "1.1.10",
4
4
  "description": "Baby Name Generator is a simple tool for generating baby names. It returns a list of baby names.",
5
5
  "main": "index.js",
6
+ "types": "index.d.ts",
6
7
  "scripts": {
7
- "test": "mocha"
8
+ "test": "mocha",
9
+ "example": "node examples/basic.js"
8
10
  },
9
11
  "repository": {
10
12
  "type": "git",
11
13
  "url": "git+https://github.com/apiverve/babynamegenerator-API.git"
12
14
  },
13
15
  "keywords": [
14
- "baby name generator","baby names","baby name generator api","baby names api","baby name generator tool"
16
+ "baby name generator", "baby names", "baby name generator api", "baby names api", "baby name generator tool"
15
17
  ],
16
18
  "author": "APIVerve <hello@apiverve.com> (http://apiverve.com/)",
17
19
  "license": "MIT",
18
20
  "bugs": {
19
21
  "url": "https://github.com/apiverve/babynamegenerator-API/issues"
20
22
  },
21
- "homepage": "https://apiverve.com/marketplace/api/babynamegenerator?utm_source=npm",
23
+ "homepage": "https://apiverve.com/marketplace/babynamegenerator?utm_source=npm",
22
24
  "devDependencies": {
23
25
  "mocha": "^11.0.1",
24
26
  "chai": "^5.1.2",
@@ -27,6 +29,6 @@
27
29
  "dependencies": {
28
30
  "node-fetch": "^3.3.2",
29
31
  "promise": "^8.3.0",
30
- "axios": "1.7.9"
32
+ "axios": "1.8.4"
31
33
  }
32
34
  }