@spytecgps/nova-orm 0.0.10 → 0.0.12

package/dist/novaDataSource.d.ts

@@ -1,4 +1,5 @@
 import { DataSource, EntityTarget, LoggerOptions, ObjectLiteral, Repository, SelectQueryBuilder } from 'typeorm';
+import { Logger } from './types/logger';
 export interface NovaDataSourceConfig {
     /**
      * Database username.
@@ -31,7 +32,8 @@ export interface NovaDataSourceConfig {
 }
 export declare class NovaDataSource {
     protected readonly dataSource: DataSource;
-    constructor(config: NovaDataSourceConfig);
+    protected readonly logger: Logger;
+    constructor(config: NovaDataSourceConfig, logger: Logger);
     /**
      * Performs connection to the database.
      */

package/dist/repositories/baseRepository.d.ts

@@ -1,5 +1,7 @@
 import { NovaDataSourceConfig } from '../novaDataSource';
+import { Logger } from '../types/logger';
 export declare class BaseRepository {
     protected readonly novaDataSourceConfig: NovaDataSourceConfig;
-    constructor(config: NovaDataSourceConfig);
+    protected readonly logger: Logger;
+    constructor(config: NovaDataSourceConfig, logger: Logger);
 }

package/dist/repositories/devices/getDeviceByImei.d.ts

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

package/dist/repositories/devices/getDeviceTypes.d.ts

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

package/dist/repositories/devices/getDevicesByDeviceTypeId.d.ts

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

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

@@ -0,0 +1,28 @@
+import { Device, DeviceType } from '../../entities';
+import { GetDeviceByImeiParams, GetDevicesByDeviceTypeIdParams, GetDeviceTypesParams } from '../../types/devices';
+import { BaseRepository } from './../baseRepository';
+export declare class DevicesRepository extends BaseRepository {
+    /**
+     * Get device by imei
+     * @param  {GetDeviceByImeiParams} params containing information to get a device by imei
+     * - filters.imei: The imei of the device
+     * - projectionOptions.withDeviceType: Whether to get the device type object
+     * - projectionOptions.withIccidCarrier: Whether to get the iccid carrier object
+     */
+    getDeviceByImei(params: GetDeviceByImeiParams): Promise<Device>;
+    /**
+     * Get devices by type id
+     * @param  {GetDevicesByDeviceTypeIdParams} params containing information to get devices by type id
+     * - filters.deviceTypeId: The device type id
+     * - filters.onlyActiveDevices: Whether to get only active devices
+     * - projectionOptions.withDeviceType: Whether to get the device type object
+     * - projectionOptions.withIccidCarrier: Whether to get the iccid carrier object
+     */
+    getDevicesByDeviceTypeId(params: GetDevicesByDeviceTypeIdParams): Promise<Device[]>;
+    /**
+     * Get device types
+     * @param  {GetDeviceTypesParams} params containing information to get device types
+     * - filters.onlyWithRelatedIccidCarrier: Whether to get only device types with iccid carrier
+     */
+    getDeviceTypes(params: GetDeviceTypesParams): Promise<DeviceType[]>;
+}

package/dist/repositories/index.d.ts

@@ -1,3 +1,3 @@
-import { DevicesRepository } from './devicesRepository';
-import { SecurityRepository } from './securityRepository';
+import { DevicesRepository } from './devices';
+import { SecurityRepository } from './security';
 export { SecurityRepository, DevicesRepository };

package/dist/repositories/security/getAllRoles.d.ts

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

package/dist/repositories/security/getUserRoles.d.ts

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

package/dist/repositories/security/getUserRolesByClientId.d.ts

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

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

@@ -0,0 +1,29 @@
+import { SecurityRole, UserSecurityRole } from '../../entities';
+import { GetUserRolesByClientIdParams, GetUserRolesParams, UserIsInRoleParams } from '../../types/security';
+import { BaseRepository } from '../baseRepository';
+export declare class SecurityRepository extends BaseRepository {
+    /**
+     * Get all security roles
+     */
+    getAllRoles(): Promise<SecurityRole[]>;
+    /**
+     * Get roles of the user
+     * @param  {GetUserRolesParams} params containing information to get roles of the user
+     * - filters.userId: The user id
+     */
+    getUserRoles(params: GetUserRolesParams): Promise<UserSecurityRole[]>;
+    /**
+     * Get user roles by clientId
+     * @param  {GetUserRolesByClientIdParams} params containing information to get user roles by clientId
+     * - filters.clientId: The client id
+     * - filters.role: The role to only obtain user roles with that role, optional
+     */
+    getUserRolesByClientId(params: GetUserRolesByClientIdParams): Promise<UserSecurityRole[]>;
+    /**
+     * Whether the user is in role
+     * @param  {UserIsInRoleParams} params containing information to know if the user is in role
+     * - filters.userId: The user id
+     * - filters.role: The role to check if the user is in that role
+     */
+    userIsInRole(params: UserIsInRoleParams): Promise<boolean>;
+}

package/dist/repositories/security/userIsInRole.d.ts

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

package/dist/types/devices.d.ts

@@ -0,0 +1,24 @@
+export interface GetDeviceByImeiParams {
+    filters: {
+        imei: string;
+    };
+    projectionOptions: {
+        withDeviceType: boolean;
+        withIccidCarrier: boolean;
+    };
+}
+export interface GetDevicesByDeviceTypeIdParams {
+    filters: {
+        deviceTypeId: number;
+        onlyActiveDevices: boolean;
+    };
+    projectionOptions: {
+        withDeviceType: boolean;
+        withIccidCarrier: boolean;
+    };
+}
+export interface GetDeviceTypesParams {
+    filters: {
+        onlyWithRelatedIccidCarrier: boolean;
+    };
+}

package/dist/types/index.d.ts

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

package/dist/types/logger.d.ts

@@ -0,0 +1,68 @@
+export interface LogFn {
+    (msg: string, ...args: any[]): void;
+    (obj: object, msg?: string, ...args: any[]): void;
+}
+export declare enum LogLevel {
+    FATAL = "fatal",
+    ERROR = "error",
+    WARN = "warn",
+    INFO = "info",
+    DEBUG = "debug",
+    TRACE = "trace"
+}
+export interface Logger {
+    /**
+     * Log at `'fatal'` level the given msg. If the first argument is an object, all its properties will be included in the JSON line.
+     * If more args follows `msg`, these will be used to format `msg` using `util.format`.
+     *
+     * @param obj: object to be serialized
+     * @param msg: the log message to write
+     * @param ...args: format string values when `msg` is a format string
+     */
+    fatal: LogFn;
+    /**
+     * Log at `'error'` level the given msg. If the first argument is an object, all its properties will be included in the JSON line.
+     * If more args follows `msg`, these will be used to format `msg` using `util.format`.
+     *
+     * @param obj: object to be serialized
+     * @param msg: the log message to write
+     * @param ...args: format string values when `msg` is a format string
+     */
+    error: LogFn;
+    /**
+     * Log at `'warn'` level the given msg. If the first argument is an object, all its properties will be included in the JSON line.
+     * If more args follows `msg`, these will be used to format `msg` using `util.format`.
+     *
+     * @param obj: object to be serialized
+     * @param msg: the log message to write
+     * @param ...args: format string values when `msg` is a format string
+     */
+    warn: LogFn;
+    /**
+     * Log at `'info'` level the given msg. If the first argument is an object, all its properties will be included in the JSON line.
+     * If more args follows `msg`, these will be used to format `msg` using `util.format`.
+     *
+     * @param obj: object to be serialized
+     * @param msg: the log message to write
+     * @param ...args: format string values when `msg` is a format string
+     */
+    info: LogFn;
+    /**
+     * Log at `'debug'` level the given msg. If the first argument is an object, all its properties will be included in the JSON line.
+     * If more args follows `msg`, these will be used to format `msg` using `util.format`.
+     *
+     * @param obj: object to be serialized
+     * @param msg: the log message to write
+     * @param ...args: format string values when `msg` is a format string
+     */
+    debug: LogFn;
+    /**
+     * Log at `'trace'` level the given msg. If the first argument is an object, all its properties will be included in the JSON line.
+     * If more args follows `msg`, these will be used to format `msg` using `util.format`.
+     *
+     * @param obj: object to be serialized
+     * @param msg: the log message to write
+     * @param ...args: format string values when `msg` is a format string
+     */
+    trace: LogFn;
+}

package/dist/types/security.d.ts

@@ -0,0 +1,18 @@
+import { HapnSecurityRole } from './enums';
+export interface GetUserRolesParams {
+    filters: {
+        userId: string;
+    };
+}
+export interface GetUserRolesByClientIdParams {
+    filters: {
+        clientId: number;
+        role?: HapnSecurityRole;
+    };
+}
+export interface UserIsInRoleParams {
+    filters: {
+        userId: string;
+        role: HapnSecurityRole;
+    };
+}

package/dist/utils/writeToLog.d.ts

@@ -0,0 +1,2 @@
+import { Logger, LogLevel } from '../types/logger';
+export declare const writeToLog: (logger: Logger, level: LogLevel, obj: any, message: string) => void;

package/package.json

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

package/dist/repositories/devicesRepository.d.ts

@@ -1,24 +0,0 @@
-import { Device, DeviceType } from '../entities';
-import { BaseRepository } from './baseRepository';
-export interface GetDevicesOptions {
-    withDeviceType: boolean;
-    withIccidCarrier: boolean;
-}
-export declare class DevicesRepository extends BaseRepository {
-    /**
-     * Get device by imei
-     * @param  {string} imei The imei of the device
-     */
-    getDeviceByImei(imei: string, options: GetDevicesOptions): Promise<Device>;
-    /**
-     * Get devices by type id
-     * @param  {number} deviceTypeId The device type id
-     * @param  {boolean} onlyActiveDevices Whether to get only active devices
-     */
-    getDevicesByDeviceTypeId(deviceTypeId: number, onlyActiveDevices: boolean, options: GetDevicesOptions): Promise<Device[]>;
-    /**
-     * Get device types
-     * @param  {boolean} onlyWithRelatedIccidCarrier Whether to get only device types with iccid carrier
-     */
-    getDeviceTypes(onlyWithRelatedIccidCarrier: boolean): Promise<DeviceType[]>;
-}

package/dist/repositories/securityRepository.d.ts

@@ -1,21 +0,0 @@
-import { SecurityRole, UserSecurityRole } from '../entities';
-import { HapnSecurityRole } from '../types/enums';
-import { BaseRepository } from './baseRepository';
-export declare class SecurityRepository extends BaseRepository {
-    /**
-     * Get all security roles
-     */
-    getAllRoles(): Promise<SecurityRole[]>;
-    /**
-     * Get roles of the user
-     */
-    getUserRoles(userId: string): Promise<UserSecurityRole[]>;
-    /**
-     * Get user roles by clientId
-     */
-    getUserRolesByClientId(clientId: number, filterRole?: HapnSecurityRole): Promise<UserSecurityRole[]>;
-    /**
-     * Whether the user is in role
-     */
-    isInRole(userId: string, role: HapnSecurityRole): Promise<boolean>;
-}