@bluedot-innovation/models 2.0.0-alpha1 → 2.0.0-beta.1

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.
Files changed (117) hide show
  1. package/.eslintrc.js +6 -0
  2. package/.gitlab-ci.yml +43 -0
  3. package/.npmignore +3 -0
  4. package/.nyc_output/295801a153bad60b994d5c6b5a8016d9.json +1 -0
  5. package/.nyc_output/2963e30f6030a94b16dd86e7b5594ebe.json +1 -0
  6. package/.nyc_output/5fc62324d665599db6649363a937708e.json +1 -0
  7. package/.nyc_output/95eec4b77e4566b36a6300f0cf8bea0b.json +1 -0
  8. package/Models.js +36 -10
  9. package/README.MD +36 -0
  10. package/__tests__/action/message/messageAction.data.json +5 -0
  11. package/__tests__/action/message/messageAction.rules.json +3 -0
  12. package/__tests__/action/message/messageAction.spec.js +61 -0
  13. package/__tests__/action/url/urlAction.data.json +4 -0
  14. package/__tests__/action/url/urlAction.rules.json +3 -0
  15. package/__tests__/action/url/urlAction.spec.js +62 -0
  16. package/__tests__/dailyStats/checkDailyStats.js +30 -0
  17. package/__tests__/filter/beacon/beaconFilter.data.json +1 -0
  18. package/__tests__/filter/beacon/beaconFilter.rules.json +3 -0
  19. package/__tests__/filter/beacon/beaconFilter.spec.js +1 -0
  20. package/__tests__/filter/bearing/bearingFilter.data.json +5 -0
  21. package/__tests__/filter/bearing/bearingFilter.rules.json +3 -0
  22. package/__tests__/filter/bearing/bearingFilter.spec.js +95 -0
  23. package/__tests__/filter/calendarDateRange/calendarDateRangeFilter.data.json +5 -0
  24. package/__tests__/filter/calendarDateRange/calendarDateRangeFilter.rules.json +3 -0
  25. package/__tests__/filter/calendarDateRange/calendarDateRangeFilter.spec.js +62 -0
  26. package/__tests__/filter/percentageCrossed/percentageCrossedFilter.data.json +5 -0
  27. package/__tests__/filter/percentageCrossed/percentageCrossedFilter.rules.json +3 -0
  28. package/__tests__/filter/percentageCrossed/percentageCrossedFilter.spec.js +62 -0
  29. package/__tests__/filter/speed/speedFilter.data.json +5 -0
  30. package/__tests__/filter/speed/speedFilter.rules.json +3 -0
  31. package/__tests__/filter/speed/speedFilter.spec.js +73 -0
  32. package/__tests__/filter/timeOfDayRange/timeOfDayRange.data.json +5 -0
  33. package/__tests__/filter/timeOfDayRange/timeOfDayRange.rules.json +3 -0
  34. package/__tests__/filter/timeOfDayRange/timeOfDayRange.spec.js +73 -0
  35. package/__tests__/geofeature/beacon/beacon.data.json +12 -0
  36. package/__tests__/geofeature/beacon/beacon.rules.json +13 -0
  37. package/__tests__/geofeature/beacon/beacon.spec.js +95 -0
  38. package/__tests__/geofeature/boundingBox/boundingBox.data.json +12 -0
  39. package/__tests__/geofeature/boundingBox/boundingBox.rules.json +3 -0
  40. package/__tests__/geofeature/boundingBox/boundingBox.spec.js +61 -0
  41. package/__tests__/geofeature/circle/circle.data.json +9 -0
  42. package/__tests__/geofeature/circle/circle.rules.json +3 -0
  43. package/__tests__/geofeature/circle/circle.spec.js +62 -0
  44. package/__tests__/geofeature/polygon/polygon.data.json +46 -0
  45. package/__tests__/geofeature/polygon/polygon.rules.json +3 -0
  46. package/__tests__/geofeature/polygon/polygon.spec.js +61 -0
  47. package/__tests__/geofeature/polyline/polyline.data.json +46 -0
  48. package/__tests__/geofeature/polyline/polyline.rules.json +3 -0
  49. package/__tests__/geofeature/polyline/polyline.spec.js +61 -0
  50. package/__tests__/monthlyStats/monthlyStats.data.json +29 -0
  51. package/__tests__/monthlyStats/monthlyStats.spec.js +40 -0
  52. package/__tests__/zone/zone.action.spec.js +50 -0
  53. package/__tests__/zone/zone.data.json +154 -0
  54. package/__tests__/zone/zone.filter.spec.js +50 -0
  55. package/__tests__/zone/zone.geofeatures.spec.js +74 -0
  56. package/__tests__/zone/zone.spec.js +98 -0
  57. package/models/AdminPortalUser.js +10 -11
  58. package/models/AdminUser.js +6 -5
  59. package/models/Application.js +31 -30
  60. package/models/Beacon.js +92 -78
  61. package/models/BeaconFilter.js +28 -12
  62. package/models/BearingFilter.js +46 -23
  63. package/models/BoundingBox.js +36 -20
  64. package/models/CalendarDateRangeFilter.js +34 -19
  65. package/models/Circle.js +33 -18
  66. package/models/Contract.js +37 -38
  67. package/models/Customer.js +31 -31
  68. package/models/CustomerLogin.js +9 -10
  69. package/models/DBEvent.js +13 -14
  70. package/models/DailyStats.js +28 -0
  71. package/models/DeviceRulesRequest.js +27 -28
  72. package/models/Fence.js +12 -13
  73. package/models/GeoFence.js +12 -14
  74. package/models/Geofeature.js +16 -18
  75. package/models/MessageAction.js +31 -16
  76. package/models/MonthlyStats.js +39 -0
  77. package/models/NotificationLogEntry.js +7 -8
  78. package/models/POILocation.js +6 -7
  79. package/models/POILookup.js +8 -9
  80. package/models/POIResult.js +7 -8
  81. package/models/PartnerCustomer.js +12 -13
  82. package/models/PartnerPasswordReset.js +8 -9
  83. package/models/PartnerUser.js +10 -11
  84. package/models/Partners.js +11 -12
  85. package/models/PercentageCrossedFilter.js +30 -15
  86. package/models/Polygon.js +34 -19
  87. package/models/Polyline.js +35 -19
  88. package/models/RuleRequestAggregation.js +14 -15
  89. package/models/SimpleCheckInZone.js +21 -21
  90. package/models/SingleUseToken.js +7 -8
  91. package/models/SpeedFilter.js +39 -19
  92. package/models/TestDevice.js +11 -12
  93. package/models/TestDeviceCluster.js +9 -10
  94. package/models/TestInstance.js +9 -10
  95. package/models/TestScenario.js +9 -10
  96. package/models/TimeOfDayRange.js +16 -16
  97. package/models/TimeOfDayRangeFilter.js +36 -18
  98. package/models/UrlAction.js +54 -0
  99. package/models/Zone.js +85 -273
  100. package/models/ZoneUIState.js +18 -18
  101. package/package-lock.json +3503 -0
  102. package/package.json +20 -8
  103. package/schemas/Point.js +10 -13
  104. package/__tests__/zone/checkActions.js +0 -64
  105. package/__tests__/zone/checkAppId.js +0 -41
  106. package/__tests__/zone/checkBeacon.js +0 -46
  107. package/__tests__/zone/checkBearingFitler.js +0 -48
  108. package/__tests__/zone/checkBoundingBox.js +0 -44
  109. package/__tests__/zone/checkCalendarDateRangeFilterFitler.js +0 -48
  110. package/__tests__/zone/checkCircle.js +0 -41
  111. package/__tests__/zone/checkMRT.js +0 -46
  112. package/__tests__/zone/checkPercentageCrossedFitler.js +0 -48
  113. package/__tests__/zone/checkPolygon.js +0 -78
  114. package/__tests__/zone/checkPolyline.js +0 -78
  115. package/__tests__/zone/checkSpeedFitler.js +0 -48
  116. package/__tests__/zone/checkTimeOfDayRangeFitler.js +0 -48
  117. package/models/URLAction.js +0 -34
package/models/Zone.js CHANGED
@@ -4,284 +4,96 @@
4
4
  * Owner :
5
5
  */
6
6
 
7
- let mongoose = require('mongoose'),
8
- Schema = mongoose.Schema;
9
- let StateEnum = require('@bluedot-innovation/enums').StateEnum;
10
- let MessageAction = require('./MessageAction');
11
- let URLAction = require('./URLAction');
12
- let Circle = require('./Circle');
13
- let BoundingBox = require('./BoundingBox');
14
- let Polyline = require('./Polyline');
15
- let Polygon = require('./Polygon');
16
- let Beacon = require('./Beacon');
17
- let SpeedFilter = require('./SpeedFilter');
18
- let BearingFilter = require('./BearingFilter');
19
- let TimeOfDayRangeFilter = require('./TimeOfDayRangeFilter');
20
- let CalendarDateRangeFilter = require('./CalendarDateRangeFilter');
21
- let PercentageCrossedFilter = require('./PercentageCrossedFilter');
22
- let uuidv1 = require('uuid/v1');
7
+ let mongoose = require('mongoose')
8
+ let Schema = mongoose.Schema
9
+ let StateEnum = require('@bluedot-innovation/enums').StateEnum
10
+ let messageActionSchema = require('./MessageAction').messageActionSchema
11
+ let urlActionSchema = require('./UrlAction').urlActionSchema
12
+ let circleSchema = require('./Circle').circleSchema
13
+ let boundingBoxSchema = require('./BoundingBox').boundingBoxSchema
14
+ let polylineSchema = require('./Polyline').polylineSchema
15
+ let polygonSchema = require('./Polygon').polygonSchema
16
+ let beaconSchema = require('./Beacon').beaconSchema
17
+ let speedFilterSchema = require('./SpeedFilter').speedFilterSchema
18
+ let bearingFilterSchema = require('./BearingFilter').bearingFilterSchema
19
+ let timeOfDayRangeFilterSchema = require('./TimeOfDayRangeFilter').timeOfDayRangeFilterSchema
20
+ let calendarDateRangeFilterSchema = require('./CalendarDateRangeFilter').calendarDateRangeFilterSchema
21
+ let percentageCrossedFilterSchema = require('./PercentageCrossedFilter').percentageCrossedFilterSchema
22
+ let uuidv4 = require('uuid/v4')
23
+ let patcher = require('mongoose-json-patch')
24
+
25
+ // ////// //
26
+ // Schema //
27
+ // ////// //
28
+
29
+ let actionSchema = new Schema({},
30
+ { discriminatorKey: 'type', _id: false })
31
+
32
+ let filterSchema = new Schema({},
33
+ { discriminatorKey: 'type', _id: false })
34
+
35
+ let geofeatureSchema = new Schema({},
36
+ { discriminatorKey: 'type', _id: false })
23
37
 
24
38
  let ZoneSchema = new Schema({
25
- _id : { type : String, default: uuidv1 },
26
- name : { type : String, required: [true, 'name is required'] },
27
- minimumRetriggerTime : {
28
- type : Number,
29
- required : [ true, 'minimumRetriggerTime is required' ],
30
- min : 60,
31
- max : 3599940,
32
- validate : { validator : Number.isInteger,
33
- message : '{VALUE} is not a number'
34
- }
35
- },
36
- filter : { type : [],
37
- validate : {
38
- validator: validateFilters
39
- }
40
- },
41
- actions : { type : [],
42
- validate : {
43
- validator: validateActions
44
- }
45
- },
46
- geofeatures : { type : [],
47
- validate : {
48
- validator: validateGeofeatures
49
- }
50
- },
51
- customData : [{ type : Schema.Types.Mixed }],
52
- description : { type : String, default: '' },
53
- creationTime : { type : Date, default: Date.now },
54
- lastUpdateTime : { type : Date, default: Date.now },
55
- applicationId : { type : String, required: [true, 'applicationId is required'] },
56
- state : { type : String, default : StateEnum.active, select: false }
57
- },
58
- { collection : 'zone' });
59
-
60
- function validateFilters(filters){
61
- let errorList = '';
62
-
63
- filters.forEach(filter => {
64
- switch(filter.type) {
65
- case 'speed': {
66
- let speedFilter = new SpeedFilter(filter);
67
- let speedFilterErrors = speedFilter.validateSync();
68
- if(speedFilterErrors) {
69
- for (let key of Object.keys(speedFilterErrors.errors)) {
70
- console.log(speedFilterErrors.errors[key].message);
71
- errorList = errorList + speedFilterErrors.errors[key].message;
72
- }
73
- }
74
-
75
- break;
76
- }
77
- case 'bearing': {
78
- let bearingFilter = new BearingFilter(filter);
79
- let bearingFilterErrors = bearingFilter.validateSync();
80
- if(bearingFilterErrors) {
81
- for (let key of Object.keys(bearingFilterErrors.errors)) {
82
- console.log(bearingFilterErrors.errors[key].message);
83
- errorList = errorList + bearingFilterErrors.errors[key].message;
84
- }
85
- }
86
-
87
- break;
88
- }
89
- case 'percentageCrossed': {
90
- let percentageCrossedFilter = new PercentageCrossedFilter(filter);
91
- let percentageCrossedFilterErrors = percentageCrossedFilter.validateSync();
92
- if(percentageCrossedFilterErrors) {
93
- for (let key of Object.keys(percentageCrossedFilterErrors.errors)) {
94
- console.log(percentageCrossedFilterErrors.errors[key].message);
95
- errorList = errorList + percentageCrossedFilterErrors.errors[key].message;
96
- }
97
- }
98
-
99
- break;
100
- }
101
- case 'timeOfDayRange': {
102
- let timeOfDayRangeFilter = new TimeOfDayRangeFilter(filter);
103
- let timeOfDayRangeFilterErrors = timeOfDayRangeFilter.validateSync();
104
- if(timeOfDayRangeFilterErrors) {
105
- for (let key of Object.keys(timeOfDayRangeFilterErrors.errors)) {
106
- console.log(timeOfDayRangeFilterErrors.errors[key].message);
107
- errorList = errorList + timeOfDayRangeFilterErrors.errors[key].message;
108
- }
109
- }
110
-
111
- break;
112
- }
113
- case 'calendarDateRange': {
114
- let calendarDateRangeFilter = new CalendarDateRangeFilter(filter);
115
- let calendarDateRangeFilterErrors = calendarDateRangeFilter.validateSync();
116
- if(calendarDateRangeFilterErrors) {
117
- for (let key of Object.keys(calendarDateRangeFilterErrors.errors)) {
118
- console.log(calendarDateRangeFilterErrors.errors[key].message);
119
- errorList = errorList + calendarDateRangeFilterErrors.errors[key].message;
120
- }
121
- }
122
-
123
- break;
124
- }
125
- default: {
126
- console.log("Please enter a valid filter type.");
127
- errorList = errorList + "Please enter a valid filter type. ";
128
-
129
- break;
130
- }
39
+ _id: {type: String, default: uuidv4},
40
+ name: {type: String, required: [true, 'name is required']},
41
+ minimumRetriggerTime: {
42
+ type: Number,
43
+ required: [true, 'minimumRetriggerTime is required'],
44
+ min: 60,
45
+ max: 3599940,
46
+ validate: {
47
+ validator: Number.isInteger,
48
+ message: '{VALUE} is not a number'
131
49
  }
132
- });
133
-
134
- if(errorList != '')
135
- throw new Error(errorList);
136
- }
137
-
138
-
139
- function validateActions(actions){
140
- let errorList = '';
141
-
142
- actions.forEach(action => {
143
- switch(action.type) {
144
- case 'message': {
145
- let messageAction = new MessageAction(action);
146
- let messageErrors = messageAction.validateSync();
147
- if(messageErrors) {
148
- for (let key of Object.keys(messageErrors.errors)) {
149
- console.log(messageErrors.errors[key].message);
150
- errorList = errorList + messageErrors.errors[key].message;
151
- }
152
- }
153
-
154
- break;
155
- }
156
- case 'url': {
157
- let urlAction = new URLAction(action);
158
- let urlErrors = urlAction.validateSync();
159
-
160
- if(urlErrors) {
161
- for (let key of Object.keys(urlErrors.errors)) {
162
- console.log(urlErrors.errors[key].message);
163
- errorList = errorList + urlErrors.errors[key].message;
164
- }
165
- }
166
-
167
- break;
168
- }
169
- default: {
170
- console.log("Please enter a valid action type.");
171
- errorList = errorList + "Please enter a valid action type. ";
172
- break;
173
- }
174
- }
175
- });
176
-
177
- if(errorList != '')
178
- throw new Error(errorList);
179
- }
180
-
181
-
182
- function validateGeofeatures(features) {
183
- if(features.length == 0) {
184
- throw new Error("Geofeatures cannot be empty.");
50
+ },
51
+ filters: {
52
+ type: [filterSchema]
53
+ },
54
+ actions: {
55
+ type: [actionSchema]
56
+ },
57
+ geofeatures: {
58
+ type: [geofeatureSchema],
59
+ required: true
60
+ },
61
+ customData: [{type: Schema.Types.Mixed}],
62
+ description: {type: String, default: ''},
63
+ creationTime: {type: Date, default: Date.now},
64
+ lastUpdateTime: {type: Date, default: Date.now},
65
+ applicationId: {type: String, required: [true, 'applicationId is required']},
66
+ state: {type: String, default: StateEnum.active, select: false}
67
+ }, {collection: 'zone'})
68
+
69
+ // TODO: Test patcher and include for other schemas if required
70
+ ZoneSchema.plugin(patcher)
71
+
72
+ ZoneSchema.path('actions').discriminator('url', new Schema(urlActionSchema))
73
+ ZoneSchema.path('actions').discriminator('message', new Schema(messageActionSchema))
74
+
75
+ ZoneSchema.path('filters').discriminator('bearing', new Schema(bearingFilterSchema))
76
+ ZoneSchema.path('filters').discriminator('calendarDateRange', new Schema(calendarDateRangeFilterSchema))
77
+ ZoneSchema.path('filters').discriminator('percentageCrossed', new Schema(percentageCrossedFilterSchema))
78
+ ZoneSchema.path('filters').discriminator('speed', new Schema(speedFilterSchema))
79
+ ZoneSchema.path('filters').discriminator('timeOfDayRange', new Schema(timeOfDayRangeFilterSchema))
80
+
81
+ ZoneSchema.path('geofeatures').discriminator('circle', new Schema(circleSchema))
82
+ ZoneSchema.path('geofeatures').discriminator('beacon', new Schema(beaconSchema))
83
+ ZoneSchema.path('geofeatures').discriminator('polygon', new Schema(polygonSchema))
84
+ ZoneSchema.path('geofeatures').discriminator('polyline', new Schema(polylineSchema))
85
+ ZoneSchema.path('geofeatures').discriminator('boundingBox', new Schema(boundingBoxSchema))
86
+
87
+ // optional mongoose
88
+ const model = (mongooseInstance) => {
89
+ let Zone
90
+ if (mongooseInstance) {
91
+ Zone = mongooseInstance.model('Zone', ZoneSchema)
185
92
  } else {
186
- let errorList = '';
187
- features.forEach(geofeature => {
188
- switch(geofeature.type) {
189
- case 'circle': {
190
- let circle = new Circle(geofeature);
191
- let circleErrors = circle.validateSync();
192
-
193
- if(circleErrors) {
194
- for (let key of Object.keys(circleErrors.errors)) {
195
- console.log(circleErrors.errors[key].message);
196
- errorList = errorList + circleErrors.errors[key].message;
197
- }
198
- }
199
-
200
- break;
201
- }
202
- case 'boundingBox': {
203
- let boundingBox = new BoundingBox(geofeature);
204
- let boundingBoxErrors = boundingBox.validateSync();
205
-
206
- if(boundingBoxErrors) {
207
- for (let key of Object.keys(boundingBoxErrors.errors)) {
208
- console.log(boundingBoxErrors.errors[key].message);
209
- errorList = errorList + boundingBoxErrors.errors[key].message;
210
- }
211
- }
212
-
213
- break;
214
- }
215
- case 'polygon': {
216
- let polygon = new Polygon(geofeature);
217
- let polygonErrors = polygon.validateSync();
218
-
219
- if(polygonErrors) {
220
- for (let key of Object.keys(polygonErrors.errors)) {
221
- console.log(polygonErrors.errors[key].message);
222
- errorList = errorList + polygonErrors.errors[key].message;
223
- }
224
- }
225
-
226
- break;
227
- }
228
- case 'polyline': {
229
- let polyline = new Polyline(geofeature);
230
- let polylineErrors = polyline.validateSync();
231
-
232
- if(polylineErrors) {
233
- for (let key of Object.keys(polylineErrors.errors)) {
234
- console.log(polylineErrors.errors[key].message);
235
- errorList = errorList + polylineErrors.errors[key].message;
236
- }
237
- }
238
-
239
- break;
240
- }
241
- case 'beacon': {
242
-
243
- let beacon = new Beacon(geofeature);
244
- let beaconErrors = beacon.validateSync();
245
-
246
- if(beaconErrors) {
247
- for (let key of Object.keys(beaconErrors.errors)) {
248
- console.log(beaconErrors.errors[key].message);
249
- errorList = errorList + beaconErrors.errors[key].message;
250
- }
251
- }
252
-
253
- break;
254
- }
255
- default: {
256
- errorList = "Please enter a proper geofeature type. ";
257
- break;
258
- }
259
- }
260
- });
261
-
262
- if(errorList != '')
263
- throw new Error(errorList);
93
+ Zone = mongoose.model('Zone', ZoneSchema)
264
94
  }
265
- }
266
-
267
- function checkPoint(point, name1, name2){
268
- let pointErrors = '';
269
95
 
270
- if(!point.latitude) {
271
- pointErrors = pointErrors + name1 + " " +name2 + " should have a latitude field. ";
272
- } else if(point.latitude < -90 || point.latitude > 90) {
273
- pointErrors = pointErrors + name1 + " " + name2 + " latitude should be within -90 and 90. ";
274
- }
275
-
276
- if(!point.longitude) {
277
- pointErrors = pointErrors + name1 + " " +name2 + " should have a longitude field. ";
278
- } else if(point.longitude < -180 || point.longitude > 180) {
279
- pointErrors = pointErrors + name1 + " " + name2 + " longitude should be within -180 and 180. ";
280
- }
281
-
282
- return pointErrors;
96
+ return Zone
283
97
  }
284
98
 
285
- let Zone = mongoose.model('Zone', ZoneSchema);
286
-
287
- module.exports = Zone;
99
+ module.exports = { Zone: model, Schema: ZoneSchema }
@@ -3,23 +3,23 @@
3
3
  * Copyright : Bluedot Innovations.
4
4
  * Owner :
5
5
  */
6
- var mongoose = require('mongoose'),
7
- Schema = mongoose.Schema;
8
- var StateEnum = require('@bluedot-innovation/enums').StateEnum;
6
+ let mongoose = require('mongoose')
7
+ let Schema = mongoose.Schema
8
+ let StateEnum = require('@bluedot-innovation/enums').StateEnum
9
9
 
10
- var ZoneUIStateSchema = new mongoose.Schema({
11
- _id : {type: String},
12
- signature : {type: String},
13
- center : Schema.Types.Mixed,
14
- dataSource: {type:String, select: false, default : 'openApi'},
15
- zoom : {type: Number, default : 4},
16
- lastUpdateTime : {type: Date, default: Date.now},
17
- creationTime : {type: Date, default: Date.now},
18
- state: {type: String, default : StateEnum.active, select: false},
19
- zoneId: String
20
- },
21
- { collection : 'zoneUIState' }
22
- );
10
+ let ZoneUIStateSchema = new mongoose.Schema({
11
+ _id: {type: String},
12
+ signature: {type: String},
13
+ center: Schema.Types.Mixed,
14
+ dataSource: {type: String, select: false, default: 'openApi'},
15
+ zoom: {type: Number, default: 4},
16
+ lastUpdateTime: {type: Date, default: Date.now},
17
+ creationTime: {type: Date, default: Date.now},
18
+ state: {type: String, default: StateEnum.active, select: false},
19
+ zoneId: String
20
+ },
21
+ {collection: 'zoneUIState'}
22
+ )
23
23
 
24
- var ZoneUIState = mongoose.model('ZoneUIState', ZoneUIStateSchema);
25
- module.exports = ZoneUIState;
24
+ let ZoneUIState = mongoose.model('ZoneUIState', ZoneUIStateSchema)
25
+ module.exports = ZoneUIState