@adventurelabs/scout-core 1.0.80 → 1.0.83

package/dist/types/db.d.ts

@@ -21,6 +21,7 @@ export type IUserRolePerHerd = Database["public"]["Tables"]["users_roles_per_her
 export type IHerd = Database["public"]["Tables"]["herds"]["Row"];
 export type ISession = Database["public"]["Tables"]["sessions"]["Row"];
 export type IConnectivity = Database["public"]["Tables"]["connectivity"]["Row"];
+export type IProvider = Database["public"]["Tables"]["providers"]["Row"];
 export type IEventWithTags = Database["public"]["CompositeTypes"]["event_with_tags"] & {
     earthranger_url: string | null;
     file_path: string | null;
@@ -62,3 +63,5 @@ export interface IApiKeyScout {
 }
 export type Tag = ITag;
 export type TagClassName = string;
+export type DeviceInsert = Database["public"]["Tables"]["devices"]["Insert"];
+export type DeviceUpdate = Database["public"]["Tables"]["devices"]["Update"];

package/dist/types/herd_module.d.ts

@@ -1,5 +1,5 @@
 import { SupabaseClient } from "@supabase/supabase-js";
-import { IDevice, IEventWithTags, IHerd, IPlan, ILayer, IUserAndRole, IZoneWithActions, ISessionWithCoordinates } from "../types/db";
+import { IDevice, IEventWithTags, IHerd, IPlan, ILayer, IProvider, IUserAndRole, IZoneWithActions, ISessionWithCoordinates } from "../types/db";
 import { EnumWebResponse } from "./requests";
 export declare enum EnumHerdModulesLoadingState {
     NOT_LOADING = "NOT_LOADING",
@@ -21,7 +21,8 @@ export declare class HerdModule {
     labels: string[];
     plans: IPlan[];
     layers: ILayer[];
-    constructor(herd: IHerd, devices: IDevice[], events: IEventWithTags[], timestamp_last_refreshed: number, user_roles?: IUserAndRole[] | null, events_page_index?: number, total_events?: number, total_events_with_filters?: number, labels?: string[], plans?: IPlan[], zones?: IZoneWithActions[], sessions?: ISessionWithCoordinates[], layers?: ILayer[]);
+    providers: IProvider[];
+    constructor(herd: IHerd, devices: IDevice[], events: IEventWithTags[], timestamp_last_refreshed: number, user_roles?: IUserAndRole[] | null, events_page_index?: number, total_events?: number, total_events_with_filters?: number, labels?: string[], plans?: IPlan[], zones?: IZoneWithActions[], sessions?: ISessionWithCoordinates[], layers?: ILayer[], providers?: IProvider[]);
     to_serializable(): IHerdModule;
     static from_herd(herd: IHerd, client: SupabaseClient): Promise<HerdModule>;
 }
@@ -39,6 +40,7 @@ export interface IHerdModule {
     zones: IZoneWithActions[];
     sessions: ISessionWithCoordinates[];
     layers: ILayer[];
+    providers: IProvider[];
 }
 export interface IHerdModulesResponse {
     data: IHerdModule[];

package/dist/types/herd_module.js

@@ -4,6 +4,7 @@ import { server_get_total_events_by_herd } from "../helpers/events";
 import { EnumSessionsVisibility } from "./events";
 import { server_get_plans_by_herd } from "../helpers/plans";
 import { server_get_layers_by_herd } from "../helpers/layers";
+import { server_get_providers_by_herd } from "../helpers/providers";
 import { server_get_events_and_tags_for_devices_batch } from "../helpers/tags";
 import { server_get_users_with_herd_access } from "../helpers/users";
 import { EnumWebResponse } from "./requests";
@@ -18,7 +19,7 @@ export var EnumHerdModulesLoadingState;
     EnumHerdModulesLoadingState["UNSUCCESSFULLY_LOADED"] = "UNSUCCESSFULLY_LOADED";
 })(EnumHerdModulesLoadingState || (EnumHerdModulesLoadingState = {}));
 export class HerdModule {
-    constructor(herd, devices, events, timestamp_last_refreshed, user_roles = null, events_page_index = 0, total_events = 0, total_events_with_filters = 0, labels = [], plans = [], zones = [], sessions = [], layers = []) {
+    constructor(herd, devices, events, timestamp_last_refreshed, user_roles = null, events_page_index = 0, total_events = 0, total_events_with_filters = 0, labels = [], plans = [], zones = [], sessions = [], layers = [], providers = []) {
         this.user_roles = null;
         this.events_page_index = 0;
         this.total_events = 0;
@@ -26,6 +27,7 @@ export class HerdModule {
         this.labels = [];
         this.plans = [];
         this.layers = [];
+        this.providers = [];
         this.herd = herd;
         this.devices = devices;
         this.events = events;
@@ -39,6 +41,7 @@ export class HerdModule {
         this.zones = zones;
         this.sessions = sessions;
         this.layers = layers;
+        this.providers = providers;
     }
     to_serializable() {
         return {
@@ -55,6 +58,7 @@ export class HerdModule {
             zones: this.zones,
             sessions: this.sessions,
             layers: this.layers,
+            providers: this.providers,
         };
     }
     static async from_herd(herd, client) {
@@ -95,7 +99,7 @@ export class HerdModule {
                 }
             }
             // Run all remaining requests in parallel with individual error handling
-            const [res_zones, res_user_roles, total_event_count, res_plans, res_sessions, res_layers,] = await Promise.allSettled([
+            const [res_zones, res_user_roles, total_event_count, res_plans, res_sessions, res_layers, res_providers,] = await Promise.allSettled([
                 server_get_more_zones_and_actions_for_herd(herd.id, 0, 10).catch((error) => {
                     console.warn(`[HerdModule] Failed to get zones and actions:`, error);
                     return { status: EnumWebResponse.ERROR, data: null };
@@ -114,12 +118,20 @@ export class HerdModule {
                 }),
                 server_get_sessions_by_herd_id(herd.id).catch((error) => {
                     console.warn(`[HerdModule] Failed to get sessions:`, error);
-                    return { status: EnumWebResponse.ERROR, data: [], msg: error.message };
+                    return {
+                        status: EnumWebResponse.ERROR,
+                        data: [],
+                        msg: error.message,
+                    };
                 }),
                 server_get_layers_by_herd(herd.id).catch((error) => {
                     console.warn(`[HerdModule] Failed to get layers:`, error);
                     return { status: EnumWebResponse.ERROR, data: null };
                 }),
+                server_get_providers_by_herd(herd.id).catch((error) => {
+                    console.warn(`[HerdModule] Failed to get providers:`, error);
+                    return { status: EnumWebResponse.ERROR, data: null };
+                }),
             ]);
             // Assign recent events to devices from batch results
             for (let i = 0; i < new_devices.length; i++) {
@@ -148,23 +160,28 @@ export class HerdModule {
             const plans = res_plans.status === "fulfilled" && res_plans.value?.data
                 ? res_plans.value.data
                 : [];
-            const sessions = res_sessions.status === "fulfilled" && res_sessions.value?.data ? res_sessions.value.data : [];
+            const sessions = res_sessions.status === "fulfilled" && res_sessions.value?.data
+                ? res_sessions.value.data
+                : [];
             const layers = res_layers.status === "fulfilled" && res_layers.value?.data
                 ? res_layers.value.data
                 : [];
+            const providers = res_providers.status === "fulfilled" && res_providers.value?.data
+                ? res_providers.value.data
+                : [];
             // TODO: store in DB and retrieve on load?
             const newLabels = LABELS;
             const endTime = Date.now();
             const loadTime = endTime - startTime;
             console.log(`[HerdModule] Loaded herd ${herd.slug} in ${loadTime}ms (${new_devices.length} devices)`);
-            return new HerdModule(herd, new_devices, [], Date.now(), user_roles, 0, total_events, total_events, newLabels, plans, zones, sessions, layers);
+            return new HerdModule(herd, new_devices, [], Date.now(), user_roles, 0, total_events, total_events, newLabels, plans, zones, sessions, layers, providers);
         }
         catch (error) {
             const endTime = Date.now();
             const loadTime = endTime - startTime;
             console.error(`[HerdModule] Critical error in HerdModule.from_herd (${loadTime}ms):`, error);
             // Return a minimal but valid HerdModule instance to prevent complete failure
-            return new HerdModule(herd, [], [], Date.now(), null, 0, 0, 0, [], [], [], [], []);
+            return new HerdModule(herd, [], [], Date.now(), null, 0, 0, 0, [], [], [], [], [], []);
         }
     }
 }

package/dist/types/supabase.d.ts

@@ -3,7 +3,7 @@ export type Json = string | number | boolean | null | {
 } | Json[];
 export type Database = {
     __InternalSupabase: {
-        PostgrestVersion: "12.2.12 (cd3cf9e)";
+        PostgrestVersion: "13.0.5";
     };
     public: {
         Tables: {
@@ -416,6 +416,41 @@ export type Database = {
                     }
                 ];
             };
+            providers: {
+                Row: {
+                    created_at: string;
+                    herd_id: number;
+                    id: number;
+                    key: string | null;
+                    source: string;
+                    type: string;
+                };
+                Insert: {
+                    created_at?: string;
+                    herd_id: number;
+                    id?: number;
+                    key?: string | null;
+                    source: string;
+                    type: string;
+                };
+                Update: {
+                    created_at?: string;
+                    herd_id?: number;
+                    id?: number;
+                    key?: string | null;
+                    source?: string;
+                    type?: string;
+                };
+                Relationships: [
+                    {
+                        foreignKeyName: "providers_herd_id_fkey";
+                        columns: ["herd_id"];
+                        isOneToOne: false;
+                        referencedRelation: "herds";
+                        referencedColumns: ["id"];
+                    }
+                ];
+            };
             sessions: {
                 Row: {
                     altitude_average: number;
@@ -427,9 +462,9 @@ export type Database = {
                     earthranger_url: string | null;
                     id: number;
                     inserted_at: string;
-                    locations: unknown;
+                    locations: unknown | null;
                     software_version: string;
-                    timestamp_end: string;
+                    timestamp_end: string | null;
                     timestamp_start: string;
                     velocity_average: number;
                     velocity_max: number;
@@ -445,9 +480,9 @@ export type Database = {
                     earthranger_url?: string | null;
                     id?: number;
                     inserted_at?: string;
-                    locations: unknown;
+                    locations?: unknown | null;
                     software_version: string;
-                    timestamp_end: string;
+                    timestamp_end?: string | null;
                     timestamp_start: string;
                     velocity_average: number;
                     velocity_max: number;
@@ -463,9 +498,9 @@ export type Database = {
                     earthranger_url?: string | null;
                     id?: number;
                     inserted_at?: string;
-                    locations?: unknown;
+                    locations?: unknown | null;
                     software_version?: string;
-                    timestamp_end?: string;
+                    timestamp_end?: string | null;
                     timestamp_start?: string;
                     velocity_average?: number;
                     velocity_max?: number;
@@ -869,7 +904,7 @@ export type Database = {
             device_type: "trail_camera" | "drone_fixed_wing" | "drone_quad" | "gps_tracker" | "sentry_tower" | "smart_buoy" | "radio_mesh_base_station" | "radio_mesh_repeater" | "unknown";
             media_type: "image" | "video" | "audio" | "text";
             plan_type: "mission" | "fence" | "rally" | "markov";
-            role: "admin" | "viewer" | "editor";
+            role: "admin" | "viewer" | "editor" | "operator";
             tag_observation_type: "manual" | "auto";
             user_status: "ONLINE" | "OFFLINE";
         };
@@ -1068,7 +1103,7 @@ export declare const Constants: {
             readonly device_type: readonly ["trail_camera", "drone_fixed_wing", "drone_quad", "gps_tracker", "sentry_tower", "smart_buoy", "radio_mesh_base_station", "radio_mesh_repeater", "unknown"];
             readonly media_type: readonly ["image", "video", "audio", "text"];
             readonly plan_type: readonly ["mission", "fence", "rally", "markov"];
-            readonly role: readonly ["admin", "viewer", "editor"];
+            readonly role: readonly ["admin", "viewer", "editor", "operator"];
             readonly tag_observation_type: readonly ["manual", "auto"];
             readonly user_status: readonly ["ONLINE", "OFFLINE"];
         };

package/dist/types/supabase.js

@@ -15,7 +15,7 @@ export const Constants = {
             ],
             media_type: ["image", "video", "audio", "text"],
             plan_type: ["mission", "fence", "rally", "markov"],
-            role: ["admin", "viewer", "editor"],
+            role: ["admin", "viewer", "editor", "operator"],
             tag_observation_type: ["manual", "auto"],
             user_status: ["ONLINE", "OFFLINE"],
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adventurelabs/scout-core",
-  "version": "1.0.80",
+  "version": "1.0.83",
   "description": "Core utilities and helpers for Adventure Labs Scout applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -38,12 +38,19 @@
     "react-dom": ">=18.0.0",
     "react-redux": ">=9.0.0",
     "@supabase/supabase-js": "^2.57.4",
-    "@supabase/ssr": "^0.6.1",
+    "@supabase/ssr": "^0.7.0",
     "@reduxjs/toolkit": "^2.0.0"
   },
   "devDependencies": {
     "@types/react": "^18.0.0",
     "@types/react-dom": "^18.0.0",
-    "typescript": "^5.0.0"
+    "typescript": "^5.0.0",
+    "next": ">=15.0.0",
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0",
+    "react-redux": ">=9.0.0",
+    "@supabase/supabase-js": "^2.57.4",
+    "@supabase/ssr": "^0.7.0",
+    "@reduxjs/toolkit": "^2.0.0"
   }
 }

package/dist/helpers/cache-usage-example.d.ts

@@ -1,17 +0,0 @@
-/**
- * Example usage of the ScoutCache system
- * This demonstrates how to use the cache-first loading pattern
- */
-import { CacheStats, TimingStats } from "./cache";
-export declare function ExampleBasicUsage(): {
-    handleRefresh: () => Promise<void>;
-    clearCache: () => Promise<void>;
-    stats: () => TimingStats;
-    cacheStats: () => Promise<CacheStats>;
-};
-export declare function ExampleAdvancedCacheManagement(): Promise<void>;
-export declare function ExampleBackgroundPreloading(): Promise<void>;
-export declare function ExamplePerformanceMonitoring(): {
-    getTimingStats: () => TimingStats;
-    getCacheStats: () => Promise<CacheStats>;
-};

package/dist/helpers/cache-usage-example.js

@@ -1,82 +0,0 @@
-/**
- * Example usage of the ScoutCache system
- * This demonstrates how to use the cache-first loading pattern
- */
-import { useScoutRefresh } from "../hooks/useScoutRefresh";
-import { scoutCache } from "./cache";
-// Example 1: Basic usage with cache-first loading
-export function ExampleBasicUsage() {
-    const { handleRefresh, getTimingStats, clearCache, getCacheStats } = useScoutRefresh({
-        autoRefresh: true,
-        cacheFirst: true,
-        cacheTtlMs: 10 * 60 * 1000, // 10 minutes
-        onRefreshComplete: () => {
-            console.log("Refresh completed!");
-        }
-    });
-    // Get timing stats
-    const stats = getTimingStats();
-    console.log("Performance stats:", stats);
-    // Get cache stats
-    const cacheStats = getCacheStats();
-    console.log("Cache stats:", cacheStats);
-    return {
-        handleRefresh,
-        clearCache,
-        stats: getTimingStats,
-        cacheStats: getCacheStats,
-    };
-}
-// Example 2: Advanced cache management
-export async function ExampleAdvancedCacheManagement() {
-    // Check if cache is valid
-    const isValid = await scoutCache.isCacheValid(5 * 60 * 1000); // 5 minutes
-    console.log("Cache is valid:", isValid);
-    // Check if we should refresh
-    const shouldRefresh = await scoutCache.shouldRefresh(2 * 60 * 1000, // max age 2 minutes
-    false // not forcing refresh
-    );
-    console.log("Should refresh:", shouldRefresh);
-    // Get cache age
-    const age = await scoutCache.getCacheAge();
-    console.log("Cache age:", Math.round(age / 1000), "seconds");
-    // Invalidate cache
-    await scoutCache.invalidateHerdModules();
-    console.log("Cache invalidated");
-    // Clear all cache data
-    await scoutCache.clearHerdModules();
-    console.log("Cache cleared");
-}
-// Example 3: Background preloading
-export async function ExampleBackgroundPreloading() {
-    // Simulate a function that loads herd modules
-    const loadHerdModules = async () => {
-        // This would be your actual API call
-        const response = await fetch("/api/herd-modules");
-        return response.json();
-    };
-    // Preload cache in background
-    await scoutCache.preloadCache(loadHerdModules, 15 * 60 * 1000); // 15 minutes TTL
-    console.log("Background preload completed");
-}
-// Example 4: Performance monitoring
-export function ExamplePerformanceMonitoring() {
-    const { getTimingStats, getCacheStats } = useScoutRefresh({
-        cacheFirst: true,
-        onRefreshComplete: async () => {
-            const stats = getTimingStats();
-            const cacheStats = await getCacheStats();
-            console.log("=== Performance Report ===");
-            console.log("Total duration:", stats.totalDuration, "ms");
-            console.log("Cache load:", stats.cacheLoad, "ms");
-            console.log("API calls:", stats.herdModulesApi + stats.userApi, "ms");
-            console.log("Cache save:", stats.cacheSave, "ms");
-            console.log("Data processing:", stats.dataProcessing, "ms");
-            console.log("LocalStorage:", stats.localStorage, "ms");
-            console.log("Cache hit rate:", (cacheStats.hitRate * 100).toFixed(1) + "%");
-            console.log("Cache size:", cacheStats.size, "herd modules");
-            console.log("Cache age:", Math.round((Date.now() - cacheStats.lastUpdated) / 1000), "seconds");
-        }
-    });
-    return { getTimingStats, getCacheStats };
-}

package/dist/hooks/data-source-usage-example.d.ts

@@ -1,9 +0,0 @@
-/**
- * Example components demonstrating how to use data source tracking
- */
-export declare function DataSourceIndicator(): import("react/jsx-runtime").JSX.Element;
-export declare function ConditionalContent(): import("react/jsx-runtime").JSX.Element;
-export declare function PerformanceMetrics(): import("react/jsx-runtime").JSX.Element;
-export declare function SmartRefreshButton(): import("react/jsx-runtime").JSX.Element;
-export declare function HeaderWithDataSource(): import("react/jsx-runtime").JSX.Element;
-export declare function DataSourceDebugger(): import("react/jsx-runtime").JSX.Element;

package/dist/hooks/data-source-usage-example.js

@@ -1,68 +0,0 @@
-import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { useDataSource, useDataSourceDescription } from './useDataSource';
-import { useScoutRefresh } from './useScoutRefresh';
-// Example 1: Basic data source display
-export function DataSourceIndicator() {
-    const { dataSource, isFromCache, cacheAge, isStale } = useDataSource();
-    const description = useDataSourceDescription();
-    return (_jsxs("div", { className: "data-source-indicator", children: [_jsx("div", { className: `source-badge ${dataSource.toLowerCase()}`, children: dataSource }), _jsxs("div", { className: "source-details", children: [_jsx("p", { children: description }), isFromCache && (_jsxs("div", { className: "cache-info", children: [_jsxs("span", { children: ["Cache age: ", Math.round(cacheAge / 1000), "s"] }), _jsx("span", { className: isStale ? 'stale' : 'fresh', children: isStale ? 'Stale' : 'Fresh' })] }))] })] }));
-}
-// Example 2: Conditional rendering based on data source
-export function ConditionalContent() {
-    const { isFromCache, isFromDatabase, isStale } = useDataSource();
-    return (_jsxs("div", { children: [isFromCache && (_jsx("div", { className: "cache-notice", children: isStale ? (_jsx("p", { children: "\u26A0\uFE0F Showing cached data (may be outdated)" })) : (_jsx("p", { children: "\u2705 Showing fresh cached data" })) })), isFromDatabase && (_jsx("div", { className: "database-notice", children: _jsx("p", { children: "\uD83D\uDD04 Showing live data from database" }) }))] }));
-}
-// Example 3: Performance metrics with data source
-export function PerformanceMetrics() {
-    const { dataSource, cacheAge } = useDataSource();
-    const { getTimingStats, getCacheStats } = useScoutRefresh();
-    const handleShowMetrics = () => {
-        const timing = getTimingStats();
-        console.log('Performance Metrics:', {
-            dataSource,
-            cacheAge: cacheAge ? Math.round(cacheAge / 1000) : 'N/A',
-            totalDuration: timing.totalDuration,
-            cacheLoad: timing.cacheLoad,
-            apiCalls: timing.herdModulesApi + timing.userApi,
-        });
-    };
-    return (_jsxs("div", { className: "performance-metrics", children: [_jsx("h3", { children: "Performance Metrics" }), _jsxs("p", { children: ["Data Source: ", dataSource] }), cacheAge && _jsxs("p", { children: ["Cache Age: ", Math.round(cacheAge / 1000), "s"] }), _jsx("button", { onClick: handleShowMetrics, children: "Show Detailed Metrics" })] }));
-}
-// Example 4: Data source aware refresh button
-export function SmartRefreshButton() {
-    const { isFromCache, isStale, cacheAge } = useDataSource();
-    const { handleRefresh } = useScoutRefresh();
-    const getButtonText = () => {
-        if (isFromCache) {
-            if (isStale) {
-                return 'Refresh Stale Data';
-            }
-            else {
-                const ageSeconds = Math.round(cacheAge / 1000);
-                return `Refresh (${ageSeconds}s old)`;
-            }
-        }
-        return 'Refresh Data';
-    };
-    const getButtonStyle = () => {
-        if (isFromCache && isStale) {
-            return 'refresh-button stale';
-        }
-        else if (isFromCache) {
-            return 'refresh-button cached';
-        }
-        return 'refresh-button fresh';
-    };
-    return (_jsx("button", { className: getButtonStyle(), onClick: handleRefresh, children: getButtonText() }));
-}
-// Example 5: Data source status in header
-export function HeaderWithDataSource() {
-    const description = useDataSourceDescription();
-    const { handleRefresh } = useScoutRefresh();
-    return (_jsxs("header", { className: "app-header", children: [_jsx("h1", { children: "Scout Dashboard" }), _jsxs("div", { className: "header-controls", children: [_jsx("span", { className: "data-source-status", children: description }), _jsx("button", { onClick: handleRefresh, children: "Refresh" })] })] }));
-}
-// Example 6: Data source debugging component
-export function DataSourceDebugger() {
-    const { dataSource, dataSourceInfo, isFromCache, isFromDatabase, isUnknown } = useDataSource();
-    return (_jsxs("div", { className: "data-source-debugger", children: [_jsx("h3", { children: "Data Source Debug Info" }), _jsxs("div", { className: "debug-info", children: [_jsxs("p", { children: [_jsx("strong", { children: "Source:" }), " ", dataSource] }), _jsxs("p", { children: [_jsx("strong", { children: "From Cache:" }), " ", isFromCache ? 'Yes' : 'No'] }), _jsxs("p", { children: [_jsx("strong", { children: "From Database:" }), " ", isFromDatabase ? 'Yes' : 'No'] }), _jsxs("p", { children: [_jsx("strong", { children: "Unknown:" }), " ", isUnknown ? 'Yes' : 'No'] }), dataSourceInfo && (_jsxs("div", { className: "detailed-info", children: [_jsxs("p", { children: [_jsx("strong", { children: "Timestamp:" }), " ", new Date(dataSourceInfo.timestamp).toISOString()] }), dataSourceInfo.cacheAge && (_jsxs("p", { children: [_jsx("strong", { children: "Cache Age:" }), " ", Math.round(dataSourceInfo.cacheAge / 1000), "s"] })), typeof dataSourceInfo.isStale === 'boolean' && (_jsxs("p", { children: [_jsx("strong", { children: "Is Stale:" }), " ", dataSourceInfo.isStale ? 'Yes' : 'No'] }))] }))] })] }));
-}

package/dist/hooks/useDataSource.d.ts

@@ -1,43 +0,0 @@
-import { EnumDataSource, IDataSourceInfo } from "../types/data_source";
-/**
- * Hook to access data source information from the Redux store
- *
- * @returns Object containing:
- * - dataSource: The current data source (CACHE, DATABASE, or UNKNOWN)
- * - dataSourceInfo: Detailed information about the data source
- * - isFromCache: Boolean indicating if data is from cache
- * - isFromDatabase: Boolean indicating if data is from database
- * - cacheAge: Age of cached data in milliseconds (if from cache)
- * - isStale: Whether cached data is stale (if from cache)
- *
- * @example
- * ```tsx
- * function MyComponent() {
- *   const { dataSource, isFromCache, cacheAge, isStale } = useDataSource();
- *
- *   return (
- *     <div>
- *       <p>Data source: {dataSource}</p>
- *       {isFromCache && (
- *         <p>Cache age: {Math.round(cacheAge! / 1000)}s, Stale: {isStale ? 'Yes' : 'No'}</p>
- *       )}
- *     </div>
- *   );
- * }
- * ```
- */
-export declare function useDataSource(): {
-    dataSource: EnumDataSource;
-    dataSourceInfo: IDataSourceInfo | null;
-    isFromCache: boolean;
-    isFromDatabase: boolean;
-    isUnknown: boolean;
-    cacheAge: number | undefined;
-    isStale: boolean | undefined;
-};
-/**
- * Hook to get a human-readable description of the data source
- *
- * @returns String description of the current data source
- */
-export declare function useDataSourceDescription(): string;

package/dist/hooks/useDataSource.js

@@ -1,63 +0,0 @@
-import { useSelector } from "react-redux";
-import { EnumDataSource } from "../types/data_source";
-/**
- * Hook to access data source information from the Redux store
- *
- * @returns Object containing:
- * - dataSource: The current data source (CACHE, DATABASE, or UNKNOWN)
- * - dataSourceInfo: Detailed information about the data source
- * - isFromCache: Boolean indicating if data is from cache
- * - isFromDatabase: Boolean indicating if data is from database
- * - cacheAge: Age of cached data in milliseconds (if from cache)
- * - isStale: Whether cached data is stale (if from cache)
- *
- * @example
- * ```tsx
- * function MyComponent() {
- *   const { dataSource, isFromCache, cacheAge, isStale } = useDataSource();
- *
- *   return (
- *     <div>
- *       <p>Data source: {dataSource}</p>
- *       {isFromCache && (
- *         <p>Cache age: {Math.round(cacheAge! / 1000)}s, Stale: {isStale ? 'Yes' : 'No'}</p>
- *       )}
- *     </div>
- *   );
- * }
- * ```
- */
-export function useDataSource() {
-    const dataSource = useSelector((state) => state.scout.data_source);
-    const dataSourceInfo = useSelector((state) => state.scout.data_source_info);
-    const isFromCache = dataSource === EnumDataSource.CACHE;
-    const isFromDatabase = dataSource === EnumDataSource.DATABASE;
-    const isUnknown = dataSource === EnumDataSource.UNKNOWN;
-    return {
-        dataSource,
-        dataSourceInfo,
-        isFromCache,
-        isFromDatabase,
-        isUnknown,
-        cacheAge: dataSourceInfo?.cacheAge,
-        isStale: dataSourceInfo?.isStale,
-    };
-}
-/**
- * Hook to get a human-readable description of the data source
- *
- * @returns String description of the current data source
- */
-export function useDataSourceDescription() {
-    const { dataSource, cacheAge, isStale } = useDataSource();
-    switch (dataSource) {
-        case EnumDataSource.CACHE:
-            const ageSeconds = cacheAge ? Math.round(cacheAge / 1000) : 0;
-            return `Loaded from cache (${ageSeconds}s old${isStale ? ', stale' : ', fresh'})`;
-        case EnumDataSource.DATABASE:
-            return 'Loaded from database (fresh data)';
-        case EnumDataSource.UNKNOWN:
-        default:
-            return 'Data source unknown';
-    }
-}