@evercam/api 1.0.0-213bdb2b3

package/dist/types/user.d.ts

@@ -0,0 +1,276 @@
+import type { DateTime, PaginationParams } from "@/types";
+export type User = {
+    id?: number;
+    fullname?: string;
+    firstname: string;
+    lastname: string;
+    email: string;
+    telephone: string;
+    country: string;
+    isAdmin: boolean;
+    persona: Persona;
+    companyId?: string;
+    companyName?: string;
+    companyExid?: string;
+    features?: Array<UserFeatureFlag>;
+};
+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: DateTime;
+    integrations: string[];
+    lastEventBrowser: string;
+    lastEvenCreatedAt: DateTime;
+    lastEventId: number;
+    lastEventIpAddress: string;
+    lastEventName: string;
+    lastEventOs: 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",
+    Copilot = "copilot",
+    ProjectSharing = "project-sharing"
+}
+export type ProjectUser = User & {
+    lastSeenAt: string;
+    active: boolean;
+    activeOneMonth: boolean;
+    eventsCount: string;
+    cameraExid: string;
+    cameraRights: string;
+};
+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 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 LogoutParams = {
+    token: string;
+    fromAdmin?: boolean;
+};
+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 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: DateTime;
+};
+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: DateTime;
+    updatedAt: DateTime;
+    lastSignInAt: DateTime;
+    signInCount: number;
+    lastSignInIp: string;
+    apiId: string;
+    apiKey: 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;
+};
+export type SuppressionsQueryParams = PaginationParams & {
+    id: number;
+    email: string;
+    source: string;
+};
+export type Suppression = {
+    id: number;
+    email: string;
+    source: string;
+    insertedAt: DateTime;
+    updatedAt: DateTime;
+};

package/dist/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/types/videoWall.d.ts

@@ -0,0 +1,33 @@
+import { Camera, Media } from "@/types";
+export declare enum VideoWallItemType {
+    LiveView = "live",
+    Video = "video",
+    Image = "image"
+}
+export type VideoWallItem<T extends Camera | Media> = {
+    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 VideoWallPresetItem = {
+    i: string | number;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    camera: Camera;
+    weather?: Record<string, unknown>;
+    media?: Media;
+};

package/dist/types/voyageControl.d.ts

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

package/dist/types/weather.d.ts

@@ -0,0 +1,83 @@
+import { Date_YYYY_MM_DD, DateType } from "@/types/time";
+export type HistoryWeatherRequestPayload = {
+    day: string;
+};
+export type WeatherResponsePayload = Array<{
+    hour?: number;
+    temp?: number;
+    clouds?: number;
+    feelsLike?: number;
+    pressure?: number;
+    humidity?: number;
+    windSpeed?: number;
+    windDegree?: number;
+    weather?: [WeatherSummary];
+    rain?: HourlyReading;
+    snow?: HourlyReading;
+}>;
+export type WeatherSummary = {
+    id?: number;
+    main?: string;
+    description?: string;
+    icon?: string;
+};
+export type HourlyReading = {
+    "1h"?: number;
+    "3h"?: number;
+};
+export declare enum WeatherProvider {
+    WeatherStack = "WeatherStack",
+    AerisWeather = "AerisWeather"
+}
+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: Date_YYYY_MM_DD;
+    totalsnow: number;
+    maxPressure: number;
+    maxWindchill: number;
+    maxHumidity: number;
+    avgtemp: number;
+    projectId: number;
+    minUvIndex: number;
+};

package/dist/types/widget.d.ts

@@ -0,0 +1,169 @@
+import type { DateTime } from "@evercam/api/types/time";
+import { VideoWallPresetItemConfig } from "@evercam/api/types/videoWall";
+export declare enum DelayUnit {
+    Minute = "minute",
+    Hour = "hour",
+    Day = "day"
+}
+export declare enum CommonWidgetSettingsKeys {
+    Width = "width",
+    WidthResolution = "resolution",
+    Height = "height",
+    HeightResolution = "heightResolution"
+}
+export declare enum RecordingsWidgetSettingsKeys {
+    DarkMode = "darkMode",
+    Calendar = "calendar",
+    HasDelay = "hasDelay",
+    Delay = "delay",
+    DelayUnit = "delayUnit",
+    HasRange = "hasRange",
+    DateRange = "dateRange",
+    Width = "width",
+    WidthResolution = "resolution",
+    Height = "height",
+    HeightResolution = "heightResolution"
+}
+export declare enum LiveViewWidgetSettingsKeys {
+    Fullscreen = "fullscreen",
+    Download = "download",
+    Zoom = "zoom",
+    Playpause = "playpause",
+    Refresh = "refresh",
+    Width = "width",
+    WidthResolution = "resolution",
+    Height = "height",
+    HeightResolution = "heightResolution"
+}
+export declare enum BimCompareWidgetSettingsKeys {
+    Timeline = "timeline",
+    Calendar = "calendar",
+    DarkMode = "darkMode",
+    Width = "width",
+    WidthResolution = "resolution",
+    Height = "height",
+    HeightResolution = "heightResolution"
+}
+export declare enum VideoWallWidgetSettingsKeys {
+    Preset = "preset",
+    RefreshRate = "refreshRate",
+    Width = "width",
+    WidthResolution = "resolution",
+    Height = "height",
+    HeightResolution = "heightResolution"
+}
+export type CommonWidgetSettings = {
+    width: number;
+    resolution: string;
+    height: number;
+    heightResolution: string;
+};
+export type RecordingsWidgetSettings = CommonWidgetSettings & {
+    darkMode: boolean;
+    calendar: boolean;
+    hasDelay: boolean;
+    delay: number;
+    delayUnit: DelayUnit;
+};
+export type LiveViewWidgetSettings = CommonWidgetSettings & {
+    fullscreen: boolean;
+    download: boolean;
+    zoom: boolean;
+    playpause: boolean;
+    refresh: number;
+};
+export type BimCompareWidgetSettings = CommonWidgetSettings & {
+    timeline: boolean;
+    darkMode: boolean;
+};
+export type VideoWallWidgetSettings = CommonWidgetSettings & {
+    preset: VideoWallPresetItemConfig;
+    refreshRate: number;
+};
+export type WidgetSettings = RecordingsWidgetSettings | LiveViewWidgetSettings | BimCompareWidgetSettings | VideoWallWidgetSettings;
+export declare enum WidgetType {
+    LiveWidget = "Live View",
+    Recording = "Recordings",
+    BimCompare = "BIM Compare",
+    VideoWall = "Video Wall"
+}
+export declare const RessourceByType: {
+    camera: WidgetType[];
+    project: WidgetType[];
+};
+export type WidgetsListRequestPayload = {
+    userId: number;
+    projectId: number;
+    cameraId: number;
+    active: boolean;
+    settings: WidgetSettings;
+    widgetType: WidgetType;
+    isPublic: boolean;
+    allowedOrigin: string;
+};
+export type Widget = {
+    id: number;
+    ressources: {
+        camera?: {
+            id: number;
+            exid: string;
+            name: string;
+        };
+        project?: {
+            id: number;
+            exid: string;
+            name: string;
+        };
+    };
+    widgetType: WidgetType;
+    settings: WidgetSettings;
+    allowedOrigin: string;
+    isPublic: boolean;
+    active: boolean;
+    user: {
+        id: number;
+        email: string;
+    };
+    insertedAt: DateTime;
+    updatedAt: DateTime;
+};
+export type WidgetFull = {
+    id: number;
+    ressources: {
+        camera?: {
+            id: number;
+            exid: string;
+            name: string;
+        };
+        project?: {
+            id: number;
+            exid: string;
+            name: string;
+        };
+    };
+    widgetType: WidgetType;
+    widgetKey: string;
+    widgetId: string;
+    active: boolean;
+    user: {
+        id: number;
+        email: string;
+    };
+    settings: WidgetSettings;
+    sessionSettings: any;
+    allowedOrigin: string;
+    isPublic: boolean;
+    insertedAt: DateTime;
+    updatedAt: DateTime;
+};
+export type WidgetPayload = {
+    ressources: {
+        cameraId?: number;
+        projectId?: number;
+    };
+    widgetType: WidgetType;
+    active: boolean;
+    settings: WidgetSettings;
+    isPublic: boolean;
+    allowedOrigin: string;
+};

package/dist/utils.d.ts

@@ -0,0 +1,9 @@
+export type Falsy = "" | null | undefined | false;
+export interface QueryParams {
+    [k: string]: string | number | boolean | string[] | Falsy;
+}
+export declare const toQueryString: <T extends Record<string, unknown>>(paramsObject?: T | QueryParams, { forceSnakeCase, forceArrayBrackets }?: {
+    forceSnakeCase?: boolean | undefined;
+    forceArrayBrackets?: boolean | undefined;
+}) => string | undefined;
+export declare function queryStringToObject(queryString?: string): QueryParams;

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@evercam/api",
+  "version": "1.0.0-213bdb2b3",
+  "description": "Evercam API client",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/evercam/evercam-frontend.git"
+  },
+  "author": "Evercam - Constuction Cameras.",
+  "license": "MIT",
+  "private": false,
+  "type": "module",
+  "main": "dist/index.umd.js",
+  "module": "dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.umd.js"
+    },
+    "./types": "./dist/src/types.ts"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": "20.x"
+  },
+  "readme": "README.md",
+  "scripts": {
+    "clean": "rimraf dist",
+    "typecheck": "tsc --noEmit",
+    "build:types": "tsc --declaration --emitDeclarationOnly",
+    "build": "yarn clean && vite build && yarn build:types",
+    "ci": "(cd ../..; yarn ci)",
+    "publish-api": "cd ../.. && yarn publish-api"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.10",
+    "vite": "latest",
+    "vite-plugin-commonjs": "^0.10.3",
+    "vite-plugin-dts": "^4.5.3"
+  },
+  "peerDependencies": {
+    "axios": "^1.7.7",
+    "humps": "^2.0.1",
+    "moment-timezone": "^0.5.46"
+  }
+}