@evercam/api 1.0.0-fa346266d → 1.0.0-fb678d3ea

package/dist/{types → api/types}/anpr.d.ts

@@ -1,17 +1,7 @@
-import { BoundingBox, CameraExid, DateType, GateReportVehicleType, TimelinePrecision } from "@/types";
+import { BoundingBox, CameraExid, DateType, GateReportVehicleType, TimelinePrecision } from "@evercam/api/types";
 export type AnprQueryParams = {
     page?: number;
     limit?: number;
-    firstSeen?: {
-        gte: DateType;
-    };
-    lastSeen?: {
-        lte: DateType;
-    };
-    captureTime?: {
-        gte?: DateType;
-        lt?: DateType;
-    };
     direction?: {
         eq?: string;
     } | string;
@@ -21,7 +11,11 @@ export type AnprQueryParams = {
     sort?: string;
     fromDate?: DateType;
     toDate?: DateType;
-    tab?: string;
+    camerasExid?: CameraExid[];
+    vehicleTypes?: GateReportVehicleType[];
+    isDuplicate?: boolean;
+    isPostprocessed?: boolean;
+    isPlate?: boolean;
 };
 export type AnprCountsQueryParams = {
     precision: TimelinePrecision;
@@ -43,27 +37,38 @@ export declare enum AnprDirection {
 export type AnprEvent = {
     id: number;
     plateNumber: string;
+    cameraExid: CameraExid;
     cameraex: CameraExid;
     picName: string;
-    captureTime: 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 | null;
+    anprVehicleType?: string;
+    anprVehicleModel?: string;
+    anprVehicleMake?: string;
+    anprVehicleColor?: string;
+    anprVehicleSpeed?: number;
     anprSnapshotLink: string;
     contextSnapshotLink: string;
+    mainSnapshotLink: string;
     contextCamera: string;
     votedVehicleType: GateReportVehicleType | string;
-    metadata_: {
+    roiId?: number;
+    captureTime: DateType;
+    contextThumbnailUrl: string;
+    isPublic: boolean;
+    label: string;
+    mp4Url: string;
+    plateThumbnailUrl: string;
+    thumbnailUrl: string;
+    metadata: {
         evercamMetadata?: {
             anpr?: {
                 bbox: BoundingBox;
@@ -96,3 +101,43 @@ export declare enum AnprEventStatus {
     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/apiKey.d.ts

@@ -0,0 +1,70 @@
+export declare enum ApiKeyType {
+    User = "user",
+    Workflows = "workflows",
+    Widget = "widget"
+}
+export type ApiKey = {
+    id: number;
+    name: string;
+    type: ApiKeyType;
+    maskedKey: string;
+    key: string | null;
+    scopes: string[];
+    projects: string[];
+    active: boolean;
+    expiresAt: string | null;
+    lastUsedAt: string | null;
+    revokedAt: string | null;
+    insertedAt: string;
+    updatedAt: string;
+};
+export declare enum ApiKeyStatus {
+    Active = "active",
+    Expired = "expired",
+    Revoked = "revoked"
+}
+export type ApiKeysRequestParams = {
+    name?: string;
+    type?: ApiKeyType;
+    status?: ApiKeyStatus[];
+    expiresAtFrom?: string;
+    expiresAtTo?: string;
+    lastUsedAtFrom?: string;
+    lastUsedAtTo?: string;
+    sort?: string;
+    page?: number;
+    limit?: number;
+};
+export type CreateApiKeyPayload = {
+    name: string;
+    scopes: string[];
+    resources?: {
+        projects: string[];
+    };
+    type?: ApiKeyType;
+    expiresAt?: string;
+};
+export type UpdateApiKeyPayload = {
+    name?: string;
+    scopes?: string[];
+    resources?: {
+        projects: string[];
+    };
+    expiresAt?: string | null;
+};
+export type AdminApiKey = Omit<ApiKey, "key"> & {
+    user: {
+        email: string;
+        fullname: string;
+    };
+};
+export type AdminApiKeysRequestParams = ApiKeysRequestParams & {
+    user?: string;
+    userId?: number;
+    lastUsedAtFrom?: string;
+    lastUsedAtTo?: string;
+};
+export type UpdateAdminApiKeyPayload = {
+    name: string;
+    expiresAt: string | null;
+};

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

@@ -0,0 +1,242 @@
+import { CameraStatus, DateType, JsonValue, 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",
+    TRANSFER_PROJECT = "transfer_project",
+    ASSIGN = "assign",
+    UNASSIGN = "unassign",
+    OAUTH_AUTHORIZE = "oauth_authorize",
+    OAUTH_TOKEN_ISSUE = "oauth_token_issue",
+    OAUTH_TOKEN_REFRESH = "oauth_token_refresh",
+    OAUTH_TOKEN_REVOKE = "oauth_token_revoke",
+    OAUTH_CLIENT_CREATE = "oauth_client_create",
+    OAUTH_CLIENT_DELETE = "oauth_client_delete",
+    API_KEY_REGENERATE = "api_key_regenerate",
+    API_KEY_REVOKE = "api_key_revoke"
+}
+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",
+    ApiKeys = "api_keys",
+    StorageProviders = "storage_providers"
+}
+export type AuditLogDiff = {
+    old: Record<string, JsonValue>;
+    new: Record<string, JsonValue>;
+};
+export type AuditLogHddInfoItem = {
+    name?: string;
+    capacity?: string;
+    freeSpace?: string;
+    status?: string;
+    property?: string;
+};
+export type AuditLogCameraDetails = {
+    exid?: string;
+    name?: string;
+    with?: string;
+    errorBody?: string;
+    reason?: string;
+    settings?: AuditLogDiff;
+};
+export type AuditLogRouterDetails = {
+    serialNumber?: string;
+    cameraExid?: string;
+    cameraName?: string;
+    simNumber?: string;
+    settings?: AuditLogDiff;
+    deviceSettings?: Record<string, JsonValue>;
+};
+export type AuditLogUserEntityDetails = {
+    firstname?: string;
+    lastname?: string;
+    settings?: AuditLogDiff;
+};
+export type AuditLogProjectDetails = {
+    exid?: string;
+    name?: string;
+    settings?: AuditLogDiff;
+};
+export type AuditLogApiKeyDetails = {
+    name?: string;
+    maskedKey?: string;
+    userId?: number;
+};
+export type AuditLogDetails = {
+    id?: number;
+    exid?: string;
+    name?: string;
+    displayName?: string;
+    layerId?: number;
+    serial?: string;
+    type?: string;
+    note?: string;
+    with?: string;
+    message?: string;
+    config?: Record<string, JsonValue>;
+    settings?: AuditLogDiff;
+    camera?: AuditLogCameraDetails;
+    router?: AuditLogRouterDetails;
+    user?: AuditLogUserEntityDetails;
+    project?: AuditLogProjectDetails;
+    sim?: {
+        number?: string;
+    };
+    kit?: {
+        name?: string;
+    };
+    hdd?: {
+        serialNumber?: string;
+        settings?: AuditLogDiff;
+    };
+    roi?: {
+        settings?: AuditLogDiff;
+    };
+    hddInfo?: AuditLogHddInfoItem[];
+    oldOwner?: string;
+    newOwner?: string;
+    oldProjectExid?: string;
+    oldProjectName?: string;
+    newProjectExid?: string;
+    newProjectName?: string;
+    fromAdmin?: boolean;
+    who?: string;
+    email?: string;
+    scope?: string;
+    resourceId?: string;
+    clientId?: string;
+    clientName?: string;
+    oauthClientId?: string;
+    scopes?: string[];
+    grantType?: string;
+    tokenType?: string;
+    maskedKey?: string;
+    userId?: number;
+    apiKey?: AuditLogApiKeyDetails;
+    revoked?: AuditLogApiKeyDetails;
+};
+export declare enum AuditLogAuthMethod {
+    Password = "password",
+    ApiKeyV2 = "api_key_v2",
+    Widget = "widget",
+    OauthAccess = "oauth_access",
+    Impersonation = "impersonation",
+    Sso = "sso"
+}
+export type AuditLogUserDetails = {
+    browser: string;
+    country: string;
+    countryCode: string;
+    device: string | null;
+    ip: string;
+    os: string | null;
+    authMethod?: AuditLogAuthMethod;
+    apiKeyId?: number;
+    apiKeyName?: string;
+    apiKeyMasked?: string;
+    widgetId?: number;
+    oauthClientId?: string;
+    impersonatedBy?: string;
+    who?: string;
+};
+export type AuditLog = {
+    id: number;
+    action: AuditLogActionType;
+    details: AuditLogDetails;
+    insertedAt: DateType;
+    entity: AuditLogEntity;
+    userDetails: AuditLogUserDetails;
+    who: string;
+};
+export type AuditLogsParams = PaginationParams & {
+    routerId: number | null;
+    cameraId: number | null;
+    entity: AuditLogEntity[] | "";
+    byRouter: string;
+    byCamera: string;
+    byProject: string;
+    userId: number;
+    byIp: string;
+    from: string;
+    to: string;
+    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/{types → api/types}/autodesk.d.ts

@@ -1,20 +1,20 @@
-export type AutodeskUserHubsResponsePayload = Array<{
+export type AutodeskUserHub = {
     text: string;
     value: string;
-}>;
-export type AutodeskProjectsResponsePayload = Array<{
+};
+export type AutodeskProject = {
     text: string;
     value: string;
-}>;
-export type AutodeskFolderResponsePayload = {
+};
+export type AutodeskFolder = {
     text: string;
     value: string;
     allowedFileType: string;
     allowedFolderType: string;
-    children: Array<AutodeskFolderResponsePayload>;
+    children: Array<AutodeskFolder>;
     parentName?: string;
 };
-export type AutodeskUploadSnapshotPayload = {
+export type AutodeskSnapshot = {
     projectId: string;
     folderId: string;
     accFileType: 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;
+};