@spytecgps/nova-orm 0.0.199 → 0.0.201

package/dist/repositories/tasks/deleteTask.d.ts

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

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

@@ -1,5 +1,5 @@
 import { DeviceTask, Task, TaskSchedule } from '../../entities';
-import { AddTaskScheduleDevicesParams, CompleteTaskParams, CreateTaskParams, CreateTaskScheduleParams, DeleteTaskScheduleDevicesParams, DeleteTaskScheduleParams, GetDeviceTasksParams, GetTaskScheduleParams, GetTaskSchedulesParams, GetTasksParams, SetTaskScheduleDevicesParams, UpdateTaskParams, UpdateTaskScheduleParams } from '../../types/tasks';
+import { AddTaskScheduleDevicesParams, CompleteTaskParams, CreateTaskParams, CreateTaskScheduleParams, DeleteTaskParams, DeleteTaskScheduleDevicesParams, DeleteTaskScheduleParams, GetDeviceTasksParams, GetTaskScheduleParams, GetTaskSchedulesParams, GetTasksParams, SetTaskScheduleDevicesParams, UpdateTaskParams, UpdateTaskScheduleParams } from '../../types/tasks';
 import { BaseRepository } from '../baseRepository';
 export declare class TasksRepository extends BaseRepository {
     /**
@@ -10,12 +10,12 @@ export declare class TasksRepository extends BaseRepository {
      * params.title: the title, required
      * params.description: the description, required
      * params.repeats: whether the task repeats, required
-     * params.dueDate: the due date, required if repeats is false
-     * params.dueOdometer: the due odometer, required if repeats is false
-     * params.dueActiveHours: the due active hours, required if repeats is false
-     * params.intervalDays: the interval days, required if repeats is true
-     * params.intervalOdometer: the interval odometer, required if repeats is true
-     * params.intervalActiveHours: the interval active hours, required if repeats is true
+     * params.dueDate: the due date, optional
+     * params.dueOdometer: the due odometer, optional
+     * params.dueActiveHours: the due active hours, optional
+     * params.intervalDays: the interval days, optional
+     * params.intervalOdometer: the interval odometer, optional
+     * params.intervalActiveHours: the interval active hours, optional
      * params.intervalStartDate: the interval start date, optional
      * params.intervalStartingOdometer: the interval starting odometer, optional
      * params.intervalStartingActiveHours: the interval starting active hours, optional
@@ -39,15 +39,15 @@ export declare class TasksRepository extends BaseRepository {
      * params.values.title: the title, optional
      * params.values.description: the description, optional
      * params.values.repeats: whether the task repeats, optional
-     * params.values.dueDate: the due date, required if repeats is false
-     * params.values.dueOdometer: the due odometer, required if repeats is false
-     * params.values.dueActiveHours: the due active hours, required if repeats is false
-     * params.values.intervalDays: the interval days, required if repeats is true
-     * params.values.intervalOdometer: the interval odometer, required if repeats is true
-     * params.values.intervalActiveHours: the interval active hours, required if repeats is true
-     * params.values.intervalStartDate: the interval start date
-     * params.values.intervalStartingOdometer: the interval starting odometer
-     * params.values.intervalStartingActiveHours: the interval starting active hours
+     * params.values.dueDate: the due date, optional
+     * params.values.dueOdometer: the due odometer, optional
+     * params.values.dueActiveHours: the due active hours, optional
+     * params.values.intervalDays: the interval days, optional
+     * params.values.intervalOdometer: the interval odometer, optional
+     * params.values.intervalActiveHours: the interval active hours, optional
+     * params.values.intervalStartDate: the interval start date, optional
+     * params.values.intervalStartingOdometer: the interval starting odometer, optional
+     * params.values.intervalStartingActiveHours: the interval starting active hours, optional
      * params.values.notes: the notes, optional
      * params.values.modifiedBy: the modified by, required
      * @returns Promise<boolean> whether the task schedule was updated
@@ -217,4 +217,12 @@ export declare class TasksRepository extends BaseRepository {
      * @returns Promise<boolean> whether the task was completed
      */
     completeTask(params: CompleteTaskParams): Promise<boolean>;
+    /**
+     * Delete an existing task
+     * @param params params containing information to delete task
+     * params.id: the ID, required
+     * params.deletedBy: the user performing the delete action, required
+     * @returns Promise<boolean> whether the task was deleted
+     */
+    deleteTask(params: DeleteTaskParams): Promise<boolean>;
 }

package/dist/types/tasks.d.ts

@@ -161,3 +161,7 @@ export interface CompleteTaskParams {
     completionOdometer?: number;
     completionActiveHours?: number;
 }
+export interface DeleteTaskParams {
+    id: number;
+    deletedBy: string;
+}

package/package.json

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