@taruvi/refine-providers 1.1.6 → 1.1.8

package/README.md

@@ -12,8 +12,8 @@ npm install @taruvi/refine-providers @taruvi/sdk @refinedev/core
 
 ```tsx
 import { Refine } from "@refinedev/core";
+import { Client } from "@taruvi/sdk";
 import {
-  Client,
   dataProvider,
   storageDataProvider,
   appDataProvider,
@@ -52,7 +52,7 @@ This package includes multiple specialized data providers:
 
 | Provider | Purpose | SDK Class | Hook |
 |----------|---------|-----------|------|
-| `dataProvider` | Database CRUD operations | `Database` | `useList`, `useOne`, `useCreate`, etc. |
+| `dataProvider` | Database CRUD & Graph operations | `Database`, `Graph` | `useList`, `useOne`, `useCreate`, etc. |
 | `storageDataProvider` | File storage operations | `Storage` | `useList`, `useCreate`, `useDelete` |
 | `functionsDataProvider` | Edge function execution | `Functions` | `useCreate` |
 | `appDataProvider` | App-level data (roles, settings) | `App` | `useList`, `useOne` |
@@ -68,7 +68,8 @@ The main data provider for CRUD operations on database tables.
 ### Basic Usage
 
 ```tsx
-import { dataProvider, Client } from "@taruvi/refine-providers";
+import { Client } from "@taruvi/sdk";
+import { dataProvider } from "@taruvi/refine-providers";
 
 const client = new Client({ apiKey, appSlug, baseUrl });
 
@@ -192,6 +193,93 @@ const { data } = useList({
 });
 ```
 
+### Graph Operations
+
+The data provider supports graph traversal and edge management when graph meta options are provided.
+
+#### Reading Graph Data
+
+```tsx
+// Get graph structure for a record
+const { data } = useOne({
+  resource: "employees",
+  id: "1",
+  meta: {
+    format: "graph",        // 'tree' or 'graph'
+    include: "descendants", // 'descendants', 'ancestors', or 'both'
+    depth: 2,               // traversal depth
+    graph_types: ["manager", "mentor"], // filter by edge types
+  },
+});
+
+// List with graph format
+const { data } = useList({
+  resource: "employees",
+  meta: {
+    format: "tree",
+    include: "both",
+    depth: 3,
+  },
+});
+```
+
+#### Graph Meta Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `format` | `'tree' \| 'graph'` | Output format for graph data |
+| `include` | `'descendants' \| 'ancestors' \| 'both'` | Direction of graph traversal |
+| `depth` | `number` | How deep to traverse relationships |
+| `graph_types` | `string[]` | Filter edges by type |
+
+#### Managing Graph Edges
+
+When any graph meta option is present, mutation operations work with edges:
+
+```tsx
+// Create an edge
+const { mutate: createEdge } = useCreate();
+createEdge({
+  resource: "employees",
+  values: {
+    from_id: 1,
+    to_id: 2,
+    type: "manager",
+    metadata: { since: "2024-01-01" },
+  },
+  meta: { format: "graph" }, // triggers graph mode
+});
+
+// Update an edge
+const { mutate: updateEdge } = useUpdate();
+updateEdge({
+  resource: "employees",
+  id: "edge-123", // edge ID
+  values: {
+    from_id: 1,
+    to_id: 3,
+    type: "manager",
+  },
+  meta: { format: "graph" },
+});
+
+// Delete edges
+const { mutate: deleteEdge } = useDelete();
+deleteEdge({
+  resource: "employees",
+  id: "edge-123",
+  meta: { format: "graph" },
+});
+
+// Delete multiple edges
+const { mutate: deleteEdges } = useDeleteMany();
+deleteEdges({
+  resource: "employees",
+  ids: ["edge-123", "edge-456"],
+  meta: { format: "graph" },
+});
+```
+
 ---
 
 ## Storage Data Provider
@@ -201,7 +289,8 @@ For file upload, download, and management operations.
 ### Setup
 
 ```tsx
-import { storageDataProvider, Client } from "@taruvi/refine-providers";
+import { Client } from "@taruvi/sdk";
+import { storageDataProvider } from "@taruvi/refine-providers";
 
 const client = new Client({ apiKey, appSlug, baseUrl });
 
@@ -291,7 +380,7 @@ For executing Taruvi edge functions.
 ### Setup
 
 ```tsx
-import { functionsDataProvider, Client } from "@taruvi/refine-providers";
+import { functionsDataProvider } from "@taruvi/refine-providers";
 
 <Refine
   dataProvider={{
@@ -366,7 +455,7 @@ For fetching app-level data like roles and settings.
 ### Setup
 
 ```tsx
-import { appDataProvider, Client } from "@taruvi/refine-providers";
+import { appDataProvider } from "@taruvi/refine-providers";
 
 <Refine
   dataProvider={{
@@ -408,7 +497,7 @@ For fetching user-level data including users list and current user details.
 ### Setup
 
 ```tsx
-import { userDataProvider, Client } from "@taruvi/refine-providers";
+import { userDataProvider } from "@taruvi/refine-providers";
 
 <Refine
   dataProvider={{
@@ -466,7 +555,7 @@ For executing predefined analytics queries.
 ### Setup
 
 ```tsx
-import { analyticsDataProvider, Client } from "@taruvi/refine-providers";
+import { analyticsDataProvider } from "@taruvi/refine-providers";
 
 <Refine
   dataProvider={{
@@ -541,7 +630,8 @@ Redirect-based authentication using Taruvi's Web UI Flow.
 ### Setup
 
 ```tsx
-import { authProvider, Client } from "@taruvi/refine-providers";
+import { Client } from "@taruvi/sdk";
+import { authProvider } from "@taruvi/refine-providers";
 
 const client = new Client({ apiKey, appSlug, baseUrl });
 
@@ -613,7 +703,7 @@ Resource-based authorization using Cerbos policies.
 ### Setup
 
 ```tsx
-import { accessControlProvider, Client } from "@taruvi/refine-providers";
+import { accessControlProvider } from "@taruvi/refine-providers";
 
 <Refine
   authProvider={authProvider(client)}
@@ -692,8 +782,8 @@ const { data } = useCan({
 Use multiple providers together:
 
 ```tsx
+import { Client } from "@taruvi/sdk";
 import {
-  Client,
   dataProvider,
   storageDataProvider,
   functionsDataProvider,
@@ -744,42 +834,14 @@ import type {
   StorageUploadVariables,
 
   // Auth types
-  TaruviUser,
   LoginParams,
   LogoutParams,
   RegisterParams,
-
-  // SDK types (re-exported)
-  TaruviConfig,
-  RoleResponse,
-  AnalyticsRequest,
-  AnalyticsResponse,
 } from "@taruvi/refine-providers";
 ```
 
 ---
 
-## SDK Re-exports
-
-For convenience, SDK classes are re-exported:
-
-```tsx
-import {
-  Client,
-  Auth,
-  Policy,
-  Functions,
-  App,
-  Analytics,
-} from "@taruvi/refine-providers";
-
-// Use SDK directly when needed
-const auth = new Auth(client);
-const isLoggedIn = auth.isUserAuthenticated();
-```
-
----
-
 ## Utility Functions
 
 Advanced users can access utility functions:

package/dist/index.cjs

@@ -86,6 +86,18 @@ function applyPopulate(query, meta) {
   const populateArray = Array.isArray(meta.populate) ? meta.populate : meta.populate.split(",").map((s) => s.trim());
   return query.populate(populateArray);
 }
+function isGraphQuery(meta) {
+  return !!(meta?.format || meta?.graph_types || meta?.include || meta?.depth);
+}
+function buildGraphQuery(client, tableName, meta, recordId) {
+  let query = new sdk.Graph(client).from(tableName);
+  if (recordId) query = query.get(recordId);
+  if (meta?.format) query = query.format(meta.format);
+  if (meta?.include) query = query.include(meta.include);
+  if (meta?.depth) query = query.depth(meta.depth);
+  if (meta?.graph_types) query = query.types(meta.graph_types);
+  return query;
+}
 function dataProvider(client) {
   const config = client.getConfig();
   const baseApiUrl = `${config.baseUrl}/api/apps/${config.appSlug}`;
@@ -96,6 +108,12 @@ function dataProvider(client) {
       const { resource, pagination, filters, sorters, meta } = params;
       const taruviMeta = meta;
       const tableName = getTableName(resource, taruviMeta);
+      if (isGraphQuery(taruviMeta)) {
+        const response2 = await buildGraphQuery(client, tableName, taruviMeta).execute();
+        const data = Array.isArray(response2) ? response2 : response2?.data ?? [];
+        const total = response2?.total ?? data.length;
+        return { data, total };
+      }
       let query = new sdk.Database(client).from(tableName);
       query = applyFilters(query, filters);
       query = applySorters(query, sorters);
@@ -108,6 +126,11 @@ function dataProvider(client) {
       const { resource, id, meta } = params;
       const taruviMeta = meta;
       const tableName = getTableName(resource, taruviMeta);
+      if (isGraphQuery(taruviMeta)) {
+        const response2 = await buildGraphQuery(client, tableName, taruviMeta, String(id)).execute();
+        const data = Array.isArray(response2) ? response2[0] : response2?.data?.[0] ?? response2;
+        return { data };
+      }
       let query = new sdk.Database(client).from(tableName);
       query = applyPopulate(query, taruviMeta);
       const response = await query.get(String(id)).execute();
@@ -117,6 +140,15 @@ function dataProvider(client) {
       const { resource, ids, meta } = params;
       const taruviMeta = meta;
       const tableName = getTableName(resource, taruviMeta);
+      if (isGraphQuery(taruviMeta)) {
+        const data = await Promise.all(
+          ids.map(async (id) => {
+            const response2 = await buildGraphQuery(client, tableName, taruviMeta, String(id)).execute();
+            return Array.isArray(response2) ? response2[0] : response2?.data?.[0] ?? response2;
+          })
+        );
+        return { data };
+      }
       const idColumn = getIdColumn(taruviMeta);
       let query = new sdk.Database(client).from(tableName);
       query = query.filter(idColumn, "in", ids.map(String));
@@ -128,6 +160,10 @@ function dataProvider(client) {
       const { resource, variables, meta } = params;
       const taruviMeta = meta;
       const tableName = getTableName(resource, taruviMeta);
+      if (isGraphQuery(taruviMeta)) {
+        const data2 = await new sdk.Graph(client).from(tableName).createEdge(variables).execute();
+        return { data: data2 };
+      }
       const data = await new sdk.Database(client).from(tableName).create(variables).execute();
       return { data };
     },
@@ -146,6 +182,10 @@ function dataProvider(client) {
       const { resource, id, variables, meta } = params;
       const taruviMeta = meta;
       const tableName = getTableName(resource, taruviMeta);
+      if (isGraphQuery(taruviMeta)) {
+        const data2 = await new sdk.Graph(client).from(tableName).updateEdge(String(id), variables).execute();
+        return { data: data2 };
+      }
       const data = await new sdk.Database(client).from(tableName).get(String(id)).update(variables).execute();
       return { data };
     },
@@ -164,6 +204,10 @@ function dataProvider(client) {
       const { resource, id, meta } = params;
       const taruviMeta = meta;
       const tableName = getTableName(resource, taruviMeta);
+      if (isGraphQuery(taruviMeta)) {
+        const data2 = await new sdk.Graph(client).from(tableName).deleteEdge([String(id)]).execute();
+        return { data: data2 };
+      }
       const data = await new sdk.Database(client).from(tableName).delete(String(id)).execute();
       return { data };
     },
@@ -171,34 +215,36 @@ function dataProvider(client) {
       const { resource, ids, meta } = params;
       const taruviMeta = meta;
       const tableName = getTableName(resource, taruviMeta);
+      if (isGraphQuery(taruviMeta)) {
+        const data2 = await new sdk.Graph(client).from(tableName).deleteEdge(ids.map(String)).execute();
+        return { data: [data2] };
+      }
       const data = await Promise.all(
-        ids.map(async (id) => {
-          return new sdk.Database(client).from(tableName).delete(String(id)).execute();
-        })
+        ids.map((id) => new sdk.Database(client).from(tableName).delete(String(id)).execute())
       );
       return { data };
     },
     custom: async (params) => {
       const { url, method, payload, query } = params;
+      let fullUrl = `api/apps/${config.appSlug}/datatables/${url}`;
       let data;
       switch (method.toLowerCase()) {
         case "get": {
-          let requestUrl = url;
           if (query && Object.keys(query).length > 0) {
             const queryString = new URLSearchParams(query).toString();
-            requestUrl = `${url}${url.includes("?") ? "&" : "?"}${queryString}`;
+            fullUrl = `${fullUrl}${fullUrl.includes("?") ? "&" : "?"}${queryString}`;
           }
-          data = await client.httpClient.get(requestUrl);
+          data = await client.httpClient.get(fullUrl);
           break;
         }
         case "post":
-          data = await client.httpClient.post(url, payload);
+          data = await client.httpClient.post(fullUrl, payload);
           break;
         case "put":
-          data = await client.httpClient.put(url, payload);
+          data = await client.httpClient.put(fullUrl, payload);
           break;
         case "delete":
-          data = await client.httpClient.delete(url);
+          data = await client.httpClient.delete(fullUrl);
           break;
         default:
           throw new Error(`Unsupported HTTP method: ${method}`);
@@ -407,25 +453,25 @@ function storageDataProvider(client) {
     },
     custom: async (params) => {
       const { url, method, payload, query } = params;
+      let fullUrl = `api/apps/${config.appSlug}/storage/buckets/${url}`;
       let data;
       switch (method.toLowerCase()) {
         case "get": {
-          let requestUrl = url;
           if (query && Object.keys(query).length > 0) {
             const queryString = new URLSearchParams(query).toString();
-            requestUrl = `${url}${url.includes("?") ? "&" : "?"}${queryString}`;
+            fullUrl = `${fullUrl}${fullUrl.includes("?") ? "&" : "?"}${queryString}`;
           }
-          data = await client.httpClient.get(requestUrl);
+          data = await client.httpClient.get(fullUrl);
           break;
         }
         case "post":
-          data = await client.httpClient.post(url, payload);
+          data = await client.httpClient.post(fullUrl, payload);
           break;
         case "put":
-          data = await client.httpClient.put(url, payload);
+          data = await client.httpClient.put(fullUrl, payload);
           break;
         case "delete":
-          data = await client.httpClient.delete(url);
+          data = await client.httpClient.delete(fullUrl);
           break;
         default:
           throw new Error(`Unsupported HTTP method: ${method}`);
@@ -436,83 +482,11 @@ function storageDataProvider(client) {
     updateMany: void 0
   };
 }
-function functionsDataProvider(client) {
-  const config = client.getConfig();
-  const baseApiUrl = `${config.baseUrl}/api/apps/${config.appSlug}`;
-  const functions = new sdk.Functions(client);
-  return {
-    /**
-     * Execute an edge function.
-     *
-     * @param resource - The function slug to execute
-     * @param variables - Parameters to pass to the function
-     * @param meta.async - Whether to execute asynchronously (default: false)
-     */
-    create: async ({
-      resource,
-      variables,
-      meta
-    }) => {
-      const functionMeta = meta;
-      const response = await functions.execute(resource, {
-        async: functionMeta?.async ?? false,
-        params: variables
-      });
-      return { data: response.data };
-    },
-    getApiUrl: () => baseApiUrl,
-    // Edge functions don't support custom method - use create() instead
-    custom: async () => {
-      throw new Error(
-        "custom is not supported for edge functions. Use useCreate to execute functions."
-      );
-    },
-    // Edge functions don't support other CRUD operations
-    getList: async () => {
-      throw new Error(
-        "getList is not supported for edge functions. Use useCreate to execute functions."
-      );
-    },
-    getOne: async () => {
-      throw new Error(
-        "getOne is not supported for edge functions. Use useCreate to execute functions."
-      );
-    },
-    getMany: async () => {
-      throw new Error(
-        "getMany is not supported for edge functions. Use useCreate to execute functions."
-      );
-    },
-    createMany: async () => {
-      throw new Error(
-        "createMany is not supported for edge functions. Use useCreate to execute functions."
-      );
-    },
-    update: async () => {
-      throw new Error(
-        "update is not supported for edge functions. Use useCreate to execute functions."
-      );
-    },
-    updateMany: async () => {
-      throw new Error(
-        "updateMany is not supported for edge functions. Use useCreate to execute functions."
-      );
-    },
-    deleteOne: async () => {
-      throw new Error(
-        "deleteOne is not supported for edge functions. Use useCreate to execute functions."
-      );
-    },
-    deleteMany: async () => {
-      throw new Error(
-        "deleteMany is not supported for edge functions. Use useCreate to execute functions."
-      );
-    }
-  };
-}
 function appDataProvider(client) {
   const config = client.getConfig();
   const baseApiUrl = `${config.baseUrl}/api/apps/${config.appSlug}`;
+  const functions = new sdk.Functions(client);
+  const analytics = new sdk.Analytics(client);
   return {
     getList: async (params) => {
       const { resource } = params;
@@ -526,7 +500,6 @@ function appDataProvider(client) {
       }
       throw new Error(`Unknown app resource: ${resource}. Supported resources: roles`);
     },
-    getApiUrl: () => baseApiUrl,
     getOne: async (params) => {
       const { resource } = params;
       if (resource === "settings") {
@@ -538,12 +511,32 @@ function appDataProvider(client) {
       }
       throw new Error(`Unknown app resource for getOne: ${resource}. Supported resources: settings`);
     },
-    // App resources are read-only
+    custom: async (params) => {
+      const { url: slug, payload, meta } = params;
+      const customMeta = meta;
+      if (customMeta?.kind === "function") {
+        const response = await functions.execute(slug, {
+          async: customMeta.async ?? false,
+          params: payload ?? {}
+        });
+        return { data: response.data };
+      }
+      if (customMeta?.kind === "analytics") {
+        const response = await analytics.execute(slug, {
+          params: payload ?? {}
+        });
+        return { data: response.data };
+      }
+      throw new Error(
+        'Specify meta.kind as "function" or "analytics" for custom operations on the app provider.'
+      );
+    },
+    getApiUrl: () => baseApiUrl,
     getMany: async () => {
       throw new Error("getMany is not supported for app resources");
     },
     create: async () => {
-      throw new Error("create is not supported for app resources");
+      throw new Error("create is not supported for app resources. Use useCustom with meta.kind");
     },
     createMany: async () => {
       throw new Error("createMany is not supported for app resources");
@@ -559,9 +552,6 @@ function appDataProvider(client) {
     },
     deleteMany: async () => {
       throw new Error("deleteMany is not supported for app resources");
-    },
-    custom: async () => {
-      throw new Error("custom is not supported for app resources");
     }
   };
 }
@@ -701,6 +691,80 @@ function userDataProvider(client) {
     }
   };
 }
+function functionsDataProvider(client) {
+  const config = client.getConfig();
+  const baseApiUrl = `${config.baseUrl}/api/apps/${config.appSlug}`;
+  const functions = new sdk.Functions(client);
+  return {
+    /**
+     * Execute an edge function.
+     *
+     * @param resource - The function slug to execute
+     * @param variables - Parameters to pass to the function
+     * @param meta.async - Whether to execute asynchronously (default: false)
+     */
+    create: async ({
+      resource,
+      variables,
+      meta
+    }) => {
+      const functionMeta = meta;
+      const response = await functions.execute(resource, {
+        async: functionMeta?.async ?? false,
+        params: variables
+      });
+      return { data: response.data };
+    },
+    getApiUrl: () => baseApiUrl,
+    // Edge functions don't support custom method - use create() instead
+    custom: async () => {
+      throw new Error(
+        "custom is not supported for edge functions. Use useCreate to execute functions."
+      );
+    },
+    // Edge functions don't support other CRUD operations
+    getList: async () => {
+      throw new Error(
+        "getList is not supported for edge functions. Use useCreate to execute functions."
+      );
+    },
+    getOne: async () => {
+      throw new Error(
+        "getOne is not supported for edge functions. Use useCreate to execute functions."
+      );
+    },
+    getMany: async () => {
+      throw new Error(
+        "getMany is not supported for edge functions. Use useCreate to execute functions."
+      );
+    },
+    createMany: async () => {
+      throw new Error(
+        "createMany is not supported for edge functions. Use useCreate to execute functions."
+      );
+    },
+    update: async () => {
+      throw new Error(
+        "update is not supported for edge functions. Use useCreate to execute functions."
+      );
+    },
+    updateMany: async () => {
+      throw new Error(
+        "updateMany is not supported for edge functions. Use useCreate to execute functions."
+      );
+    },
+    deleteOne: async () => {
+      throw new Error(
+        "deleteOne is not supported for edge functions. Use useCreate to execute functions."
+      );
+    },
+    deleteMany: async () => {
+      throw new Error(
+        "deleteMany is not supported for edge functions. Use useCreate to execute functions."
+      );
+    }
+  };
+}
 function analyticsDataProvider(client) {
   const config = client.getConfig();
   const baseApiUrl = `${config.baseUrl}/api/apps/${config.appSlug}`;