@spytecgps/nova-orm 0.0.38 → 0.0.40

package/dist/repositories/countries/getCountry.d.ts

@@ -0,0 +1,4 @@
+import { Country } from '../../entities';
+import { NovaDataSource } from '../../novaDataSource';
+import { GetCountryParams } from '../../types/countries';
+export declare const getCountry: (novaDataSource: NovaDataSource, params: GetCountryParams) => Promise<Country>;

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

@@ -0,0 +1,13 @@
+import { Country } from '../../entities';
+import { GetCountryParams } from '../../types/countries';
+import { BaseRepository } from '../baseRepository';
+export declare class CountriesRepository extends BaseRepository {
+    /**
+     * Get country
+     * @param {GetCountryParams} params containing information to get a country
+     * - filters.id: The country id
+     * - filters.alpha2Code: The country alpha2Code
+     * @returns The country information
+     */
+    getCountry(params: GetCountryParams): Promise<Country>;
+}

package/dist/repositories/index.d.ts

@@ -1,6 +1,9 @@
 import { BoundariesRepository } from './boundaries';
 import { ClientsRepository } from './clients';
+import { CountriesRepository } from './countries';
 import { DevicesRepository } from './devices';
 import { FirmwaresRepository } from './firmwares';
+import { PositionRepository } from './positions';
 import { SecurityRepository } from './security';
-export { SecurityRepository, DevicesRepository, BoundariesRepository, ClientsRepository, FirmwaresRepository, };
+import { UsersRepository } from './users';
+export { SecurityRepository, DevicesRepository, BoundariesRepository, ClientsRepository, FirmwaresRepository, PositionRepository, UsersRepository, CountriesRepository, };

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/repositories/users/createUser.d.ts

@@ -0,0 +1,4 @@
+import { User } from '../../entities/user';
+import { NovaDataSource } from '../../novaDataSource';
+import { CreateUserParams } from '../../types/user';
+export declare const createUser: (novaDataSource: NovaDataSource, params: CreateUserParams) => Promise<User>;

package/dist/repositories/users/deleteUser.d.ts

@@ -0,0 +1,3 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { DeleteUserParams } from '../../types/user';
+export declare const deleteUser: (novaDataSource: NovaDataSource, params: DeleteUserParams) => Promise<boolean>;

package/dist/repositories/users/getUserById.d.ts

@@ -0,0 +1,4 @@
+import { User } from '../../entities';
+import { NovaDataSource } from '../../novaDataSource';
+import { GetUserByIdParams } from '../../types/user';
+export declare const getUserById: (novaDataSource: NovaDataSource, params: GetUserByIdParams) => Promise<User>;

package/dist/repositories/users/getUsers.d.ts

@@ -0,0 +1,4 @@
+import { User } from '../../entities';
+import { NovaDataSource } from '../../novaDataSource';
+import { GetUsersParams } from '../../types/user';
+export declare const getUsers: (novaDataSource: NovaDataSource, params: GetUsersParams) => Promise<User[]>;

package/dist/repositories/users/getUsersIdByPhoneAndCountryCode.d.ts

@@ -0,0 +1,3 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { GetUsersIdsByPhoneAndCountryCodeParams } from '../../types/user';
+export declare const getUsersIdsByPhoneAndCountryCode: (novaDataSource: NovaDataSource, params: GetUsersIdsByPhoneAndCountryCodeParams) => Promise<string[]>;

package/dist/repositories/users/getUsersWithRoles.d.ts

@@ -0,0 +1,3 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { GetUsersWithRolesParams, UserWithRole } from '../../types/user';
+export declare const getUsersWithRoles: (novaDataSource: NovaDataSource, params: GetUsersWithRolesParams) => Promise<UserWithRole[]>;

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

@@ -0,0 +1,111 @@
+import { User } from '../../entities/user';
+import { CreateUserParams, DeleteUserParams, GetUserByIdParams, GetUsersConfigurationByImeiParams, GetUsersIdsByPhoneAndCountryCodeParams, GetUsersParams, GetUsersWithRolesParams, UpdateUserParams, UserWithRole } from '../../types/user';
+import { BaseRepository } from '../baseRepository';
+export declare class UsersRepository extends BaseRepository {
+    /**
+     * Get user by id
+     * @param {GetUserByIdParams} params containing information to get a user by id
+     * - filters.id: The user id
+     * @returns The user information
+     */
+    getUserById(params: GetUserByIdParams): Promise<User>;
+    /**
+     * Get users with filters
+     * @param {GetUsersParams} params containing information to get users with filters
+     * - filters.clientId: The client id to obtain all users from that client
+     * - filters.email: The user email to obtain all users with that email (lower case and trimmed comparison)
+     * - filters.userName: The userName to obtain all users with that userName (lower case and trimmed comparison, using userName and preferredUserName fields)
+     * - filters.search: Search test to obtain all users with that search text (lower case and trimmed comparison, using userName, preferredUserName, email and id fields)
+     * @returns The user information
+     */
+    getUsers(params: GetUsersParams): Promise<User[]>;
+    /**
+     * Get user data by imei
+     * @param  {GetUsersConfigurationByImeiParams} params containing information to get a device by imei
+     * - filters.imei: The imei of the device
+     */
+    getUsersConfigurationByImei(params: GetUsersConfigurationByImeiParams): Promise<User[]>;
+    /**
+     * Get user ids by phone and country code
+     * @param  {GetUsersIdsByPhoneAndCountryCodeParams} params containing information to get a user by phone and country code
+     * - filters.phone: The phone of the user. If the phone parameter is in the format +[internationalDirectDialing][phone], the +[internationalDirectDialing] should correspond to the internationalDirectDialing in the user's profile
+     * - filters.countryCode: The country code of the user (US, MX, etc)
+     */
+    getUsersIdsByPhoneAndCountryCode(params: GetUsersIdsByPhoneAndCountryCodeParams): Promise<string[]>;
+    /**
+     * Get users with roles
+     * @param  {GetUsersWithRolesParams} params containing information to get users with roles
+     * - filters.clientId: The client id to obtain all users from that client
+     * - filters.roleId: The role id to obtain all users with that role, optional
+     * - filters.status: The status to obtain all users with that status, optional
+     * roleId or status must be provided
+     * @returns The user information with the role name
+     */
+    getUsersWithRoles(params: GetUsersWithRolesParams): Promise<UserWithRole[]>;
+    /**
+     * Create a new user
+     * @param  {CreateUserParams} params containing information to create a new user
+     * id: the user id, required
+     * firstName: the first name, required
+     * lastName: the last name, required
+     * companyName: the company name, optional
+     * telephone: the phone number, optional
+     * street: the street from the user's address, optional
+     * postalCode: the postal code from the user's address, optional
+     * city: the city from the user's address, optional
+     * region: the region from the user's address, optional
+     * email: the email, required
+     * userName: the user name, required
+     * preferredUserName: the preferred user name, optional
+     * status: the status, optional. If not provided, the default value is 'A' (active)
+     * clientId: the client id, required
+     * pinCode: the pin code, optional
+     * isAdmin: whether the user is administrator, optional. If not provided, the default value is false
+     * countryId: the country id, optional
+     * telephoneCountryId: the country id corresponding to the phone number, optional
+     * dataSourceTypeId?: the data source type id, optional
+     * emailVerified: whether the email is verified, optional. If not provided, the default value is true
+     * @returns The created user
+     */
+    createUser(params: CreateUserParams): Promise<User>;
+    /**
+     * Delete a user
+     * @param  {DeleteUserParams} params containing information to delete a user
+     * id: the user id, required
+     * @returns Whether the user was deleted or not
+     */
+    deleteUser(params: DeleteUserParams): Promise<boolean>;
+    /**
+     * Update a user
+     * @param  {UpdateUserParams} params containing information to update a user
+     * At least one filter must be provided:
+     * filters.userId: the user id to filter the users to update, optional
+     * filters.email: the user email to filter the users to update, optional
+     * filters.statusList: a list of status to filter the users to update, optional
+     * At least one value must be provided:
+     * values.firstName: the first name, optional
+     * values.lastName: the last name, optional
+     * values.companyName: the company name, optional
+     * values.telephone: the phone number, optional
+     * values.street: the street from the user's address, optional
+     * values.postalCode: the postal code from the user's address, optional
+     * values.city: the city from the user's address, optional
+     * values.region: the region from the user's address, optional
+     * values.email: the email, optional
+     * values.userName: the user name, optional
+     * values.preferredUserName: the preferred user name, optional
+     * values.status: the status, optional
+     * values.isAdmin: whether the user is administrator, optional
+     * values.countryId: the country id, optional
+     * values.countryCode: the country alpha2 code to find the countryId, optional (if countryId is provided, countryCode is ignored)
+     * values.telephoneCountryId: the country id corresponding to the phone number, optional
+     * values.telephoneCountryCode: the country alpha2 code to find the telephoneCountryId, optional (if telephoneCountryId is provided, telephoneCountryCode is ignored)
+     * values.dataSourceTypeId?: the data source type id, optional
+     * values.emailVerified: whether the email is verified, optional
+     * values.latitude: the latitude, optional
+     * values.longitude: the longitude, optional
+     * values.lastLoginAt: the last login date, optional
+     * @returns Whether the user was updated or not
+     */
+    updateUser(params: UpdateUserParams): Promise<boolean>;
+}

package/dist/repositories/users/updateUser.d.ts

@@ -0,0 +1,3 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { UpdateUserParams } from '../../types/user';
+export declare const updateUser: (novaDataSource: NovaDataSource, params: UpdateUserParams) => Promise<boolean>;

package/dist/types/countries.d.ts

@@ -0,0 +1,6 @@
+export interface GetCountryParams {
+    filters: {
+        id?: string;
+        alpha2Code?: string;
+    };
+}

package/dist/types/index.d.ts

@@ -4,4 +4,5 @@ import * as Devices from './devices';
 import * as Firmwares from './firmwares';
 import * as Logger from './logger';
 import * as Security from './security';
-export { Logger, Devices, Firmwares, Security, Boundaries, Clients };
+import * as Users from './user';
+export { Logger, Devices, Firmwares, Security, Boundaries, Clients, Users };

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/dist/types/user.d.ts

@@ -1,5 +1,91 @@
+import { User } from '../entities/user';
 export interface GetUsersConfigurationByImeiParams {
     filters: {
         imei: string;
     };
 }
+export interface GetUserByIdParams {
+    filters: {
+        id: string;
+    };
+}
+export interface GetUsersParams {
+    filters: {
+        email?: string;
+        userName?: string;
+        clientId?: number;
+        search?: string;
+    };
+}
+export interface GetUsersIdsByPhoneAndCountryCodeParams {
+    filters: {
+        phone: string;
+        countryCode: string;
+    };
+}
+export interface GetUsersWithRolesParams {
+    filters: {
+        clientId: number;
+        roleId?: number;
+        status?: string;
+    };
+}
+export interface UserWithRole extends User {
+    role: string;
+}
+export interface CreateUserParams {
+    id: string;
+    firstName: string;
+    lastName: string;
+    companyName?: string;
+    telephone?: string;
+    street?: string;
+    postalCode?: string;
+    city?: string;
+    region?: string;
+    email: string;
+    userName: string;
+    preferredUserName?: string;
+    status?: string;
+    clientId: number;
+    pinCode?: string;
+    isAdmin?: boolean;
+    countryId?: number;
+    telephoneCountryId?: number;
+    dataSourceTypeId?: number;
+    emailVerified?: boolean;
+}
+export interface DeleteUserParams {
+    id: string;
+}
+export interface UpdateUserParams {
+    filters: {
+        userId?: string;
+        email?: string;
+        statusList?: string[];
+    };
+    values: {
+        firstName?: string;
+        lastName?: string;
+        companyName?: string;
+        telephone?: string;
+        street?: string;
+        postalCode?: string;
+        city?: string;
+        region?: string;
+        email?: string;
+        userName?: string;
+        preferredUserName?: string;
+        status?: string;
+        isAdmin?: boolean;
+        countryId?: number;
+        countryCode?: string;
+        telephoneCountryId?: number;
+        telephoneCountryCode?: string;
+        dataSourceTypeId?: number;
+        emailVerified?: boolean;
+        latitude?: number;
+        longitude?: number;
+        lastLoginAt?: Date;
+    };
+}

package/dist/utils/mapRawEntityToEntity.d.ts

@@ -0,0 +1 @@
+export declare const mapRawEntityToEntity: <T>(rawEntity: any, columnsPrefix?: string) => T;

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@spytecgps/nova-orm",
-  "version": "0.0.38",
+  "version": "0.0.40",
   "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",

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

@@ -1,11 +0,0 @@
-import { User } from '../../entities/user';
-import { GetUsersConfigurationByImeiParams } from '../../types/user';
-import { BaseRepository } from '../baseRepository';
-export declare class UserRepository extends BaseRepository {
-    /**
-     * Get user data by imei
-     * @param  {GetUsersConfigurationByImeiParams} params containing information to get a device by imei
-     * - filters.imei: The imei of the device
-     */
-    getUsersConfigurationByImei(params: GetUsersConfigurationByImeiParams): Promise<User[]>;
-}