@hyper-fetch/firebase 8.2.0 → 8.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. package/README.md +5 -2
  2. package/__tests__/features/firestore/shared/constraints.shared.tests.ts +1 -1
  3. package/__tests__/features/firestore/shared/methods/add-doc.test.suite.ts +1 -1
  4. package/__tests__/features/firestore/shared/methods/delete-doc.test.suite.ts +2 -2
  5. package/__tests__/features/firestore/shared/methods/get-doc.test.suite.ts +2 -2
  6. package/__tests__/features/firestore/shared/methods/get-docs.test.suite.ts +2 -2
  7. package/__tests__/features/firestore/shared/methods/on-snapshot.test.suite.ts +2 -2
  8. package/__tests__/features/firestore/shared/methods/set-doc.test.suite.ts +2 -2
  9. package/__tests__/features/firestore/shared/methods/update-doc.test.suite.ts +2 -2
  10. package/__tests__/features/firestore/shared/methods.shared.tests.ts +2 -1
  11. package/__tests__/features/firestore/web/constraints.web.spec.ts +2 -2
  12. package/__tests__/features/firestore/web/methods.web.spec.ts +3 -2
  13. package/__tests__/features/firestore/web/sockets.base.spec.ts +1 -0
  14. package/__tests__/features/realtime/browser/constraints.web.spec.ts +1 -1
  15. package/__tests__/features/realtime/browser/methods.web.spec.ts +1 -1
  16. package/__tests__/features/realtime/browser/sockets.base.spec.ts +2 -1
  17. package/__tests__/features/realtime/shared/constraints.shared.tests.ts +2 -2
  18. package/__tests__/features/realtime/shared/methods/get.test.suite.ts +1 -1
  19. package/__tests__/features/realtime/shared/methods/on-value.test.suite.ts +2 -2
  20. package/__tests__/features/realtime/shared/methods/push.test.suite.ts +1 -1
  21. package/__tests__/features/realtime/shared/methods/remove.test.suite.ts +1 -1
  22. package/__tests__/features/realtime/shared/methods/set.test.suite.ts +1 -1
  23. package/__tests__/features/realtime/shared/methods/update.test.suite.ts +1 -1
  24. package/__tests__/features/realtime/shared/methods.shared.tests.ts +4 -3
  25. package/__tests__/tsconfig.json +4 -14
  26. package/__tests__/vitest.setup.ts +1 -1
  27. package/dist/adapter/adapter.d.ts.map +1 -1
  28. package/dist/adapter/adapter.sockets.d.ts.map +1 -1
  29. package/dist/adapter/types/adapter.base.types.d.ts +2 -2
  30. package/dist/adapter/types/adapter.base.types.d.ts.map +1 -1
  31. package/dist/adapter/types/adapter.firestore.types.d.ts +2 -2
  32. package/dist/adapter/types/adapter.firestore.types.d.ts.map +1 -1
  33. package/dist/adapter/types/adapter.realtime.types.d.ts +1 -1
  34. package/dist/adapter/types/adapter.realtime.types.d.ts.map +1 -1
  35. package/dist/firestore/firestore.methods.d.ts +1 -1
  36. package/dist/firestore/firestore.methods.d.ts.map +1 -1
  37. package/dist/firestore/firestore.sockets.d.ts +1 -1
  38. package/dist/firestore/firestore.sockets.d.ts.map +1 -1
  39. package/dist/firestore/utils/constraints.utils.d.ts.map +1 -1
  40. package/dist/index.mjs +248 -248
  41. package/dist/index.mjs.map +1 -1
  42. package/dist/realtime/realtime.methods.d.ts +1 -1
  43. package/dist/realtime/realtime.methods.d.ts.map +1 -1
  44. package/dist/realtime/realtime.sockets.d.ts +1 -1
  45. package/dist/realtime/realtime.sockets.d.ts.map +1 -1
  46. package/dist/realtime/utils/constraints.utils.d.ts.map +1 -1
  47. package/package.json +7 -7
  48. package/src/adapter/adapter.sockets.ts +2 -3
  49. package/src/adapter/adapter.ts +2 -3
  50. package/src/adapter/types/adapter.base.types.ts +2 -3
  51. package/src/adapter/types/adapter.firestore.types.ts +8 -9
  52. package/src/adapter/types/adapter.realtime.types.ts +1 -2
  53. package/src/firestore/firestore.methods.ts +4 -4
  54. package/src/firestore/firestore.sockets.ts +5 -5
  55. package/src/firestore/utils/constraints.utils.ts +1 -2
  56. package/src/realtime/realtime.methods.ts +6 -6
  57. package/src/realtime/realtime.sockets.ts +3 -3
  58. package/src/realtime/utils/constraints.utils.ts +2 -3
  59. package/tsconfig.json +12 -1
  60. package/vite.config.ts +14 -20
  61. package/.eslintrc.cjs +0 -12
package/dist/index.mjs CHANGED
@@ -1,7 +1,7 @@
1
1
  import { Adapter } from "@hyper-fetch/core";
2
2
  import { Database, endAt, endBefore, equalTo, get, goOffline, goOnline, limitToFirst, limitToLast, onValue, orderByChild, orderByKey, orderByValue, push, query, ref, remove, set, startAfter, startAt, update } from "firebase/database";
3
- import { SocketAdapter } from "@hyper-fetch/sockets";
4
3
  import { Firestore, addDoc, collection, deleteDoc, disableNetwork, doc, enableNetwork, endAt as endAt$1, endBefore as endBefore$1, getDoc, getDocs, limit, onSnapshot, orderBy, query as query$1, setDoc, startAfter as startAfter$1, startAt as startAt$1, updateDoc, where } from "firebase/firestore";
4
+ import { SocketAdapter } from "@hyper-fetch/sockets";
5
5
  //#region src/adapter/types/adapter.firestore.types.ts
6
6
  var FirestoreMethods = /* @__PURE__ */ function(FirestoreMethods) {
7
7
  FirestoreMethods["addDoc"] = "addDoc";
@@ -23,16 +23,31 @@ var RealtimeDBMethods = /* @__PURE__ */ function(RealtimeDBMethods) {
23
23
  return RealtimeDBMethods;
24
24
  }({});
25
25
  //#endregion
26
- //#region src/realtime/utils/result.utils.ts
27
- var getOrderedResultRealtime = (snapshot) => {
28
- const res = [];
29
- snapshot.forEach((child) => {
30
- res.push({
31
- ...child.val(),
32
- __key: child.key
26
+ //#region src/firestore/utils/result.utils.ts
27
+ var getOrderedResultFirestore = (snapshot) => {
28
+ const result = [];
29
+ snapshot.docs.forEach((d) => {
30
+ result.push({
31
+ ...d.data(),
32
+ __key: d.id
33
33
  });
34
34
  });
35
- return res.length > 0 ? res : null;
35
+ return result;
36
+ };
37
+ var getGroupedResultFirestore = (snapshot) => {
38
+ const groupedResult = {
39
+ added: [],
40
+ modified: [],
41
+ removed: []
42
+ };
43
+ snapshot.docChanges().forEach((change) => {
44
+ groupedResult[change.type].push(change.doc.data());
45
+ });
46
+ return [
47
+ ...groupedResult.added,
48
+ ...groupedResult.modified,
49
+ ...groupedResult.removed
50
+ ].length > 0 ? groupedResult : null;
36
51
  };
37
52
  //#endregion
38
53
  //#region src/constraints/firebase.constraints.ts
@@ -144,245 +159,6 @@ var $equalTo = (value) => {
144
159
  };
145
160
  };
146
161
  //#endregion
147
- //#region src/realtime/utils/constraints.utils.ts
148
- var mapRealtimeConstraint = ({ type, values }) => {
149
- switch (type) {
150
- case RealtimeQueryConstraints.ORDER_BY_CHILD: {
151
- const [value] = values;
152
- return orderByChild(value);
153
- }
154
- case RealtimeQueryConstraints.ORDER_BY_KEY: return orderByKey();
155
- case RealtimeQueryConstraints.ORDER_BY_VALUE: return orderByValue();
156
- case SharedQueryConstraints.START_AT: {
157
- const [[value]] = values;
158
- return startAt(value);
159
- }
160
- case SharedQueryConstraints.START_AFTER: {
161
- const [[value]] = values;
162
- return startAfter(value);
163
- }
164
- case SharedQueryConstraints.END_AT: {
165
- const [[value]] = values;
166
- return endAt(value);
167
- }
168
- case SharedQueryConstraints.END_BEFORE: {
169
- const [[value]] = values;
170
- return endBefore(value);
171
- }
172
- case RealtimeQueryConstraints.LIMIT_TO_FIRST: {
173
- const [value] = values;
174
- return limitToFirst(value);
175
- }
176
- case RealtimeQueryConstraints.LIMIT_TO_LAST: {
177
- const [value] = values;
178
- return limitToLast(value);
179
- }
180
- case RealtimeQueryConstraints.EQUAL_TO: {
181
- const [value] = values;
182
- return equalTo(value);
183
- }
184
- default: throw new Error(`Unknown method ${type}`);
185
- }
186
- };
187
- //#endregion
188
- //#region src/firestore/firestore.types.ts
189
- var FirestoreDocOrQuery = /* @__PURE__ */ function(FirestoreDocOrQuery) {
190
- FirestoreDocOrQuery["DOC"] = "doc";
191
- FirestoreDocOrQuery["QUERY"] = "query";
192
- return FirestoreDocOrQuery;
193
- }({});
194
- //#endregion
195
- //#region src/utils/misc.ts
196
- var getStatus = (res) => {
197
- return Array.isArray(res) && res.length === 0 || res == null ? "emptyResource" : "success";
198
- };
199
- var isDocOrQuery = (fullUrl) => {
200
- return fullUrl.replace(/^\/|\/$/g, "").split("/").length % 2 === 0 ? FirestoreDocOrQuery.DOC : FirestoreDocOrQuery.QUERY;
201
- };
202
- //#endregion
203
- //#region src/realtime/realtime.sockets.ts
204
- var realtimeSockets = (database) => {
205
- return new SocketAdapter({
206
- name: "firebase-realtime",
207
- defaultConnected: true
208
- }).setConnector(({ socket, onConnect, onReconnect, onDisconnect, onListen, onConnected, onDisconnected, onEvent, onError }) => {
209
- const connect = async () => {
210
- if (onConnect()) {
211
- goOnline(database);
212
- onConnected();
213
- }
214
- };
215
- const disconnect = async () => {
216
- goOffline(database);
217
- onDisconnect();
218
- onDisconnected();
219
- };
220
- const reconnect = () => {
221
- onReconnect({
222
- disconnect,
223
- connect
224
- });
225
- };
226
- const listen = (listener, callback) => {
227
- const fullUrl = socket.url + listener.topic;
228
- const path = ref(database, fullUrl);
229
- const { options } = listener;
230
- const onlyOnce = options?.onlyOnce || false;
231
- const queryConstraints = query(path, ...options?.constraints?.map((constraint) => mapRealtimeConstraint(constraint)) || []);
232
- let unsubscribe = () => {};
233
- let unmount = () => {};
234
- let clearListeners = () => {};
235
- unsubscribe = onValue(queryConstraints, (snapshot) => {
236
- const response = isDocOrQuery(fullUrl) === "doc" ? snapshot.val() : getOrderedResultRealtime(snapshot);
237
- const extra = {
238
- ref: path,
239
- snapshot,
240
- status: getStatus(response)
241
- };
242
- callback({
243
- data: response,
244
- extra
245
- });
246
- onEvent({
247
- topic: listener.topic,
248
- data: response,
249
- extra
250
- });
251
- }, (error) => {
252
- onError({ error });
253
- }, { onlyOnce });
254
- unmount = onListen({
255
- listener,
256
- callback,
257
- onUnmount: unsubscribe
258
- });
259
- clearListeners = () => {
260
- unsubscribe();
261
- unmount();
262
- };
263
- return clearListeners;
264
- };
265
- const emit = async () => {
266
- throw new Error("Cannot emit from Realtime database socket.");
267
- };
268
- return {
269
- connect,
270
- reconnect,
271
- disconnect,
272
- listen,
273
- emit
274
- };
275
- });
276
- };
277
- //#endregion
278
- //#region src/realtime/realtime.methods.ts
279
- var getRealtimeDbBrowserMethods = ({ database, url, onSuccess, onError, onResponseStart, onRequestStart, onRequestEnd, onResponseEnd }) => {
280
- const [fullUrl] = url.split("?");
281
- const path = ref(database, fullUrl);
282
- const methods = {
283
- get: async ({ constraints = [] }) => {
284
- const snapshot = await get(query(path, ...constraints.map((constraint) => mapRealtimeConstraint(constraint))));
285
- const res = isDocOrQuery(fullUrl) === "doc" ? snapshot.val() : getOrderedResultRealtime(snapshot);
286
- return {
287
- result: res,
288
- status: getStatus(res),
289
- extra: {
290
- ref: path,
291
- snapshot
292
- }
293
- };
294
- },
295
- set: async ({ data }) => {
296
- await set(path, data);
297
- return {
298
- result: data,
299
- status: "success",
300
- extra: { ref: path }
301
- };
302
- },
303
- push: async ({ data }) => {
304
- const resRef = await push(path, data);
305
- return {
306
- result: {
307
- ...data,
308
- __key: resRef.key
309
- },
310
- status: "success",
311
- extra: {
312
- ref: resRef,
313
- key: resRef.key
314
- }
315
- };
316
- },
317
- update: async ({ data }) => {
318
- await update(path, data);
319
- return {
320
- result: data,
321
- status: "success",
322
- extra: { ref: path }
323
- };
324
- },
325
- remove: async () => {
326
- await remove(path);
327
- return {
328
- result: null,
329
- status: "success",
330
- extra: { ref: path }
331
- };
332
- }
333
- };
334
- return async (methodName, data) => {
335
- try {
336
- onRequestStart();
337
- const { result, status, extra } = await methods[methodName](data);
338
- onRequestEnd();
339
- onResponseStart();
340
- onSuccess({
341
- data: result,
342
- status,
343
- extra
344
- });
345
- onResponseEnd();
346
- } catch (error) {
347
- onRequestEnd();
348
- onResponseStart();
349
- onError({
350
- error,
351
- status: "error",
352
- extra: {}
353
- });
354
- onResponseEnd();
355
- }
356
- };
357
- };
358
- //#endregion
359
- //#region src/firestore/utils/result.utils.ts
360
- var getOrderedResultFirestore = (snapshot) => {
361
- const result = [];
362
- snapshot.docs.forEach((d) => {
363
- result.push({
364
- ...d.data(),
365
- __key: d.id
366
- });
367
- });
368
- return result;
369
- };
370
- var getGroupedResultFirestore = (snapshot) => {
371
- const groupedResult = {
372
- added: [],
373
- modified: [],
374
- removed: []
375
- };
376
- snapshot.docChanges().forEach((change) => {
377
- groupedResult[change.type].push(change.doc.data());
378
- });
379
- return [
380
- ...groupedResult.added,
381
- ...groupedResult.modified,
382
- ...groupedResult.removed
383
- ].length > 0 ? groupedResult : null;
384
- };
385
- //#endregion
386
162
  //#region src/firestore/utils/constraints.utils.ts
387
163
  var mapConstraint = ({ type, values }) => {
388
164
  switch (type) {
@@ -418,6 +194,21 @@ var mapConstraint = ({ type, values }) => {
418
194
  }
419
195
  };
420
196
  //#endregion
197
+ //#region src/firestore/firestore.types.ts
198
+ var FirestoreDocOrQuery = /* @__PURE__ */ function(FirestoreDocOrQuery) {
199
+ FirestoreDocOrQuery["DOC"] = "doc";
200
+ FirestoreDocOrQuery["QUERY"] = "query";
201
+ return FirestoreDocOrQuery;
202
+ }({});
203
+ //#endregion
204
+ //#region src/utils/misc.ts
205
+ var getStatus = (res) => {
206
+ return Array.isArray(res) && res.length === 0 || res == null ? "emptyResource" : "success";
207
+ };
208
+ var isDocOrQuery = (fullUrl) => {
209
+ return fullUrl.replace(/^\/|\/$/g, "").split("/").length % 2 === 0 ? FirestoreDocOrQuery.DOC : FirestoreDocOrQuery.QUERY;
210
+ };
211
+ //#endregion
421
212
  //#region src/firestore/firestore.methods.ts
422
213
  var getFirestoreBrowserMethods = ({ database, url, onSuccess, onError, onResponseStart, onRequestStart, onRequestEnd, onResponseEnd }) => {
423
214
  const [cleanUrl] = url.split("?");
@@ -602,6 +393,215 @@ var firestoreSockets = (database) => {
602
393
  });
603
394
  };
604
395
  //#endregion
396
+ //#region src/realtime/utils/result.utils.ts
397
+ var getOrderedResultRealtime = (snapshot) => {
398
+ const res = [];
399
+ snapshot.forEach((child) => {
400
+ res.push({
401
+ ...child.val(),
402
+ __key: child.key
403
+ });
404
+ });
405
+ return res.length > 0 ? res : null;
406
+ };
407
+ //#endregion
408
+ //#region src/realtime/utils/constraints.utils.ts
409
+ var mapRealtimeConstraint = ({ type, values }) => {
410
+ switch (type) {
411
+ case RealtimeQueryConstraints.ORDER_BY_CHILD: {
412
+ const [value] = values;
413
+ return orderByChild(value);
414
+ }
415
+ case RealtimeQueryConstraints.ORDER_BY_KEY: return orderByKey();
416
+ case RealtimeQueryConstraints.ORDER_BY_VALUE: return orderByValue();
417
+ case SharedQueryConstraints.START_AT: {
418
+ const [[value]] = values;
419
+ return startAt(value);
420
+ }
421
+ case SharedQueryConstraints.START_AFTER: {
422
+ const [[value]] = values;
423
+ return startAfter(value);
424
+ }
425
+ case SharedQueryConstraints.END_AT: {
426
+ const [[value]] = values;
427
+ return endAt(value);
428
+ }
429
+ case SharedQueryConstraints.END_BEFORE: {
430
+ const [[value]] = values;
431
+ return endBefore(value);
432
+ }
433
+ case RealtimeQueryConstraints.LIMIT_TO_FIRST: {
434
+ const [value] = values;
435
+ return limitToFirst(value);
436
+ }
437
+ case RealtimeQueryConstraints.LIMIT_TO_LAST: {
438
+ const [value] = values;
439
+ return limitToLast(value);
440
+ }
441
+ case RealtimeQueryConstraints.EQUAL_TO: {
442
+ const [value] = values;
443
+ return equalTo(value);
444
+ }
445
+ default: throw new Error(`Unknown method ${type}`);
446
+ }
447
+ };
448
+ //#endregion
449
+ //#region src/realtime/realtime.sockets.ts
450
+ var realtimeSockets = (database) => {
451
+ return new SocketAdapter({
452
+ name: "firebase-realtime",
453
+ defaultConnected: true
454
+ }).setConnector(({ socket, onConnect, onReconnect, onDisconnect, onListen, onConnected, onDisconnected, onEvent, onError }) => {
455
+ const connect = async () => {
456
+ if (onConnect()) {
457
+ goOnline(database);
458
+ onConnected();
459
+ }
460
+ };
461
+ const disconnect = async () => {
462
+ goOffline(database);
463
+ onDisconnect();
464
+ onDisconnected();
465
+ };
466
+ const reconnect = () => {
467
+ onReconnect({
468
+ disconnect,
469
+ connect
470
+ });
471
+ };
472
+ const listen = (listener, callback) => {
473
+ const fullUrl = socket.url + listener.topic;
474
+ const path = ref(database, fullUrl);
475
+ const { options } = listener;
476
+ const onlyOnce = options?.onlyOnce || false;
477
+ const queryConstraints = query(path, ...options?.constraints?.map((constraint) => mapRealtimeConstraint(constraint)) || []);
478
+ let unsubscribe = () => {};
479
+ let unmount = () => {};
480
+ let clearListeners = () => {};
481
+ unsubscribe = onValue(queryConstraints, (snapshot) => {
482
+ const response = isDocOrQuery(fullUrl) === "doc" ? snapshot.val() : getOrderedResultRealtime(snapshot);
483
+ const extra = {
484
+ ref: path,
485
+ snapshot,
486
+ status: getStatus(response)
487
+ };
488
+ callback({
489
+ data: response,
490
+ extra
491
+ });
492
+ onEvent({
493
+ topic: listener.topic,
494
+ data: response,
495
+ extra
496
+ });
497
+ }, (error) => {
498
+ onError({ error });
499
+ }, { onlyOnce });
500
+ unmount = onListen({
501
+ listener,
502
+ callback,
503
+ onUnmount: unsubscribe
504
+ });
505
+ clearListeners = () => {
506
+ unsubscribe();
507
+ unmount();
508
+ };
509
+ return clearListeners;
510
+ };
511
+ const emit = async () => {
512
+ throw new Error("Cannot emit from Realtime database socket.");
513
+ };
514
+ return {
515
+ connect,
516
+ reconnect,
517
+ disconnect,
518
+ listen,
519
+ emit
520
+ };
521
+ });
522
+ };
523
+ //#endregion
524
+ //#region src/realtime/realtime.methods.ts
525
+ var getRealtimeDbBrowserMethods = ({ database, url, onSuccess, onError, onResponseStart, onRequestStart, onRequestEnd, onResponseEnd }) => {
526
+ const [fullUrl] = url.split("?");
527
+ const path = ref(database, fullUrl);
528
+ const methods = {
529
+ get: async ({ constraints = [] }) => {
530
+ const snapshot = await get(query(path, ...constraints.map((constraint) => mapRealtimeConstraint(constraint))));
531
+ const res = isDocOrQuery(fullUrl) === "doc" ? snapshot.val() : getOrderedResultRealtime(snapshot);
532
+ return {
533
+ result: res,
534
+ status: getStatus(res),
535
+ extra: {
536
+ ref: path,
537
+ snapshot
538
+ }
539
+ };
540
+ },
541
+ set: async ({ data }) => {
542
+ await set(path, data);
543
+ return {
544
+ result: data,
545
+ status: "success",
546
+ extra: { ref: path }
547
+ };
548
+ },
549
+ push: async ({ data }) => {
550
+ const resRef = await push(path, data);
551
+ return {
552
+ result: {
553
+ ...data,
554
+ __key: resRef.key
555
+ },
556
+ status: "success",
557
+ extra: {
558
+ ref: resRef,
559
+ key: resRef.key
560
+ }
561
+ };
562
+ },
563
+ update: async ({ data }) => {
564
+ await update(path, data);
565
+ return {
566
+ result: data,
567
+ status: "success",
568
+ extra: { ref: path }
569
+ };
570
+ },
571
+ remove: async () => {
572
+ await remove(path);
573
+ return {
574
+ result: null,
575
+ status: "success",
576
+ extra: { ref: path }
577
+ };
578
+ }
579
+ };
580
+ return async (methodName, data) => {
581
+ try {
582
+ onRequestStart();
583
+ const { result, status, extra } = await methods[methodName](data);
584
+ onRequestEnd();
585
+ onResponseStart();
586
+ onSuccess({
587
+ data: result,
588
+ status,
589
+ extra
590
+ });
591
+ onResponseEnd();
592
+ } catch (error) {
593
+ onRequestEnd();
594
+ onResponseStart();
595
+ onError({
596
+ error,
597
+ status: "error",
598
+ extra: {}
599
+ });
600
+ onResponseEnd();
601
+ }
602
+ };
603
+ };
604
+ //#endregion
605
605
  //#region src/adapter/adapter.ts
606
606
  var FirebaseAdapter = (database) => {
607
607
  return new Adapter({