@evercam/api 1.0.0-a6868d86c → 1.0.0-a85cb7fae

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

@@ -1,14 +1,46 @@
-import { BBox, BoundingBox, DateType, Schedule, CameraExid, DateTime, DetectionModel, PaginationParams, PpeLabel, ProjectExid, CameraDateRangeFilter, CameraFeatureFlag, TimelineDateInterval, Camera, AdminCamera, _360FullProject, _360FloorId, PaginatedItems } from "@evercam/api/types";
+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 SmartSearchPart = {
+export type SmartSearchObjectPart = {
     id?: string;
-    type: SmartSearchPartType;
-    value: DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData | SmartSearchCondition | SmartSearchDateRange | 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",
@@ -20,14 +52,10 @@ export declare enum SmartSearchComponentType {
     Heatmap = "heatmap"
 }
 export type SmartSearchPartType = SmartSearchComponentType | SmartSearchCondition;
-export type SmartSearchDateRange = {
-    start: DateType;
-    end: DateType;
-};
 export type SmartSearchComponentData = {
     id: string;
     type: SmartSearchComponentType;
-    parts: SmartSearchPart[];
+    parts: SmartSearchPartOrGroup[];
 };
 export declare enum SmartSearchCondition {
     InArea = "in_area",
@@ -38,19 +66,35 @@ export type SmartSearchConditionData = {
     condition: SmartSearchCondition;
     value: string | BoundingBox | DetectionLabel | Date;
 };
-export type SmartSearchBackendQueryCondition = {
-    type: SmartSearchConditionTypes;
+type SmartSearchBackendConditionBase = {
     target: SmartSearchTargets;
-    operator?: SmartSearchOperators;
-    attribute?: string;
+};
+export type SmartSearchSelectionCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.Selection;
+    operator: SmartSearchOperators;
+    attribute: string;
     value: string | number | string[];
-    reference?: {
+};
+export type SmartSearchSpatialCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.Spatial;
+    operator: SmartSearchOperators;
+    reference: {
         target: SmartSearchTargets;
         attribute: string;
         value: string | number | string[];
     };
-    polygon?: BBox;
 };
+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;
@@ -59,6 +103,7 @@ export type SmartSearchBackendQuery = {
         conditions: SmartSearchBackendQueryCondition[];
     }[];
     returnType: SmartSearchReturnType;
+    timeSchedule?: Schedule;
 };
 export declare enum SmartSearchTargets {
     Tracking = "tracking",
@@ -93,28 +138,24 @@ export declare enum SmartSearchConditionTypes {
     Near = "near",
     Far = "far"
 }
-export type SmartSearchOptionValue = DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData;
+export type SmartSearchOptionValue = DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData | DateRangeFilter | SiteAnalyticsView;
 export type SmartSearchBackendQueryPayload = {
-    cameraExid: string;
     name: string;
     description: string;
-    query: {
-        req: SmartSearchBackendQuery;
-        timeSchedule?: Schedule | undefined;
-    };
+    query: SmartSearchBackendQuery;
     fromDate?: DateType;
     toDate?: DateType;
     author: string;
     createdAt: DateType;
-    params?: Record<string, unknown>;
+    params?: {
+        start: string;
+        end: string;
+    };
 };
 export type SavedQuery = {
     description: string;
     id: number;
-    query: {
-        req: SmartSearchBackendQuery;
-        timeSchedule?: Schedule | undefined;
-    };
+    query: SmartSearchBackendQuery;
     params: Record<string, string>;
     components?: Omit<SmartSearchPart, "id">[];
     toDate?: DateType;
@@ -127,8 +168,8 @@ export type SavedQuery = {
 export type DetectionsRequestParams = {
     projectExid: ProjectExid;
     cameraExids: CameraExid[];
-    fromDate?: DateTime;
-    toDate?: DateTime;
+    fromDate?: string;
+    toDate?: string;
     labels?: Array<DetectionLabel | PpeLabel>;
     modelId?: DetectionModel;
     trackId?: number;
@@ -165,14 +206,17 @@ export declare enum SiteAnalyticsViewType {
     Camera = "camera",
     ThreeSixty = "360"
 }
-type SiteAnalyticsViewByType = {
-    [SiteAnalyticsViewType.Camera]: Camera | AdminCamera;
-    [SiteAnalyticsViewType.ThreeSixty]: _360FullProject;
+export type SiteAnalyticsCameraView = {
+    type: SiteAnalyticsViewType.Camera;
+    id: CameraExid;
+    value: Camera | AdminCamera;
 };
-export type SiteAnalyticsView<T extends SiteAnalyticsViewType = SiteAnalyticsViewType.Camera> = {
-    type: SiteAnalyticsViewType;
-    value: SiteAnalyticsViewByType[T];
+export type SiteAnalytics360View = {
+    type: SiteAnalyticsViewType.ThreeSixty;
+    id: _360FloorId;
+    value: _360FloorV2;
 };
+export type SiteAnalyticsView = SiteAnalyticsCameraView | SiteAnalytics360View;
 export type SiteAnalyticsProcessingStatusPayload = {
     projectExid?: ProjectExid;
     fromDate?: DateType;
@@ -231,11 +275,7 @@ 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 SmartSearchResponse<R extends SmartSearchReturnType = SmartSearchReturnType.FirstLastSeen> = PaginatedItems<SmartSearchResultItemByType[R]>;
 export type SmartSearchMinifiedPart = {
     t: SmartSearchComponentType;
     v: unknown;

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

@@ -0,0 +1,5 @@
+import { CameraExid } from "@evercam/api/types";
+export type SmartSearchQueriesRequestPayload = {
+    camerasExid: CameraExid[];
+    name?: string;
+};

package/dist/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,12 +48,44 @@ export type DeleteSnapshotQueryParams = {
     adminEmail: string;
     adminFullname: string;
 };
-export type TransferCloudRecordingsQueryParams = {
+export type SnapshotTransfer = {
+    id: number;
+    sourceCamera: SnapshotTransferCamera;
+    targetCamera: SnapshotTransferCamera;
+    fromDate: DateType;
+    toDate: DateType;
+    overwriteExisting?: boolean | null;
+    deleteSource?: boolean | null;
+    requestor: SnapshotTransferRequestor;
+    status: SnapshotTransferStatus;
+    insertedAt: DateType;
+    attempts?: number | null;
+    errorMessage?: string | null;
+    snapshotsTransferred?: number | null;
+};
+export type SnapshotTransferCamera = {
+    id: number;
+    exid: CameraExid;
+    name: string;
+};
+export type SnapshotTransferRequestor = {
+    email: string;
+    firstname: string;
+    lastname: string;
+};
+export declare enum SnapshotTransferStatus {
+    Completed = "completed",
+    Failed = "failed",
+    Processing = "processing",
+    Pending = "pending",
+    Cancelled = "cancelled"
+}
+export type TransferCloudRecordingsQueryParams = PaginationParams & {
     targetCameraExid: CameraExid;
     fromDate: DateType;
     toDate: DateType;
-    overwriteExistingSnapshots?: boolean;
-    keepSourceSnapshots?: boolean;
+    overwriteExisting?: boolean;
+    deleteSource?: boolean;
     adminEmail?: string;
     adminFullname?: string;
 };

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

@@ -0,0 +1,19 @@
+import type { DateType } from "@evercam/api/types";
+export type StorageProvider = {
+    id?: number;
+    cameraId: number;
+    type: string;
+    provider: string;
+    url: string;
+    startDate: DateType;
+    endDate: DateType;
+    config: Record<string, any>;
+    insertedAt?: DateType;
+};
+export type StorageProvidersResponsePayload = {
+    providers: StorageProvider[];
+};
+export declare enum ProjectStorageProvider {
+    Seaweedfs = "seaweedfs",
+    S3 = "s3"
+}

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/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;

package/dist/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

@@ -1,25 +1,7 @@
 import { Moment } from "moment-timezone";
 export type DateType = Date | string | number;
 export type ExtendedDateType = Moment | DateType;
-type YYYY = number;
-type MM = number;
-type DD = number;
-type HH = number;
-type mm = number;
-type ss = number;
-type microS = number;
-export type Date_YYYY = `${YYYY}` | string;
-export type Date_YYYY_MM = `${YYYY}-${MM}` | string;
-export type Date_YYYY_MM_DD = `${YYYY}-${MM}-${DD}` | string;
-export type Time_HH_mm_ss = `${HH}:${mm}:${ss}` | string;
-export type Date_HH = `${HH}` | string;
-export type DateTime = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}` | string;
-export type DateTime_tz = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}${"+" | "-"}${HH}:${mm}` | string;
-export type DateTime_Z = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}Z` | string;
-export type DateTime_Z_micros = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}.${microS}Z` | string;
-export type DateTimeSpaceSeparated = `${Date_YYYY_MM_DD} ${Time_HH_mm_ss}` | string;
 export type DateRangeFilter = {
     fromDate: DateType;
     toDate: DateType;
 };
-export {};

package/dist/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/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,9 +39,9 @@ export type AdminUser = {
     camerasOwned: number;
     countryId: number;
     countryName: string;
-    createdAt: DateTime;
+    createdAt: string;
     integrations: string[];
-    lastSeenAt: DateTime;
+    lastSeenAt: string;
     lastLoginAt: string;
     lastname: string;
     persona: string;
@@ -48,7 +55,6 @@ export declare enum UserFeatureFlag {
     CompanyAdmin = "company-admin",
     VideoWalls = "video-walls",
     MassCameraSharing = "mass-camera-sharing",
-    Copilot = "copilot",
     ProjectSharing = "project-sharing"
 }
 export type ProjectUser = User & {
@@ -89,26 +95,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;
@@ -177,6 +201,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;
@@ -197,7 +231,7 @@ export type UserProject = {
     id: number;
     exid: string;
     name: string;
-    startedAt: DateTime;
+    startedAt: string;
 };
 export type UserProjectResponse = {
     data: UserProject[];
@@ -217,9 +251,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;
@@ -231,17 +265,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;
 };
@@ -270,6 +304,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 {};

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

@@ -1,25 +1,16 @@
-import { Camera, Media, PaginationParams } from "@/types";
+import { Camera, Media, PaginationParams } from "@evercam/api/types";
 export declare enum VideoWallItemType {
     LiveView = "live",
     Video = "video",
     Image = "image"
 }
-export type VideoWallItem<T extends Camera | Media> = {
+export type VideoWallItem<T extends Camera | Media = Camera> = {
     value: T;
     type: VideoWallItemType;
 };
-export type VideoWallPresetItemConfig = {
-    camera: Camera;
-    h: number;
-    i: string | number;
-    moved: boolean;
-    w: number;
-    x: number;
-    y: number;
-};
-export type VideoWallPreset = {
-    name?: string;
-    configuration: Array<VideoWallPresetItemConfig>;
+export type VideoWallPresetGridConfig = {
+    items: VideoWallPresetItem[];
+    meta?: VideoWallPresetMeta;
 };
 export type VideoWallPresetItem = {
     i: string | number;
@@ -30,6 +21,14 @@ export type VideoWallPresetItem = {
     camera: Camera;
     weather?: Record<string, unknown>;
     media?: Media;
+    moved?: boolean;
+};
+export type VideoWallPresetMeta = {
+    colNum: number;
+    rowCount: number;
+    tile: number;
+    template: string;
+    gridSize: number;
 };
 export type VideoWallSource = "default" | "widget";
 export interface VideoWall {
@@ -38,8 +37,8 @@ export interface VideoWall {
     name: string;
     source: VideoWallSource;
     config: Record<string, any>;
-    inserted_at: string;
-    updated_at: string;
+    insertedAt: string;
+    updatedAt: string;
     user: {
         id: number;
         firstname: string;
@@ -47,20 +46,21 @@ export interface VideoWall {
         email: string;
     };
 }
-export interface ListParams extends PaginationParams {
-    project_exid?: string;
+export interface VideoWallListParams extends PaginationParams {
+    projectExid?: string;
     id?: number;
     exid?: string;
-    project_id?: number;
-    user_id?: number;
+    projectId?: number;
+    userId?: number;
     name?: string;
     project?: string;
     user?: string;
     source?: VideoWallSource;
 }
 export type VideoWallCreateUpdatePayload = {
-    project_exid: string;
+    projectExid?: string;
     name: string;
     source?: VideoWallSource;
     config: Record<string, unknown>;
+    scope?: string;
 };