anymal-protocol 1.0.22 → 1.0.23

package/dist/index.d.mts

@@ -22,6 +22,26 @@ declare function useUpdateUserName(): (dbAuthToken: string, docID: string, name:
     success: boolean;
 }>;
 
+/**
+ * Custom hook to fetch notifications from a GraphQL endpoint.
+ * Allows filtering notifications by `pid` and optionally other fields.
+ *
+ * @example
+ * const fetchNotifications = useFetchNotifications();
+ * const notifications = await fetchNotifications(
+ *   "user_pid",
+ *   "auth_token",
+ *   "https://api.endpoint.com/graphql",
+ *   {
+ *     read: { _eq: false }, // Additional filter: unread notifications
+ *     type: { _in: ["type1", "type2"] }, // Filter by types
+ *   }
+ * );
+ *
+ * @returns {Promise<Array|Object|null>} A list of notifications if found, null otherwise.
+ */
+declare function useFetchNotifications(): (pid: string, dbAuthToken: string, endpoint: string, additionalFilters?: Record<string, any>) => Promise<any>;
+
 declare function useMintAnymalNFT(): (pid: string, nftId: string, dbAuthToken: string, validationContractAddress: string, smartAccount: any, bundlerClient: any) => Promise<{
     success: boolean;
     message: string;
@@ -79,4 +99,4 @@ declare function useCreateUserAppData(): (appId: string, pid: string, dbAuthToke
 
 declare function useFetchBalance(): (publicClient: any, walletAddress: string, kibbleTokenAddress: string) => Promise<number | undefined>;
 
-export { type AnymalNftMetadataInputData, type CreateAnymalInputData, generateBytes32Nonce, useAddAnymalToDatabase, useApproveKibbleToken, useCreateUserAppData, useCreateWeb3Account, useDeleteAnymalFromDatabase, useFetchBalance, useFetchUserData, useMintAnymalNFT, useProcessPartialKibblePayment, useSaveAnymalMetadata, useUpdateAnymalWithNFT, useUpdateUserAsVerified, useUpdateUserEmail, useUpdateUserName, useUpdateUserPid, useUploadAnymalImage, useVerifyAccount, useVerifyWeb3AuthSession };
+export { type AnymalNftMetadataInputData, type CreateAnymalInputData, generateBytes32Nonce, useAddAnymalToDatabase, useApproveKibbleToken, useCreateUserAppData, useCreateWeb3Account, useDeleteAnymalFromDatabase, useFetchBalance, useFetchNotifications, useFetchUserData, useMintAnymalNFT, useProcessPartialKibblePayment, useSaveAnymalMetadata, useUpdateAnymalWithNFT, useUpdateUserAsVerified, useUpdateUserEmail, useUpdateUserName, useUpdateUserPid, useUploadAnymalImage, useVerifyAccount, useVerifyWeb3AuthSession };

package/dist/index.d.ts

@@ -22,6 +22,26 @@ declare function useUpdateUserName(): (dbAuthToken: string, docID: string, name:
     success: boolean;
 }>;
 
+/**
+ * Custom hook to fetch notifications from a GraphQL endpoint.
+ * Allows filtering notifications by `pid` and optionally other fields.
+ *
+ * @example
+ * const fetchNotifications = useFetchNotifications();
+ * const notifications = await fetchNotifications(
+ *   "user_pid",
+ *   "auth_token",
+ *   "https://api.endpoint.com/graphql",
+ *   {
+ *     read: { _eq: false }, // Additional filter: unread notifications
+ *     type: { _in: ["type1", "type2"] }, // Filter by types
+ *   }
+ * );
+ *
+ * @returns {Promise<Array|Object|null>} A list of notifications if found, null otherwise.
+ */
+declare function useFetchNotifications(): (pid: string, dbAuthToken: string, endpoint: string, additionalFilters?: Record<string, any>) => Promise<any>;
+
 declare function useMintAnymalNFT(): (pid: string, nftId: string, dbAuthToken: string, validationContractAddress: string, smartAccount: any, bundlerClient: any) => Promise<{
     success: boolean;
     message: string;
@@ -79,4 +99,4 @@ declare function useCreateUserAppData(): (appId: string, pid: string, dbAuthToke
 
 declare function useFetchBalance(): (publicClient: any, walletAddress: string, kibbleTokenAddress: string) => Promise<number | undefined>;
 
-export { type AnymalNftMetadataInputData, type CreateAnymalInputData, generateBytes32Nonce, useAddAnymalToDatabase, useApproveKibbleToken, useCreateUserAppData, useCreateWeb3Account, useDeleteAnymalFromDatabase, useFetchBalance, useFetchUserData, useMintAnymalNFT, useProcessPartialKibblePayment, useSaveAnymalMetadata, useUpdateAnymalWithNFT, useUpdateUserAsVerified, useUpdateUserEmail, useUpdateUserName, useUpdateUserPid, useUploadAnymalImage, useVerifyAccount, useVerifyWeb3AuthSession };
+export { type AnymalNftMetadataInputData, type CreateAnymalInputData, generateBytes32Nonce, useAddAnymalToDatabase, useApproveKibbleToken, useCreateUserAppData, useCreateWeb3Account, useDeleteAnymalFromDatabase, useFetchBalance, useFetchNotifications, useFetchUserData, useMintAnymalNFT, useProcessPartialKibblePayment, useSaveAnymalMetadata, useUpdateAnymalWithNFT, useUpdateUserAsVerified, useUpdateUserEmail, useUpdateUserName, useUpdateUserPid, useUploadAnymalImage, useVerifyAccount, useVerifyWeb3AuthSession };

package/dist/index.js

@@ -27,6 +27,7 @@ __export(index_exports, {
   useCreateWeb3Account: () => useCreateWeb3Account,
   useDeleteAnymalFromDatabase: () => useDeleteAnymalFromDatabase,
   useFetchBalance: () => useFetchBalance,
+  useFetchNotifications: () => useFetchNotifications,
   useFetchUserData: () => useFetchUserData,
   useMintAnymalNFT: () => useMintAnymalNFT,
   useProcessPartialKibblePayment: () => useProcessPartialKibblePayment,
@@ -901,11 +902,70 @@ function useUpdateUserName() {
   );
 }
 
+// src/utils/account/useFetchNotifications.ts
+var import_react9 = require("react");
+function useFetchNotifications() {
+  return (0, import_react9.useCallback)(
+    async (pid, dbAuthToken, endpoint, additionalFilters) => {
+      if (!pid) {
+        throw new Error("The 'pid' field is required.");
+      }
+      try {
+        const query = `
+                  query Notification($filter: NotificationFilterArg) {
+                    Notification(filter: $filter) {
+                      _docID
+                      action
+                      id
+                      pid
+                      read
+                      source
+                      tags
+                      text
+                      timeAddedUtc
+                      timeUpdatedUtc
+                      type
+                    }
+                  }
+                `;
+        const filter = {
+          pid: {
+            _eq: pid
+          },
+          ...additionalFilters || {}
+        };
+        const variables = { filter };
+        const response = await fetch(endpoint, {
+          method: "POST",
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${dbAuthToken}`
+          },
+          body: JSON.stringify({ query, variables })
+        });
+        if (!response.ok) {
+          throw new Error(`HTTP error! Status: ${response.status}`);
+        }
+        const data = await response.json();
+        if (data?.data?.Notification?.length > 0) {
+          return data.data.Notification;
+        } else {
+          return null;
+        }
+      } catch (error) {
+        console.error("Error fetching notifications:", error);
+        return null;
+      }
+    },
+    []
+  );
+}
+
 // src/utils/anymals/useMintAnymalNFT.ts
 var import_viem2 = require("viem");
-var import_react9 = require("react");
+var import_react10 = require("react");
 function useMintAnymalNFT() {
-  return (0, import_react9.useCallback)(
+  return (0, import_react10.useCallback)(
     async (pid, nftId, dbAuthToken, validationContractAddress, smartAccount, bundlerClient) => {
       if (!dbAuthToken || !nftId || !bundlerClient || !smartAccount || !pid || !validationContractAddress) {
         return {
@@ -944,9 +1004,9 @@ function useMintAnymalNFT() {
 }
 
 // src/utils/anymals/useAddAnymalToDatabase.ts
-var import_react10 = require("react");
+var import_react11 = require("react");
 function useAddAnymalToDatabase() {
-  return (0, import_react10.useCallback)(
+  return (0, import_react11.useCallback)(
     async (dbAuthToken, endpoint, anymalData) => {
       if (!dbAuthToken) {
         return {
@@ -1011,9 +1071,9 @@ function useAddAnymalToDatabase() {
 }
 
 // src/utils/anymals/useDeleteAnymalFromDatabase.ts
-var import_react11 = require("react");
+var import_react12 = require("react");
 function useDeleteAnymalFromDatabase() {
-  return (0, import_react11.useCallback)(
+  return (0, import_react12.useCallback)(
     async (dbAuthToken, endpoint, anymalDocID) => {
       if (!dbAuthToken || !endpoint || !anymalDocID) return;
       try {
@@ -1051,9 +1111,9 @@ function useDeleteAnymalFromDatabase() {
 }
 
 // src/utils/anymals/useSaveAnymalMetadata.ts
-var import_react12 = require("react");
+var import_react13 = require("react");
 function useSaveAnymalMetadata() {
-  return (0, import_react12.useCallback)(
+  return (0, import_react13.useCallback)(
     async (idToken, publicKey, nftMetadataInput, authServiceBaseUrl) => {
       const response = await fetch(`${authServiceBaseUrl}/process-nft`, {
         method: "POST",
@@ -1080,9 +1140,9 @@ function useSaveAnymalMetadata() {
 }
 
 // src/utils/anymals/useUpdateAnymalWithNFT.ts
-var import_react13 = require("react");
+var import_react14 = require("react");
 function useUpdateAnymalWithNFT() {
-  return (0, import_react13.useCallback)(
+  return (0, import_react14.useCallback)(
     async (anymalPassportId, anymalDocId, dbAuthToken, endpoint) => {
       if (!dbAuthToken || !anymalPassportId || !anymalDocId || !endpoint) {
         return {
@@ -1129,7 +1189,7 @@ function useUpdateAnymalWithNFT() {
 }
 
 // src/utils/anymals/useUploadAnymalImage.ts
-var import_react14 = require("react");
+var import_react15 = require("react");
 
 // src/helpers/UploadImageHelper.tsx
 function resizeImage(file, maxWidth = 800, maxHeight = 800, quality = 0.7) {
@@ -1186,7 +1246,7 @@ function toBase64(file) {
 
 // src/utils/anymals/useUploadAnymalImage.ts
 function useUploadAnymalImage() {
-  return (0, import_react14.useCallback)(
+  return (0, import_react15.useCallback)(
     async (imageFile, type, idToken, publicKey, authServiceBaseUrl) => {
       if (!imageFile || !idToken) {
         return {
@@ -1242,9 +1302,9 @@ function useUploadAnymalImage() {
 
 // src/utils/marketplace/useProcessPartialKibblePayment.ts
 var import_viem3 = require("viem");
-var import_react15 = require("react");
+var import_react16 = require("react");
 function useProcessPartialKibblePayment() {
-  return (0, import_react15.useCallback)(
+  return (0, import_react16.useCallback)(
     async (pid, nftId, orderId, dbAuthToken, marketplaceContract, smartAccount, bundlerClient, amountInTokens, maxTokenPayment, nonce, deadline, backendSignature) => {
       if (!orderId || !dbAuthToken || !nftId || !bundlerClient || !smartAccount || !pid || !marketplaceContract || !amountInTokens || !maxTokenPayment || !nonce || !deadline) {
         return {
@@ -1304,9 +1364,9 @@ function useProcessPartialKibblePayment() {
 
 // src/utils/marketplace/useApproveKibbleToken.ts
 var import_viem4 = require("viem");
-var import_react16 = require("react");
+var import_react17 = require("react");
 function useApproveKibbleToken() {
-  return (0, import_react16.useCallback)(
+  return (0, import_react17.useCallback)(
     async (kibbleTokenAddress, marketplaceContract, amount, smartAccount, bundlerClient) => {
       try {
         const callData = (0, import_viem4.encodeFunctionData)({
@@ -1352,10 +1412,10 @@ var generateBytes32Nonce = () => {
 };
 
 // src/utils/application/useCreateUserAppData.ts
-var import_react17 = require("react");
+var import_react18 = require("react");
 var import_uuid2 = require("uuid");
 function useCreateUserAppData() {
-  return (0, import_react17.useCallback)(
+  return (0, import_react18.useCallback)(
     async (appId, pid, dbAuthToken, endpoint) => {
       if (!dbAuthToken || !pid || !dbAuthToken || !endpoint) return;
       const appValues = {
@@ -1408,10 +1468,10 @@ function useCreateUserAppData() {
 }
 
 // src/utils/balance/useFetchBalance.ts
-var import_react18 = require("react");
+var import_react19 = require("react");
 var import_viem6 = require("viem");
 function useFetchBalance() {
-  return (0, import_react18.useCallback)(
+  return (0, import_react19.useCallback)(
     async (publicClient, walletAddress, kibbleTokenAddress) => {
       try {
         const balance = await publicClient.readContract({
@@ -1437,6 +1497,7 @@ function useFetchBalance() {
   useCreateWeb3Account,
   useDeleteAnymalFromDatabase,
   useFetchBalance,
+  useFetchNotifications,
   useFetchUserData,
   useMintAnymalNFT,
   useProcessPartialKibblePayment,

package/dist/index.mjs

@@ -857,11 +857,70 @@ function useUpdateUserName() {
   );
 }
 
+// src/utils/account/useFetchNotifications.ts
+import { useCallback as useCallback9 } from "react";
+function useFetchNotifications() {
+  return useCallback9(
+    async (pid, dbAuthToken, endpoint, additionalFilters) => {
+      if (!pid) {
+        throw new Error("The 'pid' field is required.");
+      }
+      try {
+        const query = `
+                  query Notification($filter: NotificationFilterArg) {
+                    Notification(filter: $filter) {
+                      _docID
+                      action
+                      id
+                      pid
+                      read
+                      source
+                      tags
+                      text
+                      timeAddedUtc
+                      timeUpdatedUtc
+                      type
+                    }
+                  }
+                `;
+        const filter = {
+          pid: {
+            _eq: pid
+          },
+          ...additionalFilters || {}
+        };
+        const variables = { filter };
+        const response = await fetch(endpoint, {
+          method: "POST",
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${dbAuthToken}`
+          },
+          body: JSON.stringify({ query, variables })
+        });
+        if (!response.ok) {
+          throw new Error(`HTTP error! Status: ${response.status}`);
+        }
+        const data = await response.json();
+        if (data?.data?.Notification?.length > 0) {
+          return data.data.Notification;
+        } else {
+          return null;
+        }
+      } catch (error) {
+        console.error("Error fetching notifications:", error);
+        return null;
+      }
+    },
+    []
+  );
+}
+
 // src/utils/anymals/useMintAnymalNFT.ts
 import { encodeFunctionData as encodeFunctionData2, parseGwei as parseGwei2 } from "viem";
-import { useCallback as useCallback9 } from "react";
+import { useCallback as useCallback10 } from "react";
 function useMintAnymalNFT() {
-  return useCallback9(
+  return useCallback10(
     async (pid, nftId, dbAuthToken, validationContractAddress, smartAccount, bundlerClient) => {
       if (!dbAuthToken || !nftId || !bundlerClient || !smartAccount || !pid || !validationContractAddress) {
         return {
@@ -900,9 +959,9 @@ function useMintAnymalNFT() {
 }
 
 // src/utils/anymals/useAddAnymalToDatabase.ts
-import { useCallback as useCallback10 } from "react";
+import { useCallback as useCallback11 } from "react";
 function useAddAnymalToDatabase() {
-  return useCallback10(
+  return useCallback11(
     async (dbAuthToken, endpoint, anymalData) => {
       if (!dbAuthToken) {
         return {
@@ -967,9 +1026,9 @@ function useAddAnymalToDatabase() {
 }
 
 // src/utils/anymals/useDeleteAnymalFromDatabase.ts
-import { useCallback as useCallback11 } from "react";
+import { useCallback as useCallback12 } from "react";
 function useDeleteAnymalFromDatabase() {
-  return useCallback11(
+  return useCallback12(
     async (dbAuthToken, endpoint, anymalDocID) => {
       if (!dbAuthToken || !endpoint || !anymalDocID) return;
       try {
@@ -1007,9 +1066,9 @@ function useDeleteAnymalFromDatabase() {
 }
 
 // src/utils/anymals/useSaveAnymalMetadata.ts
-import { useCallback as useCallback12 } from "react";
+import { useCallback as useCallback13 } from "react";
 function useSaveAnymalMetadata() {
-  return useCallback12(
+  return useCallback13(
     async (idToken, publicKey, nftMetadataInput, authServiceBaseUrl) => {
       const response = await fetch(`${authServiceBaseUrl}/process-nft`, {
         method: "POST",
@@ -1036,9 +1095,9 @@ function useSaveAnymalMetadata() {
 }
 
 // src/utils/anymals/useUpdateAnymalWithNFT.ts
-import { useCallback as useCallback13 } from "react";
+import { useCallback as useCallback14 } from "react";
 function useUpdateAnymalWithNFT() {
-  return useCallback13(
+  return useCallback14(
     async (anymalPassportId, anymalDocId, dbAuthToken, endpoint) => {
       if (!dbAuthToken || !anymalPassportId || !anymalDocId || !endpoint) {
         return {
@@ -1085,7 +1144,7 @@ function useUpdateAnymalWithNFT() {
 }
 
 // src/utils/anymals/useUploadAnymalImage.ts
-import { useCallback as useCallback14 } from "react";
+import { useCallback as useCallback15 } from "react";
 
 // src/helpers/UploadImageHelper.tsx
 function resizeImage(file, maxWidth = 800, maxHeight = 800, quality = 0.7) {
@@ -1142,7 +1201,7 @@ function toBase64(file) {
 
 // src/utils/anymals/useUploadAnymalImage.ts
 function useUploadAnymalImage() {
-  return useCallback14(
+  return useCallback15(
     async (imageFile, type, idToken, publicKey, authServiceBaseUrl) => {
       if (!imageFile || !idToken) {
         return {
@@ -1198,9 +1257,9 @@ function useUploadAnymalImage() {
 
 // src/utils/marketplace/useProcessPartialKibblePayment.ts
 import { encodeFunctionData as encodeFunctionData3, parseGwei as parseGwei3 } from "viem";
-import { useCallback as useCallback15 } from "react";
+import { useCallback as useCallback16 } from "react";
 function useProcessPartialKibblePayment() {
-  return useCallback15(
+  return useCallback16(
     async (pid, nftId, orderId, dbAuthToken, marketplaceContract, smartAccount, bundlerClient, amountInTokens, maxTokenPayment, nonce, deadline, backendSignature) => {
       if (!orderId || !dbAuthToken || !nftId || !bundlerClient || !smartAccount || !pid || !marketplaceContract || !amountInTokens || !maxTokenPayment || !nonce || !deadline) {
         return {
@@ -1260,9 +1319,9 @@ function useProcessPartialKibblePayment() {
 
 // src/utils/marketplace/useApproveKibbleToken.ts
 import { encodeFunctionData as encodeFunctionData4, erc20Abi, parseGwei as parseGwei4 } from "viem";
-import { useCallback as useCallback16 } from "react";
+import { useCallback as useCallback17 } from "react";
 function useApproveKibbleToken() {
-  return useCallback16(
+  return useCallback17(
     async (kibbleTokenAddress, marketplaceContract, amount, smartAccount, bundlerClient) => {
       try {
         const callData = encodeFunctionData4({
@@ -1308,10 +1367,10 @@ var generateBytes32Nonce = () => {
 };
 
 // src/utils/application/useCreateUserAppData.ts
-import { useCallback as useCallback17 } from "react";
+import { useCallback as useCallback18 } from "react";
 import { v4 as uuid } from "uuid";
 function useCreateUserAppData() {
-  return useCallback17(
+  return useCallback18(
     async (appId, pid, dbAuthToken, endpoint) => {
       if (!dbAuthToken || !pid || !dbAuthToken || !endpoint) return;
       const appValues = {
@@ -1364,10 +1423,10 @@ function useCreateUserAppData() {
 }
 
 // src/utils/balance/useFetchBalance.ts
-import { useCallback as useCallback18 } from "react";
+import { useCallback as useCallback19 } from "react";
 import { erc20Abi as erc20Abi2, getAddress } from "viem";
 function useFetchBalance() {
-  return useCallback18(
+  return useCallback19(
     async (publicClient, walletAddress, kibbleTokenAddress) => {
       try {
         const balance = await publicClient.readContract({
@@ -1392,6 +1451,7 @@ export {
   useCreateWeb3Account,
   useDeleteAnymalFromDatabase,
   useFetchBalance,
+  useFetchNotifications,
   useFetchUserData,
   useMintAnymalNFT,
   useProcessPartialKibblePayment,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "anymal-protocol",
-  "version": "1.0.22",
+  "version": "1.0.23",
   "description": "A React/TypeScript-based utility library for reusable functions and hooks inside of the Anymal Ecosystem.",
   "main": "dist/index.js",
   "module": "dist/index.js",