@hyper-fetch/firebase 5.0.1 → 5.0.2
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/README.md +2 -2
- package/dist/index.cjs.js +261 -750
- package/dist/index.cjs.js.map +4 -4
- package/dist/index.d.ts +20 -86
- package/dist/index.esm.js +207 -760
- package/dist/index.esm.js.map +4 -4
- package/package.json +2 -9
- package/src/adapter/{browser/adapter.browser.sockets.ts → adapter.sockets.ts} +1 -1
- package/src/adapter/index.ts +2 -2
- package/src/adapter/{browser/adapter.browser.types.ts → types/adapter.base.types.ts} +1 -1
- package/src/adapter/types/index.ts +1 -2
- package/src/constraints/constraints.types.ts +0 -24
- package/src/firestore/{browser/firestore.browser.methods.ts → firestore.methods.ts} +3 -4
- package/src/firestore/{browser/firestore.browser.sockets.ts → firestore.sockets.ts} +3 -2
- package/src/firestore/index.ts +2 -2
- package/src/firestore/utils/index.ts +2 -1
- package/src/firestore/utils/{firestore.utils.ts → result.utils.ts} +1 -1
- package/src/index.ts +0 -1
- package/src/realtime/index.ts +2 -2
- package/src/realtime/{browser/realtime.browser.methods.ts → realtime.methods.ts} +2 -2
- package/src/realtime/{browser/realtime.browser.sockets.ts → realtime.sockets.ts} +1 -1
- package/src/realtime/utils/index.ts +2 -1
- package/src/realtime/utils/{realtime.utils.ts → result.utils.ts} +1 -1
- package/src/utils/index.ts +0 -1
- package/src/adapter/admin/adapter.admin.sockets.ts +0 -14
- package/src/adapter/admin/adapter.admin.ts +0 -72
- package/src/adapter/admin/adapter.admin.types.ts +0 -15
- package/src/adapter/admin/index.ts +0 -3
- package/src/adapter/browser/index.ts +0 -3
- package/src/adapter/types/firestore.admin.types.ts +0 -17
- package/src/adapter/types/realtime.admin.types.ts +0 -17
- package/src/firestore/admin/firestore.admin.methods.ts +0 -86
- package/src/firestore/admin/firestore.admin.sockets.ts +0 -86
- package/src/firestore/admin/firestore.admin.utils.ts +0 -69
- package/src/firestore/admin/index.ts +0 -2
- package/src/firestore/browser/index.ts +0 -3
- package/src/realtime/admin/index.ts +0 -2
- package/src/realtime/admin/realtime.admin.methods.ts +0 -74
- package/src/realtime/admin/realtime.admin.sockets.ts +0 -93
- package/src/realtime/admin/realtime.admin.utils.ts +0 -54
- package/src/realtime/browser/index.ts +0 -3
- package/src/utils/cache.utils.ts +0 -33
- /package/src/adapter/{browser/adapter.browser.ts → adapter.ts} +0 -0
- /package/src/firestore/{browser/firestore.browser.utils.ts → utils/constraints.utils.ts} +0 -0
- /package/src/realtime/{browser/realtime.browser.utils.ts → utils/constraints.utils.ts} +0 -0
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
import { getAdapterBindings, ResponseReturnType } from "@hyper-fetch/core";
|
|
2
|
-
import { Firestore } from "firebase-admin/firestore";
|
|
3
|
-
|
|
4
|
-
import {
|
|
5
|
-
FirestoreAdapterType,
|
|
6
|
-
FirestoreMethodsUnion,
|
|
7
|
-
FirestoreQueryParams,
|
|
8
|
-
FirebaseAdminAdapterTypes,
|
|
9
|
-
FirebaseAdminDBTypes,
|
|
10
|
-
RealtimeDbAdapterType,
|
|
11
|
-
RealtimeDBMethodsUnion,
|
|
12
|
-
RealtimeDBQueryParams,
|
|
13
|
-
FirestoreMethods,
|
|
14
|
-
RealtimeDBMethods,
|
|
15
|
-
} from "adapter";
|
|
16
|
-
import { getFirestoreAdminMethods } from "firestore";
|
|
17
|
-
import { getRealtimeDbAdminMethods } from "realtime";
|
|
18
|
-
|
|
19
|
-
export const firebaseAdminAdapter =
|
|
20
|
-
<T extends FirebaseAdminDBTypes>(database: T) =>
|
|
21
|
-
() => {
|
|
22
|
-
const adapter: FirebaseAdminAdapterTypes<T> = async (request, requestId) => {
|
|
23
|
-
const { fullUrl, onSuccess, onError, onRequestStart, onResponseEnd, onResponseStart, onRequestEnd } =
|
|
24
|
-
await getAdapterBindings<RealtimeDbAdapterType | FirestoreAdapterType>(request, requestId, "error", {});
|
|
25
|
-
return new Promise<ResponseReturnType<any, any, FirebaseAdminAdapterTypes<T>>>((resolve) => {
|
|
26
|
-
if (database instanceof Firestore) {
|
|
27
|
-
const {
|
|
28
|
-
method = FirestoreMethods.getDocs,
|
|
29
|
-
queryParams,
|
|
30
|
-
data,
|
|
31
|
-
options,
|
|
32
|
-
}: { method: FirestoreMethodsUnion; queryParams: FirestoreQueryParams; data; options } = request;
|
|
33
|
-
const availableMethods = getFirestoreAdminMethods(request, database, fullUrl, onSuccess, onError, resolve, {
|
|
34
|
-
onRequestStart,
|
|
35
|
-
onResponseEnd,
|
|
36
|
-
onResponseStart,
|
|
37
|
-
onRequestEnd,
|
|
38
|
-
});
|
|
39
|
-
if (!Object.values(FirestoreMethods).includes(method)) {
|
|
40
|
-
throw new Error(`Cannot find method ${method} in Firestore available methods.`);
|
|
41
|
-
}
|
|
42
|
-
availableMethods(method, {
|
|
43
|
-
constraints: queryParams?.constraints ? queryParams.constraints : [],
|
|
44
|
-
data,
|
|
45
|
-
options,
|
|
46
|
-
});
|
|
47
|
-
} else {
|
|
48
|
-
const {
|
|
49
|
-
method = RealtimeDBMethods.get,
|
|
50
|
-
queryParams,
|
|
51
|
-
data,
|
|
52
|
-
options,
|
|
53
|
-
}: { method: RealtimeDBMethodsUnion; queryParams: RealtimeDBQueryParams; data; options } = request;
|
|
54
|
-
const availableMethods = getRealtimeDbAdminMethods(request, database, fullUrl, onSuccess, onError, resolve, {
|
|
55
|
-
onRequestStart,
|
|
56
|
-
onResponseEnd,
|
|
57
|
-
onResponseStart,
|
|
58
|
-
onRequestEnd,
|
|
59
|
-
});
|
|
60
|
-
if (!Object.values(RealtimeDBMethods).includes(method)) {
|
|
61
|
-
throw new Error(`Cannot find method ${method} in Realtime database available methods.`);
|
|
62
|
-
}
|
|
63
|
-
availableMethods(method, {
|
|
64
|
-
constraints: queryParams?.constraints ? queryParams.constraints : [],
|
|
65
|
-
options,
|
|
66
|
-
data,
|
|
67
|
-
});
|
|
68
|
-
}
|
|
69
|
-
});
|
|
70
|
-
};
|
|
71
|
-
return adapter;
|
|
72
|
-
};
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import { Database } from "firebase-admin/database";
|
|
2
|
-
import { Firestore } from "firebase-admin/firestore";
|
|
3
|
-
|
|
4
|
-
import {
|
|
5
|
-
RealtimeDbAdapterType,
|
|
6
|
-
FirestoreAdapterType,
|
|
7
|
-
FirestoreAdminSocketAdapterType,
|
|
8
|
-
RealtimeAdminSocketAdapterType,
|
|
9
|
-
} from "adapter";
|
|
10
|
-
|
|
11
|
-
export type FirebaseAdminDBTypes = Database | Firestore;
|
|
12
|
-
export type FirebaseAdminAdapterTypes<T> = T extends Database ? RealtimeDbAdapterType : FirestoreAdapterType;
|
|
13
|
-
export type FirebaseAdminSocketAdapterTypes<T> = T extends Firestore
|
|
14
|
-
? FirestoreAdminSocketAdapterType
|
|
15
|
-
: RealtimeAdminSocketAdapterType;
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import { DocumentReference, DocumentSnapshot, Query } from "firebase-admin/firestore";
|
|
2
|
-
import { SocketAdapterType } from "@hyper-fetch/sockets";
|
|
3
|
-
|
|
4
|
-
import { FirestoreQueryParams } from "adapter";
|
|
5
|
-
|
|
6
|
-
export type FirestoreAdminSocketAdapterType = SocketAdapterType<
|
|
7
|
-
never,
|
|
8
|
-
FirestoreAdminOnSnapshotExtra,
|
|
9
|
-
{ groupByChangeType?: boolean } & FirestoreQueryParams
|
|
10
|
-
>;
|
|
11
|
-
|
|
12
|
-
export type FirestoreAdminOnSnapshotExtra = {
|
|
13
|
-
ref?: DocumentReference | Query;
|
|
14
|
-
snapshot?: DocumentSnapshot;
|
|
15
|
-
unsubscribe?: () => void;
|
|
16
|
-
groupedResult?: { added: DocumentSnapshot[]; modified: DocumentSnapshot[]; removed: DocumentSnapshot[] };
|
|
17
|
-
};
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import { SocketAdapterType } from "@hyper-fetch/sockets";
|
|
2
|
-
import { Reference, DataSnapshot } from "firebase-admin/database";
|
|
3
|
-
|
|
4
|
-
import { RealtimeDBQueryParams, RealtimeDBStatuses } from "adapter/index";
|
|
5
|
-
|
|
6
|
-
export type RealtimeAdminSocketAdapterType = SocketAdapterType<
|
|
7
|
-
never,
|
|
8
|
-
RealtimeAdminOnValueMethodExtra,
|
|
9
|
-
{ onlyOnce?: boolean } & RealtimeDBQueryParams,
|
|
10
|
-
never
|
|
11
|
-
>;
|
|
12
|
-
|
|
13
|
-
export type RealtimeAdminOnValueMethodExtra = {
|
|
14
|
-
ref: Reference;
|
|
15
|
-
snapshot: DataSnapshot;
|
|
16
|
-
status: RealtimeDBStatuses;
|
|
17
|
-
};
|
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
import { CollectionReference, DocumentReference, DocumentSnapshot, Firestore } from "firebase-admin/firestore";
|
|
2
|
-
import { RequestInstance } from "@hyper-fetch/core";
|
|
3
|
-
|
|
4
|
-
import { FirestoreMethodsUnion } from "adapter";
|
|
5
|
-
import { getStatus } from "utils";
|
|
6
|
-
import { applyFireStoreAdminConstraints, getRef, getOrderedResultFirestore } from "firestore";
|
|
7
|
-
import {
|
|
8
|
-
FirestoreConstraintsUnion,
|
|
9
|
-
FirestorePermittedMethods,
|
|
10
|
-
PermittedConstraints,
|
|
11
|
-
SharedQueryConstraints,
|
|
12
|
-
} from "constraints";
|
|
13
|
-
|
|
14
|
-
export const getFirestoreAdminMethods = <R extends RequestInstance>(
|
|
15
|
-
request: R,
|
|
16
|
-
database: Firestore,
|
|
17
|
-
url: string,
|
|
18
|
-
onSuccess,
|
|
19
|
-
onError,
|
|
20
|
-
resolve,
|
|
21
|
-
events: { onRequestStart; onResponseEnd; onResponseStart; onRequestEnd },
|
|
22
|
-
): ((
|
|
23
|
-
methodName: FirestoreMethodsUnion,
|
|
24
|
-
data: {
|
|
25
|
-
constraints?: PermittedConstraints<FirestorePermittedMethods, FirestoreConstraintsUnion | SharedQueryConstraints>[];
|
|
26
|
-
data?: any;
|
|
27
|
-
options?: Record<string, any>;
|
|
28
|
-
},
|
|
29
|
-
) => Promise<void>) => {
|
|
30
|
-
const [cleanUrl] = url.split("?");
|
|
31
|
-
const methods = {
|
|
32
|
-
getDoc: async () => {
|
|
33
|
-
const path = getRef(database, cleanUrl);
|
|
34
|
-
const snapshot = (await path.get()) as DocumentSnapshot;
|
|
35
|
-
const result = snapshot.data() || null;
|
|
36
|
-
const status = result ? "success" : "emptyResource";
|
|
37
|
-
return { result, status, extra: { ref: path, snapshot } };
|
|
38
|
-
},
|
|
39
|
-
getDocs: async ({ constraints = [] }) => {
|
|
40
|
-
const path = getRef(database, cleanUrl) as CollectionReference;
|
|
41
|
-
const query = applyFireStoreAdminConstraints(path, constraints);
|
|
42
|
-
const querySnapshot = await query.get();
|
|
43
|
-
const result = getOrderedResultFirestore(querySnapshot);
|
|
44
|
-
const status = getStatus(result);
|
|
45
|
-
|
|
46
|
-
return { result, status, extra: { ref: path, snapshot: querySnapshot } };
|
|
47
|
-
},
|
|
48
|
-
setDoc: async ({ data, options }: { data?: any; options?: Record<string, any> }) => {
|
|
49
|
-
const path = getRef(database, cleanUrl) as DocumentReference;
|
|
50
|
-
const merge = options?.merge === true;
|
|
51
|
-
const res = await path.set(data, { merge });
|
|
52
|
-
return { result: res, status: "success", extra: { ref: path } };
|
|
53
|
-
},
|
|
54
|
-
addDoc: async ({ data }: { data?: any }) => {
|
|
55
|
-
const ref = getRef(database, cleanUrl) as CollectionReference;
|
|
56
|
-
const docRef = await ref.add(data);
|
|
57
|
-
return { result: data, status: "success", extra: { ref: docRef } };
|
|
58
|
-
},
|
|
59
|
-
updateDoc: async ({ data }: { data?: any }) => {
|
|
60
|
-
const path = getRef(database, cleanUrl) as DocumentReference;
|
|
61
|
-
await path.update(data);
|
|
62
|
-
return { result: data, status: "success", extra: { ref: path } };
|
|
63
|
-
},
|
|
64
|
-
deleteDoc: async () => {
|
|
65
|
-
const path = getRef(database, cleanUrl) as DocumentReference;
|
|
66
|
-
await path.delete();
|
|
67
|
-
return { result: null, status: "success", extra: { ref: path } };
|
|
68
|
-
},
|
|
69
|
-
};
|
|
70
|
-
|
|
71
|
-
return async (methodName: FirestoreMethodsUnion, data) => {
|
|
72
|
-
try {
|
|
73
|
-
events.onRequestStart();
|
|
74
|
-
const { result, status, extra } = await methods[methodName](data);
|
|
75
|
-
events.onRequestEnd();
|
|
76
|
-
events.onResponseStart();
|
|
77
|
-
onSuccess(result, status, extra, resolve);
|
|
78
|
-
events.onResponseEnd();
|
|
79
|
-
} catch (e) {
|
|
80
|
-
events.onRequestEnd();
|
|
81
|
-
events.onResponseStart();
|
|
82
|
-
onError(e, "error", {}, resolve);
|
|
83
|
-
events.onResponseEnd();
|
|
84
|
-
}
|
|
85
|
-
};
|
|
86
|
-
};
|
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
import { CollectionReference, DocumentReference, DocumentSnapshot, Firestore, Query } from "firebase-admin/firestore";
|
|
2
|
-
import { getSocketAdapterBindings } from "@hyper-fetch/sockets";
|
|
3
|
-
|
|
4
|
-
import { applyFireStoreAdminConstraints, getRef } from "./firestore.admin.utils";
|
|
5
|
-
import { getGroupedResultFirestore, getOrderedResultFirestore } from "../utils";
|
|
6
|
-
import { getStatus } from "utils";
|
|
7
|
-
import { FirestoreAdminSocketAdapterType } from "adapter";
|
|
8
|
-
|
|
9
|
-
export const firestoreAdminSockets = (database: Firestore): FirestoreAdminSocketAdapterType => {
|
|
10
|
-
return (socket) => {
|
|
11
|
-
const {
|
|
12
|
-
open,
|
|
13
|
-
connecting,
|
|
14
|
-
reconnectionAttempts,
|
|
15
|
-
listeners,
|
|
16
|
-
removeListener,
|
|
17
|
-
onReconnect,
|
|
18
|
-
onListen,
|
|
19
|
-
onEvent,
|
|
20
|
-
onError,
|
|
21
|
-
} = getSocketAdapterBindings(socket, { open: true });
|
|
22
|
-
|
|
23
|
-
const connect = () => {
|
|
24
|
-
throw new Error("Connect function is not implemented for Firestore Admin socket.");
|
|
25
|
-
};
|
|
26
|
-
|
|
27
|
-
const disconnect = () => {
|
|
28
|
-
throw new Error("Cannot disconnect from Firestore database socket. Use 'app.delete()' instead.");
|
|
29
|
-
};
|
|
30
|
-
|
|
31
|
-
const reconnect = () => {
|
|
32
|
-
onReconnect(disconnect, connect);
|
|
33
|
-
};
|
|
34
|
-
|
|
35
|
-
const listen: ReturnType<FirestoreAdminSocketAdapterType>["listen"] = (listener, callback) => {
|
|
36
|
-
const fullUrl = socket.url + listener.endpoint;
|
|
37
|
-
const { options } = listener;
|
|
38
|
-
let pathRef: DocumentReference | Query = getRef(database, fullUrl);
|
|
39
|
-
if (pathRef instanceof CollectionReference) {
|
|
40
|
-
pathRef = applyFireStoreAdminConstraints(pathRef, options?.constraints || []);
|
|
41
|
-
}
|
|
42
|
-
let unsubscribe = () => {};
|
|
43
|
-
let unmount = () => {};
|
|
44
|
-
let clearListeners = () => {};
|
|
45
|
-
|
|
46
|
-
unsubscribe = pathRef.onSnapshot(
|
|
47
|
-
(snapshot) => {
|
|
48
|
-
const response =
|
|
49
|
-
snapshot instanceof DocumentSnapshot ? snapshot.data() || null : getOrderedResultFirestore(snapshot);
|
|
50
|
-
const status = getStatus(response);
|
|
51
|
-
const groupedResult = options?.groupByChangeType === true ? getGroupedResultFirestore(snapshot) : null;
|
|
52
|
-
const extra = { ref: pathRef, snapshot, unsubscribe, groupedResult, status };
|
|
53
|
-
callback({ data: response, extra });
|
|
54
|
-
onEvent(listener.endpoint, response, extra);
|
|
55
|
-
},
|
|
56
|
-
(error) => {
|
|
57
|
-
onError(error);
|
|
58
|
-
},
|
|
59
|
-
);
|
|
60
|
-
unmount = onListen(listener, callback, unsubscribe);
|
|
61
|
-
clearListeners = () => {
|
|
62
|
-
unsubscribe();
|
|
63
|
-
unmount();
|
|
64
|
-
};
|
|
65
|
-
|
|
66
|
-
return clearListeners;
|
|
67
|
-
};
|
|
68
|
-
|
|
69
|
-
const emit = async () => {
|
|
70
|
-
throw new Error("Cannot emit from Firestore database socket.");
|
|
71
|
-
};
|
|
72
|
-
|
|
73
|
-
return {
|
|
74
|
-
open,
|
|
75
|
-
reconnectionAttempts,
|
|
76
|
-
listeners,
|
|
77
|
-
connecting,
|
|
78
|
-
listen,
|
|
79
|
-
removeListener,
|
|
80
|
-
emit,
|
|
81
|
-
connect,
|
|
82
|
-
reconnect,
|
|
83
|
-
disconnect,
|
|
84
|
-
};
|
|
85
|
-
};
|
|
86
|
-
};
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
import { CollectionReference, DocumentReference, Firestore } from "firebase-admin/lib/firestore";
|
|
2
|
-
import { OrderByDirection } from "firebase/firestore";
|
|
3
|
-
|
|
4
|
-
import { FirestorePermittedMethods, FirestoreQueryConstraints, SharedQueryConstraints } from "../../constraints";
|
|
5
|
-
|
|
6
|
-
export const getRef = (db: Firestore, fullUrl: string) => {
|
|
7
|
-
const withoutSurroundingSlashes = fullUrl.replace(/^\/|\/$/g, "");
|
|
8
|
-
const urlParts = withoutSurroundingSlashes.split("/").map((element, index) => {
|
|
9
|
-
return index % 2 === 0 ? ["collection", element] : ["doc", element];
|
|
10
|
-
});
|
|
11
|
-
|
|
12
|
-
return urlParts.reduce((_db, value) => {
|
|
13
|
-
const [method, pathPart] = value;
|
|
14
|
-
if (method === "doc" && "doc" in _db) {
|
|
15
|
-
return _db.doc(pathPart);
|
|
16
|
-
}
|
|
17
|
-
if (method === "collection" && "collection" in _db) {
|
|
18
|
-
return _db.collection(pathPart);
|
|
19
|
-
}
|
|
20
|
-
return _db;
|
|
21
|
-
}, db as unknown as Firestore | CollectionReference | DocumentReference) as CollectionReference | DocumentReference;
|
|
22
|
-
};
|
|
23
|
-
|
|
24
|
-
export const applyFireStoreAdminConstraint = (
|
|
25
|
-
collectionRef: CollectionReference,
|
|
26
|
-
{ type, values }: FirestorePermittedMethods,
|
|
27
|
-
) => {
|
|
28
|
-
switch (type) {
|
|
29
|
-
case FirestoreQueryConstraints.WHERE: {
|
|
30
|
-
const [fieldPath, strOp, value] = values;
|
|
31
|
-
return collectionRef.where(fieldPath, strOp, value);
|
|
32
|
-
}
|
|
33
|
-
case FirestoreQueryConstraints.ORDER_BY: {
|
|
34
|
-
const [field, ord] = values;
|
|
35
|
-
return collectionRef.orderBy(field, ord as OrderByDirection);
|
|
36
|
-
}
|
|
37
|
-
case FirestoreQueryConstraints.LIMIT: {
|
|
38
|
-
const [limitValue] = values;
|
|
39
|
-
return collectionRef.limit(limitValue);
|
|
40
|
-
}
|
|
41
|
-
case SharedQueryConstraints.START_AT: {
|
|
42
|
-
const [docOrFields] = values;
|
|
43
|
-
return collectionRef.startAt(docOrFields);
|
|
44
|
-
}
|
|
45
|
-
case SharedQueryConstraints.START_AFTER: {
|
|
46
|
-
const [docOrFields] = values;
|
|
47
|
-
return collectionRef.startAfter(docOrFields);
|
|
48
|
-
}
|
|
49
|
-
case SharedQueryConstraints.END_AT: {
|
|
50
|
-
const [docOrFields] = values;
|
|
51
|
-
return collectionRef.endAt(docOrFields);
|
|
52
|
-
}
|
|
53
|
-
case SharedQueryConstraints.END_BEFORE: {
|
|
54
|
-
const [docOrFields] = values;
|
|
55
|
-
return collectionRef.endBefore(docOrFields);
|
|
56
|
-
}
|
|
57
|
-
default:
|
|
58
|
-
throw new Error(`Unknown method ${type}`);
|
|
59
|
-
}
|
|
60
|
-
};
|
|
61
|
-
|
|
62
|
-
export const applyFireStoreAdminConstraints = (
|
|
63
|
-
collectionRef: CollectionReference,
|
|
64
|
-
constraints: FirestorePermittedMethods[],
|
|
65
|
-
) => {
|
|
66
|
-
return constraints.reduce((collection, constraint) => {
|
|
67
|
-
return applyFireStoreAdminConstraint(collection, constraint);
|
|
68
|
-
}, collectionRef);
|
|
69
|
-
};
|
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
import { Database } from "firebase-admin/database";
|
|
2
|
-
import { RequestInstance } from "@hyper-fetch/core";
|
|
3
|
-
|
|
4
|
-
import { RealtimeDBMethodsUnion } from "adapter/types";
|
|
5
|
-
import { getStatus, isDocOrQuery } from "utils";
|
|
6
|
-
import { applyRealtimeAdminConstraints, getOrderedResultRealtime } from "realtime";
|
|
7
|
-
import {
|
|
8
|
-
PermittedConstraints,
|
|
9
|
-
RealtimeConstraintsUnion,
|
|
10
|
-
RealtimePermittedMethods,
|
|
11
|
-
SharedQueryConstraints,
|
|
12
|
-
} from "constraints";
|
|
13
|
-
|
|
14
|
-
export const getRealtimeDbAdminMethods = <R extends RequestInstance>(
|
|
15
|
-
request: R,
|
|
16
|
-
database: Database,
|
|
17
|
-
url: string,
|
|
18
|
-
onSuccess,
|
|
19
|
-
onError,
|
|
20
|
-
resolve,
|
|
21
|
-
events: { onRequestStart; onResponseEnd; onResponseStart; onRequestEnd },
|
|
22
|
-
): ((
|
|
23
|
-
methodName: RealtimeDBMethodsUnion,
|
|
24
|
-
data: {
|
|
25
|
-
constraints: PermittedConstraints<RealtimePermittedMethods, RealtimeConstraintsUnion | SharedQueryConstraints>[];
|
|
26
|
-
data: any;
|
|
27
|
-
options: Record<string, any>;
|
|
28
|
-
},
|
|
29
|
-
) => Promise<void>) => {
|
|
30
|
-
const [fullUrl] = url.split("?");
|
|
31
|
-
const path = database.ref(fullUrl);
|
|
32
|
-
const methods = {
|
|
33
|
-
get: async ({ constraints }) => {
|
|
34
|
-
const docOrQuery = isDocOrQuery(fullUrl);
|
|
35
|
-
const q = applyRealtimeAdminConstraints(path, constraints);
|
|
36
|
-
const snapshot = await q.get();
|
|
37
|
-
const res = docOrQuery === "doc" ? snapshot.val() : getOrderedResultRealtime(snapshot);
|
|
38
|
-
const status = getStatus(res);
|
|
39
|
-
return { result: res, status, extra: { ref: path, snapshot } };
|
|
40
|
-
},
|
|
41
|
-
set: async ({ data }) => {
|
|
42
|
-
await path.set(data);
|
|
43
|
-
return { result: data, status: "success", extra: { ref: path } };
|
|
44
|
-
},
|
|
45
|
-
push: async ({ data }) => {
|
|
46
|
-
const resRef = await path.push(data);
|
|
47
|
-
return { result: data, status: "success", extra: { ref: resRef, key: resRef.key } };
|
|
48
|
-
},
|
|
49
|
-
update: async ({ data }) => {
|
|
50
|
-
await path.update(data);
|
|
51
|
-
return { result: data, status: "success", extra: { ref: path } };
|
|
52
|
-
},
|
|
53
|
-
remove: async () => {
|
|
54
|
-
await path.remove();
|
|
55
|
-
return { result: null, status: "success", extra: { ref: path } };
|
|
56
|
-
},
|
|
57
|
-
};
|
|
58
|
-
|
|
59
|
-
return async (methodName: RealtimeDBMethodsUnion, data) => {
|
|
60
|
-
try {
|
|
61
|
-
events.onRequestStart();
|
|
62
|
-
const { result, status, extra } = await methods[methodName](data);
|
|
63
|
-
events.onRequestEnd();
|
|
64
|
-
events.onResponseStart();
|
|
65
|
-
onSuccess(result, status, extra, resolve);
|
|
66
|
-
events.onResponseEnd();
|
|
67
|
-
} catch (e) {
|
|
68
|
-
events.onRequestEnd();
|
|
69
|
-
events.onResponseStart();
|
|
70
|
-
onError(e, "error", {}, resolve);
|
|
71
|
-
events.onResponseEnd();
|
|
72
|
-
}
|
|
73
|
-
};
|
|
74
|
-
};
|
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
import { Database } from "firebase-admin/lib/database";
|
|
2
|
-
import { getSocketAdapterBindings } from "@hyper-fetch/sockets";
|
|
3
|
-
|
|
4
|
-
import { applyRealtimeAdminConstraints, getOrderedResultRealtime } from "realtime";
|
|
5
|
-
import { getStatus, isDocOrQuery } from "utils";
|
|
6
|
-
import { RealtimeAdminOnValueMethodExtra, RealtimeAdminSocketAdapterType } from "adapter";
|
|
7
|
-
|
|
8
|
-
export const realtimeSocketsAdmin = (database: Database): RealtimeAdminSocketAdapterType => {
|
|
9
|
-
return (socket) => {
|
|
10
|
-
const {
|
|
11
|
-
open,
|
|
12
|
-
connecting,
|
|
13
|
-
reconnectionAttempts,
|
|
14
|
-
listeners,
|
|
15
|
-
removeListener,
|
|
16
|
-
onConnect,
|
|
17
|
-
onReconnect,
|
|
18
|
-
onDisconnect,
|
|
19
|
-
onListen,
|
|
20
|
-
onOpen,
|
|
21
|
-
onClose,
|
|
22
|
-
onEvent,
|
|
23
|
-
onError,
|
|
24
|
-
} = getSocketAdapterBindings(socket, { open: true });
|
|
25
|
-
|
|
26
|
-
const connect = () => {
|
|
27
|
-
const enabled = onConnect();
|
|
28
|
-
|
|
29
|
-
if (enabled) {
|
|
30
|
-
database.goOnline();
|
|
31
|
-
onOpen();
|
|
32
|
-
}
|
|
33
|
-
};
|
|
34
|
-
|
|
35
|
-
const disconnect = () => {
|
|
36
|
-
database.goOffline();
|
|
37
|
-
onDisconnect();
|
|
38
|
-
onClose();
|
|
39
|
-
};
|
|
40
|
-
|
|
41
|
-
const reconnect = () => {
|
|
42
|
-
onReconnect(disconnect, connect);
|
|
43
|
-
};
|
|
44
|
-
|
|
45
|
-
const listen: ReturnType<RealtimeAdminSocketAdapterType>["listen"] = (listener, callback) => {
|
|
46
|
-
const fullUrl = socket.url + listener.endpoint;
|
|
47
|
-
const path = database.ref(fullUrl);
|
|
48
|
-
const { options } = listener;
|
|
49
|
-
const onlyOnce = options?.onlyOnce || false;
|
|
50
|
-
const q = applyRealtimeAdminConstraints(path, options?.constraints || []);
|
|
51
|
-
const method = onlyOnce === true ? "once" : "on";
|
|
52
|
-
q[method](
|
|
53
|
-
"value",
|
|
54
|
-
(snapshot) => {
|
|
55
|
-
const response = isDocOrQuery(fullUrl) === "doc" ? snapshot.val() : getOrderedResultRealtime(snapshot);
|
|
56
|
-
const status = getStatus(response);
|
|
57
|
-
const extra: RealtimeAdminOnValueMethodExtra = { ref: path, snapshot, status };
|
|
58
|
-
callback({ data: response, extra });
|
|
59
|
-
onEvent(listener.endpoint, response, extra);
|
|
60
|
-
},
|
|
61
|
-
(error) => {
|
|
62
|
-
onError(error);
|
|
63
|
-
},
|
|
64
|
-
);
|
|
65
|
-
const unsubscribe = () => q.off("value");
|
|
66
|
-
const unmount = onListen(listener, callback, unsubscribe);
|
|
67
|
-
|
|
68
|
-
const clearListeners = () => {
|
|
69
|
-
unsubscribe();
|
|
70
|
-
unmount();
|
|
71
|
-
};
|
|
72
|
-
|
|
73
|
-
return clearListeners;
|
|
74
|
-
};
|
|
75
|
-
|
|
76
|
-
const emit = async () => {
|
|
77
|
-
throw new Error("Cannot emit from Realtime database socket.");
|
|
78
|
-
};
|
|
79
|
-
|
|
80
|
-
return {
|
|
81
|
-
open,
|
|
82
|
-
reconnectionAttempts,
|
|
83
|
-
listeners,
|
|
84
|
-
connecting,
|
|
85
|
-
listen,
|
|
86
|
-
removeListener,
|
|
87
|
-
emit,
|
|
88
|
-
connect,
|
|
89
|
-
reconnect,
|
|
90
|
-
disconnect,
|
|
91
|
-
};
|
|
92
|
-
};
|
|
93
|
-
};
|
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
import { Reference } from "firebase-admin/lib/database";
|
|
2
|
-
|
|
3
|
-
import { RealtimePermittedMethods, RealtimeQueryConstraints, SharedQueryConstraints } from "constraints";
|
|
4
|
-
|
|
5
|
-
export const applyRealtimeAdminConstraint = (ref: Reference, { type, values }: RealtimePermittedMethods) => {
|
|
6
|
-
switch (type) {
|
|
7
|
-
case RealtimeQueryConstraints.ORDER_BY_CHILD: {
|
|
8
|
-
const [value] = values;
|
|
9
|
-
return ref.orderByChild(value);
|
|
10
|
-
}
|
|
11
|
-
case RealtimeQueryConstraints.ORDER_BY_KEY: {
|
|
12
|
-
return ref.orderByKey();
|
|
13
|
-
}
|
|
14
|
-
case RealtimeQueryConstraints.ORDER_BY_VALUE: {
|
|
15
|
-
return ref.orderByValue();
|
|
16
|
-
}
|
|
17
|
-
case SharedQueryConstraints.START_AT: {
|
|
18
|
-
const [[value]] = values;
|
|
19
|
-
return ref.startAt(value);
|
|
20
|
-
}
|
|
21
|
-
case SharedQueryConstraints.START_AFTER: {
|
|
22
|
-
const [[value]] = values;
|
|
23
|
-
return ref.startAfter(value);
|
|
24
|
-
}
|
|
25
|
-
case SharedQueryConstraints.END_AT: {
|
|
26
|
-
const [[value]] = values;
|
|
27
|
-
return ref.endAt(value);
|
|
28
|
-
}
|
|
29
|
-
case SharedQueryConstraints.END_BEFORE: {
|
|
30
|
-
const [[value]] = values;
|
|
31
|
-
return ref.endBefore(value);
|
|
32
|
-
}
|
|
33
|
-
case RealtimeQueryConstraints.LIMIT_TO_FIRST: {
|
|
34
|
-
const [value] = values;
|
|
35
|
-
return ref.limitToFirst(value);
|
|
36
|
-
}
|
|
37
|
-
case RealtimeQueryConstraints.LIMIT_TO_LAST: {
|
|
38
|
-
const [value] = values;
|
|
39
|
-
return ref.limitToLast(value);
|
|
40
|
-
}
|
|
41
|
-
case RealtimeQueryConstraints.EQUAL_TO: {
|
|
42
|
-
const [value] = values;
|
|
43
|
-
return ref.equalTo(value);
|
|
44
|
-
}
|
|
45
|
-
default:
|
|
46
|
-
throw new Error(`Unknown method ${type}`);
|
|
47
|
-
}
|
|
48
|
-
};
|
|
49
|
-
|
|
50
|
-
export const applyRealtimeAdminConstraints = (ref: Reference, constraints: RealtimePermittedMethods[]) => {
|
|
51
|
-
return constraints.reduce((collection, constraint) => {
|
|
52
|
-
return applyRealtimeAdminConstraint(collection, constraint);
|
|
53
|
-
}, ref);
|
|
54
|
-
};
|
package/src/utils/cache.utils.ts
DELETED
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
import { RequestInstance } from "@hyper-fetch/core";
|
|
2
|
-
|
|
3
|
-
export const setCacheManually = <R extends RequestInstance>(
|
|
4
|
-
request: R,
|
|
5
|
-
response: { value: any; status: "success" | "error" | "emptyResource" },
|
|
6
|
-
extra,
|
|
7
|
-
) => {
|
|
8
|
-
if (["success", "emptyResource"].includes(response.status)) {
|
|
9
|
-
request.client.cache.set(request, {
|
|
10
|
-
data: response.value,
|
|
11
|
-
status: "success",
|
|
12
|
-
error: null,
|
|
13
|
-
success: true,
|
|
14
|
-
extra,
|
|
15
|
-
isCanceled: false,
|
|
16
|
-
isOffline: false,
|
|
17
|
-
retries: 0,
|
|
18
|
-
timestamp: +new Date(),
|
|
19
|
-
});
|
|
20
|
-
} else {
|
|
21
|
-
request.client.cache.set(request, {
|
|
22
|
-
data: null,
|
|
23
|
-
status: "error",
|
|
24
|
-
error: response.value,
|
|
25
|
-
success: false,
|
|
26
|
-
extra,
|
|
27
|
-
isCanceled: false,
|
|
28
|
-
isOffline: false,
|
|
29
|
-
retries: 0,
|
|
30
|
-
timestamp: +new Date(),
|
|
31
|
-
});
|
|
32
|
-
}
|
|
33
|
-
};
|
|
File without changes
|
|
File without changes
|
|
File without changes
|