@sudobility/types 1.9.54 → 1.9.56

package/dist/types/infrastructure/analytics.cjs

@@ -1,212 +0,0 @@
-"use strict";
-/**
- * Analytics types and interfaces
- * Platform-agnostic analytics service interface for dependency injection
- *
- * @ai-context Core analytics interface for dependency injection
- * @ai-pattern Service interface with comprehensive event tracking
- * @ai-platform Cross-platform compatible (Web, React Native, Node.js)
- * @ai-usage Implement this interface to create analytics services for Firebase, Mixpanel, etc.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnalyticsEventBuilder = exports.AnalyticsEvent = void 0;
-/**
- * Standardized analytics events enumeration.
- *
- * Provides consistent event naming for common application analytics scenarios.
- * Organized by functional categories for better code organization and analytics reporting.
- *
- * @example
- * ```typescript
- * // Use predefined events for consistency
- * analytics.track(AnalyticsEvent.USER_LOGIN, { method: 'email' });
- * analytics.track(AnalyticsEvent.EMAIL_OPENED, { email_id: 'msg-123' });
- * ```
- */
-var AnalyticsEvent;
-(function (AnalyticsEvent) {
-    /** User successfully logged into the application */
-    AnalyticsEvent["USER_LOGIN"] = "user_login";
-    /** User logged out of the application */
-    AnalyticsEvent["USER_LOGOUT"] = "user_logout";
-    /** New user completed account registration */
-    AnalyticsEvent["USER_SIGNUP"] = "user_signup";
-    /** User sent an email message */
-    AnalyticsEvent["EMAIL_SENT"] = "email_sent";
-    /** User received a new email message */
-    AnalyticsEvent["EMAIL_RECEIVED"] = "email_received";
-    /** User opened an email message (consolidated from EMAIL_OPENED and EMAIL_OPEN) */
-    AnalyticsEvent["EMAIL_OPENED"] = "email_opened";
-    /** User replied to an email message */
-    AnalyticsEvent["EMAIL_REPLY"] = "email_reply";
-    /** User forwarded an email message */
-    AnalyticsEvent["EMAIL_FORWARD"] = "email_forward";
-    /** User deleted an email message */
-    AnalyticsEvent["EMAIL_DELETE"] = "email_delete";
-    /** User starred an email message */
-    AnalyticsEvent["EMAIL_STAR"] = "email_star";
-    /** User composed a new email */
-    AnalyticsEvent["EMAIL_COMPOSE"] = "email_compose";
-    /** User clicked a link within an email */
-    AnalyticsEvent["EMAIL_CLICKED"] = "email_clicked";
-    /** User viewed a web page */
-    AnalyticsEvent["PAGE_VIEW"] = "page_view";
-    /** User viewed a mobile screen */
-    AnalyticsEvent["SCREEN_VIEW"] = "screen_view";
-    /** User switched between folders */
-    AnalyticsEvent["FOLDER_SWITCH"] = "folder_switch";
-    /** User viewed subscription options */
-    AnalyticsEvent["SUBSCRIPTION_VIEW"] = "subscription_view";
-    /** User purchased a subscription */
-    AnalyticsEvent["SUBSCRIPTION_PURCHASE"] = "subscription_purchase";
-    /** User cancelled a subscription */
-    AnalyticsEvent["SUBSCRIPTION_CANCEL"] = "subscription_cancel";
-    /** User performed a search */
-    AnalyticsEvent["SEARCH_PERFORMED"] = "search_performed";
-    /** User changed application settings */
-    AnalyticsEvent["SETTINGS_CHANGED"] = "settings_changed";
-    /** An application error occurred */
-    AnalyticsEvent["ERROR_OCCURRED"] = "error_occurred";
-    /** User viewed an A/B test variant */
-    AnalyticsEvent["AB_TEST_VIEWED"] = "ab_test_viewed";
-    /** User converted on an A/B test */
-    AnalyticsEvent["AB_TEST_CONVERTED"] = "ab_test_converted";
-    /** Custom application-specific event */
-    AnalyticsEvent["CUSTOM_EVENT"] = "custom_event";
-})(AnalyticsEvent || (exports.AnalyticsEvent = AnalyticsEvent = {}));
-/**
- * Utility class for building standardized analytics event properties.
- *
- * Provides static methods to create consistent event property objects
- * for common analytics scenarios. Ensures proper naming conventions
- * and includes standard fields like timestamps.
- *
- * @ai-utility-class Event property builders
- * @ai-pattern Factory pattern for event properties
- * @ai-standardization Ensures consistent event property naming
- *
- * @example
- * ```typescript
- * // Use builders to create standardized event properties
- * const properties = AnalyticsEventBuilder.emailAction('read', 'email-123', 'inbox');
- * analytics.trackEvent(AnalyticsEvent.EMAIL_OPENED, properties);
- * ```
- */
-class AnalyticsEventBuilder {
-    /**
-     * Build properties for email action events.
-     *
-     * @param action Email action performed (read, sent, archived, etc.)
-     * @param emailId Unique identifier for the email
-     * @param folder Email folder context (inbox, sent, trash, etc.)
-     * @returns Standardized event properties object
-     *
-     * @ai-builder Email action properties
-     * @ai-standardization Consistent email event tracking
-     */
-    static emailAction(action, emailId, folder) {
-        return {
-            action,
-            email_id: emailId,
-            folder,
-            timestamp: Date.now(),
-        };
-    }
-    /**
-     * Build properties for page/screen view events.
-     *
-     * @param pageName Human-readable page name
-     * @param pagePath URL path or screen identifier
-     * @returns Standardized page view properties
-     *
-     * @ai-builder Navigation tracking properties
-     * @ai-cross-platform Works for web pages and mobile screens
-     */
-    static pageView(pageName, pagePath) {
-        return {
-            page_name: pageName,
-            page_path: pagePath,
-            timestamp: Date.now(),
-        };
-    }
-    /**
-     * Build properties for error tracking events.
-     *
-     * @param errorType Category of error (network, validation, runtime, etc.)
-     * @param errorMessage Error message or description
-     * @param pageName Page/screen where error occurred
-     * @returns Standardized error event properties
-     *
-     * @ai-builder Error tracking properties
-     * @ai-debugging Consistent error event structure
-     */
-    static error(errorType, errorMessage, pageName) {
-        return {
-            error_type: errorType,
-            error_message: errorMessage,
-            page_name: pageName,
-            timestamp: Date.now(),
-        };
-    }
-    /**
-     * Build properties for subscription/revenue events.
-     *
-     * @param action Subscription action (subscribe, upgrade, cancel, etc.)
-     * @param planType Subscription plan type (free, premium, pro, etc.)
-     * @param amount Monetary amount (for revenue tracking)
-     * @param currency Currency code (USD, EUR, etc.)
-     * @returns Standardized subscription event properties
-     *
-     * @ai-builder Revenue tracking properties
-     * @ai-business-metrics Subscription and revenue analytics
-     */
-    static subscription(action, planType, amount, currency) {
-        return {
-            action,
-            plan_type: planType,
-            amount,
-            currency,
-            timestamp: Date.now(),
-        };
-    }
-    /**
-     * Build properties for user engagement events.
-     *
-     * @param feature Feature name or component identifier
-     * @param interaction Type of interaction (click, scroll, hover, etc.)
-     * @param duration Time spent on interaction (milliseconds)
-     * @returns Standardized engagement event properties
-     *
-     * @ai-builder User engagement properties
-     * @ai-ux-analytics User experience and interaction tracking
-     */
-    static engagement(feature, interaction, duration) {
-        return {
-            feature,
-            interaction,
-            duration,
-            timestamp: Date.now(),
-        };
-    }
-    /**
-     * Build properties for performance monitoring events.
-     *
-     * @param metric Performance metric name (load_time, api_response, etc.)
-     * @param value Metric value (usually in milliseconds)
-     * @param context Additional context about the performance event
-     * @returns Standardized performance event properties
-     *
-     * @ai-builder Performance monitoring properties
-     * @ai-performance Application performance tracking
-     */
-    static performance(metric, value, context) {
-        return {
-            metric,
-            value,
-            context,
-            timestamp: Date.now(),
-        };
-    }
-}
-exports.AnalyticsEventBuilder = AnalyticsEventBuilder;
-//# sourceMappingURL=analytics.js.map

package/dist/types/infrastructure/api.cjs

@@ -1,43 +0,0 @@
-"use strict";
-/**
- * @fileoverview Core API Type Definitions
- * @description Centralized type definitions for API requests/responses and data structures
- * @version 2.0.0
- *
- * This file provides comprehensive type safety for:
- * - API request/response interfaces
- * - Multi-chain data structures
- * - Database entity interfaces
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProcessedEventName = exports.ContractType = exports.ChainType = void 0;
-// Re-export ChainType from business enums
-var enums_1 = require("../business/enums");
-Object.defineProperty(exports, "ChainType", { enumerable: true, get: function () { return enums_1.ChainType; } });
-/**
- * Contract types supported by the indexer
- */
-var ContractType;
-(function (ContractType) {
-    ContractType["Mailer"] = "Mailer";
-    ContractType["MailService"] = "MailService";
-})(ContractType || (exports.ContractType = ContractType = {}));
-/**
- * Event names processed by the indexer
- */
-var ProcessedEventName;
-(function (ProcessedEventName) {
-    ProcessedEventName["MailSent"] = "MailSent";
-    ProcessedEventName["PreparedMailSent"] = "PreparedMailSent";
-    ProcessedEventName["DelegationSet"] = "DelegationSet";
-    ProcessedEventName["DelegationCleared"] = "DelegationCleared";
-    ProcessedEventName["DomainRegistered"] = "DomainRegistered";
-    ProcessedEventName["DomainExtended"] = "DomainExtended";
-    ProcessedEventName["DomainReleased"] = "DomainReleased";
-    ProcessedEventName["FeeUpdated"] = "FeeUpdated";
-    ProcessedEventName["SharesRecorded"] = "SharesRecorded";
-    ProcessedEventName["RecipientClaimed"] = "RecipientClaimed";
-    ProcessedEventName["OwnerClaimed"] = "OwnerClaimed";
-    ProcessedEventName["ExpiredSharesClaimed"] = "ExpiredSharesClaimed";
-})(ProcessedEventName || (exports.ProcessedEventName = ProcessedEventName = {}));
-//# sourceMappingURL=api.js.map

package/dist/types/infrastructure/firebase-user.cjs

@@ -1,10 +0,0 @@
-"use strict";
-/**
- * @fileoverview Firebase user info types shared between frontend and backend.
- *
- * Used by:
- * - @sudobility/auth_service (backend) - getUserInfo helper
- * - @sudobility/auth_lib (frontend) - useSiteAdmin hook
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=firebase-user.js.map

package/dist/types/infrastructure/navigation.cjs

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=navigation.js.map

package/dist/types/infrastructure/network.cjs

@@ -1,18 +0,0 @@
-"use strict";
-/**
- * Network client interface for dependency injection
- * Platform-agnostic HTTP client interface
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NetworkError = void 0;
-class NetworkError extends Error {
-    constructor(message, status, statusText, response) {
-        super(message);
-        this.name = 'NetworkError';
-        this.status = status;
-        this.statusText = statusText;
-        this.response = response;
-    }
-}
-exports.NetworkError = NetworkError;
-//# sourceMappingURL=network.js.map

package/dist/types/infrastructure/wallet.cjs

@@ -1,37 +0,0 @@
-"use strict";
-/**
- * Wallet and blockchain types
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WalletType = void 0;
-/**
- * Cryptocurrency wallet type enumeration.
- *
- * Identifies different wallet providers and connection methods for blockchain interactions.
- * Supports both browser extension wallets and protocol-based connections.
- *
- * @example
- * ```typescript
- * // Wallet-specific connection logic
- * switch (walletType) {
- *   case WalletType.METAMASK:
- *     return connectMetaMask();
- *   case WalletType.WALLETCONNECT:
- *     return connectWalletConnect();
- * }
- * ```
- */
-var WalletType;
-(function (WalletType) {
-    /** MetaMask browser extension wallet */
-    WalletType["METAMASK"] = "metamask";
-    /** Phantom wallet (primarily for Solana) */
-    WalletType["PHANTOM"] = "phantom";
-    /** Coinbase Wallet */
-    WalletType["COINBASE"] = "coinbase";
-    /** WalletConnect protocol for mobile wallets */
-    WalletType["WALLETCONNECT"] = "walletconnect";
-    /** Generic injected wallet provider */
-    WalletType["INJECTED"] = "injected";
-})(WalletType || (exports.WalletType = WalletType = {}));
-//# sourceMappingURL=wallet.js.map

package/dist/types/subscription/entitlements.cjs

@@ -1,14 +0,0 @@
-"use strict";
-/**
- * Subscription Entitlement Constants
- *
- * Shared constants for subscription entitlement management.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NONE_ENTITLEMENT = void 0;
-/**
- * The special entitlement name for users without any subscription.
- * This is returned when a user has no active entitlements in RevenueCat.
- */
-exports.NONE_ENTITLEMENT = "none";
-//# sourceMappingURL=entitlements.js.map

package/dist/types/subscription/period.cjs

@@ -1,29 +0,0 @@
-"use strict";
-/**
- * Subscription Period Types
- *
- * Standard subscription periods and utilities for period comparison.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ALL_PERIODS = exports.PERIOD_RANKS = void 0;
-/**
- * Period ranking for comparison (higher = longer)
- */
-exports.PERIOD_RANKS = {
-    weekly: 1,
-    monthly: 2,
-    quarterly: 3,
-    yearly: 4,
-    lifetime: 5,
-};
-/**
- * All supported periods in order
- */
-exports.ALL_PERIODS = [
-    'weekly',
-    'monthly',
-    'quarterly',
-    'yearly',
-    'lifetime',
-];
-//# sourceMappingURL=period.js.map

package/dist/types/subscription/rate-limits.cjs

@@ -1,20 +0,0 @@
-"use strict";
-/**
- * @fileoverview Rate Limit Type Definitions
- * @description Types for rate limiting endpoints across sudojo_api, shapeshyft_api, and whisperly_api
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RateLimitPeriodType = void 0;
-// ========================================
-// RATE LIMIT HISTORY TYPES
-// ========================================
-/**
- * Valid period types for rate limit history.
- */
-var RateLimitPeriodType;
-(function (RateLimitPeriodType) {
-    RateLimitPeriodType["HOUR"] = "hour";
-    RateLimitPeriodType["DAY"] = "day";
-    RateLimitPeriodType["MONTH"] = "month";
-})(RateLimitPeriodType || (exports.RateLimitPeriodType = RateLimitPeriodType = {}));
-//# sourceMappingURL=rate-limits.js.map

package/dist/utils/async-helpers.cjs

@@ -1,244 +0,0 @@
-"use strict";
-/**
- * Common async operation patterns and helpers.
- * Reduces boilerplate code for common async operations.
- *
- * @since 1.0.0
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.debounceAsync = exports.clearExpiredCache = exports.withCache = exports.withTimeout = exports.safeParallel = exports.withLoadingState = exports.safeAsync = void 0;
-const logger_1 = require("./logging/logger");
-/**
- * Safely execute an async operation with error handling.
- * Returns a result object instead of throwing.
- *
- * @template T - The success data type
- * @param operation - Async function to execute
- * @param context - Optional context string for logging
- * @returns A promise resolving to an {@link AsyncResult}
- * @since 1.0.0
- *
- * @example
- * ```typescript
- * const result = await safeAsync(() => fetchUser(id), 'fetchUser');
- * if (result.success) {
- *   console.log(result.data);
- * } else {
- *   console.error(result.error?.message);
- * }
- * ```
- */
-const safeAsync = async (operation, context) => {
-    try {
-        const data = await operation();
-        return { data, success: true };
-    }
-    catch (error) {
-        const errorObj = error instanceof Error ? error : new Error(String(error));
-        logger_1.logger.error(`Async operation failed: ${errorObj.message}`, context, error);
-        return { error: errorObj, success: false };
-    }
-};
-exports.safeAsync = safeAsync;
-/**
- * Execute async operation with loading state tracking.
- * Manages `setLoading` and `setError` callbacks automatically.
- *
- * @template T - The success data type
- * @param operation - Async function to execute
- * @param setLoading - Callback to update loading state
- * @param setError - Callback to update error state
- * @param context - Optional context string for logging
- * @returns The operation result, or undefined on error
- * @since 1.0.0
- *
- * @example
- * ```typescript
- * const data = await withLoadingState(
- *   () => api.getUsers(),
- *   setIsLoading,
- *   setErrorMsg,
- *   'getUsers'
- * );
- * ```
- */
-const withLoadingState = async (operation, setLoading, setError, context) => {
-    setLoading(true);
-    setError(null);
-    try {
-        const result = await operation();
-        return result;
-    }
-    catch (error) {
-        const errorMessage = error instanceof Error ? error.message : String(error);
-        setError(errorMessage);
-        logger_1.logger.error(`Operation failed: ${errorMessage}`, context, error);
-        return undefined;
-    }
-    finally {
-        setLoading(false);
-    }
-};
-exports.withLoadingState = withLoadingState;
-/**
- * Execute multiple async operations in parallel with error handling.
- * All operations run concurrently via `Promise.all`.
- *
- * @template T - Tuple of result types
- * @param operations - Array of async functions to execute in parallel
- * @param context - Optional context string for logging
- * @returns A promise resolving to an {@link AsyncResult} of the tuple
- * @since 1.0.0
- *
- * @example
- * ```typescript
- * const result = await safeParallel(
- *   [() => fetchUser(1), () => fetchPosts(1)] as const,
- *   'loadProfile'
- * );
- * ```
- */
-const safeParallel = async (operations, context) => {
-    try {
-        const results = await Promise.all(operations.map(op => op()));
-        return { data: results, success: true };
-    }
-    catch (error) {
-        const errorObj = error instanceof Error ? error : new Error(String(error));
-        logger_1.logger.error(`Parallel operations failed: ${errorObj.message}`, context, error);
-        return { error: errorObj, success: false };
-    }
-};
-exports.safeParallel = safeParallel;
-/**
- * Execute async operation with a timeout.
- * Rejects if the operation does not complete within `timeoutMs`.
- *
- * @template T - The success data type
- * @param operation - Async function to execute
- * @param timeoutMs - Maximum time in milliseconds
- * @param context - Optional context string for logging
- * @returns The operation result
- * @throws Error if the operation times out
- * @since 1.0.0
- *
- * @example
- * ```typescript
- * const data = await withTimeout(
- *   () => fetch('/api/data').then((r) => r.json()),
- *   5000,
- *   'fetchData'
- * );
- * ```
- */
-const withTimeout = async (operation, timeoutMs, context) => {
-    const timeoutPromise = new Promise((_, reject) => setTimeout(() => reject(new Error(`Operation timed out after ${timeoutMs}ms`)), timeoutMs));
-    try {
-        return await Promise.race([operation(), timeoutPromise]);
-    }
-    catch (error) {
-        logger_1.logger.error(`Timeout operation failed`, context, error);
-        throw error;
-    }
-};
-exports.withTimeout = withTimeout;
-/**
- * In-memory cache for {@link withCache}.
- */
-const cache = new Map();
-/**
- * Cache async operation results with TTL (time-to-live).
- * Returns cached data if still valid; otherwise executes the operation
- * and stores the result.
- *
- * @template T - The cached data type
- * @param key - Unique cache key
- * @param operation - Async function whose result is cached
- * @param ttlMs - Cache TTL in milliseconds (default: 5 minutes)
- * @returns The cached or freshly fetched data
- * @since 1.0.0
- *
- * @example
- * ```typescript
- * const user = await withCache(
- *   `user-${id}`,
- *   () => api.getUser(id),
- *   60_000 // 1 minute
- * );
- * ```
- */
-const withCache = async (key, operation, ttlMs = 5 * 60 * 1000 // 5 minutes default
-) => {
-    const cached = cache.get(key);
-    const now = Date.now();
-    if (cached && now - cached.timestamp < cached.ttl) {
-        return cached.data;
-    }
-    const result = await operation();
-    cache.set(key, { data: result, timestamp: now, ttl: ttlMs });
-    return result;
-};
-exports.withCache = withCache;
-/**
- * Clear expired cache entries from the in-memory cache.
- * @since 1.0.0
- */
-const clearExpiredCache = () => {
-    const now = Date.now();
-    for (const [key, entry] of cache.entries()) {
-        if (now - entry.timestamp >= entry.ttl) {
-            cache.delete(key);
-        }
-    }
-};
-exports.clearExpiredCache = clearExpiredCache;
-/**
- * Active debounce timers keyed by operation key.
- */
-const debounceMap = new Map();
-/**
- * Debounce async function calls by key.
- * Only the last call within the delay window will execute.
- *
- * @template T - Argument types
- * @template R - Return type
- * @param fn - The async function to debounce
- * @param delay - Debounce delay in milliseconds
- * @param key - Unique key identifying this debounced operation
- * @returns A debounced version of `fn`
- * @since 1.0.0
- *
- * @example
- * ```typescript
- * const debouncedSearch = debounceAsync(
- *   (query: string) => api.search(query),
- *   300,
- *   'search'
- * );
- * await debouncedSearch('hello');
- * ```
- */
-const debounceAsync = (fn, delay, key) => {
-    return (...args) => {
-        return new Promise(resolve => {
-            const existingTimeout = debounceMap.get(key);
-            if (existingTimeout) {
-                clearTimeout(existingTimeout);
-            }
-            const timeout = setTimeout(async () => {
-                debounceMap.delete(key);
-                try {
-                    const result = await fn(...args);
-                    resolve(result);
-                }
-                catch (error) {
-                    logger_1.logger.error(`Debounced operation failed`, key, error);
-                    resolve(undefined);
-                }
-            }, delay);
-            debounceMap.set(key, timeout);
-        });
-    };
-};
-exports.debounceAsync = debounceAsync;
-//# sourceMappingURL=async-helpers.js.map