@spytecgps/nova-orm 0.0.28 → 0.0.30

package/dist/novaDataSource.d.ts

@@ -1,5 +1,6 @@
 import { DataSource, EntityTarget, LoggerOptions, ObjectLiteral, QueryRunner, ReplicationMode, Repository, SelectQueryBuilder } from 'typeorm';
 import { Logger } from './types/logger';
+export type queryBuilderHandler<T> = (novaDataSource: NovaDataSource) => Promise<T>;
 export interface NovaDataSourceConfig {
     /**
      * Database username.
@@ -66,4 +67,5 @@ export declare class NovaDataSource {
      * if you perform reads you can use slave databases.
      */
     createQueryRunner(mode?: ReplicationMode): QueryRunner;
+    safeQuery<T>(queryBuilderHandler: queryBuilderHandler<T>, tag?: string): Promise<T>;
 }

package/dist/repositories/firmwares/createDeviceFirmware.d.ts

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

package/dist/repositories/firmwares/createFirmwareUpgradeTask.d.ts

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

package/dist/repositories/firmwares/getDeviceFirmwares.d.ts

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

package/dist/repositories/firmwares/getFirmwareUpgradeTasks.d.ts

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

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

@@ -0,0 +1,75 @@
+import { DeviceTypeFirmware, FirmwareUpgradeTask } from '../../entities';
+import { CreateDeviceFirmwareParams, CreateFirmwareUpgradeTaskParams, GetDeviceFirmwaresParams, GetFirmwareUpgradeTasksParams, UpdateFirmwareUpgradeTaskParams } from '../../types/firmwares';
+import { BaseRepository } from '../baseRepository';
+export declare class FirmwaresRepository extends BaseRepository {
+    /**
+     * Get all devices firmwares.
+     * @param {GetDeviceFirmwaresParams} params containing information to get a device with filters.
+     * If no params or filter is specified, all devices firmwares will be returned.
+     * - filters.deviceTypeId: The device type id of the device
+     * - projectionOptions.withDeviceType: Whether to get the device type object
+     * @returns A list of devices firmwares.
+     */
+    getDeviceFirmwares(params?: GetDeviceFirmwaresParams): Promise<DeviceTypeFirmware[]>;
+    /**
+     * Create a new device firmware.
+     * @param {CreateDeviceFirmwareParams} params containing information to create a devicetype firmware.
+     * - deviceTypeId: The device type id
+     * - description: The description of the firmware version
+     * - enabled: Whether the firmware version is enabled or not
+     * - firmwareCode: The firmware version code
+     * - firmwareVersion: The firmware version after the firmware version is upgraded
+     * - firmwareUrl: The url to download the firmware
+     * - releaseDate: The date when the firmware version is released
+     * - sourceFirmwareVersion: The source firmware version that needs to match to apply this new firmware version. It can be null, if not precise version is needed.
+     * - upgradeType: The upgrade type depending on the module type
+     *    - 0: BB
+     *    - 1: MCU
+     *    - 2: BLE
+     *    - 7: MODEM
+     * @returns The newly created entity.
+     */
+    createDeviceFirmware(params: CreateDeviceFirmwareParams): Promise<DeviceTypeFirmware>;
+    /**
+     * Create a new firmware upgrade task.
+     * @param {CreateFirmwareUpgradeTaskParams} params containing information to create a firmware upgrade task.
+     * - id: The firmware upgrade task id
+     * - deviceTypeFirmwareId: The device type firmware id
+     * - clientId: The client id
+     * - deviceId: The device id
+     * - status: The status of the firmware upgrade task
+     * - behaviorName: The behavior name
+     * - behaviorParams: The behavior params
+     * - createdAt: The date when the firmware upgrade task is created
+     * - modifiedAt: The date when the firmware upgrade task is modified
+     * - preConfig: The pre config of the device before sending the upgrade command
+     * - postConfig: The post config of the device after sending the upgrade command   *
+     * @returns The newly created entity.
+     */
+    createFirmwareUpgradeTask(params: CreateFirmwareUpgradeTaskParams): Promise<FirmwareUpgradeTask>;
+    /**
+     * Get firmware upgrade tasks based on the filters.
+     * @param {GetFirmwareUpgradeTasksParams} params containing information to get a firmware upgrade task with filters.
+     * At leas one filter must be specified.
+     * - filters.deviceId: The device id
+     * - filters.firmwareId: The firmware id
+     * - filters.taskId: The task id
+     * - projectionOptions.withDeviceFirmware: Whether to get the device firmware object
+     * - projectionOptions.withDevice: Whether to get the device object
+     * - projectionOptions.deviceWithDeviceType: Whether to get the device type object of the device
+     * @returns {FirmwareUpgradeTask[]} A list of firmware upgrade tasks.
+     */
+    getFirmwareUpgradeTasks(params: GetFirmwareUpgradeTasksParams): Promise<FirmwareUpgradeTask[]>;
+    /**
+     * Partially update firmware upgrade tasks based.
+     * @param {UpdateFirmwareUpgradeTaskParams} params containing information to update a firmware upgrade task.
+     * - id: The firmware upgrade task id
+     * - behaviorName: The behavior name
+     * - behaviorParams: The behavior params
+     * - status: The status of the firmware upgrade task
+     * - preConfig: The pre config of the device before sending the upgrade command
+     * - postConfig: The post config of the device after sending the upgrade command
+     * @returns {boolea} Whether the firmware upgrade task is updated or not.
+     */
+    updateFirmwareUpgradeTasks(params: UpdateFirmwareUpgradeTaskParams): Promise<boolean>;
+}

package/dist/repositories/firmwares/updateFirmwareUpgradeTasks.d.ts

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

package/dist/repositories/index.d.ts

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

package/dist/types/firmwares.d.ts

@@ -0,0 +1,63 @@
+export interface GetDeviceFirmwaresParams {
+    filters: {
+        deviceTypeId?: number;
+        firmwareId?: number;
+    };
+    projectionOptions?: {
+        withDeviceType: boolean;
+    };
+}
+export interface GetFirmwareUpgradeTasksParams {
+    filters: {
+        deviceId?: number;
+        firmwareId?: number;
+        taskId?: string;
+    };
+    projectionOptions?: {
+        withDeviceFirmware?: boolean;
+        withDevice?: boolean;
+        deviceWithDeviceType?: boolean;
+    };
+}
+export type UpgradeType = '0' | '1' | '2' | '7';
+export interface CreateDeviceFirmwareParams {
+    deviceTypeId: number;
+    sourceFirmwareVersion?: string;
+    firmwareVersion: string;
+    firmwareCode: string;
+    firmwareUrl: string;
+    releaseDate: Date;
+    description: string;
+    enabled: boolean;
+    upgradeType: UpgradeType;
+}
+export declare enum FirmwareUpgradeTaskStatus {
+    Queued = "Queued",
+    QueuedWaitingForConfig = "QueuedWaitingForConfig",
+    QueuedWaitingForVersionMessage = "QueuedWaitingForVersionMessage",
+    InProgress = "InProgress",
+    Completed = "Completed",
+    Canceled = "Canceled",
+    Failed = "Failed"
+}
+export interface CreateFirmwareUpgradeTaskParams {
+    id: string;
+    deviceTypeFirmwareId: number;
+    clientId: number;
+    deviceId: number;
+    status: FirmwareUpgradeTaskStatus;
+    behaviorName?: string;
+    behaviorParams?: object;
+    createdAt?: Date;
+    modifiedAt?: Date;
+    preConfig?: string;
+    postConfig?: string;
+}
+export interface UpdateFirmwareUpgradeTaskParams {
+    id: string;
+    status?: FirmwareUpgradeTaskStatus;
+    behaviorName?: string;
+    behaviorParams?: object;
+    preConfig?: string;
+    postConfig?: string;
+}

package/dist/types/index.d.ts

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

package/package.json

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