@evercam/api 1.0.0-ae46ef99c → 1.0.0-api-fixes-bdf31a1d5

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,21 +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 {};
+export type DateRangeFilter = {
+    fromDate: DateType;
+    toDate: DateType;
+};

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

@@ -1,4 +1,4 @@
-import { DateType, Schedule } from "@/types";
+import { DateType, Point2D, Schedule } from "@evercam/api/types";
 export declare enum TimelapseStatus {
     Pending = 11,
     Completed = 5,
@@ -7,7 +7,8 @@ export declare enum TimelapseStatus {
 export declare enum TimelapseDuration {
     ThirtySeconds = 30,
     SixtySeconds = 60,
-    NintySeconds = 90
+    NintySeconds = 90,
+    TwoMinutes = 120
 }
 export type TimelapseVideoOptions = {
     width?: number;
@@ -15,7 +16,9 @@ export type TimelapseVideoOptions = {
     removeTimestamp: boolean;
     smoothTransition: boolean;
     evercamWatermark: boolean;
+    sectionBlur?: boolean;
     timestampPosition?: TimestampPositionCoordinates;
+    blurRegions?: BlurRegionCoordinates[];
 };
 export type TimestampPositionCoordinates = {
     x: number;
@@ -23,14 +26,14 @@ export type TimestampPositionCoordinates = {
     w: number;
     h: number;
 };
+export type BlurRegionCoordinates = Point2D[];
 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 +59,7 @@ export type TimelapseFilterQueryParams = {
     to?: DateType;
     period?: TimelapsePeriod;
     duration?: number;
-    schedule?: TimelapseSchedules;
+    schedule?: Schedule;
 };
 export type TimelapseCreationRequestPayload = {
     title: string;
@@ -67,20 +70,46 @@ export type TimelapseCreationRequestPayload = {
     schedule: Schedule;
     videoOptions: TimelapseVideoOptions;
     logo?: TimelapseLogoOptions;
+    public?: boolean;
 };
 export type TimelapseCreationResponsePayload = {
-    Timelapse: {
-        camera: string;
-        createdAt: string;
-        fromDate: string;
-        id: number;
-        duration: number;
-        requestor: string;
-        schedule: Schedule;
-        status: number;
-        toDate: string;
-        updatedAt: string;
-    };
+    id: number;
+    exid: string;
+    camera: string;
+    fromDate: string;
+    toDate: string;
+    duration: number;
+    schedule: Schedule;
+    status: number;
+    requestor: string;
+    createdAt: string;
+    updatedAt: string;
+    notes?: string | null;
+    category?: string | null;
+    isUrgent?: boolean | null;
+};
+export type TimelapseArchiveResponse = {
+    id: number;
+    exid: string;
+    cameraExid: string;
+    title: string;
+    fromDate: string;
+    toDate: string;
+    createdAt: string;
+    status: string;
+    requesterName: string;
+    requesterEmail: string;
+    public: boolean;
+    type: string;
+    format: string;
+    thumbnailUrl: string;
+    completedAt: string | null;
+    notes: string | null;
+    category: string | null;
+    isUrgent: boolean | null;
+    bucket: string;
+    sourceProduct: string | null;
+    featureType: string | null;
 };
 export type TimelapseSnapshotRequestPayload = {
     from: 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;
@@ -22,7 +29,7 @@ export type AdminUser = {
     telephone: string;
     country: string;
     isAdmin: boolean;
-    companyId: string;
+    companyId: number;
     companyName: string;
     companyExid: string;
     features: Array<UserFeatureFlag>;
@@ -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 & {
@@ -59,6 +65,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",
@@ -85,26 +95,53 @@ 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 declare enum UserSessionType {
+    Password = "password",
+    Impersonation = "impersonation",
+    Sso = "sso",
+    Widget = "widget",
+    ApiKey = "api_key",
+    OauthAccess = "oauth_access",
+    OauthRefresh = "oauth_refresh"
+}
 export type UserSession = {
     browser: string;
     createdAt: string;
@@ -113,6 +150,8 @@ export type UserSession = {
     isCurrent: boolean;
     lastUsedAt: string;
     os: string;
+    type: UserSessionType;
+    impersonatedBy: string | null;
 };
 export type SessionsListRequestPayload = {
     authorization: string;
@@ -123,32 +162,28 @@ export type SessionsListRequestPayload = {
     limit: number;
     page: number;
 };
-export type SessionActivityCamSettingsDetail = {
-    new: any;
-    old: any;
-};
-export type SessionActivityDetail = {
-    agent: string;
-    camSettings: SessionActivityCamSettingsDetail;
-    country: string;
-    countryCode: string;
-    ip: string;
-};
 export type SessionActivity = {
-    cameraExid: string;
-    details: SessionActivityDetail;
-    insertedAt: string;
-    type: string;
+    id: number;
     who: string;
+    action: string;
+    entity: string | null;
+    insertedAt: string;
+    userDetails: Record<string, unknown> | null;
+    details: Record<string, unknown> | null;
 };
 export type SessionActivitiesListRequestPayload = {
-    limit: number;
-    from: string;
-    to: string;
+    action?: string;
+    entity?: string[];
+    from?: string;
+    to?: string;
+    cameraId?: number;
+    routerId?: string;
+    sort?: string;
+    page?: number;
+    limit?: number;
 };
 export type SignupUserRequestPayload = {
     telephone: string;
-    token: string;
     firstname: string;
     lastname: string;
     email: string;
@@ -168,10 +203,22 @@ export type UserUpdateRequestPayload = {
 };
 export type UserDeleteRequestPayload = {
     verifEmail: string;
+    newOwnerEmail?: string;
 };
 export type GoogleAuthRequestPayload = {
-    code: string;
-    redirectUri: string;
+    code?: string;
+    redirectUri?: string;
+    idToken?: string;
+};
+export type ProjectContact = {
+    name: string;
+    role: ContactRole | string;
+    email?: string;
+    phone?: string | null;
+    photo?: string;
+};
+export type ProjectContactsResponsePayload = {
+    data: ProjectContact[];
 };
 export type UserStatsResponse = {
     data: {
@@ -193,79 +240,118 @@ export type UserProject = {
     id: number;
     exid: string;
     name: string;
-    startedAt: DateTime;
+    status?: string;
+    startedAt?: string;
+    insertedAt?: string;
+    endDate?: string | null;
+    timezone?: string;
+    archiveTier?: string | null;
+    featureFlags?: string[];
+    companyId?: number | null;
+    camerasCount?: number;
+    camerasRestrictionType?: string | null;
+    geographicBounds?: unknown | null;
+    owner?: {
+        id: number;
+        name: string;
+        email: string;
+    };
 };
 export type UserProjectResponse = {
     data: UserProject[];
 };
 export type AdminUserUpdateRequestPayload = {
-    companyId: string;
-    email: string;
-    persona: Persona;
-    country: string;
-    features: UserFeatureFlag[];
+    companyId?: number;
+    email?: string;
+    persona?: Persona;
+    country?: string;
+    features?: UserFeatureFlag[];
 };
 export type AdminQueryParams = PaginationParams & {
-    email: string;
-    fullname: string;
+    email?: string;
+    fullname?: string;
+    roles?: number[];
+    sort?: string;
 };
 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;
     apiKey: string;
+    roles?: string[];
 };
 export type ImpersonateUserResponse = {
-    id: string;
-    firstname: string;
-    lastname: string;
-    telephone: string;
-    email: string;
-    is_admin: boolean;
-    persona: Persona;
-    country: string;
-    companyId: number;
-    companyExid: string;
-    companyName: string;
-    evercamAccount: boolean;
-    createdAt: DateTime;
-    updatedAt: DateTime;
-    confirmedAt: DateTime;
-    last_loginAt: DateTime;
-    features: UserFeatureFlag[];
     token: string;
 };
 export type AdminUserQueryParams = PaginationParams & {
-    fullname: string;
-    email: string;
-    telephone: string;
-    persona: Persona;
-    companyName: string;
-    camerasCount: string;
-    projectsCount: string;
-    snapmailCount: string;
-    camerasOwned: string;
-    cameraShares: string;
-    createdAtDate: string;
-    lastLoginAtDate: string;
-    integrations: "procore" | "aconex" | "autodesk";
-    features: UserFeatureFlag.ProjectSharing | UserFeatureFlag.VideoWalls;
+    fullname?: string;
+    email?: string;
+    telephone?: string;
+    persona?: Persona;
+    companyName?: string;
+    camerasCount?: string;
+    projectsCount?: string;
+    snapmailCount?: string;
+    camerasOwned?: string;
+    cameraShares?: string;
+    createdAtDate?: string;
+    lastLoginAtDate?: string;
+    integrations?: "procore" | "aconex" | "autodesk";
+    features?: UserFeatureFlag.ProjectSharing | UserFeatureFlag.VideoWalls;
+    countryId?: number;
 };
 export type SuppressionsQueryParams = PaginationParams & {
+    id?: number;
+    email?: string;
+    source?: string;
+};
+export type Suppression = {
     id: number;
     email: string;
     source: string;
+    insertedAt: string;
+    updatedAt: string;
 };
-export type Suppression = {
+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;
-    source: string;
-    insertedAt: DateTime;
-    updatedAt: DateTime;
+    fullname: string;
+    company: {
+        id: number;
+        name: string;
+        exid: string;
+    };
+    persona: Persona;
+    permissions: string[];
+    role: Role;
+    subRoles: RoleSubRole[];
 };
+export {};

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

@@ -1,25 +1,16 @@
-import { Camera, Media } 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,4 +21,46 @@ 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 type VideoWall = {
+    id: number;
+    exid: string;
+    name: string;
+    config: Record<string, unknown>;
+    insertedAt: string;
+    updatedAt: string;
+    source?: VideoWallSource;
+    user?: {
+        id: number;
+        firstname: string;
+        lastname: string;
+        email: string;
+    };
+};
+export type VideoWallListParams = PaginationParams & {
+    projectExid?: string;
+    id?: number;
+    exid?: string;
+    projectId?: number;
+    userId?: number;
+    name?: string;
+    project?: string;
+    user?: string;
+    source?: VideoWallSource;
+};
+export type VideoWallCreateUpdatePayload = {
+    projectExid?: string;
+    name: string;
+    source?: VideoWallSource;
+    config?: Record<string, unknown>;
+    scope?: string;
 };