Add rules engine types and merchant rule AST helpers

src/CONST/index.ts

@@ -8443,6 +8443,7 @@ const CONST = {
     RULES: {
         SCOPE: {
             POLICY: 'policy',
+            ACCOUNT: 'account',
         },
         APPROVAL_WORKFLOW: {
             TRIGGER: {
@@ -8454,6 +8455,27 @@ const CONST = {
                 APPROVE_REPORT: 'ApproveReport',
             },
         },
+        EXPENSE_DEFAULT: {
+            TRIGGER: {
+                CREATE_TRANSACTION: 'CreateTransaction',
+            },
+            ACTION: {
+                SET: 'Set',
+            },
+            /** Expense fields a `Set` action can write to */
+            FIELD: {
+                BILLABLE: 'billable',
+                CATEGORY: 'category',
+                COMMENT: 'comment',
+                MERCHANT: 'merchant',
+                REIMBURSABLE: 'reimbursable',
+                TAG: 'tag',
+                TAX: 'tax',
+                VENDOR_ID: 'vendorID',
+            },
+            /** Every expense default rule is created with the same priority, per the rules engine spec */
+            PRIORITY: 10000,
+        },
     },
 
     BOOT_SPLASH_STATE: {

src/ONYXKEYS.ts

@@ -489,6 +489,9 @@ const ONYXKEYS = {
     /** Set whether the search filters category data has loaded */
     IS_SEARCH_FILTERS_CATEGORY_DATA_LOADED: 'isSearchFiltersCategoryDataLoaded',
 
+    /** Set once `GetRules` has answered, so screens that only consume the rules collection fetch it once */
+    HAS_RULES_DATA_BEEN_FETCHED: 'hasRulesDataBeenFetched',
+
     /** Set while search filter category data is loading */
     RAM_ONLY_IS_LOADING_SEARCH_FILTERS_CATEGORY_DATA: 'isLoadingSearchFiltersCategoryData',
 
@@ -1716,6 +1719,7 @@ type OnyxValuesMapping = {
     [ONYXKEYS.IS_LOADING_REPORT_DATA]: boolean;
     [ONYXKEYS.IS_SEARCH_FILTERS_CARD_DATA_LOADED]: boolean;
     [ONYXKEYS.IS_SEARCH_FILTERS_CATEGORY_DATA_LOADED]: boolean;
+    [ONYXKEYS.HAS_RULES_DATA_BEEN_FETCHED]: boolean;
     [ONYXKEYS.RAM_ONLY_IS_LOADING_SEARCH_FILTERS_CATEGORY_DATA]: boolean;
     [ONYXKEYS.IS_LOADING_SUBSCRIPTION_DATA]: boolean;
     [ONYXKEYS.IS_PENDING_UPDATE_PERSONAL_KARMA]: boolean;

src/components/Tables/WorkspaceExpenseDefaultsTable/WorkspaceExpenseDefaultsTableRow.tsx

@@ -106,7 +106,7 @@ function WorkspaceExpenseDefaultsTableRow({item, rowIndex, shouldUseNarrowTableL
             <Table.Row
                 interactive
                 rowIndex={rowIndex}
-                disabled={isDeleting}
+                disabled={isDeleting || !!item.disabled}
                 accessibilityLabel={accessibilityLabel}
                 sentryLabel={SECTION_SENTRY_LABELS[item.section]}
                 offlineWithFeedback={{

src/hooks/useRulesPrefetch.ts

@@ -0,0 +1,35 @@
+import {getRules} from '@libs/actions/Policy/Rules';
+
+import ONYXKEYS from '@src/ONYXKEYS';
+import isLoadingOnyxValue from '@src/types/utils/isLoadingOnyxValue';
+
+import {useEffect} from 'react';
+
+import useNetwork from './useNetwork';
+import useOnyx from './useOnyx';
+
+/**
+ * Fetches the `rules_` collection for a screen that reads it without opening a workspace.
+ *
+ * Merchant rules used to arrive on the policy, so anything holding a policy could read them. They now
+ * live in their own collection that only `GetRules` populates, which leaves screens reached from the
+ * workspaces list or from Home reading an empty collection. Where that collection decides whether an
+ * option is offered at all, an empty read silently drops the rules rather than showing a stale count.
+ *
+ * `GetRules` takes no parameters and its response SETs the whole collection, so this fetches once per
+ * session rather than on every mount. The shared guards live here so callers cannot drift apart.
+ */
+function useRulesPrefetch(enabled = true) {
+    const {isOffline} = useNetwork();
+    const [hasBeenFetched, hasBeenFetchedResult] = useOnyx(ONYXKEYS.HAS_RULES_DATA_BEEN_FETCHED);
+    const isFetchNeeded = enabled && !isLoadingOnyxValue(hasBeenFetchedResult) && !isOffline && !hasBeenFetched;
+
+    useEffect(() => {
+        if (!isFetchNeeded) {
+            return;
+        }
+        getRules();
+    }, [isFetchNeeded]);
+}
+
+export default useRulesPrefetch;

src/libs/API/parameters/DeleteRuleParams.ts

@@ -0,0 +1,6 @@
+type DeleteRuleParams = {
+    /** The ID of the rule to delete */
+    ruleID: string;
+};
+
+export default DeleteRuleParams;

src/libs/API/parameters/SetRuleParams.ts

@@ -0,0 +1,21 @@
+type SetRuleParams = {
+    /** What kind of entity the rule is scoped to. Merchant rules are always scoped to a policy */
+    scope: string;
+
+    /** The ID of the scoped entity, i.e. the policyID for policy-scoped rules */
+    scopeID: string;
+
+    /** The ID of the rule being written. A new rule uses an optimistic `rand64()` value */
+    ruleID: string;
+
+    /** Determines the order rules are applied in when more than one matches */
+    priority: number;
+
+    /** The `{filters, triggers, actions}` body of the rule, stringified */
+    value: string;
+
+    /** Whether to apply the rule to the transactions that already match it */
+    shouldUpdateMatchingTransactions: boolean;
+};
+
+export default SetRuleParams;

src/libs/API/parameters/index.ts

@@ -605,6 +605,8 @@ export type {default as DeleteDomainParams} from './DeleteDomainParams';
 export type {default as GetDuplicateTransactionDetailsParams} from './GetDuplicateTransactionDetailsParams';
 export type {default as SetPolicyCategoryReceiptsAndItemizedReceiptRequiredParams} from './SetPolicyCategoryReceiptsAndItemizedReceiptRequiredParams';
 export type {default as SetPolicyCodingRuleParams} from './SetPolicyCodingRuleParams';
+export type {default as SetRuleParams} from './SetRuleParams';
+export type {default as DeleteRuleParams} from './DeleteRuleParams';
 export type {default as SetApprovalWorkflowParams} from './SetApprovalWorkflowParams';
 export type {default as RegisterAuthenticationKeyParams} from './RegisterAuthenticationKeyParams';
 export type {default as RevokeMultifactorAuthenticationCredentialsParams} from './RevokeMultifactorAuthenticationCredentialsParams';

src/libs/API/types.ts

@@ -283,6 +283,8 @@ const WRITE_COMMANDS = {
     SET_POLICY_TIME_TRACKING_DEFAULT_RATE: 'SetPolicyTimeTrackingDefaultRate',
     SET_POLICY_RULES_ENABLED: 'SetPolicyRulesEnabled',
     SET_POLICY_CODING_RULE: 'SetPolicyCodingRule',
+    SET_RULE: 'SetRule',
+    DELETE_RULE: 'DeleteRule',
     SET_APPROVAL_WORKFLOW: 'SetApprovalWorkflow',
     SET_POLICY_EXPENSE_MAX_AMOUNT_NO_RECEIPT: 'SetPolicyExpenseMaxAmountNoReceipt',
     SET_POLICY_EXPENSE_MAX_AMOUNT_NO_ITEMIZED_RECEIPT: 'SetPolicyExpenseMaxAmountNoItemizedReceipt',
@@ -993,6 +995,8 @@ type WriteCommandParameters = {
     [WRITE_COMMANDS.ENABLE_POLICY_TIME_TRACKING]: Parameters.EnablePolicyTimeTrackingParams;
     [WRITE_COMMANDS.SET_POLICY_RULES_ENABLED]: Parameters.SetPolicyRulesEnabledParams;
     [WRITE_COMMANDS.SET_POLICY_CODING_RULE]: Parameters.SetPolicyCodingRuleParams;
+    [WRITE_COMMANDS.SET_RULE]: Parameters.SetRuleParams;
+    [WRITE_COMMANDS.DELETE_RULE]: Parameters.DeleteRuleParams;
     [WRITE_COMMANDS.SET_APPROVAL_WORKFLOW]: Parameters.SetApprovalWorkflowParams;
     [WRITE_COMMANDS.SET_POLICY_REQUIRE_COMPANY_CARDS_ENABLED]: Parameters.SetPolicyRequireCompanyCardsEnabledParams;
     [WRITE_COMMANDS.SET_POLICY_CATEGORY_DESCRIPTION_REQUIRED]: Parameters.SetPolicyCategoryDescriptionRequiredParams;
@@ -1507,6 +1511,7 @@ const READ_COMMANDS = {
     OPEN_POLICY_REPORT_FIELDS_PAGE: 'OpenPolicyReportFieldsPage',
     OPEN_POLICY_INVOICES_PAGE: 'OpenPolicyInvoicesPage',
     OPEN_POLICY_RULES_PAGE: 'OpenPolicyRulesPage',
+    GET_RULES: 'GetRules',
     OPEN_POLICY_EXPENSIFY_CARDS_PAGE: 'OpenPolicyExpensifyCardsPage',
     OPEN_POLICY_TRAVEL_PAGE: 'OpenPolicyTravelPage',
     GET_TRAVEL_BILLING_STATEMENT_PDF: 'GetTravelBillingStatementPDF',
@@ -1620,6 +1625,7 @@ type ReadCommandParameters = {
     [READ_COMMANDS.OPEN_POLICY_REPORT_FIELDS_PAGE]: Parameters.OpenPolicyReportFieldsPageParams;
     [READ_COMMANDS.OPEN_POLICY_INVOICES_PAGE]: Parameters.OpenPolicyReportFieldsPageParams;
     [READ_COMMANDS.OPEN_POLICY_RULES_PAGE]: Parameters.OpenPolicyRulesPageParams;
+    [READ_COMMANDS.GET_RULES]: EmptyObject;
     [READ_COMMANDS.OPEN_WORKSPACE_INVITE_PAGE]: Parameters.OpenWorkspaceInvitePageParams;
     [READ_COMMANDS.OPEN_DRAFT_WORKSPACE_REQUEST]: Parameters.OpenDraftWorkspaceRequestParams;
     [READ_COMMANDS.OPEN_DRAFT_PER_DIEM_EXPENSE]: Parameters.OpenDraftPerDiemExpenseParams;