@svadmin/firebase 0.9.3 → 0.9.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@svadmin/firebase",
-  "version": "0.9.3",
+  "version": "0.9.5",
   "description": "Firebase DataProvider for svadmin",
   "type": "module",
   "sideEffects": false,
@@ -16,12 +16,21 @@
     }
   },
   "peerDependencies": {
-    "@svadmin/core": "^0.19.4"
+    "@svadmin/core": "^0.23.3",
+    "@svadmin/refine-adapter": "^0.9.3"
   },
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/zuohuadong/svadmin.git",
     "directory": "packages/firebase"
+  },
+  "peerDependenciesMeta": {
+    "@svadmin/core": {
+      "optional": true
+    },
+    "@svadmin/refine-adapter": {
+      "optional": true
+    }
   }
 }

package/src/data-provider.ts

@@ -1,122 +1,13 @@
-import type {
-  DataProvider, GetListParams, GetListResult, GetOneParams, GetOneResult,
-  CreateParams, CreateResult, UpdateParams, UpdateResult, DeleteParams, DeleteResult,
-  GetManyParams, GetManyResult, CustomParams, CustomResult, Filter
-, BaseRecord } from '@svadmin/core';
-
-interface FirestoreFieldValue {
-  stringValue?: string;
-  integerValue?: string;
-  doubleValue?: number;
-  booleanValue?: boolean;
-  timestampValue?: string;
-  nullValue?: null;
-  mapValue?: unknown;
-  arrayValue?: { values?: unknown[] };
-}
-
-interface FirestoreDoc {
-  name?: string;
-  fields?: Record<string, FirestoreFieldValue>;
-}
-
-// Firebase REST API (Firestore REST v1)
-function buildFirestoreUrl(projectId: string, collection: string, docId?: string | number): string {
-  const base = `https://firestore.googleapis.com/v1/projects/${projectId}/databases/(default)/documents/${collection}`;
-  return docId ? `${base}/${docId}` : base;
-}
-
-function parseFirestoreDoc(doc: FirestoreDoc): Record<string, unknown> {
-  const fields = doc.fields ?? {};
-  const parsed: Record<string, unknown> = {};
-  for (const [key, val] of Object.entries(fields) as [string, FirestoreFieldValue][]) {
-    if ('stringValue' in val) parsed[key] = val.stringValue;
-    else if ('integerValue' in val) parsed[key] = Number(val.integerValue);
-    else if ('doubleValue' in val) parsed[key] = val.doubleValue;
-    else if ('booleanValue' in val) parsed[key] = val.booleanValue;
-    else if ('timestampValue' in val) parsed[key] = val.timestampValue;
-    else if ('nullValue' in val) parsed[key] = null;
-    else if ('mapValue' in val) parsed[key] = val.mapValue;
-    else if ('arrayValue' in val) parsed[key] = val.arrayValue?.values ?? [];
-    else parsed[key] = val;
-  }
-  // Extract document ID from name path
-  const nameParts = (doc.name ?? '').split('/');
-  parsed['id'] = nameParts[nameParts.length - 1];
-  return parsed;
-}
-
-function toFirestoreFields(data: Record<string, unknown>): Record<string, unknown> {
-  const fields: Record<string, unknown> = {};
-  for (const [key, val] of Object.entries(data)) {
-    if (key === 'id') continue;
-    if (typeof val === 'string') fields[key] = { stringValue: val };
-    else if (typeof val === 'number') fields[key] = Number.isInteger(val) ? { integerValue: String(val) } : { doubleValue: val };
-    else if (typeof val === 'boolean') fields[key] = { booleanValue: val };
-    else if (val === null) fields[key] = { nullValue: null };
-    else if (Array.isArray(val)) fields[key] = { arrayValue: { values: val } };
-    else if (typeof val === 'object') fields[key] = { mapValue: { fields: toFirestoreFields(val as Record<string, unknown>) } };
-  }
-  return fields;
-}
-
-export function createFirebaseDataProvider(projectId: string, apiKey: string): DataProvider {
-  const authHeaders = { 'Content-Type': 'application/json' };
-
-  return {
-    getApiUrl: () => `https://firestore.googleapis.com/v1/projects/${projectId}`,
-
-    async getList<T extends BaseRecord = BaseRecord>({ resource, pagination }: GetListParams): Promise<GetListResult<T>> {
-      const { pageSize = 20 } = pagination ?? {};
-      const url = `${buildFirestoreUrl(projectId, resource)}?pageSize=${pageSize}&key=${apiKey}`;
-      const res = await fetch(url, { headers: authHeaders });
-      if (!res.ok) throw new Error(`Firebase error: ${res.status}`);
-      const data = await res.json();
-      const docs = (data.documents ?? []).map(parseFirestoreDoc);
-      return { data: docs as unknown as T[], total: docs.length };
-    },
-
-    async getOne<T extends BaseRecord = BaseRecord>({ resource, id }: GetOneParams): Promise<GetOneResult<T>> {
-      const res = await fetch(`${buildFirestoreUrl(projectId, resource, id)}?key=${apiKey}`, { headers: authHeaders });
-      if (!res.ok) throw new Error(`Firebase error: ${res.status}`);
-      return { data: parseFirestoreDoc(await res.json()) as unknown as T };
-    },
-
-    async create<T extends BaseRecord = BaseRecord>({ resource, variables }: CreateParams): Promise<CreateResult<T>> {
-      const res = await fetch(`${buildFirestoreUrl(projectId, resource)}?key=${apiKey}`, {
-        method: 'POST', headers: authHeaders, body: JSON.stringify({ fields: toFirestoreFields(variables as Record<string, unknown>) }),
-      });
-      if (!res.ok) throw new Error(`Firebase error: ${res.status}`);
-      return { data: parseFirestoreDoc(await res.json()) as unknown as T };
-    },
-
-    async update<T extends BaseRecord = BaseRecord>({ resource, id, variables }: UpdateParams): Promise<UpdateResult<T>> {
-      const res = await fetch(`${buildFirestoreUrl(projectId, resource, id)}?key=${apiKey}`, {
-        method: 'PATCH', headers: authHeaders, body: JSON.stringify({ fields: toFirestoreFields(variables as Record<string, unknown>) }),
-      });
-      if (!res.ok) throw new Error(`Firebase error: ${res.status}`);
-      return { data: parseFirestoreDoc(await res.json()) as unknown as T };
-    },
-
-    async deleteOne<T extends BaseRecord = BaseRecord>({ resource, id }: DeleteParams): Promise<DeleteResult<T>> {
-      const res = await fetch(`${buildFirestoreUrl(projectId, resource, id)}?key=${apiKey}`, { method: 'DELETE', headers: authHeaders });
-      if (!res.ok) throw new Error(`Firebase error: ${res.status}`);
-      return { data: { id } as unknown as T };
-    },
-
-    async getMany<T extends BaseRecord = BaseRecord>({ resource, ids }: GetManyParams): Promise<GetManyResult<T>> {
-      const results = await Promise.all(ids.map(async (id: string | number) => {
-        const res = await fetch(`${buildFirestoreUrl(projectId, resource, id)}?key=${apiKey}`, { headers: authHeaders });
-        if (!res.ok) throw new Error(`Firebase error: ${res.status}`);
-        return parseFirestoreDoc(await res.json()) as unknown as T;
-      }));
-      return { data: results };
-    },
-
-    async custom<T = unknown>({ url, method, payload, headers: h }: CustomParams): Promise<CustomResult<T>> {
-      const res = await fetch(url, { method: method.toUpperCase(), headers: { ...authHeaders, ...h }, body: payload ? JSON.stringify(payload) : undefined });
-      if (!res.ok) throw new Error(`Custom request failed: ${res.status}`);
-      return { data: (await res.json()) as unknown as T };
-    },
-  };
+import type { DataProvider } from '@svadmin/core';
+import { createRefineAdapter } from '@svadmin/refine-adapter';
+// Note: @refinedev/simple-rest is often used as the base for custom Firebase REST, 
+// but here we intend to wrap the proper Firebase package.
+// We expect the user to pass initialized Firebase instances depending on the 
+// specific refinedev package used (e.g., @refinedev/firebase).
+
+// Since refine doesn't have a single official "firestore" package in monorepo often, 
+// they usually have community packages or one you can use. 
+// Assuming a generic `RefineFirebaseProvider` exists.
+export function createFirebaseDataProvider(firebaseDataProvider: any): DataProvider {
+  return createRefineAdapter(firebaseDataProvider);
 }

package/src/firebase.test.ts

@@ -0,0 +1,45 @@
+import { describe, test, expect } from 'bun:test';
+import { createFirebaseDataProvider } from './data-provider';
+
+describe('Firebase DataProvider', () => {
+    // Mock the raw output from a refine-firebase DataProvider
+    const mockRefineProvider = {
+      getList: async () => ({ data: [{ id: 'doc-1', title: 'Test' }], total: 1 }),
+      getOne: async () => ({ data: { id: 'doc-1', title: 'Test' } }),
+      create: async (params: any) => ({ data: { id: 'doc-2', ...params.variables } }),
+      update: async (params: any) => ({ data: { id: params.id, ...params.variables } }),
+      deleteOne: async (params: any) => ({ data: { id: params.id } }),
+    };
+
+    const dp = createFirebaseDataProvider(mockRefineProvider);
+
+    test('getList routes to wrapped provider', async () => {
+      expect(dp).toBeDefined();
+      const res = await dp.getList({ resource: 'posts' });
+      expect(res.data).toHaveLength(1);
+      expect(res.data[0].id).toBe('doc-1');
+      expect(res.total).toBe(1);
+    });
+
+    test('getOne routes to wrapped provider', async () => {
+      const res = await dp.getOne({ resource: 'posts', id: 'doc-1' });
+      expect(res.data.id).toBe('doc-1');
+    });
+
+    test('create routes to wrapped provider', async () => {
+      const res = await dp.create({ resource: 'posts', variables: { key: 'val' } });
+      expect(res.data.id).toBe('doc-2');
+      expect(res.data.key).toBe('val');
+    });
+
+    test('update routes to wrapped provider', async () => {
+      const res = await dp.update({ resource: 'posts', id: 'doc-1', variables: { key: 'newVal' } });
+      expect(res.data.id).toBe('doc-1');
+      expect(res.data.key).toBe('newVal');
+    });
+
+    test('deleteOne routes to wrapped provider', async () => {
+      const res = await dp.deleteOne({ resource: 'posts', id: 'doc-1' });
+      expect(res.data.id).toBe('doc-1');
+    });
+});