feat: findOne and removing metadata local scope (#93)

feat: findOne and removing metadata local scope

docgen/index.html

@@ -27,6 +27,10 @@
       name="keywords"
       content="fireorm, orm, google firestore, firebase firestore, orm for firestore, object-relational mapper for firestore"
     />
+    <meta
+      name="google-site-verification"
+      content="rNOyKPlEr5GjTyoc6fAPbmDrH3lFClwt8nfYYfiWuTE"
+    />
     <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css" />
 
     <style>

package.json

@@ -63,8 +63,7 @@
     "tslint": "^5.12.0",
     "typedoc": "^0.15.0",
     "typedoc-plugin-markdown": "^2.2.7",
-    "typescript": "^3.2.2",
-    "uuid": "^3.3.2"
+    "typescript": "^3.2.2"
   },
   "peerDependencies": {
     "reflect-metadata": "^0.1.13"

src/AbstractFirestoreRepository.ts

@@ -279,6 +279,19 @@ export abstract class AbstractFirestoreRepository<T extends IEntity>
     return new QueryBuilder<T>(this).find();
   }
 
+  /**
+   * Execute the query to find at least one document matching all
+   * filters (if specified)
+   *
+   * @returns {Promise<T | null>} One document that matched the filters
+   * (if specified), or null if none exists.
+   *
+   * @memberof AbstractFirestoreRepository
+   */
+  findOne(): Promise<T | null> {
+    return new QueryBuilder<T>(this).findOne();
+  }
+
   /**
    * Takes all the queries stored by QueryBuilder and executes them.
    * Must be implemented by base repositores
@@ -297,6 +310,7 @@ export abstract class AbstractFirestoreRepository<T extends IEntity>
   abstract execute(
     queries: IFireOrmQueryLine[],
     limitVal?: number,
-    orderByObj?: IOrderByParams
+    orderByObj?: IOrderByParams,
+    single?: boolean
   ): Promise<T[]>;
 }

src/BaseFirestoreRepository.spec.ts

@@ -1,41 +1,13 @@
-import BaseFirestoreRepository from './BaseFirestoreRepository';
-import { getFixture, Album, Coordinates } from '../test/fixture';
 import { expect } from 'chai';
-import { Collection, SubCollection, ISubCollection, Initialize } from '.';
-import { Type } from './';
-import { MetadataStorage } from './MetadataStorage';
 const MockFirebase = require('mock-cloud-firestore');
 
-const store = { metadataStorage: new MetadataStorage() };
-Initialize(null, store);
-
-@Collection('bands')
-class Band {
-  id: string;
-  name: string;
-  formationYear: number;
-  lastShow: Date;
-
-  // Todo create fireorm bypass decorator
-  @Type(() => Coordinates)
-  lastShowCoordinates: Coordinates;
-  genres: Array<string>;
-
-  @SubCollection(Album)
-  albums?: ISubCollection<Album>;
-
-  getLastShowYear() {
-    return this.lastShow.getFullYear();
-  }
-
-  getPopularGenre() {
-    return this.genres[0];
-  }
-}
-
-class BandRepository extends BaseFirestoreRepository<Band> {}
+import { Initialize } from './MetadataStorage';
+import { getFixture, Album, Coordinates } from '../test/fixture';
+import { BaseFirestoreRepository } from './BaseFirestoreRepository';
+import { Band } from '../test/BandCollection';
 
 describe('BaseFirestoreRepository', () => {
+  class BandRepository extends BaseFirestoreRepository<Band> {}
   let bandRepository: BaseFirestoreRepository<Band> = null;
 
   beforeEach(() => {
@@ -45,7 +17,7 @@ describe('BaseFirestoreRepository', () => {
     });
 
     const firestore = firebase.firestore();
-    Initialize(firestore, store);
+    Initialize(firestore);
     bandRepository = new BandRepository('bands');
   });
 
@@ -362,6 +334,33 @@ describe('BaseFirestoreRepository', () => {
     });
   });
 
+  describe('findOne', () => {
+    it('must return T', async () => {
+      const result = await bandRepository
+        .whereLessOrEqualThan('formationYear', 1983)
+        .whereArrayContains('genres', 'funk-rock')
+        .findOne();
+      expect(result).to.be.instanceOf(Band);
+      expect(result.id).to.equal('red-hot-chili-peppers');
+    });
+
+    it('must return null if not found', async () => {
+      const result = await bandRepository
+        .whereLessThan('formationYear', 0)
+        .findOne();
+      expect(result).to.be.null;
+    });
+
+    it('should work within transactions', async () => {
+      await bandRepository.runTransaction(async tran => {
+        const result = await tran
+          .whereLessThan('formationYear', 0)
+          .findOne();
+        expect(result).to.be.null;
+      });
+    });
+  });
+
   describe('miscellaneous', () => {
     it('should correctly parse dates', async () => {
       const pt = await bandRepository.findById('porcupine-tree');

src/BaseFirestoreRepository.ts

@@ -16,7 +16,7 @@ import { AbstractFirestoreRepository } from './AbstractFirestoreRepository';
 import { TransactionRepository } from './BaseFirestoreTransactionRepository';
 import { FirestoreBatchRepository } from './BatchFirestoreRepository';
 
-export default class BaseFirestoreRepository<T extends IEntity>
+export class BaseFirestoreRepository<T extends IEntity>
   extends AbstractFirestoreRepository<T>
   implements IRepository<T> {
   private readonly firestoreColRef: CollectionReference;
@@ -42,7 +42,7 @@ export default class BaseFirestoreRepository<T extends IEntity>
     }
   }
 
-  findById(id: string): Promise<T> {
+  async findById(id: string): Promise<T> {
     return this.firestoreColRef
       .doc(id)
       .get()
@@ -89,8 +89,10 @@ export default class BaseFirestoreRepository<T extends IEntity>
     await this.firestoreColRef.doc(id).delete();
   }
 
-  runTransaction(executor: (tran: TransactionRepository<T>) => Promise<void>) {
-    return this.firestoreColRef.firestore.runTransaction(t => {
+  async runTransaction(
+    executor: (tran: TransactionRepository<T>) => Promise<void>
+  ) {
+    return this.firestoreColRef.firestore.runTransaction(async t => {
       return executor(
         new TransactionRepository<T>(
           this.firestoreColRef,
@@ -108,10 +110,11 @@ export default class BaseFirestoreRepository<T extends IEntity>
     );
   }
 
-  execute(
+  async execute(
     queries: Array<IFireOrmQueryLine>,
     limitVal?: number,
-    orderByObj?: IOrderByParams
+    orderByObj?: IOrderByParams,
+    single?: boolean
   ): Promise<T[]> {
     let query = queries.reduce((acc, cur) => {
       const op = cur.operator as WhereFilterOp;
@@ -122,9 +125,12 @@ export default class BaseFirestoreRepository<T extends IEntity>
       query = query.orderBy(orderByObj.fieldPath, orderByObj.directionStr);
     }
 
-    if (limitVal) {
+    if (single) {
+      query = query.limit(1);
+    } else if (limitVal) {
       query = query.limit(limitVal);
     }
+
     return query.get().then(this.extractTFromColSnap);
   }
 }

src/BaseFirestoreTransactionRepository.spec.ts

@@ -1,32 +1,9 @@
-import BaseFirestoreRepository from './BaseFirestoreRepository';
-import { getFixture, Album, Coordinates } from '../test/fixture';
 import { expect } from 'chai';
-import { Collection, SubCollection, ISubCollection, Initialize } from '.';
-import { MetadataStorage } from './MetadataStorage';
 const MockFirebase = require('mock-cloud-firestore');
-
-const store = { metadataStorage: new MetadataStorage() };
-Initialize(null, store);
-
-@Collection('bands')
-class Band {
-  id: string;
-  name: string;
-  formationYear: number;
-  lastShow: Date;
-  genres: Array<string>;
-
-  @SubCollection(Album)
-  albums?: ISubCollection<Album>;
-
-  getLastShowYear() {
-    return this.lastShow.getFullYear();
-  }
-
-  getPopularGenre() {
-    return this.genres[0];
-  }
-}
+import { BaseFirestoreRepository } from './BaseFirestoreRepository';
+import { getFixture, Album } from '../test/fixture';
+import { Initialize } from './MetadataStorage';
+import { Band } from '../test/BandCollection';
 
 // Just a test type to prevent using any other method than
 // runTransaction in this file
@@ -47,7 +24,7 @@ describe('BaseFirestoreTransactionRepository', () => {
     });
 
     const firestore = firebase.firestore();
-    Initialize(firestore, store);
+    Initialize(firestore);
     bandRepository = new BandRepository('bands');
   });
 

src/Decorators/Collection.spec.ts

@@ -1,13 +1,12 @@
-import Collection from './Collection';
 import { expect } from 'chai';
-import { MetadataStorage, Initialize } from '../MetadataStorage';
+import { Initialize, getStore, clearMetadataStorage } from '../MetadataStorage';
+import { Collection } from './Collection';
 
 describe('CollectionDecorator', () => {
-  const store = { metadataStorage: new MetadataStorage() };
-
+  const store = getStore();
   beforeEach(() => {
-    store.metadataStorage = new MetadataStorage();
-    Initialize(null, store);
+    clearMetadataStorage();
+    Initialize(null);
   });
 
   it('should register collections', () => {

src/Decorators/Collection.ts

@@ -1,7 +1,7 @@
 import { getMetadataStorage } from '../MetadataStorage';
 import { plural } from 'pluralize';
 
-export default function Collection(entityName?: string): Function {
+export function Collection(entityName?: string): Function {
   return function(entity: Function) {
     getMetadataStorage().setCollection({
       name: entityName || plural(entity.name),

src/Decorators/CustomRepository.spec.ts

@@ -1,14 +1,14 @@
-import CustomRepository from './CustomRepository';
 import { expect } from 'chai';
-import { MetadataStorage, Initialize } from '../MetadataStorage';
-import { BaseFirestoreRepository } from '..';
+import { CustomRepository } from './CustomRepository';
+import { Initialize, getStore, clearMetadataStorage } from '../MetadataStorage';
+import { BaseFirestoreRepository } from '../BaseFirestoreRepository';
 
 describe('CustomRepositoryDecorator', () => {
-  const store = { metadataStorage: new MetadataStorage() };
+  const store = getStore();
 
   beforeEach(() => {
-    store.metadataStorage = new MetadataStorage();
-    Initialize(null, store);
+    clearMetadataStorage();
+    Initialize(null);
   });
 
   it('should register custom repositories', () => {

src/Decorators/CustomRepository.ts

@@ -1,9 +1,7 @@
 import { getMetadataStorage } from '../MetadataStorage';
 import { InstanstiableIEntity } from '../types';
 
-export default function CustomRepository(
-  entity: InstanstiableIEntity
-): Function {
+export function CustomRepository(entity: InstanstiableIEntity): Function {
   return function(target: Function) {
     getMetadataStorage().setRepository({ entity, target });
   };

src/Decorators/SubCollection.spec.ts

@@ -1,24 +1,24 @@
-import SubCollection from './SubCollection';
+import { SubCollection } from './SubCollection';
 import { expect } from 'chai';
-import { MetadataStorage, Initialize } from '../MetadataStorage';
+import { Initialize, clearMetadataStorage, getStore } from '../MetadataStorage';
 
 describe('SubCollectionDecorator', () => {
-  const store = { metadataStorage: new MetadataStorage() };
+  const store = getStore();
 
   beforeEach(() => {
-    store.metadataStorage = new MetadataStorage();
-    Initialize(null, store);
+    clearMetadataStorage();
+    Initialize(null);
   });
 
   it('should register collections', () => {
     class SubEntity {}
     class Entity {
-      @SubCollection(SubEntity, 'subentities')
+      @SubCollection(SubEntity, 'subs')
       readonly subentity: null;
     }
 
     expect(store.metadataStorage.subCollections.length).to.eql(1);
-    expect(store.metadataStorage.subCollections[0].name).to.eql('subentities');
+    expect(store.metadataStorage.subCollections[0].name).to.eql('subs');
     expect(store.metadataStorage.subCollections[0].parentEntity).to.eql(Entity);
     expect(store.metadataStorage.subCollections[0].entity).to.eql(SubEntity);
     expect(store.metadataStorage.subCollections[0].propertyKey).to.eql(

src/Decorators/SubCollection.ts

@@ -1,10 +1,7 @@
 import { getMetadataStorage } from '../MetadataStorage';
 import { plural } from 'pluralize';
 
-export default function SubCollection(
-  entity: Function,
-  entityName?: string
-): Function {
+export function SubCollection(entity: Function, entityName?: string): Function {
   return function(target: Function, propertyKey: string) {
     getMetadataStorage().setSubCollection({
       entity,

src/Decorators/index.ts

@@ -0,0 +1,3 @@
+export * from './Collection';
+export * from './CustomRepository';
+export * from './SubCollection';