@svadmin/rest 0.2.1

package/README.md

@@ -0,0 +1,26 @@
+# @svadmin/rest
+
+Generic REST data provider for svadmin, bridging the official
+[`@refinedev/rest`](https://www.npmjs.com/package/@refinedev/rest) package.
+
+Use it when your API does not follow the Simple REST envelope but you still want
+declarative resource routing.
+
+## Install
+
+```bash
+bun add @svadmin/rest @refinedev/rest @nestjsx/crud-request
+```
+
+## Usage
+
+```ts
+import { createRestDataProvider } from '@svadmin/rest';
+
+const dataProvider = await createRestDataProvider('https://api.example.test');
+```
+
+All arguments are forwarded to `@refinedev/rest`; the result is adapted to the
+svadmin `DataProvider` contract.
+
+See `docs/architecture/admin-platform.md` for the platform model.

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@svadmin/rest",
+  "version": "0.2.1",
+  "description": "Generic REST adapters — bridge @refinedev/rest to a svadmin DataProvider",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "src/**/*.ts",
+    "!src/**/*.test.*",
+    "!src/**/*.spec.*",
+    "!src/**/vitest.config.*",
+    "!src/**/setupTest.*"
+  ],
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "default": "./src/index.ts"
+    }
+  },
+  "svadmin": {
+    "capabilities": [
+      "data",
+      "rest",
+      "custom-endpoints"
+    ],
+    "core": "^0.55.0",
+    "stability": "experimental",
+    "migration": null
+  },
+  "peerDependencies": {
+    "@svadmin/core": "^0.58.0",
+    "@refinedev/rest": "^2.1.1",
+    "@nestjsx/crud-request": "^5.0.0-alpha.3"
+  },
+  "license": "MIT",
+  "author": "zuohuadong",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vibeunion/svadmin.git",
+    "directory": "packages/rest"
+  },
+  "homepage": "https://github.com/vibeunion/svadmin#readme",
+  "bugs": {
+    "url": "https://github.com/vibeunion/svadmin/issues"
+  },
+  "peerDependenciesMeta": {
+    "@svadmin/core": {
+      "optional": true
+    },
+    "@refinedev/rest": {
+      "optional": true
+    },
+    "@nestjsx/crud-request": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@svadmin/refine-adapter": "^0.12.2"
+  },
+  "devDependencies": {
+    "@refinedev/rest": "^2.1.1"
+  }
+}

package/src/data-provider.ts

@@ -0,0 +1,39 @@
+import type { DataProvider } from '@svadmin/core';
+import { createRefineAdapter } from '@svadmin/refine-adapter';
+
+/**
+ * Creates a data provider from the official `@refinedev/rest` package.
+ * Requires `@refinedev/rest` (and its peer `@nestjsx/crud-request`) to be
+ * installed. The generic provider is useful for custom REST endpoints that do
+ * not match the Simple REST envelope.
+ *
+ * @param args Arguments required by `@refinedev/rest`
+ * @returns A fully compatible svadmin DataProvider
+ */
+export async function createRestDataProvider(...args: unknown[]): Promise<DataProvider> {
+  const pkg = await import('@refinedev/rest');
+  const init = resolveInitializer(pkg);
+  const created = init(...args);
+  const refineProvider = isProviderBundle(created)
+    ? created.dataProvider
+    : created;
+  return createRefineAdapter(refineProvider);
+}
+
+export type RestDataProviderArgs = unknown[];
+
+function resolveInitializer(pkg: unknown): (...args: unknown[]) => unknown {
+  if (typeof pkg !== 'object' || pkg === null) throw new TypeError('Invalid REST provider module');
+  const exports = pkg as Record<string, unknown>;
+  for (const key of ['createDataProvider', 'default', 'dataProvider', 'DataProvider']) {
+    const candidate = exports[key];
+    if (typeof candidate === 'function') return candidate as (...args: unknown[]) => unknown;
+  }
+  throw new Error('[svadmin] Failed to resolve @refinedev/rest. Ensure the package is installed correctly.');
+}
+
+function isProviderBundle(value: unknown): value is { dataProvider: unknown } {
+  return typeof value === 'object'
+    && value !== null
+    && 'dataProvider' in value;
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export { createRestDataProvider } from './data-provider';
+export type { RestDataProviderArgs } from './data-provider';