@gearbox-protocol/ui-kit 4.0.0-next.34 → 4.0.0-next.36

package/dist/types/components/base/values/constants.d.ts

@@ -5,6 +5,7 @@ export declare class ValueTest {
     static utilization: string;
     static healthFactor: string;
     static pnl: string;
+    static priceImpact: string;
     static tokenBigint: string;
     static points: string;
     static placeholder: string;

package/dist/types/components/base/values/index.d.ts

@@ -4,4 +4,5 @@ export { PointsValue, type PointsValueProps } from './points-value';
 export { PositionShortLabel, PositionShortLabelTest, } from './position-short-label';
 export { type PositionStatus, PositionStatusBadge, type PositionStatusBadgeProps, } from './position-status-badge';
 export { PositionTypeBadge, type PositionTypeBadgeProps, } from './position-type-badge';
+export { PriceImpactValue, priceImpact } from './price-impact-value';
 export { ApyValue, type ApyValueProps, bps, HealthFactorValue, LeverageValue, TokenBigint, UsdValue, UtilizationValue, } from './scalars';

package/dist/types/components/base/values/pnl-value.d.ts

@@ -1,6 +1,12 @@
 import { PnlBreakdown } from '@gearbox-protocol/sdk/model';
 import { default as React } from 'react';
-/** Realised + unrealised PnL of a position, signed. */
+/**
+ * Realised + unrealised PnL, signed.
+ *
+ * A breakdown (a position's own) or a bare USD figure (a wallet's total, which
+ * the model carries as a plain number) — the same pairing {@link ApyValue}
+ * makes between a breakdown and a bare rate.
+ */
 export declare function PnlValue({ data, }: {
-    readonly data: PnlBreakdown | undefined;
+    readonly data: PnlBreakdown | number | null | undefined;
 }): React.ReactElement;

package/dist/types/components/base/values/price-impact-value.d.ts

@@ -0,0 +1,25 @@
+import { default as React } from 'react';
+/**
+ * A price impact as a percentage.
+ *
+ * The scale is `PERCENTAGE_FACTOR_1KK` — `1_000_000` is 100%, so `-10_000` is
+ * -1% — the legacy price-impact scale, a hundred times finer than the `Bps`
+ * the rest of this module speaks. The conversion is owned here for the same
+ * reason `bps` owns its own: `percentageTemplate` carries a same-named,
+ * differently-scaled twin, so a shared step would inherit that ambiguity.
+ *
+ * A loss is what this figure almost always is, and it prints its own minus.
+ * Only the rare route that beat the marginal price needs its sign spelled out,
+ * or a gain would read as a loss of the same size.
+ */
+export declare function priceImpact(value: bigint): string;
+/**
+ * What a routed operation gave up to market depth.
+ *
+ * Which of the three rates a caller shows — against the routed output, the
+ * equity or the position — is the caller's choice; this renders the one it is
+ * handed.
+ */
+export declare function PriceImpactValue({ data, }: {
+    readonly data: bigint | undefined;
+}): React.ReactElement;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/ui-kit",
-  "version": "4.0.0-next.34",
+  "version": "4.0.0-next.36",
   "description": "Internal UI components",
   "repository": {
     "type": "git",