Merge pull request #4 from DevKevs/electoralRollValidation

feat: ✨ electoral roll register api call included

Author: DevKevs

README.md

@@ -4,24 +4,28 @@ This package offers a simple and efficient way to validate Dominican Republic ID
 
 # Installation
 
-you can install the package using:
+You can install the package using:
 
 ```sh
 npm install do-validator
 ```
 
 # Use
 
-```sh
-import { documentValidator } from 'do-validator';
+```ts
+import { documentValidator, electoralRollValidation } from 'do-validator';
+
+const document = '10000000001';
 
-const validation = documentValidator('12345678901');
+console.log(documentValidator(document));
 
-console.log(validation);
+const validation = async () =>  console.log(await electoralRollValidation(document));
+
+validation();
 ```
 # API 
-```sh
-documentValidator(document)
+```ts
+documentValidator(document) //Faster
 ```
 
 Validates a Dominican identity card number.
@@ -31,9 +35,29 @@ document (string): The identity card number to validate 11 characters without sp
 
 ### Return
 boolean: true if the ID number is valid, false otherwise.
+<hr>
 
-# Example
-```sh
+```ts
+//validation by API Call
+await electoralRollValidation(document) 
+```
+Validates a Dominican identity card number by an API Call in the Electoral roll.
+
+### Parameters
+document (string): The identity card number to validate 11 characters without special characters.
+
+### Return
+```ts
+{
+    statusCode: number,
+    valid: boolean,
+    message: string
+}
+```
+
+
+# Examples
+```ts
 import { documentValidator } from 'do-validator';
 
 const validId = 'YOUR_DOMINICAN_DOCUMENT';
@@ -42,6 +66,19 @@ const invalidId = '12345678901';
 console.log(documentValidator(validId));  // true
 console.log(documentValidator(invalidId));  // false
 
+```
+
+```ts
+import { electoralRollValidation } from 'do-validator';
+
+const validId = 'YOUR_DOMINICAN_DOCUMENT';
+const invalidId = '12345678901';
+
+const validation = async (document) =>  console.log(await electoralRollValidation(document));
+
+validation(validId); // valid json response
+validation(invalidId) // invalid json response
+
 ```
 # Author
 DevKevs

src/index.ts

@@ -25,6 +25,36 @@ export function documentValidator(document: string): boolean {
   }
 }
 
+/**
+ * The function `electoralRollValidation` validates in a electoral roll register by
+ * making an API call.
+ * @param {string} document - The `document` parameter in the `electoralRollValidation` function is
+ * expected to be a string representing an identification document number.
+ * @returns The function `electoralRollValidation` returns the response from the API endpoint
+ * after validating the provided
+ * document number.
+ */
+export async function electoralRollValidation(document: string) {
+  try {
+    const documentId: string = removeHyphens(document);
+
+    if (documentId.length !== 11) {
+      throw new Error('The provided document must have 11 characters.');
+    }
+
+    const promise = await fetch(`https://api.digital.gob.do/v3/cedulas/${documentId}/validate`);
+    const response = await promise.json();
+    
+    return { 
+      statusCode: promise.status,
+      valid: response.valid, 
+      message: response.message ?? 'The provided document is valid.'
+    };
+  } catch (error) {
+    console.error(error)
+  }
+}
+
 function removeHyphens(documentId: string): string {
   if (documentId.includes('-')) {
     return documentId.replace(/-/g, '');

src/testlib.ts

@@ -1,3 +1,10 @@
-import { documentValidator } from ".";
+import { documentValidator, electoralRollValidation } from ".";
 
-console.log(documentValidator("12345678901"));
+const document = '10000000001';
+
+//Locally validation (No API call needed)
+console.log(documentValidator(document));
+
+//Server side, by API call validation
+const validation = async () =>  console.log(await electoralRollValidation(document));
+validation();