@vigneshreddy/cms-sdk 1.0.15 → 1.0.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vigneshreddy/cms-sdk",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "description": "Official TypeScript SDK for CutMeShort CMS API",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",

package/dist/src/circuit-breaker.d.ts

@@ -1,97 +0,0 @@
-/**
- * Circuit breaker to prevent cascading failures
- * Fails fast when backend is unhealthy
- */
-export declare enum CircuitBreakerState {
-    CLOSED = "CLOSED",// Normal operation
-    OPEN = "OPEN",// Failing fast
-    HALF_OPEN = "HALF_OPEN"
-}
-export interface CircuitBreakerOptions {
-    /** Number of failures before opening circuit */
-    failureThreshold: number;
-    /** Time window to count failures (milliseconds) */
-    failureWindowMs: number;
-    /** Time to wait before attempting to recover (milliseconds) */
-    resetTimeoutMs: number;
-    /** Callback when state changes */
-    onStateChange?: (newState: CircuitBreakerState, reason?: string) => void;
-}
-export declare class CircuitBreaker {
-    private state;
-    private failureCount;
-    private failureTimestamps;
-    private lastFailureTime;
-    private nextAttemptTime;
-    private failureThreshold;
-    private failureWindowMs;
-    private resetTimeoutMs;
-    private onStateChange?;
-    constructor(options: CircuitBreakerOptions);
-    /**
-     * Check if a request should be allowed
-     */
-    canAttempt(): boolean;
-    /**
-     * Record a successful request
-     */
-    recordSuccess(): void;
-    /**
-     * Record a failed request
-     */
-    recordFailure(): void;
-    /**
-     * Get current state
-     */
-    getState(): CircuitBreakerState;
-    /**
-     * Get number of recent failures
-     */
-    getFailureCount(): number;
-    /**
-     * Get milliseconds until circuit attempts to recover
-     */
-    getRecoveryTime(): number;
-    /**
-     * Manually reset the circuit breaker
-     */
-    reset(): void;
-    private setState;
-}
-/**
- * Pre-configured circuit breaker settings for common scenarios
- */
-export declare const CIRCUIT_BREAKER_PRESETS: {
-    /**
-     * Strict: Open after 2 failures in 10 seconds, wait 30 seconds before retry
-     */
-    readonly STRICT: {
-        readonly failureThreshold: 2;
-        readonly failureWindowMs: 10000;
-        readonly resetTimeoutMs: 30000;
-    };
-    /**
-     * Standard: Open after 5 failures in 30 seconds, wait 60 seconds before retry
-     */
-    readonly STANDARD: {
-        readonly failureThreshold: 5;
-        readonly failureWindowMs: 30000;
-        readonly resetTimeoutMs: 60000;
-    };
-    /**
-     * Lenient: Open after 10 failures in 60 seconds, wait 120 seconds before retry
-     */
-    readonly LENIENT: {
-        readonly failureThreshold: 10;
-        readonly failureWindowMs: 60000;
-        readonly resetTimeoutMs: 120000;
-    };
-    /**
-     * Disabled: Circuit breaker always allows attempts
-     */
-    readonly DISABLED: {
-        readonly failureThreshold: number;
-        readonly failureWindowMs: number;
-        readonly resetTimeoutMs: 0;
-    };
-};

package/dist/src/circuit-breaker.js

@@ -1,162 +0,0 @@
-"use strict";
-/**
- * Circuit breaker to prevent cascading failures
- * Fails fast when backend is unhealthy
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CIRCUIT_BREAKER_PRESETS = exports.CircuitBreaker = exports.CircuitBreakerState = void 0;
-var CircuitBreakerState;
-(function (CircuitBreakerState) {
-    CircuitBreakerState["CLOSED"] = "CLOSED";
-    CircuitBreakerState["OPEN"] = "OPEN";
-    CircuitBreakerState["HALF_OPEN"] = "HALF_OPEN";
-})(CircuitBreakerState || (exports.CircuitBreakerState = CircuitBreakerState = {}));
-class CircuitBreaker {
-    constructor(options) {
-        this.state = CircuitBreakerState.CLOSED;
-        this.failureCount = 0;
-        this.failureTimestamps = [];
-        this.lastFailureTime = 0;
-        this.nextAttemptTime = 0;
-        this.failureThreshold = options.failureThreshold;
-        this.failureWindowMs = options.failureWindowMs;
-        this.resetTimeoutMs = options.resetTimeoutMs;
-        this.onStateChange = options.onStateChange;
-    }
-    /**
-     * Check if a request should be allowed
-     */
-    canAttempt() {
-        if (this.state === CircuitBreakerState.CLOSED) {
-            return true;
-        }
-        if (this.state === CircuitBreakerState.OPEN) {
-            const now = Date.now();
-            if (now >= this.nextAttemptTime) {
-                // Try to recover
-                this.setState(CircuitBreakerState.HALF_OPEN, "Attempting recovery");
-                return true;
-            }
-            return false;
-        }
-        // HALF_OPEN - allow attempt
-        return true;
-    }
-    /**
-     * Record a successful request
-     */
-    recordSuccess() {
-        if (this.state === CircuitBreakerState.HALF_OPEN) {
-            this.setState(CircuitBreakerState.CLOSED, "Recovered successfully");
-        }
-        // Clear failure history on success
-        if (this.state === CircuitBreakerState.CLOSED) {
-            this.failureCount = 0;
-            this.failureTimestamps = [];
-        }
-    }
-    /**
-     * Record a failed request
-     */
-    recordFailure() {
-        const now = Date.now();
-        this.lastFailureTime = now;
-        // Remove old failures outside the window
-        this.failureTimestamps = this.failureTimestamps.filter((timestamp) => now - timestamp < this.failureWindowMs);
-        // Add new failure
-        this.failureTimestamps.push(now);
-        this.failureCount = this.failureTimestamps.length;
-        if (this.state === CircuitBreakerState.HALF_OPEN) {
-            // Failed during recovery attempt
-            this.setState(CircuitBreakerState.OPEN, "Recovery attempt failed");
-            this.nextAttemptTime = now + this.resetTimeoutMs;
-        }
-        else if (this.state === CircuitBreakerState.CLOSED) {
-            // Check if threshold exceeded
-            if (this.failureCount >= this.failureThreshold) {
-                this.setState(CircuitBreakerState.OPEN, `${this.failureCount} failures in ${this.failureWindowMs}ms`);
-                this.nextAttemptTime = now + this.resetTimeoutMs;
-            }
-        }
-    }
-    /**
-     * Get current state
-     */
-    getState() {
-        return this.state;
-    }
-    /**
-     * Get number of recent failures
-     */
-    getFailureCount() {
-        // Clean up old failures
-        const now = Date.now();
-        this.failureTimestamps = this.failureTimestamps.filter((timestamp) => now - timestamp < this.failureWindowMs);
-        return this.failureTimestamps.length;
-    }
-    /**
-     * Get milliseconds until circuit attempts to recover
-     */
-    getRecoveryTime() {
-        if (this.state !== CircuitBreakerState.OPEN) {
-            return 0;
-        }
-        return Math.max(0, this.nextAttemptTime - Date.now());
-    }
-    /**
-     * Manually reset the circuit breaker
-     */
-    reset() {
-        this.setState(CircuitBreakerState.CLOSED, "Manual reset");
-        this.failureCount = 0;
-        this.failureTimestamps = [];
-        this.lastFailureTime = 0;
-        this.nextAttemptTime = 0;
-    }
-    setState(newState, reason) {
-        if (this.state !== newState) {
-            this.state = newState;
-            if (this.onStateChange) {
-                this.onStateChange(newState, reason);
-            }
-        }
-    }
-}
-exports.CircuitBreaker = CircuitBreaker;
-/**
- * Pre-configured circuit breaker settings for common scenarios
- */
-exports.CIRCUIT_BREAKER_PRESETS = {
-    /**
-     * Strict: Open after 2 failures in 10 seconds, wait 30 seconds before retry
-     */
-    STRICT: {
-        failureThreshold: 2,
-        failureWindowMs: 10000,
-        resetTimeoutMs: 30000,
-    },
-    /**
-     * Standard: Open after 5 failures in 30 seconds, wait 60 seconds before retry
-     */
-    STANDARD: {
-        failureThreshold: 5,
-        failureWindowMs: 30000,
-        resetTimeoutMs: 60000,
-    },
-    /**
-     * Lenient: Open after 10 failures in 60 seconds, wait 120 seconds before retry
-     */
-    LENIENT: {
-        failureThreshold: 10,
-        failureWindowMs: 60000,
-        resetTimeoutMs: 120000,
-    },
-    /**
-     * Disabled: Circuit breaker always allows attempts
-     */
-    DISABLED: {
-        failureThreshold: Infinity,
-        failureWindowMs: Infinity,
-        resetTimeoutMs: 0,
-    },
-};

package/dist/src/constants.d.ts

@@ -1,128 +0,0 @@
-/**
- * Centralized constants for the CMS SDK
- * This single source of truth makes it easy to adjust configuration without updating multiple files
- */
-export declare const SDK_VERSION = "1.0.14";
-export declare const API_CONFIG: {
-    /** Default base URL for the CMS API */
-    readonly BASE_URL: "https://www.cutmeshort.com";
-    /** Default timeout in milliseconds for HTTP requests */
-    readonly TIMEOUT_MS: 10000;
-};
-export declare const RETRY_CONFIG: {
-    /** Default maximum number of retry attempts for transient failures */
-    readonly MAX_RETRIES: 2;
-    /** Default base delay (in ms) between retries for transient failures */
-    readonly DELAY_MS: 500;
-    /** Default maximum delay cap (in ms) for retry backoff */
-    readonly MAX_DELAY_MS: 10000;
-    /** HTTP status codes that should be retried by default */
-    readonly ON_STATUSES: readonly [429, 500, 502, 503, 504];
-    /** Whether to retry on network errors (no response / timeout) by default */
-    readonly ON_NETWORK_ERROR: true;
-};
-export declare const VALIDATION_CONSTRAINTS: {
-    readonly API_KEY: {
-        /** Regex pattern for valid API keys: must be 20+ alphanumeric chars */
-        readonly PATTERN: RegExp;
-    };
-    readonly TIMEOUT: {
-        readonly MIN_MS: 1000;
-        readonly MAX_MS: 60000;
-    };
-    readonly MAX_RETRIES: {
-        readonly MIN: 0;
-        readonly MAX: 10;
-    };
-    readonly RETRY_DELAY: {
-        readonly MIN_MS: 100;
-        readonly MAX_MS: 30000;
-    };
-    readonly RETRY_MAX_DELAY: {
-        readonly MIN_MS: 1000;
-        readonly MAX_MS: 120000;
-    };
-    readonly STRING_FIELDS: {
-        readonly CLICK_ID: {
-            readonly MIN: 1;
-            readonly MAX: 255;
-        };
-        readonly CUSTOMER_ID: {
-            readonly MIN: 1;
-            readonly MAX: 255;
-        };
-        readonly CUSTOMER_EXTERNAL_ID: {
-            readonly MIN: 1;
-            readonly MAX: 255;
-        };
-        readonly CUSTOMER_NAME: {
-            readonly MAX: 255;
-        };
-        readonly CUSTOMER_EMAIL: {
-            readonly MAX: 255;
-        };
-        readonly EVENT_NAME: {
-            readonly MIN: 1;
-            readonly MAX: 255;
-        };
-        readonly INVOICE_ID: {
-            readonly MIN: 1;
-            readonly MAX: 255;
-        };
-    };
-    readonly CURRENCY: {
-        readonly LENGTH: 3;
-        readonly PATTERN: RegExp;
-    };
-    readonly AMOUNT: {
-        readonly MIN: 0;
-    };
-};
-export declare const ERROR_MESSAGES: {
-    readonly API_KEY_REQUIRED: "apiKey is required";
-    readonly API_KEY_INVALID_FORMAT: "apiKey must be a valid API key format";
-    readonly BASE_URL_INVALID: "baseUrl must be a valid absolute URL";
-    readonly TIMEOUT_TOO_LOW: "timeout must be at least 1000ms";
-    readonly TIMEOUT_TOO_HIGH: "timeout must not exceed 60000ms";
-    readonly MAX_RETRIES_NEGATIVE: "maxRetries must be non-negative";
-    readonly MAX_RETRIES_TOO_HIGH: "maxRetries must not exceed 10";
-    readonly RETRY_DELAY_TOO_LOW: "retryDelayMs must be at least 100ms";
-    readonly RETRY_DELAY_TOO_HIGH: "retryDelayMs must not exceed 30000ms";
-    readonly RETRY_MAX_DELAY_TOO_LOW: "retryMaxDelayMs must be at least 1000ms";
-    readonly RETRY_MAX_DELAY_TOO_HIGH: "retryMaxDelayMs must not exceed 120000ms";
-    readonly EVENT_NAME_REQUIRED: "eventName is required";
-    readonly EVENT_NAME_TOO_LONG: "eventName must not exceed 255 characters";
-    readonly CUSTOMER_ID_REQUIRED: "customerId is required";
-    readonly CUSTOMER_ID_TOO_LONG: "customerId must not exceed 255 characters";
-    readonly CUSTOMER_EXTERNAL_ID_REQUIRED: "customerExternalId is required";
-    readonly CUSTOMER_EXTERNAL_ID_TOO_LONG: "customerExternalId must not exceed 255 characters";
-    readonly CUSTOMER_EMAIL_INVALID: "customerEmail must be a valid email";
-    readonly CUSTOMER_EMAIL_TOO_LONG: "customerEmail must not exceed 255 characters";
-    readonly CUSTOMER_AVATAR_INVALID: "customerAvatar must be a valid URL";
-    readonly INVOICE_ID_REQUIRED: "invoiceId is required";
-    readonly INVOICE_ID_TOO_LONG: "invoiceId must not exceed 255 characters";
-    readonly AMOUNT_NEGATIVE: "amount must be non-negative";
-    readonly CURRENCY_INVALID_LENGTH: "currency must be 3-letter code (e.g., USD)";
-    readonly CURRENCY_INVALID_FORMAT: "currency must be uppercase ISO 4217 code";
-    readonly CURRENCY_OPTIONAL_IN_SALE: "currency is optional in sale tracking";
-};
-export declare const HTTP_HEADERS: {
-    /** Content type for all API requests */
-    readonly CONTENT_TYPE: "application/json";
-    /** SDK version header key */
-    readonly SDK_VERSION_HEADER: "X-CMS-SDK-Version";
-    /** SDK runtime detection header key */
-    readonly SDK_RUNTIME_HEADER: "X-CMS-SDK-Runtime";
-    /** SDK runtime value for Node.js */
-    readonly RUNTIME_NODEJS: "nodejs";
-    /** SDK runtime value for browser */
-    readonly RUNTIME_BROWSER: "browser";
-};
-export declare const SENSITIVE_FIELDS: {
-    /** List of field names that should be redacted in logs */
-    readonly PATTERNS: readonly ["apiKey", "accessToken", "token", "password", "secret", "authorization", "x-api-key"];
-    /** Redaction placeholder */
-    readonly REDACTION_PLACEHOLDER: "[REDACTED]";
-    /** API key redaction placeholder */
-    readonly API_KEY_REDACTION: "[REDACTED_API_KEY]";
-};

package/dist/src/constants.js

@@ -1,182 +0,0 @@
-"use strict";
-/**
- * Centralized constants for the CMS SDK
- * This single source of truth makes it easy to adjust configuration without updating multiple files
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SENSITIVE_FIELDS = exports.HTTP_HEADERS = exports.ERROR_MESSAGES = exports.VALIDATION_CONSTRAINTS = exports.RETRY_CONFIG = exports.API_CONFIG = exports.SDK_VERSION = void 0;
-// ============================================================================
-// SDK VERSION
-// ============================================================================
-exports.SDK_VERSION = "1.0.14";
-// ============================================================================
-// API CONFIGURATION
-// ============================================================================
-exports.API_CONFIG = {
-    /** Default base URL for the CMS API */
-    BASE_URL: "https://www.cutmeshort.com",
-    /** Default timeout in milliseconds for HTTP requests */
-    TIMEOUT_MS: 10000,
-};
-// ============================================================================
-// RETRY CONFIGURATION
-// ============================================================================
-exports.RETRY_CONFIG = {
-    /** Default maximum number of retry attempts for transient failures */
-    MAX_RETRIES: 2,
-    /** Default base delay (in ms) between retries for transient failures */
-    DELAY_MS: 500,
-    /** Default maximum delay cap (in ms) for retry backoff */
-    MAX_DELAY_MS: 10000,
-    /** HTTP status codes that should be retried by default */
-    ON_STATUSES: [429, 500, 502, 503, 504],
-    /** Whether to retry on network errors (no response / timeout) by default */
-    ON_NETWORK_ERROR: true,
-};
-// ============================================================================
-// VALIDATION CONSTRAINTS
-// ============================================================================
-exports.VALIDATION_CONSTRAINTS = {
-    // API Key validation
-    API_KEY: {
-        /** Regex pattern for valid API keys: must be 20+ alphanumeric chars */
-        PATTERN: /^[a-zA-Z0-9_]{20,}$/,
-    },
-    // Timeout constraints
-    TIMEOUT: {
-        MIN_MS: 1000,
-        MAX_MS: 60000,
-    },
-    // Max retries constraints
-    MAX_RETRIES: {
-        MIN: 0,
-        MAX: 10,
-    },
-    // Retry delay constraints
-    RETRY_DELAY: {
-        MIN_MS: 100,
-        MAX_MS: 30000,
-    },
-    // Retry max delay constraints
-    RETRY_MAX_DELAY: {
-        MIN_MS: 1000,
-        MAX_MS: 120000,
-    },
-    // String field constraints
-    STRING_FIELDS: {
-        CLICK_ID: {
-            MIN: 1,
-            MAX: 255,
-        },
-        CUSTOMER_ID: {
-            MIN: 1,
-            MAX: 255,
-        },
-        CUSTOMER_EXTERNAL_ID: {
-            MIN: 1,
-            MAX: 255,
-        },
-        CUSTOMER_NAME: {
-            MAX: 255,
-        },
-        CUSTOMER_EMAIL: {
-            MAX: 255,
-        },
-        EVENT_NAME: {
-            MIN: 1,
-            MAX: 255,
-        },
-        INVOICE_ID: {
-            MIN: 1,
-            MAX: 255,
-        },
-    },
-    // Currency code constraints (ISO 4217)
-    CURRENCY: {
-        LENGTH: 3,
-        PATTERN: /^[A-Z]{3}$/,
-    },
-    // Amount constraints
-    AMOUNT: {
-        MIN: 0,
-    },
-};
-// ============================================================================
-// ERROR HANDLING
-// ============================================================================
-exports.ERROR_MESSAGES = {
-    // API Key errors
-    API_KEY_REQUIRED: "apiKey is required",
-    API_KEY_INVALID_FORMAT: "apiKey must be a valid API key format",
-    // Base URL errors
-    BASE_URL_INVALID: "baseUrl must be a valid absolute URL",
-    // Timeout errors
-    TIMEOUT_TOO_LOW: `timeout must be at least ${exports.VALIDATION_CONSTRAINTS.TIMEOUT.MIN_MS}ms`,
-    TIMEOUT_TOO_HIGH: `timeout must not exceed ${exports.VALIDATION_CONSTRAINTS.TIMEOUT.MAX_MS}ms`,
-    // Max retries errors
-    MAX_RETRIES_NEGATIVE: "maxRetries must be non-negative",
-    MAX_RETRIES_TOO_HIGH: `maxRetries must not exceed ${exports.VALIDATION_CONSTRAINTS.MAX_RETRIES.MAX}`,
-    // Retry delay errors
-    RETRY_DELAY_TOO_LOW: `retryDelayMs must be at least ${exports.VALIDATION_CONSTRAINTS.RETRY_DELAY.MIN_MS}ms`,
-    RETRY_DELAY_TOO_HIGH: `retryDelayMs must not exceed ${exports.VALIDATION_CONSTRAINTS.RETRY_DELAY.MAX_MS}ms`,
-    // Retry max delay errors
-    RETRY_MAX_DELAY_TOO_LOW: `retryMaxDelayMs must be at least ${exports.VALIDATION_CONSTRAINTS.RETRY_MAX_DELAY.MIN_MS}ms`,
-    RETRY_MAX_DELAY_TOO_HIGH: `retryMaxDelayMs must not exceed ${exports.VALIDATION_CONSTRAINTS.RETRY_MAX_DELAY.MAX_MS}ms`,
-    // Event name errors
-    EVENT_NAME_REQUIRED: "eventName is required",
-    EVENT_NAME_TOO_LONG: `eventName must not exceed ${exports.VALIDATION_CONSTRAINTS.STRING_FIELDS.EVENT_NAME.MAX} characters`,
-    // Customer ID errors
-    CUSTOMER_ID_REQUIRED: "customerId is required",
-    CUSTOMER_ID_TOO_LONG: `customerId must not exceed ${exports.VALIDATION_CONSTRAINTS.STRING_FIELDS.CUSTOMER_ID.MAX} characters`,
-    // Customer external ID errors
-    CUSTOMER_EXTERNAL_ID_REQUIRED: "customerExternalId is required",
-    CUSTOMER_EXTERNAL_ID_TOO_LONG: `customerExternalId must not exceed ${exports.VALIDATION_CONSTRAINTS.STRING_FIELDS.CUSTOMER_EXTERNAL_ID.MAX} characters`,
-    // Email errors
-    CUSTOMER_EMAIL_INVALID: "customerEmail must be a valid email",
-    CUSTOMER_EMAIL_TOO_LONG: `customerEmail must not exceed ${exports.VALIDATION_CONSTRAINTS.STRING_FIELDS.CUSTOMER_EMAIL.MAX} characters`,
-    // Avatar errors
-    CUSTOMER_AVATAR_INVALID: "customerAvatar must be a valid URL",
-    // Invoice ID errors
-    INVOICE_ID_REQUIRED: "invoiceId is required",
-    INVOICE_ID_TOO_LONG: `invoiceId must not exceed ${exports.VALIDATION_CONSTRAINTS.STRING_FIELDS.INVOICE_ID.MAX} characters`,
-    // Amount errors
-    AMOUNT_NEGATIVE: "amount must be non-negative",
-    // Currency errors
-    CURRENCY_INVALID_LENGTH: `currency must be ${exports.VALIDATION_CONSTRAINTS.CURRENCY.LENGTH}-letter code (e.g., USD)`,
-    CURRENCY_INVALID_FORMAT: "currency must be uppercase ISO 4217 code",
-    CURRENCY_OPTIONAL_IN_SALE: "currency is optional in sale tracking",
-};
-// ============================================================================
-// HTTP HEADERS
-// ============================================================================
-exports.HTTP_HEADERS = {
-    /** Content type for all API requests */
-    CONTENT_TYPE: "application/json",
-    /** SDK version header key */
-    SDK_VERSION_HEADER: "X-CMS-SDK-Version",
-    /** SDK runtime detection header key */
-    SDK_RUNTIME_HEADER: "X-CMS-SDK-Runtime",
-    /** SDK runtime value for Node.js */
-    RUNTIME_NODEJS: "nodejs",
-    /** SDK runtime value for browser */
-    RUNTIME_BROWSER: "browser",
-};
-// ============================================================================
-// SENSITIVE FIELD PATTERNS
-// ============================================================================
-exports.SENSITIVE_FIELDS = {
-    /** List of field names that should be redacted in logs */
-    PATTERNS: [
-        "apiKey",
-        "accessToken",
-        "token",
-        "password",
-        "secret",
-        "authorization",
-        "x-api-key",
-    ],
-    /** Redaction placeholder */
-    REDACTION_PLACEHOLDER: "[REDACTED]",
-    /** API key redaction placeholder */
-    API_KEY_REDACTION: "[REDACTED_API_KEY]",
-};