@plyaz/types 1.7.15 → 1.7.17

package/dist/testing/features/api/types.d.ts

@@ -0,0 +1,292 @@
+import type * as Vitest from 'vitest';
+import type { ConnectionType, EffectiveConnectionType, NetworkInfo } from '../../../api';
+/**
+ * Options for setupApiTest helper
+ */
+export interface SetupApiTestOptions {
+    /**
+     * EventManager singleton to reset between tests
+     * Pass the EventManager class if you want automatic reset
+     * @default undefined
+     */
+    eventManager?: {
+        reset: () => void;
+    };
+    /**
+     * Whether to use fake timers in tests
+     * @default false
+     */
+    useFakeTimers?: boolean;
+    /**
+     * Whether to clear all mocks before each test
+     * @default true
+     */
+    clearMocks?: boolean;
+    /**
+     * Whether to clear all spies before each test
+     * Requires spies utility that has clearAll method
+     * @default false
+     */
+    clearSpies?: boolean | {
+        clearAll: () => void;
+    };
+    /**
+     * Custom setup function to run before each test
+     * Runs after built-in setup
+     * @default undefined
+     */
+    beforeEach?: () => void | Promise<void>;
+    /**
+     * Custom teardown function to run after each test
+     * Runs before built-in teardown
+     * @default undefined
+     */
+    afterEach?: () => void | Promise<void>;
+}
+/**
+ * Creates tracked spies for fetchff module
+ */
+export interface FetchffSpies {
+    createApiFetcher: Vitest.Mock;
+    isSlowConnection: Vitest.Mock;
+    fetchf: Vitest.Mock;
+    mutate: Vitest.Mock;
+    revalidate: Vitest.Mock;
+    getCache: Vitest.Mock;
+    setCache: Vitest.Mock;
+    deleteCache: Vitest.Mock;
+}
+/**
+ * Return type for setupFetchffMocks utility
+ * Provides spies and setup functions for testing fetchff module
+ */
+export interface SetupFetchffMocksReturn {
+    spies: ApiMockSpies;
+    setupMocks: {
+        fetchff: () => FetchffSpies;
+        adapter: () => ConfigAdapterSpies;
+        builder: () => ConfigBuilderSpies;
+    };
+}
+/**
+ * Combined API mock spies for convenience
+ */
+export interface ApiMockSpies {
+    fetchff: FetchffSpies;
+    adapter: ConfigAdapterSpies;
+    builder: ConfigBuilderSpies;
+}
+/**
+ * Config builder spies
+ */
+export interface ConfigBuilderSpies {
+    mergeConfigs: Vitest.Mock;
+    buildApiConfig: Vitest.Mock;
+    applyDefaults: Vitest.Mock;
+    validateConfig: Vitest.Mock;
+}
+/**
+ * Config adapter spies
+ */
+export interface ConfigAdapterSpies {
+    toFetchffConfig: Vitest.Mock;
+    fromFetchffResponse: Vitest.Mock;
+    mergeHeaders: Vitest.Mock;
+    parseRetryConfig: Vitest.Mock;
+    parseCacheConfig: Vitest.Mock;
+}
+/**
+ * Network connection information interface
+ * Represents the connection property of navigator for testing
+ */
+export interface NetworkInfoConnection {
+    type: ConnectionType;
+    effectiveType: EffectiveConnectionType;
+    downlink: number | null;
+    downlinkMax: number | null;
+    rtt: number | null;
+    saveData: boolean;
+}
+/**
+ * Mock navigator interface for testing network information
+ * Includes connection details and language settings
+ */
+export interface NetworkInfoNavigatorMock {
+    type?: ConnectionType;
+    onLine: boolean;
+    connection: NetworkInfoConnection;
+    language: string;
+    languages: string[];
+}
+export interface CreateMockEventFactoryReturn {
+    on: ReturnType<Vitest.Mock>;
+    off: ReturnType<Vitest.Mock>;
+    emit: ReturnType<Vitest.Mock>;
+    emitGeneric: ReturnType<Vitest.Mock>;
+    onAny: ReturnType<Vitest.Mock>;
+    offAny: ReturnType<Vitest.Mock>;
+}
+export interface CreateMockNetworkFactory {
+    emitQualityChanged: ReturnType<Vitest.Mock>;
+    emitQualityChange: ReturnType<Vitest.Mock>;
+    emitConfigOverride: ReturnType<Vitest.Mock>;
+    emitConfigRestored: ReturnType<Vitest.Mock>;
+    emitInfoUpdate: ReturnType<Vitest.Mock>;
+    emitPresetApplied: ReturnType<Vitest.Mock>;
+    emitPresetChanged: ReturnType<Vitest.Mock>;
+    emitHintsUpdated: ReturnType<Vitest.Mock>;
+    emitAutoDetection: ReturnType<Vitest.Mock>;
+    emitManualUpdate: ReturnType<Vitest.Mock>;
+}
+export interface CreateMockErrorFactory {
+    emitError: ReturnType<Vitest.Mock>;
+    emitNetworkError: ReturnType<Vitest.Mock>;
+    emitTimeoutError: ReturnType<Vitest.Mock>;
+    emitClientError: ReturnType<Vitest.Mock>;
+    emitServerError: ReturnType<Vitest.Mock>;
+    emitValidationError: ReturnType<Vitest.Mock>;
+    emitHeadersError: ReturnType<Vitest.Mock>;
+    emitCritical: ReturnType<Vitest.Mock>;
+}
+export interface CreateMockHeaderFactory {
+    emitChanged: ReturnType<Vitest.Mock>;
+    emitEnriched: ReturnType<Vitest.Mock>;
+    emitConflict: ReturnType<Vitest.Mock>;
+    emitOverride: ReturnType<Vitest.Mock>;
+    emitMerged: ReturnType<Vitest.Mock>;
+    emitFiltered: ReturnType<Vitest.Mock>;
+    emitValidated: ReturnType<Vitest.Mock>;
+    emitCached: ReturnType<Vitest.Mock>;
+    emitCacheHit: ReturnType<Vitest.Mock>;
+    emitCacheMiss: ReturnType<Vitest.Mock>;
+}
+export interface CreateMockDebugFactory {
+    emitConfigConflict: ReturnType<Vitest.Mock>;
+    emitConflict: ReturnType<Vitest.Mock>;
+    emitConfigChange: ReturnType<Vitest.Mock>;
+    emitHeadersTracked: ReturnType<Vitest.Mock>;
+    emitNetworkOverride: ReturnType<Vitest.Mock>;
+    emitNetworkStateChanged: ReturnType<Vitest.Mock>;
+    emitNetworkDataCleared: ReturnType<Vitest.Mock>;
+    emitDebugInfo: ReturnType<Vitest.Mock>;
+    emitTracking: ReturnType<Vitest.Mock>;
+    emitPerformance: ReturnType<Vitest.Mock>;
+    emitMonitoringAlert: ReturnType<Vitest.Mock>;
+}
+export interface CreateMockConfigFactory {
+    emitGlobalUpdated: ReturnType<Vitest.Mock>;
+    emitConfigChanged: ReturnType<Vitest.Mock>;
+    emitConfigOverride: ReturnType<Vitest.Mock>;
+    emitConfigRestored: ReturnType<Vitest.Mock>;
+    emitConfigValidated: ReturnType<Vitest.Mock>;
+    emitPresetApplied: ReturnType<Vitest.Mock>;
+}
+export interface CreateMockPerformanceFactory {
+    emitMetric: ReturnType<Vitest.Mock>;
+    emitTiming: ReturnType<Vitest.Mock>;
+    emitThreshold: ReturnType<Vitest.Mock>;
+    emitCacheHit: ReturnType<Vitest.Mock>;
+    emitCacheMiss: ReturnType<Vitest.Mock>;
+    emitRequestStart: ReturnType<Vitest.Mock>;
+    emitRequestComplete: ReturnType<Vitest.Mock>;
+    emitRetry: ReturnType<Vitest.Mock>;
+    emitThresholdExceeded: ReturnType<Vitest.Mock>;
+    emitOptimizationApplied: ReturnType<Vitest.Mock>;
+    emitMetricRecorded: ReturnType<Vitest.Mock>;
+}
+export interface CreateMockCacheFactory {
+    emitHit: ReturnType<Vitest.Mock>;
+    emitMiss: ReturnType<Vitest.Mock>;
+    emitSet: ReturnType<Vitest.Mock>;
+    emitDelete: ReturnType<Vitest.Mock>;
+    emitClear: ReturnType<Vitest.Mock>;
+    emitExpire: ReturnType<Vitest.Mock>;
+    emitCacheHit: ReturnType<Vitest.Mock>;
+    emitCacheMiss: ReturnType<Vitest.Mock>;
+    emitCacheSet: ReturnType<Vitest.Mock>;
+    emitCacheDelete: ReturnType<Vitest.Mock>;
+    emitCacheClear: ReturnType<Vitest.Mock>;
+    emitCacheExpire: ReturnType<Vitest.Mock>;
+}
+export interface CreateMockBaseFactory {
+    emitInitialized: ReturnType<Vitest.Mock>;
+    emitDestroyed: ReturnType<Vitest.Mock>;
+    emitReady: ReturnType<Vitest.Mock>;
+}
+export interface CreateMockClientFactory {
+    emitRequest: ReturnType<Vitest.Mock>;
+    emitResponse: ReturnType<Vitest.Mock>;
+    emitError: ReturnType<Vitest.Mock>;
+    emitRetry: ReturnType<Vitest.Mock>;
+    emitTimeout: ReturnType<Vitest.Mock>;
+    emitConflict: ReturnType<Vitest.Mock>;
+    emitDebug: ReturnType<Vitest.Mock>;
+    emitCreated: ReturnType<Vitest.Mock>;
+    emitDestroyed: ReturnType<Vitest.Mock>;
+}
+/**
+ * Base event factory class for testing
+ * Provides minimal event functionality
+ */
+export interface BaseEventFactoryClass {
+    new (): {
+        emit(): void;
+        on(): ReturnType<Vitest.Mock>;
+        off(): void;
+        createAndEmit(): void;
+        createBaseEvent(): {
+            type: string;
+            timestamp: number;
+        };
+    };
+}
+/**
+ * Return type for createAllMockFactories
+ * Provides access to all mock event factories and reset functionality
+ */
+export interface CreateAllMockFactoriesReturn {
+    BaseEventFactory: BaseEventFactoryClass;
+    getNetworkEventFactory: ReturnType<Vitest.Mock>;
+    getHeaderEventFactory: ReturnType<Vitest.Mock>;
+    getErrorEventFactory: ReturnType<Vitest.Mock>;
+    getDebugEventFactory: ReturnType<Vitest.Mock>;
+    getConfigEventFactory: ReturnType<Vitest.Mock>;
+    getPerformanceEventFactory: ReturnType<Vitest.Mock>;
+    getCacheEventFactory: ReturnType<Vitest.Mock>;
+    getBaseEventFactory: ReturnType<Vitest.Mock>;
+    getClientEventFactory: ReturnType<Vitest.Mock>;
+    resetFactories: ReturnType<Vitest.Mock>;
+}
+/**
+ * Return type for createTrackableApiClient
+ * Provides mock client with event tracking utilities
+ *
+ * @template TClient - Type of the mock client being tracked
+ */
+export interface CreateTrackableApiClientReturn<TClient = unknown> {
+    client: TClient;
+    getEventHandlers: (event: string) => Array<(...args: unknown[]) => void>;
+    triggerEvent: (event: string, ...args: unknown[]) => void;
+    clearHandlers: () => void;
+}
+/**
+ * Options for createMockNavigator function
+ * Additional navigator properties to configure
+ */
+export interface CreateMockNavigatorOptions {
+    onLine?: boolean;
+    language?: string;
+    languages?: string[];
+}
+/**
+ * Return type for setupNetworkMockHelper
+ * Provides utilities to switch between network conditions in tests
+ */
+export interface SetupNetworkMockHelperReturn {
+    setExcellent: () => NetworkInfoNavigatorMock;
+    setGood: () => NetworkInfoNavigatorMock;
+    setSlow: () => NetworkInfoNavigatorMock;
+    setOffline: () => NetworkInfoNavigatorMock;
+    setCustom: (networkInfo: Partial<NetworkInfo>) => NetworkInfoNavigatorMock;
+    getNavigator: () => NetworkInfoNavigatorMock;
+}

package/dist/testing/features/index.d.ts

@@ -1,2 +1,3 @@
 export type * from './cache';
 export type * from './feature-flags';
+export type * from './api';

package/dist/web3/index.cjs

@@ -1,31 +1,4 @@
 'use strict';
 
-// @plyaz package - Built with tsup
-
-// src/web3/enums.ts
-var CHAIN_ID = {
-  /** Ethereum Mainnet (Chain ID: 1). */
-  EthereumMainnet: 1,
-  /** Ethereum Sepolia Testnet (Chain ID: 11155111). */
-  EthereumSepolia: 11155111,
-  /** Optimism Mainnet (Chain ID: 10). */
-  Optimism: 10,
-  /** Optimism Sepolia Testnet (Chain ID: 11155420). */
-  OptimismSepolia: 11155420,
-  /** Arbitrum One Mainnet (Chain ID: 42161). */
-  Arbitrum: 42161,
-  /** Arbitrum Sepolia Testnet (Chain ID: 421614). */
-  ArbitrumSepolia: 421614,
-  /** Polygon Mainnet (Chain ID: 137). */
-  Polygon: 137,
-  /** Polygon Amoy Testnet (Chain ID: 80002). */
-  PolygonAmoy: 80002,
-  /** Base Mainnet (Chain ID: 8453). */
-  Base: 8453,
-  /** Base Sepolia Testnet (Chain ID: 84532). */
-  BaseSepolia: 84532
-};
-
-exports.CHAIN_ID = CHAIN_ID;
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/dist/web3/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/web3/enums.ts"],"names":[],"mappings":";;;;;AAaO,IAAM,QAAA,GAAW;AAAA;AAAA,EAEtB,eAAA,EAAiB,CAAA;AAAA;AAAA,EAGjB,eAAA,EAAiB,QAAA;AAAA;AAAA,EAGjB,QAAA,EAAU,EAAA;AAAA;AAAA,EAGV,eAAA,EAAiB,QAAA;AAAA;AAAA,EAGjB,QAAA,EAAU,KAAA;AAAA;AAAA,EAGV,eAAA,EAAiB,MAAA;AAAA;AAAA,EAGjB,OAAA,EAAS,GAAA;AAAA;AAAA,EAGT,WAAA,EAAa,KAAA;AAAA;AAAA,EAGb,IAAA,EAAM,IAAA;AAAA;AAAA,EAGN,WAAA,EAAa;AACf","file":"index.cjs","sourcesContent":["/**\n * Enum representing supported EVM-compatible blockchain networks by their numeric chain IDs.\n * @description These IDs are used to identify the specific network when interacting with wallets or smart contracts.\n * @see https://chainlist.org for reference chain IDs\n *\n * @example\n * ```typescript\n * import { CHAIN_ID } from '@plyaz/types';\n *\n * const chainId = CHAIN_ID.EthereumMainnet; // 1\n * const isTestnet = chainId === CHAIN_ID.EthereumSepolia || chainId === CHAIN_ID.PolygonAmoy;\n * ```\n */\nexport const CHAIN_ID = {\n  /** Ethereum Mainnet (Chain ID: 1). */\n  EthereumMainnet: 1,\n\n  /** Ethereum Sepolia Testnet (Chain ID: 11155111). */\n  EthereumSepolia: 11_155_111,\n\n  /** Optimism Mainnet (Chain ID: 10). */\n  Optimism: 10,\n\n  /** Optimism Sepolia Testnet (Chain ID: 11155420). */\n  OptimismSepolia: 11_155_420,\n\n  /** Arbitrum One Mainnet (Chain ID: 42161). */\n  Arbitrum: 42_161,\n\n  /** Arbitrum Sepolia Testnet (Chain ID: 421614). */\n  ArbitrumSepolia: 421_614,\n\n  /** Polygon Mainnet (Chain ID: 137). */\n  Polygon: 137,\n\n  /** Polygon Amoy Testnet (Chain ID: 80002). */\n  PolygonAmoy: 80_002,\n\n  /** Base Mainnet (Chain ID: 8453). */\n  Base: 8_453,\n\n  /** Base Sepolia Testnet (Chain ID: 84532). */\n  BaseSepolia: 84_532,\n} as const;\n"]}
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs"}

package/dist/web3/index.d.ts

@@ -1,2 +1,2 @@
-export * from './enums';
+export type * from './enums';
 export type * from './types';

package/dist/web3/index.js

@@ -1,29 +1,3 @@
-// @plyaz package - Built with tsup
 
-// src/web3/enums.ts
-var CHAIN_ID = {
-  /** Ethereum Mainnet (Chain ID: 1). */
-  EthereumMainnet: 1,
-  /** Ethereum Sepolia Testnet (Chain ID: 11155111). */
-  EthereumSepolia: 11155111,
-  /** Optimism Mainnet (Chain ID: 10). */
-  Optimism: 10,
-  /** Optimism Sepolia Testnet (Chain ID: 11155420). */
-  OptimismSepolia: 11155420,
-  /** Arbitrum One Mainnet (Chain ID: 42161). */
-  Arbitrum: 42161,
-  /** Arbitrum Sepolia Testnet (Chain ID: 421614). */
-  ArbitrumSepolia: 421614,
-  /** Polygon Mainnet (Chain ID: 137). */
-  Polygon: 137,
-  /** Polygon Amoy Testnet (Chain ID: 80002). */
-  PolygonAmoy: 80002,
-  /** Base Mainnet (Chain ID: 8453). */
-  Base: 8453,
-  /** Base Sepolia Testnet (Chain ID: 84532). */
-  BaseSepolia: 84532
-};
-
-export { CHAIN_ID };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/web3/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/web3/enums.ts"],"names":[],"mappings":";;;AAaO,IAAM,QAAA,GAAW;AAAA;AAAA,EAEtB,eAAA,EAAiB,CAAA;AAAA;AAAA,EAGjB,eAAA,EAAiB,QAAA;AAAA;AAAA,EAGjB,QAAA,EAAU,EAAA;AAAA;AAAA,EAGV,eAAA,EAAiB,QAAA;AAAA;AAAA,EAGjB,QAAA,EAAU,KAAA;AAAA;AAAA,EAGV,eAAA,EAAiB,MAAA;AAAA;AAAA,EAGjB,OAAA,EAAS,GAAA;AAAA;AAAA,EAGT,WAAA,EAAa,KAAA;AAAA;AAAA,EAGb,IAAA,EAAM,IAAA;AAAA;AAAA,EAGN,WAAA,EAAa;AACf","file":"index.js","sourcesContent":["/**\n * Enum representing supported EVM-compatible blockchain networks by their numeric chain IDs.\n * @description These IDs are used to identify the specific network when interacting with wallets or smart contracts.\n * @see https://chainlist.org for reference chain IDs\n *\n * @example\n * ```typescript\n * import { CHAIN_ID } from '@plyaz/types';\n *\n * const chainId = CHAIN_ID.EthereumMainnet; // 1\n * const isTestnet = chainId === CHAIN_ID.EthereumSepolia || chainId === CHAIN_ID.PolygonAmoy;\n * ```\n */\nexport const CHAIN_ID = {\n  /** Ethereum Mainnet (Chain ID: 1). */\n  EthereumMainnet: 1,\n\n  /** Ethereum Sepolia Testnet (Chain ID: 11155111). */\n  EthereumSepolia: 11_155_111,\n\n  /** Optimism Mainnet (Chain ID: 10). */\n  Optimism: 10,\n\n  /** Optimism Sepolia Testnet (Chain ID: 11155420). */\n  OptimismSepolia: 11_155_420,\n\n  /** Arbitrum One Mainnet (Chain ID: 42161). */\n  Arbitrum: 42_161,\n\n  /** Arbitrum Sepolia Testnet (Chain ID: 421614). */\n  ArbitrumSepolia: 421_614,\n\n  /** Polygon Mainnet (Chain ID: 137). */\n  Polygon: 137,\n\n  /** Polygon Amoy Testnet (Chain ID: 80002). */\n  PolygonAmoy: 80_002,\n\n  /** Base Mainnet (Chain ID: 8453). */\n  Base: 8_453,\n\n  /** Base Sepolia Testnet (Chain ID: 84532). */\n  BaseSepolia: 84_532,\n} as const;\n"]}
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.7.15",
+  "version": "1.7.17",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",
@@ -182,7 +182,8 @@
     "@eslint/markdown": "^6.5.0",
     "@nestjs/common": "^11.1.3",
     "@next/eslint-plugin-next": "^15.0.3",
-    "@plyaz/config": "^1.4.1",
+    "@plyaz/config": "^1.5.2",
+    "fetchff": "^4.1.0",
     "@plyaz/devtools": "^1.9.4",
     "@testing-library/react": "^16.3.0",
     "@testing-library/user-event": "^14.6.1",

package/dist/api/types.d.ts

@@ -1,51 +0,0 @@
-import type { Simplify } from 'type-fest';
-import type { WithTimestamp, WithCorrelationId, Pageable, Versioned, NavigablePaginationMetadata, WithRequestId, WithItems } from '../common/types';
-/**
- * Standard structure for API responses.
- * @template Data - The main payload/data returned by the API.
- * @template Meta - Optional metadata object extending the default {@link ApiResponseMeta}.
- */
-export interface ApiResponse<Data, Meta = Record<string, string>> {
-    /**
-     * The core data returned by the API.
-     */
-    readonly data: Data;
-    /**
-     * Optional metadata object containing request-related information.
-     */
-    readonly meta?: ApiResponseMeta & Meta;
-}
-/**
- * Metadata included in API responses.
- * @description Provides useful context such as timestamps, request tracking, and API versioning.
- */
-export type ApiResponseMeta = WithTimestamp & Versioned & WithCorrelationId & WithRequestId;
-/**
- * Generic structure for paginated API responses.
- * @template Item - The type of items in the paginated result.
- */
-/**
- * Common pagination information shared by paginated API results.
- * Type alias for NavigablePaginationMetadata to maintain consistency.
- */
-export type PaginationInfo = NavigablePaginationMetadata;
-/**
- * Items wrapper used in paginated results.
- * Extends WithItems with readonly array for API immutability.
- */
-export type Paginated<Item> = WithItems<Item>;
-/**
- * Generic structure for paginated API responses.
- * Combines items with pagination metadata.
- * @template Item - The type of items in the paginated result.
- */
-export type PaginatedResponse<Item> = Simplify<Paginated<Item> & PaginationInfo>;
-/**
- * Parameters used to control pagination in API requests.
- */
-export interface PaginationParameters extends Partial<Pageable> {
-    /**
-     * Optional cursor string for cursor-based pagination.
-     */
-    readonly cursor?: string;
-}