Updated documentation.

Corrected Timestamp lookup.
Fixes jloosli#33

Author: jloosli

README.md

@@ -37,6 +37,24 @@ Exports a json file with the following format:
       "docA": {
         "name": "Big Co",
         "employee_count": 2012,
+        "created": {
+          "__datatype__": "timestamp",
+          "value": {
+            "_seconds": 12343456,
+            "_nanoseconds": 7890
+          }
+        },
+        "location": {
+          "__datatype__": "geopoint",
+          "value": {
+            "_latitude": -123.456789,
+            "_longitude": 34.5678
+          }
+        },
+        "AdministratorRef": {
+          "__datatype__": "documentReference",
+          "value": "path/to/the/document"
+        },
         "__collections__": {
           "employees": ...,
           "products": ...
@@ -60,6 +78,23 @@ Imports need to be from a file with the same structure (e.g. from an exported fi
 __Be careful!__ This can easily overwrite or mess up your data if you import 
 to the wrong location.
 
+#### Special Datatypes
+
+Three types of data are serialized in the export: 
+
+* Timestamps
+* Geopoints
+* DocumentReferences
+
+They each are serialized in the following format:
+
+```json
+{
+  "__datatype__": "timestamp|geopoint|documentReference",
+  "value": "The serialized value"
+}
+```
+
 ## Installation
 Install using [__npm__](https://www.npmjs.com/).
 

src/interfaces/ICollection.ts

@@ -0,0 +1,5 @@
+import {IDocument} from "./IDocument";
+
+export interface ICollection {
+  [id: string]: IDocument;
+}

src/interfaces/IDocument.ts

@@ -0,0 +1,9 @@
+import {ICollection} from "./ICollection";
+
+export interface IDocument {
+  __collections__: {
+    [id: string]: ICollection;
+  };
+
+  [id: string]: any;
+}

src/interfaces/IDocumentReference.ts

@@ -0,0 +1,6 @@
+import {ISpecialType} from "./ISpecialType";
+
+export interface IDocumentReference extends ISpecialType {
+  __datatype__: 'documentReference';
+  value: string
+}

src/lib/interfaces.ts src/interfaces/IFirebaseCredentials.tssrc/lib/interfaces.ts renamed to src/interfaces/IFirebaseCredentials.ts

@@ -1,15 +1,3 @@
-export interface IDocument {
-  __collections__: {
-    [id: string]: ICollection;
-  };
-
-  [id: string]: any;
-}
-
-export interface ICollection {
-  [id: string]: IDocument;
-}
-
 export interface IFirebaseCredentials {
   type: string;
   project_id: string;

src/interfaces/IGeopoint.ts

@@ -0,0 +1,9 @@
+import {ISpecialType} from "./ISpecialType";
+
+export interface IGeopoint extends ISpecialType {
+  __datatype__: 'geopoint';
+  value: {
+    _latitude: number;
+    _longitude: number;
+  }
+}

src/interfaces/ISpecialType.ts

@@ -0,0 +1,4 @@
+export interface ISpecialType {
+  __datatype__: string;
+  value: any;
+}

src/interfaces/ITimestamp.ts

@@ -0,0 +1,9 @@
+import {ISpecialType} from "./ISpecialType";
+
+export interface ITimestamp extends ISpecialType {
+  __datatype__: 'timestamp';
+  value: {
+    _seconds: number;
+    _nanoseconds: number;
+  }
+}

src/lib/firestore-helpers.ts

@@ -1,6 +1,6 @@
 import * as admin from 'firebase-admin';
 import loadJsonFile from "load-json-file";
-import {IFirebaseCredentials} from "./interfaces";
+import {IFirebaseCredentials} from "../interfaces/IFirebaseCredentials";
 
 
 const getCredentialsFromFile = (credentialsFilename: string): Promise<IFirebaseCredentials> => {

src/lib/helpers.ts

@@ -1,4 +1,7 @@
 import * as admin from "firebase-admin";
+import {ITimestamp} from "../interfaces/ITimestamp";
+import {IGeopoint} from "../interfaces/IGeopoint";
+import {IDocumentReference} from "../interfaces/IDocumentReference";
 import DocumentReference = admin.firestore.DocumentReference;
 import GeoPoint = admin.firestore.GeoPoint;
 import Firestore = FirebaseFirestore.Firestore;
@@ -16,51 +19,75 @@ const array_chunks = (array: Array<any>, chunk_size: number): Array<Array<any>>
 const serializeSpecialTypes = (data: any) => {
   const cleaned: any = {};
   Object.keys(data).map(key => {
-    let value = data[key];
-    if (value instanceof admin.firestore.Timestamp) {
-      value = {__datatype__: 'timestamp', value: {seconds: value.seconds, nanoseconds: value.nanoseconds}};
-    } else if (value instanceof GeoPoint) {
-      value = {__datatype__: 'geopoint', value: value};
-    } else if (value instanceof DocumentReference) {
-      value = {__datatype__: 'documentReference', value: value.path};
-    } else if (value === Object(value)) {
-      let isArray = Array.isArray(value);
-      value = serializeSpecialTypes(value);
+    let rawValue = data[key];
+    if (rawValue instanceof admin.firestore.Timestamp) {
+      rawValue = {
+        __datatype__: 'timestamp',
+        value: {
+          _seconds: rawValue.seconds,
+          _nanoseconds: rawValue.nanoseconds
+        }
+      } as ITimestamp;
+    } else if (rawValue instanceof GeoPoint) {
+      rawValue = {
+        __datatype__: 'geopoint',
+        value: {
+          _latitude: rawValue.latitude,
+          _longitude: rawValue.longitude
+        }
+      } as IGeopoint;
+    } else if (rawValue instanceof DocumentReference) {
+      rawValue = {
+        __datatype__: 'documentReference',
+        value: rawValue.path
+      } as IDocumentReference;
+    } else if (rawValue === Object(rawValue)) {
+      let isArray = Array.isArray(rawValue);
+      rawValue = serializeSpecialTypes(rawValue);
       if (isArray) {
-        value = Object.keys(value).map(key => value[key]);
+        rawValue = Object.keys(rawValue).map(key => rawValue[key]);
       }
     }
-    cleaned[key] = value;
+    cleaned[key] = rawValue;
   });
   return cleaned;
 };
 
 const unserializeSpecialTypes = (data: any, fs: Firestore) => {
   const cleaned: any = {};
   Object.keys(data).map(key => {
-    let value = data[key];
-    if (value instanceof Object) {
-      if ('__datatype__' in value && 'value' in value) {
-        switch (value.__datatype__) {
+    let rawValue: any = data[key];
+    let cleanedValue: any;
+    if (rawValue instanceof Object) {
+      if ('__datatype__' in rawValue && 'value' in rawValue) {
+        switch (rawValue.__datatype__) {
           case 'timestamp':
-            value = new admin.firestore.Timestamp(value.value._seconds, value.value._nanoseconds);
+            rawValue = rawValue as ITimestamp;
+            if (rawValue.value instanceof String) {
+              const millis = Date.parse(rawValue.value);
+              cleanedValue = new admin.firestore.Timestamp(millis / 1000, 0);
+            } else {
+              cleanedValue = new admin.firestore.Timestamp(rawValue.value._seconds, rawValue.value._nanoseconds);
+            }
             break;
           case 'geopoint':
-            value = new admin.firestore.GeoPoint(value.value._latitude, value.value._longitude);
+            rawValue = rawValue as IGeopoint;
+            cleanedValue = new admin.firestore.GeoPoint(rawValue.value._latitude, rawValue.value._longitude);
             break;
           case 'documentReference':
-            value = fs.doc(value.value);
+            rawValue = rawValue as IDocumentReference;
+            rawValue = fs.doc(rawValue.value);
             break;
         }
       } else {
-        let isArray = Array.isArray(value);
-        value = unserializeSpecialTypes(value, fs);
+        let isArray = Array.isArray(rawValue);
+        cleanedValue = unserializeSpecialTypes(rawValue, fs);
         if (isArray) {
-          value = Object.keys(value).map(key => value[key])
+          cleanedValue = Object.keys(rawValue).map(key => rawValue[key])
         }
       }
     }
-    cleaned[key] = value;
+    cleaned[key] = cleanedValue;
   });
   return cleaned;
 };