@spytecgps/nova-orm 0.0.51 → 0.0.52

package/dist/repositories/alerts/createAlert.d.ts

@@ -0,0 +1,5 @@
+import { Alert } from '../../entities';
+import { NovaDataSource } from '../../novaDataSource';
+import { CreateAlertParams } from '../../types/alert';
+import { Logger } from '../../types/logger';
+export declare const createAlert: (novaDataSource: NovaDataSource, params: CreateAlertParams, logger: Logger) => Promise<Alert>;

package/dist/repositories/alerts/getAlertsReportByClient.d.ts

@@ -0,0 +1,7 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { AlertReport, GetAlertReportByClientParams } from '../../types/alert';
+import { Logger } from '../../types/logger';
+/**
+ * @deprecated The method should not be used
+ */
+export declare const getAlertsReportByClient: (novaDataSource: NovaDataSource, params: GetAlertReportByClientParams, logger: Logger) => Promise<AlertReport[]>;

package/dist/repositories/alerts/getAlertsReportByUser.d.ts

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

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

@@ -0,0 +1,43 @@
+import { Alert } from '../../entities';
+import { AlertReport, CreateAlertParams, GetAlertReportByUserParams } from '../../types/alert';
+import { BaseRepository } from '../baseRepository';
+export declare class AlertRepository extends BaseRepository {
+    /** Create an alert record
+     * @param  {CreateAlertParams} params containing information to create an alert
+     * id: The alert id. if null will be generated
+     * clientId: The client id of the owner of the device generating the alert
+     * deviceId: The device id of the device generating the alert
+     * alertTypeId: The alert type id
+     * value: The alert value
+     * userId: The user id of the user associated with the alert
+     * messageId: The message id of the message that generated the alert
+     * boundaryId: The boundary id of the boundary if the alert is related to a boundary
+     * imei: The imei of the device generating the alert
+     * sendTime: The time the alert was sent
+     * lat: The latitude of the device when the alert was generated
+     * lon: The longitude of the device when the alert was generated
+     * address: The address of the device when the alert was generated
+     * isBuffer: The is buffer flag
+     * isNotification: The is notification flag
+     * gpsUtcTime: The time the gps utc time was set
+     * relevantAddress: The relevant address
+     * gpsMessageId: The gps message id
+     * cellTowerRelevantAddress: The cell tower relevant address
+     */
+    createAlert(params: CreateAlertParams): Promise<Alert>;
+    /** Get alerts report by user id
+     * @param  {GetAlertReportByUserParams} params containing information to filter alerts report by user id
+     * params.filters.userId: The user id of the user associated with the alert
+     * params.filters.imeis: The imeis of the devices generating the alert
+     * params.filters.alertTypeId: The alert type id
+     * params.filters.boundaryId: The boundary id of the boundary if the alert is related to a boundary
+     * params.filters.sendTimeFrom: The time the alert was sent from
+     * params.filters.sendTimeTo: The time the alert was sent to
+     * params.pagingOptions.pageSize: The number of alerts to return
+     * params.pagingOptions.pageIndex: The page index of the alerts to return
+     * params.sortOptions.sortField: The field to sort the alerts by
+     * params.sortOptions.sortOrder: The order to sort the alerts by desc | asc
+     * @returns Promise<AlertReport[]>
+     */
+    getAlertsReportByUser(params: GetAlertReportByUserParams): Promise<AlertReport[]>;
+}

package/dist/repositories/index.d.ts

@@ -1,3 +1,4 @@
+import { AlertRepository } from './alerts';
 import { BoundariesRepository } from './boundaries';
 import { ClientsRepository } from './clients';
 import { CountriesRepository } from './countries';
@@ -7,4 +8,4 @@ import { PositionRepository } from './positions';
 import { SecurityRepository } from './security';
 import { UserInvitationsRepository } from './userInvitations';
 import { UsersRepository } from './users';
-export { SecurityRepository, DevicesRepository, BoundariesRepository, ClientsRepository, FirmwaresRepository, PositionRepository, UsersRepository, CountriesRepository, UserInvitationsRepository, };
+export { SecurityRepository, DevicesRepository, BoundariesRepository, ClientsRepository, FirmwaresRepository, PositionRepository, AlertRepository, UsersRepository, CountriesRepository, UserInvitationsRepository, };

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

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

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

@@ -1,5 +1,5 @@
 import { Position } from '../../entities';
-import { CreatePositionParams, GetPositionsByImeiParams, GetPositionsReportByClientIdParams, PositionReport } from '../../types/position';
+import { CreatePositionParams, GetPositionsByImeiParams, GetPositionsReportByClientParams, PositionReport } from '../../types/position';
 import { BaseRepository } from '../baseRepository';
 export declare class PositionRepository extends BaseRepository {
     /**
@@ -48,7 +48,7 @@ export declare class PositionRepository extends BaseRepository {
     getPositionsByImei(params: GetPositionsByImeiParams): Promise<Position[]>;
     /**
      * Get positions report by client id
-     * @param  {GetPositionsReportByClientIdParams} params containing information to get positions
+     * @param  {GetPositionsReportByClientParams} 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
@@ -58,5 +58,5 @@ export declare class PositionRepository extends BaseRepository {
      * - pageSize: the page size
      * - pageIndex: the page index
      */
-    getPositionsReportByClientId(params: GetPositionsReportByClientIdParams): Promise<PositionReport[]>;
+    getPositionsReportByClient(params: GetPositionsReportByClientParams): Promise<PositionReport[]>;
 }

package/dist/types/alert.d.ts

@@ -0,0 +1,74 @@
+/// <reference types="node" />
+export interface CreateAlertParams {
+    id?: number;
+    alertTypeId: number;
+    value?: string;
+    userId?: string;
+    messageId: string;
+    boundaryId?: number;
+    deviceId?: number;
+    imei: string;
+    sendTime: Date;
+    lat?: number;
+    lon?: number;
+    address?: string;
+    clientId: number;
+    isBuffer?: boolean | null;
+    isNotification?: boolean | null;
+    gpsUtcTime?: Date;
+    relevantAddress?: string;
+    gpsMessageId?: string;
+    cellTowerRelevantAddress?: string;
+    createdAt?: Date;
+}
+export interface ReportPagination {
+    pagingOptions: {
+        pageSize: number | 25;
+        pageIndex: number | 1;
+    };
+    sortOptions?: {
+        sortField: string;
+        sortOrder: 'ASC' | 'DESC';
+    };
+}
+export interface GetAlertReportByUserParams extends ReportPagination {
+    filters: {
+        userId: string;
+        imeis: string[];
+        isTestEnvironment?: boolean | false;
+        alertTypeIds?: number[] | null;
+        boundaryId?: number | null;
+        sendTimeFrom?: Date | null;
+        sendTimeTo?: Date | null;
+    };
+}
+export interface GetAlertReportByClientParams extends ReportPagination {
+    filters: {
+        clientId: number;
+        imei?: string | null;
+        alertTypeId?: number | null;
+        boundaryId?: number | null;
+        sendTimeFrom?: Date | null;
+        sendTimeTo?: Date | null;
+    };
+}
+export interface AlertReport {
+    id: number;
+    alertTypeId: number;
+    value?: string | null;
+    createdAt: Date;
+    userId: Buffer;
+    messageId: Buffer;
+    boundaryId?: number | null;
+    imei: string;
+    sendTime: Date;
+    lat?: number | null;
+    lon?: number | null;
+    address?: string | null;
+    isBuffer?: boolean | null;
+    isNotification?: boolean | null;
+    gpsMessageId?: Buffer | null;
+    gpsUTCTime?: Date | null;
+    stage?: string | null;
+    totalCount: number;
+}

package/dist/types/position.d.ts

@@ -21,7 +21,7 @@ export interface GetPositionsByImeiParams {
         imei: string;
     };
 }
-export interface GetPositionsReportByClientIdParams {
+export interface GetPositionsReportByClientParams {
     filters: {
         clientId: number;
         imeis?: string[] | null;
@@ -31,8 +31,8 @@ export interface GetPositionsReportByClientIdParams {
         speedMax?: number | null;
     };
     pagingOptions: {
-        limit: number | 25;
-        offset: number | 1;
+        pageSize: number | 25;
+        pageIndex: number | 1;
     };
 }
 export interface PositionReport {

package/dist/utils/randomizer.d.ts

@@ -0,0 +1,4 @@
+export declare const getRandomBoolean: () => boolean;
+export declare const getRandomInteger: (max: number) => number;
+export declare const getRandomString: (length: number) => string;
+export declare const getRandomImei: (length?: number) => string;

package/dist/utils/uuidHelpers.d.ts

@@ -1,2 +1,2 @@
 export declare const uuidStringToBinaryBuffer: (uuidString: string) => Buffer;
-export declare const binaryBufferToUuidString: (buffer: Buffer) => string;
+export declare const binaryBufferToUuidString: (buffer: Buffer | null) => string;

package/package.json

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

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

@@ -1,4 +0,0 @@
-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[]>;