Merge pull request #412 from MJigah/feature/field-selection

Add field selection (projection) to SDK read methods

Author: Kingsman-99

src/client.ts

@@ -60,6 +60,7 @@ import { compilePaymentReceipt } from "./receipt.js";
 import type { PaymentReceipt } from "./receipt.js";
 import type {
   ArchivedInvoice,
+
   ArbiterVote,
   AuctionInfo,
   DisputeStatus,
@@ -1483,7 +1484,9 @@ export class StellarSplitClient {
     invoiceId: string,
     opts?: { retry?: PerMethodRetryOptions; dedupe?: boolean; traceId?: string; timeout?: number }
   ): Promise<Invoice> {
+
     return this._withCache("getInvoice", [invoiceId], async () => {
+
       const fetcher = this._batcher
         ? () => this._batcher!.getInvoice(invoiceId)
         : () => this._fetchInvoice(invoiceId, opts?.traceId);

src/types.ts

@@ -183,27 +183,27 @@ export interface Invoice {
  */
 export type SplitRule =
   | {
-    /** Recipient receives a fixed amount in stroops (capped at remaining funds). */
-    kind: "Fixed";
-    recipient: string;
-    amount: bigint;
-  }
+      /** Recipient receives a fixed amount in stroops (capped at remaining funds). */
+      kind: "Fixed";
+      recipient: string;
+      amount: bigint;
+    }
   | {
-    /** Recipient receives `bps` basis points of the funded amount. */
-    kind: "Percentage";
-    recipient: string;
-    bps: number;
-  }
+      /** Recipient receives `bps` basis points of the funded amount. */
+      kind: "Percentage";
+      recipient: string;
+      bps: number;
+    }
   | {
-    /**
-     * Recipient receives a marginal-band share: for each tier, `bps` is
-     * applied to the portion of funds falling between the previous tier's
-     * `upTo` and this tier's `upTo`.
-     */
-    kind: "Tiered";
-    recipient: string;
-    tiers: { upTo: bigint; bps: number }[];
-  };
+      /**
+       * Recipient receives a marginal-band share: for each tier, `bps` is
+       * applied to the portion of funds falling between the previous tier's
+       * `upTo` and this tier's `upTo`.
+       */
+      kind: "Tiered";
+      recipient: string;
+      tiers: { upTo: bigint; bps: number }[];
+    };
 
 /** A single recipient's previewed payout under the configured split rules. */
 export interface SplitPreviewEntry {
@@ -533,6 +533,9 @@ export interface CloneOverrides {
   newOverflowBehavior?: OverflowBehavior;
 }
 
+/** Field names supported by read methods that can return partial objects. */
+export type InvoiceField = keyof Invoice;
+
 /** Extended invoice data from get_invoice_ext. */
 export interface InvoiceExt {
   parentInvoiceId: string | null;
@@ -790,4 +793,3 @@ export interface SetCrossChainRefParams {
   /** Cross-chain reference data. */
   ref: CrossChainRef;
 }
-