@taruvi/refine-providers 1.0.10 → 1.1.1

package/README.md

@@ -16,6 +16,8 @@ import {
   Client,
   dataProvider,
   storageDataProvider,
+  appDataProvider,
+  userDataProvider,
   authProvider,
   accessControlProvider,
 } from "@taruvi/refine-providers";
@@ -53,7 +55,8 @@ This package includes multiple specialized data providers:
 | `dataProvider` | Database CRUD operations | `Database` | `useList`, `useOne`, `useCreate`, etc. |
 | `storageDataProvider` | File storage operations | `Storage` | `useList`, `useCreate`, `useDelete` |
 | `functionsDataProvider` | Edge function execution | `Functions` | `useCreate` |
-| `appDataProvider` | App-level data (roles) | `App` | `useList` |
+| `appDataProvider` | App-level data (roles, settings) | `App` | `useList`, `useOne` |
+| `userDataProvider` | User-level data (users list, current user) | `User` | `useList`, `useOne` |
 | `analyticsDataProvider` | Analytics queries | `Analytics` | `useCreate` |
 
 ---
@@ -358,7 +361,7 @@ mutate({
 
 ## App Data Provider
 
-For fetching app-level data like roles.
+For fetching app-level data like roles and settings.
 
 ### Setup
 
@@ -384,6 +387,76 @@ const { data } = useList({
 // Returns: { data: [{ id, name, permissions, ... }], total: number }
 ```
 
+### Fetch Settings
+
+```tsx
+const { data } = useOne({
+  resource: "settings",
+  dataProviderName: "app",
+  id: "", // id is ignored for settings
+});
+
+// Returns: { data: { ...app settings object } }
+```
+
+---
+
+## User Data Provider
+
+For fetching user-level data including users list and current user details.
+
+### Setup
+
+```tsx
+import { userDataProvider, Client } from "@taruvi/refine-providers";
+
+<Refine
+  dataProvider={{
+    default: dataProvider(client),
+    user: userDataProvider(client),
+  }}
+/>
+```
+
+### Fetch Users List
+
+```tsx
+const { data } = useList({
+  resource: "users",
+  dataProviderName: "user",
+  pagination: { currentPage: 1, pageSize: 10 },
+  filters: [
+    { field: "is_active", operator: "eq", value: true },
+    { field: "search", operator: "eq", value: "john" },
+  ],
+  sorters: [{ field: "username", order: "asc" }],
+});
+
+// Returns: { data: [{ id, username, email, first_name, last_name, ... }], total: number }
+```
+
+**Supported Filters:**
+
+| Filter | Type | Description |
+|--------|------|-------------|
+| `search` | string | Search by username, email, or name |
+| `is_active` | boolean | Filter by active status |
+| `is_staff` | boolean | Filter by staff status |
+| `is_superuser` | boolean | Filter by superuser status |
+| `is_deleted` | boolean | Filter by deleted status |
+
+### Get Current User
+
+```tsx
+const { data } = useOne({
+  resource: "me",
+  dataProviderName: "user",
+  id: "", // id is ignored for "me" resource
+});
+
+// Returns: { data: { id, username, email, first_name, last_name, full_name, is_active, is_staff, ... } }
+```
+
 ---
 
 ## Analytics Data Provider
@@ -591,6 +664,27 @@ For Cerbos, specify the entity type in resource meta:
 />
 ```
 
+### Override Entity Type at Runtime
+
+You can override the entity type directly in `useCan` params:
+
+```tsx
+// Override entityType for this specific check
+const { data } = useCan({
+  resource: "posts",
+  action: "edit",
+  params: {
+    id: 1,
+    entityType: "article", // Overrides resource.meta.entityType
+  },
+});
+```
+
+**Entity Type Resolution Priority:**
+1. `params.entityType` (direct override)
+2. `resource.meta.entityType` (from Refine config)
+3. Resource name (fallback)
+
 ---
 
 ## Multiple Data Providers
@@ -604,6 +698,7 @@ import {
   storageDataProvider,
   functionsDataProvider,
   appDataProvider,
+  userDataProvider,
   analyticsDataProvider,
 } from "@taruvi/refine-providers";
 
@@ -615,6 +710,7 @@ const client = new Client({ apiKey, appSlug, baseUrl });
     storage: storageDataProvider(client),
     functions: functionsDataProvider(client),
     app: appDataProvider(client),
+    user: userDataProvider(client),
     analytics: analyticsDataProvider(client),
   }}
 />
@@ -623,6 +719,8 @@ const client = new Client({ apiKey, appSlug, baseUrl });
 useList({ resource: "posts" }); // Uses default
 useList({ resource: "images", dataProviderName: "storage" });
 useList({ resource: "roles", dataProviderName: "app" });
+useList({ resource: "users", dataProviderName: "user" });
+useOne({ resource: "me", dataProviderName: "user", id: "" });
 
 // For functions and analytics, use useCreate:
 const { mutate } = useCreate();

package/dist/index.cjs

@@ -517,10 +517,18 @@ function appDataProvider(client) {
       throw new Error(`Unknown app resource: ${resource}. Supported resources: roles`);
     },
     getApiUrl: () => baseApiUrl,
-    // App resources are read-only
-    getOne: async () => {
-      throw new Error("getOne is not supported for app resources");
+    getOne: async (params) => {
+      const { resource } = params;
+      if (resource === "settings") {
+        const app = new sdk.App(client);
+        const response = await app.settings().execute();
+        return {
+          data: response
+        };
+      }
+      throw new Error(`Unknown app resource for getOne: ${resource}. Supported resources: settings`);
     },
+    // App resources are read-only
     getMany: async () => {
       throw new Error("getMany is not supported for app resources");
     },
@@ -547,32 +555,74 @@ function appDataProvider(client) {
     }
   };
 }
+function buildUserListFilters(filters, sorters, pagination) {
+  const result = {};
+  if (pagination && pagination.mode !== "off") {
+    if (pagination.currentPage) {
+      result.page = pagination.currentPage;
+    }
+    if (pagination.pageSize) {
+      result.page_size = pagination.pageSize;
+    }
+  }
+  if (filters) {
+    for (const filter of filters) {
+      if ("field" in filter) {
+        const field = filter.field;
+        const value = filter.value;
+        switch (field) {
+          case "search":
+            result.search = String(value);
+            break;
+          case "is_active":
+            result.is_active = Boolean(value);
+            break;
+          case "is_staff":
+            result.is_staff = Boolean(value);
+            break;
+          case "is_superuser":
+            result.is_superuser = Boolean(value);
+            break;
+          case "is_deleted":
+            result.is_deleted = Boolean(value);
+            break;
+        }
+      }
+    }
+  }
+  if (sorters && sorters.length > 0) {
+    const sorter = sorters[0];
+    result.ordering = sorter.order === "desc" ? `-${sorter.field}` : sorter.field;
+  }
+  return result;
+}
 function userDataProvider(client) {
   const config = client.getConfig();
   const baseApiUrl = `${config.baseUrl}/api/apps/${config.appSlug}`;
   return {
     getList: async (params) => {
-      const { resource } = params;
-      if (resource === "roles") {
-        const app = new sdk.App(client);
-        const response = await app.roles().execute();
+      const { resource, pagination, filters, sorters } = params;
+      if (resource === "users") {
+        const user = new sdk.User(client);
+        const userFilters = buildUserListFilters(filters, sorters, pagination);
+        const response = await user.list(userFilters);
         return {
           data: response.data || response,
-          total: response.total ?? (Array.isArray(response) ? response.length : response.data?.length ?? 0)
+          total: response.total
         };
       }
-      throw new Error(`Unknown user resource for getList: ${resource}. Supported resources: roles`);
+      throw new Error(`Unknown user resource for getList: ${resource}. Supported resources: users`);
     },
     getOne: async (params) => {
-      const { resource } = params;
-      if (resource === "me") {
+      const { resource, id } = params;
+      if (resource === "users") {
         const user = new sdk.User(client);
-        const response = await user.getUserData();
+        const response = await user.getUser(String(id));
         return {
           data: response
         };
       }
-      throw new Error(`Unknown user resource for getOne: ${resource}. Supported resources: me`);
+      throw new Error(`Unknown user resource for getOne: ${resource}. Supported resources: me, users`);
     },
     getApiUrl: () => baseApiUrl,
     // User resources are mostly read-only
@@ -863,7 +913,7 @@ function accessControlProvider(client, options) {
       if (!resource) {
         return { can: false, reason: "Resource not specified" };
       }
-      const entityType = params?.resource?.meta?.entityType;
+      const entityType = params?.entityType ?? params?.resource?.meta?.entityType;
       return permissionLoader.load({
         resource,
         action,