refactor: use TypeScript overloads for parseTransactionFlags

Address CodeRabbit review feedback: replace union signature with
proper overloads to prevent invalid call shapes.

- Add ParseTransactionFlagsOptions interface
- Overload 1: parseTransactionFlags(tx, options?) for Transaction objects
- Overload 2: parseTransactionFlags(txType, flagsNum, options?) for strings
- Update tests to use new overload-friendly calling convention

Author: slurpyone

packages/xrpl/src/models/utils/flags.ts

@@ -142,6 +142,14 @@ export function convertTxFlagsToNumber(tx: Transaction): number {
   }, 0)
 }
 
+/**
+ * Options for {@link parseTransactionFlags}.
+ */
+export interface ParseTransactionFlagsOptions {
+  /** Set to `true` to include disabled flags (as `false`) in the result. */
+  includeAll?: boolean
+}
+
 /**
  * Convert a Transaction flags property into a map for easy interpretation.
  *
@@ -173,20 +181,32 @@ export function convertTxFlagsToNumber(tx: Transaction): number {
  * @param options.includeAll - Set to `true` to include disabled flags.
  * @returns A map of flag names to booleans.
  */
+export function parseTransactionFlags(
+  tx: Transaction,
+  options?: ParseTransactionFlagsOptions,
+): Record<string, boolean>
+export function parseTransactionFlags(
+  txType: string,
+  flagsNum: number,
+  options?: ParseTransactionFlagsOptions,
+): Record<string, boolean>
 export function parseTransactionFlags(
   txOrType: Transaction | string,
-  flagsNum?: number,
-  options?: { includeAll?: boolean },
+  flagsNumOrOptions?: number | ParseTransactionFlagsOptions,
+  maybeOptions?: ParseTransactionFlagsOptions,
 ): Record<string, boolean> {
   let flags: number
   let transactionType: string
+  let options: ParseTransactionFlagsOptions | undefined
 
   if (typeof txOrType === 'string') {
     transactionType = txOrType
-    flags = flagsNum ?? 0
+    flags = (flagsNumOrOptions as number) ?? 0
+    options = maybeOptions
   } else {
     transactionType = txOrType.TransactionType
     flags = convertTxFlagsToNumber(txOrType)
+    options = flagsNumOrOptions as ParseTransactionFlagsOptions | undefined
   }
 
   const includeAll = options?.includeAll ?? false

packages/xrpl/test/models/utils.test.ts

@@ -441,7 +441,7 @@ describe('Models Utils', function () {
         Flags: PaymentChannelClaimFlags.tfRenew,
       }
 
-      const flagsMap = parseTransactionFlags(tx, undefined, {
+      const flagsMap = parseTransactionFlags(tx, {
         includeAll: true,
       })
       assert.deepEqual(flagsMap, {