-
Notifications
You must be signed in to change notification settings - Fork 37
/
ObservableCollection.ts
317 lines (286 loc) · 11.6 KB
/
ObservableCollection.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
import {Observable, Subscriber} from 'rxjs';
import {ObservableCursor} from './ObservableCursor';
import {removeObserver} from './utils';
import Selector = Mongo.Selector;
import ObjectID = Mongo.ObjectID;
import SortSpecifier = Mongo.SortSpecifier;
import FieldSpecifier = Mongo.FieldSpecifier;
import Modifier = Mongo.Modifier;
export module MongoObservable {
'use strict';
export interface ConstructorOptions {
connection?: Object;
idGeneration?: string;
transform?: Function;
}
export interface AllowDenyOptionsObject<T> {
insert?: (userId: string, doc: T) => boolean;
update?: (userId: string, doc: T, fieldNames: string[], modifier: any) => boolean;
remove?: (userId: string, doc: T) => boolean;
fetch ?: string[];
transform ? : Function;
}
/**
* Creates a new MongoObservable.Collection from an existing of predefined Mongo.Collection.
* Use this feature to wrap existing collections such as Meteor.users.
* @param {Mongo.Collection} collection - The collection.
* @returns {MongoObservable.Collection} - Wrapped collection.
* @static
*/
export function fromExisting<T>(collection: Mongo.Collection<T>): MongoObservable.Collection<T> {
return new MongoObservable.Collection(collection);
}
/**
* A class represents a MongoDB collection in the client side, wrapped with RxJS
* Observables, so you can use it with your Angular 2 easier.
* The wrapper has the same API as Mongo.Collection, only the "find" method returns
* an ObservableCursor instead of regular Mongo.Cursor.
*
* T is a generic type - should be used with the type of the objects inside the collection.
*/
export class Collection<T> {
private _collection: Mongo.Collection<T>;
/**
* Creates a new Mongo.Collection instance wrapped with Observable features.
* @param {String | Mongo.Collection} nameOrExisting - The name of the collection. If null, creates an
* unmanaged (unsynchronized) local collection. If provided an instance of existing collection, will
* create a wrapper for the existing Mongo.Collection.
* @param {ConstructorOptions} options - Creation options.
* @constructor
*/
constructor(nameOrExisting: string | Mongo.Collection<T>,
options?: ConstructorOptions) {
if (nameOrExisting instanceof Mongo.Collection) {
this._collection = nameOrExisting;
} else {
this._collection = new Mongo.Collection<T>(<string>nameOrExisting, options);
}
}
/**
* Returns the Mongo.Collection object that wrapped with the MongoObservable.Collection.
* @returns {Mongo.Collection<T>} The Collection instance
*/
get collection(): Mongo.Collection<T> {
return this._collection;
}
/**
* Allow users to write directly to this collection from client code, subject to limitations you define.
*
* @returns {Boolean}
*/
allow(options: AllowDenyOptionsObject<T>): boolean {
return this._collection.allow(options);
}
/**
* Override allow rules.
*
* @returns {Boolean}
*/
deny(options: AllowDenyOptionsObject<T>): boolean {
return this._collection.deny(options);
}
/**
* Returns the Collection object corresponding to this collection from the npm
* mongodb driver module which is wrapped by Mongo.Collection.
*
* @returns {Mongo.Collection} The Collection instance
*
* @see {@link https://docs.meteor.com/api/collections.html#Mongo-Collection-rawCollection|rawCollection on Meteor documentation}
*/
rawCollection(): any {
return this._collection.rawCollection();
}
/**
* Returns the Db object corresponding to this collection's database connection from the
* npm mongodb driver module which is wrapped by Mongo.Collection.
*
* @returns {Mongo.Db} The Db instance
*
* @see {@link https://docs.meteor.com/api/collections.html#Mongo-Collection-rawDatabase|rawDatabase on Meteor documentation}
*/
rawDatabase(): any {
return this._collection.rawDatabase();
}
/**
* Insert a document in the collection.
*
* @param {T} doc - The document to insert. May not yet have an _id
* attribute, in which case Meteor will generate one for you.
* @returns {Observable<string>} Observable which completes with the inserted ObjectId
*
* @see {@link https://docs.meteor.com/api/collections.html#Mongo-Collection-insert|insert on Meteor documentation}
*/
insert(doc: T): Observable<string> {
let observers: Subscriber<string>[] = [];
let obs = this._createObservable<string>(observers);
this._collection.insert(doc,
(error: Meteor.Error, docId: string) => {
observers.forEach(observer => {
error ? observer.error(error) :
observer.next(docId);
observer.complete();
});
});
return obs;
}
/**
* Remove documents from the collection.
*
* @param {Collection~MongoQuerySelector} selector - Specifies which documents to modify
* @returns {Observable<Number>} Observable which completes with the number of affected rows
*
* @see {@link https://docs.meteor.com/api/collections.html#Mongo-Collection-remove|remove on Meteor documentation}
*/
remove(selector: Selector | ObjectID | string): Observable<number> {
let observers: Subscriber<number>[] = [];
let obs = this._createObservable<number>(observers);
this._collection.remove(selector,
(error: Meteor.Error, removed: number) => {
observers.forEach(observer => {
error ? observer.error(error) :
observer.next(removed);
observer.complete();
});
});
return obs;
}
/**
* Modify one or more documents in the collection.
*
* @param {Collection~MongoQuerySelector} selector - Specifies which documents to modify
* @param {Modifier} modifier - Specifies how to modify the documents
* @param {MongoUpdateOptions} options - Update options
* first argument and, if no error, the number of affected documents as the second
* @returns {Observable<Number>} Observable which completes with the number of affected rows
*
* @see {@link https://docs.meteor.com/api/collections.html#Mongo-Collection-update|update on Meteor documentation}
*/
update(
selector: Selector | ObjectID | string,
modifier: Modifier,
options?: { multi?: boolean; upsert?: boolean; }): Observable<number> {
let observers: Subscriber<number>[] = [];
let obs = this._createObservable<number>(observers);
this._collection.update(selector, modifier, options,
(error: Meteor.Error, updated: number) => {
observers.forEach(observer => {
error ? observer.error(error) :
observer.next(updated);
observer.complete();
});
});
return obs;
}
/**
* Finds the first document that matches the selector, as ordered by sort and skip options.
*
* @param {Collection~MongoQuerySelector} selector - Specifies which documents to modify
* @param {Modifier} modifier - Specifies how to modify the documents
* @param {MongoUpsertOptions} options - Upsert options
* first argument and, if no error, the number of affected documents as the second.
* @returns {Observable<{numberAffected, insertedId}>} Observable which completes with an
* Object that contain the keys numberAffected and insertedId.
*
* @see {@link https://docs.meteor.com/api/collections.html#Mongo-Collection-upsert|upsert on Meteor documentation}
*/
upsert(
selector: Selector | ObjectID | string,
modifier: Modifier,
options?: { multi?: boolean; }): Observable<number> {
let observers: Subscriber<number>[] = [];
let obs = this._createObservable<number>(observers);
this._collection.upsert(selector, modifier, options,
(error: Meteor.Error, affected: number) => {
observers.forEach(observer => {
error ? observer.error(error) :
observer.next(affected);
observer.complete();
});
});
return obs;
}
/**
* Method has the same notation as Mongo.Collection.find, only returns Observable.
*
* @param {Collection~MongoQuerySelector} selector - A query describing the documents to find
* @param {Collection~MongoQueryOptions} options - Query options, such as sort, limit, etc.
* @returns {ObservableCursor<T>} RxJS Observable wrapped with Meteor features.
* @example <caption>Using Angular2 Component</caption>
* const MyCollection = MongoObservable.Collection("myCollection");
*
* class MyComponent {
* private myData: ObservableCursor<any>;
*
* constructor() {
* this.myData = MyCollection.find({}, {limit: 10});
* }
* }
*
* @see {@link https://docs.meteor.com/api/collections.html#Mongo-Collection-find|find on Meteor documentation}
*/
find(selector?: Selector | ObjectID | string, options?: {
sort?: SortSpecifier;
skip?: number;
limit?: number;
fields?: FieldSpecifier;
reactive?: boolean;
transform?: Function;
}): ObservableCursor<T> {
const cursor = this._collection.find.apply(
this._collection, arguments);
return ObservableCursor.create<T>(cursor);
}
/**
* Finds the first document that matches the selector, as ordered by sort and skip options.
*
* @param {Collection~MongoQuerySelector} selector - A query describing the documents to find
* @param {Collection~MongoQueryOptions} options - Query options, such as sort, limit, etc.
* @returns {any} The first object, or `undefined` in case of non-existing object.
*
* @see {@link https://docs.meteor.com/api/collections.html#Mongo-Collection-findOne|findOne on Meteor documentation}
*/
findOne(selector?: Selector | ObjectID | string, options?: {
sort?: SortSpecifier;
skip?: number;
fields?: FieldSpecifier;
reactive?: boolean;
transform?: Function;
}): T {
return this._collection.findOne.apply(
this._collection, arguments);
}
private _createObservable<T>(observers: Subscriber<T>[]) {
return Observable.create((observer: Subscriber<T>) => {
observers.push(observer);
return () => {
removeObserver(observers, observer);
};
});
}
}
}
/**
* An options object for MongoDB queries.
* @typedef {Object} Collection~MongoQueryOptions
* @property {Object} sort - Sort order (default: natural order)
* @property {Number} skip - Number of results to skip at the beginning
* @property {Object} fields - Dictionary of fields to return or exclude.
* @property {Boolean} reactive - (Client only) Default true; pass false to disable reactivity
* @property {Function} transform - Overrides transform on the Collection for this cursor. Pass null to disable transformation.
*/
/**
* A MongoDB query selector representation.
* @typedef {(Mongo.Selector|Mongo.ObjectID|string)} Collection~MongoQuerySelector
*/
/**
* A MongoDB query options for upsert action
* @typedef {Object} Collection~MongoUpsertOptions
* @property {Boolean} multi - True to modify all matching documents;
* false to only modify one of the matching documents (the default).
*/
/**
* A MongoDB query options for update action
* @typedef {Object} Collection~MongoUpdateOptions
* @property {Boolean} multi - True to modify all matching documents;
* @property {Boolean} upsert - True to use upsert logic.
*/