@adventurelabs/scout-core 1.0.8 → 1.0.9

package/dist/constants/db.d.ts

@@ -0,0 +1 @@
+export declare const BUCKET_NAME_SCOUT = "scout";

package/dist/constants/db.js

@@ -0,0 +1 @@
+export const BUCKET_NAME_SCOUT = "scout";

package/dist/helpers/events.js

@@ -1,6 +1,7 @@
 "use server";
 import { newServerClient } from "../supabase/server";
 import { EnumWebResponse, IWebResponse, } from "../types/requests";
+import { addSignedUrlsToEvents } from "./storage";
 export async function server_get_events_by_herd(herd_id) {
     const supabase = await newServerClient();
     // fetch events and include devices
@@ -13,8 +14,12 @@ export async function server_get_events_by_herd(herd_id) {
       `)
         .eq("devices.herd_id", herd_id)
         .order("timestamp_observation", { ascending: false });
+    // Add signed URLs to events using the same client
+    const eventsWithSignedUrls = data
+        ? await addSignedUrlsToEvents(data, supabase)
+        : [];
     // TODO: DETERMINE WHEN TO PASS ERROR
-    let response = IWebResponse.success(data ? data : []);
+    let response = IWebResponse.success(eventsWithSignedUrls);
     return response.to_compatible();
 }
 export async function server_get_more_events_by_herd(herd_id, offset, page_count = 10) {
@@ -32,8 +37,12 @@ export async function server_get_more_events_by_herd(herd_id, offset, page_count
         .eq("devices.herd_id", herd_id)
         .range(from, to)
         .order("timestamp_observation", { ascending: false });
+    // Add signed URLs to events using the same client
+    const eventsWithSignedUrls = data
+        ? await addSignedUrlsToEvents(data, supabase)
+        : [];
     // TODO: DETERMINE WHEN TO PASS ERROR
-    let response = IWebResponse.success(data ? data : []);
+    let response = IWebResponse.success(eventsWithSignedUrls);
     return response.to_compatible();
 }
 // function to get total number of events for a herd

package/dist/helpers/storage.d.ts

@@ -0,0 +1,36 @@
+import { SupabaseClient } from "@supabase/supabase-js";
+import { Database } from "../types/supabase";
+/**
+ * Generates a signed URL for a file in Supabase storage
+ * @param filePath - The path to the file in storage (e.g., "events/123/image.jpg")
+ * @param expiresIn - Number of seconds until the URL expires (default: 3600 = 1 hour)
+ * @param supabaseClient - Optional Supabase client (will create new one if not provided)
+ * @returns Promise<string | null> - The signed URL or null if error
+ */
+export declare function generateSignedUrl(filePath: string, expiresIn?: number, supabaseClient?: SupabaseClient<Database>): Promise<string | null>;
+/**
+ * Generates signed URLs for multiple events and sets them as media_url
+ * @param events - Array of events that may have file_path
+ * @param supabaseClient - Optional Supabase client (will create new one if not provided)
+ * @returns Promise<Array> - Events with signed URLs set as media_url
+ */
+export declare function addSignedUrlsToEvents(events: any[], supabaseClient?: SupabaseClient<Database>): Promise<any[]>;
+/**
+ * Generates a signed URL for a single event and sets it as media_url
+ * @param event - Event object that may have file_path
+ * @param supabaseClient - Optional Supabase client (will create new one if not provided)
+ * @returns Promise<Object> - Event with signed URL set as media_url
+ */
+export declare function addSignedUrlToEvent(event: any, supabaseClient?: SupabaseClient<Database>): Promise<any>;
+/**
+ * Gets the media URL for an event (signed URL if file_path exists, otherwise media_url)
+ * @param event - Event object that may have file_path or media_url
+ * @returns string | null - The media URL or null if none available
+ */
+export declare function getEventMediaUrl(event: any): string | null;
+/**
+ * Checks if an event has any media URL available
+ * @param event - Event object
+ * @returns boolean - True if event has any media URL
+ */
+export declare function hasEventMedia(event: any): boolean;

package/dist/helpers/storage.js

@@ -0,0 +1,82 @@
+"use server";
+import { newServerClient } from "../supabase/server";
+import { BUCKET_NAME_SCOUT } from "../constants/db";
+/**
+ * Generates a signed URL for a file in Supabase storage
+ * @param filePath - The path to the file in storage (e.g., "events/123/image.jpg")
+ * @param expiresIn - Number of seconds until the URL expires (default: 3600 = 1 hour)
+ * @param supabaseClient - Optional Supabase client (will create new one if not provided)
+ * @returns Promise<string | null> - The signed URL or null if error
+ */
+export async function generateSignedUrl(filePath, expiresIn = 3600, supabaseClient) {
+    try {
+        const supabase = supabaseClient || (await newServerClient());
+        const { data, error } = await supabase.storage
+            .from(BUCKET_NAME_SCOUT)
+            .createSignedUrl(filePath, expiresIn);
+        if (error) {
+            console.error("Error generating signed URL:", error.message);
+            return null;
+        }
+        return data.signedUrl;
+    }
+    catch (error) {
+        console.error("Error in generateSignedUrl:", error);
+        return null;
+    }
+}
+/**
+ * Generates signed URLs for multiple events and sets them as media_url
+ * @param events - Array of events that may have file_path
+ * @param supabaseClient - Optional Supabase client (will create new one if not provided)
+ * @returns Promise<Array> - Events with signed URLs set as media_url
+ */
+export async function addSignedUrlsToEvents(events, supabaseClient) {
+    const eventsWithSignedUrls = await Promise.all(events.map(async (event) => {
+        // If event has a file_path, generate a signed URL and set it as media_url
+        if (event.file_path) {
+            const signedUrl = await generateSignedUrl(event.file_path, 3600, supabaseClient);
+            return {
+                ...event,
+                media_url: signedUrl || event.media_url, // Fall back to existing media_url if signed URL fails
+            };
+        }
+        // If no file_path, keep existing media_url
+        return event;
+    }));
+    return eventsWithSignedUrls;
+}
+/**
+ * Generates a signed URL for a single event and sets it as media_url
+ * @param event - Event object that may have file_path
+ * @param supabaseClient - Optional Supabase client (will create new one if not provided)
+ * @returns Promise<Object> - Event with signed URL set as media_url
+ */
+export async function addSignedUrlToEvent(event, supabaseClient) {
+    // If event has a file_path, generate a signed URL and set it as media_url
+    if (event.file_path) {
+        const signedUrl = await generateSignedUrl(event.file_path, 3600, supabaseClient);
+        return {
+            ...event,
+            media_url: signedUrl || event.media_url, // Fall back to existing media_url if signed URL fails
+        };
+    }
+    // If no file_path, keep existing media_url
+    return event;
+}
+/**
+ * Gets the media URL for an event (signed URL if file_path exists, otherwise media_url)
+ * @param event - Event object that may have file_path or media_url
+ * @returns string | null - The media URL or null if none available
+ */
+export function getEventMediaUrl(event) {
+    return event.media_url || null;
+}
+/**
+ * Checks if an event has any media URL available
+ * @param event - Event object
+ * @returns boolean - True if event has any media URL
+ */
+export function hasEventMedia(event) {
+    return !!(event.media_url || event.file_path);
+}

package/dist/helpers/tags.js

@@ -2,6 +2,7 @@
 // add tag to db
 import { newServerClient } from "../supabase/server";
 import { EnumWebResponse, IWebResponse, } from "../types/requests";
+import { addSignedUrlsToEvents, addSignedUrlToEvent } from "./storage";
 export async function server_create_tags(tags) {
     const supabase = await newServerClient();
     // remove id key from tags
@@ -89,7 +90,9 @@ export async function server_get_more_events_with_tags_by_herd(herd_id, offset,
         event.tags = event.tags.filter((tag) => tag !== null);
         return event;
     });
-    return IWebResponse.success(filtered_data).to_compatible();
+    // Add signed URLs to events using the same client
+    const eventsWithSignedUrls = await addSignedUrlsToEvents(filtered_data, supabase);
+    return IWebResponse.success(eventsWithSignedUrls).to_compatible();
 }
 export async function server_get_events_and_tags_for_device(device_id, limit = 3) {
     const supabase = await newServerClient();
@@ -106,7 +109,9 @@ export async function server_get_events_and_tags_for_device(device_id, limit = 3
             data: [],
         };
     }
-    return IWebResponse.success(data).to_compatible();
+    // Add signed URLs to events using the same client
+    const eventsWithSignedUrls = await addSignedUrlsToEvents(data, supabase);
+    return IWebResponse.success(eventsWithSignedUrls).to_compatible();
 }
 export async function get_event_and_tags_by_event_id(event_id) {
     const supabase = await newServerClient();
@@ -154,5 +159,7 @@ export async function get_event_and_tags_by_event_id(event_id) {
         tags: data[0].tags || [],
         earthranger_url: data[0].earthranger_url,
     };
-    return IWebResponse.success(transformedData).to_compatible();
+    // Add signed URL to event using the same client
+    const eventWithSignedUrl = await addSignedUrlToEvent(transformedData, supabase);
+    return IWebResponse.success(eventWithSignedUrl).to_compatible();
 }

package/dist/hooks/useSignedUrl.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Hook for generating signed URLs on the client side
+ * @param filePath - The file path in storage
+ * @param expiresIn - Number of seconds until URL expires (default: 3600 = 1 hour)
+ * @returns Object with signedUrl and loading state
+ */
+export declare function useSignedUrl(filePath: string | null, expiresIn?: number): {
+    signedUrl: string | null;
+    loading: boolean;
+    error: string | null;
+};

package/dist/hooks/useSignedUrl.js

@@ -0,0 +1,50 @@
+"use client";
+import { useState, useEffect } from "react";
+import { createBrowserClient } from "@supabase/ssr";
+import { BUCKET_NAME_EVENTS } from "../constants/db";
+/**
+ * Hook for generating signed URLs on the client side
+ * @param filePath - The file path in storage
+ * @param expiresIn - Number of seconds until URL expires (default: 3600 = 1 hour)
+ * @returns Object with signedUrl and loading state
+ */
+export function useSignedUrl(filePath, expiresIn = 3600) {
+    const [signedUrl, setSignedUrl] = useState(null);
+    const [loading, setLoading] = useState(false);
+    const [error, setError] = useState(null);
+    useEffect(() => {
+        if (!filePath) {
+            setSignedUrl(null);
+            setError(null);
+            return;
+        }
+        const generateSignedUrl = async () => {
+            setLoading(true);
+            setError(null);
+            try {
+                const url = process.env.NEXT_PUBLIC_SUPABASE_URL || "";
+                const anon_key = process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY || "";
+                const supabase = createBrowserClient(url, anon_key);
+                const { data, error } = await supabase.storage
+                    .from(BUCKET_NAME_EVENTS)
+                    .createSignedUrl(filePath, expiresIn);
+                if (error) {
+                    setError(error.message);
+                    setSignedUrl(null);
+                }
+                else {
+                    setSignedUrl(data.signedUrl);
+                }
+            }
+            catch (err) {
+                setError(err instanceof Error ? err.message : "Unknown error");
+                setSignedUrl(null);
+            }
+            finally {
+                setLoading(false);
+            }
+        };
+        generateSignedUrl();
+    }, [filePath, expiresIn]);
+    return { signedUrl, loading, error };
+}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./constants/annotator";
 export * from "./constants/app";
+export * from "./constants/db";
 export * from "./types/db";
 export * from "./types/herd_module";
 export * from "./types/ui";
@@ -23,6 +24,7 @@ export * from "./helpers/ui";
 export * from "./helpers/users";
 export * from "./helpers/web";
 export * from "./helpers/zones";
+export * from "./helpers/storage";
 export * from "./hooks/useScoutDbListener";
 export * from "./hooks/useScoutRefresh";
 export * from "./providers";

package/dist/index.js

@@ -1,6 +1,7 @@
 // Constants
 export * from "./constants/annotator";
 export * from "./constants/app";
+export * from "./constants/db";
 // Types
 export * from "./types/db";
 export * from "./types/herd_module";
@@ -26,6 +27,7 @@ export * from "./helpers/ui";
 export * from "./helpers/users";
 export * from "./helpers/web";
 export * from "./helpers/zones";
+export * from "./helpers/storage";
 // Hooks
 export * from "./hooks/useScoutDbListener";
 export * from "./hooks/useScoutRefresh";

package/dist/supabase/server.d.ts

@@ -102,13 +102,14 @@ export declare function newServerClient(): Promise<import("@supabase/supabase-js
                 altitude: number;
                 device_id: number;
                 earthranger_url: string | null;
+                file_path: string | null;
                 heading: number;
                 id: number;
                 inserted_at: string;
                 is_public: boolean;
                 location: unknown | null;
                 media_type: Database["public"]["Enums"]["media_type"];
-                media_url: string;
+                media_url: string | null;
                 message: string;
                 timestamp_observation: string;
             };
@@ -116,13 +117,14 @@ export declare function newServerClient(): Promise<import("@supabase/supabase-js
                 altitude: number;
                 device_id: number;
                 earthranger_url?: string | null;
+                file_path?: string | null;
                 heading: number;
                 id?: number;
                 inserted_at?: string;
                 is_public?: boolean;
                 location?: unknown | null;
                 media_type?: Database["public"]["Enums"]["media_type"];
-                media_url: string;
+                media_url?: string | null;
                 message: string;
                 timestamp_observation?: string;
             };
@@ -130,13 +132,14 @@ export declare function newServerClient(): Promise<import("@supabase/supabase-js
                 altitude?: number;
                 device_id?: number;
                 earthranger_url?: string | null;
+                file_path?: string | null;
                 heading?: number;
                 id?: number;
                 inserted_at?: string;
                 is_public?: boolean;
                 location?: unknown | null;
                 media_type?: Database["public"]["Enums"]["media_type"];
-                media_url?: string;
+                media_url?: string | null;
                 message?: string;
                 timestamp_observation?: string;
             };
@@ -362,6 +365,7 @@ export declare function newServerClient(): Promise<import("@supabase/supabase-js
                 altitude: number | null;
                 device_id: number | null;
                 earthranger_url: string | null;
+                file_path: string | null;
                 heading: number | null;
                 herd_id: number | null;
                 id: number | null;
@@ -497,13 +501,14 @@ export declare function newServerClient(): Promise<import("@supabase/supabase-js
                 altitude: number;
                 device_id: number;
                 earthranger_url: string | null;
+                file_path: string | null;
                 heading: number;
                 id: number;
                 inserted_at: string;
                 is_public: boolean;
                 location: unknown | null;
                 media_type: Database["public"]["Enums"]["media_type"];
-                media_url: string;
+                media_url: string | null;
                 message: string;
                 timestamp_observation: string;
             }[];

package/dist/types/db.js

@@ -12,4 +12,5 @@ export const DUMMY_EVENT = {
     is_public: true,
     timestamp_observation: new Date().toISOString(),
     earthranger_url: null,
+    file_path: null,
 };

package/dist/types/supabase.d.ts

@@ -136,13 +136,14 @@ export type Database = {
                     altitude: number;
                     device_id: number;
                     earthranger_url: string | null;
+                    file_path: string | null;
                     heading: number;
                     id: number;
                     inserted_at: string;
                     is_public: boolean;
                     location: unknown | null;
                     media_type: Database["public"]["Enums"]["media_type"];
-                    media_url: string;
+                    media_url: string | null;
                     message: string;
                     timestamp_observation: string;
                 };
@@ -150,13 +151,14 @@ export type Database = {
                     altitude: number;
                     device_id: number;
                     earthranger_url?: string | null;
+                    file_path?: string | null;
                     heading: number;
                     id?: number;
                     inserted_at?: string;
                     is_public?: boolean;
                     location?: unknown | null;
                     media_type?: Database["public"]["Enums"]["media_type"];
-                    media_url: string;
+                    media_url?: string | null;
                     message: string;
                     timestamp_observation?: string;
                 };
@@ -164,13 +166,14 @@ export type Database = {
                     altitude?: number;
                     device_id?: number;
                     earthranger_url?: string | null;
+                    file_path?: string | null;
                     heading?: number;
                     id?: number;
                     inserted_at?: string;
                     is_public?: boolean;
                     location?: unknown | null;
                     media_type?: Database["public"]["Enums"]["media_type"];
-                    media_url?: string;
+                    media_url?: string | null;
                     message?: string;
                     timestamp_observation?: string;
                 };
@@ -410,6 +413,7 @@ export type Database = {
                     altitude: number | null;
                     device_id: number | null;
                     earthranger_url: string | null;
+                    file_path: string | null;
                     heading: number | null;
                     herd_id: number | null;
                     id: number | null;
@@ -550,13 +554,14 @@ export type Database = {
                     altitude: number;
                     device_id: number;
                     earthranger_url: string | null;
+                    file_path: string | null;
                     heading: number;
                     id: number;
                     inserted_at: string;
                     is_public: boolean;
                     location: unknown | null;
                     media_type: Database["public"]["Enums"]["media_type"];
-                    media_url: string;
+                    media_url: string | null;
                     message: string;
                     timestamp_observation: string;
                 }[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adventurelabs/scout-core",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Core utilities and helpers for Adventure Labs Scout applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",