@svadmin/refine-adapter 0.9.3 → 0.10.1

package/README.md

@@ -0,0 +1,88 @@
+# @svadmin/refine-adapter
+
+> Bridge any [@refinedev](https://github.com/refinedev/refine) data provider to svadmin
+
+[![npm](https://img.shields.io/npm/v/@svadmin/refine-adapter?color=ff3e00&label=npm)](https://www.npmjs.com/package/@svadmin/refine-adapter)
+
+## Why?
+
+[Refine](https://refine.dev/) has a rich ecosystem of battle-tested data providers for services like Supabase, Appwrite, Hasura, Strapi, Airtable, NestJS, and more. `@svadmin/refine-adapter` lets you use **any** of those providers inside svadmin — zero rewrite required.
+
+Since Refine's `DataProvider` interface closely mirrors svadmin's `DataProvider`, the adapter is a thin bridge that binds method calls and forwards optional methods when present.
+
+## Installation
+
+```bash
+bun add @svadmin/refine-adapter @svadmin/core
+```
+
+If your app is powered by Vite and also uses `@svadmin/ui` or `@svadmin/supabase`, exclude svadmin packages from `optimizeDeps` to avoid dev-time pre-bundling issues:
+
+```ts
+optimizeDeps: {
+  exclude: ['@svadmin/core', '@svadmin/ui', '@svadmin/supabase'],
+}
+```
+
+Then install the Refine data provider you want to use, e.g.:
+
+```bash
+bun add @refinedev/supabase
+bun add @refinedev/strapi-v4
+bun add @refinedev/appwrite
+```
+
+## Usage
+
+```typescript
+import { createRefineAdapter } from '@svadmin/refine-adapter';
+import { dataProvider as createRefineSupabase } from '@refinedev/supabase';
+import { createClient } from '@supabase/supabase-js';
+
+const supabaseClient = createClient(SUPABASE_URL, SUPABASE_KEY);
+const refineProvider = createRefineSupabase(supabaseClient);
+
+// Bridge it to svadmin
+const dataProvider = createRefineAdapter(refineProvider);
+```
+
+Then pass `dataProvider` to `<AdminApp>` or `setDataProvider()` as usual.
+
+## Supported Methods
+
+| Method | Required | Description |
+|--------|----------|-------------|
+| `getList` | ✅ | List with pagination, sorting, filtering |
+| `getOne` | ✅ | Get single record |
+| `create` | ✅ | Create record |
+| `update` | ✅ | Update record |
+| `deleteOne` | ✅ | Delete record |
+| `getApiUrl` | ✅ | Return API base URL |
+| `getMany` | Optional | Bulk get |
+| `createMany` | Optional | Bulk create |
+| `updateMany` | Optional | Bulk update |
+| `deleteMany` | Optional | Bulk delete |
+| `custom` | Optional | Custom endpoint |
+
+Optional methods are only wired if the underlying Refine provider implements them.
+
+## Which Svadmin Providers Use This?
+
+The following `@svadmin/*` packages internally use `@svadmin/refine-adapter` to bridge their corresponding `@refinedev/*` provider:
+
+| svadmin Package | Refine Package |
+|-----------------|---------------|
+| `@svadmin/supabase` | `@refinedev/supabase` |
+| `@svadmin/appwrite` | `@refinedev/appwrite` |
+| `@svadmin/strapi` | `@refinedev/strapi-v4` |
+| `@svadmin/hasura` | `@refinedev/hasura` |
+| `@svadmin/graphql` | `@refinedev/graphql` |
+| `@svadmin/airtable` | `@refinedev/airtable` |
+| `@svadmin/medusa` | `@refinedev/medusa` |
+| `@svadmin/nestjs-query` | `@refinedev/nestjs-query` |
+| `@svadmin/nestjsx-crud` | `@refinedev/nestjsx-crud` |
+| `@svadmin/simple-rest` | `@refinedev/simple-rest` |
+
+## License
+
+MIT

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@svadmin/refine-adapter",
-  "version": "0.9.3",
+  "version": "0.10.1",
   "description": "Universal Refine DataProvider adapter for svadmin",
   "type": "module",
   "sideEffects": false,
   "files": [
-    "src/**/*"
+    "src/**/*.ts",
+    "!src/**/*.test.*",
+    "!src/**/*.spec.*",
+    "!src/**/vitest.config.*",
+    "!src/**/setupTest.*"
   ],
   "main": "src/index.ts",
   "types": "src/index.ts",
@@ -16,12 +20,17 @@
     }
   },
   "peerDependencies": {
-    "@svadmin/core": "^0.21.0"
+    "@svadmin/core": "^0.34.2"
   },
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/zuohuadong/svadmin.git",
     "directory": "packages/refine-adapter"
+  },
+  "peerDependenciesMeta": {
+    "@svadmin/core": {
+      "optional": true
+    }
   }
 }

package/src/index.ts

@@ -1,22 +1,77 @@
 import type { DataProvider as SvadminDataProvider } from '@svadmin/core';
 
+type RequiredRefineDataProvider = Pick<
+  SvadminDataProvider,
+  'getList' | 'getOne' | 'create' | 'update' | 'deleteOne'
+>;
+
+type OptionalRefineDataProvider = Partial<
+  Pick<SvadminDataProvider, 'getApiUrl' | 'getMany' | 'createMany' | 'updateMany' | 'deleteMany' | 'custom'>
+>;
+
+export type RefineDataProviderLike = RequiredRefineDataProvider & OptionalRefineDataProvider;
+
+const requiredMethods = [
+  'getList',
+  'getOne',
+  'create',
+  'update',
+  'deleteOne',
+] as const satisfies readonly (keyof RequiredRefineDataProvider)[];
+
+const optionalMethods = [
+  'getMany',
+  'createMany',
+  'updateMany',
+  'deleteMany',
+  'custom',
+] as const satisfies readonly (keyof OptionalRefineDataProvider)[];
+
+function isObjectLike(value: unknown): value is Record<PropertyKey, unknown> {
+  return typeof value === 'object' && value !== null;
+}
+
+function assertRefineDataProvider(value: unknown): asserts value is RefineDataProviderLike {
+  if (!isObjectLike(value)) {
+    throw new Error('[svadmin] createRefineAdapter: expected a valid Refine DataProvider object, got ' + String(value));
+  }
+
+  for (const method of requiredMethods) {
+    if (typeof value[method] !== 'function') {
+      throw new Error(`[svadmin] createRefineAdapter: missing required Refine DataProvider method "${method}"`);
+    }
+  }
+}
+
 /**
  * Adapter to consume an official @refinedev/* data provider in SvelteAdmin.
- * Refine's DataProvider interface directly matches the core interface 
- * definition of @svadmin/core.
+ * Refine's DataProvider interface mostly matches the core interface
+ * definition of @svadmin/core, except for the current page property.
  */
-export function createRefineAdapter(refineProvider: any): SvadminDataProvider {
-  return {
-    getApiUrl: () => refineProvider.getApiUrl(),
-    getList: refineProvider.getList,
-    getOne: refineProvider.getOne,
-    create: refineProvider.create,
-    update: refineProvider.update,
-    deleteOne: refineProvider.deleteOne,
-    getMany: refineProvider.getMany,
-    createMany: refineProvider.createMany,
-    updateMany: refineProvider.updateMany,
-    deleteMany: refineProvider.deleteMany,
-    custom: refineProvider.custom,
-  } as SvadminDataProvider;
+export function createRefineAdapter(refineProvider: unknown): SvadminDataProvider {
+  assertRefineDataProvider(refineProvider);
+
+  const adapter: SvadminDataProvider = {
+    getApiUrl: () => refineProvider.getApiUrl?.() ?? '',
+    getList(params) {
+      const pagination = params.pagination?.current === undefined
+        ? params.pagination
+        : { ...params.pagination, currentPage: params.pagination.current };
+      return refineProvider.getList({ ...params, pagination });
+    },
+    getOne: refineProvider.getOne.bind(refineProvider),
+    create: refineProvider.create.bind(refineProvider),
+    update: refineProvider.update.bind(refineProvider),
+    deleteOne: refineProvider.deleteOne.bind(refineProvider),
+  };
+
+  // Only attach optional methods if they actually exist
+  for (const method of optionalMethods) {
+    const handler = refineProvider[method];
+    if (typeof handler === 'function') {
+      adapter[method] = handler.bind(refineProvider) as never;
+    }
+  }
+
+  return adapter;
 }

package/src/refinedev-optional.d.ts

@@ -0,0 +1,53 @@
+declare module '@refinedev/airtable' {
+  export const dataProvider: (...args: unknown[]) => unknown;
+  const defaultExport: (...args: unknown[]) => unknown;
+  export default defaultExport;
+}
+
+declare module '@refinedev/appwrite' {
+  export const dataProvider: (...args: unknown[]) => unknown;
+  const defaultExport: (...args: unknown[]) => unknown;
+  export default defaultExport;
+}
+
+declare module '@refinedev/graphql' {
+  export const dataProvider: (...args: unknown[]) => unknown;
+  const defaultExport: (...args: unknown[]) => unknown;
+  export default defaultExport;
+}
+
+declare module '@refinedev/hasura' {
+  export const dataProvider: (...args: unknown[]) => unknown;
+  const defaultExport: (...args: unknown[]) => unknown;
+  export default defaultExport;
+}
+
+declare module '@refinedev/medusa' {
+  export const dataProvider: (...args: unknown[]) => unknown;
+  const defaultExport: (...args: unknown[]) => unknown;
+  export default defaultExport;
+}
+
+declare module '@refinedev/nestjs-query' {
+  export const dataProvider: (...args: unknown[]) => unknown;
+  const defaultExport: (...args: unknown[]) => unknown;
+  export default defaultExport;
+}
+
+declare module '@refinedev/nestjsx-crud' {
+  export const dataProvider: (...args: unknown[]) => unknown;
+  const defaultExport: (...args: unknown[]) => unknown;
+  export default defaultExport;
+}
+
+declare module '@refinedev/strapi-v4' {
+  export const dataProvider: (...args: unknown[]) => unknown;
+  const defaultExport: (...args: unknown[]) => unknown;
+  export default defaultExport;
+}
+
+declare module '@refinedev/supabase' {
+  export const dataProvider: (...args: unknown[]) => unknown;
+  const defaultExport: (...args: unknown[]) => unknown;
+  export default defaultExport;
+}