@spytecgps/nova-orm 1.0.12 → 1.0.14

package/dist/repositories/deviceStatus/getDeviceStatuses.d.ts

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

package/dist/repositories/deviceStatus/getDeviceStatuses.js

@@ -0,0 +1,77 @@
+import { ClientDeviceSetting, Device } from '../../entities';
+import { DeviceStatus } from '../../entities/deviceStatus';
+export const getDeviceStatuses = async (novaDataSource, params, logger) => {
+    if (!params?.filters?.imeiList?.length && !params?.filters?.clientId) {
+        logger.warn({ params }, 'DeviceStatusRepository::getDevice missing required parameters');
+        return [];
+    }
+    const dsResult = await novaDataSource.safeQuery(async (dataSource) => {
+        const deviceStatusRepository = dataSource.getRepository(DeviceStatus);
+        let queryBuilder = deviceStatusRepository.createQueryBuilder('deviceStatus');
+        if (params.filters.imeiList?.length) {
+            queryBuilder = queryBuilder.andWhere('deviceStatus.imei IN (:...imeis)', {
+                imeis: params.filters.imeiList,
+            });
+        }
+        if (params.filters.clientId) {
+            queryBuilder = queryBuilder.andWhere('deviceStatus.clientId = :clientId', {
+                clientId: params.filters.clientId,
+            });
+        }
+        if (params.filters.minSendTime) {
+            queryBuilder = queryBuilder.andWhere('deviceStatus.sendTime > :sendTimeMin', {
+                sendTimeMin: params.filters.minSendTime,
+            });
+        }
+        if (params.filters.deviceStatus || params.projectionOptions?.withDevice) {
+            queryBuilder = queryBuilder.leftJoinAndMapOne('deviceStatus.device', Device, 'device', 'deviceStatus.imei = device.imei and deviceStatus.clientId = device.clientId');
+            if (params.filters.deviceStatus) {
+                queryBuilder = queryBuilder.andWhere('device.status = :status', {
+                    status: params.filters.deviceStatus,
+                });
+            }
+        }
+        if (params.projectionOptions?.withClient) {
+            queryBuilder = queryBuilder.leftJoinAndSelect('deviceStatus.client', 'client');
+        }
+        if (params.projectionOptions?.withClientDeviceSettings) {
+            queryBuilder = queryBuilder.leftJoinAndMapOne('deviceStatus.clientDeviceSetting', ClientDeviceSetting, 'clientDeviceSetting', 'deviceStatus.imei = clientDeviceSetting.imei and deviceStatus.clientId = clientDeviceSetting.clientId');
+        }
+        queryBuilder = queryBuilder
+            .limit(params.pagingOptions?.limit ?? 100)
+            .offset(params.pagingOptions?.offset ?? 0);
+        const deviceStatuses = await queryBuilder.getMany();
+        return deviceStatuses;
+    }, 'DeviceStatusRepository::getDevice');
+    dsResult.forEach(ds => {
+        if (params.projectionOptions?.deviceStatusProperties?.length) {
+            for (const key in ds.data) {
+                if (!params.projectionOptions?.deviceStatusProperties?.some(p => p == key)) {
+                    delete ds.data[key];
+                }
+            }
+        }
+        if (params.projectionOptions?.deviceProperties?.length) {
+            for (const key in ds.device) {
+                if (!params.projectionOptions?.deviceProperties?.some(p => p == key)) {
+                    delete ds.device[key];
+                }
+            }
+        }
+        if (params.projectionOptions?.clientProperties?.length) {
+            for (const key in ds.client) {
+                if (!params.projectionOptions?.clientProperties?.some(p => p == key)) {
+                    delete ds.client[key];
+                }
+            }
+        }
+        if (params.projectionOptions?.clientDeviceSettingsProperties?.length) {
+            for (const key in ds.clientDeviceSetting) {
+                if (!params.projectionOptions?.clientDeviceSettingsProperties?.some(p => p == key)) {
+                    delete ds.clientDeviceSetting[key];
+                }
+            }
+        }
+    });
+    return dsResult;
+};

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

@@ -0,0 +1,27 @@
+import { DeviceStatus } from '../../entities/deviceStatus';
+import { GetDeviceStatusesParams, UpsertDeviceStatusesParams } from '../../types/deviceStatus';
+import { BaseRepository } from './../baseRepository';
+export declare class DeviceStatusRepository extends BaseRepository {
+    /**
+     * Get device statuses
+     * @param  {GetDeviceStatusesParams} params containing information to get device statuses
+     * - filters.deviceStatus: The device status
+     * - filters.clientId: The client id
+     * - filters.imeiList: The imei list
+     * - filters.minSendTime: The min send time
+     * - projectionOptions.deviceStatusProperties: The device status properties to get
+     * - projectionOptions.withDevice: Whether to get the device object
+     * - projectionOptions.deviceProperties: The device properties to get
+     * - projectionOptions.withClient: Whether to get the client object
+     * - projectionOptions.clientProperties: The client properties to get
+     * - projectionOptions.withClientDeviceSettings: Whether to get the client device settings
+     * - projectionOptions.clientDeviceSettingsProperties: The client device settings properties to get
+     */
+    getDeviceStatuses(params: GetDeviceStatusesParams): Promise<DeviceStatus[]>;
+    /**
+     * Upsert the device status information
+     * @param {UpsertDeviceStatusesParams} params containing device statuses information
+     * - items: The device statuses entities to upsert
+     */
+    upsertDeviceStatuses(params: UpsertDeviceStatusesParams): Promise<boolean>;
+}

package/dist/repositories/deviceStatus/index.js

@@ -0,0 +1,40 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { BaseRepository } from './../baseRepository';
+import { getDeviceStatuses } from './getDeviceStatuses';
+import { upsertDeviceStatuses } from './upsertDeviceStatuses';
+export class DeviceStatusRepository extends BaseRepository {
+    /**
+     * Get device statuses
+     * @param  {GetDeviceStatusesParams} params containing information to get device statuses
+     * - filters.deviceStatus: The device status
+     * - filters.clientId: The client id
+     * - filters.imeiList: The imei list
+     * - filters.minSendTime: The min send time
+     * - projectionOptions.deviceStatusProperties: The device status properties to get
+     * - projectionOptions.withDevice: Whether to get the device object
+     * - projectionOptions.deviceProperties: The device properties to get
+     * - projectionOptions.withClient: Whether to get the client object
+     * - projectionOptions.clientProperties: The client properties to get
+     * - projectionOptions.withClientDeviceSettings: Whether to get the client device settings
+     * - projectionOptions.clientDeviceSettingsProperties: The client device settings properties to get
+     */
+    async getDeviceStatuses(params) {
+        this.logger.trace(params, 'DeviceStatusRepository::getDeviceStatus started with params');
+        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger);
+        const result = await getDeviceStatuses(novaDataSource, params, this.logger);
+        this.logger.trace(result, 'DeviceStatusRepository::getDeviceStatus result');
+        return result;
+    }
+    /**
+     * Upsert the device status information
+     * @param {UpsertDeviceStatusesParams} params containing device statuses information
+     * - items: The device statuses entities to upsert
+     */
+    async upsertDeviceStatuses(params) {
+        this.logger.trace(params, 'DeviceStatusRepository::upsertDeviceStatus started with params');
+        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger);
+        const result = await upsertDeviceStatuses(novaDataSource, params, this.logger);
+        this.logger.trace({ result }, 'DeviceStatusRepository::upsertDeviceStatus result');
+        return result;
+    }
+}

package/dist/repositories/deviceStatus/upsertDeviceStatuses.d.ts

@@ -0,0 +1,4 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { UpsertDeviceStatusesParams } from '../../types/deviceStatus';
+import { Logger } from '../../types/logger';
+export declare const upsertDeviceStatuses: (novaDataSource: NovaDataSource, params: UpsertDeviceStatusesParams, logger: Logger) => Promise<boolean>;

package/dist/repositories/deviceStatus/upsertDeviceStatuses.js

@@ -0,0 +1,40 @@
+import { DeviceStatus } from '../../entities/deviceStatus';
+export const upsertDeviceStatuses = async (novaDataSource, params, logger) => {
+    if (!params?.items?.length) {
+        logger.warn({ params }, 'DeviceStatusRepository::upsertDeviceStatus missing required parameters');
+        return false;
+    }
+    return novaDataSource.safeQuery(async (dataSource) => {
+        const deviceStatusRepository = dataSource.getRepository(DeviceStatus);
+        const deviceStatuses = params.items.map(item => {
+            return {
+                clientId: item.clientId,
+                imei: item.imei,
+                created: new Date(item.created),
+                sendTime: new Date(item.sendTime),
+                data: item,
+            };
+        });
+        const result = await deviceStatusRepository.upsert(deviceStatuses, {
+            conflictPaths: ['imei'],
+        });
+        // const values = deviceStatuses
+        //   .map(
+        //     d =>
+        //       `(${d.imei}, '${d.clientId}', '${d.created}', '${d.sendTime}', '${JSON.stringify(
+        //         d.data,
+        //       )}')`,
+        //   )
+        //   .join(', ')
+        // const query = `
+        //     INSERT INTO deviceStatus (imei, clientId, created, sendTime, data)
+        //     VALUES ${values}
+        //     ON DUPLICATE KEY UPDATE
+        //         created = IF(VALUES(sendTime) > sendTime, VALUES(created), created),
+        //         sendTime = IF(VALUES(sendTime) > sendTime, VALUES(sendTime), sendTime),
+        //         data = IF(VALUES(sendTime) > sendTime, VALUES(data), data);
+        // `
+        // const result = await deviceStatusRepository.query(query)
+        return result?.raw?.affectedRows > 0;
+    }, 'DeviceStatusRepository::upsertDeviceStatus');
+};

package/dist/repositories/index.d.ts

@@ -14,6 +14,7 @@ import { DeactivationsRepository } from './deactivations';
 import { DeviceBehaviorsRepository } from './deviceBehaviors';
 import { DevicePairingsRepository } from './devicePairings';
 import { DevicesRepository } from './devices';
+import { DeviceStatusRepository } from './deviceStatus';
 import { FirmwaresRepository } from './firmwares';
 import { NotificationRecipientsRepository } from './notificationRecipients';
 import { PositionRepository } from './positions';
@@ -29,4 +30,4 @@ import { UserInvitationsRepository } from './userInvitations';
 import { UserRatingRequestsRepository } from './userRatingRequests';
 import { UserRegistrationAttemptsRepository } from './userRegistrationAttempts';
 import { UsersRepository } from './users';
-export { AcumaticaRepository, AempTokenRepository, AlertRepository, AlertTypesRepository, AppFeaturesRepository, AssetCategoriesRepository, BillingRepository, BlacklistRepository, BLEMeshConfigurationRepository, BoundariesRepository, ClientsRepository, CountriesRepository, DeactivationsRepository, DeviceBehaviorsRepository, DevicePairingsRepository, DevicesRepository, FirmwaresRepository, NotificationRecipientsRepository, PositionRepository, SecurityRepository, TasksRepository, TripRepository, UserActivationsRepository, UserAppFeedbackRepository, UserAppIncidentsRepository, UserConfigurationsRepository, UserDataDeletionRequestsRepository, UserInvitationsRepository, UserRatingRequestsRepository, UserRegistrationAttemptsRepository, UsersRepository, };
+export { AcumaticaRepository, AempTokenRepository, AlertRepository, AlertTypesRepository, AppFeaturesRepository, AssetCategoriesRepository, BillingRepository, BlacklistRepository, BLEMeshConfigurationRepository, BoundariesRepository, ClientsRepository, CountriesRepository, DeactivationsRepository, DeviceStatusRepository, DeviceBehaviorsRepository, DevicePairingsRepository, DevicesRepository, FirmwaresRepository, NotificationRecipientsRepository, PositionRepository, SecurityRepository, TasksRepository, TripRepository, UserActivationsRepository, UserAppFeedbackRepository, UserAppIncidentsRepository, UserConfigurationsRepository, UserDataDeletionRequestsRepository, UserInvitationsRepository, UserRatingRequestsRepository, UserRegistrationAttemptsRepository, UsersRepository, };

package/dist/repositories/index.js

@@ -14,6 +14,7 @@ import { DeactivationsRepository } from './deactivations';
 import { DeviceBehaviorsRepository } from './deviceBehaviors';
 import { DevicePairingsRepository } from './devicePairings';
 import { DevicesRepository } from './devices';
+import { DeviceStatusRepository } from './deviceStatus';
 import { FirmwaresRepository } from './firmwares';
 import { NotificationRecipientsRepository } from './notificationRecipients';
 import { PositionRepository } from './positions';
@@ -29,4 +30,4 @@ import { UserInvitationsRepository } from './userInvitations';
 import { UserRatingRequestsRepository } from './userRatingRequests';
 import { UserRegistrationAttemptsRepository } from './userRegistrationAttempts';
 import { UsersRepository } from './users';
-export { AcumaticaRepository, AempTokenRepository, AlertRepository, AlertTypesRepository, AppFeaturesRepository, AssetCategoriesRepository, BillingRepository, BlacklistRepository, BLEMeshConfigurationRepository, BoundariesRepository, ClientsRepository, CountriesRepository, DeactivationsRepository, DeviceBehaviorsRepository, DevicePairingsRepository, DevicesRepository, FirmwaresRepository, NotificationRecipientsRepository, PositionRepository, SecurityRepository, TasksRepository, TripRepository, UserActivationsRepository, UserAppFeedbackRepository, UserAppIncidentsRepository, UserConfigurationsRepository, UserDataDeletionRequestsRepository, UserInvitationsRepository, UserRatingRequestsRepository, UserRegistrationAttemptsRepository, UsersRepository, };
+export { AcumaticaRepository, AempTokenRepository, AlertRepository, AlertTypesRepository, AppFeaturesRepository, AssetCategoriesRepository, BillingRepository, BlacklistRepository, BLEMeshConfigurationRepository, BoundariesRepository, ClientsRepository, CountriesRepository, DeactivationsRepository, DeviceStatusRepository, DeviceBehaviorsRepository, DevicePairingsRepository, DevicesRepository, FirmwaresRepository, NotificationRecipientsRepository, PositionRepository, SecurityRepository, TasksRepository, TripRepository, UserActivationsRepository, UserAppFeedbackRepository, UserAppIncidentsRepository, UserConfigurationsRepository, UserDataDeletionRequestsRepository, UserInvitationsRepository, UserRatingRequestsRepository, UserRegistrationAttemptsRepository, UsersRepository, };

package/dist/types/deviceStatus.d.ts

@@ -0,0 +1,33 @@
+import { Client, ClientDeviceSetting, Device } from '../entities';
+import { Enums } from '.';
+interface DeviceStatusEntity {
+    imei: string;
+    clientId: number;
+    created: string;
+    sendTime: string;
+}
+export interface GetDeviceStatusesParams {
+    filters: {
+        imeiList?: string[];
+        clientId?: number;
+        minSendTime?: Date;
+        deviceStatus?: Enums.DeviceStatus;
+    };
+    projectionOptions?: {
+        deviceStatusProperties?: string[];
+        withClient?: boolean;
+        clientProperties?: (keyof Client)[];
+        withDevice?: boolean;
+        deviceProperties?: (keyof Device)[];
+        withClientDeviceSettings?: boolean;
+        clientDeviceSettingsProperties?: (keyof ClientDeviceSetting)[];
+    };
+    pagingOptions?: {
+        limit?: number;
+        offset?: number;
+    };
+}
+export interface UpsertDeviceStatusesParams {
+    items: DeviceStatusEntity[];
+}
+export {};

package/dist/types/deviceStatus.js

@@ -0,0 +1 @@
+export {};

package/package.json

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