monastery 1.41.0 → 1.41.1

package/changelog.md

@@ -2,6 +2,8 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.41.1](https://github.com/boycce/monastery/compare/1.41.0...1.41.1) (2023-04-17)
+
 ## [1.41.0](https://github.com/boycce/monastery/compare/1.40.5...1.41.0) (2023-04-16)
 
 ### [1.40.5](https://github.com/boycce/monastery/compare/1.40.4...1.40.5) (2023-02-22)

package/docs/definition/index.md

@@ -43,15 +43,20 @@ Model definition object.
     pets: [{ // array of embedded documents
       name: { type: 'string' },
       type: { type: 'string' },
-    }]
-    // You can add a rule on the embedded document or array using the following structure
-    pets: {
-      type: [{
+    }],
+    // You can add a rule on an embedded-document/array using the following structure
+    address: {
+      name: { type: 'string' },
+      type: { type: 'string' },
+      schema: { minLength: 1 },
+    },
+    pets: db.arrayWithSchema(
+      [{
         name: { type: 'string' },
         type: { type: 'string' },
       }],
-      minLength: 1,
-    }
+      { minLength: 1 },
+    )
   }
 }
 ```

package/lib/model.js

@@ -131,25 +131,6 @@ Model.prototype._setupFields = function(fields) {
    * @param {object|array} fields - subsdocument or array
    */
   util.forEach(fields, function(field, fieldName) {
-    // Preprocess type objects
-    if (util.isSchema(field) && typeof field.type == 'object') {
-      if (field.schema) {
-        this.error(`Field "${fieldName}.schema" on model "${this.name}" is ignored when using `
-        + 'object types, simply define the schema fields alongside field.type.')
-        delete fields[fieldName]
-        return
-      }
-      if (util.isSchema(field.type)) {
-        this.error(`"${fieldName}.type" on model "${this.name}" is a schema object, it must be either a ` 
-        + 'string, subdocument or array')
-        delete fields[fieldName]
-        return
-      }
-      let fieldCache = field
-      field = fields[fieldName] = field.type
-      field.schema = util.omit(fieldCache, ['type'])
-    }
-    
     // Schema field
     if (util.isSchema(field)) {
       // No image schema pre-processing done yet by a plugin

package/lib/util.js

@@ -109,6 +109,8 @@ module.exports = {
 
   isSubdocument: function(value) {
     /**
+     * "are all fields objects/arrays?"
+     * 
      * Is the value a subdocument which contains more fields? Or a just a field definition?
      * @param {object} value - object to check
      *   E.g. isSubdocument = {

package/package.json

@@ -2,7 +2,7 @@
   "name": "monastery",
   "description": "⛪ A straight forward MongoDB ODM built around Monk",
   "author": "Ricky Boyce",
-  "version": "1.41.0",
+  "version": "1.41.1",
   "license": "MIT",
   "repository": "github:boycce/monastery",
   "homepage": "https://boycce.github.io/monastery/",

package/test/model.js

@@ -68,58 +68,6 @@ module.exports = function(monastery, opendb) {
     ))
   })
 
-  test('model setup with type object', async () => {
-    // Setup
-    let db = (await opendb(false)).db
-    let user = db.model('user', { fields: {
-      name: { 
-        type: { cat: { type: 'string' }}, // subdocument
-        minLength: 4,
-      },
-      name2: { 
-        type: [{ type: 'string' }], // array
-        minLength: 4,
-      },
-    }})
-
-    // subdocument object type
-    expect(user.fields.name).toEqual({
-      cat: { isString: true, type: 'string' },
-      schema: { isObject: true, type: 'object', minLength: 4 }
-    })
-    // array object type
-    expect(JSON.stringify(user.fields.name2)).toEqual(JSON.stringify(
-      [{ type: 'string', isString: true }]
-    ))
-    expect(user.fields.name2.schema).toEqual({ 
-      type: 'array', 
-      isArray: true,
-      minLength: 4,
-    })
-  })
-
-  test('model setup with invalid schema type object', async () => {
-    // Setup
-    let db = (await opendb(false, { hideErrors: true })).db // hide debug error
-    let user = db.model('user', { fields: {
-      // valid subdocument
-      name: { 
-        type: { type: 'string' },
-      },
-      // schema with invlaid object type
-      name2: { 
-        type: { type: 'string' },
-        minLength: 10,
-      },
-    }})
-
-    expect(user.fields.name).toEqual({
-      type: { isString: true, type: 'string' },
-      schema: { isObject: true, type: 'object' },
-    })
-    expect(user.fields.name2).toEqual(undefined)
-  })
-
   test('model setup with default fields', async () => {
     // Setup
     let db = (await opendb(false, { defaultObjects: true })).db
@@ -167,6 +115,52 @@ module.exports = function(monastery, opendb) {
     })
   })
 
+  test('model setup with schema', async () => {
+    // Setup
+    let db = (await opendb(false)).db
+    let objectSchemaTypeRef = { name: { type: 'string', minLength: 5 } }
+    let user = db.model('user', { 
+      fields: {
+        pet: { ...objectSchemaTypeRef, schema: { virtual: true }}, 
+        pets: db.arrayWithSchema(
+          [objectSchemaTypeRef],
+          { virtual: true },
+        ),
+      }
+    })
+    // Object with schema
+    expect(user.fields.pet).toEqual({
+      name: {
+        type: 'string', 
+        isString: true,
+        minLength: 5,
+      },
+      schema: {
+        type: 'object', 
+        isObject: true,
+        virtual: true,
+      },
+    })
+    // Array with schema
+    expect(user.fields.pets[0]).toEqual({
+      name: {
+        type: 'string', 
+        isString: true,
+        minLength: 5,
+      },
+      schema: {
+        type: 'object', 
+        isObject: true,
+      },
+    })
+    expect(user.fields.pets.schema).toEqual({
+      type: 'array', 
+      isArray: true,
+      virtual: true,
+    })
+  })
+
+
   test('model reserved rules', async () => {
     // Setup
     let db = (await opendb(false, { hideErrors: true })).db // hide debug error