devops: add circleci

Author: codediodeio

.circleci/config.yml

@@ -0,0 +1,32 @@
+# Javascript Node CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-javascript/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/node:8
+      
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "package.json" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run: npm install
+
+      - save_cache:
+          paths:
+            - node_modules
+          key: v1-dependencies-{{ checksum "package.json" }}
+        
+      # run tests!
+      - run: npm run test

README.md

@@ -4,7 +4,15 @@ Realtime Geolocation with Firestore & RxJS
 
 [Live Demo](https://geo-test-c92e4.firebaseapp.com)
 
-## QuickStart
+<p align="center">
+
+<a href="https://slackin-pbfjhfxnsa.now.sh"><img src="https://slackin-pbfjhfxnsa.now.sh/badge.svg"></a>
+
+<!-- <a href="https://circleci.com/gh/codediodeio/angular-firestarter"><img src="https://circleci.com/gh/codediodeio/angular-firestarter.svg?style=svg"></a> -->
+
+</p>
+
+## :checkered_flag: QuickStart
 
 ```shell
 npm install firebase geofirex
@@ -55,7 +63,7 @@ query.subscribe(console.log);
 // [{ ...documentData, queryMetadata: { distance: 1.23232, bearing: 230.23 }  }]
 ```
 
-## API
+## :notebook: API
 
 ### `collection(path: string, query? QueryFn)`
 
@@ -114,7 +122,7 @@ Example: `const point = geo.point(38, -119)`
 - `point.distance(latitude, longitude)` Haversine distance to a point
 - `point.bearing(latitude, longitude)` Haversine bearing to a point
 
-## Tips
+## :zap: Tips
 
 ### Seeing this error: `DocumentReference.set() called with invalid data`
 

integration/src/app/basic-geoquery/basic-geoquery.component.scss

@@ -15,4 +15,17 @@ agm-map {
 button {
     display: block;
     margin-top: 10px
+}
+
+@media (max-width: 960px) {
+    .tools {
+        position: fixed;
+        top: 0;
+        background: #fff;
+        padding: 10px;
+        left: 0;
+        height: 100vh;
+        width: 20vw;
+        overflow-y: scroll;
+    }
 }

integration/src/app/realtime-geoquery/realtime-geoquery.component.scss

@@ -20,4 +20,17 @@ button {
 .doc {
     font-weight: 1.2em;
     font-weight: bold;
+}
+
+@media (max-width: 960px) {
+    .tools {
+        position: fixed;
+        top: 0;
+        background: #fff;
+        padding: 10px;
+        left: 0;
+        height: 100vh;
+        width: 20vw;
+        overflow-y: scroll;
+    }
 }

package.json

@@ -1,6 +1,6 @@
 {
     "name": "geofirex",
-    "version": "0.0.3",
+    "version": "0.0.4",
     "description": "Realtime Firestore GeoQueries with RxJS",
     "main": "dist/index.cjs.js",
     "module": "dist/index.esm.js",
@@ -14,7 +14,7 @@
         "url": "https://github.com/codediodeio/geofirex.git"
     },
     "scripts": {
-        "test": "jest --coverage",
+        "test": "jest --coverage --forceExit",
         "test:watch": "jest --watchAll",
         "build": "rollup -c",
         "dev": "rollup -c -w",

src/collection.ts

@@ -13,6 +13,16 @@ export interface GeoQueryOptions {
 }
 const defaultOpts: GeoQueryOptions = { units: 'km' };
 
+export interface QueryMetadata {
+  bearing: number;
+  distance: number;
+}
+
+export interface GeoQueryDocument {
+  [key: string]: any;
+  queryMetadata: QueryMetadata;
+}
+
 export class GeoFireCollectionRef {
   private ref: firestore.CollectionReference;
   private query: firestore.Query;
@@ -72,7 +82,7 @@ export class GeoFireCollectionRef {
    * @param  {string} id document id
    * @param  {Latitude} latitude
    * @param  {Longitude} longitude
-   * @param  {string='point'} field optional field to set data to
+   * @param  {string} field optional name of the document property, defaults to 'point'
    * @returns {Promise<void>}
    */
   setPoint(
@@ -103,14 +113,14 @@ export class GeoFireCollectionRef {
    * @param  {number} radius the radius to search from the centerpoint
    * @param  {string} field the document field that contains the GeoFirePoint data
    * @param  {GeoQueryOptions} opts=defaultOpts
-   * @returns {Observable<any>}
+   * @returns {Observable<GeoQueryDocument>}
    */
   within(
     center: GeoFirePoint,
     radius: number,
     field: string,
     opts = defaultOpts
-  ) {
+  ): Observable<GeoQueryDocument[]> {
     const precision = setPrecsion(radius);
     const centerHash = center.hash.substr(0, precision);
     const area = GeoFirePoint.neighbors(centerHash).concat(centerHash);
@@ -180,17 +190,9 @@ function snapToData(id = 'id') {
 }
 
 /**
-internal use only
+internal, do not use
  */
 function createStream(input): Observable<any> {
-  // return Observable.create(observer => {
-  //   input.onSnapshot({
-  //     next(val) {
-  //       observer.next(val);
-  //     }
-  //   });
-  // });
-
   return new Observable(observer => {
     const unsubscribe = input.onSnapshot(observer);
     return { unsubscribe };