@gearbox-protocol/sdk 14.12.0-next.77 → 14.12.0-next.79

package/dist/types/model/positions.d.ts

@@ -1,4 +1,5 @@
 import { AssetType, Bps, ChainId, Leverage, Token, TokenAmount } from "./primitives.js";
+import { Filterable } from "./filters.js";
 import { ApyBreakdown, PointsProgram } from "./opportunities.js";
 import { DelayedReceivedAsset, LiquidationPosition } from "./liquidations.js";
 import { Address } from "viem";
@@ -258,45 +259,48 @@ declare function positionId(position: Position): PositionId;
 /**
  * Optional narrowing of a positions list.
  *
- * Every criterion is optional and an omitted one matches any value, so an empty
- * filter is the same as no filter at all. Criteria combine with AND.
+ * Every condition is optional and an omitted one matches any value, so an
+ * empty filter is the same as no filter at all. A condition can also be set to
+ * `"all"` to say the same thing explicitly, which is what a UI whose state has
+ * an "any" option holds, see {@link Filterable}. Conditions combine with AND.
  **/
 interface PositionFilter {
   /**
    * Keep only positions of this kind.
    **/
-  kind?: PositionKind;
+  kind?: Filterable<PositionKind>;
   /**
    * Keep only credit accounts that carry no debt, or only the ones that do.
    * Applicable only to {@link StrategyPosition}
    **/
-  isZeroDebt?: boolean;
+  isZeroDebt?: Filterable<boolean>;
   /**
    * Keep only positions on these chains.
    **/
-  chainIds?: ChainId[];
+  chainIds?: Filterable<ChainId[]>;
   /**
    * Keep only positions whose underlying is of this class, which for an RWA
    * market means the class of the token its wrapper holds.
    *
    * Not applicable to {@link LiquidationPosition}
    **/
-  underlyingType?: AssetType;
+  underlyingType?: Filterable<AssetType>;
 }
 /**
- * Whether a position satisfies every criterion of a filter.
+ * Whether a position satisfies every condition of a filter.
  *
- * This is the single definition of what each criterion means: every source
+ * This is the single definition of what each condition means: every source
  * builds its rows first and runs them through here, so the chain and the
  * backend cannot disagree on what a filter selects.
  *
- * A criterion that does not apply to a position's kind keeps the row rather
+ * A condition that does not apply to a position's kind keeps the row rather
  * than dropping it: `isZeroDebt` says nothing about a pool position, and
  * `underlyingType` says nothing about a liquidation position, which is
  * denominated in whatever its withdrawal pays out.
  *
  * @param position - Row to test.
- * @param filter - Criteria to test against. An absent filter matches anything.
+ * @param filter - Conditions to test against. An absent filter matches
+ * anything.
  **/
 declare function matchesPositionFilter(position: Position, filter?: PositionFilter): boolean;
 /**