@evercam/api 1.0.0-9cdf48fed → 1.0.0-9dffa9592

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 { 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",
@@ -51,13 +54,6 @@ export declare enum TimelapseType {
     Year = "year",
     FullProject = "full_project"
 }
-export type TimelapseFilterQueryParams = {
-    from?: DateType;
-    to?: DateType;
-    period?: TimelapsePeriod;
-    duration?: number;
-    schedule?: TimelapseSchedules;
-};
 export type TimelapseCreationRequestPayload = {
     title: string;
     duration: number;

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 & {
@@ -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,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;
@@ -148,7 +176,6 @@ export type SessionActivitiesListRequestPayload = {
 };
 export type SignupUserRequestPayload = {
     telephone: string;
-    token: string;
     firstname: string;
     lastname: string;
     email: string;
@@ -166,13 +193,20 @@ export type UserUpdateRequestPayload = {
     country: string;
     persona: string;
 };
-export type UserDeleteRequestPayload = {
-    verifEmail: string;
-};
 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;
@@ -193,7 +227,7 @@ export type UserProject = {
     id: number;
     exid: string;
     name: string;
-    startedAt: DateTime;
+    startedAt: string;
 };
 export type UserProjectResponse = {
     data: UserProject[];
@@ -213,9 +247,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;
@@ -227,17 +261,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;
 };
@@ -266,6 +300,43 @@ 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;
+    };
+    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 interface VideoWall {
+    id: number;
+    exid: string;
+    name: string;
+    source: VideoWallSource;
+    config: Record<string, any>;
+    insertedAt: string;
+    updatedAt: string;
+    user: {
+        id: number;
+        firstname: string;
+        lastname: string;
+        email: string;
+    };
+}
+export interface VideoWallListParams extends 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;
 };

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

@@ -1,29 +1,95 @@
-import { Date_YYYY_MM_DD, DateType } from "@/types/time";
+import { DateType } from "@evercam/api/types/time";
 export type HistoryWeatherRequestPayload = {
     day: string;
     provider: WeatherProvider;
 };
+export type WeatherReportParams = {
+    startDate: string;
+    endDate: string;
+    weatherConditionIds?: number[];
+    minMinTemp?: number;
+    maxMinTemp?: number;
+    minMaxTemp?: number;
+    maxMaxTemp?: number;
+    minMinPrecip?: number;
+    maxMinPrecip?: number;
+    minMaxPrecip?: number;
+    maxMaxPrecip?: number;
+    minMinWindSpeed?: number;
+    maxMinWindSpeed?: number;
+    minMaxWindSpeed?: number;
+    maxMaxWindSpeed?: number;
+    minMinHumidity?: number;
+    maxMinHumidity?: number;
+    minMaxHumidity?: number;
+    maxMaxHumidity?: number;
+    minMinPressure?: number;
+    maxMinPressure?: number;
+    minMaxPressure?: number;
+    maxMaxPressure?: number;
+    minMinClouds?: number;
+    maxMinClouds?: number;
+    minMaxClouds?: number;
+    maxMaxClouds?: number;
+    minMaxUvIndex?: number;
+    maxMaxUvIndex?: number;
+};
+export declare enum WeatherReportScope {
+    Daily = "daily"
+}
+export type WeatherReportRequestPayload = WeatherReportParams & {
+    scope: WeatherReportScope;
+    includeRecent: boolean;
+};
 export type CurrentWeatherRequestPayload = {
     provider: WeatherProvider;
+    includeForecast?: boolean;
+    forecastDays?: number;
 };
-export type WeatherResponsePayload = Array<{
-    hour?: number;
-    temp?: number;
+export type WeatherHourlyItem = {
+    chanceoffog: number;
+    chanceoffrost: number;
+    chanceofhightemp: number;
+    chanceofovercast: number;
+    chanceofrain: number;
+    chanceofremdry: number;
+    chanceofsnow: number;
+    chanceofsunshine: number;
+    chanceofthunder: number;
+    chanceofwindy: number;
     clouds?: number;
+    dewpoint: number;
     feelsLike?: number;
-    pressure?: number;
+    heatindex: number;
+    hour?: number;
     humidity?: number;
-    windSpeed?: number;
-    windDegree?: number;
-    weather?: [WeatherSummary];
+    isRequestedWeather?: boolean;
+    precip: number;
+    pressure?: number;
     rain?: HourlyReading;
     snow?: HourlyReading;
-}>;
+    source: string;
+    temp?: number;
+    uvIndex: number;
+    weather?: WeatherSummary;
+    windchill: number;
+    windDegree?: number;
+    windDir: string;
+    windgust: number;
+    windSpeed?: number;
+    wind?: {
+        speed: number;
+    };
+};
+export type WeatherResponsePayload = Array<WeatherHourlyItem>;
 export type WeatherSummary = {
     id?: number;
     main?: string;
     description?: string;
-    icon?: string;
+    temperature?: number;
+    icon?: string | string[];
+    weatherIndex?: number;
+    rain?: HourlyReading;
 };
 export type HourlyReading = {
     "1h"?: number;
@@ -76,7 +142,7 @@ export type WeatherDataResponse = {
     uvIndex: number;
     maxHeatindex: number;
     minTemp: number;
-    date: Date_YYYY_MM_DD;
+    date: string;
     totalsnow: number;
     maxPressure: number;
     maxWindchill: number;

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

@@ -1,6 +1,6 @@
-import type { DateTime } from "@evercam/api/types/time";
-import { PaginationParams } from "@/types";
-import { VideoWallPresetItemConfig } from "@evercam/api/types/videoWall";
+import { CameraExid, PaginationParams } from "@evercam/api/types";
+import type { JsonObject } from "@evercam/api/types";
+import { VideoWallPresetGridConfig } from "@evercam/api/types/videoWall";
 export declare enum DelayUnit {
     Minute = "Minutes",
     Hour = "Hours",
@@ -78,6 +78,8 @@ export type RecordingsWidgetSettings = CommonWidgetSettings & {
     hasDelay: boolean;
     delay: number;
     delayUnit: DelayUnit;
+    hasRange: boolean;
+    dateRange: [string, string] | null;
 };
 export type LiveViewWidgetSettings = CommonWidgetSettings & {
     fullscreen: boolean;
@@ -90,16 +92,24 @@ export type BimCompareWidgetSettings = CommonWidgetSettings & {
     timeline: boolean;
     darkMode: boolean;
 };
-export type VideoWallWidgetSettings = CommonWidgetSettings & {
-    preset: VideoWallPresetItemConfig;
+export type VideoWallWidgetSettingsObject = CommonWidgetSettings & {
+    preset: VideoWallPresetGridConfig;
     refreshRate: number;
+    allowCellFullscreen: boolean;
+    allowFitContent: boolean;
+    allowForceAspectRatio: boolean;
+    allowFullscreen: boolean;
+    cameras: CameraExid[];
+    description: string;
+    global: boolean;
+    visibility: string;
 };
 export type ThreeSixtyWidgetSettings = CommonWidgetSettings & {
     dateId: string;
     floorId: string;
     markerId: string;
 };
-export type WidgetSettings = RecordingsWidgetSettings | LiveViewWidgetSettings | BimCompareWidgetSettings | VideoWallWidgetSettings | ThreeSixtyWidgetSettings;
+export type WidgetSettings = RecordingsWidgetSettings | LiveViewWidgetSettings | BimCompareWidgetSettings | VideoWallWidgetSettingsObject | ThreeSixtyWidgetSettings;
 export declare enum WidgetType {
     LiveWidget = "Live View",
     Recording = "Recordings",
@@ -118,7 +128,7 @@ export type WidgetsListRequestPayload = PaginationParams & {
     active: boolean;
     settings: WidgetSettings;
     widgetType: WidgetType;
-    isPublic: boolean;
+    domainRestricted: boolean;
     allowedOrigin: string;
 };
 export type Widget = {
@@ -138,7 +148,7 @@ export type Widget = {
     widgetType: WidgetType;
     settings: WidgetSettings;
     allowedOrigin: string;
-    isPublic: boolean;
+    domainRestricted: boolean;
     active: boolean;
     user: {
         id: number;
@@ -146,8 +156,8 @@ export type Widget = {
         firstname: string;
         lastname: string;
     };
-    insertedAt: DateTime;
-    updatedAt: DateTime;
+    insertedAt: string;
+    updatedAt: string;
 };
 export type WidgetFull = {
     id: number;
@@ -172,11 +182,62 @@ export type WidgetFull = {
         email: string;
     };
     settings: WidgetSettings;
-    sessionSettings: any;
+    sessionSettings: JsonObject | null;
     allowedOrigin: string;
-    isPublic: boolean;
-    insertedAt: DateTime;
-    updatedAt: DateTime;
+    domainRestricted: boolean;
+    insertedAt: string;
+    updatedAt: string;
+};
+export type WidgetSessionSettingsPayload = {
+    sessionSettings: JsonObject;
+};
+export type AdminWidgetResourceCamera = {
+    id: number;
+    exid: string;
+    name: string;
+};
+export type AdminWidgetResourceProject = {
+    id: number;
+    exid: string;
+    name: string;
+    featureFlags: string[];
+};
+export type AdminWidgetResourcePreset = {
+    id: number;
+    name: string;
+    exid: string;
+    config: JsonObject;
+};
+export type AdminWidgetResources = {
+    camera?: AdminWidgetResourceCamera | null;
+    project?: AdminWidgetResourceProject | null;
+    preset?: AdminWidgetResourcePreset | null;
+};
+export type AdminWidgetUser = {
+    id: number;
+    email: string;
+    firstname: string;
+    lastname: string;
+};
+export type AdminWidget = {
+    id: number;
+    active: boolean;
+    public: boolean;
+    user: AdminWidgetUser;
+    description: string | null;
+    insertedAt: string;
+    updatedAt: string;
+    settings: WidgetSettings;
+    ressources: AdminWidgetResources;
+    seenAt?: string;
+    showDashboardLink?: boolean;
+    domainRestricted: boolean;
+    widgetType: WidgetType;
+    allowedOrigin: string | null;
+};
+export type AdminWidgetFull = AdminWidget & {
+    widgetKey: string;
+    widgetId: string;
 };
 export type WidgetPayload = {
     ressources: {
@@ -186,6 +247,6 @@ export type WidgetPayload = {
     widgetType: WidgetType;
     active: boolean;
     settings: WidgetSettings;
-    isPublic: boolean;
+    domainRestricted: boolean;
     allowedOrigin: string;
 };

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

@@ -4,9 +4,9 @@ export type XWeatherCreatePayload = {
     clientSecret: string;
 };
 export type XWeatherResponse = {
-    id: number;
-    provider: string;
+    id?: number;
+    provider: "xweather";
     config: object;
-    insertedAt: string;
-    updatedAt: string;
+    insertedAt?: string;
+    updatedAt?: string;
 };