@evercam/api 1.0.0-000bac2be

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

@@ -0,0 +1,143 @@
+import { BoundingBox, CameraExid, DateType, GateReportVehicleType, TimelinePrecision } from "@evercam/api/types";
+export type AnprQueryParams = {
+    page?: number;
+    limit?: number;
+    direction?: {
+        eq?: string;
+    } | string;
+    plateNumber?: {
+        eq?: string;
+    } | string;
+    sort?: string;
+    fromDate?: DateType;
+    toDate?: DateType;
+    camerasExid?: CameraExid[];
+    vehicleTypes?: GateReportVehicleType[];
+    isDuplicate?: boolean;
+    isPostprocessed?: boolean;
+    isPlate?: boolean;
+};
+export type AnprCountsQueryParams = {
+    precision: TimelinePrecision;
+    fromDate?: string;
+    toDate?: string;
+    isPublic?: boolean;
+    cameras?: CameraExid[];
+    direction?: AnprDirection;
+    isPlate?: boolean;
+    isDuplicate?: boolean;
+    vehicleTypes?: GateReportVehicleType[];
+    camerasExid?: CameraExid[];
+};
+export declare enum AnprDirection {
+    Left = "reverse",
+    Arrived = "forward",
+    Unknown = "unknown"
+}
+export type AnprEvent = {
+    id: number;
+    plateNumber: string;
+    cameraExid: CameraExid;
+    cameraex: CameraExid;
+    picName: string;
+    eventTime: string;
+    insertedAt: string;
+    isDuplicate: boolean;
+    direction: AnprDirection;
+    updatedAt: string;
+    edited?: boolean;
+    isPlate: boolean;
+    isPostprocessed: boolean;
+    vehicleType?: GateReportVehicleType;
+    contextVehicleType?: GateReportVehicleType;
+    anprVehicleType?: string;
+    anprVehicleModel?: string;
+    anprVehicleMake?: string;
+    anprVehicleColor?: string;
+    anprVehicleSpeed?: number;
+    anprSnapshotLink: string;
+    contextSnapshotLink: string;
+    mainSnapshotLink: string;
+    contextCamera: string;
+    votedVehicleType: GateReportVehicleType | string;
+    roiId?: number;
+    captureTime: DateType;
+    contextThumbnailUrl: string;
+    isPublic: boolean;
+    label: string;
+    mp4Url: string;
+    plateThumbnailUrl: string;
+    thumbnailUrl: string;
+    metadata: {
+        evercamMetadata?: {
+            anpr?: {
+                bbox: BoundingBox;
+                label: string;
+                score: number;
+            };
+            context?: {
+                bbox: BoundingBox;
+                label: string;
+                score: number;
+            };
+        };
+        plateRecognizerMetadata?: {
+            plateNumber?: string;
+            vehicleMake?: string;
+            vehicleType?: string;
+            vehicleColor?: string;
+            vehicleModel?: string;
+            vehicleOrientation?: string;
+        };
+    };
+};
+export type AnprCount = {
+    date: string;
+    counts: Record<AnprDirection, number>;
+};
+export declare enum AnprEventStatus {
+    IsPlate = "is_plate",
+    NotPlate = "not_plate",
+    IsDuplicate = "is_duplicate",
+    NotDuplicate = "not_duplicate"
+}
+export type AnprBulkUpdateRequestPayload = {
+    anprEventsIds: number[];
+    action: AnprEventStatus;
+};
+export type AnprUpdateRequestPayload = {
+    plateNumber: string;
+    vehicleType: GateReportVehicleType;
+    direction: AnprDirection;
+};
+export declare enum AnprExtractionStatus {
+    Pending = "pending",
+    Running = "running",
+    Completed = "completed",
+    Failed = "failed"
+}
+export declare enum AnprExtractionSaveMode {
+    All = "all",
+    AiDbOnly = "ai_db_only",
+    ImagesOnly = "images_only"
+}
+export type AnprExtraction = {
+    id: number;
+    cameraId: number;
+    userId: number | null;
+    startDate: string;
+    endDate: string;
+    status: AnprExtractionStatus;
+    totalRecords: number;
+    error: string | null;
+    saveMode: AnprExtractionSaveMode;
+    startedAt: string | null;
+    completedAt: string | null;
+    insertedAt: string;
+    updatedAt: string;
+};
+export type AnprExtractionCreatePayload = {
+    startDate: string;
+    endDate: string;
+    saveMode?: AnprExtractionSaveMode;
+};

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

@@ -0,0 +1,116 @@
+import { CameraStatus, DateType, PaginationParams } from "@evercam/api/types";
+export declare enum AuditLogActionType {
+    VH_STATUS = "vh_status",
+    CR_UPDATED = "cr_updated",
+    CR_CREATED = "cr_created",
+    ONLINE = "online",
+    OFFLINE = "offline",
+    ON_HOLD = "on_hold",
+    WAITING = "waiting",
+    DECOMMISSIONED = "decommissioned",
+    UNDER_MAINTENANCE = "under_maintenance",
+    WAITING_FOR_SITE_VISIT = "waiting_for_site_visit",
+    SMS = "sms",
+    CUSTOM = "custom",
+    SIM = "sim",
+    LOGIN = "login",
+    LOGOUT = "logout",
+    CREATE = "create",
+    UPDATE = "update",
+    DELETE = "delete",
+    DEVICE_SETTINGS = "device_settings",
+    LINK_SIM_WITH_ROUTER = "link_sim_with_router",
+    UNLINK_SIM_FROM_ROUTER = "unlink_sim_from_router",
+    LINK_CAMERA_WITH_ROUTER = "link_camera_with_router",
+    UNLINK_CAMERA_FROM_ROUTER = "unlink_camera_from_router",
+    SHARE = "share",
+    UPDATE_SHARE = "update_share",
+    DELETE_SHARE = "delete_share",
+    SHARE_REQUEST = "share_request",
+    DELETE_SHARE_REQUEST = "delete_share_request",
+    TRANSFER_OWNERSHIP = "transfer_ownership",
+    BIM_NOTE = "bim_note",
+    GATE_REPORT_NOTE = "gate_report_note"
+}
+export declare enum AuditLogEntity {
+    Cameras = "cameras",
+    Projects = "projects",
+    Layers = "layers",
+    Routers = "routers",
+    Sims = "sims",
+    Hdds = "hdds",
+    Nvr = "nvr",
+    Archives = "archives",
+    Users = "users",
+    Rois = "rois",
+    Kits = "kits",
+    Roles = "roles",
+    Tags = "tags",
+    KitsTags = "kits_tags",
+    Oauth = "oauth",
+    StorageProviders = "storage_providers"
+}
+export type AuditLog = {
+    id: number;
+    action: AuditLogActionType;
+    details: Record<string, any>;
+    insertedAt: DateType;
+    entity: string;
+    user_details: {
+        browser: string;
+        country: string;
+        countryCode: string;
+        device: string | null;
+        ip: string;
+        os: string | null;
+    };
+    who: string;
+};
+export type AuditLogsParams = PaginationParams & {
+    routerId: number;
+    cameraId: number;
+    entity: string;
+    byRouter: boolean;
+    byCamera: boolean;
+    byProject: boolean;
+    action: string;
+};
+export type CameraLogsQueryParams = {
+    historyDays: number;
+    accountId?: string;
+    status: CameraStatus[];
+};
+export type CameraLogItem = {
+    start: DateType;
+    state: CameraStatus;
+    end: DateType;
+};
+export type CameraLog = {
+    data: CameraLogItem[];
+    measure: string;
+};
+export type CameraAuditLog = {
+    id: number;
+    action: AuditLogActionType;
+    details: {
+        error_body?: string;
+        exid: string;
+        id: number;
+        name: string;
+        reason?: string;
+    };
+    insertedAt: DateType;
+    entity: string;
+    user_details: {
+        ip: string;
+        country: string;
+        countryCode: string;
+        agent: string;
+    };
+    who: string;
+};
+export type CameraAuditLogsQueryParams = PaginationParams & {
+    from: string;
+    to: string;
+    action: AuditLogActionType[];
+};

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

@@ -0,0 +1,132 @@
+export declare enum RoleResourceType {
+    App = "app",
+    Camera = "camera",
+    Project = "project"
+}
+export declare enum RoleAssignmentLogAction {
+    Assign = "assign",
+    Unassign = "unassign"
+}
+export type RoleSubRole = {
+    resourceId: string;
+    roleId: number;
+    roleName?: string;
+    permissions?: string[];
+};
+export type Role = {
+    id: number;
+    name: string;
+    description?: string | null;
+    resource?: string;
+    resourceType: RoleResourceType;
+    resourceId?: string | null;
+    permissions: string[];
+    subRoles?: RoleSubRole[];
+    isDefault?: boolean;
+};
+export type ProjectResourceRole = Role & {
+    resourceType: RoleResourceType.Project;
+};
+export type CameraResourceRole = Omit<Role, "subRoles"> & {
+    resourceType: RoleResourceType.Camera;
+};
+export type ProjectRoleRequestPayload = {
+    name: string;
+    permissions: string[];
+    subRoles?: RoleSubRole[];
+};
+export type AuthzRoleUser = {
+    email: string;
+    resourceId: string;
+};
+export type AuthzUserRolesResponse = {
+    roles: Role[];
+};
+export type AuthzScopePermission = {
+    id: number;
+    action: string;
+    exid: string;
+};
+export type AuthzScope = {
+    id: number;
+    name: string;
+    description: string | null;
+    permissions: AuthzScopePermission[];
+    app: string;
+    exid: string;
+};
+export type AuthzScopeCreatePayload = {
+    name: string;
+    description?: string;
+    permissions: string[];
+};
+export type AuthzScopeUpdatePayload = Partial<AuthzScopeCreatePayload>;
+export declare function isProjectRole(role: Role): role is ProjectResourceRole;
+export declare function isCameraRole(role: Role): role is CameraResourceRole;
+export type RoleAssignmentUserDetails = {
+    browser?: string | null;
+    device?: string | null;
+    os?: string | null;
+    country?: string | null;
+    countryCode?: string | null;
+    ip?: string | null;
+    impersonatedBy?: string | null;
+};
+export type RoleAssignmentRowUserDetails = RoleAssignmentUserDetails & {
+    via?: string | null;
+    inviteId?: number | null;
+    inviteEmail?: string | null;
+};
+export type RoleAssignmentLog = {
+    id: number;
+    action: RoleAssignmentLogAction;
+    assignerId: number | null;
+    assignerEmail: string | null;
+    assigneeId: number | null;
+    assigneeEmail: string;
+    roleId: number | null;
+    roleName: string | null;
+    previousRoleId: number | null;
+    previousRoleName: string | null;
+    scope: RoleResourceType;
+    projectExid: string | null;
+    cameraExid: string | null;
+    cameraName: string | null;
+    projectName: string | null;
+    ip: string | null;
+    userDetails: RoleAssignmentRowUserDetails | null;
+    insertedAt: string;
+};
+export type RoleAssignmentResourceRef = {
+    exid: string;
+    name: string | null;
+};
+export type RoleAssignmentLogBatch = {
+    groupId: string;
+    batchId: string | null;
+    batchSize: number;
+    assigneeId: number | null;
+    assigneeEmail: string;
+    actions: RoleAssignmentLogAction[];
+    projects: RoleAssignmentResourceRef[];
+    ip: string | null;
+    userDetails: RoleAssignmentUserDetails | null;
+    insertedAt: string;
+    children: RoleAssignmentLog[];
+};
+export type RoleAssignmentLogsParams = {
+    page?: number;
+    limit?: number;
+    sort?: string;
+    action?: RoleAssignmentLogAction;
+    roleId?: number;
+    roleName?: string;
+    assigneeEmail?: string;
+    assignerEmail?: string;
+    scope?: RoleResourceType;
+    projectExid?: string;
+    cameraExid?: string;
+    ip?: string;
+    from?: string;
+    to?: string;
+};

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

@@ -0,0 +1,29 @@
+export type AutodeskUserHub = {
+    text: string;
+    value: string;
+};
+export type AutodeskProject = {
+    text: string;
+    value: string;
+};
+export type AutodeskFolder = {
+    text: string;
+    value: string;
+    allowedFileType: string;
+    allowedFolderType: string;
+    children: Array<AutodeskFolder>;
+    parentName?: string;
+};
+export type AutodeskSnapshot = {
+    projectId: string;
+    folderId: string;
+    accFileType: string;
+    accFolderType: string;
+    projectExid: string;
+    snapshot: string;
+};
+export type AutodeskTokenResponsePayload = {
+    token: string;
+    expiresAt: string;
+    login: string;
+};

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

@@ -0,0 +1,123 @@
+import { AconexIdentifiers, CameraExid } from "@evercam/api/types";
+export declare enum AutomationProvider {
+    Aconex = "aconex",
+    Procore = "procore",
+    Autodesk = "autodesk",
+    Email = "email"
+}
+export declare enum AutomationType {
+    Photo = "photo",
+    Compare = "compare",
+    GateReport = "gate_report",
+    Weather = "weather"
+}
+export declare enum AutomationWeatherReportType {
+    Forecast = "forecast",
+    History = "history"
+}
+export declare enum AutomationExportFormat {
+    Pdf = "pdf",
+    Csv = "csv"
+}
+export declare enum AutomationWeatherDataGranularity {
+    Daily = "daily",
+    Hourly = "hourly"
+}
+export type AutomationWeatherConfig = {
+    reportType: AutomationWeatherReportType;
+    exportFormat: AutomationExportFormat;
+    dataGranularity?: AutomationWeatherDataGranularity;
+    selectedColumns?: string[];
+    forecastDays?: number;
+};
+export type AutomationCompareConfig = {
+    compareDelay: number;
+};
+export type AutomationEmailRecipient = string | {
+    email: string;
+};
+export type AutomationGateReportConfig = {
+    projectExid: string;
+    vehicleTypes: string[];
+    fileType: string;
+    period: number;
+    columns: string[];
+};
+export type AutomationEmailProviderConfig = {
+    cameraExids?: CameraExid[];
+    recipients: string | AutomationEmailRecipient[];
+};
+export type AutomationProcoreProviderConfig = {
+    companyId: number;
+    companyName: string;
+    projectId: number;
+    projectName: string;
+    categoryId: number;
+    categoryName: string;
+};
+export type AutomationAconexProviderConfig = {
+    projectId: number;
+    projectName: string;
+} & Partial<Record<AconexIdentifiers, string | number | boolean>>;
+export type AutomationAutodeskProviderConfig = {
+    hubId: number;
+    hubName: string;
+    projectId: number;
+    projectName: string;
+    folderId: number;
+    accFileType: string;
+    accFolderType: string;
+    folderName: string;
+};
+export type AutomationProviderConfig = AutomationEmailProviderConfig | AutomationProcoreProviderConfig | AutomationAconexProviderConfig | AutomationAutodeskProviderConfig;
+export type AutomationOptionsConfig = AutomationCompareConfig | AutomationGateReportConfig | AutomationWeatherConfig | {};
+export type AutomationConfig = AutomationProviderConfig & AutomationOptionsConfig;
+export type Automation = {
+    id?: number;
+    cameraExids: CameraExid[];
+    name: string;
+    subject?: string;
+    provider: AutomationProvider;
+    type: AutomationType;
+    config: AutomationConfig;
+    notifyDays: string[];
+    notifyTime: string;
+    timezone: string;
+    isPaused: boolean;
+    restrictedCameraExids?: string[];
+};
+export declare enum AutomationConfigStep {
+    Type = "type",
+    Cameras = "cameras",
+    Settings = "settings",
+    Destination = "destination"
+}
+export type AutomationProviderOption = {
+    labelTranslationKey: string;
+    descriptionTranslationKey: string;
+    value: AutomationProvider;
+    icon: string;
+    iconSize?: string;
+    requiresConnection: boolean;
+};
+export type AutomationTypeOption = {
+    labelTranslationKey: string;
+    descriptionTranslationKey: string;
+    label?: string;
+    description?: string;
+    value: AutomationType;
+    icon: string;
+    iconType?: string;
+};
+export type FormattedAutomation = {
+    cameraExids?: string;
+    name: string;
+    subject: string;
+    provider: AutomationProvider;
+    type: AutomationType;
+    config: Partial<AutomationProviderConfig> & Partial<AutomationOptionsConfig>;
+    notifyDays: string;
+    notifyTime: string;
+    timezone: string;
+    isPaused: boolean;
+};

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

@@ -0,0 +1,71 @@
+import type { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelTokenSource, CancelTokenStatic } from "axios";
+import { Swr } from "@evercam/api/api/client/swr/Swr";
+export type AxiosEnvironment = {
+    baseUrl?: string | null;
+    stagingAiApiUrl?: string | null;
+    aiApiUrl?: string | null;
+    ingestDroneApi?: string | null;
+    ingest360Api?: string | null;
+    ingestGpuApiUrl?: string | null;
+    posthogApiUrl?: string | null;
+    posthogProjectId?: string | null;
+    firebaseVideowallUrl?: string | null;
+    weatherApiBaseUrl?: string | null;
+    evercamLabsUrl?: string | null;
+    isLabsStaging?: boolean;
+    workflowsApiUrl?: string | null;
+    firebaseDbLink?: string | null;
+    firebaseStorageUrl?: string | null;
+    firebaseStorageToken?: string | null;
+    forgeTokenServerUrl?: string | null;
+    snapshotsURL?: string | null;
+    app?: string | null;
+    getAuthToken?: () => string | null;
+    errorLogger?: (error: AxiosError) => void;
+    swrKey?: string;
+};
+export type RequestInterceptor = (req: AxiosRequestConfig, env: AxiosEnvironment) => AxiosRequestConfig & any;
+export type ResponseInterceptor = (res: AxiosResponse, env: AxiosEnvironment) => AxiosResponse & any;
+export type ErrorInterceptor = (error: any, env: AxiosEnvironment) => any;
+export type RequestManager = {
+    createToken: (key: string) => CancelTokenSource["token"];
+    cancelToken: (key: string) => void;
+    cancelAll: () => void;
+};
+export interface ExtendedAxiosInstance extends AxiosInstance {
+    CancelToken: CancelTokenStatic;
+    isCancel: (value: AxiosResponse | AxiosError | unknown) => boolean;
+    setToken: (token: string) => void;
+    setHeader: (headerName: string, value: any) => void;
+    createRequestManager: () => RequestManager;
+    requestManager: RequestManager;
+    env: AxiosEnvironment;
+    addEnvironmentVariables: (vars: Record<string, any>) => void;
+    addRequestInterceptor: (interceptor: RequestInterceptor, errorInterceptor?: ErrorInterceptor) => void;
+    addResponseInterceptor: (interceptor: ResponseInterceptor, errorInterceptor?: ErrorInterceptor) => void;
+    addErrorInterceptor: (interceptor: ErrorInterceptor) => void;
+    swr: Swr;
+}
+export type ResponseValue<T> = T | undefined;
+export type SwrResponse<T> = {
+    cachedValue: ResponseValue<T>;
+    freshPromise: Promise<ResponseValue<T>>;
+};
+export type SwrRequestConfig<T> = Omit<AxiosRequestConfig, "onSwrHit" | "onSwrRefresh"> & {
+    onSwrHit?: (data: T) => unknown;
+    onSwrRefresh?: (data: T) => unknown;
+};
+declare module "axios" {
+    interface AxiosRequestConfig {
+        raw?: boolean;
+        preserveCasing?: boolean;
+        timing?: boolean;
+        _metadata?: {
+            startTime: number;
+        };
+        swr?: boolean;
+        onSwrHit?: (data: any) => unknown;
+        onSwrRefresh?: (data: any) => unknown;
+        onSwrError?: (error: Error) => unknown;
+    }
+}