Skip to content

Commit

Permalink
lint
Browse files Browse the repository at this point in the history
  • Loading branch information
Brian Chen committed Dec 19, 2019
1 parent e1082ce commit 4eacbce
Show file tree
Hide file tree
Showing 7 changed files with 108 additions and 53 deletions.
9 changes: 5 additions & 4 deletions dev/src/document-change.ts
Expand Up @@ -14,10 +14,10 @@
* limitations under the License.
*/

import { FirestoreDataConverter } from '@google-cloud/firestore';
import {FirestoreDataConverter} from '@google-cloud/firestore';
import {QueryDocumentSnapshot} from './document';
import { DocumentData } from './types';
import { defaultConverter } from './watch';
import {DocumentData} from './types';
import {defaultConverter} from './watch';

export type DocumentChangeType = 'added' | 'removed' | 'modified';

Expand Down Expand Up @@ -55,7 +55,8 @@ export class DocumentChange<T = DocumentData> {
this._document = document;
this._oldIndex = oldIndex;
this._newIndex = newIndex;
this._converter = converter || defaultConverter as FirestoreDataConverter<T>;
this._converter =
converter || (defaultConverter as FirestoreDataConverter<T>);
}

/**
Expand Down
29 changes: 20 additions & 9 deletions dev/src/document.ts
Expand Up @@ -28,8 +28,8 @@ import {ApiMapValue, DocumentData, UpdateMap} from './types';
import {isEmpty, isObject} from './util';

import api = google.firestore.v1;
import { FirestoreDataConverter } from '@google-cloud/firestore';
import { defaultConverter } from './watch';
import {FirestoreDataConverter} from '@google-cloud/firestore';
import {defaultConverter} from './watch';

/**
* Returns a builder for DocumentSnapshot and QueryDocumentSnapshot instances.
Expand All @@ -56,7 +56,8 @@ export class DocumentSnapshotBuilder<T = DocumentData> {
private readonly _converter: FirestoreDataConverter<T>;

constructor(converter?: FirestoreDataConverter<T>) {
this._converter = converter || defaultConverter as FirestoreDataConverter<T>;
this._converter =
converter || (defaultConverter as FirestoreDataConverter<T>);
}

/**
Expand Down Expand Up @@ -84,7 +85,14 @@ export class DocumentSnapshotBuilder<T = DocumentData> {
this.updateTime!,
this.ref!._converter
)
: new DocumentSnapshot(this.ref!, undefined, this.readTime!, undefined, undefined, this.ref!._converter);
: new DocumentSnapshot(
this.ref!,
undefined,
this.readTime!,
undefined,
undefined,
this.ref!._converter
);
}
}

Expand All @@ -109,7 +117,7 @@ export class DocumentSnapshot<T = DocumentData> {
private _readTime: Timestamp | undefined;
private _createTime: Timestamp | undefined;
private _updateTime: Timestamp | undefined;
private readonly _converter: FirestoreDataConverter<T>;
private readonly _converter: FirestoreDataConverter<T>;

/**
* @hideconstructor
Expand Down Expand Up @@ -138,8 +146,9 @@ export class DocumentSnapshot<T = DocumentData> {
this._readTime = readTime;
this._createTime = createTime;
this._updateTime = updateTime;
this._converter = converter || defaultConverter as FirestoreDataConverter<T>;
}
this._converter =
converter || (defaultConverter as FirestoreDataConverter<T>);
}

/**
* Creates a DocumentSnapshot from an object.
Expand Down Expand Up @@ -507,7 +516,7 @@ export class DocumentSnapshot<T = DocumentData> {
(other instanceof DocumentSnapshot &&
this._ref.isEqual(other._ref) &&
deepEqual(this._fieldsProto, other._fieldsProto, {strict: true}) &&
this._converter === other._converter)
this._converter === other._converter)
);
}
}
Expand All @@ -527,7 +536,9 @@ export class DocumentSnapshot<T = DocumentData> {
* @class
* @extends DocumentSnapshot
*/
export class QueryDocumentSnapshot<T = DocumentData> extends DocumentSnapshot<T> {
export class QueryDocumentSnapshot<T = DocumentData> extends DocumentSnapshot<
T
> {
/**
* @hideconstructor
*
Expand Down
7 changes: 5 additions & 2 deletions dev/src/index.ts
Expand Up @@ -60,7 +60,7 @@ import {
import {WriteBatch} from './write-batch';

import api = google.firestore.v1;
import { DocumentData } from '@google-cloud/firestore';
import {DocumentData} from '@google-cloud/firestore';

export {
CollectionReference,
Expand Down Expand Up @@ -954,7 +954,10 @@ export class Firestore {
'Received document: %s',
response.found.name!
);
document = self.snapshot_<T>(response.found, response.readTime!);
document = self.snapshot_<T>(
response.found,
response.readTime!
);
} else {
logger(
'Firestore.getAll_',
Expand Down
67 changes: 46 additions & 21 deletions dev/src/reference.ts
Expand Up @@ -59,7 +59,7 @@ import {defaultConverter, DocumentWatch, QueryWatch} from './watch';
import {validateDocumentData, WriteBatch, WriteResult} from './write-batch';

import api = proto.google.firestore.v1;
import { FirestoreDataConverter } from '@google-cloud/firestore';
import {FirestoreDataConverter} from '@google-cloud/firestore';

/**
* The direction of a `Query.orderBy()` clause is specified as 'desc' or 'asc'
Expand Down Expand Up @@ -125,7 +125,7 @@ const comparisonOperators: {
*/
export class DocumentReference<T = DocumentData> implements Serializable {
readonly _converter: FirestoreDataConverter<T>;

/**
* @hideconstructor
*
Expand All @@ -137,7 +137,8 @@ export class DocumentReference<T = DocumentData> implements Serializable {
readonly _path: ResourcePath,
converter?: FirestoreDataConverter<T>
) {
this._converter = converter || defaultConverter as FirestoreDataConverter<T>;
this._converter =
converter || (defaultConverter as FirestoreDataConverter<T>);
}

/**
Expand Down Expand Up @@ -224,7 +225,11 @@ export class DocumentReference<T = DocumentData> implements Serializable {
* }):
*/
get parent(): CollectionReference<T> {
return new CollectionReference(this._firestore, this._path.parent()!, this._converter);
return new CollectionReference(
this._firestore,
this._path.parent()!,
this._converter
);
}

/**
Expand Down Expand Up @@ -439,7 +444,11 @@ export class DocumentReference<T = DocumentData> implements Serializable {

const writeBatch = new WriteBatch(this._firestore);
return writeBatch.update
.apply(writeBatch, [this as DocumentReference<unknown>, dataOrField, ...preconditionOrValues])
.apply(writeBatch, [
this as DocumentReference<unknown>,
dataOrField,
...preconditionOrValues,
])
.commit()
.then(([writeResult]) => writeResult);
}
Expand Down Expand Up @@ -489,7 +498,11 @@ export class DocumentReference<T = DocumentData> implements Serializable {

// The document is missing.
const document = new DocumentSnapshotBuilder<T>();
document.ref = new DocumentReference(this._firestore, this._path, this._converter);
document.ref = new DocumentReference(
this._firestore,
this._path,
this._converter
);
document.readTime = readTime;
onNext(document.build());
}, onError || console.error);
Expand Down Expand Up @@ -530,9 +543,7 @@ export class DocumentReference<T = DocumentData> implements Serializable {
* @param converter Converts objects to and from Firestore.
* @return A DocumentReference<U> that uses the provided converter.
*/
withConverter<U>(
converter: FirestoreDataConverter<U>
): DocumentReference<U> {
withConverter<U>(converter: FirestoreDataConverter<U>): DocumentReference<U> {
return new DocumentReference<U>(this.firestore, this._path, converter);
}
}
Expand Down Expand Up @@ -689,7 +700,8 @@ export class QuerySnapshot<T = DocumentData> {
) {
this._docs = docs;
this._changes = changes;
this._converter = converter || defaultConverter as FirestoreDataConverter<T>;
this._converter =
converter || (defaultConverter as FirestoreDataConverter<T>);
}

/**
Expand Down Expand Up @@ -1042,7 +1054,8 @@ export class Query<T = DocumentData> {
converter?: FirestoreDataConverter<T>
) {
this._serializer = new Serializer(_firestore);
this._converter = converter || defaultConverter as FirestoreDataConverter<T>;
this._converter =
converter || (defaultConverter as FirestoreDataConverter<T>);
}

/**
Expand Down Expand Up @@ -1475,7 +1488,11 @@ export class Query<T = DocumentData> {
);
}

reference = new DocumentReference(this._firestore, basePath.append(val), this._converter);
reference = new DocumentReference(
this._firestore,
basePath.append(val),
this._converter
);
} else if (val instanceof DocumentReference) {
reference = val;
if (!basePath.isPrefixOf(reference._path)) {
Expand Down Expand Up @@ -1707,7 +1724,9 @@ export class Query<T = DocumentData> {
() => {
const changes: Array<DocumentChange<T>> = [];
for (let i = 0; i < docs.length; ++i) {
changes.push(new DocumentChange('added', docs[i], -1, i, this._converter));
changes.push(
new DocumentChange('added', docs[i], -1, i, this._converter)
);
}
return changes;
},
Expand Down Expand Up @@ -1979,9 +1998,7 @@ export class Query<T = DocumentData> {
* @param converter Converts objects to and from Firestore.
* @return A Query<U> that uses the provided converter.
*/
withConverter<U>(
converter: FirestoreDataConverter<U>
): Query<U> {
withConverter<U>(converter: FirestoreDataConverter<U>): Query<U> {
return new Query<U>(this.firestore, this._queryOptions, converter);
}
}
Expand All @@ -1994,14 +2011,18 @@ export class Query<T = DocumentData> {
* @class
* @extends Query
*/
export class CollectionReference<T=DocumentData> extends Query<T> {
export class CollectionReference<T = DocumentData> extends Query<T> {
/**
* @hideconstructor
*
* @param firestore The Firestore Database client.
* @param path The Path of this collection.
*/
constructor(firestore: Firestore, path: ResourcePath, _converter?: FirestoreDataConverter<T>) {
constructor(
firestore: Firestore,
path: ResourcePath,
_converter?: FirestoreDataConverter<T>
) {
super(firestore, QueryOptions.forCollectionQuery(path), _converter);
}

Expand Down Expand Up @@ -2209,7 +2230,11 @@ export class CollectionReference<T=DocumentData> extends Query<T> {
withConverter<U>(
converter: FirestoreDataConverter<U>
): CollectionReference<U> {
return new CollectionReference<U>(this.firestore, this.resourcePath, converter);
return new CollectionReference<U>(
this.firestore,
this.resourcePath,
converter
);
}
}

Expand All @@ -2236,8 +2261,8 @@ export function validateQueryOrder(
export function defaultDataConverter(): FirestoreDataConverter<DocumentData> {
return {
toFirestore: data => data,
fromFirestore: data => data as DocumentData
}
fromFirestore: data => data as DocumentData,
};
}

/**
Expand Down
2 changes: 1 addition & 1 deletion dev/src/types.ts
Expand Up @@ -81,7 +81,7 @@ export interface Settings {
* mapped to values.
*/
export interface DocumentData {
// tslint:disable-next-line:no-any
// tslint:disable-next-line:no-any
[field: string]: any;
}

Expand Down
43 changes: 28 additions & 15 deletions dev/src/watch.ts
Expand Up @@ -29,17 +29,21 @@ import {DocumentData, GrpcError, RBTree} from './types';
import {requestTag} from './util';

import api = google.firestore.v1;
import { FirestoreDataConverter } from '@google-cloud/firestore';
import {FirestoreDataConverter} from '@google-cloud/firestore';

export const defaultConverter = {
toFirestore(modelObject: FirebaseFirestore.DocumentData): FirebaseFirestore.DocumentData {
return modelObject;
},
fromFirestore(data: FirebaseFirestore.DocumentData):FirebaseFirestore.DocumentData {
return data;
}
};

toFirestore(
modelObject: FirebaseFirestore.DocumentData
): FirebaseFirestore.DocumentData {
return modelObject;
},
fromFirestore(
data: FirebaseFirestore.DocumentData
): FirebaseFirestore.DocumentData {
return data;
},
};

/*!
* Target ID used by watch. Watch uses a fixed target id since we only support
* one target per stream.
Expand Down Expand Up @@ -319,7 +323,8 @@ abstract class Watch<T = DocumentData> {
this.requestTag = requestTag();
this.onNext = EMPTY_FUNCTION;
this.onError = EMPTY_FUNCTION;
this._converter = converter || defaultConverter as FirestoreDataConverter<T>;
this._converter =
converter || (defaultConverter as FirestoreDataConverter<T>);
}

/** Returns a 'Target' proto denoting the target to listen on. */
Expand Down Expand Up @@ -754,7 +759,9 @@ abstract class Watch<T = DocumentData> {
* Returns the DocumentChange event for successful modifications.
* @private
*/
private modifyDoc(newDocument: QueryDocumentSnapshot<T>): DocumentChange<T> | null {
private modifyDoc(
newDocument: QueryDocumentSnapshot<T>
): DocumentChange<T> | null {
const name = newDocument.ref.path;
assert(this.docMap.has(name), 'Document to modify does not exist');
const oldDocument = this.docMap.get(name)!;
Expand Down Expand Up @@ -873,8 +880,11 @@ abstract class Watch<T = DocumentData> {
* @private
*/
export class DocumentWatch<T = DocumentData> extends Watch<T> {
constructor(firestore: Firestore, private readonly ref: DocumentReference<T>,
converter?: FirestoreDataConverter<T>) {
constructor(
firestore: Firestore,
private readonly ref: DocumentReference<T>,
converter?: FirestoreDataConverter<T>
) {
super(firestore, converter);
}

Expand Down Expand Up @@ -902,8 +912,11 @@ export class DocumentWatch<T = DocumentData> extends Watch<T> {
export class QueryWatch<T = DocumentData> extends Watch<T> {
private comparator: DocumentComparator<T>;

constructor(firestore: Firestore, private readonly query: Query<T>,
converter?: FirestoreDataConverter<T>) {
constructor(
firestore: Firestore,
private readonly query: Query<T>,
converter?: FirestoreDataConverter<T>
) {
super(firestore, converter);
this.comparator = query.comparator();
}
Expand Down

0 comments on commit 4eacbce

Please sign in to comment.