@apiverve/babynamegenerator 1.1.13 → 1.2.0
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 +11 -17
- package/index.d.ts +17 -4
- package/index.js +4 -10
- package/package.json +5 -6
package/README.md
CHANGED
|
@@ -61,7 +61,8 @@ Using the API is simple. All you have to do is make a request. The API will retu
|
|
|
61
61
|
```javascript
|
|
62
62
|
var query = {
|
|
63
63
|
gender: "male",
|
|
64
|
-
count: 1
|
|
64
|
+
count: 1,
|
|
65
|
+
includeAvatar: false
|
|
65
66
|
};
|
|
66
67
|
|
|
67
68
|
api.execute(query, function (error, data) {
|
|
@@ -82,7 +83,8 @@ You can also use promises to make requests. The API returns a promise that you c
|
|
|
82
83
|
```javascript
|
|
83
84
|
var query = {
|
|
84
85
|
gender: "male",
|
|
85
|
-
count: 1
|
|
86
|
+
count: 1,
|
|
87
|
+
includeAvatar: false
|
|
86
88
|
};
|
|
87
89
|
|
|
88
90
|
api.execute(query)
|
|
@@ -104,7 +106,8 @@ You can also use async/await to make requests. The API returns a promise that yo
|
|
|
104
106
|
async function makeRequest() {
|
|
105
107
|
var query = {
|
|
106
108
|
gender: "male",
|
|
107
|
-
count: 1
|
|
109
|
+
count: 1,
|
|
110
|
+
includeAvatar: false
|
|
108
111
|
};
|
|
109
112
|
|
|
110
113
|
try {
|
|
@@ -125,22 +128,13 @@ async function makeRequest() {
|
|
|
125
128
|
"status": "ok",
|
|
126
129
|
"error": null,
|
|
127
130
|
"data": {
|
|
128
|
-
"count":
|
|
131
|
+
"count": 1,
|
|
129
132
|
"names": [
|
|
130
133
|
{
|
|
131
|
-
"firstName": "
|
|
132
|
-
"middleName": "
|
|
133
|
-
"fullName": "
|
|
134
|
-
|
|
135
|
-
{
|
|
136
|
-
"firstName": "Sandra",
|
|
137
|
-
"middleName": "Tasha",
|
|
138
|
-
"fullName": "Sandra Tasha"
|
|
139
|
-
},
|
|
140
|
-
{
|
|
141
|
-
"firstName": "Patricia",
|
|
142
|
-
"middleName": "Rosemary",
|
|
143
|
-
"fullName": "Patricia Rosemary"
|
|
134
|
+
"firstName": "Myra",
|
|
135
|
+
"middleName": "Sherri",
|
|
136
|
+
"fullName": "Myra Sherri",
|
|
137
|
+
"avatar": "https://storage.googleapis.com/apiverve/APIResources/faces/Female/Child/11223344.jpg?X-Goog-Signature=..."
|
|
144
138
|
}
|
|
145
139
|
]
|
|
146
140
|
}
|
package/index.d.ts
CHANGED
|
@@ -4,23 +4,36 @@ declare module '@apiverve/babynamegenerator' {
|
|
|
4
4
|
secure?: boolean;
|
|
5
5
|
}
|
|
6
6
|
|
|
7
|
+
/**
|
|
8
|
+
* Describes fields the current plan does not unlock. Locked fields arrive as null
|
|
9
|
+
* in `data`; `locked_fields` names them, using dot paths for nested fields.
|
|
10
|
+
* Absent when the plan unlocks everything.
|
|
11
|
+
*/
|
|
12
|
+
export interface PremiumInfo {
|
|
13
|
+
message: string;
|
|
14
|
+
upgrade_url: string;
|
|
15
|
+
locked_fields: string[];
|
|
16
|
+
}
|
|
17
|
+
|
|
7
18
|
export interface babynamegeneratorResponse {
|
|
8
19
|
status: string;
|
|
9
20
|
error: string | null;
|
|
10
21
|
data: BabyNameGeneratorData;
|
|
11
22
|
code?: number;
|
|
23
|
+
premium?: PremiumInfo;
|
|
12
24
|
}
|
|
13
25
|
|
|
14
26
|
|
|
15
27
|
interface BabyNameGeneratorData {
|
|
16
|
-
count: number;
|
|
28
|
+
count: number | null;
|
|
17
29
|
names: Name[];
|
|
18
30
|
}
|
|
19
31
|
|
|
20
32
|
interface Name {
|
|
21
|
-
firstName: string;
|
|
22
|
-
middleName: string;
|
|
23
|
-
fullName: string;
|
|
33
|
+
firstName: null | string;
|
|
34
|
+
middleName: null | string;
|
|
35
|
+
fullName: null | string;
|
|
36
|
+
avatar: null | string;
|
|
24
37
|
}
|
|
25
38
|
|
|
26
39
|
export default class babynamegeneratorWrapper {
|
package/index.js
CHANGED
|
@@ -13,16 +13,10 @@ class babynamegeneratorWrapper {
|
|
|
13
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
15
|
|
|
16
|
-
// Validate API key format (GUID or alphanumeric
|
|
17
|
-
const apiKeyPattern = /^[a-zA-Z0-
|
|
16
|
+
// Validate API key format (GUID, prefixed keys like apv_xxx, or alphanumeric)
|
|
17
|
+
const apiKeyPattern = /^[a-zA-Z0-9_-]+$/;
|
|
18
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');
|
|
19
|
+
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');
|
|
26
20
|
}
|
|
27
21
|
|
|
28
22
|
if (typeof secure !== 'boolean') {
|
|
@@ -36,7 +30,7 @@ class babynamegeneratorWrapper {
|
|
|
36
30
|
this.baseURL = 'https://api.apiverve.com/v1/babynamegenerator';
|
|
37
31
|
|
|
38
32
|
// Validation rules for parameters (generated from schema)
|
|
39
|
-
this.validationRules = {"gender":{"type":"string","required":true},"count":{"type":"integer","required":false,"min":1,"max":100,"default":1}};
|
|
33
|
+
this.validationRules = {"gender":{"type":"string","required":true},"count":{"type":"integer","required":false,"min":1,"max":100,"default":1},"includeAvatar":{"type":"boolean","required":false,"default":false}};
|
|
40
34
|
}
|
|
41
35
|
|
|
42
36
|
/**
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@apiverve/babynamegenerator",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.2.0",
|
|
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
6
|
"types": "index.d.ts",
|
|
7
7
|
"sideEffects": false,
|
|
8
8
|
"engines": {
|
|
9
|
-
"node": ">=
|
|
9
|
+
"node": ">=18.0.0"
|
|
10
10
|
},
|
|
11
11
|
"files": [
|
|
12
12
|
"index.js",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"directory": "npm"
|
|
24
24
|
},
|
|
25
25
|
"keywords": [
|
|
26
|
-
""
|
|
26
|
+
"baby name generator", "baby names", "baby name generator api", "baby names api", "baby name generator tool"
|
|
27
27
|
],
|
|
28
28
|
"author": {
|
|
29
29
|
"name": "APIVerve",
|
|
@@ -41,8 +41,7 @@
|
|
|
41
41
|
"dotenv": "^16.4.7"
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"
|
|
45
|
-
"
|
|
46
|
-
"axios": "1.13.2"
|
|
44
|
+
"axios": "1.13.2",
|
|
45
|
+
"form-data": "^4.0.1"
|
|
47
46
|
}
|
|
48
47
|
}
|