dymo-api 1.1.0 → 1.1.2

package/dist/cjs/branches/private.cjs

@@ -57,7 +57,7 @@ const convertTailwindToInlineCss = (htmlContent) => {
  *
  * @param token - A string or null representing the authentication token. Must not be null.
  * @param data - An object adhering to the Validator interface, containing at least one of the following fields:
- *               email, phone, domain, creditCard, ip, or wallet.
+ *               url, email, phone, domain, creditCard, ip, wallet or user agent.
  *
  * @returns A promise that resolves to the response data from the verification endpoint.
  *
@@ -67,7 +67,7 @@ const convertTailwindToInlineCss = (htmlContent) => {
 const isValidData = async (token, data) => {
     if (token === null)
         throw customError(3000, "Invalid private token.");
-    if (!Object.keys(data).some((key) => ["email", "phone", "domain", "creditCard", "ip", "wallet"].includes(key) && data.hasOwnProperty(key)))
+    if (!Object.keys(data).some((key) => ["url", "email", "phone", "domain", "creditCard", "ip", "wallet", "userAgent"].includes(key) && data.hasOwnProperty(key)))
         throw customError(1500, "You must provide at least one parameter.");
     try {
         const response = await config_1.axiosApiUrl.post("/private/secure/verify", data, { headers: { "Content-Type": "application/json", "Authorization": token } });

package/dist/cjs/dymo-api.cjs

@@ -72,12 +72,14 @@ class DymoAPI {
      * If neither is set, it will throw an error.
      *
      * @param {Object} data - The data to be validated.
+     * @param {string} [data.url] - Optional URL to be validated.
      * @param {string} [data.email] - Optional email address to be validated.
      * @param {Interfaces.PhoneData} [data.phone] - Optional phone number data to be validated.
      * @param {string} [data.domain] - Optional domain name to be validated.
      * @param {string|Interfaces.CreditCardData} [data.creditCard] - Optional credit card number or data to be validated.
      * @param {string} [data.ip] - Optional IP address to be validated.
      * @param {string} [data.wallet] - Optional wallet address to be validated.
+     * @param {string} [data.userAgent] - Optional user agent string to be validated.
      * @param {Interfaces.VerifyPlugins[]} [data.plugins] - Optional array of verification plugins to be used.
      * @returns {Promise<Interfaces.DataValidationAnalysis>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the validation process.

package/dist/esm/branches/private.js

@@ -18,7 +18,7 @@ const convertTailwindToInlineCss = (htmlContent) => {
  *
  * @param token - A string or null representing the authentication token. Must not be null.
  * @param data - An object adhering to the Validator interface, containing at least one of the following fields:
- *               email, phone, domain, creditCard, ip, or wallet.
+ *               url, email, phone, domain, creditCard, ip, wallet or user agent.
  *
  * @returns A promise that resolves to the response data from the verification endpoint.
  *
@@ -28,7 +28,7 @@ const convertTailwindToInlineCss = (htmlContent) => {
 export const isValidData = async (token, data) => {
     if (token === null)
         throw customError(3000, "Invalid private token.");
-    if (!Object.keys(data).some((key) => ["email", "phone", "domain", "creditCard", "ip", "wallet"].includes(key) && data.hasOwnProperty(key)))
+    if (!Object.keys(data).some((key) => ["url", "email", "phone", "domain", "creditCard", "ip", "wallet", "userAgent"].includes(key) && data.hasOwnProperty(key)))
         throw customError(1500, "You must provide at least one parameter.");
     try {
         const response = await axiosApiUrl.post("/private/secure/verify", data, { headers: { "Content-Type": "application/json", "Authorization": token } });

package/dist/esm/dymo-api.js

@@ -37,12 +37,14 @@ class DymoAPI {
      * If neither is set, it will throw an error.
      *
      * @param {Object} data - The data to be validated.
+     * @param {string} [data.url] - Optional URL to be validated.
      * @param {string} [data.email] - Optional email address to be validated.
      * @param {Interfaces.PhoneData} [data.phone] - Optional phone number data to be validated.
      * @param {string} [data.domain] - Optional domain name to be validated.
      * @param {string|Interfaces.CreditCardData} [data.creditCard] - Optional credit card number or data to be validated.
      * @param {string} [data.ip] - Optional IP address to be validated.
      * @param {string} [data.wallet] - Optional wallet address to be validated.
+     * @param {string} [data.userAgent] - Optional user agent string to be validated.
      * @param {Interfaces.VerifyPlugins[]} [data.plugins] - Optional array of verification plugins to be used.
      * @returns {Promise<Interfaces.DataValidationAnalysis>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the validation process.

package/dist/types/branches/private.d.ts

@@ -4,7 +4,7 @@ import * as Interfaces from "../lib/interfaces";
  *
  * @param token - A string or null representing the authentication token. Must not be null.
  * @param data - An object adhering to the Validator interface, containing at least one of the following fields:
- *               email, phone, domain, creditCard, ip, or wallet.
+ *               url, email, phone, domain, creditCard, ip, wallet or user agent.
  *
  * @returns A promise that resolves to the response data from the verification endpoint.
  *

package/dist/types/dymo-api.d.ts

@@ -34,12 +34,14 @@ declare class DymoAPI {
      * If neither is set, it will throw an error.
      *
      * @param {Object} data - The data to be validated.
+     * @param {string} [data.url] - Optional URL to be validated.
      * @param {string} [data.email] - Optional email address to be validated.
      * @param {Interfaces.PhoneData} [data.phone] - Optional phone number data to be validated.
      * @param {string} [data.domain] - Optional domain name to be validated.
      * @param {string|Interfaces.CreditCardData} [data.creditCard] - Optional credit card number or data to be validated.
      * @param {string} [data.ip] - Optional IP address to be validated.
      * @param {string} [data.wallet] - Optional wallet address to be validated.
+     * @param {string} [data.userAgent] - Optional user agent string to be validated.
      * @param {Interfaces.VerifyPlugins[]} [data.plugins] - Optional array of verification plugins to be used.
      * @returns {Promise<Interfaces.DataValidationAnalysis>} A promise that resolves to the response from the server.
      * @throws Will throw an error if there is an issue with the validation process.

package/dist/types/lib/interfaces.d.ts

@@ -11,12 +11,14 @@ export interface CreditCardData {
 }
 export type VerifyPlugins = "blocklist" | "compromiseDetector" | "nsfw" | "reputation" | "torNetwork" | "typosquatting" | "urlShortener";
 export interface Validator {
+    url?: string;
     email?: string;
     phone?: PhoneData;
     domain?: string;
     creditCard?: string | CreditCardData;
     ip?: string;
     wallet?: string;
+    userAgent?: string;
     plugins?: VerifyPlugins[];
 }
 export interface SRNG {
@@ -164,6 +166,23 @@ export interface PasswordValidationResult {
     details: ValidationDetail[];
 }
 export interface DataValidationAnalysis {
+    url: {
+        valid: boolean;
+        fraud: boolean;
+        freeSubdomain: boolean;
+        customTLD: boolean;
+        url: string;
+        domain: string;
+        plugins: {
+            blocklist?: boolean;
+            compromiseDetector?: boolean;
+            nsfw?: boolean;
+            reputation?: "low" | "medium" | "high" | "very-high" | "education" | "governmental" | "unknown";
+            torNetwork?: boolean;
+            typosquatting?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
+            urlShortener?: boolean;
+        };
+    };
     email: {
         valid: boolean;
         fraud: boolean;
@@ -273,6 +292,20 @@ export interface DataValidationAnalysis {
             torNetwork?: boolean;
         };
     };
+    userAgent: {
+        valid: boolean;
+        type?: string;
+        clientSlug?: string | null;
+        clientName?: string;
+        version?: string | null;
+        userAgent?: string;
+        fraud?: boolean;
+        isRealUser?: boolean;
+        info?: string;
+        plugins?: {
+            blocklist?: boolean;
+        };
+    };
 }
 export type SchemaType = "string" | "number" | "boolean" | "array" | "object";
 export interface JsonSchemaProperty {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dymo-api",
-  "version": "1.1.00",
+  "version": "1.1.02",
   "description": "Flow system for Dymo API.",
   "main": "dist/cjs/dymo-api.js",
   "module": "dist/esm/dymo-api.js",