Merge branch 'release/v2.1.0'

Author: sebelga

lib/entity.js

@@ -140,11 +140,7 @@ function createKey(self, id, ancestors, namespace) {
 
     let path;
     if (id) {
-        if (is.string(id)) {
-            id = isFinite(id) ? parseInt(id, 10) : id;
-        } else if (!is.number(id)) {
-            throw new Error('id must be a string or a number');
-        }
+        id = parseId(self, id);
         path = hasAncestors ? ancestors.concat([self.entityKind, id]) : [self.entityKind, id];
     } else {
         if (hasAncestors) {
@@ -159,6 +155,30 @@ function createKey(self, id, ancestors, namespace) {
     return namespace ? self.gstore.ds.key({ namespace, path }) : self.gstore.ds.key(path);
 }
 
+/**
+ * Parse the id and according to the keyType config in the Schema ("name"|"id"|<undefined>)
+ * it will convert an '123'(string) id to 123 (int).
+ * @param {*} self -- the entity instance
+ * @param {*} id -- id passed in constructor
+ */
+function parseId(self, id) {
+    const { options } = self.schema;
+
+    if (is.string(id)) {
+        if (options && options.keyType === 'name') {
+            return id;
+        } else if (options.keyType === 'id') {
+            return self.gstore.ds.int(id);
+        }
+        // auto convert string number to number
+        return isFinite(id) ? self.gstore.ds.int(id) : id;
+    } else if (!is.number(id)) {
+        throw new Error('id must be a string or a number');
+    }
+
+    return id;
+}
+
 function buildEntityData(self, data) {
     const { schema } = self;
     const isJoiSchema = !is.undef(schema._joi);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gstore-node",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "gstore-node is a Google Datastore Entity Models tools",
   "main": "index.js",
   "scripts": {

test/entity-test.js

@@ -216,7 +216,18 @@ describe('Entity', () => {
             it('---> with a full Key ("string" Integer keyname passed)', () => {
                 const entity = new Model({}, '123');
 
-                expect(entity.entityKey.id).equal(123);
+                expect(entity.entityKey.id).equal('123');
+            });
+
+            it('---> with a full Key ("string" Integer **not** converted)', () => {
+                schema = new Schema({
+                    name: { type: 'string' },
+                }, { keyType: 'name' });
+                Model = gstore.model('EntityKind', schema);
+
+                const entity = new Model({}, '123');
+
+                expect(entity.entityKey.name).equal('123');
             });
 
             it('---> throw error is id passed is not string or number', () => {