dymo-api 1.2.5 → 1.2.7

package/dist/esm/utils/basics.js

@@ -0,0 +1,10 @@
+import config from "../config/index.js";
+export const customError = (code, message) => {
+    return Object.assign(new Error(), { code, message: `[${config.lib.name}] ${message}` });
+};
+export const validBaseURL = (baseUrl) => {
+    if (/^(https:\/\/api\.tpeoficial\.com$|http:\/\/(localhost:\d+|dymoapi:\d+))$/.test(baseUrl))
+        return baseUrl;
+    else
+        throw new Error("[Dymo API] Invalid URL. It must be https://api.tpeoficial.com or start with http://localhost or http://dymoapi followed by a port.");
+};

package/dist/types/branches/private/functions/extractWithTextly/index.d.ts

@@ -0,0 +1,16 @@
+import { type AxiosInstance } from "axios";
+import * as Interfaces from "../../../../lib/types/interfaces";
+/**
+ * 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: (axiosClient: AxiosInstance, data: Interfaces.ExtractWithTextly) => Promise<any>;

package/dist/types/branches/private/functions/getRandom/index.d.ts

@@ -0,0 +1,16 @@
+import { type AxiosInstance } from "axios";
+import * as Interfaces from "../../../../lib/types/interfaces";
+/**
+ * Retrieves a random number within a specified range 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 SRNG interface, containing 'min' and 'max' fields,
+ *               which define the inclusive range within which the random number should be generated.
+ *
+ * @returns A promise that resolves to the response data containing the random number.
+ *
+ * @throws Will throw an error if the token is null, if 'min' or 'max' are not defined,
+ *         if 'min' is not less than 'max', if 'min' or 'max' are out of the allowed range,
+ *         or if an error occurs during the request to the random number generator endpoint.
+ */
+export declare const getRandom: (axiosClient: AxiosInstance, data: Interfaces.SRNG) => Promise<any>;

package/dist/types/branches/private/functions/isValidData/index.d.ts

@@ -0,0 +1,15 @@
+import { type AxiosInstance } from "axios";
+import * as Interfaces from "../../../../lib/types/interfaces";
+/**
+ * Validates the provided data using a secure verification endpoint.
+ *
+ * @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:
+ *               url, email, phone, domain, creditCard, ip, wallet or user agent.
+ *
+ * @returns A promise that resolves to the response data from the verification endpoint.
+ *
+ * @throws Will throw an error if the token is null, if none of the required fields are present in the data,
+ *         or if an error occurs during the verification request.
+ */
+export declare const isValidData: (axiosClient: AxiosInstance, data: Interfaces.Validator) => Promise<any>;

package/dist/types/branches/private/functions/isValidEmail/index.d.ts

@@ -0,0 +1,20 @@
+import { type AxiosInstance } from "axios";
+import * as Interfaces from "../../../../lib/types/interfaces";
+/**
+ * Validates an email using a secure verification endpoint.
+ *
+ * @param {string | null} token - Authentication token (required).
+ * @param {Interfaces.EmailValidator} email - Email to validate.
+ * @param {Interfaces.EmailValidatorRules} [rules] - Deny rules. Defaults to ["FRAUD", "INVALID", "NO_MX_RECORDS", "NO_REPLY_EMAIL"].
+ *
+ * Deny rules (some are premium ⚠️):
+ * - "FRAUD", "INVALID", "NO_MX_RECORDS" ⚠️, "PROXIED_EMAIL" ⚠️, "FREE_SUBDOMAIN" ⚠️,
+ *   "PERSONAL_EMAIL", "CORPORATE_EMAIL", "NO_REPLY_EMAIL", "ROLE_ACCOUNT", "NO_REACHABLE", "HIGH_RISK_SCORE" ⚠️
+ *
+ * @returns {Promise<boolean>} True if the email passes all deny rules, false otherwise.
+ * @throws Error if token is null, rules are empty, or request fails.
+ *
+ * @example
+ * const valid = await isValidEmail(apiToken, "user@example.com", { deny: ["FRAUD", "NO_MX_RECORDS"] });
+ */
+export declare const isValidEmail: (axiosClient: AxiosInstance, email: Interfaces.EmailValidator, rules: Interfaces.EmailValidatorRules) => Promise<any>;

package/dist/types/branches/private/functions/protectReq/index.d.ts

@@ -0,0 +1,3 @@
+import { type AxiosInstance } from "axios";
+import * as Interfaces from "../../../../lib/types/interfaces";
+export declare const protectReq: <T>(axiosClient: AxiosInstance, req: Interfaces.HTTPRequest, rules: Interfaces.WafRules) => Promise<any>;

package/dist/types/branches/private/functions/protectReq/requestHandler.d.ts

@@ -0,0 +1,22 @@
+type GenericRequest<T = any> = {
+    body?: T;
+    headers?: Record<string, any>;
+    ip?: string;
+    connection?: {
+        remoteAddress?: string;
+    };
+    socket?: {
+        remoteAddress?: string;
+    };
+    req?: {
+        socket?: {
+            remoteAddress?: string;
+        };
+    };
+};
+export declare const handleRequest: <T = any>(req: GenericRequest<T>) => {
+    body: T | undefined;
+    userAgent: string | undefined;
+    ip: string | undefined;
+};
+export {};

package/dist/types/branches/private/functions/sendEmail/index.d.ts

@@ -0,0 +1,18 @@
+import { type AxiosInstance } from "axios";
+import * as Interfaces from "../../../../lib/types/interfaces";
+/**
+ * Sends an email using a secure sending endpoint.
+ *
+ * @param token - A string or null representing the authentication token. Must not be null.
+ * @param data - An object adhering to the SendEmail interface, containing the following fields:
+ *               'from', 'to', 'subject', 'html' or 'react', and optionally 'attachments', 'options', 'priority', 'waitToResponse', and 'composeTailwindClasses'.
+ *
+ * @returns A promise that resolves to the response data from the sending endpoint.
+ *
+ * @throws Will throw an error if the token is null, if any of the required fields are missing,
+ *         if the 'react' field is not a valid React element, if the 'attachments' field exceeds the maximum allowed size of 40 MB,
+ *         or if an error occurs during the sending request.
+ */
+export declare const sendEmail: (axiosClient: AxiosInstance, data: Interfaces.SendEmail & {
+    serverEmailConfig: Interfaces.ServerEmailConfig | undefined;
+}) => Promise<any>;

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

@@ -0,0 +1,6 @@
+export * from "./functions/extractWithTextly";
+export * from "./functions/getRandom";
+export * from "./functions/isValidData";
+export * from "./functions/isValidEmail";
+export * from "./functions/protectReq";
+export * from "./functions/sendEmail";

package/dist/types/branches/public/functions/getPrayerTimes/index.d.ts

@@ -0,0 +1,17 @@
+import { type AxiosInstance } from "axios";
+import * as Interfaces from "../../../../lib/types/interfaces";
+/**
+ * Retrieves the prayer times for the given location.
+ *
+ * This method requires a latitude and longitude to be provided in the
+ * data object. If either of these are not provided, it will throw an error.
+ *
+ * @param {Interfaces.PrayerTimesData} data - The data to be sent.
+ * @param {number} data.lat - The latitude of the location.
+ * @param {number} data.lon - The longitude of the location.
+ * @returns {Promise<any>} A promise that resolves to the response from the server.
+ * @throws Will throw an error if there is an issue with the prayer times retrieval process.
+ *
+ * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/prayertimes)
+ */
+export declare const getPrayerTimes: (axiosClient: AxiosInstance, data: Interfaces.PrayerTimesData) => Promise<any>;

package/dist/types/branches/public/functions/isValidPwd/index.d.ts

@@ -0,0 +1,28 @@
+import { type AxiosInstance } from "axios";
+import * as Interfaces from "../../../../lib/types/interfaces";
+/**
+ * Validates a password based on the given parameters.
+ *
+ * This method requires the password to be provided in the data object.
+ * If the password is not provided, it will throw an error. The method
+ * will validate the password against the following rules:
+ *  - The password must be at least 8 characters long.
+ *  - The password must be at most 32 characters long.
+ *  - The password must contain at least one uppercase letter.
+ *  - The password must contain at least one lowercase letter.
+ *  - The password must contain at least one number.
+ *  - The password must contain at least one special character.
+ *  - The password must not contain any of the given banned words.
+ *
+ * @param {Interfaces.IsValidPwdData} data - The data to be sent.
+ * @param {string} [data.email] - Optional email associated with the password.
+ * @param {string} data.password - The password to be validated.
+ * @param {string | string[]} [data.bannedWords] - The list of banned words that the password must not contain.
+ * @param {number} [data.min] - Minimum length of the password. Defaults to 8 if not provided.
+ * @param {number} [data.max] - Maximum length of the password. Defaults to 32 if not provided.
+ * @returns {Promise<Interfaces.PasswordValidationResult>} A promise that resolves to the response from the server.
+ * @throws Will throw an error if there is an issue with the password validation process.
+ *
+ * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/password-validator)
+*/
+export declare const isValidPwd: (axiosClient: AxiosInstance, data: Interfaces.IsValidPwdData) => Promise<any>;

package/dist/types/branches/public/functions/satinize/index.d.ts

@@ -0,0 +1,12 @@
+import { type AxiosInstance } from "axios";
+/**
+ * Sanitizes the input, replacing any special characters with their HTML entities.
+ *
+ * @param {Interfaces.InputSatinizerData} data - The data to be sent.
+ * @param {string} data.input - The input to be sanitized.
+ * @returns {Promise<any>} A promise that resolves to the response from the server.
+ * @throws Will throw an error if there is an issue with the sanitization process.
+ *
+ * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/input-satinizer)
+ */
+export declare const satinize: (axiosClient: AxiosInstance, input: string) => Promise<any>;

package/dist/types/branches/public/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./functions/getPrayerTimes";
+export * from "./functions/isValidPwd";
+export * from "./functions/satinize";

package/dist/types/config/index.d.ts

@@ -8,7 +8,3 @@ declare const config: {
     };
 };
 export default config;
-declare let BASE_URL: string;
-export declare const setBaseUrl: (baseUrl: string) => void;
-declare const axiosApiUrl: import("axios").AxiosInstance;
-export { BASE_URL, axiosApiUrl };

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

@@ -5,6 +5,7 @@ declare class DymoAPI {
     private serverEmailConfig?;
     private rules;
     private baseUrl;
+    private axiosClient;
     /**
      * @param {Object} options - Options to create the DymoAPI instance.
      * @param {string} [options.rootApiKey] - The root API key.
@@ -19,7 +20,7 @@ declare class DymoAPI {
      * @example
      * const dymoApi = new DymoAPI({
      *     rootApiKey: "6bfb7675-6b69-4f8d-9f43-5a6f7f02c6c5",
-     *     apiKey: "4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5"
+     *     apiKey: "dm_4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5"
      * });
      */
     constructor({ rootApiKey, apiKey, baseUrl, serverEmailConfig, rules }?: {
@@ -67,9 +68,28 @@ declare class DymoAPI {
      * @example
      * const valid = await dymoClient.isValidEmail("user@example.com", { deny: ["FRAUD", "NO_MX_RECORDS"] });
      *
-     * @see [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
+     * @see [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/request-verifier)
      */
     isValidEmail(email: Interfaces.EmailValidator, rules?: Interfaces.EmailValidatorRules): Promise<Interfaces.EmailValidatorResponse>;
+    /**
+     * Protects the given request against the configured rules.
+     *
+     * 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 {Object} req - The request object to be protected.
+     * @param {Interfaces.WafRules} [rules] - Optional rules for protection. Some rules are premium features.
+     * @returns {Promise<Interfaces.HTTPRequest>} Resolves with the protected request.
+     * @important
+     * **⚠️ This is a [PREMIUM](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier) and BETA feature.**
+     * @throws Will throw an error if protection cannot be performed.
+     *
+     * @example
+     * const protectedReq = await dymoClient.protectReq(req);
+     *
+     * @see [Documentation](https://docs.tpeoficial.com/docs/dymo-api/private/data-verifier)
+    */
+    protectReq(req: Interfaces.HTTPRequest, rules?: Interfaces.WafRules): Promise<any>;
     /**
      * Sends an email using the configured email client settings.
      *
@@ -143,6 +163,21 @@ declare class DymoAPI {
     getPrayerTimes(data: Interfaces.PrayerTimesData): Promise<Interfaces.CountryPrayerTimes | {
         error: string;
     }>;
+    /**
+     * Satinizes the input, replacing any special characters with their HTML
+     * entities.
+     *
+     * @deprecated Use `satinize` instead. This feature will be removed soon.
+     * @param {Object} data - The data to be sent.
+     * @param {string} data.input - The input to be satinized.
+     * @returns {Promise<Interfaces.SatinizedInputAnalysis>} A promise that resolves to the response from the server.
+     * @throws Will throw an error if there is an issue with the satinization process.
+     *
+     * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/input-satinizer)
+     */
+    satinizer(data: {
+        input: string;
+    }): Promise<Interfaces.SatinizedInputAnalysis>;
     /**
      * Satinizes the input, replacing any special characters with their HTML
      * entities.
@@ -154,7 +189,7 @@ declare class DymoAPI {
      *
      * [Documentation](https://docs.tpeoficial.com/docs/dymo-api/public/input-satinizer)
      */
-    satinizer(data: Interfaces.InputSatinizerData): Promise<Interfaces.SatinizedInputAnalysis>;
+    satinize(input: string): Promise<Interfaces.SatinizedInputAnalysis>;
     /**
      * Validates a password based on the given parameters.
      *

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

@@ -46,9 +46,6 @@ export interface PrayerTimesData {
     lat?: number;
     lon?: number;
 }
-export interface InputSatinizerData {
-    input?: string;
-}
 export interface IsValidPwdData {
     email?: string;
     password?: string;
@@ -166,4 +163,6 @@ export interface ExtractWithTextly {
     };
 }
 export * from "./rules";
+export * from "./primitives";
 export * from "./data-verifier";
+export * from "./well-known-bots";

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

@@ -9,3 +9,10 @@ export interface CreditCard {
     cvc?: string | number;
     cvv?: string | number;
 }
+export interface HTTPRequest {
+    url: string;
+    method: string | "GET" | "POST" | "PUT" | "DELETE";
+    headers?: Record<string, string>;
+    body?: string | object | null;
+    [key: string]: any;
+}

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

@@ -1,11 +1,23 @@
+import * as WellKnownBots from "./well-known-bots";
 import { NegativeEmailRules, NegativeSensitiveInfoRules } from "./data-verifier";
+type Mode = "LIVE" | "DRY_RUN";
+type NegativeWafRules = "FRAUD" | "VPN" | "PROXY" | "TOR_NETWORK";
+export interface WafRules {
+    mode?: Mode;
+    allowBots?: WellKnownBots.WellKnownBotOrCategory[];
+    deny?: NegativeWafRules[];
+}
 export interface EmailValidatorRules {
+    mode?: Mode;
     deny: NegativeEmailRules[];
 }
 export interface SensitiveInfoRules {
+    mode?: Mode;
     deny: NegativeSensitiveInfoRules[];
 }
 export interface Rules {
     email?: EmailValidatorRules;
     sensitiveInfo?: SensitiveInfoRules;
+    waf?: WafRules;
 }
+export {};

package/dist/types/lib/types/well-known-bots.d.ts

@@ -0,0 +1,4 @@
+export type WellKnownBot = "A6CORP_CRAWLER" | "ABOUNDEX_CRAWLER" | "ACAPBOT" | "ACOON_CRAWLER" | "ADBEAT_CRAWLER" | "ADDSEARCH_CRAWLER" | "ADDTHIS_CRAWLER" | "ADMANTX_CRAWLER" | "ADSCANNER_CRAWLER" | "ADSTXTCRAWLER" | "ADVBOT_CRAWLER" | "AHREFS_CRAWLER" | "AI_SEARCH_BOT" | "AI2_CRAWLER" | "AI2_CRAWLER_DOLMA" | "AIHIT_CRAWLER" | "ALEXANDRIA_CRAWLER" | "ALPHASEOBOT_CRAWLER" | "AMAZON_ALEXA_CRAWLER" | "AMAZON_CLOUDFRONT" | "AMAZON_CRAWLER" | "ANDERSPINK_CRAWLER" | "ANTHROPIC_CRAWLER" | "ANTIBOT" | "APERCITE_CRAWLER" | "APPLE_CRAWLER" | "APPLE_FEEDFETCHER" | "ARA_CRAWLER" | "ARATURKA_CRAWLER" | "ARCHIVEORG_ARCHIVER" | "AROCOM_CRAWLER" | "ASK_CRAWLER" | "ASPIEGEL_CRAWLER" | "AUDISTO_CRAWLER" | "AVIRA_CRAWLER" | "AWARIO_CRAWLER" | "AWARIO_CRAWLER_RSS" | "AWARIO_CRAWLER_SMART" | "AWESOMECRAWLER" | "AZURE_APP_INSIGHTS" | "B2BBOT" | "BACKLINKTEST_CRAWLER" | "BAIDU_CLOUD_WATCH" | "BAIDU_CRAWLER" | "BAZQUX_FEEDFETCHER" | "BETABOT" | "BETTERUPTIME_MONITOR" | "BIDSWITCH_CRAWLER" | "BIGDATACORP_CRAWLER" | "BIGLOTRON" | "BING_ADS" | "BING_CRAWLER" | "BING_OFFICE_STORE" | "BING_PREVIEW" | "BINLAR" | "BITLY_CRAWLER" | "BITSIGHT_CRAWLER" | "BLACKBOARD_CRAWLER" | "BLOGMURA_CRAWLER" | "BLOGTRAFFIC_FEEDFETCHER" | "BLP_BBOT" | "BNF_CRAWLER" | "BOMBORA_CRAWLER" | "BOTIFY_CRAWLER" | "BOXCAR_CRAWLER" | "BRAINOBOT" | "BRANDONMEDIA_CRAWLER" | "BRANDVERITY_CRAWLER" | "BRANDWATCH_CRAWLER" | "BRIGHTEDGE_CRAWLER" | "BUBLUP_CRAWLER" | "BUILTWITH_CRAWLER" | "BUZZSTREAM_CRAWLER" | "BYTEDANCE_CRAWLER" | "CAPSULINK_CRAWLER" | "CAREERX_CRAWLER" | "CENTURYBOT" | "CHANGEDETECTION_CRAWLER" | "CHECKMARKNETWORK_CRAWLER" | "CHLOOE_CRAWLER" | "CINCRAWDATA_CRAWLER" | "CISPA_CRAWLER" | "CITESEERX_CRAWLER" | "CLICKAGY_CRAWLER" | "CLIQZ_CRAWLER" | "CLOUDFLARE_ARCHIVER" | "CLOUDSYSTEMNETWORKS_CRAWLER" | "COCCOC_CRAWLER" | "COCOLYZE_CRAWLER" | "CODA_SERVER_FETCHER" | "CODEWISE_CRAWLER" | "COGNITIVESEO_CRAWLER" | "COHERE_CRAWLER" | "COMMONCRAWL_CRAWLER" | "COMPANYBOOK_CRAWLER" | "CONDUCTOR_CRAWLER" | "CONTENT_CRAWLER_SPIDER" | "CONTEXTAD_CRAWLER" | "CONTXBOT" | "CONVERA_CRAWLER" | "COOKIEBOT_CRAWLER" | "CREATIVECOMMONS_CRAWLER" | "CRITEO_CRAWLER" | "CRYSTALSEMANTICS_CRAWLER" | "CUREBOT_CRAWLER" | "CURL" | "CUTBOT_CRAWLER" | "CXENSE_CRAWLER" | "CYBERPATROL_CRAWLER" | "DAREBOOST_CRAWLER" | "DATADOG_MONITOR_SYNTHETICS" | "DATAFEEDWATCH_CRAWLER" | "DATAFORSEO_CRAWLER" | "DATAGNION_CRAWLER" | "DATANYZE_CRAWLER" | "DATAPROVIDER_CRAWLER" | "DATENBUTLER_CRAWLER" | "DAUM_CRAWLER" | "DCRAWL" | "DEADLINKCHECKER" | "DEEPNOC_CRAWLER" | "DEUSU_CRAWLER" | "DIFFBOT_CRAWLER" | "DIGG_CRAWLER" | "DIGINCORE_CRAWLER" | "DIGITALDRAGON_CRAWLER" | "DISCORD_CRAWLER" | "DISCOVERYENGINE_CRAWLER" | "DISQUS_CRAWLER" | "DNYZ_CRAWLER" | "DOMAINCRAWLER_CRAWLER" | "DOMAINREANIMATOR_CRAWLER" | "DOMAINSBOT_CRAWLER" | "DOMAINSPROJECT_CRAWLER" | "DOMAINSTATS_CRAWLER" | "DOMAINTOOLS_CRAWLER" | "DOTNETDOTCOM_CRAWLER" | "DRAGONMETRICS_CRAWLER" | "DRIFTNET_CRAWLER" | "DUBBOT_CRAWLER" | "DUCKDUCKGO_CRAWLER" | "DUCKDUCKGO_CRAWLER_FAVICONS" | "DUEDIL_CRAWLER" | "DYNATRACE_MONITOR" | "EC2LINKFINDER" | "EDISTER_CRAWLER" | "ELISABOT" | "EMBEDLY_CRAWLER" | "ENTIREWEB_CRAWLER" | "EPFL_CRAWLER" | "EPICTIONS_CRAWLER" | "ERIGHT_CRAWLER" | "EUROPARCHIVE_CRAWLER" | "EVENTURES_CRAWLER" | "EVENTURES_CRAWLER_BATCH" | "EVERYONESOCIAL_CRAWLER" | "EXENSA_CRAWLER" | "EXPERIBOT_CRAWLER" | "EXTLINKS_CRAWLER" | "EYEOTA_CRAWLER" | "EZID_CRAWLER" | "FACEBOOK_CRAWLER" | "FACEBOOK_SHARE_CRAWLER" | "FAST_CRAWLER" | "FAST_CRAWLER_ENTERPRISE" | "FEDORAPLANET_CRAWLER" | "FEEDAFEVER_CRAWLER" | "FEEDBIN_CRAWLER" | "FEEDLY_FEEDFETCHER" | "FEEDSPOT_FEEDFETCHER" | "FEMTOSEARCH_CRAWLER" | "FINDTHATFILE_CRAWLER" | "FLAMINGOSEARCH_CRAWLER" | "FLIPBOARD_PROXY" | "FLUFFY" | "FR_CRAWLER" | "FREEWEBMONITORING_MONITOR" | "FRESHRSS_FEEDFETCHER" | "FRESHWORKS_MONITOR" | "FRIENDLYCRAWLER" | "FUELBOT" | "FYREBOT" | "G00G1E_CRAWLER" | "G2READER_CRAWLER" | "G2WEBSERVICES_CRAWLER" | "GARLIK_CRAWLER" | "GEEDO_CRAWLER" | "GEEDO_CRAWLER_PRODUCTS" | "GENIEO_CRAWLER" | "GIGABLAST_CRAWLER" | "GIGABLAST_CRAWLER_OSS" | "GINGER_CRAWLER" | "GLUTENFREEPLEASURE_CRAWLER" | "GNAM_GNAM_SPIDER" | "GNOWIT_CRAWLER" | "GO_HTTP" | "GOO_CRAWLER" | "GOOGLE_ADSBOT" | "GOOGLE_ADSBOT_MOBILE" | "GOOGLE_ADSENSE" | "GOOGLE_ADSENSE_GOOGLEBOT" | "GOOGLE_ADWORDS" | "GOOGLE_APPENGINE" | "GOOGLE_CERTIFICATES_BRIDGE" | "GOOGLE_CRAWLER" | "GOOGLE_CRAWLER_CLOUDVERTEX" | "GOOGLE_CRAWLER_IMAGE" | "GOOGLE_CRAWLER_MOBILE" | "GOOGLE_CRAWLER_NEWS" | "GOOGLE_CRAWLER_OTHER" | "GOOGLE_CRAWLER_SAFETY" | "GOOGLE_CRAWLER_STORE" | "GOOGLE_CRAWLER_VIDEO" | "GOOGLE_FAVICON" | "GOOGLE_FEEDFETCHER" | "GOOGLE_INSPECTION_TOOL" | "GOOGLE_LIGHTHOUSE" | "GOOGLE_PHYSICAL_WEB" | "GOOGLE_PREVIEW" | "GOOGLE_PUSH_NOTIFICATIONS" | "GOOGLE_READ_ALOUD" | "GOOGLE_SITE_VERIFICATION" | "GOOGLE_STRUCTURED_DATA_TESTING_TOOL" | "GOOGLE_WEB_SNIPPET" | "GOOGLE_XRAWLER" | "GOWIKI_CRAWLER" | "GRAPESHOT_CRAWLER" | "GROB_CRAWLER" | "GROUPHIGH_CRAWLER" | "GROUPME_CRAWLER" | "GRUB" | "GSLFBOT" | "GWENE_CRAWLER" | "HAOSOU_CRAWLER" | "HATENA_CRAWLER" | "HEADLESS_CHROME" | "HEADLINE_CRAWLER" | "HOYER_CRAWLER" | "HTTP_GET" | "HTTRACK" | "HUBSPOT_CRAWLER" | "HYDROZEN_MONITOR" | "HYPEFACTORS_CRAWLER" | "HYPESTAT_CRAWLER" | "HYSCORE_CRAWLER" | "IA_ARCHIVER" | "IASK_CRAWLER" | "IDEASANDCODE_CRAWLER" | "IFRAMELY_PREVIEW" | "IMAGESIFT_CRAWLER" | "IMESSAGE_PREVIEW" | "IMG2DATASET" | "INDEED_CRAWLER" | "INETDEX_CRAWLER" | "INFEGY_CRAWLER" | "INFOO_CRAWLER" | "INOREADER_AGGREGATOR" | "INTEGRALADS_CRAWLER" | "INTEGROMEDB_CRAWLER" | "INTELIUM_CRAWLER" | "INTERNETARCHIVE_CRAWLER_OSS" | "IONOS_CRAWLER" | "IP_WEB_CRAWLER" | "IPIP_CRAWLER" | "IRC_ARCHIVEBOT" | "ISKANIE_CRAWLER" | "ISS_CRAWLER" | "IT2MEDIA_CRAWLER" | "ITINFLUENTIALS_CRAWLER" | "JAMIEMBROWN_CRAWLER" | "JAVA_APACHE_HTTPCLIENT" | "JAVA_ASYNCHTTPCLIENT" | "JAVA_CRAWLER4J" | "JAVA_HTTPUNIT" | "JAVA_JERSEY" | "JAVA_JETTY" | "JAVA_OKHTTP" | "JAVA_SNACKTORY" | "JAVASCRIPT_AXIOS" | "JAVASCRIPT_NODE_FETCH" | "JAVASCRIPT_PHANTOM" | "JETSLIDE_CRAWLER" | "JOBBOERSE_CRAWLER" | "JOOBLE_CRAWLER" | "JUSPROG_CRAWLER" | "JYXO_CRAWLER" | "K7COMPUTING_CRAWLER" | "KEMVI_CRAWLER" | "KOMODIA_CRAWLER" | "KOSMIO_CRAWLER" | "KUMA_MONITOR" | "L9EXPLORE" | "LANDAUMEDIA_CRAWLER" | "LASERLIKE_CRAWLER" | "LAW_UNIMI_CRAWLER" | "LB_SPIDER" | "LEADCRUNCH_CRAWLER" | "LEIKI_CRAWLER" | "LEIPZIG_FINDLINKS" | "LEIPZIG_LCC" | "LEMMY_CRAWLER" | "LIGHTSPEEDSYSTEMS_CRAWLER" | "LINE_CRAWLER" | "LINGUEE_CRAWLER" | "LINKAPEDIA_CRAWLER" | "LINKARCHIVER" | "LINKDEX_CRAWLER" | "LINKEDIN_CRAWLER" | "LINKFLUENCE_CRAWLER" | "LINKIS_CRAWLER" | "LIPPERHEY_CRAWLER" | "LIVELAP_CRAWLER" | "LOGLY_CRAWLER" | "LOOP_CRAWLER" | "LSSBOT" | "LSSBOT_ROCKET" | "LTX71_CRAWLER" | "LUMINATOR_CRAWLER" | "MACOCU_CRAWLER" | "MAILRU_CRAWLER" | "MAJESTIC_CRAWLER" | "MAPPYDATA_CRAWLER" | "MARGINALIA_CRAWLER" | "MASTODON_CRAWLER" | "MAUIBOT" | "MEDIATOOLKIT_CRAWLER" | "MEGAINDEX_CRAWLER" | "MELTWATER_CRAWLER" | "META_CRAWLER" | "META_CRAWLER_USER" | "METADATALABS_CRAWLER" | "METAJOB_CRAWLER" | "METAURI_CRAWLER" | "METRICSTOOLS_CRAWLER" | "MICROSOFT_PREVIEW" | "MICROSOFT_RESEARCH_CRAWLER" | "MIGNIFY_CRAWLER" | "MIGNIFY_IMRBOT" | "MINIFLUX_FEEDFETCHER" | "MIXNODE_CACHE" | "MOAT_CRAWLER" | "MOJEEK_CRAWLER" | "MONITORBACKLINKS_CRAWLER" | "MONSIDO_CRAWLER" | "MOODLE_CRAWLER" | "MOREOVER_CRAWLER" | "MOZ_CRAWLER" | "MOZ_SITE_AUDIT" | "MSN_CRAWLER" | "MUCKRACK_CRAWLER" | "MULTIVIEWBOT" | "NAGIOS_CHECK_HTTP" | "NAVER_CRAWLER" | "NAVER_CRAWLER_RSS" | "NEEVA_CRAWLER" | "NERDBYNATURE_CRAWLER" | "NERDYBOT_CRAWLER" | "NETCRAFT_CRAWLER" | "NETESTATE_CRAWLER" | "NETICLE_CRAWLER" | "NETSYSTEMSRESEARCH_CRAWLER" | "NETVIBES_CRAWLER" | "NEWSBLUR_AGGREGATOR" | "NEWSHARECOUNTS_CRAWLER" | "NEWSPAPER" | "NEXTCLOUD_CRAWLER" | "NICECRAWLER_ARCHIVE" | "NICT_CRAWLER" | "NIKI_BOT" | "NING_CRAWLER" | "NINJABOT" | "NIXSTATS_CRAWLER" | "NMAP" | "NTENT_CRAWLER" | "NUTCH" | "NUZZEL_CRAWLER" | "OCARINABOT" | "OKRU_CRAWLER" | "OMGILI_CRAWLER" | "OPENAI_CRAWLER" | "OPENAI_CRAWLER_SEARCH" | "OPENAI_CRAWLER_USER" | "OPENGRAPHCHECK_CRAWLER" | "OPENHOSE_CRAWLER" | "OPENINDEX_CRAWLER" | "ORANGE_CRAWLER" | "ORANGE_FTGROUP_CRAWLER" | "OUTBRAIN_LINK_CHECKER" | "OUTCLICKS_CRAWLER" | "PAGE_TO_RSS" | "PAGEPEEKER_CRAWLER" | "PAGETHING_CRAWLER" | "PALOALTONETWORKS_CRAWLER" | "PANSCIENT_CRAWLER" | "PAPERLI_CRAWLER" | "PERL_LIBWWW" | "PERL_PCORE" | "PERPLEXITY_CRAWLER" | "PETALSEARCH_CRAWLER" | "PHP_CURLCLASS" | "PHP_PHPCRAWL" | "PHP_SIMPLE_SCRAPER" | "PHP_SIMPLEPIE" | "PHXBOT" | "PICSEARCH_CRAWLER" | "PINGDOM_CRAWLER" | "PINTREST_CRAWLER" | "PIPL_CRAWLER" | "POCKET_CRAWLER" | "POSTMAN" | "POSTRANK_CRAWLER" | "PRCY_CRAWLER" | "PRIMAL_CRAWLER" | "PRIVACORE_CRAWLER" | "PRIVACYAWARE_CRAWLER" | "PROFOUND_CRAWLER" | "PROXIMIC_CRAWLER" | "PULSEPOINT_CRAWLER" | "PURE_CRAWLER" | "PYTHON_AIOHTTP" | "PYTHON_BITBOT" | "PYTHON_HTTPX" | "PYTHON_OPENGRAPH" | "PYTHON_REQUESTS" | "PYTHON_SCRAPY" | "PYTHON_URLLIB" | "QWANT_CRAWLER" | "RANKACTIVE_CRAWLER" | "REDDIT_CRAWLER" | "REFIND_CRAWLER" | "RETREVO_PAGE_ANALYZER" | "RIDDER_CRAWLER" | "RIVVA_CRAWLER" | "RSSBOT_FEEDFETCHER" | "RSSING_CRAWLER" | "RSSMICRO_FEEDFETCHER" | "RUBY_METAINSPECTOR" | "RYTE_CRAWLER" | "SAFEDNS_CRAWLER" | "SCAN_INTERFAX_CRAWLER" | "SCHMORP_CRAWLER" | "SCOUTJET_CRAWLER" | "SCREAMINGFROG_CRAWLER" | "SCRIBD_CRAWLER" | "SCRITCH_CRAWLER" | "SEARCHATLAS_CRAWLER" | "SEEKBOT_CRAWLER" | "SEEKPORT_CRAWLER" | "SEEWITHKIDS_CRAWLER" | "SEMANTICAUDIENCE_CRAWLER" | "SEMANTICSCHOLAR_CRAWLER" | "SEMPITECH_CRAWLER" | "SEMRUSH_CRAWLER" | "SENTIONE_CRAWLER" | "SENTRY_CRAWLER" | "SENUTO_CRAWLER" | "SEOBILITY_CRAWLER" | "SEOKICKS_CRAWLER" | "SEOLIZER_CRAWLER" | "SEOPROFILER_CRAWLER" | "SEOSCANNERS_CRAWLER" | "SEOSTAR_CRAWLER" | "SEOZOOM_CRAWLER" | "SERENDEPUTY_CRAWLER" | "SERPSTATBOT_CRAWLER" | "SEZNAM_CRAWLER" | "SIMILARTECH_CRAWLER" | "SIMPLE_CRAWLER" | "SISTRIX_007AC9_CRAWLER" | "SISTRIX_CRAWLER" | "SITEBOT_CRAWLER" | "SITECHECKER_CRAWLER" | "SITEEXPLORER_CRAWLER" | "SITEIMPROVE_CRAWLER" | "SKYPE_PREVIEW" | "SLACK_CRAWLER" | "SLACK_IMAGE_PROXY" | "SNAP_PREVIEW" | "SOCIALRANK_CRAWLER" | "SOFTBYTELABS_CRAWLER" | "SOGOU_CRAWLER" | "STARTME_CRAWLER" | "STEAM_PREVIEW" | "STORYGIZE_CRAWLER" | "STRACT_CRAWLER" | "STRIPE_WEBHOOK" | "STUTTGART_CRAWLER" | "SUMMALY_CRAWLER" | "SUMMIFY_CRAWLER" | "SUPERFEEDR_CRAWLER" | "SURLY_CRAWLER" | "SWIMGBOT" | "SYNAPSE_CRAWLER" | "SYSOMOS_CRAWLER" | "T3VERSIONS_CRAWLER" | "TABOOLA_CRAWLER" | "TAGOO_CRAWLER" | "TANGIBLEE_CRAWLER" | "TELEGRAM_CRAWLER" | "TESTOMATO_CRAWLER" | "THEOLDREADER_CRAWLER" | "THINKLAB_CRAWLER" | "TIGER_CRAWLER" | "TIKTOK_CRAWLER" | "TIMPI_CRAWLER" | "TINEYE_CRAWLER" | "TISCALI_CRAWLER" | "TOMBASCRAPER_CRAWLER" | "TOPLIST_CRAWLER" | "TORUS_CRAWLER" | "TOUTIAO_CRAWLER" | "TRAACKR_CRAWLER" | "TRACEMYFILE_CRAWLER" | "TRENDICTION_CRAWLER" | "TRENDSMAP_CRAWLER" | "TROVE_CRAWLER" | "TROVIT_CRAWLER" | "TTRSS_FEEDFETCHER" | "TURNITIN_CRAWLER" | "TWEETEDTIMES_CRAWLER" | "TWEETMEMEBOT" | "TWENGA_CRAWLER" | "TWINGLY_CRAWLER" | "TWITTER_CRAWLER" | "TWOIP_CRAWLER" | "TWOIP_CRAWLER_CMS" | "TWURLY_CRAWLER" | "UBERMETRICS_CRAWLER" | "UBT_CRAWLER" | "UPFLOW_CRAWLER" | "UPTIME_MONITOR" | "UPTIMEBOT_MONITOR" | "UPTIMEROBOT_MONITOR" | "URLCLASSIFICATION_CRAWLER" | "USINE_NOUVELLE_CRAWLER" | "UTEXAS_CRAWLER" | "UTORRENT_CRAWLER" | "VEBIDOO_CRAWLER" | "VELEN_CRAWLER" | "VEOOZ_CRAWLER" | "VERCEL_CRAWLER" | "VERCEL_MONITOR_PREVIEW" | "VERISIGN_IPS_AGENT" | "VIBER_CRAWLER" | "VIGIL_CRAWLER" | "VIPNYTT_CRAWLER" | "VIRUSTOTAL_CRAWLER" | "VKROBOT_CRAWLER" | "VKSHARE_CRAWLER" | "VUHUV_CRAWLER" | "W3C_VALIDATOR_CSS" | "W3C_VALIDATOR_FEED" | "W3C_VALIDATOR_HTML" | "W3C_VALIDATOR_HTML_NU" | "W3C_VALIDATOR_I18N" | "W3C_VALIDATOR_LINKS" | "W3C_VALIDATOR_MOBILE" | "W3C_VALIDATOR_UNIFIED" | "WAREBAY_CRAWLER" | "WEBARCHIVE_CRAWLER" | "WEBCEO_CRAWLER" | "WEBCOMPANY_CRAWLER" | "WEBDATASTATS_CRAWLER" | "WEBEAVER_CRAWLER" | "WEBMEUP_CRAWLER" | "WEBMON" | "WEBPAGETEST_CRAWLER" | "WEBZIO_CRAWLER" | "WEBZIO_CRAWLER_AI" | "WELLKNOWN_CRAWLER" | "WESEE_CRAWLER" | "WGET" | "WHATSAPP_CRAWLER" | "WOCODI_CRAWLER" | "WOORANK_CRAWLER" | "WOORANK_CRAWLER_REVIEW" | "WORDPRESS_CRAWLER" | "WORDPRESS_CRAWLER_RSS" | "WORDUP_CRAWLER" | "WORIO_CRAWLER" | "WOTBOX_CRAWLER" | "XENU_CRAWLER" | "XOVIBOT_CRAWLER" | "YACY_CRAWLER" | "YAHOO_CRAWLER" | "YAHOO_CRAWLER_JAPAN" | "YAHOO_PREVIEW" | "YAMANALAB_CRAWLER" | "YANDEX_CRAWLER" | "YANDEX_CRAWLER_JAVASCRIPT" | "YANGA_CRAWLER" | "YELLOWBP_CRAWLER" | "YISOU_CRAWLER" | "YOOZ_CRAWLER" | "YOU_CRAWLER" | "ZABBIX_MONITOR" | "ZGRAB" | "ZOOMINFO_CRAWLER" | "ZUM_CRAWLER" | "ZUPERLIST_CRAWLER";
+export type BotCategory = "CATEGORY:ACADEMIC" | "CATEGORY:ADVERTISING" | "CATEGORY:AI" | "CATEGORY:AMAZON" | "CATEGORY:APPLE" | "CATEGORY:ARCHIVE" | "CATEGORY:FEEDFETCHER" | "CATEGORY:GOOGLE" | "CATEGORY:META" | "CATEGORY:MICROSOFT" | "CATEGORY:MONITOR" | "CATEGORY:OPTIMIZER" | "CATEGORY:PREVIEW" | "CATEGORY:PROGRAMMATIC" | "CATEGORY:SEARCH_ENGINE" | "CATEGORY:SLACK" | "CATEGORY:SOCIAL" | "CATEGORY:TOOL" | "CATEGORY:UNKNOWN" | "CATEGORY:VERCEL" | "CATEGORY:WEBHOOK" | "CATEGORY:YAHOO" | "CATEGORY:CYBERSECURITY";
+export declare const categories: Record<BotCategory, readonly WellKnownBot[]>;
+export type WellKnownBotOrCategory = WellKnownBot | BotCategory;

package/dist/types/utils/basics.d.ts

@@ -0,0 +1,2 @@
+export declare const customError: (code: number, message: string) => Error;
+export declare const validBaseURL: (baseUrl: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dymo-api",
-  "version": "1.2.05",
+  "version": "1.2.7",
   "description": "Flow system for Dymo API.",
   "main": "dist/cjs/dymo-api.js",
   "module": "dist/esm/dymo-api.js",
@@ -23,11 +23,14 @@
     "LICENSE"
   ],
   "scripts": {
-    "build": "rimraf dist && tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && node ./scripts/rename.js",
+    "clean": "rimraf dist",
+    "build:cjs": "tsc -p tsconfig.cjs.json && tsc-alias -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json && tsc-alias -p tsconfig.esm.json",
+    "build": "npm run clean && npm run build:cjs && npm run build:esm && node ./scripts/rename.js",
     "start": "ts-node src/dymo-api.ts",
-    "prepublishOnly": "npm run test && npm run build",
-    "test": "jest --max-old-space-size=4096",
-    "test:watch": "jest --watch --max-old-space-size=4096"
+    "prepublishOnly": "npm run build",
+    "test": "jest --runInBand --max-old-space-size=4096",
+    "test:watch": "jest --runInBand --watch --max-old-space-size=4096"
   },
   "repository": {
     "url": "https://github.com/TPEOficial/dymo-api-node"
@@ -64,6 +67,11 @@
     "rimraf": "^6.0.1",
     "ts-jest": "^29.4.4",
     "ts-node": "^10.9.2",
+    "tsc-alias": "^1.8.16",
     "typescript": "^5.5.4"
+  },
+  "prettier": {
+    "tabWidth": 4,
+    "useTabs": false
   }
 }