@evercam/api 1.0.0-003291add

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

@@ -0,0 +1,345 @@
+import type { CameraExid, PaginationParams } from "@evercam/api/types";
+import { Role, RoleSubRole } from "@evercam/api/types/authz";
+export type User = {
+    id?: number;
+    fullname?: string;
+    firstname: string;
+    lastname: string;
+    email: string;
+    telephone: string;
+    country: string;
+    isAdmin: boolean;
+    persona: Persona;
+    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;
+    fullname: string;
+    firstname: string;
+    email: string;
+    telephone: string;
+    country: string;
+    isAdmin: boolean;
+    companyId: string;
+    companyName: string;
+    companyExid: string;
+    features: Array<UserFeatureFlag>;
+    active: boolean;
+    cameraShares: number;
+    camerasCount: number;
+    camerasOwned: number;
+    countryId: number;
+    countryName: string;
+    createdAt: string;
+    integrations: string[];
+    lastSeenAt: string;
+    lastLoginAt: string;
+    lastname: string;
+    persona: string;
+    projects: string[];
+    projectsCount: number;
+    referralUrl?: string;
+    snapmailCount: number;
+    zohoId: string;
+};
+export declare enum UserFeatureFlag {
+    CompanyAdmin = "company-admin",
+    VideoWalls = "video-walls",
+    MassCameraSharing = "mass-camera-sharing",
+    ProjectSharing = "project-sharing"
+}
+export type ProjectUser = User & {
+    lastSeenAt: string;
+    active: boolean;
+    activeOneMonth: boolean;
+    eventsCount: string;
+    cameraExid: string;
+    cameraRights: string;
+};
+export declare enum ContactRole {
+    SalesExecutive = "Sales Executive",
+    CustomerSuccessManager = "Customer Success Manager"
+}
+export declare enum Persona {
+    HQ = "HQ",
+    PM = "PM",
+    QS = "QS",
+    Marketing = "Marketing",
+    HS = "H&S",
+    DI = "DI",
+    Other = "Other"
+}
+export type UpdatePasswordRequestPayload = {
+    token: string;
+    password: string;
+};
+export type Credentials = {
+    apiKey: string;
+    apiId: string;
+};
+export type LoginRequestPayload = {
+    username: string;
+    password: string;
+    redirectToZoho?: boolean;
+};
+export type RemotePasswordUpdateRequestPayload = {
+    currentPassword: string;
+    newPassword: 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;
+    id: number;
+    ipAddress: string;
+    isCurrent: boolean;
+    lastUsedAt: string;
+    os: string;
+};
+export type SessionsListRequestPayload = {
+    authorization: string;
+    browser?: string;
+    os?: string;
+    ipAddress?: string;
+    sort: string;
+    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;
+    who: string;
+};
+export type SessionActivitiesListRequestPayload = {
+    limit: number;
+    from: string;
+    to: string;
+};
+export type SignupUserRequestPayload = {
+    telephone: string;
+    token: string;
+    firstname: string;
+    lastname: string;
+    email: string;
+    password: string;
+    shareRequestKey: string;
+    referralUrl: string;
+    persona: string;
+    disablePassword: boolean;
+};
+export type UserUpdateRequestPayload = {
+    firstname: string;
+    lastname: string;
+    email: string;
+    telephone: string;
+    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;
+    };
+};
+export type UserCamera = {
+    id: number;
+    exid: string;
+    ownerFullname: string;
+    ownerEmail: string;
+    apiId: string;
+    apiKey: string;
+};
+export type UserCameraResponse = {
+    data: UserCamera[];
+};
+export type UserProject = {
+    id: number;
+    exid: string;
+    name: string;
+    startedAt: string;
+};
+export type UserProjectResponse = {
+    data: UserProject[];
+};
+export type AdminUserUpdateRequestPayload = {
+    companyId: string;
+    email: string;
+    persona: Persona;
+    country: string;
+    features: UserFeatureFlag[];
+};
+export type AdminQueryParams = PaginationParams & {
+    email: string;
+    fullname: string;
+};
+export type Admin = {
+    id: number;
+    fullname: string;
+    email: string;
+    createdAt: string;
+    updatedAt: string;
+    lastSignInAt: string;
+    signInCount: number;
+    lastSignInIp: string;
+    apiId: string;
+    apiKey: string;
+};
+export type ImpersonateUserResponse = {
+    id: string;
+    firstname: string;
+    lastname: string;
+    telephone: string;
+    email: string;
+    isAdmin: boolean;
+    persona: Persona;
+    country: string;
+    companyId: number;
+    companyExid: string;
+    companyName: string;
+    evercamAccount: boolean;
+    createdAt: string;
+    updatedAt: string;
+    confirmedAt: string;
+    lastLoginAt: string;
+    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;
+};
+export type SuppressionsQueryParams = PaginationParams & {
+    id: number;
+    email: string;
+    source: string;
+};
+export type Suppression = {
+    id: number;
+    email: string;
+    source: string;
+    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/vendorModel.d.ts

@@ -0,0 +1,15 @@
+export type VendorModel = {
+    cameraCount: number;
+    exid: string;
+    h264Url: string;
+    jpgUrl: string;
+    name: string;
+    online: number;
+    playbackUrl: string;
+};
+export type VendorModelRequestPayload = {
+    sort: string;
+};
+export type VendorModelResponsePayload = {
+    data: VendorModel[];
+};

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

@@ -0,0 +1,66 @@
+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 = Camera> = {
+    value: T;
+    type: VideoWallItemType;
+};
+export type VideoWallPresetGridConfig = {
+    items: VideoWallPresetItem[];
+    meta?: VideoWallPresetMeta;
+};
+export type VideoWallPresetItem = {
+    i: string | number;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    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/voyageControl.d.ts

@@ -0,0 +1,6 @@
+export type VoyageControlConnectorPayload = {
+    email: string;
+    venue: string;
+    apiKey: string;
+    projectExid: string;
+};

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

@@ -0,0 +1,153 @@
+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 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;
+    heatindex: number;
+    hour?: number;
+    humidity?: number;
+    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;
+    temperature?: number;
+    icon?: string | string[];
+    weatherIndex?: number;
+    rain?: HourlyReading;
+};
+export type HourlyReading = {
+    "1h"?: number;
+    "3h"?: number;
+};
+export declare enum WeatherProvider {
+    WeatherStack = "weather_stack",
+    XWeather = "xweather"
+}
+export type Weatherstatus = {
+    description: string;
+    hour: DateType;
+    id: number;
+    temp: number;
+};
+export type WeatherDataResponse = {
+    minFeelsLike: number;
+    id: number;
+    sunhour: number;
+    maxFeelsLike: number;
+    minWindchill: number;
+    minPressure: number;
+    minWindDegree: number;
+    minDewpoint: number;
+    maxClouds: number;
+    maxWindgust: number;
+    minWindSpeed: number;
+    astro: {
+        moonIllumination: number;
+        moonPhase: string;
+        moonrise: string;
+        moonset: string;
+        sunrise: string;
+        sunset: string;
+    };
+    insertedAt: string;
+    maxDewpoint: number;
+    maxTemp: number;
+    minClouds: number;
+    weather: Weatherstatus[];
+    minHeatindex: number;
+    minPrecip: number;
+    maxWindDegree: number;
+    maxUvIndex: number;
+    minHumidity: number;
+    maxWindSpeed: number;
+    minWindgust: number;
+    updatedAt: DateType;
+    maxPrecip: number;
+    uvIndex: number;
+    maxHeatindex: number;
+    minTemp: number;
+    date: string;
+    totalsnow: number;
+    maxPressure: number;
+    maxWindchill: number;
+    maxHumidity: number;
+    avgtemp: number;
+    projectId: number;
+    minUvIndex: number;
+};