@spytecgps/nova-orm 0.0.16 → 0.0.18

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,67 @@
+import { Geofence } from '../../entities';
+import { CreateBoundaryParams, DeleteBoundaryParams, GetBoundariesByClientIdParams, GetBoundaryByIdParams, UpdateBoundaryParams } from '../../types/boundaries';
+import { BaseRepository } from '../baseRepository';
+export declare 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
+     */
+    getBoundariesByClientId(params: GetBoundariesByClientIdParams): Promise<Geofence[]>;
+    /**
+     * 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
+     */
+    getBoundariesIdsByClientId(params: GetBoundariesByClientIdParams): Promise<number[]>;
+    /**
+     * Get a boundary by id
+     * @param  {GetBoundaryByIdParams} params containing information to get a boundary by id
+     * - filters.boundaryId: The boundary id
+     */
+    getBoundaryById(params: GetBoundaryByIdParams): Promise<Geofence>;
+    /**
+     * 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
+     */
+    createBoundary(params: CreateBoundaryParams): Promise<Geofence>;
+    /**
+     * 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.
+     */
+    updateBoundary(params: UpdateBoundaryParams): Promise<boolean>;
+    /**
+     * 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
+     */
+    deleteBoundary(params: DeleteBoundaryParams): Promise<boolean>;
+}

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

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

package/dist/repositories/index.d.ts

@@ -1,3 +1,4 @@
+import { BoundariesRepository } from './boundaries';
 import { DevicesRepository } from './devices';
 import { SecurityRepository } from './security';
-export { SecurityRepository, DevicesRepository };
+export { SecurityRepository, DevicesRepository, BoundariesRepository };

package/dist/types/boundaries.d.ts

@@ -0,0 +1,56 @@
+import { BoundaryStatus } from './enums';
+export interface GetBoundariesByClientIdParams {
+    filters: {
+        clientId: number;
+        status?: BoundaryStatus;
+    };
+}
+export interface GetBoundaryByIdParams {
+    filters: {
+        boundaryId: number;
+    };
+}
+export interface CreateBoundaryParams {
+    name: string;
+    type: string;
+    clientId: number;
+    createdBy: string;
+    location: string;
+    buffer: string;
+    radiusDisplayUnit: string;
+    color: string;
+    geometry: string;
+    status: BoundaryStatus;
+    dataSourceTypeId?: number;
+    isUserCreated?: boolean;
+    area?: number;
+    centerLat?: number;
+    centerLon?: number;
+}
+export interface UpdateBoundaryParams {
+    filters: {
+        boundaryId: number;
+    };
+    values: {
+        name?: string;
+        type?: string;
+        modifiedBy?: string;
+        location?: string;
+        buffer?: string;
+        radiusDisplayUnit?: string;
+        color?: string;
+        geometry?: string;
+        status?: BoundaryStatus;
+        area?: number;
+        centerLat?: number;
+        centerLon?: number;
+    };
+}
+export interface DeleteBoundaryParams {
+    filters: {
+        boundaryId: number;
+    };
+    values: {
+        modifiedBy: string;
+    };
+}

package/dist/types/enums.d.ts

@@ -7,3 +7,8 @@ export declare enum DeviceStatus {
     Active = "A",
     Deleted = "D"
 }
+export declare enum BoundaryStatus {
+    Active = 1,
+    Inactive = 2,
+    Deleted = 3
+}

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
+import * as Boundaries from './boundaries';
 import * as Devices from './devices';
 import * as Logger from './logger';
 import * as Security from './security';
-export { Logger, Devices, Security };
+export { Logger, Devices, Security, Boundaries };

package/dist/utils/uuidHelpers.d.ts

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

package/package.json

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