@apiverve/humannameparser 1.1.14 → 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.
Files changed (3) hide show
  1. package/README.md +3 -1
  2. package/index.d.ts +22 -8
  3. package/package.json +5 -6
package/README.md CHANGED
@@ -130,7 +130,9 @@ async function makeRequest() {
130
130
  "last": "de Florence",
131
131
  "nick": "Tino",
132
132
  "suffix": "Jr."
133
- }
133
+ },
134
+ "initials": "MPF",
135
+ "formalName": "Mr. de Florence, Martino P. Jr."
134
136
  }
135
137
  }
136
138
  ```
package/index.d.ts CHANGED
@@ -4,26 +4,40 @@ declare module '@apiverve/humannameparser' {
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 humannameparserResponse {
8
19
  status: string;
9
20
  error: string | null;
10
21
  data: HumanNameParserData;
11
22
  code?: number;
23
+ premium?: PremiumInfo;
12
24
  }
13
25
 
14
26
 
15
27
  interface HumanNameParserData {
16
- name: string;
17
- parsed: Parsed;
28
+ name: null | string;
29
+ parsed: Parsed;
30
+ initials: null | string;
31
+ formalName: null | string;
18
32
  }
19
33
 
20
34
  interface Parsed {
21
- title: string;
22
- first: string;
23
- middle: string;
24
- last: string;
25
- nick: string;
26
- suffix: string;
35
+ title: null | string;
36
+ first: null | string;
37
+ middle: null | string;
38
+ last: null | string;
39
+ nick: null | string;
40
+ suffix: null | string;
27
41
  }
28
42
 
29
43
  export default class humannameparserWrapper {
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@apiverve/humannameparser",
3
- "version": "1.1.14",
3
+ "version": "1.2.0",
4
4
  "description": "Human Name Parser is a simple tool for parsing human names into their components. It returns the parsed components of the human name.",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
7
7
  "sideEffects": false,
8
8
  "engines": {
9
- "node": ">=14.0.0"
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
+ "human name parser", "human name parser", "parser api", "human name parser tool", "human name parser software"
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
- "node-fetch": "^3.3.2",
45
- "promise": "^8.3.0",
46
- "axios": "1.13.2"
44
+ "axios": "1.13.2",
45
+ "form-data": "^4.0.1"
47
46
  }
48
47
  }