dymo-api 1.0.99 → 1.1.1

package/dist/cjs/branches/private.cjs

@@ -36,7 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRandom = exports.sendEmail = exports.isValidData = void 0;
+exports.extractWithTextly = exports.getRandom = exports.sendEmail = exports.isValidData = void 0;
 const path_1 = __importDefault(require("path"));
 const react_1 = __importDefault(require("react"));
 const promises_1 = __importDefault(require("fs/promises"));
@@ -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"].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 } });
@@ -184,3 +184,32 @@ const getRandom = async (token, data) => {
     }
 };
 exports.getRandom = getRandom;
+/**
+ * Extracts structured data from a given string using a secure endpoint.
+ *
+ * @param token - A string or null representing the authentication token. Must not be null.
+ * @param data - An object adhering to the ExtractWithTextly interface, containing 'data' and 'format' fields.
+ *               The 'data' field is the string from which structured data should be extracted.
+ *               The 'format' field is an object defining the structure of the data to be extracted.
+ *
+ * @returns A promise that resolves to the response data containing the extracted structured data.
+ *
+ * @throws Will throw an error if the token is null, if 'data' or 'format' are not defined,
+ *         or if an error occurs during the request to the extraction endpoint.
+ */
+const extractWithTextly = async (token, data) => {
+    if (token === null)
+        throw customError(3000, "Invalid private token.");
+    if (!data.data)
+        throw customError(1500, "No data provided.");
+    if (!data.format)
+        throw customError(1500, "No format provided.");
+    try {
+        const response = await config_1.axiosApiUrl.post("/private/textly/extract", data, { headers: { "Content-Type": "application/json", "Authorization": token } });
+        return response.data;
+    }
+    catch (error) {
+        throw customError(5000, error.response?.data?.message || error.message);
+    }
+};
+exports.extractWithTextly = extractWithTextly;

package/dist/cjs/dymo-api.cjs

@@ -72,6 +72,7 @@ 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.
@@ -136,6 +137,21 @@ class DymoAPI {
     async getRandom(data) {
         return await PrivateAPI.getRandom(this.rootApiKey || this.apiKey, data);
     }
+    /**
+     * Extracts structured data from a given string using Textly.
+     *
+     * This method requires either the root API key or the API key to be set.
+     * If neither is set, it will throw an error.
+     *
+     * @param {Interfaces.ExtractWithTextly} data - The data to be sent, containing the string to be processed and the format schema.
+     * @returns {Promise<any>} A promise that resolves to the extracted structured data.
+     * @throws Will throw an error if there is an issue with the extraction process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/textly/text-extraction)
+     */
+    async extractWithTextly(data) {
+        return await PrivateAPI.extractWithTextly(this.rootApiKey || this.apiKey, data);
+    }
     // FUNCTIONS / Public.
     /**
      * Retrieves the prayer times for the given location.

package/dist/esm/branches/private.js

@@ -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"].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 } });
@@ -142,3 +142,31 @@ export const getRandom = async (token, data) => {
         throw customError(5000, error.response?.data?.message || error.message);
     }
 };
+/**
+ * Extracts structured data from a given string using a secure endpoint.
+ *
+ * @param token - A string or null representing the authentication token. Must not be null.
+ * @param data - An object adhering to the ExtractWithTextly interface, containing 'data' and 'format' fields.
+ *               The 'data' field is the string from which structured data should be extracted.
+ *               The 'format' field is an object defining the structure of the data to be extracted.
+ *
+ * @returns A promise that resolves to the response data containing the extracted structured data.
+ *
+ * @throws Will throw an error if the token is null, if 'data' or 'format' are not defined,
+ *         or if an error occurs during the request to the extraction endpoint.
+ */
+export const extractWithTextly = async (token, data) => {
+    if (token === null)
+        throw customError(3000, "Invalid private token.");
+    if (!data.data)
+        throw customError(1500, "No data provided.");
+    if (!data.format)
+        throw customError(1500, "No format provided.");
+    try {
+        const response = await axiosApiUrl.post("/private/textly/extract", data, { headers: { "Content-Type": "application/json", "Authorization": token } });
+        return response.data;
+    }
+    catch (error) {
+        throw customError(5000, error.response?.data?.message || error.message);
+    }
+};

package/dist/esm/dymo-api.js

@@ -37,6 +37,7 @@ 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.
@@ -101,6 +102,21 @@ class DymoAPI {
     async getRandom(data) {
         return await PrivateAPI.getRandom(this.rootApiKey || this.apiKey, data);
     }
+    /**
+     * Extracts structured data from a given string using Textly.
+     *
+     * This method requires either the root API key or the API key to be set.
+     * If neither is set, it will throw an error.
+     *
+     * @param {Interfaces.ExtractWithTextly} data - The data to be sent, containing the string to be processed and the format schema.
+     * @returns {Promise<any>} A promise that resolves to the extracted structured data.
+     * @throws Will throw an error if there is an issue with the extraction process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/textly/text-extraction)
+     */
+    async extractWithTextly(data) {
+        return await PrivateAPI.extractWithTextly(this.rootApiKey || this.apiKey, data);
+    }
     // FUNCTIONS / Public.
     /**
      * Retrieves the prayer times for the given location.

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

@@ -42,3 +42,17 @@ export declare const sendEmail: (token: string | null, data: Interfaces.SendEmai
  *         or if an error occurs during the request to the random number generator endpoint.
  */
 export declare const getRandom: (token: string | null, data: Interfaces.SRNG) => Promise<any>;
+/**
+ * Extracts structured data from a given string using a secure endpoint.
+ *
+ * @param token - A string or null representing the authentication token. Must not be null.
+ * @param data - An object adhering to the ExtractWithTextly interface, containing 'data' and 'format' fields.
+ *               The 'data' field is the string from which structured data should be extracted.
+ *               The 'format' field is an object defining the structure of the data to be extracted.
+ *
+ * @returns A promise that resolves to the response data containing the extracted structured data.
+ *
+ * @throws Will throw an error if the token is null, if 'data' or 'format' are not defined,
+ *         or if an error occurs during the request to the extraction endpoint.
+ */
+export declare const extractWithTextly: (token: string | null, data: Interfaces.ExtractWithTextly) => Promise<any>;

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

@@ -34,6 +34,7 @@ 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.
@@ -90,6 +91,19 @@ declare class DymoAPI {
      * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/secure-random-number-generator)
      */
     getRandom(data: Interfaces.SRNG): Promise<Interfaces.SRNSummary>;
+    /**
+     * Extracts structured data from a given string using Textly.
+     *
+     * This method requires either the root API key or the API key to be set.
+     * If neither is set, it will throw an error.
+     *
+     * @param {Interfaces.ExtractWithTextly} data - The data to be sent, containing the string to be processed and the format schema.
+     * @returns {Promise<any>} A promise that resolves to the extracted structured data.
+     * @throws Will throw an error if there is an issue with the extraction process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/textly/text-extraction)
+     */
+    extractWithTextly(data: Interfaces.ExtractWithTextly): Promise<any>;
     /**
      * Retrieves the prayer times for the given location.
      *

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

@@ -11,6 +11,7 @@ export interface CreditCardData {
 }
 export type VerifyPlugins = "blocklist" | "compromiseDetector" | "nsfw" | "reputation" | "torNetwork" | "typosquatting" | "urlShortener";
 export interface Validator {
+    url?: string;
     email?: string;
     phone?: PhoneData;
     domain?: string;
@@ -164,6 +165,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;
@@ -274,3 +292,25 @@ export interface DataValidationAnalysis {
         };
     };
 }
+export type SchemaType = "string" | "number" | "boolean" | "array" | "object";
+export interface JsonSchemaProperty {
+    type: SchemaType;
+    items?: JsonSchemaProperty;
+    properties?: Record<string, JsonSchemaProperty>;
+    required?: string[];
+    description?: string;
+    format?: string;
+    enum?: unknown[];
+    minimum?: number;
+    maximum?: number;
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+    [key: string]: unknown;
+}
+export interface ExtractWithTextly {
+    data: string;
+    format: {
+        [key: string]: JsonSchemaProperty;
+    };
+}

package/package.json

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