dymo-api 1.2.30 → 1.2.32

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

@@ -6,30 +6,35 @@ declare class DymoAPI {
     private rules;
     private baseUrl;
     private axiosClient;
+    private resilienceManager;
     /**
-     * @param {Object} options - Options to create the DymoAPI instance.
-     * @param {string} [options.rootApiKey] - The root API key.
-     * @param {string} [options.apiKey] - The API key.
-     * @param {string} [options.baseUrl] - Whether to use a local server instead of the cloud server.
-     * @param {Object} [options.serverEmailConfig] - The server email config.
-     * @description
-     * This is the main class to interact with the Dymo API. It should be
-     * instantiated with the root API key and the API key. The root API key is
-     * used to fetch the tokens and the API key is used to authenticate the
-     * requests.
-     * @example
-     * const dymoApi = new DymoAPI({
-     *     rootApiKey: "6bfb7675-6b69-4f8d-9f43-5a6f7f02c6c5",
-     *     apiKey: "dm_4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5"
-     * });
-     */
-    constructor({ rootApiKey, apiKey, baseUrl, serverEmailConfig, rules }?: {
+         * @param {Object} options - Options to create the DymoAPI instance.
+         * @param {string} [options.rootApiKey] - The root API key.
+         * @param {string} [options.apiKey] - The API key.
+         * @param {string} [options.baseUrl] - Whether to use a local server instead of the cloud server.
+         * @param {Object} [options.serverEmailConfig] - The server email config.
+         * @param {Object} [options.rules] - The rules.
+         * @param {Object} [options.resilience] - The resilience config.
+         * @description
+         * This is the main class to interact with the Dymo API. It should be
+         * instantiated with the root API key and the API key. The root API key is
+         * used to fetch the tokens and the API key is used to authenticate the
+         * requests. Requests are retried once by default with exponential backoff.
+         * @example
+         * const dymoApi = new DymoAPI({
+         *     rootApiKey: "6bfb7675-6b69-4f8d-9f43-5a6f7f02c6c5",
+         *     apiKey: "dm_4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5"
+         * });
+         */
+    constructor({ rootApiKey, apiKey, baseUrl, serverEmailConfig, rules, resilience }?: {
         rootApiKey?: string | null;
         apiKey?: string | null;
         baseUrl?: string;
         serverEmailConfig?: Interfaces.ServerEmailConfig;
         rules?: Interfaces.Rules;
+        resilience?: Interfaces.ResilienceConfig;
     });
+    private getEmailPlugins;
     /**
      * Validates the given data against the configured validation settings.
      *
@@ -281,4 +286,4 @@ declare class DymoAPI {
     isValidPwd(data: Interfaces.IsValidPwdData): Promise<Interfaces.PasswordValidationResult>;
 }
 export default DymoAPI;
-export type { EmailValidatorRules, NegativeEmailRules, DataEmailValidationAnalysis, IPValidatorRules, NegativeIPRules, DataIPValidationAnalysis, PhoneValidatorRules, NegativePhoneRules, DataPhoneValidationAnalysis, WafRules, SensitiveInfoRules } from "./lib/types/interfaces";
+export type { EmailValidatorRules, NegativeEmailRules, DataEmailValidationAnalysis, IPValidatorRules, NegativeIPRules, DataIPValidationAnalysis, PhoneValidatorRules, NegativePhoneRules, DataPhoneValidationAnalysis, WafRules, SensitiveInfoRules, ResilienceConfig } from "./lib/types/interfaces";

package/dist/types/lib/resilience/fallback.d.ts

@@ -0,0 +1,26 @@
+export declare class FallbackDataGenerator {
+    static generateFallbackData<T>(method: string, inputData?: any): T;
+    private static validateURL;
+    private static validateEmail;
+    private static validateDomain;
+    private static validateCreditCard;
+    private static validateIP;
+    private static validatePhone;
+    private static validateWallet;
+    private static validateIBAN;
+    private static extractDomain;
+    private static generateDataValidationAnalysis;
+    private static generateEmailValidatorResponse;
+    private static generateEmailDataAnalysis;
+    private static generateIPValidatorResponse;
+    private static generateIPDataAnalysis;
+    private static generatePhoneValidatorResponse;
+    private static generatePhoneDataAnalysis;
+    private static generateHTTPRequest;
+    private static generateEmailStatus;
+    private static generateSRNSummary;
+    private static generateExtractWithTextly;
+    private static generatePrayerTimes;
+    private static generateSatinizedInputAnalysis;
+    private static generatePasswordValidationResult;
+}

package/dist/types/lib/resilience/index.d.ts

@@ -0,0 +1,13 @@
+import { ResilienceConfig } from "../types/interfaces";
+import { AxiosInstance, AxiosRequestConfig } from "axios";
+export declare class ResilienceManager {
+    private config;
+    private clientId;
+    private rateLimitManager;
+    constructor(config?: ResilienceConfig, clientId?: string);
+    executeWithResilience<T>(axiosClient: AxiosInstance, requestConfig: AxiosRequestConfig, fallbackData?: T): Promise<T>;
+    private shouldRetry;
+    private sleep;
+    getConfig(): Required<ResilienceConfig>;
+    getClientId(): string;
+}

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

@@ -162,6 +162,21 @@ export interface ExtractWithTextly {
         [key: string]: JsonSchemaProperty;
     };
 }
+export interface RateLimitInfo {
+    limit?: number;
+    remaining?: number;
+    resetTime?: string;
+    retryAfter?: number;
+    lastUpdated?: number;
+}
+export interface RateLimitTracker {
+    [clientId: string]: RateLimitInfo;
+}
+export interface ResilienceConfig {
+    fallbackEnabled?: boolean;
+    retryAttempts?: number;
+    retryDelay?: number;
+}
 export * from "./rules";
 export * from "./primitives";
 export * from "./data-verifier";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dymo-api",
-  "version": "1.2.30",
+  "version": "1.2.32",
   "description": "Flow system for Dymo API.",
   "main": "dist/cjs/dymo-api.js",
   "module": "dist/esm/dymo-api.js",
@@ -85,4 +85,4 @@
     "tabWidth": 4,
     "useTabs": false
   }
-}
+}