@adventurelabs/scout-core 1.0.0

package/dist/types/db.d.ts

@@ -0,0 +1,42 @@
+import { User } from "@supabase/supabase-js";
+import { Database } from "./supabase";
+export type Role = Database["public"]["Enums"]["role"];
+export type DeviceType = Database["public"]["Enums"]["device_type"];
+export type MediaType = Database["public"]["Enums"]["media_type"];
+export type TagObservationType = Database["public"]["Enums"]["tag_observation_type"];
+export type IUser = User;
+export type IDevice = Database["public"]["CompositeTypes"]["device_pretty_location"] & {
+    api_keys_scout?: IApiKeyScout[];
+    recent_events?: IEventWithTags[];
+};
+export type IEvent = Database["public"]["Tables"]["events"]["Row"];
+export type ITag = Database["public"]["Tables"]["tags"]["Row"];
+export type IPlan = Database["public"]["Tables"]["plans"]["Row"];
+export type IAction = Database["public"]["Tables"]["actions"]["Row"];
+export type IZone = Database["public"]["Tables"]["zones"]["Row"];
+export type IUserRolePerHerd = Database["public"]["Tables"]["users_roles_per_herd"]["Row"];
+export type IHerd = Database["public"]["Tables"]["herds"]["Row"];
+export type IEventWithTags = Database["public"]["CompositeTypes"]["event_with_tags"] & {
+    earthranger_url: string | null;
+};
+export type IDevicePrettyLocation = Database["public"]["CompositeTypes"]["device_pretty_location"];
+export type IEventAndTagsPrettyLocation = Database["public"]["CompositeTypes"]["event_and_tags_pretty_location"];
+export type IZonesAndActionsPrettyLocation = Database["public"]["CompositeTypes"]["zones_and_actions_pretty_location"];
+export interface IZoneWithActions extends IZone {
+    actions: IAction[];
+}
+export type IUserAndRole = {
+    user: {
+        id: string;
+        username: string | null;
+    } | null;
+    role: Role;
+};
+export interface IApiKeyScout {
+    id: string;
+    description: string;
+    key: string;
+}
+export type Tag = ITag;
+export type TagClassName = string;
+export declare const DUMMY_EVENT: IEvent;

package/dist/types/db.js

@@ -0,0 +1,15 @@
+// Dummy event for testing/development
+export const DUMMY_EVENT = {
+    id: 0,
+    inserted_at: new Date().toISOString(),
+    device_id: 0,
+    message: "Dummy event",
+    media_url: "",
+    media_type: "image",
+    location: null,
+    altitude: 0,
+    heading: 0,
+    is_public: true,
+    timestamp_observation: new Date().toISOString(),
+    earthranger_url: null,
+};

package/dist/types/gps.d.ts

@@ -0,0 +1,21 @@
+export declare class GpsData {
+    id: number;
+    timestamp_utc: number;
+    latitude: number;
+    longitude: number;
+    altitude: number;
+    constructor(id: number, timestamp_utc: number, latitude: number, longitude: number, altitude: number);
+    static fromLocationObject(location: ILocationObject): GpsData;
+}
+export interface IGpsMetadata {
+    log_id: number;
+    total_distance_km: number;
+    max_speed_kph: number;
+    average_speed_kph: number;
+    max_altitude_m: number;
+}
+export interface ILocationObject {
+    latitude: number;
+    longitude: number;
+    id: number;
+}

package/dist/types/gps.js

@@ -0,0 +1,13 @@
+export class GpsData {
+    constructor(id, timestamp_utc, latitude, longitude, altitude) {
+        this.id = id;
+        this.timestamp_utc = timestamp_utc;
+        this.latitude = latitude;
+        this.longitude = longitude;
+        this.altitude = altitude;
+    }
+    // add a method to compose fromm a location object
+    static fromLocationObject(location) {
+        return new GpsData(location.id, 0, location.latitude, location.longitude, 0);
+    }
+}

package/dist/types/herd_module.d.ts

@@ -0,0 +1,31 @@
+import { SupabaseClient } from "@supabase/supabase-js";
+import { IDevice, IEventWithTags, IHerd, IPlan, IUserAndRole, IZoneWithActions } from "../types/db";
+export declare class HerdModule {
+    herd: IHerd;
+    devices: IDevice[];
+    events: IEventWithTags[];
+    zones: IZoneWithActions[];
+    timestamp_last_refreshed: number;
+    user_roles: IUserAndRole[] | null;
+    events_page_index: number;
+    total_events: number;
+    total_events_with_filters: number;
+    labels: string[];
+    plans: IPlan[];
+    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[]);
+    to_serializable(): IHerdModule;
+    static from_herd(herd: IHerd, client: SupabaseClient): Promise<HerdModule>;
+}
+export interface IHerdModule {
+    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[];
+}

package/dist/types/herd_module.js

@@ -0,0 +1,82 @@
+import { LABELS } from "../constants/annotator";
+import { get_devices_by_herd } from "../helpers/devices";
+import { server_get_total_events_by_herd } from "../helpers/events";
+import { server_get_plans_by_herd } from "../helpers/plans";
+import { server_get_events_and_tags_for_device } from "../helpers/tags";
+import { server_get_users_with_herd_access } from "../helpers/users";
+import { EnumWebResponse } from "./requests";
+import { server_get_more_zones_and_actions_for_herd } from "../helpers/zones";
+import { server_list_api_keys } from "../api_keys/actions";
+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 = []) {
+        this.user_roles = null;
+        this.events_page_index = 0;
+        this.total_events = 0;
+        this.total_events_with_filters = 0;
+        this.labels = [];
+        this.plans = [];
+        this.herd = herd;
+        this.devices = devices;
+        this.events = events;
+        this.timestamp_last_refreshed = timestamp_last_refreshed;
+        this.user_roles = user_roles;
+        this.events_page_index = events_page_index;
+        this.total_events = total_events;
+        this.total_events_with_filters = total_events_with_filters;
+        this.labels = labels;
+        this.plans = plans;
+        this.zones = zones;
+    }
+    to_serializable() {
+        return {
+            herd: this.herd,
+            devices: this.devices,
+            events: this.events,
+            timestamp_last_refreshed: this.timestamp_last_refreshed,
+            user_roles: this.user_roles,
+            events_page_index: this.events_page_index,
+            total_events: this.total_events,
+            total_events_with_filters: this.total_events_with_filters,
+            labels: this.labels,
+            plans: this.plans,
+            zones: this.zones,
+        };
+    }
+    static async from_herd(herd, client) {
+        // load devices
+        let response_new_devices = await get_devices_by_herd(herd.id, client);
+        if (response_new_devices.status == EnumWebResponse.ERROR ||
+            !response_new_devices.data) {
+            console.warn("No devices found for herd");
+            return new HerdModule(herd, [], [], Date.now());
+        }
+        const new_devices = response_new_devices.data;
+        // get api keys for each device... run requests in parallel
+        if (new_devices.length > 0) {
+            let api_keys_promises = new_devices.map((device) => server_list_api_keys(device.id?.toString() ?? ""));
+            let api_keys = await Promise.all(api_keys_promises);
+            for (let i = 0; i < new_devices.length; i++) {
+                new_devices[i].api_keys_scout = api_keys[i];
+            }
+        }
+        // get recent events for each device... run requests in parallel
+        let recent_events_promises = new_devices.map((device) => server_get_events_and_tags_for_device(device.id ?? 0));
+        // Run all requests in parallel
+        const [recent_events, res_zones, res_user_roles, total_event_count, res_plans,] = await Promise.all([
+            Promise.all(recent_events_promises),
+            server_get_more_zones_and_actions_for_herd(herd.id, 0, 10),
+            server_get_users_with_herd_access(herd.id),
+            server_get_total_events_by_herd(herd.id),
+            server_get_plans_by_herd(herd.id),
+        ]);
+        for (let i = 0; i < new_devices.length; i++) {
+            let x = recent_events[i].data;
+            if (recent_events[i].status == EnumWebResponse.SUCCESS && x) {
+                new_devices[i].recent_events = x;
+            }
+        }
+        // TODO: store in DB and retrieve on load?
+        const newLabels = LABELS;
+        return new HerdModule(herd, new_devices, [], Date.now(), res_user_roles.data, 0, total_event_count.data ? total_event_count.data : 0, total_event_count.data ? total_event_count.data : 0, newLabels, res_plans.data ? res_plans.data : [], res_zones.data ? res_zones.data : []);
+    }
+}

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./db";
+export * from "./herd_module";
+export * from "./ui";
+export * from "./requests";
+export * from "./gps";
+export * from "./supabase";

package/dist/types/index.js

@@ -0,0 +1,6 @@
+export * from "./db";
+export * from "./herd_module";
+export * from "./ui";
+export * from "./requests";
+export * from "./gps";
+export * from "./supabase";

package/dist/types/requests.d.ts

@@ -0,0 +1,18 @@
+export declare enum EnumWebResponse {
+    SUCCESS = "success",
+    ERROR = "error"
+}
+export declare class IWebResponse<T> {
+    status: EnumWebResponse;
+    data: T | null;
+    msg: string | null;
+    constructor(status: EnumWebResponse, data: T | null, msg: string | null);
+    static success<T>(data: T): IWebResponse<T>;
+    static error<T>(msg: string): IWebResponse<T>;
+    to_compatible(): IWebResponseCompatible<T>;
+}
+export interface IWebResponseCompatible<T> {
+    status: EnumWebResponse;
+    data: T | null;
+    msg: string | null;
+}

package/dist/types/requests.js

@@ -0,0 +1,25 @@
+export var EnumWebResponse;
+(function (EnumWebResponse) {
+    EnumWebResponse["SUCCESS"] = "success";
+    EnumWebResponse["ERROR"] = "error";
+})(EnumWebResponse || (EnumWebResponse = {}));
+export class IWebResponse {
+    constructor(status, data, msg) {
+        this.status = status;
+        this.data = data;
+        this.msg = msg;
+    }
+    static success(data) {
+        return new IWebResponse(EnumWebResponse.SUCCESS, data, null);
+    }
+    static error(msg) {
+        return new IWebResponse(EnumWebResponse.ERROR, null, msg);
+    }
+    to_compatible() {
+        return {
+            status: this.status,
+            data: this.data,
+            msg: this.msg,
+        };
+    }
+}