@bluedot-innovation/models 2.0.22 → 3.0.0-alpha.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.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,12 @@
1
+ ## 3.0.0
2
+
3
+ - Breaking changes:
4
+ - `bearing` -> `travelDirection`
5
+ - `percentageCrossed` -> `travelPath`
6
+ - `percentage.percentage` -> `travelPath.minimumGeofeaturesCrossed`
7
+ - `timeofDayRange` -> `timeActive`
8
+ - `calendarDateRange` -> `dayRange`
9
+
1
10
  ## 2.0.22
2
11
 
3
12
  - Allow 0 Major and Minor
package/Models.js CHANGED
@@ -7,7 +7,7 @@ let Models = {}
7
7
  Models.Account = require('./models/Account').Model
8
8
  Models.Beacon = require('./models/Beacon').Model
9
9
  Models.BeaconFilter = require('./models/BeaconFilter').Model
10
- Models.BearingFilter = require('./models/BearingFilter').Model
10
+ Models.TravelDirection = require('./models/filters/TravelDirection').Model
11
11
  Models.BoundingBox = require('./models/BoundingBox').Model
12
12
  Models.CalendarDateRangeFilter = require('./models/CalendarDateRangeFilter').Model
13
13
  Models.Circle = require('./models/Circle').Model
@@ -30,7 +30,7 @@ let Schemas = {}
30
30
  Schemas.Account = require('./models/Account').Schema
31
31
  Schemas.Beacon = require('./models/Beacon').Schema
32
32
  Schemas.BeaconFilter = require('./models/BeaconFilter').Schema
33
- Schemas.BearingFilter = require('./models/BearingFilter').Schema
33
+ Schemas.TravelDirection = require('./models/filters/TravelDirection').Schema
34
34
  Schemas.BoundingBox = require('./models/BoundingBox').Schema
35
35
  Schemas.CalendarDateRangeFilter = require('./models/CalendarDateRangeFilter').Schema
36
36
  Schemas.Circle = require('./models/Circle').Schema
@@ -1,5 +1,5 @@
1
1
  {
2
- "type" : "bearing",
2
+ "type" : "travelDirection",
3
3
  "fromAngle" : 0,
4
4
  "toAngle" : 90
5
- }
5
+ }
@@ -1,27 +1,27 @@
1
1
  let mongoose = require('mongoose')
2
2
  mongoose.Promise = global.Promise
3
3
 
4
- const BearingFilterModel = require('../../../Models').BearingFilter(mongoose)
5
- const { isMinimumNinetyApart } = require.main.require('models/BearingFilter')
4
+ const TravelDirectionModel = require('../../../Models').TravelDirection(mongoose)
5
+ const { isMinimumNinetyApart } = require.main.require('models/filters/TravelDirection')
6
6
  const describe = require('mocha').describe
7
7
  const it = require('mocha').it
8
8
  const chai = require('chai')
9
9
  const assert = chai.assert
10
10
  const mocha = require('mocha')
11
11
  const beforeEach = mocha.beforeEach
12
- const rules = require('./bearingFilter.rules.json')
12
+ const rules = require('./travelDirection.rules.json')
13
13
 
14
- let bearingFilter
14
+ let travelDirectionFilter
15
15
 
16
16
  beforeEach(() => {
17
- bearingFilter = JSON.parse(JSON.stringify(require('./bearingFilter.data.json')))
17
+ travelDirectionFilter = JSON.parse(JSON.stringify(require('./travelDirection.data.json')))
18
18
  })
19
19
 
20
- describe('BearingFilter', () => {
21
- describe('Valid BearingFilter', () => {
22
- it('should validate a valid bearingFilter ', (done) => {
23
- let BearingFilter = new BearingFilterModel(bearingFilter)
24
- BearingFilter.validate((err, res) => {
20
+ describe('TravelDirection', () => {
21
+ describe('Valid TravelDirection', () => {
22
+ it('should validate a valid travelDirectionFilter ', (done) => {
23
+ let TravelDirection = new TravelDirectionModel(travelDirectionFilter)
24
+ TravelDirection.validate((err, res) => {
25
25
  assert.notExists(res)
26
26
  assert(err === null, 'err should equals null')
27
27
  done()
@@ -29,21 +29,21 @@ describe('BearingFilter', () => {
29
29
  })
30
30
  })
31
31
 
32
- describe('Invalid BearingFilter', () => {
33
- it('should not validate a bearingFilter with invalid BearingFilter', (done) => {
34
- delete bearingFilter[rules.requiredFields[0]]
35
- let BearingFilter = new BearingFilterModel(bearingFilter)
36
- BearingFilter.validate((err, res) => {
32
+ describe('Invalid TravelDirection', () => {
33
+ it('should not validate a travelDirectionFilter with invalid TravelDirection', (done) => {
34
+ delete travelDirectionFilter[rules.requiredFields[0]]
35
+ let TravelDirection = new TravelDirectionModel(travelDirectionFilter)
36
+ TravelDirection.validate((err, res) => {
37
37
  assert.exists(err, 'err object should exist')
38
38
  assert.isObject(err)
39
39
  done()
40
40
  })
41
41
  })
42
42
  it('should throw an error when toAngle === fromAngle', (done) => {
43
- bearingFilter.toAngle = 10
44
- bearingFilter.fromAngle = 10
45
- let BearingFilter = new BearingFilterModel(bearingFilter)
46
- BearingFilter.validate((err, res) => {
43
+ travelDirectionFilter.toAngle = 10
44
+ travelDirectionFilter.fromAngle = 10
45
+ let TravelDirection = new TravelDirectionModel(travelDirectionFilter)
46
+ TravelDirection.validate((err, res) => {
47
47
  assert.exists(err, 'err object should exist')
48
48
  assert.isObject(err)
49
49
  assert.nestedProperty(err, `errors.toAngle`, 'error should have a toAngle property')
@@ -51,10 +51,10 @@ describe('BearingFilter', () => {
51
51
  })
52
52
  })
53
53
  it('should throw an error when toAngle < 90 degrees from fromAngle (and toAngle < fromAngle)', (done) => {
54
- bearingFilter.toAngle = 5
55
- bearingFilter.fromAngle = 10
56
- let BearingFilter = new BearingFilterModel(bearingFilter)
57
- BearingFilter.validate((err, res) => {
54
+ travelDirectionFilter.toAngle = 5
55
+ travelDirectionFilter.fromAngle = 10
56
+ let TravelDirection = new TravelDirectionModel(travelDirectionFilter)
57
+ TravelDirection.validate((err, res) => {
58
58
  assert.exists(err, 'err object should exist')
59
59
  assert.isObject(err)
60
60
  assert.nestedProperty(err, `errors.toAngle`, 'error should have a toAngle property')
@@ -62,10 +62,10 @@ describe('BearingFilter', () => {
62
62
  })
63
63
  })
64
64
  it('should throw an error when toAngle < 90 degrees from fromAngle (and toAngle > fromAngle)', (done) => {
65
- bearingFilter.toAngle = 10
66
- bearingFilter.fromAngle = 5
67
- let BearingFilter = new BearingFilterModel(bearingFilter)
68
- BearingFilter.validate((err, res) => {
65
+ travelDirectionFilter.toAngle = 10
66
+ travelDirectionFilter.fromAngle = 5
67
+ let TravelDirection = new TravelDirectionModel(travelDirectionFilter)
68
+ TravelDirection.validate((err, res) => {
69
69
  assert.exists(err, 'err object should exist')
70
70
  assert.isObject(err)
71
71
  assert.nestedProperty(err, `errors.toAngle`, 'error should have a toAngle property')
@@ -76,10 +76,10 @@ describe('BearingFilter', () => {
76
76
  let requiredFields = rules.requiredFields
77
77
  requiredFields.map((i) => {
78
78
  it(`should throw an error with property '${i}' if '${i}' is not present`, (done) => {
79
- // delete i from geofeatures' bearingFilter child
80
- delete bearingFilter[i]
81
- let BearingFilter = new BearingFilterModel(bearingFilter)
82
- BearingFilter.validate((err, res) => {
79
+ // delete i from geofeatures' travelDirectionFilter child
80
+ delete travelDirectionFilter[i]
81
+ let TravelDirection = new TravelDirectionModel(travelDirectionFilter)
82
+ TravelDirection.validate((err, res) => {
83
83
  assert.notExists(res)
84
84
  assert.exists(err, 'err object should exist')
85
85
  assert.isObject(err)
package/models/Zone.js CHANGED
@@ -15,7 +15,7 @@ let polylineSchema = require('./Polyline').polylineSchema
15
15
  let polygonSchema = require('./Polygon').polygonSchema
16
16
  let beaconSchema = require('./ZoneBeacon').beaconSchema
17
17
  let speedFilterSchema = require('./SpeedFilter').speedFilterSchema
18
- let bearingFilterSchema = require('./BearingFilter').bearingFilterSchema
18
+ let travelDirectionRawSchema = require('./filters/travelDirection').rawSchema
19
19
  let timeOfDayRangeFilterSchema = require('./TimeOfDayRangeFilter').timeOfDayRangeFilterSchema
20
20
  let calendarDateRangeFilterSchema = require('./CalendarDateRangeFilter').calendarDateRangeFilterSchema
21
21
  let percentageCrossedFilterSchema = require('./PercentageCrossedFilter').percentageCrossedFilterSchema
@@ -75,7 +75,7 @@ zoneSchema.plugin(patcher)
75
75
  zoneSchema.path('actions').discriminator('url', new Schema(urlActionSchema))
76
76
  zoneSchema.path('actions').discriminator('message', new Schema(messageActionSchema))
77
77
 
78
- zoneSchema.path('filters').discriminator('bearing', new Schema(bearingFilterSchema))
78
+ zoneSchema.path('filters').discriminator('travelDirection', new Schema(travelDirectionRawSchema))
79
79
  zoneSchema.path('filters').discriminator('calendarDateRange', new Schema(calendarDateRangeFilterSchema))
80
80
  zoneSchema.path('filters').discriminator('percentageCrossed', new Schema(percentageCrossedFilterSchema))
81
81
  zoneSchema.path('filters').discriminator('speed', new Schema(speedFilterSchema))
@@ -7,31 +7,31 @@ const schema = {
7
7
  toAngle: {type: Number, required: true, min: 0, max: 359, validate: {isAsync: true, validator: validateAngles, msg: 'default error message'}}
8
8
  }
9
9
 
10
- const BearingFilterSchema = new mongoose.Schema(schema, {
10
+ const TravelDirectionFilterSchema = new mongoose.Schema(schema, {
11
11
  versionKey: false
12
12
  })
13
13
 
14
14
  // For discriminator key
15
- BearingFilterSchema.add({
15
+ TravelDirectionFilterSchema.add({
16
16
  type: {type: String, required: true}
17
17
  })
18
18
 
19
- function validateAngles (toAngle, magicCallback) {
19
+ function validateAngles (toAngle, callback) {
20
20
  let fromAngle = this.fromAngle
21
21
 
22
22
  if (toAngle === undefined) {
23
- return magicCallback(false, 'toAngle is required')
23
+ return callback(false, 'toAngle is required')
24
24
  }
25
25
 
26
26
  if (fromAngle === undefined) {
27
- return magicCallback(false, 'fromAngle is required')
27
+ return callback(false, 'fromAngle is required')
28
28
  }
29
29
 
30
30
  if (!isMinimumNinetyApart(fromAngle, toAngle)) {
31
- return magicCallback(false, 'From Angle and To Angle must be separated by at least 90 degrees in either direction')
31
+ return callback(false, 'From Angle and To Angle must be separated by at least 90 degrees in either direction')
32
32
  }
33
33
 
34
- magicCallback(true)
34
+ callback(true)
35
35
  }
36
36
 
37
37
  function isMinimumNinetyApart (fromAngle, toAngle) {
@@ -46,33 +46,22 @@ function isMinimumNinetyApart (fromAngle, toAngle) {
46
46
  if (lessThan90 || lessThan90Wrapped) { return false }
47
47
  return true
48
48
  }
49
- // function isMinimumNinetyApart (fromAngle, toAngle) {
50
- // const fromAngleWrapped = parseInt(fromAngle) + 360
51
- // const toAngleWrapped = parseInt(toAngle) + 360
52
- // if ((fromAngle - toAngle) === 90 || (toAngle - fromAngle) === 90) {
53
- // return true
54
- // } else if (fromAngle > toAngle) {
55
- // return (toAngleWrapped - fromAngle) === 90
56
- // } else if (fromAngle < toAngle) {
57
- // return (fromAngleWrapped - toAngle) === 90
58
- // }
59
- // }
60
49
 
61
50
  // optional mongoose
62
51
  let model = (mongooseInstance) => {
63
- let BearingFilter
52
+ let TravelDirectionFilter
64
53
  if (mongooseInstance) {
65
- BearingFilter = mongooseInstance.model('BearingFilter', BearingFilterSchema)
54
+ TravelDirectionFilter = mongooseInstance.model('TravelDirectionFilter', TravelDirectionFilterSchema)
66
55
  } else {
67
- BearingFilter = mongoose.model('BearingFilter', BearingFilterSchema)
56
+ TravelDirectionFilter = mongoose.model('TravelDirectionFilter', TravelDirectionFilterSchema)
68
57
  }
69
58
 
70
- return BearingFilter
59
+ return TravelDirectionFilter
71
60
  }
72
61
  // Exports Mongoose Model, Mongoose Schema, JSON schema (required locally for discriminators)
73
62
  module.exports = {
74
63
  Model: model,
75
- Schema: BearingFilterSchema,
76
- bearingFilterSchema: schema,
64
+ Schema: TravelDirectionFilterSchema,
65
+ rawSchema: schema,
77
66
  isMinimumNinetyApart
78
67
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bluedot-innovation/models",
3
- "version": "2.0.22",
3
+ "version": "3.0.0-alpha.1",
4
4
  "description": "",
5
5
  "main": "Models.js",
6
6
  "scripts": {