@3deye-toolkit/react-event-search 0.0.3 → 0.0.5

package/dist/react-event-search.d.ts

@@ -2,7 +2,6 @@ import { BehaviorSubject } from 'rxjs';
 import crossfilter from 'crossfilter2';
 import type { IReactionDisposer } from 'mobx';
 import { Observable } from 'rxjs';
-import { default as React_2 } from 'react';
 import { Subject } from 'rxjs';
 import { Subscription } from 'rxjs';
 import { z } from 'zod';
@@ -12,6 +11,7 @@ declare class AccountStore extends ApiStore {
     user: User | null;
     auth: Auth;
     constructor(notification?: NotificationService | undefined);
+    get isSharingUserAccount(): boolean;
     get userDisplayName(): string | null;
     protected afterInit(): void;
     loadUser$(): Observable<RawUser | null>;
@@ -29,34 +29,7 @@ declare class AccountStore extends ApiStore {
     updateCustomPreferences: (preferences: Partial<Preferences>) => Observable<RawUser>;
     setDefaultGroup(groupId: number): Observable<RawUser> | undefined;
     get preferences(): Preferences;
-    getPreference: <T extends PREFERENCES>(key: T) => {
-        utc: boolean;
-        hour12: boolean;
-        startOfWeek: "monday" | "sunday";
-        defaultVideoResizeMode?: VideoResizeMode | undefined;
-        camerasResizeMode?: [number, VideoResizeMode][] | undefined;
-        fisheyeCameras?: [number, [number, number, number] | {
-            params: {
-                x: number;
-                y: number;
-                r: number;
-                s: number;
-            };
-            positions?: [{
-                lat: number;
-                lon: number;
-                fov: number;
-            }, {
-                lat: number;
-                lon: number;
-                fov: number;
-            }, {
-                lat: number;
-                lon: number;
-                fov: number;
-            }] | undefined;
-        } | null][] | undefined;
-    }[T];
+    getPreference: <T extends keyof Preferences>(key: T) => Preferences[T];
     private retryOnVersionMismatch;
 }
 
@@ -96,11 +69,12 @@ declare class Api<T extends DeepPartial<IApi>> {
         event: string;
         data: any;
     }>;
-    logging: boolean;
+    logLevel: LOG_LEVEL;
     authStore: Auth;
     createConnection: (accessToken: string) => Connection;
     apiConfig: PartialApi;
     constructor(apiConfig: T, authStore: Auth, createConnection: (accessToken: string) => Connection);
+    log: (level: LOG_LEVEL, ...args: unknown[]) => void;
     connect(token: Token): void;
     shutdownConnection(): void;
     private init;
@@ -139,6 +113,18 @@ declare abstract class ApiStore {
     dispose(): void;
 }
 
+declare interface App {
+    cameras: CamerasStore;
+    archives: ArchivesStore;
+    events: EventsStore;
+    eventSchema: EventSchemaStore;
+    thumbnails: ThumbnailsStore;
+    account: AccountStore;
+    notification: NotificationService;
+    auth: Auth;
+    api: Api<IApi> & IApi;
+}
+
 /**
  * @alpha
  */
@@ -286,7 +272,7 @@ declare class Camera {
     get supportsWebRTC(): boolean;
     constructor(raw: RawCamera);
     update: (raw: RawCamera) => void;
-    can: (permission: CameraPermissions) => number;
+    can: (permission: CameraPermissions) => boolean;
 }
 
 declare interface CameraAddress {
@@ -379,44 +365,6 @@ declare interface ChunksQuery {
     to: Date;
 }
 
-declare class Clip {
-    id: number;
-    cameraId: number;
-    name: string;
-    startTime: Date;
-    endTime: Date;
-    type: 'Archive' | 'Timelaps' | 'Timelaps to do';
-    createdAt: Date;
-    /**
-     * clip duration in seconds
-     */
-    duration: number;
-    chunks: ArchiveChunk[];
-    clipUrl?: string;
-    description: string;
-    version: string;
-    raw: RawClip;
-    isDownloading: boolean;
-    archives?: ArchiveChunk[];
-    constructor(raw: RawClip);
-    get isTimelapse(): boolean;
-    update(raw: RawClip): void;
-}
-
-declare interface ClipParams {
-    cameraId: number;
-    startTime: Date;
-    endTime: Date;
-    name: string;
-    description?: string;
-}
-
-declare interface ClipsQuery {
-    cameraId: number;
-    from: Date;
-    to: Date;
-}
-
 declare interface Connection {
     state: CONNECTION_STATE;
     stop: () => void;
@@ -430,7 +378,7 @@ declare interface Connection {
     proxies: {
         [P in keyof typeof FULL_API_CONFIG]: {
             on: (eventName: string, callback: (data: any) => void) => void;
-            invoke: any;
+            invoke: (...params: unknown[]) => any;
         };
     };
     createHubProxy: (hubName: string) => void;
@@ -463,8 +411,8 @@ declare type DetectedObject = Car | LicensePlate | {
 };
 
 declare interface DetectedObjectOption {
-    id: string;
-    name: string;
+    value: string;
+    label: string;
     color: string;
     highlightColor: string;
     type: 'detectedObject';
@@ -488,7 +436,7 @@ declare class EventSchemaStore extends ApiStore {
     dispose(): void;
 }
 
-declare const EventSearch: React_2.FC<Props>;
+declare const EventSearch: React.FC<Props>;
 export default EventSearch;
 
 declare class EventSearchStore extends ApiStore {
@@ -497,7 +445,6 @@ declare class EventSearchStore extends ApiStore {
     private account;
     private notification;
     private heatmaps?;
-    api: ExtendedApi;
     disposables: (IReactionDisposer | Subscription)[];
     readonly analyticsEnabled: boolean;
     cameraId: number | null;
@@ -560,7 +507,6 @@ declare class EventSearchStore extends ApiStore {
         Bottom: number;
     };
     afterInit(): void;
-    dispose(): void;
 }
 
 declare class EventsLoader extends ApiStore {
@@ -581,7 +527,7 @@ declare class EventsLoader extends ApiStore {
     }[];
     liveUpdateMode: 'manual' | 'auto' | 'disabled';
     disposables: (IReactionDisposer | Subscription)[];
-    pageInfo: PageInfo_2 | null;
+    pageInfo: PageInfo | null;
     loading: boolean;
     loadMoreTrigger: number;
     retryTrigger: number;
@@ -593,7 +539,7 @@ declare class EventsLoader extends ApiStore {
         objectIdx: number;
     }[]);
     flushUpdates: () => void;
-    setLiveUpdateMode: (mode: 'manual' | 'auto' | 'disabled') => void;
+    setLiveUpdateMode: (mode: "manual" | "auto" | "disabled") => void;
     load: () => void;
     reload: () => void;
     loadMore: () => void;
@@ -643,7 +589,6 @@ declare class EventsStore extends ApiStore {
     eventsByType: crossfilter.Dimension<CameraEvent, EventType>;
     eventsByFoundObjects: crossfilter.Dimension<CameraEvent, string>;
     eventsByColor: crossfilter.Dimension<CameraEvent, string>;
-    eventsByLiveliness: crossfilter.Dimension<CameraEvent, boolean>;
     pendingRequests: crossfilter.Crossfilter<PendingRequest>;
     pendingRequestsByEnd: crossfilter.Dimension<PendingRequest, number>;
     pendingRequestsByStart: crossfilter.Dimension<PendingRequest, number>;
@@ -654,6 +599,7 @@ declare class EventsStore extends ApiStore {
     knownIntervalsByEnd: crossfilter.Dimension<Interval, number>;
     eventsById: Map<number, CameraEvent>;
     updates: number;
+    updatesByCameraId: Map<number, number>;
     /**
      * Contains recent additions to the store as list of event ids
      * NOTE: do not update several times in single action as we lose info about intermediate additions that way
@@ -688,6 +634,7 @@ declare class EventsStore extends ApiStore {
             misc: boolean;
         };
     }): CameraEvent;
+    getRunningEvent(cameraId: number): CameraEvent | undefined;
     getFirstNonAnalyticEventAfter({ cameraId, date }: {
         cameraId: number;
         date: Date;
@@ -710,12 +657,6 @@ declare class EventsStore extends ApiStore {
 
 declare type EventType = 'Motion' | 'Tampering' | 'PanTiltZoom' | 'CrossLine' | 'Intrusion' | 'LicensePlate' | 'FaceDetection' | 'Audio' | 'Analytic' | 'SpeedDetection' | 'PeopleCounter' | 'Temperature' | 'PoS' | 'GPS' | 'DigitalInput' | 'Normal' | 'Suspicious' | 'Loitering' | 'Vandalism' | 'Trespass' | 'Emergency' | 'LifeInDanger' | 'ErroneousAlert' | 'Misidentification' | 'Fire' | 'MedicalDuress' | 'HoldUp' | 'CheckIn' | 'CheckOut' | 'ClockIn' | 'ClockOut' | 'ParkingStart' | 'ParkingEnd' | 'ParkingViolation' | 'GateAccess' | 'DoorAccess' | 'TemperatureCheck' | 'IDCheck' | 'PPECheck' | 'WelfareCheck' | 'VehicleBreakIn' | 'DrugTrafficking' | 'Assault' | 'PackageDelivery' | 'Uncategorized';
 
-declare type ExtendedApi = Api<IApi> & IApi & {
-    archives: {
-        GetLongLastingTimeLaps: (cameraId: number) => Observable<any>;
-    };
-};
-
 declare type ExtractHubs<T, K> = {
     [P in keyof ExtractMethods<T, K>]: ExtractMethods<T[P], K[P]>;
 };
@@ -822,7 +763,7 @@ declare interface IApi {
         UpdateCamgroup: (params: any) => Observable<ApiResult<RawCamgroup>>;
     };
     sound: {
-        GetPushSoundServiceUrl: (id: number) => Observable<any>;
+        GetPushSoundServiceUrl: (id: number) => Observable<ApiResult<string>>;
     };
     thumbnails: {
         GetThumbnailsInfo: (params: {
@@ -854,6 +795,7 @@ declare interface InitParams {
         widgetId: string;
         widgetToken: string;
     };
+    clientId?: string;
     tokenStorage?: Storage_2;
     tokenStorageKey?: string;
     apiUrl?: string;
@@ -874,51 +816,20 @@ declare type IntervalState = {
     request: Observable<Thumbnail[]>;
 };
 
-declare class LibraryStore extends ApiStore {
-    private notification?;
-    data: crossfilter.Crossfilter<Clip>;
-    clipsByCameraId: crossfilter.Dimension<Clip, number>;
-    clipsByCreationDate: crossfilter.Dimension<Clip, number>;
-    clipsByStart: crossfilter.Dimension<Clip, number>;
-    clipsByEnd: crossfilter.Dimension<Clip, number>;
-    clipsByType: crossfilter.Dimension<Clip, string>;
-    clipsById: crossfilter.Dimension<Clip, number>;
-    clipsMap: Map<number, Clip>;
-    loaded: boolean;
-    loading: boolean;
-    updates: number;
-    constructor(notification?: NotificationService | undefined);
-    /**
-     * Fetches all clips from the server and updates the store
-     */
-    fetch(): Observable<Clip[]>;
-    add: (clips: Clip[]) => void;
-    addOrUpdate: (clips: Clip[]) => void;
-    removeFromStore: (clips: {
-        id: number;
-    }[]) => void;
-    getClips({ cameraId, from, to }: ClipsQuery): Clip[];
-    getTimelapses(): Clip[];
-    getRecentlyAdded(): Clip[];
-    all(): Clip[];
-    getOnly(type: 'clips' | 'timelapses' | null, sortDirection?: 'asc' | 'desc'): Clip[];
-    createClip: (data: ClipParams) => void;
-    createTimelapse: (data: TimelapseParams) => void;
-    rename(clip: Clip, name: string): void;
-    delete(clip: Clip): void;
-    protected afterInit(): void;
-    dispose(): void;
-}
-
 declare interface LicensePlate {
     Type: 'LicensePlate';
     Value: string;
-    Number: string;
     ParentIndex: number;
     Box: BoundingBox;
     Probability: number;
 }
 
+declare enum LOG_LEVEL {
+    INFO = 0,
+    WARN = 1,
+    ERROR = 2
+}
+
 declare interface NotificationOptions_2 {
     duration: number;
 }
@@ -961,12 +872,6 @@ declare interface PageInfo {
     haveMore: boolean;
 }
 
-declare interface PageInfo_2 {
-    isDescending: boolean;
-    nextPageToken: number;
-    haveMore: boolean;
-}
-
 declare type PartialApi = DeepPartial<IApi>;
 
 declare type PartialExcept<T, K extends keyof T> = Pick<T, K> & Partial<T>;
@@ -986,20 +891,11 @@ declare interface PendingRequest_2 {
     request: Observable<Thumbnail[]>;
 }
 
-declare enum PREFERENCES {
-    DEFAULT_VIDEO_RESIZE_MODE = "defaultVideoResizeMode",
-    RESIZE_MODE_PER_CAMERA = "camerasResizeMode",
-    FISHEYE_CAMERAS = "fisheyeCameras",
-    UTC = "utc",
-    HOUR12 = "hour12",
-    START_OF_WEEK = "startOfWeek"
-}
-
 declare type Preferences = z.infer<typeof preferencesSchema>;
 
 declare const preferencesSchema: z.ZodObject<{
-    defaultVideoResizeMode: z.ZodOptional<z.ZodNativeEnum<typeof VideoResizeMode>>;
-    camerasResizeMode: z.ZodOptional<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNativeEnum<typeof VideoResizeMode>], null>, "many">>;
+    defaultVideoResizeMode: z.ZodOptional<z.ZodEnum<["fill", "contain"]>>;
+    camerasResizeMode: z.ZodOptional<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodEnum<["fill", "contain"]>], null>, "many">>;
     fisheyeCameras: z.ZodOptional<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodUnion<[z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber], null>, z.ZodObject<{
         params: z.ZodObject<{
             x: z.ZodNumber;
@@ -1009,13 +905,13 @@ declare const preferencesSchema: z.ZodObject<{
         }, "strip", z.ZodTypeAny, {
             x: number;
             y: number;
-            r: number;
             s: number;
+            r: number;
         }, {
             x: number;
             y: number;
-            r: number;
             s: number;
+            r: number;
         }>;
         positions: z.ZodOptional<z.ZodTuple<[z.ZodObject<{
             lat: z.ZodNumber;
@@ -1058,8 +954,8 @@ declare const preferencesSchema: z.ZodObject<{
         params: {
             x: number;
             y: number;
-            r: number;
             s: number;
+            r: number;
         };
         positions?: [{
             lat: number;
@@ -1078,8 +974,8 @@ declare const preferencesSchema: z.ZodObject<{
         params: {
             x: number;
             y: number;
-            r: number;
             s: number;
+            r: number;
         };
         positions?: [{
             lat: number;
@@ -1102,14 +998,14 @@ declare const preferencesSchema: z.ZodObject<{
     utc: boolean;
     hour12: boolean;
     startOfWeek: "monday" | "sunday";
-    defaultVideoResizeMode?: VideoResizeMode | undefined;
-    camerasResizeMode?: [number, VideoResizeMode][] | undefined;
-    fisheyeCameras?: [number, [number, number, number] | {
+    defaultVideoResizeMode?: "contain" | "fill" | undefined;
+    camerasResizeMode?: [number, "contain" | "fill"][] | undefined;
+    fisheyeCameras?: [number, {
         params: {
             x: number;
             y: number;
-            r: number;
             s: number;
+            r: number;
         };
         positions?: [{
             lat: number;
@@ -1124,16 +1020,16 @@ declare const preferencesSchema: z.ZodObject<{
             lon: number;
             fov: number;
         }] | undefined;
-    } | null][] | undefined;
+    } | [number, number, number] | null][] | undefined;
 }, {
-    defaultVideoResizeMode?: VideoResizeMode | undefined;
-    camerasResizeMode?: [number, VideoResizeMode][] | undefined;
-    fisheyeCameras?: [number, [number, number, number] | {
+    defaultVideoResizeMode?: "contain" | "fill" | undefined;
+    camerasResizeMode?: [number, "contain" | "fill"][] | undefined;
+    fisheyeCameras?: [number, {
         params: {
             x: number;
             y: number;
-            r: number;
             s: number;
+            r: number;
         };
         positions?: [{
             lat: number;
@@ -1148,7 +1044,7 @@ declare const preferencesSchema: z.ZodObject<{
             lon: number;
             fov: number;
         }] | undefined;
-    } | null][] | undefined;
+    } | [number, number, number] | null][] | undefined;
     utc?: boolean | undefined;
     hour12?: boolean | undefined;
     startOfWeek?: "monday" | "sunday" | undefined;
@@ -1384,21 +1280,21 @@ declare interface SensorEventsRequest {
 }
 
 declare enum SensorEventType {
-    Motion = 0,
-    Tampering = 1,
-    PanTiltZoom = 2,
-    CrossLine = 3,
-    Intrusion = 4,
-    LicensePlate = 5,
-    FaceDetection = 6,
-    Audio = 7,
-    Analytic = 8,
-    SpeedDetection = 9,
-    PeopleCounter = 10,
-    Temperature = 11,
-    PoS = 12,
-    GPS = 13,
-    DigitalInput = 14,
+    Motion = 0,// Has duration
+    Tampering = 1,// Has duration
+    PanTiltZoom = 2,// Has duration
+    CrossLine = 3,// Has duration
+    Intrusion = 4,// Has duration
+    LicensePlate = 5,// Instant
+    FaceDetection = 6,// Instant
+    Audio = 7,// Has duration
+    Analytic = 8,// Instant, has data
+    SpeedDetection = 9,// Instant, has data
+    PeopleCounter = 10,// Instant, has data
+    Temperature = 11,// Instant, has data
+    PoS = 12,// Instant, ? has data. Point of Sale transaction event
+    GPS = 13,// Instant, has data. GPS coordinates event
+    DigitalInput = 14,// Instant
     Normal = 15,
     Suspicious = 16,
     Loitering = 17,
@@ -1480,10 +1376,6 @@ declare class ThumbnailsStore extends ApiStore {
     }) => Thumbnail;
 }
 
-declare type TimelapseParams = ClipParams & {
-    duration: number;
-};
-
 declare class Token {
     accessToken: string;
     accessTokenExpires: Date;
@@ -1502,7 +1394,7 @@ declare class Token {
     constructor(raw: RawToken);
 }
 
-declare class ToolkitApp {
+declare class ToolkitApp implements App {
     readonly name: string;
     initialized: boolean;
     cameras: CamerasStore;
@@ -1512,13 +1404,12 @@ declare class ToolkitApp {
     thumbnails: ThumbnailsStore;
     account: AccountStore;
     notification: NotificationService;
-    library: LibraryStore;
     auth: Auth;
     api: Api<IApi> & IApi;
     private disposables;
     private tokenUpdateReactions;
     constructor(name: string);
-    init({ token, tokenStorage: storage, tokenStorageKey, apiUrl, tokenServiceUrl }: InitParams, name?: string): ToolkitApp;
+    init({ clientId, token, tokenStorage: storage, tokenStorageKey, apiUrl, tokenServiceUrl }: InitParams, name?: string): ToolkitApp;
     dispose: () => void;
     /**
      * Adds a reaction to token changes
@@ -1531,9 +1422,4 @@ declare class ToolkitApp {
 
 declare type User = RawUser;
 
-declare enum VideoResizeMode {
-    Fit = "contain",
-    Stretch = "fill"
-}
-
 export { }