@spytecgps/nova-orm 0.0.59 → 0.0.61

package/dist/repositories/index.d.ts

@@ -7,8 +7,9 @@ import { DevicesRepository } from './devices';
 import { FirmwaresRepository } from './firmwares';
 import { PositionRepository } from './positions';
 import { SecurityRepository } from './security';
+import { UserConfigurationsRepository } from './userConfigurations';
 import { UserDataDeletionRequestsRepository } from './userDataDeletionRequests';
 import { UserInvitationsRepository } from './userInvitations';
 import { UserRatingRequestsRepository } from './userRatingRequests';
 import { UsersRepository } from './users';
-export { SecurityRepository, DevicesRepository, BoundariesRepository, ClientsRepository, FirmwaresRepository, PositionRepository, AlertRepository, UsersRepository, CountriesRepository, UserInvitationsRepository, UserDataDeletionRequestsRepository, UserRatingRequestsRepository, DeviceBehaviorsRepository, };
+export { AlertRepository, BoundariesRepository, ClientsRepository, CountriesRepository, DeviceBehaviorsRepository, DevicesRepository, FirmwaresRepository, PositionRepository, SecurityRepository, UserConfigurationsRepository, UserDataDeletionRequestsRepository, UserInvitationsRepository, UserRatingRequestsRepository, UsersRepository, };

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

@@ -1,6 +1,7 @@
+import { InsertResult } from 'typeorm';
 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 upsertPositions: (novaDataSource: NovaDataSource, params: CreatePositionParams[], logger: Logger) => Promise<any>;
+export declare const upsertPositions: (novaDataSource: NovaDataSource, params: CreatePositionParams[], logger: Logger) => Promise<InsertResult>;

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

@@ -1,3 +1,4 @@
+import { InsertResult } from 'typeorm';
 import { Position } from '../../entities';
 import { CreatePositionParams, GetPositionsByImeiParams, GetPositionsReportByClientParams, PositionReport } from '../../types/position';
 import { BaseRepository } from '../baseRepository';
@@ -39,7 +40,7 @@ export declare class PositionRepository extends BaseRepository {
      * - gpsUtcTime: the time the gps was set
      * - externalBatteryPercentage: the external battery percentage reported by the device
      */
-    upsertPositions(params: CreatePositionParams[]): Promise<any>;
+    upsertPositions(params: CreatePositionParams[]): Promise<InsertResult>;
     /**
      * Get positions by imei
      * @param  {GetPositionsByImeiParams} params containing information to get positions

package/dist/repositories/userConfigurations/bulkCreateUserAlertConfigurations.d.ts

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

package/dist/repositories/userConfigurations/createUserConfiguration.d.ts

@@ -0,0 +1,5 @@
+import { UserConfiguration } from '../../entities/userConfiguration';
+import { NovaDataSource } from '../../novaDataSource';
+import { Logger } from '../../types/logger';
+import { CreateUserConfigurationParams } from '../../types/userConfigurations';
+export declare const createUserConfiguration: (novaDataSource: NovaDataSource, params: CreateUserConfigurationParams, logger: Logger) => Promise<UserConfiguration>;

package/dist/repositories/userConfigurations/deleteUserAlertConfigurations.d.ts

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

package/dist/repositories/userConfigurations/deleteUserConfiguration.d.ts

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

package/dist/repositories/userConfigurations/getUserAlertConfigurations.d.ts

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

package/dist/repositories/userConfigurations/getUserConfigurations.d.ts

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

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

@@ -0,0 +1,104 @@
+import { UserAlertConfiguration, UserConfiguration } from '../../entities';
+import { BulkCreateUserAlertConfigurationsParams, CreateUserConfigurationParams, DeleteUserAlertConfigurationsParams, DeleteUserConfigurationParams, GetUserAlertConfigurationsParams, GetUserConfigurationsParams, UpdateUserAlertConfigurationsParams, UpdateUserConfigurationParams } from '../../types/userConfigurations';
+import { BaseRepository } from '../baseRepository';
+export declare class UserConfigurationsRepository extends BaseRepository {
+    /**
+     * Get user configurations
+     * @param {GetUserConfigurationsParams} params containing information to get user configurations
+     * - filters.clientId: The client id to obtain all user configurations from that client
+     * - filters.userId: The user id to obtain all user configurations from that user
+     * @returns The user configurations
+     */
+    getUserConfigurations(params: GetUserConfigurationsParams): Promise<UserConfiguration[]>;
+    /**
+     * Create user configuration
+     * @param {CreateUserConfigurationParams} params containing information to create a user configuration
+     * - id: The user configuration id, optional. If not provided, it will be generated
+     * - userId: The user id, required
+     * - isMetric: Whether is metric, required
+     * - timezone: The user timezone, optional
+     * - defaultMapLayer: The user default map layer, optional
+     * - speedUnits: The user speed units, optional
+     * - distanceUnits: The user distance units, optional
+     * - alertsNotificationsOn: The user alerts notifications on, optional. If not provided, it will be true
+     * - dataSourceTypeId: The user data source type id, optional
+     * - homepage: The user homepage, optional
+     * - temperatureUnits: The user temperature units, optional
+     * @returns The created user configuration
+     */
+    createUserConfiguration(params: CreateUserConfigurationParams): Promise<UserConfiguration>;
+    /**
+     * Update user configuration
+     * @param {UpdateUserConfigurationParams} params containing information to update a user configuration
+     * Filters:
+     * - filters.userId: The user id to update the user configuration, required
+     * Values:
+     * One of the following values is required
+     * - values.timezone: The user timezone, optional
+     * - values.defaultMapLayer: The user default map layer, optional
+     * - values.speedUnits: The user speed units, optional
+     * - values.distanceUnits: The user distance units, optional
+     * - values.alertsNotificationsOn: The user alerts notifications on, optional
+     * - values.dataSourceTypeId: The user data source type id, optional
+     * - values.homepage: The user homepage, optional
+     * - values.temperatureUnits: The user temperature units, optional
+     * @returns Whether the user configuration was updated
+     */
+    updateUserConfiguration(params: UpdateUserConfigurationParams): Promise<boolean>;
+    /**
+     * Delete user configuration
+     * @param {DeleteUserConfigurationParams} params containing information to delete a user configuration
+     * - filters.userId: The user id to delete the user configuration, required
+     * @returns Whether the user configuration was deleted
+     */
+    deleteUserConfiguration(params: DeleteUserConfigurationParams): Promise<boolean>;
+    /**
+     * Get user alert configurations
+     * @param {GetUserAlertConfigurationsParams} params containing information to get user alert configurations
+     * - filters.userId: The user id to obtain all user alert configurations from that user, required
+     * - filters.includeBeta: Whether to include beta alert types, required
+     * @returns The user alert configurations
+     */
+    getUserAlertConfigurations(params: GetUserAlertConfigurationsParams): Promise<UserAlertConfiguration[]>;
+    /**
+     * Bulk create user alert configurations
+     * @param {BulkCreateUserAlertConfigurationsParams} params containing information to bulk create user alert configurations
+     * - alertConfigurations: The user alert configurations to create, required
+     * Each user alert configuration should contain:
+     * - id: The user alert configuration id, optional. If not provided, it will be generated
+     * - userId: The user id, required
+     * - alertTypeId: The alert type id, required
+     * - smsNotification: The user sms notification, optional
+     * - emailNotification: The user email notification, optional
+     * - appNotification: The user app notification, optional. If not provided, it will be true
+     * - pushNotification: The user push notification, optional. If not provided, it will be true
+     * - alertValue: The user alert value, optional
+     * - alertMetadata: The user alert metadata, optional
+     * @returns Whether the user alert configurations were created
+     */
+    bulkCreateUserAlertConfigurations(params: BulkCreateUserAlertConfigurationsParams): Promise<boolean>;
+    /**
+     * Update user alert configurations
+     * @param {UpdateUserAlertConfigurationsParams} params containing information to update user alert configurations
+     * Filters:
+     * - filters.userId: The user id to update the user alert configurations, required
+     * - filters.alertTypeId: The alert type id to update the user alert configurations, optional
+     * Values:
+     * One of the following values is required
+     * - values.smsNotification: The user sms notification, optional
+     * - values.emailNotification: The user email notification, optional
+     * - values.appNotification: The user app notification, optional
+     * - values.pushNotification: The user push notification, optional
+     * - values.alertValue: The user alert value, optional
+     * - values.alertMetadata: The user alert metadata, optional
+     * @returns Whether the user alert configurations were updated
+     */
+    updateUserAlertConfigurations(params: UpdateUserAlertConfigurationsParams): Promise<boolean>;
+    /**
+     * Delete user alert configurations
+     * @param {DeleteUserAlertConfigurationsParams} params containing information to delete user alert configurations
+     * - filters.userId: The user id to delete the user alert configurations, required
+     * @returns Whether the user alert configurations were deleted
+     */
+    deleteUserAlertConfigurations(params: DeleteUserAlertConfigurationsParams): Promise<boolean>;
+}

package/dist/repositories/userConfigurations/updateUserAlertConfigurations.d.ts

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

package/dist/repositories/userConfigurations/updateUserConfiguration.d.ts

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

package/dist/types/index.d.ts

@@ -6,7 +6,8 @@ import * as Firmwares from './firmwares';
 import * as Logger from './logger';
 import * as Security from './security';
 import * as Users from './user';
+import * as UserConfigurations from './userConfigurations';
 import * as UserDataDeletionRequests from './userDataDeletionRequests';
 import * as UserInvitations from './userInvitations';
 import * as UserRatingRequests from './userRatingRequests';
-export { Logger, Devices, Firmwares, Security, Boundaries, Clients, Users, UserInvitations, UserDataDeletionRequests, UserRatingRequests, DeviceBehaviors, };
+export { Boundaries, Clients, DeviceBehaviors, Devices, Firmwares, Logger, Security, Users, UserConfigurations, UserDataDeletionRequests, UserInvitations, UserRatingRequests, };

package/dist/types/userConfigurations.d.ts

@@ -0,0 +1,78 @@
+export interface GetUserConfigurationsParams {
+    filters: {
+        clientId?: number;
+        userId?: string;
+    };
+}
+export interface CreateUserConfigurationParams {
+    id?: number;
+    userId: string;
+    isMetric: boolean;
+    timezone?: string;
+    defaultMapLayer?: string;
+    speedUnits?: string;
+    distanceUnits?: string;
+    alertsNotificationsOn?: boolean;
+    dataSourceTypeId?: number;
+    homepage?: string;
+    temperatureUnits?: string;
+}
+export interface UpdateUserConfigurationParams {
+    filters: {
+        userId: string;
+    };
+    values: {
+        timezone?: string;
+        defaultMapLayer?: string;
+        speedUnits?: string;
+        distanceUnits?: string;
+        alertsNotificationsOn?: boolean;
+        dataSourceTypeId?: number;
+        homepage?: string;
+        temperatureUnits?: string;
+    };
+}
+export interface DeleteUserConfigurationParams {
+    filters: {
+        userId: string;
+    };
+}
+export interface GetUserAlertConfigurationsParams {
+    filters: {
+        userId: string;
+        includeBeta: boolean;
+    };
+}
+export interface CreateUserAlertConfigurationParams {
+    id?: number;
+    userId: string;
+    alertTypeId: number;
+    smsNotification?: boolean;
+    emailNotification?: boolean;
+    appNotification?: boolean;
+    pushNotification?: boolean;
+    alertValue?: string;
+    alertMetadata?: string;
+}
+export interface BulkCreateUserAlertConfigurationsParams {
+    alertConfigurations: CreateUserAlertConfigurationParams[];
+}
+export interface UpdateUserAlertConfigurationsParams {
+    filters: {
+        userId: string;
+        alertTypeId?: number;
+    };
+    values: {
+        smsNotification?: boolean;
+        emailNotification?: boolean;
+        appNotification?: boolean;
+        pushNotification?: boolean;
+        alertValue?: string;
+        alertMetadata?: string;
+    };
+}
+export interface DeleteUserAlertConfigurationsParams {
+    filters: {
+        userId: string;
+    };
+}

package/package.json

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