anymal-protocol 1.0.60 → 1.0.61

package/dist/index.d.mts

@@ -61,6 +61,7 @@ interface AnymalNftMetadataInputData {
 
 declare function useAddAnymalToDatabase(): (dbAuthToken: string, endpoint: string, anymalData: CreateAnymalInputData) => Promise<{
     _docID: string | null;
+    dbCid: string | null;
     success: boolean;
     message: string;
 }>;
@@ -214,6 +215,101 @@ declare function createAuthEnvelope(privateKeyHex: string, network?: Network, op
  */
 declare function generateAppSignature(privateKeyHex: string, clientId: string, redirectUri: string, state: string): Promise<string>;
 
+/**
+ * Types of actions you can submit
+ */
+declare enum ActionType {
+    GRAPHQL = "GRAPHQL",
+    CONTRACT = "CONTRACT",
+    EXTERNAL = "EXTERNAL"
+}
+/**
+ * Represents a single action record returned by the backend.
+ */
+interface ActionRecord {
+    id: string;
+    wallet: string;
+    pid: string;
+    action_id: string;
+    metadata: Record<string, any>;
+    version_cid?: string;
+    quantity: number;
+    reward_amount?: number;
+    status: 'PENDING' | 'VALIDATED' | 'CLAIMED';
+    createdAt: string;
+    validatedAt?: string | null;
+    claimedAt?: string | null;
+    claimQuantity?: number | null;
+}
+/**
+ * API response for fetching action records.
+ */
+interface FetchActionsResponse {
+    data: ActionRecord[];
+}
+
+/**
+ * Base fields sent with every action
+ */
+interface BaseActionPayload {
+    actionId: string;
+    timestamp: string;
+    nonce: string;
+    source: ActionType;
+    clientInfo?: {
+        userAgent?: string;
+        locale?: string;
+    };
+}
+/**
+ * Payload for GraphQL-based actions
+ */
+interface GraphQLActionPayload extends BaseActionPayload {
+    versionCid: string;
+    resource: string;
+    resourceId: string;
+    changedFields?: string[];
+    previousValues?: Record<string, any>;
+    mutation?: string;
+    variables?: Record<string, any>;
+}
+/**
+ * Payload for on-chain contract actions
+ */
+interface ContractActionPayload extends BaseActionPayload {
+    txHash: string;
+    chainId: number;
+    contract: string;
+    functionName: string;
+    args: any[];
+    receipt: {
+        blockNumber: number;
+        status: number;
+        gasUsed: string;
+    };
+}
+/**
+ * Payload for external web-service actions
+ */
+interface ExternalActionPayload extends BaseActionPayload {
+    endpoint: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    requestBody?: Record<string, any>;
+    responseStatus?: number;
+    responseBody?: any;
+}
+type ActionPayload = GraphQLActionPayload | ContractActionPayload | ExternalActionPayload;
+interface SubmitResponse {
+    ok: boolean;
+    id: string;
+}
+/**
+ * Generic submission function
+ */
+declare function submitAction(idToken: string, pid: string, payload: ActionPayload, endpointBaseUrl: string): Promise<SubmitResponse>;
+
+declare function useFetchActions(): (idToken: string, actionsServiceBaseUrl: string, pid: string, status?: string, limit?: number, offset?: number) => Promise<FetchActionsResponse | null>;
+
 declare function useCreateUserAppData(): (appId: string, pid: string, dbAuthToken: string, endpoint: string) => Promise<{
     success: boolean;
     data: any;
@@ -226,4 +322,4 @@ declare function useCreateOrganizationAppData(): (appId: string, pid: string, db
 
 declare function useFetchBalance(): (publicClient: any, walletAddress: string, kibbleTokenAddress: string) => Promise<number | undefined>;
 
-export { AUTH_API_ENDPOINTS, type AnymalNftMetadataInputData, type AuthEnvelope, type CreateAnymalInputData, type JWTOptions, NETWORK_HOSTS, Network, createAuthEnvelope, fetchAnymals, generateAppSignature, generateBytes32Nonce, generateJWT, loadExistingSecp256k1PrivateKey, serializePublicKeyCompressed, useAddAnymalToDatabase, useApproveKibbleToken, useApproveOrgPartialPayment, useCreateOrganizationAppData, useCreateOrganizationBase, useCreateUserAppData, useCreateWeb3Account, useDeleteAnymalFromDatabase, useFetchAnymals, useFetchBalance, useFetchNotifications, useFetchUserData, useMintAnymalNFT, useProcessOrgPartialKibblePayment, useProcessPartialKibblePayment, useSaveAnymalMetadata, useUpdateAnymalWithNFT, useUpdateOrgWalletAddress, useUpdateUserAsVerified, useUpdateUserEmail, useUpdateUserName, useUpdateUserPid, useUploadAnymalImage, useVerifyAccount, useVerifyWeb3AuthSession };
+export { AUTH_API_ENDPOINTS, type ActionPayload, ActionType, type AnymalNftMetadataInputData, type AuthEnvelope, type ContractActionPayload, type CreateAnymalInputData, type ExternalActionPayload, type GraphQLActionPayload, type JWTOptions, NETWORK_HOSTS, Network, type SubmitResponse, createAuthEnvelope, fetchAnymals, generateAppSignature, generateBytes32Nonce, generateJWT, loadExistingSecp256k1PrivateKey, serializePublicKeyCompressed, submitAction, useAddAnymalToDatabase, useApproveKibbleToken, useApproveOrgPartialPayment, useCreateOrganizationAppData, useCreateOrganizationBase, useCreateUserAppData, useCreateWeb3Account, useDeleteAnymalFromDatabase, useFetchActions, useFetchAnymals, useFetchBalance, useFetchNotifications, useFetchUserData, useMintAnymalNFT, useProcessOrgPartialKibblePayment, useProcessPartialKibblePayment, useSaveAnymalMetadata, useUpdateAnymalWithNFT, useUpdateOrgWalletAddress, useUpdateUserAsVerified, useUpdateUserEmail, useUpdateUserName, useUpdateUserPid, useUploadAnymalImage, useVerifyAccount, useVerifyWeb3AuthSession };

package/dist/index.d.ts

@@ -61,6 +61,7 @@ interface AnymalNftMetadataInputData {
 
 declare function useAddAnymalToDatabase(): (dbAuthToken: string, endpoint: string, anymalData: CreateAnymalInputData) => Promise<{
     _docID: string | null;
+    dbCid: string | null;
     success: boolean;
     message: string;
 }>;
@@ -214,6 +215,101 @@ declare function createAuthEnvelope(privateKeyHex: string, network?: Network, op
  */
 declare function generateAppSignature(privateKeyHex: string, clientId: string, redirectUri: string, state: string): Promise<string>;
 
+/**
+ * Types of actions you can submit
+ */
+declare enum ActionType {
+    GRAPHQL = "GRAPHQL",
+    CONTRACT = "CONTRACT",
+    EXTERNAL = "EXTERNAL"
+}
+/**
+ * Represents a single action record returned by the backend.
+ */
+interface ActionRecord {
+    id: string;
+    wallet: string;
+    pid: string;
+    action_id: string;
+    metadata: Record<string, any>;
+    version_cid?: string;
+    quantity: number;
+    reward_amount?: number;
+    status: 'PENDING' | 'VALIDATED' | 'CLAIMED';
+    createdAt: string;
+    validatedAt?: string | null;
+    claimedAt?: string | null;
+    claimQuantity?: number | null;
+}
+/**
+ * API response for fetching action records.
+ */
+interface FetchActionsResponse {
+    data: ActionRecord[];
+}
+
+/**
+ * Base fields sent with every action
+ */
+interface BaseActionPayload {
+    actionId: string;
+    timestamp: string;
+    nonce: string;
+    source: ActionType;
+    clientInfo?: {
+        userAgent?: string;
+        locale?: string;
+    };
+}
+/**
+ * Payload for GraphQL-based actions
+ */
+interface GraphQLActionPayload extends BaseActionPayload {
+    versionCid: string;
+    resource: string;
+    resourceId: string;
+    changedFields?: string[];
+    previousValues?: Record<string, any>;
+    mutation?: string;
+    variables?: Record<string, any>;
+}
+/**
+ * Payload for on-chain contract actions
+ */
+interface ContractActionPayload extends BaseActionPayload {
+    txHash: string;
+    chainId: number;
+    contract: string;
+    functionName: string;
+    args: any[];
+    receipt: {
+        blockNumber: number;
+        status: number;
+        gasUsed: string;
+    };
+}
+/**
+ * Payload for external web-service actions
+ */
+interface ExternalActionPayload extends BaseActionPayload {
+    endpoint: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    requestBody?: Record<string, any>;
+    responseStatus?: number;
+    responseBody?: any;
+}
+type ActionPayload = GraphQLActionPayload | ContractActionPayload | ExternalActionPayload;
+interface SubmitResponse {
+    ok: boolean;
+    id: string;
+}
+/**
+ * Generic submission function
+ */
+declare function submitAction(idToken: string, pid: string, payload: ActionPayload, endpointBaseUrl: string): Promise<SubmitResponse>;
+
+declare function useFetchActions(): (idToken: string, actionsServiceBaseUrl: string, pid: string, status?: string, limit?: number, offset?: number) => Promise<FetchActionsResponse | null>;
+
 declare function useCreateUserAppData(): (appId: string, pid: string, dbAuthToken: string, endpoint: string) => Promise<{
     success: boolean;
     data: any;
@@ -226,4 +322,4 @@ declare function useCreateOrganizationAppData(): (appId: string, pid: string, db
 
 declare function useFetchBalance(): (publicClient: any, walletAddress: string, kibbleTokenAddress: string) => Promise<number | undefined>;
 
-export { AUTH_API_ENDPOINTS, type AnymalNftMetadataInputData, type AuthEnvelope, type CreateAnymalInputData, type JWTOptions, NETWORK_HOSTS, Network, createAuthEnvelope, fetchAnymals, generateAppSignature, generateBytes32Nonce, generateJWT, loadExistingSecp256k1PrivateKey, serializePublicKeyCompressed, useAddAnymalToDatabase, useApproveKibbleToken, useApproveOrgPartialPayment, useCreateOrganizationAppData, useCreateOrganizationBase, useCreateUserAppData, useCreateWeb3Account, useDeleteAnymalFromDatabase, useFetchAnymals, useFetchBalance, useFetchNotifications, useFetchUserData, useMintAnymalNFT, useProcessOrgPartialKibblePayment, useProcessPartialKibblePayment, useSaveAnymalMetadata, useUpdateAnymalWithNFT, useUpdateOrgWalletAddress, useUpdateUserAsVerified, useUpdateUserEmail, useUpdateUserName, useUpdateUserPid, useUploadAnymalImage, useVerifyAccount, useVerifyWeb3AuthSession };
+export { AUTH_API_ENDPOINTS, type ActionPayload, ActionType, type AnymalNftMetadataInputData, type AuthEnvelope, type ContractActionPayload, type CreateAnymalInputData, type ExternalActionPayload, type GraphQLActionPayload, type JWTOptions, NETWORK_HOSTS, Network, type SubmitResponse, createAuthEnvelope, fetchAnymals, generateAppSignature, generateBytes32Nonce, generateJWT, loadExistingSecp256k1PrivateKey, serializePublicKeyCompressed, submitAction, useAddAnymalToDatabase, useApproveKibbleToken, useApproveOrgPartialPayment, useCreateOrganizationAppData, useCreateOrganizationBase, useCreateUserAppData, useCreateWeb3Account, useDeleteAnymalFromDatabase, useFetchActions, useFetchAnymals, useFetchBalance, useFetchNotifications, useFetchUserData, useMintAnymalNFT, useProcessOrgPartialKibblePayment, useProcessPartialKibblePayment, useSaveAnymalMetadata, useUpdateAnymalWithNFT, useUpdateOrgWalletAddress, useUpdateUserAsVerified, useUpdateUserEmail, useUpdateUserName, useUpdateUserPid, useUploadAnymalImage, useVerifyAccount, useVerifyWeb3AuthSession };

package/dist/index.js

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   AUTH_API_ENDPOINTS: () => AUTH_API_ENDPOINTS,
+  ActionType: () => ActionType,
   NETWORK_HOSTS: () => NETWORK_HOSTS,
   Network: () => Network,
   createAuthEnvelope: () => createAuthEnvelope,
@@ -30,6 +31,7 @@ __export(index_exports, {
   generateJWT: () => generateJWT,
   loadExistingSecp256k1PrivateKey: () => loadExistingSecp256k1PrivateKey,
   serializePublicKeyCompressed: () => serializePublicKeyCompressed,
+  submitAction: () => submitAction,
   useAddAnymalToDatabase: () => useAddAnymalToDatabase,
   useApproveKibbleToken: () => useApproveKibbleToken,
   useApproveOrgPartialPayment: () => useApproveOrgPartialPayment,
@@ -38,6 +40,7 @@ __export(index_exports, {
   useCreateUserAppData: () => useCreateUserAppData,
   useCreateWeb3Account: () => useCreateWeb3Account,
   useDeleteAnymalFromDatabase: () => useDeleteAnymalFromDatabase,
+  useFetchActions: () => useFetchActions,
   useFetchAnymals: () => useFetchAnymals,
   useFetchBalance: () => useFetchBalance,
   useFetchNotifications: () => useFetchNotifications,
@@ -1318,10 +1321,12 @@ function useAddAnymalToDatabase() {
         return {
           success: false,
           message: "Authentication token is missing.",
-          _docID: null
+          _docID: null,
+          dbCid: null
         };
       }
       let anymalDocID = null;
+      let dbCid = null;
       try {
         const mutation = `
                 mutation Create_Anymal($input: [AnymalMutationInputArg!]) {
@@ -1329,6 +1334,9 @@ function useAddAnymalToDatabase() {
                       _docID
                       name
                       passportID
+                      _version {
+                       cid
+                      }
                     }
                 }
             `;
@@ -1359,15 +1367,18 @@ function useAddAnymalToDatabase() {
           throw new Error(`GraphQL error: ${errorMessage}`);
         }
         anymalDocID = data.create_Anymal[0]._docID;
+        dbCid = data.create_Anymal[0]._version[0].cid;
         return {
           success: true,
           _docID: anymalDocID,
+          dbCid,
           message: "Anymal added to account"
         };
       } catch (error) {
         return {
           success: false,
           _docID: null,
+          dbCid: null,
           message: "Error adding anymal to account"
         };
       }
@@ -2100,11 +2111,65 @@ async function generateAppSignature(privateKeyHex, clientId, redirectUri, state)
   return Buffer.from(signatureDER).toString("hex");
 }
 
-// src/utils/application/useCreateUserAppData.ts
+// src/helpers/ActionHelpers.tsx
+async function submitAction(idToken, pid, payload, endpointBaseUrl) {
+  const api = endpointBaseUrl + "/actions";
+  const response = await fetch(api, {
+    method: "POST",
+    headers: { "Content-Type": "application/json", "Authorization": "Bearer " + idToken },
+    body: JSON.stringify({ actionId: payload.actionId, pid, payload })
+  });
+  if (!response.ok) {
+    const err = await response.json();
+    throw new Error(err.error || "Failed to submit action");
+  }
+  return response.json();
+}
+
+// src/utils/actions/useFetchActions.ts
 var import_react23 = require("react");
+function useFetchActions() {
+  return (0, import_react23.useCallback)(
+    async (idToken, actionsServiceBaseUrl, pid, status, limit, offset) => {
+      const params = new URLSearchParams({ pid });
+      if (status) params.set("status", status);
+      if (limit != null) params.set("limit", `${limit}`);
+      if (offset != null) params.set("offset", `${offset}`);
+      try {
+        const response = await fetch(
+          `${actionsServiceBaseUrl}/actions?${params.toString()}`,
+          {
+            method: "GET",
+            headers: {
+              "Content-Type": "application/json",
+              Authorization: "Bearer " + idToken
+            }
+          }
+        );
+        if (!response.ok) throw new Error(`HTTP ${response.status}`);
+        return await response.json();
+      } catch (error) {
+        console.error("useFetchActions error:", error);
+        return null;
+      }
+    },
+    []
+  );
+}
+
+// src/types/Actions.ts
+var ActionType = /* @__PURE__ */ ((ActionType2) => {
+  ActionType2["GRAPHQL"] = "GRAPHQL";
+  ActionType2["CONTRACT"] = "CONTRACT";
+  ActionType2["EXTERNAL"] = "EXTERNAL";
+  return ActionType2;
+})(ActionType || {});
+
+// src/utils/application/useCreateUserAppData.ts
+var import_react24 = require("react");
 var import_uuid2 = require("uuid");
 function useCreateUserAppData() {
-  return (0, import_react23.useCallback)(
+  return (0, import_react24.useCallback)(
     async (appId, pid, dbAuthToken, endpoint) => {
       if (!dbAuthToken || !pid || !dbAuthToken || !endpoint) return;
       const appValues = {
@@ -2159,10 +2224,10 @@ function useCreateUserAppData() {
 }
 
 // src/utils/application/useCreateOrganizationAppData.ts
-var import_react24 = require("react");
+var import_react25 = require("react");
 var import_uuid3 = require("uuid");
 function useCreateOrganizationAppData() {
-  return (0, import_react24.useCallback)(
+  return (0, import_react25.useCallback)(
     async (appId, pid, dbAuthToken, endpoint) => {
       if (!dbAuthToken || !pid || !dbAuthToken || !endpoint) return;
       const appValues = {
@@ -2216,10 +2281,10 @@ function useCreateOrganizationAppData() {
 }
 
 // src/utils/balance/useFetchBalance.ts
-var import_react25 = require("react");
+var import_react26 = require("react");
 var import_viem9 = require("viem");
 function useFetchBalance() {
-  return (0, import_react25.useCallback)(
+  return (0, import_react26.useCallback)(
     async (publicClient, walletAddress, kibbleTokenAddress) => {
       try {
         const balance = await publicClient.readContract({
@@ -2239,6 +2304,7 @@ function useFetchBalance() {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AUTH_API_ENDPOINTS,
+  ActionType,
   NETWORK_HOSTS,
   Network,
   createAuthEnvelope,
@@ -2248,6 +2314,7 @@ function useFetchBalance() {
   generateJWT,
   loadExistingSecp256k1PrivateKey,
   serializePublicKeyCompressed,
+  submitAction,
   useAddAnymalToDatabase,
   useApproveKibbleToken,
   useApproveOrgPartialPayment,
@@ -2256,6 +2323,7 @@ function useFetchBalance() {
   useCreateUserAppData,
   useCreateWeb3Account,
   useDeleteAnymalFromDatabase,
+  useFetchActions,
   useFetchAnymals,
   useFetchBalance,
   useFetchNotifications,

package/dist/index.mjs

@@ -1269,10 +1269,12 @@ function useAddAnymalToDatabase() {
         return {
           success: false,
           message: "Authentication token is missing.",
-          _docID: null
+          _docID: null,
+          dbCid: null
         };
       }
       let anymalDocID = null;
+      let dbCid = null;
       try {
         const mutation = `
                 mutation Create_Anymal($input: [AnymalMutationInputArg!]) {
@@ -1280,6 +1282,9 @@ function useAddAnymalToDatabase() {
                       _docID
                       name
                       passportID
+                      _version {
+                       cid
+                      }
                     }
                 }
             `;
@@ -1310,15 +1315,18 @@ function useAddAnymalToDatabase() {
           throw new Error(`GraphQL error: ${errorMessage}`);
         }
         anymalDocID = data.create_Anymal[0]._docID;
+        dbCid = data.create_Anymal[0]._version[0].cid;
         return {
           success: true,
           _docID: anymalDocID,
+          dbCid,
           message: "Anymal added to account"
         };
       } catch (error) {
         return {
           success: false,
           _docID: null,
+          dbCid: null,
           message: "Error adding anymal to account"
         };
       }
@@ -1971,11 +1979,65 @@ var generateBytes32Nonce = () => {
   return padHex(`0x${uuid3}`, { size: 32 });
 };
 
-// src/utils/application/useCreateUserAppData.ts
+// src/helpers/ActionHelpers.tsx
+async function submitAction(idToken, pid, payload, endpointBaseUrl) {
+  const api = endpointBaseUrl + "/actions";
+  const response = await fetch(api, {
+    method: "POST",
+    headers: { "Content-Type": "application/json", "Authorization": "Bearer " + idToken },
+    body: JSON.stringify({ actionId: payload.actionId, pid, payload })
+  });
+  if (!response.ok) {
+    const err = await response.json();
+    throw new Error(err.error || "Failed to submit action");
+  }
+  return response.json();
+}
+
+// src/utils/actions/useFetchActions.ts
 import { useCallback as useCallback23 } from "react";
+function useFetchActions() {
+  return useCallback23(
+    async (idToken, actionsServiceBaseUrl, pid, status, limit, offset) => {
+      const params = new URLSearchParams({ pid });
+      if (status) params.set("status", status);
+      if (limit != null) params.set("limit", `${limit}`);
+      if (offset != null) params.set("offset", `${offset}`);
+      try {
+        const response = await fetch(
+          `${actionsServiceBaseUrl}/actions?${params.toString()}`,
+          {
+            method: "GET",
+            headers: {
+              "Content-Type": "application/json",
+              Authorization: "Bearer " + idToken
+            }
+          }
+        );
+        if (!response.ok) throw new Error(`HTTP ${response.status}`);
+        return await response.json();
+      } catch (error) {
+        console.error("useFetchActions error:", error);
+        return null;
+      }
+    },
+    []
+  );
+}
+
+// src/types/Actions.ts
+var ActionType = /* @__PURE__ */ ((ActionType2) => {
+  ActionType2["GRAPHQL"] = "GRAPHQL";
+  ActionType2["CONTRACT"] = "CONTRACT";
+  ActionType2["EXTERNAL"] = "EXTERNAL";
+  return ActionType2;
+})(ActionType || {});
+
+// src/utils/application/useCreateUserAppData.ts
+import { useCallback as useCallback24 } from "react";
 import { v4 as uuid } from "uuid";
 function useCreateUserAppData() {
-  return useCallback23(
+  return useCallback24(
     async (appId, pid, dbAuthToken, endpoint) => {
       if (!dbAuthToken || !pid || !dbAuthToken || !endpoint) return;
       const appValues = {
@@ -2030,10 +2092,10 @@ function useCreateUserAppData() {
 }
 
 // src/utils/application/useCreateOrganizationAppData.ts
-import { useCallback as useCallback24 } from "react";
+import { useCallback as useCallback25 } from "react";
 import { v4 as uuid2 } from "uuid";
 function useCreateOrganizationAppData() {
-  return useCallback24(
+  return useCallback25(
     async (appId, pid, dbAuthToken, endpoint) => {
       if (!dbAuthToken || !pid || !dbAuthToken || !endpoint) return;
       const appValues = {
@@ -2087,10 +2149,10 @@ function useCreateOrganizationAppData() {
 }
 
 // src/utils/balance/useFetchBalance.ts
-import { useCallback as useCallback25 } from "react";
+import { useCallback as useCallback26 } from "react";
 import { erc20Abi as erc20Abi3, getAddress } from "viem";
 function useFetchBalance() {
-  return useCallback25(
+  return useCallback26(
     async (publicClient, walletAddress, kibbleTokenAddress) => {
       try {
         const balance = await publicClient.readContract({
@@ -2109,6 +2171,7 @@ function useFetchBalance() {
 }
 export {
   AUTH_API_ENDPOINTS,
+  ActionType,
   NETWORK_HOSTS,
   Network,
   createAuthEnvelope,
@@ -2118,6 +2181,7 @@ export {
   generateJWT,
   loadExistingSecp256k1PrivateKey,
   serializePublicKeyCompressed,
+  submitAction,
   useAddAnymalToDatabase,
   useApproveKibbleToken,
   useApproveOrgPartialPayment,
@@ -2126,6 +2190,7 @@ export {
   useCreateUserAppData,
   useCreateWeb3Account,
   useDeleteAnymalFromDatabase,
+  useFetchActions,
   useFetchAnymals,
   useFetchBalance,
   useFetchNotifications,

package/package.json

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