@spytecgps/nova-orm 0.0.48 → 0.0.50

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5,5 +5,6 @@ import { DevicesRepository } from './devices';
5
5
  import { FirmwaresRepository } from './firmwares';
6
6
  import { PositionRepository } from './positions';
7
7
  import { SecurityRepository } from './security';
8
+ import { UserInvitationsRepository } from './userInvitations';
8
9
  import { UsersRepository } from './users';
9
- export { SecurityRepository, DevicesRepository, BoundariesRepository, ClientsRepository, FirmwaresRepository, PositionRepository, UsersRepository, CountriesRepository, };
10
+ export { SecurityRepository, DevicesRepository, BoundariesRepository, ClientsRepository, FirmwaresRepository, PositionRepository, UsersRepository, CountriesRepository, UserInvitationsRepository, };
@@ -3,4 +3,4 @@ import { NovaDataSource } from '../../novaDataSource';
3
3
  import { Logger } from '../../types/logger';
4
4
  import { CreatePositionParams } from '../../types/position';
5
5
  export declare const createPosition: (novaDataSource: NovaDataSource, params: CreatePositionParams, logger: Logger) => Promise<Position>;
6
- export declare const createPositions: (novaDataSource: NovaDataSource, params: CreatePositionParams[], logger: Logger) => Promise<any>;
6
+ export declare const upsertPositions: (novaDataSource: NovaDataSource, params: CreatePositionParams[], logger: Logger) => Promise<any>;
@@ -39,7 +39,7 @@ export declare class PositionRepository extends BaseRepository {
39
39
  * - gpsUtcTime: the time the gps was set
40
40
  * - externalBatteryPercentage: the external battery percentage reported by the device
41
41
  */
42
- createPositions(params: CreatePositionParams[]): Promise<any>;
42
+ upsertPositions(params: CreatePositionParams[]): Promise<any>;
43
43
  /**
44
44
  * Get positions by imei
45
45
  * @param {GetPositionsByImeiParams} params containing information to get positions
@@ -0,0 +1,5 @@
1
+ import { UserInvitation } from '../../entities';
2
+ import { NovaDataSource } from '../../novaDataSource';
3
+ import { Logger } from '../../types/logger';
4
+ import { CreateUserInvitationParams } from '../../types/userInvitations';
5
+ export declare const createUserInvitation: (novaDataSource: NovaDataSource, params: CreateUserInvitationParams, logger: Logger) => Promise<UserInvitation>;
@@ -0,0 +1,5 @@
1
+ import { UserInvitation } from '../../entities';
2
+ import { NovaDataSource } from '../../novaDataSource';
3
+ import { Logger } from '../../types/logger';
4
+ import { GetUserInvitationByIdParams } from '../../types/userInvitations';
5
+ export declare const getUserInvitationById: (novaDataSource: NovaDataSource, params: GetUserInvitationByIdParams, logger: Logger) => Promise<UserInvitation>;
@@ -0,0 +1,5 @@
1
+ import { UserInvitation } from '../../entities';
2
+ import { NovaDataSource } from '../../novaDataSource';
3
+ import { Logger } from '../../types/logger';
4
+ import { GetUserInvitationsParams } from '../../types/userInvitations';
5
+ export declare const getUserInvitations: (novaDataSource: NovaDataSource, params: GetUserInvitationsParams, logger: Logger) => Promise<UserInvitation[]>;
@@ -0,0 +1,55 @@
1
+ import { UserInvitation } from '../../entities';
2
+ import { CreateUserInvitationParams, GetUserInvitationByIdParams, GetUserInvitationsParams, UpdateUserInvitationParams } from '../../types/userInvitations';
3
+ import { BaseRepository } from '../baseRepository';
4
+ export declare class UserInvitationsRepository extends BaseRepository {
5
+ /**
6
+ * Get user invitation by id
7
+ * @param {GetUserInvitationByIdParams} params containing information to get a user invitation by id
8
+ * - filters.id: The user invitation id
9
+ * @returns The user invitation information
10
+ */
11
+ getUserInvitationById(params: GetUserInvitationByIdParams): Promise<UserInvitation>;
12
+ /**
13
+ * Get user invitations with filters
14
+ * @param {GetUserInvitationsParams} params containing information to get user invitations
15
+ * - filters.inviterClientId: The inviter client id
16
+ * - filters.inviteeEmails: The array of invitee emails to filter by
17
+ * - filters.statusList: The array of status list to filter by
18
+ * @returns The user invitations list
19
+ */
20
+ getUserInvitations(params: GetUserInvitationsParams): Promise<UserInvitation[]>;
21
+ /**
22
+ * Update user invitation
23
+ * @param {UpdateUserInvitationParams} params containing information to update a user invitation
24
+ * - filters.id: The user invitation id
25
+ * At least one value must be provided:
26
+ * - values.statusId: The status id, optional
27
+ * - values.inviteeUserId: The invitee user id, optional
28
+ * - values.inviteeEmail: The invitee email, optional
29
+ * - values.inviteeSecurityRoleId: The invitee security role id, optional
30
+ * - values.trackerImeis: The tracker imeis, optional
31
+ * - values.trackerAccess: The tracker access, optional
32
+ * - values.minAccessDate: The min access date, optional
33
+ * - values.boundaries: The boundaries, optional
34
+ * - values.boundaryAccess: The boundary access, optional
35
+ * @returns Whether the user invitation was updated or not
36
+ */
37
+ updateUserInvitation(params: UpdateUserInvitationParams): Promise<boolean>;
38
+ /**
39
+ * Create user invitation
40
+ * @param {CreateUserInvitationParams} params containing information to create a user invitation
41
+ * - id: The user invitation id, required
42
+ * - inviterClientId: The inviter client id, required
43
+ * - inviterUserId: The inviter user id, required
44
+ * - inviteeEmail: The invitee email, required
45
+ * - inviteeSecurityRoleId: The invitee security role id, required
46
+ * - statusId: The status id, required
47
+ * - trackerImeis: The tracker imeis, optional
48
+ * - trackerAccess: The tracker access, optional
49
+ * - minAccessDate: The min access date, optional
50
+ * - boundaries: The boundaries, optional
51
+ * - boundaryAccess: The boundary access, optional
52
+ * @returns The created user invitation
53
+ */
54
+ createUserInvitation(params: CreateUserInvitationParams): Promise<UserInvitation>;
55
+ }
@@ -0,0 +1,4 @@
1
+ import { NovaDataSource } from '../../novaDataSource';
2
+ import { Logger } from '../../types/logger';
3
+ import { UpdateUserInvitationParams } from '../../types/userInvitations';
4
+ export declare const updateUserInvitation: (novaDataSource: NovaDataSource, params: UpdateUserInvitationParams, logger: Logger) => Promise<boolean>;
@@ -5,4 +5,5 @@ import * as Firmwares from './firmwares';
5
5
  import * as Logger from './logger';
6
6
  import * as Security from './security';
7
7
  import * as Users from './user';
8
- export { Logger, Devices, Firmwares, Security, Boundaries, Clients, Users };
8
+ import * as UserInvitations from './userInvitations';
9
+ export { Logger, Devices, Firmwares, Security, Boundaries, Clients, Users, UserInvitations };
@@ -0,0 +1,41 @@
1
+ export interface GetUserInvitationByIdParams {
2
+ filters: {
3
+ id: string;
4
+ };
5
+ }
6
+ export interface GetUserInvitationsParams {
7
+ filters: {
8
+ inviterClientId?: number;
9
+ inviteeEmails?: string[];
10
+ statusList?: number[];
11
+ };
12
+ }
13
+ export interface UpdateUserInvitationParams {
14
+ filters: {
15
+ id: string;
16
+ };
17
+ values: {
18
+ statusId?: number;
19
+ inviteeUserId?: string;
20
+ inviteeEmail?: string;
21
+ inviteeSecurityRoleId?: number;
22
+ trackerImeis?: string;
23
+ trackerAccess?: string;
24
+ minAccessDate?: Date;
25
+ boundaries?: string;
26
+ boundaryAccess?: string;
27
+ };
28
+ }
29
+ export interface CreateUserInvitationParams {
30
+ id: string;
31
+ inviterClientId: number;
32
+ inviterUserId: string;
33
+ inviteeEmail: string;
34
+ inviteeSecurityRoleId: number;
35
+ statusId: number;
36
+ trackerImeis?: string;
37
+ trackerAccess?: string;
38
+ minAccessDate?: Date;
39
+ boundaries?: string;
40
+ boundaryAccess?: string;
41
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spytecgps/nova-orm",
3
- "version": "0.0.48",
3
+ "version": "0.0.50",
4
4
  "description": "ORM with PlanetScale",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",