fix: 🐛 Removed admin adapters from hyper-fetch/firebase package

Author: GerasNyx

.husky/pre-commit

@@ -5,4 +5,4 @@ yarn commitlint --edit "$1"
 yarn nx run-many --target=build --all --exclude=next,reactjs
 yarn nx run-many --target=lint --all --exclude=next,reactjs --parallel=10
 yarn nx run-many --target=typecheck --all --parallel=10
-yarn nx run-many --target=tests --all --exclude=adapter-firebase
+yarn nx run-many --target=tests --all --exclude=adapter-firebase,adapter-firebase-admin

documentation/docs/documentation/05-adapters/firebase/01-introduction.mdx

@@ -4,18 +4,18 @@ title: Firebase introduction
 sidebar_label: Introduction
 ---
 
-Hyper Fetch `firebase` package is a complete integration of `realtime database` and `firestore`, both for frontend and
-backend. It offers single, unified approach for all of them.
+Hyper Fetch `firebase` packages offer complete integration of `realtime database` and `firestore`, both for frontend and
+backend, with a single, unified approach for all of them.
 
 ## Getting Started
 
 In order to start using the firebase adapter, you have to initialize the firestore/realtime database and set the correct
 adapter on the `client`.
 
-There are two adapters to chose from:
+There are two subpackage to chose from:
 
-1. `firebaseAdapter` - for working with web realtime and firestore databases.
-2. `firebaseAdminAdapter` - for admin versions of the packages.
+1. `@hyper-fetch/firebase` - for admin versions of the packages.
+2. `@hyper-fetch/firebase-admin` - for working with web realtime and firestore databases.
 
 ```tsx
 import { firebaseAdapter } from "@hyper-fetch/firebase";
@@ -39,6 +39,13 @@ const getReq = client.createRequest<Tea[]>()({
 const { data, status, extra, success, error } = await getReq.send();
 ```
 
+In case of firebase admin, the only difference is in the import:
+
+```tsx
+import { firebaseAdminAdapter } from "@hyper-fetch/firebase-admin";
+...
+```
+
 Resulting `response` is an object that contains the following properties:
 
 1. `data` - data returned from the database

packages/adapter-firebase-admin/__tests__/features/firestore/shared/methods/on-snapshot.test.suite.ts

@@ -8,7 +8,7 @@ import { Tea } from "../../../../utils";
 
 export const onSnapshotTestSuite = (
   adapter: FirebaseAdminSocketAdapterTypes<any>,
-  coreAdapter: FirebaseAdminAdapterTypes<any>,
+  coreAdapter: () => FirebaseAdminAdapterTypes<any>,
 ) => {
   const newData = { origin: "Poland", type: "Green", year: 2043, name: "Pou Ran Do Cha", amount: 100 } as Tea;
   let spy = jest.fn();

packages/adapter-firebase-admin/src/firestore/utils/constraints.utils.ts

@@ -1,4 +1,4 @@
-import { CollectionReference, DocumentReference, Firestore } from "firebase-admin/lib/firestore";
+import { CollectionReference } from "firebase-admin/lib/firestore";
 import { OrderByDirection } from "firebase/firestore";
 
 import { FirestorePermittedMethods, FirestoreQueryConstraints, SharedQueryConstraints } from "../../constraints";

packages/adapter-firebase/__tests__/features/firestore/admin/constraints.admin.spec.ts

@@ -1,11 +1,4 @@
-import {
-  firebaseAdminAdapter,
-  firebaseAdapter,
-  FirebaseBrowserAdapterTypes,
-  FirebaseAdminAdapterTypes,
-  FirebaseAdminSocketAdapterTypes,
-  FirebaseBrowserSocketAdapterTypes,
-} from "adapter";
+import { firebaseAdapter, FirebaseBrowserAdapterTypes, FirebaseBrowserSocketAdapterTypes } from "adapter";
 import { addDocTestSuite } from "./methods/add-doc.test.suite";
 import { deleteDocTestSuite } from "./methods/delete-doc.test.suite";
 import { getDocTestSuite } from "./methods/get-doc.test.suite";
@@ -14,9 +7,7 @@ import { setDocTestSuite } from "./methods/set-doc.test.suite";
 import { updateDocTestSuite } from "./methods/update-doc.test.suite";
 import { onSnapshotTestSuite } from "./methods/on-snapshot.test.suite";
 
-export const methodsSharedTestCases = (
-  adapterFunction: () => ReturnType<typeof firebaseAdapter> | ReturnType<typeof firebaseAdminAdapter>,
-) => {
+export const methodsSharedTestCases = (adapterFunction: () => ReturnType<typeof firebaseAdapter>) => {
   addDocTestSuite(adapterFunction);
   deleteDocTestSuite(adapterFunction);
   getDocTestSuite(adapterFunction);
@@ -26,8 +17,8 @@ export const methodsSharedTestCases = (
 };
 
 export const socketsMethodsSharedTestCases = (
-  adapter: FirebaseAdminSocketAdapterTypes<any> | FirebaseBrowserSocketAdapterTypes<any>,
-  coreAdapter: () => FirebaseBrowserAdapterTypes<any> | FirebaseAdminAdapterTypes<any>,
+  adapter: FirebaseBrowserSocketAdapterTypes<any>,
+  coreAdapter: () => FirebaseBrowserAdapterTypes<any>,
 ) => {
   onSnapshotTestSuite(adapter, coreAdapter);
 };

packages/adapter-firebase/__tests__/features/firestore/admin/methods.admin.spec.ts

@@ -1,11 +1,9 @@
 import { Client } from "@hyper-fetch/core";
 
-import { firebaseAdminAdapter, firebaseAdapter } from "adapter";
-import { Tea } from "../../../../utils/seed/seed.data";
+import { firebaseAdapter } from "adapter";
+import { Tea } from "../../../../utils";
 
-export const addDocTestSuite = (
-  adapterFunction: () => ReturnType<typeof firebaseAdapter> | ReturnType<typeof firebaseAdminAdapter>,
-) => {
+export const addDocTestSuite = (adapterFunction: () => ReturnType<typeof firebaseAdapter>) => {
   describe("addDoc", () => {
     it("should allow for adding data to a list", async () => {
       const newData = { origin: "Poland", type: "Green", year: 2023, name: "Pou Ran Do Cha", amount: 100 } as Tea;

packages/adapter-firebase/__tests__/features/firestore/admin/sockets.base.spec.ts

@@ -1,12 +1,10 @@
 import { Client } from "@hyper-fetch/core";
 
-import { firebaseAdminAdapter, firebaseAdapter } from "adapter";
-import { Tea } from "../../../../utils/seed/seed.data";
+import { firebaseAdapter } from "adapter";
+import { Tea } from "../../../../utils";
 import { testLifecycleEvents } from "../../../../shared/request-events.shared";
 
-export const deleteDocTestSuite = (
-  adapterFunction: () => ReturnType<typeof firebaseAdapter> | ReturnType<typeof firebaseAdminAdapter>,
-) => {
+export const deleteDocTestSuite = (adapterFunction: () => ReturnType<typeof firebaseAdapter>) => {
   describe("deleteDoc", () => {
     it("should allow for removing data", async () => {
       const client = new Client({ url: "teas/" }).setAdapter(adapterFunction());

packages/adapter-firebase/__tests__/features/firestore/shared/methods.shared.tests.ts

@@ -1,12 +1,10 @@
 import { Client } from "@hyper-fetch/core";
 
-import { firebaseAdminAdapter, firebaseAdapter } from "adapter";
-import { Tea } from "../../../../utils/seed/seed.data";
+import { firebaseAdapter } from "adapter";
+import { Tea } from "../../../../utils";
 import { testLifecycleEvents } from "../../../../shared/request-events.shared";
 
-export const getDocTestSuite = (
-  adapterFunction: () => ReturnType<typeof firebaseAdapter> | ReturnType<typeof firebaseAdminAdapter>,
-) => {
+export const getDocTestSuite = (adapterFunction: () => ReturnType<typeof firebaseAdapter>) => {
   describe("getDoc", () => {
     it("should return data available for endpoint", async () => {
       const client = new Client({ url: "teas/" }).setAdapter(adapterFunction());

packages/adapter-firebase/__tests__/features/firestore/shared/methods/add-doc.test.suite.ts

@@ -1,12 +1,10 @@
 import { Client } from "@hyper-fetch/core";
 
-import { firebaseAdminAdapter, firebaseAdapter } from "adapter";
-import { Tea } from "../../../../utils/seed/seed.data";
+import { firebaseAdapter } from "adapter";
+import { Tea } from "../../../../utils";
 import { testLifecycleEvents } from "../../../../shared/request-events.shared";
 
-export const getDocsTestSuite = (
-  adapterFunction: () => ReturnType<typeof firebaseAdapter> | ReturnType<typeof firebaseAdminAdapter>,
-) => {
+export const getDocsTestSuite = (adapterFunction: () => ReturnType<typeof firebaseAdapter>) => {
   describe("getDocs", () => {
     it("should return data available for endpoint", async () => {
       const client = new Client({ url: "teas/" }).setAdapter(adapterFunction());

packages/adapter-firebase/__tests__/features/firestore/shared/methods/delete-doc.test.suite.ts

@@ -2,18 +2,13 @@ import { Client } from "@hyper-fetch/core";
 import { Socket } from "@hyper-fetch/sockets";
 import waitForExpect from "wait-for-expect";
 
-import {
-  FirebaseAdminAdapterTypes,
-  FirebaseBrowserAdapterTypes,
-  FirebaseBrowserSocketAdapterTypes,
-  FirebaseAdminSocketAdapterTypes,
-} from "adapter";
+import { FirebaseBrowserAdapterTypes, FirebaseBrowserSocketAdapterTypes } from "adapter";
 import { $where } from "constraints";
 import { Tea } from "../../../../utils";
 
 export const onSnapshotTestSuite = (
-  adapter: FirebaseAdminSocketAdapterTypes<any> | FirebaseBrowserSocketAdapterTypes<any>,
-  coreAdapter: () => FirebaseBrowserAdapterTypes<any> | FirebaseAdminAdapterTypes<any>,
+  adapter: FirebaseBrowserSocketAdapterTypes<any>,
+  coreAdapter: () => FirebaseBrowserAdapterTypes<any>,
 ) => {
   const newData = { origin: "Poland", type: "Green", year: 2043, name: "Pou Ran Do Cha", amount: 100 } as Tea;
   let spy = jest.fn();

packages/adapter-firebase/__tests__/features/firestore/shared/methods/get-doc.test.suite.ts

@@ -1,12 +1,10 @@
 import { Client } from "@hyper-fetch/core";
 
-import { Tea } from "../../../../utils/seed/seed.data";
-import { firebaseAdminAdapter, firebaseAdapter } from "adapter";
+import { Tea } from "../../../../utils";
+import { firebaseAdapter } from "adapter";
 import { testLifecycleEvents } from "../../../../shared/request-events.shared";
 
-export const setDocTestSuite = (
-  adapterFunction: () => ReturnType<typeof firebaseAdapter> | ReturnType<typeof firebaseAdminAdapter>,
-) => {
+export const setDocTestSuite = (adapterFunction: () => ReturnType<typeof firebaseAdapter>) => {
   describe("setDoc", () => {
     it("should set data", async () => {
       const newData = { origin: "Poland", type: "Green", year: 2023, name: "Pou Ran Do Cha", amount: 10 } as Tea;

packages/adapter-firebase/__tests__/features/firestore/shared/methods/get-docs.test.suite.ts

@@ -1,12 +1,10 @@
 import { Client } from "@hyper-fetch/core";
 
-import { firebaseAdminAdapter, firebaseAdapter } from "adapter";
-import { Tea } from "../../../../utils/seed/seed.data";
+import { firebaseAdapter } from "adapter";
+import { Tea } from "../../../../utils";
 import { testLifecycleEvents } from "../../../../shared/request-events.shared";
 
-export const updateDocTestSuite = (
-  adapterFunction: () => ReturnType<typeof firebaseAdapter> | ReturnType<typeof firebaseAdminAdapter>,
-) => {
+export const updateDocTestSuite = (adapterFunction: () => ReturnType<typeof firebaseAdapter>) => {
   describe("updateDoc", () => {
     it("should allow for updating data", async () => {
       const newData = { name: "Pou Ran Do Cha", amount: 100, year: 966 } as Tea;

packages/adapter-firebase/__tests__/features/firestore/shared/methods/on-snapshot.test.suite.ts

@@ -1,11 +1,10 @@
 import { Client } from "@hyper-fetch/core";
 
-import { $endAt, $limitToFirst, $orderByChild, $startAt, firebaseAdminAdapter, firebaseAdapter } from "../../../../src";
-import { Tea } from "../../../utils/seed/seed.data";
+import { $endAt, $limitToFirst, $orderByChild, $startAt } from "constraints";
+import { firebaseAdapter } from "adapter";
+import { Tea } from "../../../utils";
 
-export const constraintsSharedTestCases = (
-  adapterFunction: () => ReturnType<typeof firebaseAdapter> | ReturnType<typeof firebaseAdminAdapter>,
-) => {
+export const constraintsSharedTestCases = (adapterFunction: () => ReturnType<typeof firebaseAdapter>) => {
   describe("Ordering", () => {
     it("Should allow ordering by child", async () => {
       const client = new Client({ url: "teas/" }).setAdapter(adapterFunction());

packages/adapter-firebase/__tests__/features/firestore/shared/methods/set-doc.test.suite.ts

@@ -1,21 +1,12 @@
-import {
-  firebaseAdminAdapter,
-  firebaseAdapter,
-  FirebaseAdminAdapterTypes,
-  FirebaseBrowserAdapterTypes,
-  FirebaseBrowserSocketAdapterTypes,
-  FirebaseAdminSocketAdapterTypes,
-} from "adapter";
+import { firebaseAdapter, FirebaseBrowserAdapterTypes, FirebaseBrowserSocketAdapterTypes } from "adapter";
 import { getTestSuite } from "./methods/get.test.suite";
 import { setTestSuite } from "./methods/set.test.suite";
 import { pushTestSuite } from "./methods/push.test.suite";
 import { updateTestSuite } from "./methods/update.test.suite";
 import { removeTestSuite } from "./methods/remove.test.suite";
 import { onValueTestSuite } from "./methods/on-value.test.suite";
 
-export const methodsSharedTestCases = (
-  adapterFunction: () => ReturnType<typeof firebaseAdapter> | ReturnType<typeof firebaseAdminAdapter>,
-) => {
+export const methodsSharedTestCases = (adapterFunction: () => ReturnType<typeof firebaseAdapter>) => {
   getTestSuite(adapterFunction);
   setTestSuite(adapterFunction);
   pushTestSuite(adapterFunction);
@@ -26,8 +17,8 @@ export const methodsSharedTestCases = (
 export const socketsMethodsSharedTestCases = (
   db,
   seedDbMethod: (db) => Promise<void>,
-  socketsAdapter: (database) => FirebaseBrowserSocketAdapterTypes<any> | FirebaseAdminSocketAdapterTypes<any>,
-  coreAdapter: (database) => () => FirebaseBrowserAdapterTypes<any> | FirebaseAdminAdapterTypes<any>,
+  socketsAdapter: (database) => FirebaseBrowserSocketAdapterTypes<any>,
+  coreAdapter: (database) => () => FirebaseBrowserAdapterTypes<any>,
 ) => {
   onValueTestSuite(db, seedDbMethod, socketsAdapter, coreAdapter);
 };

packages/adapter-firebase/__tests__/features/firestore/shared/methods/update-doc.test.suite.ts

@@ -1,12 +1,10 @@
 import { Client } from "@hyper-fetch/core";
 
-import { firebaseAdminAdapter, firebaseAdapter } from "adapter";
+import { firebaseAdapter } from "adapter";
 import { testLifecycleEvents } from "../../../../shared/request-events.shared";
-import { Tea } from "../../../../utils/seed/seed.data";
+import { Tea } from "../../../../utils";
 
-export const getTestSuite = (
-  adapterFunction: () => ReturnType<typeof firebaseAdapter> | ReturnType<typeof firebaseAdminAdapter>,
-) => {
+export const getTestSuite = (adapterFunction: () => ReturnType<typeof firebaseAdapter>) => {
   describe("get", () => {
     let client = new Client({ url: "teas/" }).setAdapter(adapterFunction());
     let clientBees = new Client({ url: "bees/" }).setAdapter(adapterFunction());