feat: pass govtool metadata validator to pdf pillar

docs/GOVERNANCE_ACTION_SUBMISSION.md

@@ -144,3 +144,46 @@ await buildSignSubmitConwayCertTx({
 ### Step 6: Verify the Governance Action
 
 `buildSignSubmitConwayCertTx` logs the transaction CBOR making it able to be tracked on the transactions tools such as cexplorer.
+
+## Additional steps for using the GovTool metadata validation on the imported Pillar component
+
+```tsx
+enum MetadataValidationStatus {
+  URL_NOT_FOUND = "URL_NOT_FOUND",
+  INVALID_JSONLD = "INVALID_JSONLD",
+  INVALID_HASH = "INVALID_HASH",
+  INCORRECT_FORMAT = "INCORRECT_FORMAT",
+}
+// Using the props passed to the component
+type Props = {
+  validateMetadata: ({
+    url,
+    hash,
+    standard,
+  }: {
+    url: string;
+    hash: string;
+    standard: "CIP108";
+  }) => Promise<{
+    metadata?: any;
+    status?: MetadataValidationStatus;
+    valid: boolean;
+  }>;
+};
+
+import React, { Suspense } from "react";
+
+const SomeImportedPillar: React.FC<Props> = React.lazy(
+  () => import("path/to/SomeImportedPillar")
+);
+
+const SomeWrapperComponent = () => {
+  const { validateMetadata } = useValidateMutation();
+
+  return (
+    <Suspense fallback={<div>I am lazy loading...</div>}>
+      <SomeImportedPillar validateMetadata={validateMetadata} />
+    </Suspense>
+  );
+};
+```

govtool/frontend/src/components/organisms/PDFWrapper.tsx

@@ -1,11 +1,15 @@
-import React, { Suspense } from "react";
+import React, { ComponentProps, Suspense } from "react";
 import { Box, CircularProgress } from "@mui/material";
 import "@intersect.mbo/pdf-ui/style";
 import { useCardano, useGovernanceActions } from "@/context";
+import { useValidateMutation } from "@/hooks/mutations";
 
-const PDF = React.lazy(() => import("@intersect.mbo/pdf-ui/cjs"));
+const ProposalDiscussion = React.lazy(
+  () => import("@intersect.mbo/pdf-ui/cjs"),
+);
 
 export const PDFWrapper = () => {
+  const { validateMetadata } = useValidateMutation();
   const { walletApi, ...context } = useCardano();
   const { createGovernanceActionJsonLD, createHash } = useGovernanceActions();
 
@@ -33,14 +37,19 @@ export const PDFWrapper = () => {
           </Box>
         }
       >
-        <PDF
+        <ProposalDiscussion
           walletAPI={{
             ...context,
             ...walletApi,
             createGovernanceActionJsonLD,
             createHash,
           }}
           pathname={window.location.pathname}
+          validateMetadata={
+            validateMetadata as ComponentProps<
+              typeof ProposalDiscussion
+            >["validateMetadata"]
+          }
         />
       </Suspense>
     </Box>

govtool/frontend/src/types/@intersect.mbo.d.ts

@@ -1,10 +1,32 @@
-type PDFProps = {
+enum MetadataValidationStatus {
+  URL_NOT_FOUND = "URL_NOT_FOUND",
+  INVALID_JSONLD = "INVALID_JSONLD",
+  INVALID_HASH = "INVALID_HASH",
+  INCORRECT_FORMAT = "INCORRECT_FORMAT",
+}
+
+type ProposalDiscussionProps = {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   walletAPI: any;
   pathname: string;
   locale?: string;
+  validateMetadata: ({
+    url,
+    hash,
+    standard,
+  }: {
+    url: string;
+    hash: string;
+    standard: "CIP108";
+  }) => Promise<
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    | { status?: MetadataValidationStatus; metadata?: any; valid: boolean }
+    | undefined
+  >;
 };
 
 declare module "@intersect.mbo/pdf-ui/cjs" {
-  export default function PDF(props: PDFProps): JSX.Element;
+  export default function ProposalDiscussion(
+    props: ProposalDiscussionProps,
+  ): JSX.Element;
 }