@taruvi/refine-providers 1.1.7 → 1.1.8

package/dist/index.d.ts

@@ -20,36 +20,52 @@ interface StorageUploadVariables {
 declare function storageDataProvider(client: Client): DataProvider;
 
 /**
- * Extended meta options for function execution.
+ * Meta options for function execution via custom().
  */
 interface FunctionMeta {
+    kind: "function";
     /** Whether to execute the function asynchronously */
     async?: boolean;
 }
-declare function functionsDataProvider(client: Client): DataProvider;
-
+/**
+ * Meta options for analytics query execution via custom().
+ */
+interface AnalyticsMeta {
+    kind: "analytics";
+}
+type AppCustomMeta = FunctionMeta | AnalyticsMeta;
 /**
  * Creates a Refine DataProvider for Taruvi App operations.
  *
- * This provider is specialized for fetching app-level data like roles and settings.
- *
- * Supported resources:
- * - "roles" (getList): Fetch app roles
- * - "settings" (getOne): Fetch app settings
+ * Supported operations:
+ * - getList("roles"): Fetch app roles
+ * - getOne("settings"): Fetch app settings
+ * - custom(): Execute edge functions or analytics queries via meta.kind
  *
  * @example
  * ```typescript
  * // Get app roles
- * const { data } = useList({
+ * useList({ dataProviderName: "app", resource: "roles" });
+ *
+ * // Get app settings
+ * useOne({ dataProviderName: "app", resource: "settings", id: "" });
+ *
+ * // Execute an edge function
+ * useCustom({
  *   dataProviderName: "app",
- *   resource: "roles",
+ *   url: "process-order",
+ *   method: "post",
+ *   config: { payload: { orderId: 123 } },
+ *   meta: { kind: "function", async: false },
  * });
  *
- * // Get app settings
- * const { data } = useOne({
+ * // Execute an analytics query
+ * useCustom({
  *   dataProviderName: "app",
- *   resource: "settings",
- *   id: "", // id is ignored for settings
+ *   url: "monthly-report",
+ *   method: "post",
+ *   config: { payload: { period: "Q1" } },
+ *   meta: { kind: "analytics" },
  * });
  * ```
  */
@@ -96,13 +112,10 @@ declare function appDataProvider(client: Client): DataProvider;
  */
 declare function userDataProvider(client: Client): DataProvider;
 
-/**
- * Extended meta options for analytics query execution.
- */
-interface AnalyticsMeta {
-    /** Additional parameters to pass to the analytics query */
-    params?: Record<string, unknown>;
-}
+/** @deprecated Use `appDataProvider` with `useCustom` and `meta.kind: "function"` instead. */
+declare function functionsDataProvider(client: Client): DataProvider;
+
+/** @deprecated Use `appDataProvider` with `useCustom` and `meta.kind: "analytics"` instead. */
 declare function analyticsDataProvider(client: Client): DataProvider;
 
 /**
@@ -265,4 +278,4 @@ declare function buildQueryString(params?: Record<string, unknown>): string;
  */
 declare function handleError(error: unknown): never;
 
-export { type AnalyticsMeta, type FunctionMeta, type LoginParams, type LogoutParams, REFINE_OPERATOR_MAP, type RegisterParams, type StorageUploadVariables, type TaruviListResponse, type TaruviMeta, accessControlProvider, analyticsDataProvider, appDataProvider, authProvider, buildQueryString, buildRefineQueryParams, convertRefineFilters, convertRefinePagination, convertRefineSorters, dataProvider, functionsDataProvider, handleError, storageDataProvider, userDataProvider };
+export { type AnalyticsMeta, type AppCustomMeta, type FunctionMeta, type LoginParams, type LogoutParams, REFINE_OPERATOR_MAP, type RegisterParams, type StorageUploadVariables, type TaruviListResponse, type TaruviMeta, accessControlProvider, analyticsDataProvider, appDataProvider, authProvider, buildQueryString, buildRefineQueryParams, convertRefineFilters, convertRefinePagination, convertRefineSorters, dataProvider, functionsDataProvider, handleError, storageDataProvider, userDataProvider };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { Graph, Database, Storage, Functions, App, User, Analytics, Auth, Policy } from '@taruvi/sdk';
+import { Graph, Database, Storage, Functions, Analytics, App, User, Auth, Policy } from '@taruvi/sdk';
 import DataLoader2 from 'dataloader';
 
 // src/dataProvider.ts
@@ -476,83 +476,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 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 Functions(client);
+  const analytics = new Analytics(client);
   return {
     getList: async (params) => {
       const { resource } = params;
@@ -566,7 +494,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") {
@@ -578,12 +505,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");
@@ -599,9 +546,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");
     }
   };
 }
@@ -741,6 +685,80 @@ function userDataProvider(client) {
     }
   };
 }
+function functionsDataProvider(client) {
+  const config = client.getConfig();
+  const baseApiUrl = `${config.baseUrl}/api/apps/${config.appSlug}`;
+  const functions = new 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}`;