@evercam/api 1.0.0-e1ad6ae1b → 1.0.0-e424632fd

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

@@ -1,7 +1,13 @@
-import { DateType } from "@/types";
+import { DateType } from "@evercam/api/types";
 type sortby = string;
 type sortDirection = "asc" | "desc";
 export type SortingUrlParam = `${sortby}|${sortDirection}`;
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+export type JsonObject = {
+    [key: string]: JsonValue;
+};
+export type JsonArray = JsonValue[];
 export type BatteryReading = {
     id: number;
     voltage: number;
@@ -53,7 +59,7 @@ export declare enum UnitSystem {
     Metric = "metric"
 }
 export type Timestamp = string | number;
-export type Schedule = {
+export type ScheduleUppercase = {
     Friday: string[];
     Monday: string[];
     Saturday: string[];
@@ -71,6 +77,7 @@ export type ScheduleLowercase = {
     tuesday: string[];
     wednesday: string[];
 };
+export type Schedule = ScheduleUppercase | ScheduleLowercase;
 export type PaginationParams = {
     sort?: SortingUrlParam;
     page?: number;
@@ -108,11 +115,11 @@ export declare enum DownloadFileType {
 export declare enum FeedbackContext {
     CopilotMessage = "copilot_message"
 }
-export type FeedbackPayload<T> = {
+export type FeedbackPayload = {
     id?: number;
     user: string;
     text: string;
-    type: T;
+    type: string;
     context: FeedbackContext;
     messageId?: number;
     conversationId?: number;
@@ -126,6 +133,11 @@ export interface JSON {
     stringify<T>(value: T, replacer?: (key: string, value: unknown) => unknown, space?: string | number): string & Stringified<T>;
     parse<T>(text: Stringified<T>, reviver?: (key: unknown, value: unknown) => unknown): T;
 }
+export type Point2D = {
+    x: number;
+    y: number;
+};
+export type TuplePoint2D = [number, number];
 export type Exid = string;
 export type EntityByExid<Entity extends unknown> = Record<Exid, Entity>;
 export type BatteryVoltage = {

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

@@ -0,0 +1,58 @@
+import type { DateType } from "@evercam/api/types";
+export type ShareRequest = {
+    cameraId: string;
+    createdAt: DateType | number;
+    email: string;
+    id: number;
+    rights: string;
+    sharerEmail: string;
+    sharerName: string;
+    userId: number;
+};
+export type Share = {
+    cameraId: string;
+    createdAt: DateType | number;
+    email: string;
+    fullname: string;
+    id: number;
+    lastSeenAt: DateType;
+    rights: string;
+    sessionCount: number;
+    sharerEmail: string;
+    sharerId: number;
+    sharerName: string;
+    userId: number;
+    isUserAccessRestricted: boolean;
+};
+export type ShareDeletionRequestPayload = {
+    email?: string;
+    key?: string;
+    origin?: string;
+};
+export type SharedUsersResponsePayload = Array<{
+    email: string;
+    name: string;
+}>;
+export type ShareCreateRequestPayload = {
+    email: string[] | string;
+    message?: string;
+    permission?: string;
+    rights: string;
+    apiId?: string;
+    apiKey?: string;
+};
+export type ShareCreateResponsePayload = {
+    shares: Share[];
+    shareRequests: ShareRequest[];
+};
+export declare enum InviteStatus {
+    Pending = 0,
+    Cancelled = -1,
+    Used = 1,
+    Failed = -2
+}
+export declare enum ShareVisibility {
+    PublicDiscoverable = "publicDiscoverable",
+    PublicUndiscoverable = "publicUndiscoverable",
+    Private = "private"
+}

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

@@ -1,4 +1,4 @@
-import { DateTime, PaginationParams } from "@/types";
+import { PaginationParams } from "@evercam/api/types";
 export declare enum SmsCommands {
     Cellular = "cellular",
     Gpson = "gpson",
@@ -63,7 +63,7 @@ export type Sim = {
     puk: string;
     iccid: string;
     description: string;
-    lastSmsAt: DateTime;
+    lastSmsAt: string;
     cameras: {
         name: string;
         exid: string;
@@ -79,11 +79,11 @@ export type SendSmsResponse = {
     errorText: string;
 };
 export type SmsHistory = {
-    insertedAt: DateTime;
+    insertedAt: string;
     type: string;
     status: string;
     text: string;
-    deliveryDatetime: DateTime;
+    deliveryDatetime: string;
 };
 export type SmsHistoryResponse = {
     singleSimSms: SmsHistory[];
@@ -98,8 +98,8 @@ export type Sms = {
     status: string;
     text: string;
     type: string;
-    insertedAt: DateTime;
-    deliveryDatetime: DateTime;
+    insertedAt: string;
+    deliveryDatetime: string;
 };
 export type SmsQueryParams = PaginationParams & {
     dateRange: string;

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

@@ -0,0 +1,287 @@
+import { BBox, BoundingBox, DateType, Schedule, ScheduleLowercase, CameraExid, DetectionModel, PaginationParams, PpeLabel, ProjectExid, CameraDateRangeFilter, CameraFeatureFlag, TimelineDateInterval, Camera, AdminCamera, _360FloorV2, _360FloorId, PaginatedItems, DateRangeFilter } from "@evercam/api/types";
+import { DetectionLabel, DownloadFileType } from "@evercam/api/types";
+export declare enum SiteAnalyticsMode {
+    Detections = "detections",
+    Segments = "segments"
+}
+export type SmartSearchObjectPart = {
+    id?: string;
+    type: SmartSearchComponentType.Object;
+    value: DetectionLabel;
+};
+export type SmartSearchOperatorPart = {
+    id?: string;
+    type: SmartSearchComponentType.Operator;
+    value: SmartSearchOperatorType;
+};
+export type SmartSearchConditionPart = {
+    id?: string;
+    type: SmartSearchComponentType.Condition;
+    value: SmartSearchCondition | SmartSearchConditionData;
+};
+export type SmartSearchViewPart = {
+    id?: string;
+    type: SmartSearchComponentType.View;
+    value: SiteAnalyticsView;
+};
+export type SmartSearchAreaPart = {
+    id?: string;
+    type: SmartSearchComponentType.Area;
+    value: BBox;
+};
+export type SmartSearchTimePart = {
+    id?: string;
+    type: SmartSearchComponentType.Time;
+    value: Schedule | ScheduleLowercase;
+};
+export type SmartSearchDateRangePart = {
+    id?: string;
+    type: SmartSearchComponentType.DateRange;
+    value: DateRangeFilter;
+};
+export type SmartSearchPart = SmartSearchObjectPart | SmartSearchOperatorPart | SmartSearchConditionPart | SmartSearchViewPart | SmartSearchAreaPart | SmartSearchTimePart | SmartSearchDateRangePart;
+export type SmartSearchPartOrGroup = SmartSearchPart | SmartSearchPart[];
+export declare enum SmartSearchComponentType {
+    Condition = "condition",
+    Object = "object",
+    Area = "in_area",
+    Time = "time",
+    Operator = "operator",
+    View = "view",
+    DateRange = "date_range",
+    Heatmap = "heatmap"
+}
+export type SmartSearchPartType = SmartSearchComponentType | SmartSearchCondition;
+export type SmartSearchComponentData = {
+    id: string;
+    type: SmartSearchComponentType;
+    parts: SmartSearchPartOrGroup[];
+};
+export declare enum SmartSearchCondition {
+    InArea = "in_area",
+    Intersects = "intersects",
+    Time = "time"
+}
+export type SmartSearchConditionData = {
+    condition: SmartSearchCondition;
+    value: string | BoundingBox | DetectionLabel | Date;
+};
+type SmartSearchBackendConditionBase = {
+    target: SmartSearchTargets;
+};
+export type SmartSearchSelectionCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.Selection;
+    operator: SmartSearchOperators;
+    attribute: string;
+    value: string | number | string[];
+};
+export type SmartSearchSpatialCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.Spatial;
+    operator: SmartSearchOperators;
+    reference: {
+        target: SmartSearchTargets;
+        attribute: string;
+        value: string | number | string[];
+    };
+};
+export type SmartSearchAreaCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.Area;
+    operator: SmartSearchOperators;
+    polygon: BBox;
+};
+export type SmartSearchGeoAreaCondition = SmartSearchBackendConditionBase & {
+    type: SmartSearchConditionTypes.GeoArea;
+    operator: SmartSearchOperators;
+    polygon: BBox;
+};
+export type SmartSearchBackendQueryCondition = SmartSearchSelectionCondition | SmartSearchSpatialCondition | SmartSearchAreaCondition | SmartSearchGeoAreaCondition;
+export type SmartSearchBackendQuery = {
+    returnTargets: SmartSearchTargets[];
+    rulesLogic: SmartSearchOperatorType;
+    rules: {
+        logic: SmartSearchOperatorType;
+        conditions: SmartSearchBackendQueryCondition[];
+    }[];
+    returnType: SmartSearchReturnType;
+    timeSchedule?: Schedule;
+};
+export declare enum SmartSearchTargets {
+    Tracking = "tracking",
+    Segments = "segments"
+}
+export declare enum SmartSearchReturnType {
+    All = "all",
+    FirstLastSeen = "first_last_seen"
+}
+export declare enum SmartSearchOperatorType {
+    And = "AND",
+    Or = "OR"
+}
+export declare enum SmartSearchOperators {
+    Near = "near",
+    Far = "far",
+    Intersects = "intersects",
+    DoesNotIntersect = "does_not_intersect",
+    Inside = "inside",
+    Outside = "outside",
+    DistanceBelow = "distance_below",
+    DistanceAbove = "distance_above",
+    Area = "in_area",
+    Equal = "="
+}
+export declare enum SmartSearchConditionTypes {
+    Selection = "selection",
+    Spatial = "spatial",
+    Area = "area",
+    GeoArea = "in_geo_area",
+    Iou = "iou",
+    Near = "near",
+    Far = "far"
+}
+export type SmartSearchOptionValue = DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData | DateRangeFilter | SiteAnalyticsView;
+export type SmartSearchBackendQueryPayload = {
+    name: string;
+    description: string;
+    query: SmartSearchBackendQuery;
+    fromDate?: DateType;
+    toDate?: DateType;
+    author: string;
+    createdAt: DateType;
+    params?: {
+        start: string;
+        end: string;
+    };
+};
+export type SavedQuery = {
+    description: string;
+    id: number;
+    query: SmartSearchBackendQuery;
+    params: Record<string, string>;
+    components?: Omit<SmartSearchPart, "id">[];
+    toDate?: DateType;
+    createdAt?: DateType;
+    cameraExid: string;
+    name: string;
+    fromDate?: DateType;
+    author?: string;
+};
+export type DetectionsRequestParams = {
+    projectExid: ProjectExid;
+    cameraExids: CameraExid[];
+    fromDate?: string;
+    toDate?: string;
+    labels?: Array<DetectionLabel | PpeLabel>;
+    modelId?: DetectionModel;
+    trackId?: number;
+    thresholds?: string[];
+    excludeLabels?: Array<DetectionLabel | PpeLabel>;
+    mergedClasses?: Array<string>;
+    confidenceThreshold?: number;
+} & PaginationParams;
+export type DetectionsExportRequestParams = DetectionsRequestParams & {
+    fileType: DownloadFileType;
+    columns?: string[];
+    directDownload?: boolean;
+};
+export type SmartSearchHeatmapPoint = {
+    coordinates: [number, number];
+    detectionsCount: number;
+};
+export type SmartSearchHeatmapData = {
+    label: string;
+    points: SmartSearchHeatmapPoint[];
+};
+export type SmartSearchNearConfig = {
+    sourceLabels: DetectionLabel[];
+    targetLabel?: DetectionLabel;
+};
+export type HeatmapIntersectionsRequestParams = CameraDateRangeFilter & SmartSearchNearConfig;
+export type SmartSearchSidebarItem = {
+    key: string;
+    displayLabel: string;
+    data: SmartSearchHeatmapData;
+    imagePath?: string;
+};
+export declare enum SiteAnalyticsViewType {
+    Camera = "camera",
+    ThreeSixty = "360"
+}
+export type SiteAnalyticsCameraView = {
+    type: SiteAnalyticsViewType.Camera;
+    id: CameraExid;
+    value: Camera | AdminCamera;
+};
+export type SiteAnalytics360View = {
+    type: SiteAnalyticsViewType.ThreeSixty;
+    id: _360FloorId;
+    value: _360FloorV2;
+};
+export type SiteAnalyticsView = SiteAnalyticsCameraView | SiteAnalytics360View;
+export type SiteAnalyticsProcessingStatusPayload = {
+    projectExid?: ProjectExid;
+    fromDate?: DateType;
+    toDate?: DateType;
+    cameraExid?: CameraExid;
+    drawingId?: string;
+    features?: CameraFeatureFlag[];
+};
+export type SiteAnalyticsProcessingStatus = {
+    projectExid: ProjectExid;
+    viewType: SiteAnalyticsViewType;
+    viewId: string;
+    feature: CameraFeatureFlag;
+    processedIntervals: TimelineDateInterval[];
+};
+export type SmartSearchRequestPayload = {
+    cameraExids?: CameraExid[];
+    drawingIds?: _360FloorId[];
+    walkIds?: string[];
+    markerIds?: string[];
+    payload: SmartSearchBackendQuery;
+    fromDate?: string;
+    toDate?: string;
+    page?: number;
+    pageSize?: number;
+    threshold?: number;
+};
+type SmartSearchResultItemBase = {
+    area: number;
+    bbox: BBox;
+    cameraExid?: CameraExid;
+    centroid: number[];
+    confidenceScore: number;
+    drawingId?: _360FloorId;
+    label: DetectionLabel;
+    modelId: DetectionModel;
+    projectExid: ProjectExid;
+    segmentId?: number;
+    trackId: number;
+    walkId?: string | number;
+};
+export type SmartSearchResultItemFirstLastSeen = SmartSearchResultItemBase & {
+    firstSeen: DateType;
+    firstSeenMarkerId?: string | number;
+    lastSeen: DateType;
+    lastSeenMarkerId?: string | number;
+};
+export type SmartSearchResultItemAll = SmartSearchResultItemBase & {
+    walkId?: string | number;
+    markerId?: string | number;
+    geolocation?: number[];
+    mask?: number[][];
+    timestamp: DateType;
+};
+type SmartSearchResultItemByType = {
+    [SmartSearchReturnType.FirstLastSeen]: SmartSearchResultItemFirstLastSeen;
+    [SmartSearchReturnType.All]: SmartSearchResultItemAll;
+};
+export type SmartSearchResponse<R extends SmartSearchReturnType = SmartSearchReturnType.FirstLastSeen> = PaginatedItems<SmartSearchResultItemByType[R]>;
+export type SmartSearchMinifiedPart = {
+    t: SmartSearchComponentType;
+    v: unknown;
+};
+export type SmartSearchMinifiedComponent = {
+    t: SmartSearchComponentType;
+    p: SmartSearchMinifiedPart[];
+};
+export {};

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

@@ -0,0 +1,5 @@
+import { CameraExid } from "@evercam/api/types";
+export type SmartSearchQueriesRequestPayload = {
+    camerasExid: CameraExid[];
+    name?: string;
+};

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

@@ -1,4 +1,4 @@
-import { CameraExid, DateType, PaginationParams, Schedule } from "@/types";
+import { CameraExid, DateType, PaginationParams, Schedule } from "@evercam/api/types";
 export type SnapshotExtractionQyeryParams = PaginationParams & {
     camera: string;
     cameraExid: CameraExid;
@@ -48,12 +48,44 @@ export type DeleteSnapshotQueryParams = {
     adminEmail: string;
     adminFullname: string;
 };
-export type TransferCloudRecordingsQueryParams = {
+export type SnapshotTransfer = {
+    id: number;
+    sourceCamera: SnapshotTransferCamera;
+    targetCamera: SnapshotTransferCamera;
+    fromDate: DateType;
+    toDate: DateType;
+    overwriteExisting?: boolean | null;
+    deleteSource?: boolean | null;
+    requestor: SnapshotTransferRequestor;
+    status: SnapshotTransferStatus;
+    insertedAt: DateType;
+    attempts?: number | null;
+    errorMessage?: string | null;
+    snapshotsTransferred?: number | null;
+};
+export type SnapshotTransferCamera = {
+    id: number;
+    exid: CameraExid;
+    name: string;
+};
+export type SnapshotTransferRequestor = {
+    email: string;
+    firstname: string;
+    lastname: string;
+};
+export declare enum SnapshotTransferStatus {
+    Completed = "completed",
+    Failed = "failed",
+    Processing = "processing",
+    Pending = "pending",
+    Cancelled = "cancelled"
+}
+export type TransferCloudRecordingsQueryParams = PaginationParams & {
     targetCameraExid: CameraExid;
     fromDate: DateType;
     toDate: DateType;
-    overwriteExistingSnapshots?: boolean;
-    keepSourceSnapshots?: boolean;
+    overwriteExisting?: boolean;
+    deleteSource?: boolean;
     adminEmail?: string;
     adminFullname?: string;
 };

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

@@ -0,0 +1,19 @@
+import type { DateType } from "@evercam/api/types";
+export type StorageProvider = {
+    id?: number;
+    cameraId: number;
+    type: string;
+    provider: string;
+    url: string;
+    startDate: DateType;
+    endDate: DateType;
+    config: Record<string, any>;
+    insertedAt?: DateType;
+};
+export type StorageProvidersResponsePayload = {
+    providers: StorageProvider[];
+};
+export declare enum ProjectStorageProvider {
+    Seaweedfs = "seaweedfs",
+    S3 = "s3"
+}

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

@@ -0,0 +1,40 @@
+import type { JsonObject, JsonValue } from "@evercam/api/types";
+export type StoryblokAsset = {
+    id: number | null;
+    alt: string | null;
+    name: string;
+    focus: string | null;
+    title: string | null;
+    filename: string;
+    copyright: string | null;
+    fieldtype: "asset";
+    source?: string;
+    metaData?: JsonObject;
+    isExternalUrl?: boolean;
+};
+export type StoryblokStory<TContent extends JsonObject = JsonObject> = {
+    id: number;
+    uuid: string;
+    name: string;
+    slug: string;
+    fullSlug: string;
+    content: TContent;
+    createdAt: string;
+    publishedAt: string | null;
+    updatedAt: string;
+    position: number;
+    tagList: string[];
+    isStartpage: boolean;
+    parentId: number | null;
+    groupId: string;
+    firstPublishedAt: string | null;
+    releaseId: number | null;
+    lang: string;
+    path: string;
+};
+export type StoryblokResponse<TContent extends JsonObject = JsonObject> = {
+    story: StoryblokStory<TContent>;
+    cv: number;
+    rels: JsonValue[];
+    links: JsonValue[];
+};

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

@@ -1,11 +1,11 @@
-import { DateTime_Z_micros, KitMetricData } from "@/types";
+import { KitMetricData } from "@evercam/api/types";
 export type ExNvrLoginResponse = {
     accessToken: string;
 };
 export type ExNvrRecordingInterval = {
     active: boolean;
-    startDate: DateTime_Z_micros;
-    endDate: DateTime_Z_micros;
+    startDate: string;
+    endDate: string;
 };
 export type ExNvrDeviceConfig = {
     id: string;

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

@@ -1,4 +1,4 @@
-import { Kit } from "@/types/kit";
+import { Kit } from "@evercam/api/types/kit";
 export type Tag<T = string> = {
     id?: number;
     name: T;

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

@@ -0,0 +1,7 @@
+import { Moment } from "moment-timezone";
+export type DateType = Date | string | number;
+export type ExtendedDateType = Moment | DateType;
+export type DateRangeFilter = {
+    fromDate: DateType;
+    toDate: DateType;
+};

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

@@ -1,4 +1,4 @@
-import { DateType, Schedule } from "@/types";
+import { DateType, 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,18 @@ export type TimestampPositionCoordinates = {
     w: number;
     h: number;
 };
+export type BlurRegionPoint = {
+    x: number;
+    y: number;
+};
+export type BlurRegionCoordinates = BlurRegionPoint[];
 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",
@@ -56,7 +63,7 @@ export type TimelapseFilterQueryParams = {
     to?: DateType;
     period?: TimelapsePeriod;
     duration?: number;
-    schedule?: TimelapseSchedules;
+    schedule?: Schedule;
 };
 export type TimelapseCreationRequestPayload = {
     title: string;