Skip to content
This repository was archived by the owner on Dec 14, 2022. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 36 additions & 83 deletions package-lock.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
},
"license": "MIT",
"devDependencies": {
"@google-cloud/firestore": "^2.5.0",
"@types/chai": "^4.1.7",
"@types/chai-as-promised": "^7.1.0",
"@types/mocha": "^5.2.7",
Expand Down
2 changes: 1 addition & 1 deletion src/Collection.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { firestore } from 'firebase/app';
import { firestore } from './firestore';
import store, { getRepository } from './store';
import { ICollectionQuery, ICollection, IDocumentRef, WriteTypes } from './types';
import { QueryBuilder, FirestoreSerializer } from './utils';
Expand Down
2 changes: 1 addition & 1 deletion src/DocumentSnapshot.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import Entity from './Entity';
import { IDocumentSnapshot, ICollection } from './types/collection.types';
import { IDocumentRef } from './types';
import { firestore } from 'firebase/app';
import { firestore } from './firestore';
import { FirestoreSerializer } from './utils';

export default class DocumentSnapshot <T extends Entity> implements IDocumentSnapshot<T> {
Expand Down
2 changes: 1 addition & 1 deletion src/Query.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { firestore } from 'firebase/app';
import { firestore } from './firestore';
import { Entity } from '.';
import { IFieldMeta, ICollection, IQuery } from './types';
import QuerySnapshot from './QuerySnapshot';
Expand Down
2 changes: 1 addition & 1 deletion src/QuerySnapshot.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { firestore } from 'firebase/app';
import { firestore } from './firestore';
import Query from './Query';
import Entity from './Entity';
import { IQuerySnapshot, ICollection, DocumentChange } from './types';
Expand Down
2 changes: 1 addition & 1 deletion src/decorators/documentRef.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { firestore } from 'firebase/app';
import { firestore } from '../firestore';
import { IDocumentRefConfig, IDocumentRefMeta, FieldTypes, IDocumentRef, IEntity, ICollection } from '../types';
import FieldUtils from '../utils/FieldUtils';
import { getOrCreateRepository, getRepository } from '../store';
Expand Down
2 changes: 1 addition & 1 deletion src/decorators/geoPoint.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { firestore } from 'firebase/app';
import { firestore } from '../firestore';
import { FieldTypes, IGeoPointConfig, IGeoPoint, GeoPointData } from '../types';
import FieldUtils from '../utils/FieldUtils';
import { getOrCreateRepository } from '../store';
Expand Down
2 changes: 1 addition & 1 deletion src/decorators/timestamp.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { firestore } from 'firebase/app';
import { firestore } from '../firestore';
import { FieldTypes, ITimestampConfig, WriteTypes, ITimestampMeta } from '../types';
import FieldUtils from '../utils/FieldUtils';
import { getOrCreateRepository } from '../store';
Expand Down
2 changes: 1 addition & 1 deletion src/fields/DocumentRef.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { IDocumentRef, ICollection } from '../types';
import { firestore } from 'firebase/app';
import { firestore } from '../firestore';
import { FirestoreSerializer } from '../utils';
import Collection from '../Collection';
import Entity from '../Entity';
Expand Down
2 changes: 1 addition & 1 deletion src/fields/GeoPoint.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { firestore } from 'firebase/app';
import { firestore } from '../firestore';
import { IGeoPoint } from '../types';

/**
Expand Down
2 changes: 1 addition & 1 deletion src/fields/Timestamp.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { firestore } from 'firebase/app';
import { firestore } from '../firestore';
import { ITimestamp } from '../types';

/**
Expand Down
29 changes: 29 additions & 0 deletions src/firestore.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import { firestore as firebaseFirestore } from 'firebase/app';
import * as CloudFirestore from '@google-cloud/firestore';

const Timestamp = firebaseFirestore ? firebaseFirestore.Timestamp : CloudFirestore.Timestamp;
const GeoPoint = firebaseFirestore ? firebaseFirestore.GeoPoint : CloudFirestore.GeoPoint;
const FieldValue = firebaseFirestore ? firebaseFirestore.FieldValue : CloudFirestore.FieldValue;

export namespace firestore {
export type Timestamp = firebaseFirestore.Timestamp | CloudFirestore.Timestamp;
export type GeoPoint = firebaseFirestore.GeoPoint | CloudFirestore.GeoPoint;
export type FieldValue = firebaseFirestore.FieldValue | CloudFirestore.FieldValue;
export type QuerySnapshot = firebaseFirestore.QuerySnapshot;
export type WhereFilterOp = firebaseFirestore.WhereFilterOp;
export type OrderByDirection = firebaseFirestore.OrderByDirection;
export type CollectionReference = firebaseFirestore.CollectionReference;
export type DocumentChangeType = firebaseFirestore.DocumentChangeType;
export type DocumentReference = firebaseFirestore.DocumentReference;
export type DocumentSnapshot = firebaseFirestore.DocumentSnapshot;
export type Query = firebaseFirestore.Query;
export type Firestore = firebaseFirestore.Firestore;
export type SnapshotMetadata = firebaseFirestore.SnapshotMetadata;
export type SnapshotListenOptions = firebaseFirestore.SnapshotListenOptions;
}

export const firestore = {
Timestamp,
GeoPoint,
FieldValue,
};
7 changes: 4 additions & 3 deletions src/store.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import * as firebase from 'firebase/app';
import * as firebase from './firestore';
import * as CloudFirestore from '@google-cloud/firestore';
import {
IFireormConfig,
IFieldMeta,
Expand All @@ -20,8 +21,8 @@ let store: IStore = {
* @param firestore A firestore instance.
* @param config Configuration options for firestorm.
*/
export const initialize = (firestore: firebase.firestore.Firestore, config?: IFireormConfig): void => {
store.firestore = firestore;
export const initialize = (firestore: firebase.firestore.Firestore | CloudFirestore.Firestore, config?: IFireormConfig): void => {
store.firestore = firestore as firebase.firestore.Firestore;
if (config) {
(Object.keys(config) as (keyof IFireormConfig)[]).forEach((key): void => {
store.config[key] = config[key];
Expand Down
2 changes: 1 addition & 1 deletion src/types/collection.types.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { firestore } from 'firebase/app';
import { firestore } from '../firestore';
import { IDocumentRef } from './field.types';
import { Query } from '..';

Expand Down
2 changes: 1 addition & 1 deletion src/types/field.types.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* eslint-disable @typescript-eslint/no-empty-interface */
import { firestore } from 'firebase/app';
import { firestore } from '../firestore';
import { FieldTypes } from './enum.types';
import { ICollection, IEntity, IDocumentSnapshot } from './collection.types';

Expand Down
2 changes: 1 addition & 1 deletion src/types/store.types.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { firestore } from 'firebase/app';
import { firestore } from '../firestore';
import { ICollectionConfig, ISubCollectionConfig, IEntity } from './collection.types';
import { FieldConversionType } from './enum.types';
import { IFieldMeta } from './field.types';
Expand Down
2 changes: 1 addition & 1 deletion src/types/timestamp.types.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { firestore } from 'firebase/app';
import { firestore } from '../firestore';
import { IFieldConfig, IFieldMeta, WriteTypes } from '.';
import { Timestamp } from '../fields';

Expand Down
2 changes: 1 addition & 1 deletion src/utils/FirestoreSerializer.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { firestore } from 'firebase/app';
import { firestore } from '../firestore';
import { FieldTypes, ICollection, WriteTypes } from '../types';
import { getRepository } from '../store';
import Entity from '../Entity';
Expand Down
2 changes: 1 addition & 1 deletion src/utils/QueryBuilder.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { firestore } from 'firebase/app';
import { firestore } from '../firestore';
import { IEntity, ICollectionQuery, ICollection, IFieldMeta } from '../types';

/**
Expand Down