@spytecgps/nova-orm 1.2.35-rc1 → 1.2.36

package/dist/repositories/boundaries/index.js

@@ -1,179 +1,179 @@
-import { NovaDataSource } from '../../novaDataSource';
-import { BaseRepository } from '../baseRepository';
-import { createBoundary } from './createBoundary';
-import { deleteBoundary } from './deleteBoundary';
-import { getBoundariesByClientId } from './getBoundariesByClientId';
-import { getBoundariesIdsByClientId } from './getBoundariesIdsByClientId';
-import { getBoundariesReport } from './getBoundariesReport';
-import { getBoundaryById } from './getBoundaryById';
-import { processBoundaryEvent } from './processBoundaryEvent';
-import { updateBoundary } from './updateBoundary';
-import { upsertBoundaryEvent } from './upsertBoundaryEvent';
-export class BoundariesRepository extends BaseRepository {
-    /**
-     * Get all boundaries by client id
-     * @param  {GetBoundariesByClientIdParams} params containing information to get boundaries by clientId
-     * - filters.clientId: The client id
-     * - filters.status: The status to only obtain boundaries with that status, optional
-     */
-    async getBoundariesByClientId(params) {
-        this.logger.trace(params, 'BoundariesRepository::getBoundariesByClientId started with params');
-        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
-        const result = await getBoundariesByClientId(novaDataSource, params, this.logger);
-        this.logger.trace({ result: result.map(x => x.id) }, 'BoundariesRepository::getBoundariesByClientId result');
-        return result;
-    }
-    /**
-     * Get all boundaries ids by client id
-     * @param  {GetBoundariesByClientIdParams} params containing information to get boundaries ids by clientId
-     * - filters.clientId: The client id
-     * - filters.status: The status to only obtain boundaries with that status, optional
-     */
-    async getBoundariesIdsByClientId(params) {
-        this.logger.trace(params, 'BoundariesRepository::getBoundariesIdsByClientId started with params');
-        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
-        const result = await getBoundariesIdsByClientId(novaDataSource, params, this.logger);
-        this.logger.trace(result, 'BoundariesRepository::getBoundariesIdsByClientId result');
-        return result;
-    }
-    /**
-     * Get a boundary by id
-     * @param  {GetBoundaryByIdParams} params containing information to get a boundary by id
-     * - filters.boundaryId: The boundary id
-     */
-    async getBoundaryById(params) {
-        this.logger.trace(params, 'BoundariesRepository::getBoundaryById started with params');
-        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
-        const result = await getBoundaryById(novaDataSource, params, this.logger);
-        this.logger.trace({
-            result: {
-                ...result,
-                geometry: undefined,
-            },
-        }, 'BoundariesRepository::getBoundaryById result');
-        return result;
-    }
-    /**
-     * Create a boundary
-     * @param  {CreateBoundaryParams} params containing information to create a boundary
-     * - name: boundary name
-     * - type: boundary type
-     * - clientId: id of the client that owns the boundary
-     * - createdBy: id of the user that created the boundary
-     * - location: location of the boundary
-     * - buffer: buffer of the boundary
-     * - radiusDisplayUnit: radius display unit of the boundary
-     * - color: color of the boundary
-     * - geometry: geometry of the boundary
-     * - status: status of the boundary
-     * - dataSourceTypeId: data source type id of the boundary, optional
-     * - isUserCreated: if the boundary was created by a user, optional
-     * - area: area of the boundary, optional
-     */
-    async createBoundary(params) {
-        this.logger.trace(params, 'BoundariesRepository::createBoundary started with params');
-        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
-        const result = await createBoundary(novaDataSource, params, this.logger);
-        this.logger.trace({
-            result: {
-                ...result,
-                geometry: undefined,
-            },
-        }, 'BoundariesRepository::createBoundary result');
-        return result;
-    }
-    /**
-     * Update a boundary
-     * @param  {UpdateBoundaryParams} params containing information to update a boundary
-     * - filters.boundaryId: The id of the boundary to update
-     * - values.name: The name of the boundary. Optional, if undefined, the name will not be updated.
-     * - values.type: The type of the boundary. Optional, if undefined, the type will not be updated.
-     * - values.modifiedBy: The user id of the user that modified the boundary. Optional, if undefined, the modifiedBy will not be updated.
-     * - values.location: The location of the boundary. Optional, if undefined, the location will not be updated.
-     * - values.geometry: The geometry of the boundary. Optional, if undefined, the geometry will not be updated.
-     * - values.status: The status of the boundary. Optional, if undefined, the status will not be updated.
-     * - values.buffer: The buffer of the boundary. Optional, if undefined, the buffer will not be updated.
-     * - values.radiusDisplayUnit: The radius display unit of the boundary. Optional, if undefined, the radius display unit will not be updated.
-     * - values.color: The color of the boundary. Optional, if undefined, the color will not be updated.
-     * - values.area: The area of the boundary. Optional, if undefined, the area will not be updated.
-     */
-    async updateBoundary(params) {
-        this.logger.trace(params, 'BoundariesRepository::updateBoundary started with params');
-        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
-        const result = await updateBoundary(novaDataSource, params, this.logger);
-        this.logger.trace({ result }, 'BoundariesRepository::updateBoundary result');
-        return result;
-    }
-    /**
-     * Delete a boundary
-     * @param  {DeleteBoundaryParams} params containing information to delete a boundary
-     * The boundary will not be removed from the database, it will only be marked as deleted
-     * - filters.boundaryId: The id of the boundary to delete
-     * - values.modifiedBy: The user id of the user that deleted the boundary
-     */
-    async deleteBoundary(params) {
-        this.logger.trace(params, 'BoundariesRepository::deleteBoundary started with params');
-        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
-        const result = await deleteBoundary(novaDataSource, params, this.logger);
-        this.logger.trace({ result }, 'BoundariesRepository::deleteBoundary result');
-        return result;
-    }
-    /**
-     * 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
-     */
-    async getBoundariesReport(params) {
-        this.logger.trace(params, 'BoundariesRepository::getBoundariesReport started with params');
-        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
-        const result = await getBoundariesReport(novaDataSource, params, this.logger);
-        this.logger.trace(result, 'BoundariesRepository::getBoundariesReport result');
-        return result;
-    }
-    /**
-     * Process boundary event
-     * @param  {ProcessBoundaryEventParams} params containing information to process boundary event
-     * - boundaryId: The boundary id
-     * - imei: The imei of the device
-     * - userId: The user id
-     * - sendTime: The event date
-     * - eventType: The event type (enter or exit)
-     * - lat: The latitude of the event
-     * - lon: The longitude of the event
-     * - address: The address of the event
-     * @returns true if the event was processed, false otherwise
-     */
-    async processBoundaryEvent(params) {
-        this.logger.trace(params, 'BoundariesRepository::processBoundaryEvent started with params');
-        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
-        const result = await processBoundaryEvent(novaDataSource, params, this.logger);
-        this.logger.trace({ result }, 'BoundariesRepository::processBoundaryEvent result');
-        return result;
-    }
-    /**
-     * Upsert boundary event
-     * @param  {UpsertBoundaryEventParams} params containing information to upsert boundary event
-     * - id: The id of the boundary event
-     * @returns true if the event was upserted, false otherwise
-     */
-    async upsertBoundaryEvent(params) {
-        this.logger.trace(params, 'BoundariesRepository::upsertBoundaryEvent started with params');
-        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
-        const result = await upsertBoundaryEvent(novaDataSource, params, this.logger);
-        this.logger.trace({ result }, 'BoundariesRepository::upsertBoundaryEvent result');
-        return result;
-    }
-}
+import { NovaDataSource } from '../../novaDataSource';
+import { BaseRepository } from '../baseRepository';
+import { createBoundary } from './createBoundary';
+import { deleteBoundary } from './deleteBoundary';
+import { getBoundariesByClientId } from './getBoundariesByClientId';
+import { getBoundariesIdsByClientId } from './getBoundariesIdsByClientId';
+import { getBoundariesReport } from './getBoundariesReport';
+import { getBoundaryById } from './getBoundaryById';
+import { processBoundaryEvent } from './processBoundaryEvent';
+import { updateBoundary } from './updateBoundary';
+import { upsertBoundaryEvent } from './upsertBoundaryEvent';
+export class BoundariesRepository extends BaseRepository {
+    /**
+     * Get all boundaries by client id
+     * @param  {GetBoundariesByClientIdParams} params containing information to get boundaries by clientId
+     * - filters.clientId: The client id
+     * - filters.status: The status to only obtain boundaries with that status, optional
+     */
+    async getBoundariesByClientId(params) {
+        this.logger.trace(params, 'BoundariesRepository::getBoundariesByClientId started with params');
+        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
+        const result = await getBoundariesByClientId(novaDataSource, params, this.logger);
+        this.logger.trace({ result: result.map(x => x.id) }, 'BoundariesRepository::getBoundariesByClientId result');
+        return result;
+    }
+    /**
+     * Get all boundaries ids by client id
+     * @param  {GetBoundariesByClientIdParams} params containing information to get boundaries ids by clientId
+     * - filters.clientId: The client id
+     * - filters.status: The status to only obtain boundaries with that status, optional
+     */
+    async getBoundariesIdsByClientId(params) {
+        this.logger.trace(params, 'BoundariesRepository::getBoundariesIdsByClientId started with params');
+        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
+        const result = await getBoundariesIdsByClientId(novaDataSource, params, this.logger);
+        this.logger.trace(result, 'BoundariesRepository::getBoundariesIdsByClientId result');
+        return result;
+    }
+    /**
+     * Get a boundary by id
+     * @param  {GetBoundaryByIdParams} params containing information to get a boundary by id
+     * - filters.boundaryId: The boundary id
+     */
+    async getBoundaryById(params) {
+        this.logger.trace(params, 'BoundariesRepository::getBoundaryById started with params');
+        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
+        const result = await getBoundaryById(novaDataSource, params, this.logger);
+        this.logger.trace({
+            result: {
+                ...result,
+                geometry: undefined,
+            },
+        }, 'BoundariesRepository::getBoundaryById result');
+        return result;
+    }
+    /**
+     * Create a boundary
+     * @param  {CreateBoundaryParams} params containing information to create a boundary
+     * - name: boundary name
+     * - type: boundary type
+     * - clientId: id of the client that owns the boundary
+     * - createdBy: id of the user that created the boundary
+     * - location: location of the boundary
+     * - buffer: buffer of the boundary
+     * - radiusDisplayUnit: radius display unit of the boundary
+     * - color: color of the boundary
+     * - geometry: geometry of the boundary
+     * - status: status of the boundary
+     * - dataSourceTypeId: data source type id of the boundary, optional
+     * - isUserCreated: if the boundary was created by a user, optional
+     * - area: area of the boundary, optional
+     */
+    async createBoundary(params) {
+        this.logger.trace(params, 'BoundariesRepository::createBoundary started with params');
+        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
+        const result = await createBoundary(novaDataSource, params, this.logger);
+        this.logger.trace({
+            result: {
+                ...result,
+                geometry: undefined,
+            },
+        }, 'BoundariesRepository::createBoundary result');
+        return result;
+    }
+    /**
+     * Update a boundary
+     * @param  {UpdateBoundaryParams} params containing information to update a boundary
+     * - filters.boundaryId: The id of the boundary to update
+     * - values.name: The name of the boundary. Optional, if undefined, the name will not be updated.
+     * - values.type: The type of the boundary. Optional, if undefined, the type will not be updated.
+     * - values.modifiedBy: The user id of the user that modified the boundary. Optional, if undefined, the modifiedBy will not be updated.
+     * - values.location: The location of the boundary. Optional, if undefined, the location will not be updated.
+     * - values.geometry: The geometry of the boundary. Optional, if undefined, the geometry will not be updated.
+     * - values.status: The status of the boundary. Optional, if undefined, the status will not be updated.
+     * - values.buffer: The buffer of the boundary. Optional, if undefined, the buffer will not be updated.
+     * - values.radiusDisplayUnit: The radius display unit of the boundary. Optional, if undefined, the radius display unit will not be updated.
+     * - values.color: The color of the boundary. Optional, if undefined, the color will not be updated.
+     * - values.area: The area of the boundary. Optional, if undefined, the area will not be updated.
+     */
+    async updateBoundary(params) {
+        this.logger.trace(params, 'BoundariesRepository::updateBoundary started with params');
+        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
+        const result = await updateBoundary(novaDataSource, params, this.logger);
+        this.logger.trace({ result }, 'BoundariesRepository::updateBoundary result');
+        return result;
+    }
+    /**
+     * Delete a boundary
+     * @param  {DeleteBoundaryParams} params containing information to delete a boundary
+     * The boundary will not be removed from the database, it will only be marked as deleted
+     * - filters.boundaryId: The id of the boundary to delete
+     * - values.modifiedBy: The user id of the user that deleted the boundary
+     */
+    async deleteBoundary(params) {
+        this.logger.trace(params, 'BoundariesRepository::deleteBoundary started with params');
+        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
+        const result = await deleteBoundary(novaDataSource, params, this.logger);
+        this.logger.trace({ result }, 'BoundariesRepository::deleteBoundary result');
+        return result;
+    }
+    /**
+     * 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
+     */
+    async getBoundariesReport(params) {
+        this.logger.trace(params, 'BoundariesRepository::getBoundariesReport started with params');
+        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
+        const result = await getBoundariesReport(novaDataSource, params, this.logger);
+        this.logger.trace(result, 'BoundariesRepository::getBoundariesReport result');
+        return result;
+    }
+    /**
+     * Process boundary event
+     * @param  {ProcessBoundaryEventParams} params containing information to process boundary event
+     * - boundaryId: The boundary id
+     * - imei: The imei of the device
+     * - userId: The user id
+     * - sendTime: The event date
+     * - eventType: The event type (enter or exit)
+     * - lat: The latitude of the event
+     * - lon: The longitude of the event
+     * - address: The address of the event
+     * @returns true if the event was processed, false otherwise
+     */
+    async processBoundaryEvent(params) {
+        this.logger.trace(params, 'BoundariesRepository::processBoundaryEvent started with params');
+        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
+        const result = await processBoundaryEvent(novaDataSource, params, this.logger);
+        this.logger.trace({ result }, 'BoundariesRepository::processBoundaryEvent result');
+        return result;
+    }
+    /**
+     * Upsert boundary event
+     * @param  {UpsertBoundaryEventParams} params containing information to upsert boundary event
+     * - id: The id of the boundary event
+     * @returns true if the event was upserted, false otherwise
+     */
+    async upsertBoundaryEvent(params) {
+        this.logger.trace(params, 'BoundariesRepository::upsertBoundaryEvent started with params');
+        const novaDataSource = new NovaDataSource(this.novaDataSourceConfig, this.logger, this.replicaNovaDataSourceConfig);
+        const result = await upsertBoundaryEvent(novaDataSource, params, this.logger);
+        this.logger.trace({ result }, 'BoundariesRepository::upsertBoundaryEvent result');
+        return result;
+    }
+}
 //# sourceMappingURL=index.js.map

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

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