Implementing optimistic violations for workspace categories and tags.

src/hooks/usePolicyData/index.ts

@@ -0,0 +1,62 @@
+import {useMemo} from 'react';
+import {useAllReportsTransactionsAndViolations} from '@components/OnyxListItemProvider';
+import useOnyx from '@hooks/useOnyx';
+import usePolicy from '@hooks/usePolicy';
+import ONYXKEYS from '@src/ONYXKEYS';
+import type {Policy, Report} from '@src/types/onyx';
+import type {ReportTransactionsAndViolationsDerivedValue} from '@src/types/onyx/DerivedValues';
+import type {OnyxValueWithOfflineFeedback} from '@src/types/onyx/OnyxCommon';
+import type PolicyData from './types';
+
+/**
+ * Retrieves policy tags, categories, reports and their associated transactions and violations.
+ * @param policyID The ID of the policy to retrieve data for.
+ * @returns An object containing policy data
+ */
+function usePolicyData(policyID?: string): PolicyData {
+    const policy = usePolicy(policyID);
+    const allReportsTransactionsAndViolations = useAllReportsTransactionsAndViolations();
+    const [tags] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${policyID}`, {canBeMissing: true}, [policyID]);
+    const [categories] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY_CATEGORIES}${policyID}`, {canBeMissing: true}, [policyID]);
+    const [reports] = useOnyx(
+        ONYXKEYS.COLLECTION.REPORT,
+        {
+            canBeMissing: true,
+            selector: (allReports) => {
+                if (!policyID || !allReports || !allReportsTransactionsAndViolations) {
+                    return {};
+                }
+
+                // Filter reports to only include those that belong to the specified policy and have associated transactions
+                return Object.keys(allReportsTransactionsAndViolations).reduce<Record<string, Report>>((acc, reportID) => {
+                    const policyReport = allReports[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`];
+                    if (policyReport?.policyID === policyID) {
+                        acc[reportID] = policyReport;
+                    }
+                    return acc;
+                }, {});
+            },
+        },
+        [policyID, allReportsTransactionsAndViolations],
+    );
+    const transactionsAndViolations = useMemo(() => {
+        if (!reports || !allReportsTransactionsAndViolations) {
+            return {};
+        }
+        return Object.keys(reports).reduce<ReportTransactionsAndViolationsDerivedValue>((acc, reportID) => {
+            if (allReportsTransactionsAndViolations[reportID]) {
+                acc[reportID] = allReportsTransactionsAndViolations[reportID];
+            }
+            return acc;
+        }, {});
+    }, [reports, allReportsTransactionsAndViolations]);
+    return {
+        transactionsAndViolations,
+        tags: tags ?? {},
+        categories: categories ?? {},
+        policy: policy as OnyxValueWithOfflineFeedback<Policy>,
+        reports: Object.values(reports ?? {}) as Array<OnyxValueWithOfflineFeedback<Report>>,
+    };
+}
+
+export default usePolicyData;

src/hooks/usePolicyData/types.ts

@@ -0,0 +1,13 @@
+import type {Policy, PolicyCategories, PolicyTagLists, Report} from '@src/types/onyx';
+import type {ReportTransactionsAndViolationsDerivedValue} from '@src/types/onyx/DerivedValues';
+import type {OnyxValueWithOfflineFeedback} from '@src/types/onyx/OnyxCommon';
+
+type PolicyData = {
+    policy: OnyxValueWithOfflineFeedback<Policy>;
+    tags: PolicyTagLists;
+    categories: PolicyCategories;
+    reports: Array<OnyxValueWithOfflineFeedback<Report>>;
+    transactionsAndViolations: ReportTransactionsAndViolationsDerivedValue;
+};
+
+export default PolicyData;