@spytecgps/nova-orm 0.0.38 → 0.0.39

package/dist/repositories/index.d.ts

@@ -2,5 +2,6 @@ import { BoundariesRepository } from './boundaries';
 import { ClientsRepository } from './clients';
 import { DevicesRepository } from './devices';
 import { FirmwaresRepository } from './firmwares';
+import { PositionRepository } from './positions';
 import { SecurityRepository } from './security';
-export { SecurityRepository, DevicesRepository, BoundariesRepository, ClientsRepository, FirmwaresRepository, };
+export { SecurityRepository, DevicesRepository, BoundariesRepository, ClientsRepository, FirmwaresRepository, PositionRepository, };

package/dist/repositories/positions/createPosition.d.ts

@@ -0,0 +1,6 @@
+import { Position } from '../../entities';
+import { NovaDataSource } from '../../novaDataSource';
+import { Logger } from '../../types/logger';
+import { CreatePositionParams } from '../../types/position';
+export declare const createPosition: (novaDataSource: NovaDataSource, params: CreatePositionParams, logger: Logger) => Promise<Position>;
+export declare const createPositions: (novaDataSource: NovaDataSource, params: CreatePositionParams[], logger: Logger) => Promise<Position[]>;

package/dist/repositories/positions/getPositionsByImei.d.ts

@@ -0,0 +1,5 @@
+import { Position } from '../../entities';
+import { NovaDataSource } from '../../novaDataSource';
+import { Logger } from '../../types/logger';
+import { GetPositionsByImeiParams } from '../../types/position';
+export declare const getPositionsByImei: (novaDataSource: NovaDataSource, params: GetPositionsByImeiParams, logger: Logger) => Promise<Position[]>;

package/dist/repositories/positions/getPositionsReportByClientId.d.ts

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

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

@@ -0,0 +1,62 @@
+import { Position } from '../../entities';
+import { CreatePositionParams, GetPositionsByImeiParams, GetPositionsReportByClientIdParams, PositionReport } from '../../types/position';
+import { BaseRepository } from '../baseRepository';
+export declare class PositionRepository extends BaseRepository {
+    /**
+     * Create a position
+     * @param  {CreatePositionParams} params containing information to create a position
+     * - id: position id. if null will be generated
+     * - imei: imei of the device reporting the position
+     * - lat: the latitude of the position
+     * - lon: the longitude of the position
+     * - actualDate: the actual date of the message
+     * - speed: the speed reported by the device
+     * - odometer: the odometer reported by the device
+     * - messageId: the id of the message
+     * - batteryPercentage: the battery percentage reported by the device
+     * - clientId: the client id of owner of the device
+     * - address: the address of the position
+     * - sendTime: the time the message was sent
+     * - gpsUtcTime: the time the gps was set
+     * - externalBatteryPercentage: the external battery percentage reported by the device
+     */
+    createPosition(params: CreatePositionParams): Promise<Position>;
+    /**
+     * Create a position
+     * @param  {CreatePositionParams[]} params array containing information to create a positions
+     * - id: position id. if null will be generated
+     * - imei: imei of the device reporting the position
+     * - lat: the latitude of the position
+     * - lon: the longitude of the position
+     * - actualDate: the actual date of the message
+     * - speed: the speed reported by the device
+     * - odometer: the odometer reported by the device
+     * - messageId: the id of the message
+     * - batteryPercentage: the battery percentage reported by the device
+     * - clientId: the client id of owner of the device
+     * - address: the address of the position
+     * - sendTime: the time the message was sent
+     * - gpsUtcTime: the time the gps was set
+     * - externalBatteryPercentage: the external battery percentage reported by the device
+     */
+    createPositions(params: CreatePositionParams[]): Promise<Position[]>;
+    /**
+     * Get positions by imei
+     * @param  {GetPositionsByImeiParams} params containing information to get positions
+     * - filters.imei: filters by imei to get positions
+     */
+    getPositionsByImei(params: GetPositionsByImeiParams): Promise<Position[]>;
+    /**
+     * Get positions report by client id
+     * @param  {GetPositionsReportByClientIdParams} params containing information to get positions
+     * - filters.clientId: filters by client id to get positions
+     * - filters.imeis: filters by imeis to get positions
+     * - filters.actualDateFrom: filters by actual date from to get positions
+     * - filters.actualDateTo: filters by actual date to to get positions
+     * - filters.speedMin: filters by speed min to get positions
+     * - filters.speedMax: filters by speed max to get positions
+     * - pageSize: the page size
+     * - pageIndex: the page index
+     */
+    getPositionsReportByClientId(params: GetPositionsReportByClientIdParams): Promise<PositionReport[]>;
+}

package/dist/types/position.d.ts

@@ -0,0 +1,51 @@
+export interface CreatePositionParams {
+    id?: number;
+    imei: string;
+    lat?: number;
+    lon?: number;
+    actualDate: Date;
+    createdAt?: Date;
+    speed?: number;
+    odometer?: number;
+    messageId: string;
+    batteryPercentage?: number;
+    clientId: number;
+    address?: string;
+    sendTime: Date;
+    gpsUtcTime?: Date;
+    externalBatteryPercentage?: number;
+    externalPowerVoltage?: number;
+}
+export interface GetPositionsByImeiParams {
+    filters: {
+        imei: string;
+    };
+}
+export interface GetPositionsReportByClientIdParams {
+    filters: {
+        clientId: number;
+        imeis?: string[] | null;
+        actualDateFrom?: Date | null;
+        actualDateTo?: Date | null;
+        speedMin?: number | null;
+        speedMax?: number | null;
+    };
+    pagingOptions: {
+        limit: number | 25;
+        offset: number | 1;
+    };
+}
+export interface PositionReport {
+    imei: string;
+    created: Date;
+    actualDate: Date;
+    lat: number;
+    lon: number;
+    address: string;
+    speed: number;
+    odometer: number;
+    batteryPercentage: number;
+    externalPowerVoltage: number;
+    externalBatteryPercentage: number;
+    totalCount: number;
+}

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@spytecgps/nova-orm",
-  "version": "0.0.38",
+  "version": "0.0.39",
   "description": "ORM with PlanetScale",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "devDependencies": {
     "@types/jest": "^29.5.1",
     "@types/node": "^14.18.36",
+    "@types/uuid": "^9.0.2",
     "@typescript-eslint/eslint-plugin": "^5.59.0",
     "@typescript-eslint/parser": "^5.59.0",
     "aws-sdk": "^2.877.0",