feat(schema): allow defining array of aliases in schema as well

Fix #12368

lib/schema.js

@@ -189,6 +189,34 @@ function aliasFields(schema, paths) {
 
     const prop = schema.paths[path].path;
 
+    if (Array.isArray(alias)) {
+      for (const a of alias) {
+        if (typeof a !== 'string') {
+          throw new Error('Invalid value for alias option on ' + prop + ', got ' + a);
+        }
+
+        schema.aliases[a] = prop;
+
+        schema.
+          virtual(a).
+          get((function(p) {
+            return function() {
+              if (typeof this.get === 'function') {
+                return this.get(p);
+              }
+              return this[p];
+            };
+          })(prop)).
+          set((function(p) {
+            return function(v) {
+              return this.$set(p, v);
+            };
+          })(prop));
+      }
+
+      continue;
+    }
+
     if (typeof alias !== 'string') {
       throw new Error('Invalid value for alias option on ' + prop + ', got ' + alias);
     }

test/schema.alias.test.js

@@ -159,4 +159,34 @@ describe('schema alias option', function() {
     done();
     // acquit:ignore:end
   });
+
+  it('array of aliases (gh-12368)', function() {
+    const productSchema = new Schema({
+      n: {
+        type: String,
+        alias: ['name', 'product_name']
+      }
+    });
+
+    const Product = db.model('Test', productSchema);
+    const doc = new Product({});
+
+    doc['product_name'] = 'Turbo Man';
+    assert.equal(doc.n, 'Turbo Man');
+    assert.equal(doc.name, 'Turbo Man');
+  });
+
+  it('alias() method (gh-12368)', function() {
+    const schema = new Schema({ name: String });
+
+    schema.alias('name', 'otherName');
+    assert.equal(schema.aliases['otherName'], 'name');
+    assert.ok(schema.virtuals['otherName']);
+
+    schema.alias('name', ['name1', 'name2']);
+    assert.equal(schema.aliases['name1'], 'name');
+    assert.equal(schema.aliases['name2'], 'name');
+    assert.ok(schema.virtuals['name1']);
+    assert.ok(schema.virtuals['name2']);
+  });
 });

test/schema.test.js

@@ -2868,21 +2868,6 @@ describe('schema', function() {
     assert.equal(doc1.domain, doc2.domain);
   });
 
-
-  it('alias (gh-12368)', function() {
-    const schema = new Schema({ name: String });
-
-    schema.alias('name', 'otherName');
-    assert.equal(schema.aliases['otherName'], 'name');
-    assert.ok(schema.virtuals['otherName']);
-
-    schema.alias('name', ['name1', 'name2']);
-    assert.equal(schema.aliases['name1'], 'name');
-    assert.equal(schema.aliases['name2'], 'name');
-    assert.ok(schema.virtuals['name1']);
-    assert.ok(schema.virtuals['name2']);
-  });
-
   it('allows defining ObjectIds and Decimal128s using Types.* (gh-12205)', function() {
     const schema = new Schema({
       testId: mongoose.Types.ObjectId,

types/index.d.ts

@@ -196,6 +196,12 @@ declare module 'mongoose' {
     /** Adds key path / schema type pairs to this schema. */
     add(obj: SchemaDefinition<SchemaDefinitionType<EnforcedDocType>> | Schema, prefix?: string): this;
 
+    /**
+     * Add an alias for `path`. This means getting or setting the `alias`
+     * is equivalent to getting or setting the `path`.
+     */
+    alias(path: string, alias: string | string[]): this;
+
     /**
      * Array of child schemas (from document arrays and single nested subdocs)
      * and their corresponding compiled models. Each element of the array is

types/schematypes.d.ts

@@ -57,7 +57,7 @@ declare module 'mongoose' {
                               T | typeof SchemaType | Schema<any, any, any> | SchemaDefinition<T> | Function | AnyArray<Function>;
 
     /** Defines a virtual with the given name that gets/sets this path. */
-    alias?: string;
+    alias?: string | string[];
 
     /** Function or object describing how to validate this schematype. See [validation docs](https://mongoosejs.com/docs/validation.html). */
     validate?: SchemaValidator<T> | AnyArray<SchemaValidator<T>>;