@spytecgps/nova-orm 0.0.120 → 0.0.121

package/dist/repositories/trips/getTrips.d.ts

@@ -0,0 +1,4 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { Logger } from '../../types/logger';
+import { GetTripsParams, GetTripsResult } from '../../types/trip';
+export declare const getTrips: (novaDataSource: NovaDataSource, params: GetTripsParams, logger: Logger) => Promise<GetTripsResult>;

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

@@ -1,5 +1,5 @@
 import { Trip } from '../../entities';
-import { CreateTripParams, UpdateTripEndValuesParams } from '../../types/trip';
+import { CreateTripParams, GetTripsParams, GetTripsResult, UpdateTripEndValuesParams } from '../../types/trip';
 import { BaseRepository } from '../baseRepository';
 export declare class TripRepository extends BaseRepository {
     /**
@@ -20,4 +20,10 @@ export declare class TripRepository extends BaseRepository {
      * @returns {Trip} the Trip associated to the passed id or null
      */
     getTripById(id: string): Promise<Trip>;
+    /**
+     * Get a trip by id
+     * @param  {GetTripsParams} id the trip's filters
+     * @returns {GetTripsResult} The GetTripsResult containing the trips and the totalCount.
+     */
+    getTrips(params: GetTripsParams): Promise<GetTripsResult>;
 }

package/dist/types/trip.d.ts

@@ -1,3 +1,5 @@
+import { Trip } from '../entities';
+import { ReportPagination } from './common';
 import { TripCompletionStatus, TripType } from './enums';
 export declare const requiredCreateTripParamsAttributes: string[];
 export interface CreateTripParams {
@@ -25,15 +27,45 @@ export interface CreateTripParams {
 }
 export declare const requiredUpdateTripEndValuesParamsAttributes: string[];
 export interface UpdateTripEndValuesParams {
-    id: string;
-    endDate: Date;
-    endLat: number;
-    endLon: number;
-    endAddress: string;
-    positionEnd: string;
-    endMessageId: string;
-    distance: number;
-    duration: number;
-    tripType: TripType;
-    tripCompletionStatusId: TripCompletionStatus;
+    filters: {
+        id: string;
+    };
+    values: {
+        endDate: Date;
+        endLat: number;
+        endLon: number;
+        endAddress: string;
+        positionEnd: string;
+        endMessageId: string;
+        distance: number;
+        duration: number;
+        tripType: TripType;
+        tripCompletionStatusId: TripCompletionStatus;
+    };
+}
+export declare const requiredGetTripsParamsAttributes: string[];
+export interface GetTripSortParams {
+    sortField?: 'startDate' | 'endDate' | 'imei' | 'tripType' | 'deviceName';
+    sortOrder?: 'ASC' | 'DESC';
+}
+export interface GetTripsParams extends ReportPagination {
+    filters: {
+        clientId: number;
+        from: Date;
+        to: Date;
+        tripType?: TripType;
+        durationMin?: number;
+        durationMax?: number;
+        distanceMin?: number;
+        distanceMax?: number;
+        imeis?: string[];
+        completionStatus?: TripCompletionStatus;
+        deviceName?: string;
+        deviceStatus?: 'A' | 'D';
+    };
+    sortOptions?: GetTripSortParams;
+}
+export interface GetTripsResult {
+    trips: Trip[];
+    totalCount: number;
 }

package/package.json

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