@hyper-fetch/firebase 6.0.1 โ 7.0.0
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.
- package/.eslintrc.json +8 -3
- package/README.md +5 -5
- package/dist/index.d.ts +71 -48
- package/dist/{index.esm.js โ index.js} +240 -229
- package/dist/index.js.map +7 -0
- package/package.json +7 -9
- package/src/adapter/adapter.sockets.ts +4 -6
- package/src/adapter/adapter.ts +62 -70
- package/src/adapter/types/adapter.base.types.ts +34 -3
- package/src/adapter/types/adapter.firestore.types.ts +28 -11
- package/src/adapter/types/adapter.realtime.types.ts +13 -9
- package/src/firestore/firestore.methods.ts +36 -26
- package/src/firestore/firestore.sockets.ts +90 -88
- package/src/firestore/firestore.types.ts +11 -0
- package/src/firestore/index.ts +1 -0
- package/src/firestore/utils/constraints.utils.ts +1 -1
- package/src/firestore/utils/result.utils.ts +11 -5
- package/src/realtime/realtime.methods.ts +44 -27
- package/src/realtime/realtime.sockets.ts +66 -80
- package/src/realtime/utils/result.utils.ts +4 -2
- package/src/utils/misc.ts +4 -2
- package/tsconfig.json +1 -1
- package/dist/index.cjs.js +0 -715
- package/dist/index.cjs.js.map +0 -7
- package/dist/index.esm.js.map +0 -7
package/.eslintrc.json
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
{
|
|
2
|
-
"extends": ["../../.eslintrc.
|
|
2
|
+
"extends": ["plugin:@nx/react", "../../.eslintrc.js"],
|
|
3
3
|
"parserOptions": {
|
|
4
|
-
"project": ["./tsconfig.json"
|
|
5
|
-
}
|
|
4
|
+
"project": ["./tsconfig.json"]
|
|
5
|
+
},
|
|
6
|
+
"rules": {
|
|
7
|
+
"react/jsx-props-no-spreading": 0,
|
|
8
|
+
"react/require-default-props": 0
|
|
9
|
+
},
|
|
10
|
+
"ignorePatterns": ["dist/", "coverage/", "jest.config.ts", "/*.js"]
|
|
6
11
|
}
|
package/README.md
CHANGED
|
@@ -44,17 +44,17 @@ from the convenience and efficiency of Hyper Fetch for your Firebase-powered pro
|
|
|
44
44
|
|
|
45
45
|
๐ **Queueing** - [Read more](https://hyperfetch.bettertyped.com/docs/guides/advanced/queueing)
|
|
46
46
|
|
|
47
|
-
๐ **Automatic caching** - [Read more](https://hyperfetch.bettertyped.com/docs/
|
|
47
|
+
๐ **Automatic caching** - [Read more](https://hyperfetch.bettertyped.com/docs/core/cache)
|
|
48
48
|
|
|
49
49
|
๐ช **Persistence** - [Read more](https://hyperfetch.bettertyped.com/docs/guides/advanced/persistence)
|
|
50
50
|
|
|
51
|
-
๐ **SSR Support** - [Read more](https://hyperfetch.bettertyped.com/docs/
|
|
51
|
+
๐ **SSR Support** - [Read more](https://hyperfetch.bettertyped.com/docs/getting-started/environment)
|
|
52
52
|
|
|
53
53
|
๐ **Offline First** - [Read more](https://hyperfetch.bettertyped.com/docs/guides/advanced/offline)
|
|
54
54
|
|
|
55
|
-
๐ก **Built-in adapter** - [Read more](https://hyperfetch.bettertyped.com/docs/
|
|
55
|
+
๐ก **Built-in adapter** - [Read more](https://hyperfetch.bettertyped.com/docs/core/adapter)
|
|
56
56
|
|
|
57
|
-
๐งช **Easy to test** - [Read more](https://hyperfetch.bettertyped.com/docs/
|
|
57
|
+
๐งช **Easy to test** - [Read more](https://hyperfetch.bettertyped.com/docs/getting-started/testing)
|
|
58
58
|
|
|
59
59
|
๐ **Authentication** - [Read more](https://hyperfetch.bettertyped.com/docs/guides/basic/authentication)
|
|
60
60
|
|
|
@@ -66,7 +66,7 @@ from the convenience and efficiency of Hyper Fetch for your Firebase-powered pro
|
|
|
66
66
|
|
|
67
67
|
## Sources
|
|
68
68
|
|
|
69
|
-
- #### [Installation](https://hyperfetch.bettertyped.com/docs/
|
|
69
|
+
- #### [Installation](https://hyperfetch.bettertyped.com/docs/getting-started/installation)
|
|
70
70
|
- #### [Docs](https://hyperfetch.bettertyped.com/docs/react/overview)
|
|
71
71
|
- #### [API](https://hyperfetch.bettertyped.com/api/)
|
|
72
72
|
- #### [NPM](https://www.npmjs.com/package/@hyper-fetch/firebase)
|
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { WhereFilterOp, OrderByDirection, DocumentReference, DocumentSnapshot,
|
|
3
|
-
import {
|
|
4
|
-
import { DatabaseReference, DataSnapshot, Database } from 'firebase/database';
|
|
1
|
+
import { Adapter, Request, Client, getAdapterBindings } from '@hyper-fetch/core';
|
|
2
|
+
import { WhereFilterOp, OrderByDirection, DocumentReference, CollectionReference, DocumentSnapshot, QuerySnapshot, Unsubscribe, Firestore } from 'firebase/firestore';
|
|
3
|
+
import { SocketAdapter } from '@hyper-fetch/sockets';
|
|
5
4
|
import * as _firebase_firestore from '@firebase/firestore';
|
|
5
|
+
import { DocumentData, QuerySnapshot as QuerySnapshot$1, DocumentSnapshot as DocumentSnapshot$1 } from '@firebase/firestore';
|
|
6
|
+
import { DatabaseReference, DataSnapshot, Database } from 'firebase/database';
|
|
6
7
|
import * as _firebase_database from '@firebase/database';
|
|
8
|
+
import { DataSnapshot as DataSnapshot$1 } from '@firebase/database';
|
|
7
9
|
|
|
8
10
|
declare enum SharedQueryConstraints {
|
|
9
11
|
START_AT = "startAt",
|
|
@@ -32,7 +34,7 @@ declare const $where: (fieldPath: string, opStr: WhereFilterOp, value: any) => {
|
|
|
32
34
|
declare const $orderBy: (fieldPath: string, directionStr?: OrderByDirection) => {
|
|
33
35
|
toString: () => string;
|
|
34
36
|
type: FirestoreQueryConstraints.ORDER_BY;
|
|
35
|
-
values: string[];
|
|
37
|
+
values: (string | undefined)[];
|
|
36
38
|
};
|
|
37
39
|
declare const $limit: (num: number) => {
|
|
38
40
|
toString: () => string;
|
|
@@ -67,12 +69,12 @@ declare const $orderByChild: (path: string) => {
|
|
|
67
69
|
declare const $orderByKey: () => {
|
|
68
70
|
toString: () => string;
|
|
69
71
|
type: RealtimeQueryConstraints.ORDER_BY_KEY;
|
|
70
|
-
values:
|
|
72
|
+
values: never[];
|
|
71
73
|
};
|
|
72
74
|
declare const $orderByValue: () => {
|
|
73
75
|
toString: () => string;
|
|
74
76
|
type: RealtimeQueryConstraints.ORDER_BY_VALUE;
|
|
75
|
-
values:
|
|
77
|
+
values: never[];
|
|
76
78
|
};
|
|
77
79
|
declare const $limitToFirst: (num: number) => {
|
|
78
80
|
toString: () => string;
|
|
@@ -101,12 +103,12 @@ type ExtractConstraintType<T> = T extends {
|
|
|
101
103
|
} ? ThisType : never;
|
|
102
104
|
type PermittedConstraints<T, U> = ExtractConstraintType<T> extends U ? T : never;
|
|
103
105
|
|
|
104
|
-
type FirestoreSocketAdapterType =
|
|
106
|
+
type FirestoreSocketAdapterType = SocketAdapter<FirestoreOnSnapshotExtra, undefined, {
|
|
105
107
|
groupByChangeType?: boolean;
|
|
106
108
|
} & FirestoreQueryParams>;
|
|
107
|
-
type FirestoreAdapterType =
|
|
109
|
+
type FirestoreAdapterType = Adapter<Record<string, never>, "getDoc", FirestoreStatuses, FirestoreExtra, FirestoreQueryParams, FirestoreQueryParams> | Adapter<Record<string, never>, "getDocs", FirestoreStatuses, FirestoreGetDocsExtra, FirestoreQueryParams, FirestoreQueryParams> | Adapter<{
|
|
108
110
|
merge: boolean;
|
|
109
|
-
}, "setDoc", FirestoreStatuses, FirestoreRefOnlyExtra, Record<string, never
|
|
111
|
+
}, "setDoc", FirestoreStatuses, FirestoreRefOnlyExtra, Record<string, never>, undefined> | Adapter<Record<string, never>, "updateDoc" | "addDoc" | "deleteDoc" | "setDoc", FirestoreStatuses, FirestoreRefOnlyExtra, Record<string, never>, undefined>;
|
|
110
112
|
type FirestoreQueryParams = {
|
|
111
113
|
constraints?: PermittedConstraints<FirestorePermittedMethods, FirestoreConstraintsUnion | SharedQueryConstraints>[];
|
|
112
114
|
};
|
|
@@ -125,13 +127,13 @@ type FirestoreExtra = {
|
|
|
125
127
|
};
|
|
126
128
|
type FirestoreOnSnapshotExtra = {
|
|
127
129
|
ref?: DocumentReference | CollectionReference;
|
|
128
|
-
snapshot?: DocumentSnapshot;
|
|
130
|
+
snapshot?: DocumentSnapshot | QuerySnapshot;
|
|
129
131
|
unsubscribe?: Unsubscribe;
|
|
130
|
-
groupedResult
|
|
131
|
-
added:
|
|
132
|
-
modified:
|
|
133
|
-
removed:
|
|
134
|
-
};
|
|
132
|
+
groupedResult: {
|
|
133
|
+
added: DocumentData[];
|
|
134
|
+
modified: DocumentData[];
|
|
135
|
+
removed: DocumentData[];
|
|
136
|
+
} | null;
|
|
135
137
|
};
|
|
136
138
|
type FirestoreGetDocsExtra = {
|
|
137
139
|
ref?: CollectionReference;
|
|
@@ -142,10 +144,10 @@ type FirestoreRefOnlyExtra = {
|
|
|
142
144
|
};
|
|
143
145
|
type FirestoreStatuses = "success" | "error" | "emptyResource";
|
|
144
146
|
|
|
145
|
-
type RealtimeSocketAdapterType =
|
|
147
|
+
type RealtimeSocketAdapterType = SocketAdapter<RealtimeDbOnValueMethodExtra, undefined, {
|
|
146
148
|
onlyOnce?: boolean;
|
|
147
149
|
} & RealtimeDBQueryParams>;
|
|
148
|
-
type RealtimeDbAdapterType =
|
|
150
|
+
type RealtimeDbAdapterType = Adapter<DefaultRealtimeDBAdapterOptions, "get", RealtimeDBStatuses, RealtimeDbGetMethodExtra, RealtimeDBQueryParams, RealtimeDBQueryParams> | Adapter<DefaultRealtimeDBAdapterOptions, "push", RealtimeDBStatuses, RealtimeDbPushMethodExtra, Record<string, never>, undefined> | Adapter<DefaultRealtimeDBAdapterOptions, "set" | "update" | "remove", RealtimeDBStatuses, RealtimeDbDefaultExtra, Record<string, never>, undefined>;
|
|
149
151
|
type DefaultRealtimeDBAdapterOptions = {
|
|
150
152
|
priority?: number;
|
|
151
153
|
};
|
|
@@ -177,51 +179,72 @@ type RealtimeDBQueryParams = {
|
|
|
177
179
|
constraints?: PermittedConstraints<RealtimePermittedMethods, RealtimeConstraintsUnion | SharedQueryConstraints>[];
|
|
178
180
|
};
|
|
179
181
|
|
|
180
|
-
type
|
|
181
|
-
type
|
|
182
|
-
type
|
|
182
|
+
type FirebaseDBTypes = Database | Firestore;
|
|
183
|
+
type FirebaseAdapterTypes<T> = T extends Database ? RealtimeDbAdapterType : FirestoreAdapterType;
|
|
184
|
+
type FirebaseSocketAdapterTypes<T> = T extends Firestore ? FirestoreSocketAdapterType : RealtimeSocketAdapterType;
|
|
185
|
+
type FirebaseRealtimeDBType = Request<any, any, RealtimeDBQueryParams, any, any, Client<any, Adapter<any, RealtimeDBMethodsUnion, any, any, any, any>>, any, any, any>;
|
|
186
|
+
type FirestoreRequestType = Request<any, any, FirestoreQueryParams, any, any, Client<any, Adapter<any, FirestoreMethodsUnion, any, any, any, any>>, any, any, any>;
|
|
187
|
+
type FirebaseRequestType<T> = T extends Database ? FirebaseRealtimeDBType : FirestoreRequestType;
|
|
183
188
|
|
|
184
|
-
declare const
|
|
189
|
+
declare const FirebaseAdapter: <T extends FirebaseDBTypes>(database: T) => FirestoreAdapterType;
|
|
185
190
|
|
|
186
|
-
declare const
|
|
191
|
+
declare const FirebaseSocketsAdapter: <T extends FirebaseDBTypes>(database: T) => FirebaseSocketAdapterTypes<T>;
|
|
187
192
|
|
|
188
|
-
declare const getOrderedResultFirestore: (snapshot: any) =>
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
193
|
+
declare const getOrderedResultFirestore: (snapshot: QuerySnapshot$1<any>) => (DocumentData & {
|
|
194
|
+
__key: string;
|
|
195
|
+
})[];
|
|
196
|
+
declare const getGroupedResultFirestore: (snapshot: QuerySnapshot$1) => {
|
|
197
|
+
added: DocumentData[];
|
|
198
|
+
modified: DocumentData[];
|
|
199
|
+
removed: DocumentData[];
|
|
200
|
+
} | null;
|
|
194
201
|
|
|
195
202
|
declare const mapConstraint: ({ type, values }: FirestorePermittedMethods) => _firebase_firestore.QueryFieldFilterConstraint | _firebase_firestore.QueryOrderByConstraint | _firebase_firestore.QueryLimitConstraint | _firebase_firestore.QueryStartAtConstraint | _firebase_firestore.QueryEndAtConstraint;
|
|
196
203
|
|
|
197
|
-
|
|
198
|
-
onResponseStart;
|
|
199
|
-
onRequestStart;
|
|
200
|
-
onRequestEnd;
|
|
201
|
-
onResponseEnd;
|
|
202
|
-
}) => (methodName: FirestoreMethodsUnion, data: {
|
|
204
|
+
type DataType$1 = {
|
|
203
205
|
constraints?: PermittedConstraints<FirestorePermittedMethods, FirestoreConstraintsUnion | SharedQueryConstraints>[];
|
|
204
|
-
|
|
206
|
+
payload?: any;
|
|
205
207
|
options?: Record<string, any>;
|
|
206
|
-
}
|
|
208
|
+
};
|
|
209
|
+
declare const getFirestoreBrowserMethods: ({ database, url, onSuccess, onError, onResponseStart, onRequestStart, onRequestEnd, onResponseEnd, }: {
|
|
210
|
+
database: Firestore;
|
|
211
|
+
url: string;
|
|
212
|
+
onSuccess: Awaited<ReturnType<typeof getAdapterBindings>>["onSuccess"];
|
|
213
|
+
onError: Awaited<ReturnType<typeof getAdapterBindings>>["onError"];
|
|
214
|
+
onResponseStart: Awaited<ReturnType<typeof getAdapterBindings>>["onResponseStart"];
|
|
215
|
+
onRequestStart: Awaited<ReturnType<typeof getAdapterBindings>>["onRequestStart"];
|
|
216
|
+
onRequestEnd: Awaited<ReturnType<typeof getAdapterBindings>>["onRequestEnd"];
|
|
217
|
+
onResponseEnd: Awaited<ReturnType<typeof getAdapterBindings>>["onResponseEnd"];
|
|
218
|
+
}) => ((methodName: FirestoreMethodsUnion, data: DataType$1) => Promise<void>);
|
|
207
219
|
|
|
208
220
|
declare const firestoreSockets: (database: Firestore) => FirestoreSocketAdapterType;
|
|
209
221
|
|
|
210
|
-
declare
|
|
222
|
+
declare enum FirestoreDocOrQuery {
|
|
223
|
+
DOC = "doc",
|
|
224
|
+
QUERY = "query"
|
|
225
|
+
}
|
|
226
|
+
type FirestoreSnapshotType<T extends FirestoreDocOrQuery> = T extends FirestoreDocOrQuery.DOC ? DocumentSnapshot$1 : QuerySnapshot;
|
|
227
|
+
|
|
228
|
+
declare const getOrderedResultRealtime: (snapshot: DataSnapshot$1) => any[] | null;
|
|
211
229
|
|
|
212
230
|
declare const mapRealtimeConstraint: ({ type, values }: RealtimePermittedMethods) => _firebase_database.QueryConstraint;
|
|
213
231
|
|
|
214
232
|
declare const realtimeSockets: (database: Database) => RealtimeSocketAdapterType;
|
|
215
233
|
|
|
216
|
-
|
|
217
|
-
onResponseStart;
|
|
218
|
-
onRequestStart;
|
|
219
|
-
onRequestEnd;
|
|
220
|
-
onResponseEnd;
|
|
221
|
-
}) => (methodName: RealtimeDBMethodsUnion, data: {
|
|
234
|
+
type DataType = {
|
|
222
235
|
constraints: PermittedConstraints<RealtimePermittedMethods, RealtimeConstraintsUnion | SharedQueryConstraints>[];
|
|
223
|
-
|
|
236
|
+
payload: any;
|
|
224
237
|
options: Record<string, any>;
|
|
225
|
-
}
|
|
226
|
-
|
|
227
|
-
|
|
238
|
+
};
|
|
239
|
+
declare const getRealtimeDbBrowserMethods: ({ database, url, onSuccess, onError, onResponseStart, onRequestStart, onRequestEnd, onResponseEnd, }: {
|
|
240
|
+
database: Database;
|
|
241
|
+
url: string;
|
|
242
|
+
onSuccess: Awaited<ReturnType<typeof getAdapterBindings>>["onSuccess"];
|
|
243
|
+
onError: Awaited<ReturnType<typeof getAdapterBindings>>["onError"];
|
|
244
|
+
onResponseStart: Awaited<ReturnType<typeof getAdapterBindings>>["onResponseStart"];
|
|
245
|
+
onRequestStart: Awaited<ReturnType<typeof getAdapterBindings>>["onRequestStart"];
|
|
246
|
+
onRequestEnd: Awaited<ReturnType<typeof getAdapterBindings>>["onRequestEnd"];
|
|
247
|
+
onResponseEnd: Awaited<ReturnType<typeof getAdapterBindings>>["onResponseEnd"];
|
|
248
|
+
}) => ((methodName: RealtimeDBMethodsUnion, data: DataType) => Promise<void>);
|
|
249
|
+
|
|
250
|
+
export { $endAt, $endBefore, $equalTo, $limit, $limitToFirst, $limitToLast, $orderBy, $orderByChild, $orderByKey, $orderByValue, $startAfter, $startAt, $where, type DefaultRealtimeDBAdapterOptions, FirebaseAdapter, type FirebaseAdapterTypes, type FirebaseDBTypes, type FirebaseRealtimeDBType, type FirebaseRequestType, type FirebaseSocketAdapterTypes, FirebaseSocketsAdapter, type FirestoreAdapterType, type FirestoreConstraintsUnion, FirestoreDocOrQuery, type FirestoreExtra, type FirestoreGetDocsExtra, FirestoreMethods, type FirestoreMethodsUnion, type FirestoreOnSnapshotExtra, type FirestorePermittedMethods, FirestoreQueryConstraints, type FirestoreQueryParams, type FirestoreRefOnlyExtra, type FirestoreRequestType, type FirestoreSnapshotType, type FirestoreSocketAdapterType, type FirestoreStatuses, type PermittedConstraints, type RealtimeConstraintsUnion, RealtimeDBMethods, type RealtimeDBMethodsUnion, type RealtimeDBQueryParams, type RealtimeDBStatuses, type RealtimeDbAdapterType, type RealtimeDbDefaultExtra, type RealtimeDbGetMethodExtra, type RealtimeDbOnValueMethodExtra, type RealtimeDbPushMethodExtra, type RealtimePermittedMethods, RealtimeQueryConstraints, type RealtimeSocketAdapterType, SharedQueryConstraints, firestoreSockets, getFirestoreBrowserMethods, getGroupedResultFirestore, getOrderedResultFirestore, getOrderedResultRealtime, getRealtimeDbBrowserMethods, mapConstraint, mapRealtimeConstraint, realtimeSockets };
|