@spytecgps/nova-orm 0.0.196 → 0.0.197

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

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

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

@@ -1,5 +1,5 @@
 import { DeviceTask, Task, TaskSchedule } from '../../entities';
-import { AddTaskScheduleDevicesParams, CreateTaskParams, CreateTaskScheduleParams, DeleteTaskScheduleDevicesParams, DeleteTaskScheduleParams, GetDeviceTasksParams, GetTaskScheduleParams, GetTaskSchedulesParams, SetTaskScheduleDevicesParams, UpdateTaskScheduleParams } from '../../types/tasks';
+import { AddTaskScheduleDevicesParams, CreateTaskParams, CreateTaskScheduleParams, DeleteTaskScheduleDevicesParams, DeleteTaskScheduleParams, GetDeviceTasksParams, GetTaskScheduleParams, GetTaskSchedulesParams, GetTasksParams, SetTaskScheduleDevicesParams, UpdateTaskScheduleParams } from '../../types/tasks';
 import { BaseRepository } from '../baseRepository';
 export declare class TasksRepository extends BaseRepository {
     /**
@@ -158,4 +158,35 @@ export declare class TasksRepository extends BaseRepository {
      * @returns Promise<Task> the created task
      */
     createTask(params: CreateTaskParams): Promise<Task>;
+    /**
+     * Get tasks with filters
+     * @param params params containing information to get tasks
+     * At least one of the following filters is required:
+     * params.filters.taskId: the task ID
+     * params.filters.taskScheduleId: the task schedule ID
+     * params.filters.imei: the IMEI
+     * params.filters.clientId: the client ID
+     * params.filters.dueDateFilter: the due date range filter
+     * params.filters.dueOdometerFilter: the due odometer range filter
+     * params.filters.dueActiveHoursFilter: the due active hours range filter
+     * params.filters.startDateFilter: the start date range filter
+     * params.filters.startingOdometerFilter: the starting odometer range filter
+     * params.filters.startingActiveHoursFilter: the starting active hours range filter
+     * params.filters.status: the status (pending, past_due, completed, deleted)
+     * params.filters.pastDueAtFilter: the past due at range filter
+     * params.filters.createdAtFilter: the created at range filter
+     * params.filters.completedAtFilter: the completed at range filter
+     * params.filters.completionNotes: the completion notes for partial match search
+     * params.filters.completionOdometerFilter: the completion odometer range filter
+     * params.filters.completionActiveHoursFilter: the completion active hours range filter
+     * params.filters.completedBy: the completed by, partial match search
+     * params.filters.modifiedBy: the modified by, partial match search
+     * params.filters.modifiedAtFilter: the modified at range filter
+     * params.filters.queuedAtFilter: the queued at range filter
+     * params.filters.predictedDueDateFilter: the predicted due date range filter
+     * params.filters.deletedAtFilter: the deleted at range filter
+     * params.filters.deletedBy: the deleted by, partial match search
+     * @returns Promise<Task[]> the tasks corresponding to the filters
+     */
+    getTasks(params: GetTasksParams): Promise<Task[]>;
 }

package/dist/types/tasks.d.ts

@@ -109,3 +109,32 @@ export interface CreateTaskParams {
     startingOdometer?: number;
     startingActiveHours?: number;
 }
+export interface GetTasksFilters {
+    taskScheduleId?: number;
+    taskId?: number;
+    imei?: string;
+    clientId?: number;
+    dueDateFilter?: RangeFilter<Date>;
+    dueOdometerFilter?: RangeFilter<number>;
+    dueActiveHoursFilter?: RangeFilter<number>;
+    startDateFilter?: RangeFilter<Date>;
+    startingOdometerFilter?: RangeFilter<number>;
+    startingActiveHoursFilter?: RangeFilter<number>;
+    status?: 'pending' | 'past_due' | 'completed' | 'deleted';
+    pastDueAtFilter?: RangeFilter<Date>;
+    createdAtFilter?: RangeFilter<Date>;
+    completedAtFilter?: RangeFilter<Date>;
+    completionNotes?: string;
+    completionOdometerFilter?: RangeFilter<number>;
+    completionActiveHoursFilter?: RangeFilter<number>;
+    completedBy?: string;
+    modifiedBy?: string;
+    modifiedAtFilter?: RangeFilter<Date>;
+    queuedAtFilter?: RangeFilter<Date>;
+    predictedDueDateFilter?: RangeFilter<Date>;
+    deletedAtFilter?: RangeFilter<Date>;
+    deletedBy?: string;
+}
+export interface GetTasksParams {
+    filters: GetTasksFilters;
+}

package/dist/utils/filterTools.d.ts

@@ -0,0 +1,7 @@
+import { SelectQueryBuilder } from 'typeorm';
+export interface FilterMap<T1, T2> {
+    targetFieldName: keyof T1;
+    filterName: keyof T2;
+    comparisonOperator?: 'RANGE' | '=' | 'LIKE';
+}
+export declare const addFilters: <T>(queryBuilder: SelectQueryBuilder<T>, filters: any, filterMapping: FilterMap<T, any>[]) => SelectQueryBuilder<T>;

package/package.json

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