Resolves #243

Author: etsuo

package.json

@@ -1,6 +1,6 @@
 {
  "name": "@sakuraapi/core",
- "version": "0.19.6",
+ "version": "0.20.0",
  "description": "MongoDB and TypeScript MEAN Stack Framework for NodeJS",
  "main": "lib/index.js",
  "typings": "lib/index.d.ts",

src/core/@model/id.spec.ts

@@ -40,6 +40,19 @@ describe('@Id', () => {
  });
  });
 
+ it('allows default ID on instantiation', () => {
+
+ @Model()
+ class DefaultValue extends SapiModelMixin() {
+ @Id()
+ id: ObjectID = new ObjectID();
+ }
+
+ const result = new DefaultValue();
+ expect(result.id).toBeDefined();
+
+ });
+
  describe('@Db', () => {
  it('maps fromDb', () => {
  const id = new ObjectID();

src/core/@model/model-operators/from-db.ts

@@ -54,8 +54,7 @@ export function fromDb<T = InstanceType<ReturnType<typeof SapiModelMixin>>>(json
 
 function mapDbToModel(this: ReturnType<typeof SapiModelMixin>,
  json: { [key: string]: any },
- model: InstanceType<ReturnType<typeof SapiModelMixin>>,
- isChild = false) {
+ model: InstanceType<ReturnType<typeof SapiModelMixin>>) {
 
  model = model || {} as InstanceType<ReturnType<typeof SapiModelMixin>>;
 
@@ -108,9 +107,9 @@ function mapDbToModel(this: ReturnType<typeof SapiModelMixin>,
  } else {
  if (subModel) {
  const newModel = new subModel();
- value = Object.assign(newModel, mapDbToModel.call(newModel.constructor, json[key], nextModel, true));
+ value = Object.assign(newModel, mapDbToModel.call(newModel.constructor, json[key], nextModel));
  } else {
- value = mapDbToModel.call(this, json[key], nextModel, true);
+ value = mapDbToModel.call(this, json[key], nextModel);
  }
  }
 

src/core/@model/model-operators/to-db.spec.ts

@@ -207,5 +207,44 @@ describe('Model.toDb', () => {
  });
 
  });
+
+ describe('#243 @Id fields should map to _id in dbo', () => {
+
+ @Model()
+ class Child extends SapiModelMixin() {
+ @Id()
+ id: ObjectID = new ObjectID();
+ }
+
+ @Model({
+ dbConfig: {
+ collection: 'users',
+ db: 'userDb'
+ }
+ })
+ class Parent extends SapiModelMixin() {
+ @Id()
+ id: ObjectID = new ObjectID();
+
+ @Db({model: Child})
+ children: Child[];
+ }
+
+ it('toDb', async () => {
+
+ const parent = new Parent();
+ parent.children = [
+ new Child(),
+ new Child()
+ ];
+
+ const result = parent.toDb();
+
+ expect(ObjectID.isValid(result._id)).toBeTruthy();
+ expect(ObjectID.isValid(result.children[0]._id)).toBeTruthy();
+ expect(ObjectID.isValid(result.children[1]._id)).toBeTruthy();
+
+ });
+ });
  });
 });

src/core/@model/model-operators/to-db.ts

@@ -1,5 +1,6 @@
 import { shouldRecurse } from '../../lib';
 import { dbSymbols, IDbOptions } from '../db';
+import { idSymbols } from '../id';
 import { modelSymbols } from '../model';
 import { debug } from './index';
 
@@ -27,71 +28,59 @@ export function toDb(changeSet?: any): object {
  debug.normal(`.toDb called, target '${(constructor || {} as any).name}'`);
 
  changeSet = changeSet || this;
-
- const dbObj = mapModelToDb.call(this, changeSet);
-
- delete (dbObj as any).id;
- if (!(dbObj as any)._id && this._id) {
- (dbObj as any)._id = this._id;
- }
-
- return dbObj;
+ return mapModelToDb.call(this, changeSet);
 }
 
-function mapModelToDb(source, depth = 0) {
+function mapModelToDb(model) {
 
- const result = {} as any;
- if (!source) {
+ const dbo = {} as any;
+ if (!model) {
  return;
  }
 
- const dbOptionsByPropertyName: Map<string, IDbOptions> = Reflect.getMetadata(dbSymbols.dbByPropertyName, source);
+ const dbOptionsByPropertyName: Map<string, IDbOptions> = Reflect.getMetadata(dbSymbols.dbByPropertyName, model);
 
  // iterate over each property
- const keys = Object.getOwnPropertyNames(source);
+ const keys = Object.getOwnPropertyNames(model);
 
  for (const key of keys) {
 
- const map = keyMapper.call(this, key, source[key], dbOptionsByPropertyName) || {} as any;
- const model = map.model;
+ const map = keyMapper.call(this, key, model[key], dbOptionsByPropertyName) || {} as any;
+ const subModel = map.model;
 
  if (!map.newKey) {
- // field is not mapped with @Db, and model is not promiscuous, skip it
+ // field is not mapped with @Db or @Id, and model is not promiscuous, skip it
  continue;
  }
 
  let value;
- if (model || shouldRecurse(source[key])) {
+ if (subModel || shouldRecurse(model[key])) {
 
- if (Array.isArray(source[key])) {
- ++depth;
+ if (Array.isArray(model[key])) {
  const values = [];
- for (const src of source[key]) {
- values.push(mapModelToDb.call(this, src, depth));
+ for (const src of model[key]) {
+ values.push(mapModelToDb.call(this, src));
  }
  value = values;
 
  } else if (map.newKey !== undefined) {
 
- value = mapModelToDb.call(this, source[key], ++depth);
+ value = mapModelToDb.call(this, model[key]);
 
  }
 
  } else if (map.newKey !== undefined) {
 
  // if a newKey (db key) has been defined, then set the value to the source [key] so that
  // result[map.newKey] will get source[key] - otherwise, result[map.newKey] will be undefined.
- value = source[key];
+ value = model[key];
 
  }
 
- result[map.newKey] = value;
- }
- if (depth > 0 && (result._id && result.id)) { // resolves #106
- delete result.id;
+ dbo[map.newKey] = value;
  }
 
- return result;
+ return dbo;
 }
 
 function keyMapper(key, value, dbMeta): { model: any, newKey: string } {
@@ -103,8 +92,13 @@ function keyMapper(key, value, dbMeta): { model: any, newKey: string } {
  }
 
  let fieldName: string;
- // if there's @Db meta data on the property
- if (dbMeta && dbMeta.get) {
+ const idProperty = Reflect.getMetadata(idSymbols.idByPropertyName, this);
+
+ if (idProperty && idProperty === key) { // if this is an @Id field
+
+ fieldName = '_id';
+
+ } else if (dbMeta && dbMeta.get) { // if there's @Db meta data on the property
  const dbOptions = (dbMeta.get(key)) as IDbOptions;
 
  if ((dbOptions || {}).field) {
@@ -118,7 +112,7 @@ function keyMapper(key, value, dbMeta): { model: any, newKey: string } {
 
  // if the model's promiscuous use the property name for the field name if @Db wasn't found...
  // otherwise leave the field out of the results
- if (!fieldName && ((modelOptions.dbConfig || {}).promiscuous || (this[modelSymbols.modelOptions] || {} as any).promiscuous)) {
+ if (!fieldName && ((modelOptions.dbConfig || {}).promiscuous || (modelOptions || {} as any).promiscuous)) {
  fieldName = key;
  }
 

src/core/@model/model.ts

@@ -244,10 +244,12 @@ export function Model(modelOptions?: IModelOptions): (object) => any {
  throw new Error(`Model ${target.name} defines 'dbConfig' but does not have an @Id decorated properties`);
  }
 
- // map _id to id
- newConstructor.prototype._id = undefined;
-
  if (idProperty) {
+ // if @Id has a default value, move it to _id
+ if (c[idProperty]) {
+ c._id = c[idProperty];
+ }
+
  Reflect.defineProperty(c, idProperty, {
  configurable: true,
  enumerable: true,