@spytecgps/nova-orm 0.0.109 → 0.0.110

package/dist/repositories/boundaries/getBoundariesReport.d.ts

@@ -0,0 +1,4 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { BoundariesReportEntity, GetBoundariesReportParams } from '../../types/boundaries';
+import { Logger } from '../../types/logger';
+export declare const getBoundariesReport: (novaDataSource: NovaDataSource, params: GetBoundariesReportParams, logger: Logger) => Promise<BoundariesReportEntity[]>;

package/dist/repositories/boundaries/index.d.ts

@@ -1,5 +1,5 @@
 import { Boundary } from '../../entities';
-import { CreateBoundaryParams, DeleteBoundaryParams, GetBoundariesByClientIdParams, GetBoundaryByIdParams, UpdateBoundaryParams } from '../../types/boundaries';
+import { BoundariesReportEntity, CreateBoundaryParams, DeleteBoundaryParams, GetBoundariesByClientIdParams, GetBoundariesReportParams, GetBoundaryByIdParams, UpdateBoundaryParams } from '../../types/boundaries';
 import { BaseRepository } from '../baseRepository';
 export declare class BoundariesRepository extends BaseRepository {
     /**
@@ -64,4 +64,22 @@ export declare class BoundariesRepository extends BaseRepository {
      * - values.modifiedBy: The user id of the user that deleted the boundary
      */
     deleteBoundary(params: DeleteBoundaryParams): Promise<boolean>;
+    /**
+     * Get boundaries report
+     * @param  {GetBoundariesReportParams} params containing information to get boundaries report
+     * - filters.userId: The user id
+     * - filters.boundaryId: The boundary id, optional
+     * - filters.boundaryName: The boundary name, optional
+     * - filters.imeis: The imeis, optional
+     * - filters.boundaryInStartDate: The boundary in start date, optional
+     * - filters.boundaryInEndDate: The boundary in end date, optional
+     * - filters.boundaryOutStartDate: The boundary out start date, optional
+     * - filters.boundaryOutEndDate: The boundary out end date, optional
+     * - pagingOptions.pageSize: The page size of the pagination, required
+     * - pagingOptions.pageIndex: The page index of the pagination, required
+     * - sortOptions.sortField: The field to sort the pagination, optional
+     * - sortOptions.sortOrder: The order to sort the pagination, optional
+     * @returns The boundaries report
+     */
+    getBoundariesReport(params: GetBoundariesReportParams): Promise<BoundariesReportEntity[]>;
 }

package/dist/types/alert.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import { ReportPagination } from './common';
 export interface CreateAlertParams {
     id?: number;
     alertTypeId: number;
@@ -19,16 +20,6 @@ export interface CreateAlertParams {
     cellTowerRelevantAddress?: string;
     createdAt?: Date;
 }
-export interface ReportPagination {
-    pagingOptions: {
-        pageSize: number | 25;
-        pageIndex: number | 0;
-    };
-    sortOptions?: {
-        sortField: string;
-        sortOrder: 'ASC' | 'DESC';
-    };
-}
 export interface GetAlertReportByUserParams extends ReportPagination {
     filters: {
         userId: string;
@@ -43,6 +34,10 @@ export interface GetAlertReportByUserParams extends ReportPagination {
         createdFrom?: Date | null;
         createdTo?: Date | null;
     };
+    sortOptions?: {
+        sortField: string;
+        sortOrder: 'ASC' | 'DESC';
+    };
 }
 export interface GetAlertReportByClientParams extends ReportPagination {
     filters: {
@@ -52,6 +47,10 @@ export interface GetAlertReportByClientParams extends ReportPagination {
         sendTimeFrom?: Date | null;
         sendTimeTo?: Date | null;
     };
+    sortOptions?: {
+        sortField: string;
+        sortOrder: 'ASC' | 'DESC';
+    };
 }
 export interface AlertReport {
     id: number;

package/dist/types/boundaries.d.ts

@@ -1,3 +1,4 @@
+import { ReportPagination } from './common';
 import { BoundaryStatus } from './enums';
 export interface GetBoundariesByClientIdParams {
     filters: {
@@ -55,3 +56,38 @@ export interface DeleteBoundaryParams {
         modifiedBy: string;
     };
 }
+export interface GetBoundariesReportParams extends ReportPagination {
+    filters: {
+        userId: string;
+        boundaryInStartDate?: Date;
+        boundaryInEndDate?: Date;
+        boundaryOutStartDate?: Date;
+        boundaryOutEndDate?: Date;
+        imeis?: string[];
+        boundaryId?: number;
+        boundaryName?: string;
+        minDuration?: number;
+        maxDuration?: number;
+    };
+    sortOptions?: {
+        sortField: 'inDateTime' | 'outDateTime' | 'inOutDuration' | 'name';
+        sortOrder: 'ASC' | 'DESC';
+    };
+}
+export interface BoundariesReportEntity {
+    deviceId: number;
+    imei: string;
+    deviceName?: string | null;
+    boundaryId: number;
+    boundaryName?: string | null;
+    inDate?: Date | null;
+    inLat?: number | null;
+    inLon?: number | null;
+    inAddress?: string | null;
+    outDate?: Date | null;
+    outLat?: number | null;
+    outLon?: number | null;
+    outAddress?: string | null;
+    inOutDuration?: number | null;
+    totalCount: number;
+}

package/dist/types/common.d.ts

@@ -0,0 +1,6 @@
+export interface ReportPagination {
+    pagingOptions: {
+        pageSize: number | 25;
+        pageIndex: number | 0;
+    };
+}

package/dist/types/position.d.ts

@@ -1,3 +1,4 @@
+import { ReportPagination } from './common';
 export interface CreatePositionParams {
     id?: number;
     imei: string;
@@ -21,7 +22,7 @@ export interface GetPositionsByImeiParams {
         imei: string;
     };
 }
-export interface GetPositionsReportByClientParams {
+export interface GetPositionsReportByClientParams extends ReportPagination {
     filters: {
         clientId: number;
         imeis?: string[] | null;
@@ -32,10 +33,6 @@ export interface GetPositionsReportByClientParams {
         odometerMin?: number | null;
         odometerMax?: number | null;
     };
-    pagingOptions: {
-        pageSize: number | 25;
-        pageIndex: number | 0;
-    };
     sortOptions?: {
         sortField: string;
         sortOrder: 'ASC' | 'DESC';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spytecgps/nova-orm",
-  "version": "0.0.109",
+  "version": "0.0.110",
   "description": "ORM with PlanetScale",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",