@spytecgps/nova-orm 0.0.18 → 0.0.20

package/dist/novaDataSource.d.ts

@@ -1,4 +1,4 @@
-import { DataSource, EntityTarget, LoggerOptions, ObjectLiteral, Repository, SelectQueryBuilder } from 'typeorm';
+import { DataSource, EntityTarget, LoggerOptions, ObjectLiteral, QueryRunner, ReplicationMode, Repository, SelectQueryBuilder } from 'typeorm';
 import { Logger } from './types/logger';
 export interface NovaDataSourceConfig {
     /**
@@ -55,4 +55,15 @@ export declare class NovaDataSource {
      * Creates a new query builder that can be used to build a SQL query.
      */
     createQueryBuilder<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, alias: string): Promise<SelectQueryBuilder<Entity>>;
+    /**
+     * Creates a query runner used for perform queries on a single database connection.
+     * Using query runners you can control your queries to execute using single database connection and
+     * manually control your database transaction.
+     *
+     * Mode is used in replication mode and indicates whatever you want to connect
+     * to master database or any of slave databases.
+     * If you perform writes you must use master database,
+     * if you perform reads you can use slave databases.
+     */
+    createQueryRunner(mode?: ReplicationMode): QueryRunner;
 }

package/dist/repositories/clients/createClient.d.ts

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

package/dist/repositories/clients/createClientConfiguration.d.ts

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

package/dist/repositories/clients/deleteClientAndConfiguration.d.ts

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

package/dist/repositories/clients/getClient.d.ts

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

package/dist/repositories/clients/getClientConfiguration.d.ts

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

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

@@ -0,0 +1,87 @@
+import { Client, ClientConfiguration } from '../../entities';
+import { CreateClientConfigurationParams, CreateClientParams, DeleteClientParams, GetClientConfigurationParams, GetClientParams, UpdateClientConfigurationParams, UpdateClientParams } from '../../types/clients';
+import { BaseRepository } from '../baseRepository';
+export declare class ClientsRepository extends BaseRepository {
+    /**
+     * Get a client by id or email
+     * @param  {GetClientParams} params containing information to get a client
+     * - filters.clientId: The client id, optional
+     * - filters.email: The email, optional
+     */
+    getClient(params: GetClientParams): Promise<Client>;
+    /**
+     * Create client
+     * @param  {CreateClientParams} params containing information to create a client
+     * - name: client name
+     * - email: client email
+     * - uuid: client uuid
+     * - clientTypeId: client type id, optional
+     * - dataSourceTypeId: data source type id, optional
+     * - sievaUserName: sieva user name, optional
+     * - sievaBatchId: sieva batch id, optional
+     * - salesforceId: salesforce id, optional
+     * - accumaticaId: accumatica id, optional
+     * - expirationDate: expiration date, optional
+     * - useType: use type, optional
+     * - btCustomerId: bt customer id, optional
+     * - activationCampaign: activation campaign, optional
+     * - organizationId: organization id, optional
+     *  @returns {Promise<Client>} The created client
+     */
+    createClient(params: CreateClientParams): Promise<Client>;
+    /**
+     * Create client
+     * @param  {UpdateClientParams} params containing information to update a client
+     * - filters.clientId: The id of the client to update
+     * - values.name: client name, optional
+     * - values.email: client email, optional
+     * - values.uuid: client uuid, optional
+     * - values.clientTypeId: client type id, optional
+     * - values.dataSourceTypeId: data source type id, optional
+     * - values.sievaUserName: sieva user name, optional
+     * - values.sievaBatchId: sieva batch id, optional
+     * - values.salesforceId: salesforce id, optional
+     * - values.accumaticaId: accumatica id, optional
+     * - values.expirationDate: expiration date, optional
+     * - values.useType: use type, optional
+     * - values.btCustomerId: bt customer id, optional
+     * - values.activationCampaign: activation campaign, optional
+     * - values.organizationId: organization id, optional
+     *  @returns {Promise<boolean>} True if the client was updated, false otherwise
+     */
+    updateClient(params: UpdateClientParams): Promise<boolean>;
+    /**
+     * Delete a client and its configurations
+     * @param  {DeleteClientParams} params containing information to delete a client
+     * - filters.clientId: The id of the client to delete
+     * @returns {Promise<boolean>} True if the client was deleted, false otherwise
+     */
+    deleteClientAndConfigurations(params: DeleteClientParams): Promise<boolean>;
+    /**
+     * Get a client configuration
+     * @param  {GetClientConfigurationParams} params containing information to get a client configuration
+     * - filters.clientId: The client id
+     */
+    getClientConfiguration(params: GetClientConfigurationParams): Promise<ClientConfiguration>;
+    /**
+     * Create a client configuration
+     * @param  {CreateClientConfigurationParams} params containing information to create a client configuration
+     * - clientId: The client id
+     * - movementTripThreshold: The movement trip threshold
+     * - stopTripThreshold: The stop trip threshold
+     * - mapUpdateMode: The map update mode
+     * - maxUsersAllowed: The max users allowed
+     */
+    createClientConfiguration(params: CreateClientConfigurationParams): Promise<ClientConfiguration>;
+    /**
+     * Update a client configuration
+     * @param  {UpdateClientConfigurationParams} params containing information to update a client configuration
+     * - filters.clientId: The client id
+     * - values.movementTripThreshold: The movement trip threshold, optional
+     * - values.stopTripThreshold: The stop trip threshold, optional
+     * - values.mapUpdateMode: The map update mode, optional
+     * - values.maxUsersAllowed: The max users allowed, optional
+     * @returns {Promise<boolean>} True if the client configuration was updated, false otherwise
+     */
+    updateClientConfiguration(params: UpdateClientConfigurationParams): Promise<boolean>;
+}

package/dist/repositories/clients/updateClient.d.ts

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

package/dist/repositories/clients/updateClientConfiguration.d.ts

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

package/dist/repositories/index.d.ts

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

package/dist/types/clients.d.ts

@@ -0,0 +1,72 @@
+import { HapnClientType } from './enums';
+export interface GetClientParams {
+    filters: {
+        clientId?: number;
+        email?: string;
+    };
+}
+export interface CreateClientParams {
+    name: string;
+    uuid: string;
+    email: string;
+    clientTypeId?: HapnClientType;
+    dataSourceTypeId?: number;
+    sievaUserName?: string;
+    sievaBatchId?: number;
+    salesforceId?: string;
+    accumaticaId?: string;
+    expirationDate?: Date;
+    useType?: string;
+    btCustomerId?: string;
+    activationCampaign?: string;
+    organizationId?: number;
+}
+export interface UpdateClientParams {
+    filters: {
+        clientId: number;
+    };
+    values: {
+        name?: string;
+        uuid?: string;
+        email?: string;
+        clientTypeId?: HapnClientType;
+        dataSourceTypeId?: number;
+        sievaUserName?: string;
+        sievaBatchId?: number;
+        salesforceId?: string;
+        accumaticaId?: string;
+        expirationDate?: Date;
+        useType?: string;
+        btCustomerId?: string;
+        activationCampaign?: string;
+        organizationId?: number;
+    };
+}
+export interface DeleteClientParams {
+    filters: {
+        clientId: number;
+    };
+}
+export interface GetClientConfigurationParams {
+    filters: {
+        clientId: number;
+    };
+}
+export interface CreateClientConfigurationParams {
+    clientId: number;
+    movementTripThreshold?: number;
+    stopTripThreshold?: number;
+    mapUpdateMode?: number;
+    maxUsersAllowed?: number;
+}
+export interface UpdateClientConfigurationParams {
+    filters: {
+        clientId: number;
+    };
+    values: {
+        movementTripThreshold?: number;
+        stopTripThreshold?: number;
+        mapUpdateMode?: number;
+        maxUsersAllowed?: number;
+    };
+}

package/dist/types/enums.d.ts

@@ -12,3 +12,8 @@ export declare enum BoundaryStatus {
     Inactive = 2,
     Deleted = 3
 }
+export declare enum HapnClientType {
+    b2c = 1,
+    b2b = 2,
+    test = 3
+}

package/dist/types/index.d.ts

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

package/package.json

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