@evercam/api 1.0.0-c55f6a67c → 1.0.0-c5a9f7fda

package/dist/api/types/siteAnalytics.d.ts

@@ -0,0 +1,297 @@
+import { BBox, BoundingBox, DateType, Schedule, ScheduleLowercase, CameraExid, DetectionModel, PaginationParams, PpeLabel, ProjectExid, CameraDateRangeFilter, CameraFeatureFlag, TimelineDateInterval, Camera, AdminCamera, _360FloorV2, _360FloorId, PaginatedItems, DateRangeFilter } from "@evercam/api/types";
+import { DetectionLabel, DownloadFileType } from "@evercam/api/types";
+export declare enum SiteAnalyticsMode {
+    Detections = "detections",
+    Segments = "segments"
+}
+export type SmartSearchObjectPart = {
+    id?: string;
+    type: SmartSearchComponentType.Object;
+    value: DetectionLabel;
+};
+export type SmartSearchOperatorPart = {
+    id?: string;
+    type: SmartSearchComponentType.Operator;
+    value: SmartSearchOperatorType;
+};
+export type SmartSearchConditionPart = {
+    id?: string;
+    type: SmartSearchComponentType.Condition;
+    value: SmartSearchCondition | SmartSearchConditionData;
+};
+export type SmartSearchViewPart = {
+    id?: string;
+    type: SmartSearchComponentType.View;
+    value: SiteAnalyticsView;
+};
+export type SmartSearchAreaPart = {
+    id?: string;
+    type: SmartSearchComponentType.Area;
+    value: BBox;
+};
+export type SmartSearchTimePart = {
+    id?: string;
+    type: SmartSearchComponentType.Time;
+    value: Schedule | ScheduleLowercase;
+};
+export type SmartSearchDateRangePart = {
+    id?: string;
+    type: SmartSearchComponentType.DateRange;
+    value: DateRangeFilter;
+};
+export type SmartSearchPart = SmartSearchObjectPart | SmartSearchOperatorPart | SmartSearchConditionPart | SmartSearchViewPart | SmartSearchAreaPart | SmartSearchTimePart | SmartSearchDateRangePart;
+export type SmartSearchPartOrGroup = SmartSearchPart | SmartSearchPart[];
+export declare enum SmartSearchComponentType {
+    Condition = "condition",
+    Object = "object",
+    Area = "in_area",
+    Time = "time",
+    Operator = "operator",
+    View = "view",
+    DateRange = "date_range",
+    Heatmap = "heatmap"
+}
+export type SmartSearchPartType = SmartSearchComponentType | SmartSearchCondition;
+export type SmartSearchComponentData = {
+    id: string;
+    type: SmartSearchComponentType;
+    parts: SmartSearchPartOrGroup[];
+};
+export declare enum SmartSearchCondition {
+    InArea = "in_area",
+    Intersects = "intersects",
+    Time = "time"
+}
+export type SmartSearchConditionData = {
+    condition: SmartSearchCondition;
+    value: string | BoundingBox | DetectionLabel | Date;
+};
+type SmartSearchBackendConditionBase = {
+    target: SmartSearchTargets;
+};
+export type SmartSearchSelectionCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.Selection;
+    operator: SmartSearchOperators;
+    attribute: string;
+    value: string | number | string[];
+};
+export type SmartSearchSpatialCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.Spatial;
+    operator: SmartSearchOperators;
+    reference: {
+        target: SmartSearchTargets;
+        attribute: string;
+        value: string | number | string[];
+    };
+};
+export type SmartSearchAreaCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.Area;
+    operator: SmartSearchOperators;
+    polygon: BBox;
+};
+export type SmartSearchGeoAreaCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.GeoArea;
+    operator: SmartSearchOperators;
+    polygon: BBox;
+};
+export type SmartSearchBackendQueryCondition = SmartSearchSelectionCondition | SmartSearchSpatialCondition | SmartSearchAreaCondition | SmartSearchGeoAreaCondition;
+export type SmartSearchBackendQuery = {
+    returnTargets: SmartSearchTargets[];
+    rulesLogic: SmartSearchOperatorType;
+    rules: {
+        logic: SmartSearchOperatorType;
+        conditions: SmartSearchBackendQueryCondition[];
+    }[];
+    returnType: SmartSearchReturnType;
+};
+export declare enum SmartSearchTargets {
+    Tracking = "tracking",
+    Segments = "segments"
+}
+export declare enum SmartSearchReturnType {
+    All = "all",
+    FirstLastSeen = "first_last_seen"
+}
+export declare enum SmartSearchOperatorType {
+    And = "AND",
+    Or = "OR"
+}
+export declare enum SmartSearchOperators {
+    Near = "near",
+    Far = "far",
+    Intersects = "intersects",
+    DoesNotIntersect = "does_not_intersect",
+    Inside = "inside",
+    Outside = "outside",
+    DistanceBelow = "distance_below",
+    DistanceAbove = "distance_above",
+    Area = "in_area",
+    Equal = "="
+}
+export declare enum SmartSearchConditionTypes {
+    Selection = "selection",
+    Spatial = "spatial",
+    Area = "area",
+    GeoArea = "in_geo_area",
+    Iou = "iou",
+    Near = "near",
+    Far = "far"
+}
+export type SmartSearchOptionValue = DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData | DateRangeFilter | SiteAnalyticsView;
+export type SmartSearchBackendQueryPayload = {
+    cameraExid: string;
+    name: string;
+    description: string;
+    query: {
+        req: SmartSearchBackendQuery;
+        timeSchedule?: Schedule | undefined;
+    };
+    fromDate?: DateType;
+    toDate?: DateType;
+    author: string;
+    createdAt: DateType;
+    params?: {
+        start: string;
+        end: string;
+    };
+};
+export type SavedQuery = {
+    description: string;
+    id: number;
+    query: {
+        req: SmartSearchBackendQuery;
+        timeSchedule?: Schedule | undefined;
+    };
+    params: Record<string, string>;
+    components?: Omit<SmartSearchPart, "id">[];
+    toDate?: DateType;
+    createdAt?: DateType;
+    cameraExid: string;
+    name: string;
+    fromDate?: DateType;
+    author?: string;
+};
+export type DetectionsRequestParams = {
+    projectExid: ProjectExid;
+    cameraExids: CameraExid[];
+    fromDate?: string;
+    toDate?: string;
+    labels?: Array<DetectionLabel | PpeLabel>;
+    modelId?: DetectionModel;
+    trackId?: number;
+    thresholds?: string[];
+    excludeLabels?: Array<DetectionLabel | PpeLabel>;
+    mergedClasses?: Array<string>;
+    confidenceThreshold?: number;
+} & PaginationParams;
+export type DetectionsExportRequestParams = DetectionsRequestParams & {
+    fileType: DownloadFileType;
+    columns?: string[];
+    directDownload?: boolean;
+};
+export type SmartSearchHeatmapPoint = {
+    coordinates: [number, number];
+    detectionsCount: number;
+};
+export type SmartSearchHeatmapData = {
+    label: string;
+    points: SmartSearchHeatmapPoint[];
+};
+export type SmartSearchNearConfig = {
+    sourceLabels: DetectionLabel[];
+    targetLabel?: DetectionLabel;
+};
+export type HeatmapIntersectionsRequestParams = CameraDateRangeFilter & SmartSearchNearConfig;
+export type SmartSearchSidebarItem = {
+    key: string;
+    displayLabel: string;
+    data: SmartSearchHeatmapData;
+    imagePath?: string;
+};
+export declare enum SiteAnalyticsViewType {
+    Camera = "camera",
+    ThreeSixty = "360"
+}
+export type SiteAnalyticsCameraView = {
+    type: SiteAnalyticsViewType.Camera;
+    id: CameraExid;
+    value: Camera | AdminCamera;
+};
+export type SiteAnalytics360View = {
+    type: SiteAnalyticsViewType.ThreeSixty;
+    id: _360FloorId;
+    value: _360FloorV2;
+};
+export type SiteAnalyticsView = SiteAnalyticsCameraView | SiteAnalytics360View;
+export type SiteAnalyticsProcessingStatusPayload = {
+    projectExid?: ProjectExid;
+    fromDate?: DateType;
+    toDate?: DateType;
+    cameraExid?: CameraExid;
+    drawingId?: string;
+    features?: CameraFeatureFlag[];
+};
+export type SiteAnalyticsProcessingStatus = {
+    projectExid: ProjectExid;
+    viewType: SiteAnalyticsViewType;
+    viewId: string;
+    feature: CameraFeatureFlag;
+    processedIntervals: TimelineDateInterval[];
+};
+export type SmartSearchRequestPayload = {
+    cameraExids?: CameraExid[];
+    drawingIds?: _360FloorId[];
+    walkIds?: string[];
+    markerIds?: string[];
+    payload: SmartSearchBackendQuery;
+    fromDate?: string;
+    toDate?: string;
+    page?: number;
+    pageSize?: number;
+    threshold?: number;
+};
+type SmartSearchResultItemBase = {
+    area: number;
+    bbox: BBox;
+    cameraExid?: CameraExid;
+    centroid: number[];
+    confidenceScore: number;
+    drawingId?: _360FloorId;
+    label: DetectionLabel;
+    modelId: DetectionModel;
+    projectExid: ProjectExid;
+    segmentId?: number;
+    trackId: number;
+    walkId?: string | number;
+};
+export type SmartSearchResultItemFirstLastSeen = SmartSearchResultItemBase & {
+    firstSeen: DateType;
+    firstSeenMarkerId?: string | number;
+    lastSeen: DateType;
+    lastSeenMarkerId?: string | number;
+};
+export type SmartSearchResultItemAll = SmartSearchResultItemBase & {
+    walkId?: string | number;
+    markerId?: string | number;
+    geolocation?: number[];
+    mask?: number[][];
+    timestamp: DateType;
+};
+type SmartSearchResultItemByType = {
+    [SmartSearchReturnType.FirstLastSeen]: SmartSearchResultItemFirstLastSeen;
+    [SmartSearchReturnType.All]: SmartSearchResultItemAll;
+};
+export type SmartSearchResponse<R extends SmartSearchReturnType = SmartSearchReturnType.FirstLastSeen> = {
+    data: PaginatedItems<SmartSearchResultItemByType[R]>;
+    message?: string;
+    success: boolean;
+};
+export type SmartSearchMinifiedPart = {
+    t: SmartSearchComponentType;
+    v: unknown;
+};
+export type SmartSearchMinifiedComponent = {
+    t: SmartSearchComponentType;
+    p: SmartSearchMinifiedPart[];
+};
+export {};

package/dist/{types → api/types}/snapshots.d.ts

@@ -1,4 +1,4 @@
-import { CameraExid, DateType, PaginationParams, Schedule } from "@/types";
+import { CameraExid, DateType, PaginationParams, Schedule } from "@evercam/api/types";
 export type SnapshotExtractionQyeryParams = PaginationParams & {
     camera: string;
     cameraExid: CameraExid;
@@ -48,3 +48,12 @@ export type DeleteSnapshotQueryParams = {
     adminEmail: string;
     adminFullname: string;
 };
+export type TransferCloudRecordingsQueryParams = {
+    targetCameraExid: CameraExid;
+    fromDate: DateType;
+    toDate: DateType;
+    overwriteExistingSnapshots?: boolean;
+    keepSourceSnapshots?: boolean;
+    adminEmail?: string;
+    adminFullname?: string;
+};

package/dist/api/types/sso.d.ts

@@ -0,0 +1,55 @@
+export type SsoProvider = {
+    id: number;
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};
+export type SsoUpdatePayload = {
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};
+export type SsoCreatePayload = {
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};

package/dist/api/types/storyblok.d.ts

@@ -0,0 +1,40 @@
+import type { JsonObject, JsonValue } from "@evercam/api/types";
+export type StoryblokAsset = {
+    id: number | null;
+    alt: string | null;
+    name: string;
+    focus: string | null;
+    title: string | null;
+    filename: string;
+    copyright: string | null;
+    fieldtype: "asset";
+    source?: string;
+    metaData?: JsonObject;
+    isExternalUrl?: boolean;
+};
+export type StoryblokStory<TContent extends JsonObject = JsonObject> = {
+    id: number;
+    uuid: string;
+    name: string;
+    slug: string;
+    fullSlug: string;
+    content: TContent;
+    createdAt: string;
+    publishedAt: string | null;
+    updatedAt: string;
+    position: number;
+    tagList: string[];
+    isStartpage: boolean;
+    parentId: number | null;
+    groupId: string;
+    firstPublishedAt: string | null;
+    releaseId: number | null;
+    lang: string;
+    path: string;
+};
+export type StoryblokResponse<TContent extends JsonObject = JsonObject> = {
+    story: StoryblokStory<TContent>;
+    cv: number;
+    rels: JsonValue[];
+    links: JsonValue[];
+};

package/dist/{types → api/types}/streaming.d.ts

@@ -1,11 +1,11 @@
-import { DateTime_Z_micros, KitMetricData } from "@/types";
+import { KitMetricData } from "@evercam/api/types";
 export type ExNvrLoginResponse = {
     accessToken: string;
 };
 export type ExNvrRecordingInterval = {
     active: boolean;
-    startDate: DateTime_Z_micros;
-    endDate: DateTime_Z_micros;
+    startDate: string;
+    endDate: string;
 };
 export type ExNvrDeviceConfig = {
     id: string;
@@ -39,8 +39,7 @@ export type ExNvrDeviceConfig = {
     timezone: string;
 };
 export declare enum ExNvrFootageAvailableStatus {
-    Active = "Active",
-    NotActive = "Not Active",
+    Available = "Available",
     NotAvailable = "Not Available"
 }
 export declare enum ExNvrDeviceState {

package/dist/{types → api/types}/tag.d.ts

@@ -1,4 +1,4 @@
-import { Kit } from "@/types/kit";
+import { Kit } from "@evercam/api/types/kit";
 export type Tag<T = string> = {
     id?: number;
     name: T;

package/dist/api/types/time.d.ts

@@ -0,0 +1,7 @@
+import { Moment } from "moment-timezone";
+export type DateType = Date | string | number;
+export type ExtendedDateType = Moment | DateType;
+export type DateRangeFilter = {
+    fromDate: DateType;
+    toDate: DateType;
+};

package/dist/{types → api/types}/timelapse.d.ts

@@ -1,4 +1,4 @@
-import { DateType, Schedule } from "@/types";
+import { DateType, Schedule } from "@evercam/api/types";
 export declare enum TimelapseStatus {
     Pending = 11,
     Completed = 5,
@@ -24,13 +24,12 @@ export type TimestampPositionCoordinates = {
     h: number;
 };
 export type TimelapseLogoOptions = {
-    id: number;
+    id?: number;
     x: number;
     y: number;
     width: number;
     height: number;
 };
-export type TimelapseSchedules = string | Schedule;
 export declare enum TimelapseScheduleType {
     Continuous = "continuous",
     WorkingHours = "workingHours",
@@ -56,7 +55,7 @@ export type TimelapseFilterQueryParams = {
     to?: DateType;
     period?: TimelapsePeriod;
     duration?: number;
-    schedule?: TimelapseSchedules;
+    schedule?: Schedule;
 };
 export type TimelapseCreationRequestPayload = {
     title: string;

package/dist/{types → api/types}/user.d.ts

@@ -1,4 +1,5 @@
-import type { DateTime, PaginationParams } from "@/types";
+import type { CameraExid, PaginationParams } from "@evercam/api/types";
+import { Role, RoleSubRole } from "@evercam/api/types/authz";
 export type User = {
     id?: number;
     fullname?: string;
@@ -9,10 +10,16 @@ export type User = {
     country: string;
     isAdmin: boolean;
     persona: Persona;
-    companyId?: string;
+    companyId?: string | number;
     companyName?: string;
     companyExid?: string;
     features?: Array<UserFeatureFlag>;
+    confirmedAt?: string;
+    createdAt?: string;
+    lastLoginAt?: string;
+    token?: string;
+    updatedAt?: string;
+    evercamAccount?: boolean;
 };
 export type AdminUser = {
     id: number;
@@ -32,14 +39,9 @@ export type AdminUser = {
     camerasOwned: number;
     countryId: number;
     countryName: string;
-    createdAt: DateTime;
+    createdAt: string;
     integrations: string[];
-    lastEventBrowser: string;
-    lastEvenCreatedAt: DateTime;
-    lastEventId: number;
-    lastEventIpAddress: string;
-    lastEventName: string;
-    lastEventOs: string;
+    lastSeenAt: string;
     lastLoginAt: string;
     lastname: string;
     persona: string;
@@ -64,6 +66,10 @@ export type ProjectUser = User & {
     cameraExid: string;
     cameraRights: string;
 };
+export declare enum ContactRole {
+    SalesExecutive = "Sales Executive",
+    CustomerSuccessManager = "Customer Success Manager"
+}
 export declare enum Persona {
     HQ = "HQ",
     PM = "PM",
@@ -90,26 +96,44 @@ export type RemotePasswordUpdateRequestPayload = {
     currentPassword: string;
     newPassword: string;
 };
-export type LoginResponsePayload = {
-    confirmedAt?: string;
-    country?: string;
-    createdAt?: string;
-    email?: string;
-    firstname?: string;
-    id?: string;
-    isAdmin?: boolean;
-    lastLoginAt?: string;
-    lastname?: string;
-    persona?: Persona;
-    telephone?: string;
-    token?: string;
-    updatedAt?: string;
-    evercamAccount?: string;
+export type AuthPasswordOption = {
+    type: "password";
+};
+export type AuthSsoOption = {
+    type: "sso";
+    name: string;
+    scope: string;
+    prompt: string | null;
+    exid: string;
+    clientId: string;
+    iconUrl: string;
+    loginUrl: string;
+    responseType: string;
+};
+export type AuthOption = AuthPasswordOption | AuthSsoOption;
+export type AuthOptionsResponsePayload = {
+    options: AuthOption[];
+};
+export type AuthProviderConfigPayload = {
+    name: string;
+    scope: string;
+    prompt: string | null;
+    exid: string;
+    clientId: string;
+    iconUrl: string;
+    loginUrl: string;
+    responseType: string;
 };
 export type LogoutParams = {
     token: string;
     fromAdmin?: boolean;
 };
+export type ConfirmUserRequestPayload = {
+    c: string;
+};
+export type DeleteActiveSessionRequestPayload = {
+    authorization: string;
+};
 export type UserSession = {
     browser: string;
     createdAt: string;
@@ -178,6 +202,16 @@ export type GoogleAuthRequestPayload = {
     code: string;
     redirectUri: string;
 };
+export type ProjectContact = {
+    name: string;
+    role: ContactRole | string;
+    email?: string;
+    phone?: string;
+    photo?: string;
+};
+export type ProjectContactsResponsePayload = {
+    data: ProjectContact[];
+};
 export type UserStatsResponse = {
     data: {
         userStats: AdminUser;
@@ -198,7 +232,7 @@ export type UserProject = {
     id: number;
     exid: string;
     name: string;
-    startedAt: DateTime;
+    startedAt: string;
 };
 export type UserProjectResponse = {
     data: UserProject[];
@@ -218,9 +252,9 @@ export type Admin = {
     id: number;
     fullname: string;
     email: string;
-    createdAt: DateTime;
-    updatedAt: DateTime;
-    lastSignInAt: DateTime;
+    createdAt: string;
+    updatedAt: string;
+    lastSignInAt: string;
     signInCount: number;
     lastSignInIp: string;
     apiId: string;
@@ -232,17 +266,17 @@ export type ImpersonateUserResponse = {
     lastname: string;
     telephone: string;
     email: string;
-    is_admin: boolean;
+    isAdmin: boolean;
     persona: Persona;
     country: string;
     companyId: number;
     companyExid: string;
     companyName: string;
     evercamAccount: boolean;
-    createdAt: DateTime;
-    updatedAt: DateTime;
-    confirmedAt: DateTime;
-    last_loginAt: DateTime;
+    createdAt: string;
+    updatedAt: string;
+    confirmedAt: string;
+    lastLoginAt: string;
     features: UserFeatureFlag[];
     token: string;
 };
@@ -271,6 +305,42 @@ export type Suppression = {
     id: number;
     email: string;
     source: string;
-    insertedAt: DateTime;
-    updatedAt: DateTime;
+    insertedAt: string;
+    updatedAt: string;
+};
+type Email = string;
+export type WsAccessRestrictionUpdate = {
+    camera_id: CameraExid;
+    is_access_restricted: boolean;
+};
+export type WsUserRestrictionItem = {
+    user_id: number;
+    camera_id: CameraExid;
+    is_user_access_restricted: boolean;
+};
+export type WsUserRestrictionUpdate = WsUserRestrictionItem[];
+/**
+ * Backend WebSocket event payload:
+ * {
+ *   user: {
+ *     "someone@domain.com": {camera_id, is_access_restricted} OR [{...}, {...}]
+ *   }
+ * }
+ */
+export type WsRestrictionChangedPayload = {
+    user: Record<Email, WsAccessRestrictionUpdate | WsUserRestrictionUpdate>;
+};
+export type ProjectUserWithRole = {
+    id: number;
+    email: string;
+    fullname: string;
+    company: {
+        id: number;
+        name: string;
+        exid: string;
+    };
+    permissions: string[];
+    role: Role;
+    subRoles: RoleSubRole[];
 };
+export {};