@bluedot-innovation/models 2.0.19-alpha.52 → 2.0.19-alpha.7

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,6 +1,5 @@
1
1
  ## 2.0.19
2
- - Allow "immediate" on proximity field in beacons.
3
- -
2
+ - Mask `State`, `creationTime`, `lastUpdateTime`, `geofeatures.geometry`, `secret` from API responses
4
3
 
5
4
  ## 2.0.18
6
5
  - `password` on `user` model no longer required. We will rely on cognito to throw an error
package/Models.js CHANGED
@@ -5,17 +5,17 @@
5
5
  let Models = {}
6
6
 
7
7
  Models.Account = require('./models/Account').Model
8
- Models.Beacon = require('./models/Beacon').Model
8
+ Models.Beacon = require('./models/geofeatures/Beacon').Model
9
9
  Models.BeaconFilter = require('./models/BeaconFilter').Model
10
10
  Models.BearingFilter = require('./models/BearingFilter').Model
11
- Models.BoundingBox = require('./models/BoundingBox').Model
11
+ Models.BoundingBox = require('./models/geofeatures/BoundingBox').Model
12
12
  Models.CalendarDateRangeFilter = require('./models/CalendarDateRangeFilter').Model
13
- Models.Circle = require('./models/Circle').Model
13
+ Models.Circle = require('./models/geofeatures/Circle').Model
14
14
  Models.MessageAction = require('./models/MessageAction').Model
15
15
  Models.MonthlyStat = require('./models/MonthlyStats').Model
16
16
  Models.PercentageCrossedFilter = require('./models/PercentageCrossedFilter').Model
17
- Models.Polygon = require('./models/Polygon').Model
18
- Models.Polyline = require('./models/Polyline').Model
17
+ Models.Polygon = require('./models/geofeatures/Polygon').Model
18
+ Models.Polyline = require('./models/geofeatures/Polyline').Model
19
19
  Models.Project = require('./models/Project').Model
20
20
  Models.RuleRequestAggregation = require('./models/RuleRequestAggregation').Model
21
21
  Models.SpeedFilter = require('./models/SpeedFilter').Model
@@ -28,17 +28,17 @@ Models.ZoneBeacon = require('./models/ZoneBeacon').Model
28
28
  let Schemas = {}
29
29
 
30
30
  Schemas.Account = require('./models/Account').Schema
31
- Schemas.Beacon = require('./models/Beacon').Schema
31
+ Schemas.Beacon = require('./models/geofeatures/Beacon').Schema
32
32
  Schemas.BeaconFilter = require('./models/BeaconFilter').Schema
33
33
  Schemas.BearingFilter = require('./models/BearingFilter').Schema
34
- Schemas.BoundingBox = require('./models/BoundingBox').Schema
34
+ Schemas.BoundingBox = require('./models/geofeatures/BoundingBox').Schema
35
35
  Schemas.CalendarDateRangeFilter = require('./models/CalendarDateRangeFilter').Schema
36
- Schemas.Circle = require('./models/Circle').Schema
36
+ Schemas.Circle = require('./models/geofeatures/Circle').Schema
37
37
  Schemas.MessageAction = require('./models/MessageAction').Schema
38
38
  Schemas.MonthlyStat = require('./models/MonthlyStats').Schema
39
39
  Schemas.PercentageCrossedFilter = require('./models/PercentageCrossedFilter').Schema
40
- Schemas.Polygon = require('./models/Polygon').Schema
41
- Schemas.Polyline = require('./models/Polyline').Schema
40
+ Schemas.Polygon = require('./models/geofeatures/Polygon').Schema
41
+ Schemas.Polyline = require('./models/geofeatures/Polyline').Schema
42
42
  Schemas.Project = require('./models/Project').Schema
43
43
  Schemas.RuleRequestAggregation = require('./models/RuleRequestAggregation').Schema
44
44
  Schemas.SpeedFilter = require('./models/SpeedFilter').Schema
@@ -2,7 +2,7 @@ let mongoose = require('mongoose')
2
2
  mongoose.Promise = global.Promise
3
3
 
4
4
  const BearingFilterModel = require('../../../Models').BearingFilter(mongoose)
5
- const { isMinimumNinetyApart } = require.main.require('models/BearingFilter')
5
+ const { isMinimumNinetyApart } = require('../../../models/BearingFilter')
6
6
  const describe = require('mocha').describe
7
7
  const it = require('mocha').it
8
8
  const chai = require('chai')
package/models/Project.js CHANGED
@@ -9,6 +9,7 @@ let Schema = mongoose.Schema
9
9
  let StateEnum = require('@bluedot-innovation/enums').StateEnum
10
10
  let uuidv4 = require('uuid/v4')
11
11
  let patcher = require('mongoose-json-patch')
12
+ const mongooseHidden = require('../utils/mongooseHidden')
12
13
  let helpers = require('../helpers')
13
14
 
14
15
  let WebhookSchema = require('../schemas/Webhook')
@@ -38,6 +39,7 @@ let ProjectSchema = new mongoose.Schema({
38
39
  {collection: 'project'})
39
40
 
40
41
  ProjectSchema.plugin(patcher)
42
+ ProjectSchema.plugin(mongooseHidden)
41
43
 
42
44
  // optional mongoose
43
45
  let model = (mongooseInstance) => {
package/models/User.js CHANGED
@@ -9,6 +9,7 @@ const patcher = require('mongoose-json-patch')
9
9
  const helpers = require('../helpers')
10
10
  const ProjectPermission = require('../schemas/ProjectPermission')
11
11
  const uuidv4 = require('uuid/v4')
12
+ const mongooseHidden = require('../utils/mongooseHidden')
12
13
 
13
14
  let UserSchema = new mongoose.Schema({
14
15
  _id: {type: String, default: uuidv4},
@@ -45,6 +46,8 @@ let UserSchema = new mongoose.Schema({
45
46
  {collection: 'user'})
46
47
 
47
48
  UserSchema.plugin(patcher)
49
+ UserSchema.plugin(mongooseHidden)
50
+
48
51
 
49
52
  // optional mongoose
50
53
  let model = (mongooseInstance) => {
package/models/Zone.js CHANGED
@@ -9,10 +9,10 @@ let Schema = mongoose.Schema
9
9
  let StateEnum = require('@bluedot-innovation/enums').StateEnum
10
10
  let messageActionSchema = require('./MessageAction').messageActionSchema
11
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
12
+ let circleSchema = require('./geofeatures/Circle').circleSchema
13
+ let boundingBoxSchema = require('./geofeatures/BoundingBox').boundingBoxSchema
14
+ let polylineSchema = require('./geofeatures/Polyline').polylineSchema
15
+ let polygonSchema = require('./geofeatures/Polygon').polygonSchema
16
16
  let beaconSchema = require('./ZoneBeacon').beaconSchema
17
17
  let speedFilterSchema = require('./SpeedFilter').speedFilterSchema
18
18
  let bearingFilterSchema = require('./BearingFilter').bearingFilterSchema
@@ -22,6 +22,7 @@ let percentageCrossedFilterSchema = require('./PercentageCrossedFilter').percent
22
22
  let uuidv4 = require('uuid/v4')
23
23
  let patcher = require('mongoose-json-patch')
24
24
  let helpers = require('../helpers')
25
+ const mongooseHidden = require('../utils/mongooseHidden')
25
26
 
26
27
  // ////// //
27
28
  // Schema //
@@ -69,9 +70,6 @@ let zoneSchema = new Schema({
69
70
  accountId: {type: String, required: true, validate: {isAsync: false, validator: helpers.validateUUIDv4, msg: 'default error message'}}
70
71
  }, {collection: 'zone'})
71
72
 
72
- // TODO: Test patcher and include for other schemas if required
73
- zoneSchema.plugin(patcher)
74
-
75
73
  zoneSchema.path('actions').discriminator('url', new Schema(urlActionSchema))
76
74
  zoneSchema.path('actions').discriminator('message', new Schema(messageActionSchema))
77
75
 
@@ -87,6 +85,10 @@ zoneSchema.path('geofeatures').discriminator('polygon', new Schema(polygonSchema
87
85
  zoneSchema.path('geofeatures').discriminator('polyline', new Schema(polylineSchema))
88
86
  zoneSchema.path('geofeatures').discriminator('boundingBox', new Schema(boundingBoxSchema))
89
87
 
88
+ // TODO: Test patcher and include for other schemas if required
89
+ zoneSchema.plugin(patcher)
90
+ zoneSchema.plugin(mongooseHidden)
91
+
90
92
  // optional mongoose
91
93
  const model = (mongooseInstance) => {
92
94
  let Zone
@@ -1,6 +1,6 @@
1
1
  const cloneDeep = require('lodash.clonedeep')
2
2
  const mongoose = require('mongoose')
3
- const beaconSchema = require('./Beacon').beaconSchema
3
+ const beaconSchema = require('./geofeatures/Beacon').beaconSchema
4
4
  const BeaconEnum = require('@bluedot-innovation/enums').BeaconEnum
5
5
 
6
6
  const schema = cloneDeep(beaconSchema)
@@ -8,7 +8,7 @@ const schema = cloneDeep(beaconSchema)
8
8
  schema.proximity = {
9
9
  type: String,
10
10
  default: BeaconEnum.FAR,
11
- enum: [BeaconEnum.NEAR, BeaconEnum.IMMEDIATE, BeaconEnum.FAR]
11
+ enum: [BeaconEnum.NEAR, BeaconEnum.FAR]
12
12
  }
13
13
 
14
14
  const ZoneBeaconSchema = new mongoose.Schema(schema)
@@ -1,9 +1,10 @@
1
- let mongoose = require('mongoose')
2
- let StateEnum = require('@bluedot-innovation/enums').StateEnum
3
- let Point = require('../schemas/Point')
4
- let PointGeometry = require('../schemas/PointGeometry')
5
- let uuidv4 = require('uuid/v4')
6
- let patcher = require('mongoose-json-patch')
1
+ const StateEnum = require('@bluedot-innovation/enums').StateEnum
2
+ const patcher = require('mongoose-json-patch')
3
+ const mongoose = require('mongoose')
4
+ const uuidv4 = require('uuid/v4')
5
+ const PointGeometry = require('../../schemas/PointGeometry')
6
+ const mongooseHidden = require('../../utils/mongooseHidden')
7
+ const Point = require('../../schemas/Point')
7
8
 
8
9
  let schema = {
9
10
  _id: {type: String, default: uuidv4},
@@ -41,6 +42,7 @@ BeaconSchema.index({ accountId: 1, geometry: '2dsphere' })
41
42
  // accountId: 1, geometry: "2dsphere"
42
43
 
43
44
  BeaconSchema.plugin(patcher)
45
+ BeaconSchema.plugin(mongooseHidden)
44
46
 
45
47
  // mongoose validator helper plugin
46
48
  BeaconSchema.post('validate', function (doc) {
@@ -1,8 +1,9 @@
1
- let mongoose = require('mongoose')
2
1
  let StateEnum = require('@bluedot-innovation/enums').StateEnum
2
+ let mongoose = require('mongoose')
3
3
  let uuidv4 = require('uuid/v4')
4
- let Point = require('../schemas/Point')
5
- let PolygonGeometry = require('../schemas/PolygonGeometry')
4
+ const PolygonGeometry = require('../../schemas/PolygonGeometry')
5
+ const Point = require('../../schemas/Point')
6
+ const mongooseHidden = require('../../utils/mongooseHidden')
6
7
 
7
8
  const schema = {
8
9
  _id: {type: String, default: uuidv4},
@@ -16,28 +17,31 @@ const schema = {
16
17
  state: {type: String, default: StateEnum.active, select: false}
17
18
  }
18
19
 
19
- const BoundingBoxSchema = new mongoose.Schema(
20
+ const boundingBoxSchema = new mongoose.Schema(
20
21
  schema,
21
22
  {
22
23
  _id: false,
23
24
  versionKey: false
24
25
  })
25
26
 
26
- BoundingBoxSchema.add({
27
+ boundingBoxSchema.add({
27
28
  type:
28
29
  {type: String, required: true}
29
30
  })
30
31
 
32
+ boundingBoxSchema.plugin(mongooseHidden)
33
+
34
+
31
35
  // optional mongoose
32
36
  let model = (mongooseInstance) => {
33
37
  let BoundingBox
34
38
  if (mongooseInstance) {
35
- BoundingBox = mongooseInstance.model('BoundingBox', BoundingBoxSchema)
39
+ BoundingBox = mongooseInstance.model('BoundingBox', boundingBoxSchema)
36
40
  } else {
37
- BoundingBox = mongoose.model('BoundingBox', BoundingBoxSchema)
41
+ BoundingBox = mongoose.model('BoundingBox', boundingBoxSchema)
38
42
  }
39
43
 
40
44
  return BoundingBox
41
45
  }
42
46
  // Exports Mongoose Model, Mongoose Schema, JSON schema (required locally for discriminators)
43
- module.exports = { Model: model, Schema: BoundingBoxSchema, boundingBoxSchema: schema }
47
+ module.exports = { Model: model, Schema: boundingBoxSchema, boundingBoxSchema: schema }
@@ -1,40 +1,45 @@
1
1
  let mongoose = require('mongoose')
2
2
  let StateEnum = require('@bluedot-innovation/enums').StateEnum
3
- let Point = require('../schemas/Point')
4
3
  let uuidv4 = require('uuid/v4')
5
- let PolygonGeometry = require('../schemas/PolygonGeometry')
4
+ const PolygonGeometry = require('../../schemas/PolygonGeometry')
5
+ const mongooseHidden = require('../../utils/mongooseHidden')
6
+ const Point = require('../../schemas/Point')
6
7
 
7
8
  let schema = {
8
9
  _id: {type: String, default: uuidv4},
9
- name: {type: String, required: [true, 'name is required.']},
10
+ geometry: {type: PolygonGeometry},
11
+ name: {type: String, required: [true, 'name is required. ']},
10
12
  color: String,
11
- radius: {type: Number, required: [true, 'radius is required.'], min: 5},
12
- center: {type: Point, required: [true, 'center is required.']},
13
+ radius: {type: Number, required: [true, 'radius is required. '], min: 5},
14
+ center: {type: Point, required: [true, 'center is required. ']},
13
15
  creationTime: {type: Date, default: Date.now},
14
16
  lastUpdateTime: {type: Date, default: Date.now},
15
- geometry: {type: PolygonGeometry},
16
17
  state: {type: String, default: StateEnum.active, select: false}
17
18
  }
18
19
 
19
- let CircleSchema = new mongoose.Schema(schema, {
20
- _id: false,
21
- __v: false
22
- }, { retainKeyOrder: true })
20
+ let circleSchema = new mongoose.Schema(
21
+ schema,
22
+ {
23
+ _id: false,
24
+ __v: false
25
+ })
23
26
 
24
- CircleSchema.add({
27
+ circleSchema.add({
25
28
  type: {type: String, required: true}
26
29
  })
27
30
 
31
+ circleSchema.plugin(mongooseHidden)
32
+
28
33
  // optional mongoose
29
34
  let model = (mongooseInstance) => {
30
35
  let Circle
31
36
  if (mongooseInstance) {
32
- Circle = mongooseInstance.model('Circle', CircleSchema)
37
+ Circle = mongooseInstance.model('Circle', circleSchema)
33
38
  } else {
34
- Circle = mongoose.model('Circle', CircleSchema)
39
+ Circle = mongoose.model('Circle', circleSchema)
35
40
  }
36
41
 
37
42
  return Circle
38
43
  }
39
44
  // Exports Mongoose Model, Mongoose Schema, JSON schema (required locally for discriminators)
40
- module.exports = { Model: model, Schema: CircleSchema, circleSchema: schema }
45
+ module.exports = { Model: model, Schema: circleSchema, circleSchema: schema }
@@ -1,6 +1,7 @@
1
1
  let mongoose = require('mongoose')
2
2
  let StateEnum = require('@bluedot-innovation/enums').StateEnum
3
- let Point = require('../schemas/Point')
3
+ const mongooseHidden = require('../../utils/mongooseHidden')
4
+ const Point = require('../../schemas/Point')
4
5
  let uuidv4 = require('uuid/v4')
5
6
 
6
7
  const schema = {
@@ -13,28 +14,31 @@ const schema = {
13
14
  lastUpdateTime: {type: Date, default: Date.now},
14
15
  state: {type: String, default: StateEnum.active, select: false}
15
16
  }
16
- const PolygonSchema = new mongoose.Schema(
17
+ const polygonSchema = new mongoose.Schema(
17
18
  schema,
18
19
  {
19
20
  _id: false,
20
21
  versionKey: false
21
22
  })
22
23
 
23
- PolygonSchema.add({
24
+ polygonSchema.add({
24
25
  type:
25
26
  {type: String, required: true}
26
27
  })
27
28
 
29
+ polygonSchema.plugin(mongooseHidden)
30
+
31
+
28
32
  // optional mongoose
29
33
  let model = (mongooseInstance) => {
30
34
  let Polygon
31
35
  if (mongooseInstance) {
32
- Polygon = mongooseInstance.model('Polygon', PolygonSchema)
36
+ Polygon = mongooseInstance.model('Polygon', polygonSchema)
33
37
  } else {
34
- Polygon = mongoose.model('Polygon', PolygonSchema)
38
+ Polygon = mongoose.model('Polygon', polygonSchema)
35
39
  }
36
40
 
37
41
  return Polygon
38
42
  }
39
43
  // Exports Mongoose Model, Mongoose Schema, JSON schema (required locally for discriminators)
40
- module.exports = { Model: model, Schema: PolygonSchema, polygonSchema: schema }
44
+ module.exports = { Model: model, Schema: polygonSchema, polygonSchema: schema }
@@ -1,41 +1,43 @@
1
1
  let mongoose = require('mongoose')
2
2
  let StateEnum = require('@bluedot-innovation/enums').StateEnum
3
- let Point = require('../schemas/Point')
3
+ const Point = require('../../schemas/Point')
4
4
  let uuidv4 = require('uuid/v4')
5
- let MultiLineStringGeometry = require('../schemas/MultiLineStringGeometry')
5
+ const MultiLineStringGeometry = require('../../schemas/MultiLineStringGeometry')
6
+ const mongooseHidden = require('../../utils/mongooseHidden')
6
7
 
7
8
  const schema = {
8
9
  _id: {type: String, default: uuidv4},
9
10
  geometry: {type: MultiLineStringGeometry},
10
- name: {type: String, required: [true, 'name is required. ']},
11
- vertices: {type: [Point], required: [true, 'vertices is required. ']},
11
+ name: {type: String, required: [true, 'name is required.']},
12
+ vertices: {type: [Point], required: [true, 'vertices is required.']},
12
13
  creationTime: {type: Date, default: Date.now},
13
14
  lastUpdateTime: {type: Date, default: Date.now},
14
15
  state: {type: String, default: StateEnum.active, select: false}
15
16
  }
16
17
 
17
- const PolylineSchema = new mongoose.Schema(
18
+ const polylineSchema = new mongoose.Schema(
18
19
  schema,
19
20
  {
20
21
  _id: false,
21
22
  versionKey: false
22
23
  })
23
24
 
24
- PolylineSchema.add({
25
- type:
26
- {type: String, required: true}
25
+ polylineSchema.add({
26
+ type: {type: String, required: true}
27
27
  })
28
28
 
29
+ polylineSchema.plugin(mongooseHidden)
30
+
29
31
  // optional mongoose
30
32
  let model = (mongooseInstance) => {
31
33
  let Polyline
32
34
  if (mongooseInstance) {
33
- Polyline = mongooseInstance.model('Polyline', PolylineSchema)
35
+ Polyline = mongooseInstance.model('Polyline', polylineSchema)
34
36
  } else {
35
- Polyline = mongoose.model('Polyline', PolylineSchema)
37
+ Polyline = mongoose.model('Polyline', polylineSchema)
36
38
  }
37
39
 
38
40
  return Polyline
39
41
  }
40
42
  // Exports Mongoose Model, Mongoose Schema, JSON schema (required locally for discriminators)
41
- module.exports = { Model: model, Schema: PolylineSchema, polylineSchema: schema }
43
+ module.exports = { Model: model, Schema: polylineSchema, polylineSchema: schema }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bluedot-innovation/models",
3
- "version": "2.0.19-alpha.52",
3
+ "version": "2.0.19-alpha.7",
4
4
  "description": "",
5
5
  "main": "Models.js",
6
6
  "scripts": {
@@ -30,10 +30,11 @@
30
30
  "sinon": "^4.1.2"
31
31
  },
32
32
  "dependencies": {
33
- "@bluedot-innovation/enums": "2.1.1",
33
+ "@bluedot-innovation/enums": "2.0.2",
34
34
  "lodash.clonedeep": "4.5.0",
35
35
  "mongoose": "^4.13.9",
36
36
  "mongoose-error-helper": "0.0.2",
37
+ "mongoose-hidden": "^1.5.3",
37
38
  "mongoose-json-patch": "^1.1.1",
38
39
  "uuid": "^3.1.0"
39
40
  }
@@ -0,0 +1,9 @@
1
+ const mongooseHidden = require('mongoose-hidden')({defaultHidden: {
2
+ state: true,
3
+ creationTime: true,
4
+ lastUpdateTime: true,
5
+ __v: true,
6
+ secret: true
7
+ }})
8
+
9
+ module.exports = mongooseHidden;