@liberfi.io/ui-predict 0.1.70 → 0.1.72

package/dist/client-DgC5flVr.d.ts

@@ -1,201 +0,0 @@
-/**
- * V2 types for the prediction-server REST API (/api/v1/events).
- *
- * These types are intentionally isolated from the legacy client types so that
- * the v1 (DFlow) and v2 (prediction-server) clients can coexist and be migrated
- * incrementally.
- *
- * Mirrors: github.com/liberfi-io/prediction-server/internal/domain
- */
-/** Upstream data provider that produced a domain object. */
-type V2ProviderSource = "dflow" | "polymarket";
-/**
- * Provider-specific metadata attached to every domain aggregate.
- * Keys are namespaced field paths, e.g. "polymarket.conditionId" or "dflow.yesMint".
- * Values are raw JSON-decoded values.
- */
-type V2ProviderMeta = Record<string, unknown>;
-/** Provider-sourced label attached to an Event. */
-interface V2Tag {
-    slug: string;
-    label: string;
-    source: V2ProviderSource;
-    provider_meta?: V2ProviderMeta;
-}
-/** Lifecycle status of a prediction event (normalised across all providers). */
-type V2EventStatus = "pending" | "open" | "closed" | "voided";
-/** Settlement / resolution data source for an event. */
-interface V2SettlementSource {
-    url: string;
-    name?: string;
-}
-/** Root aggregate for a prediction event from the prediction-server API. */
-interface V2Event {
-    /** Internal database surrogate key (absent when not yet persisted). */
-    id?: number;
-    /**
-     * Canonical business key shared across all providers.
-     * - DFlow:      ticker (e.g. "KXBTCD-25FEB-T68000")
-     * - Polymarket: slug   (e.g. "will-trump-win-2024")
-     */
-    slug: string;
-    title: string;
-    subtitle?: string;
-    description?: string;
-    image_url?: string;
-    status: V2EventStatus;
-    /** ISO 8601 timestamp; absent if the provider does not supply it. */
-    start_at?: string;
-    end_at?: string;
-    created_at?: string;
-    updated_at?: string;
-    /** Provider-sourced labels for display only. */
-    tags?: V2Tag[];
-    /** All values are USD amounts. */
-    volume?: number;
-    volume_24h?: number;
-    liquidity?: number;
-    open_interest?: number;
-    settlement_sources?: V2SettlementSource[];
-    /** Nested markets; omitted when the request used `with_markets=false`. */
-    markets?: V2Market[];
-    source: V2ProviderSource;
-    provider_meta?: V2ProviderMeta;
-}
-/** Lifecycle status of a prediction market (normalised across all providers). */
-type V2MarketStatus = "pending" | "open" | "closed" | "voided";
-/** Final resolution of a closed market. Empty string means unresolved. */
-type V2MarketResult = "yes" | "no" | "voided" | "";
-/** One possible outcome in a binary (or multi-outcome) prediction market. */
-interface V2Outcome {
-    /** Display name, e.g. "Yes" or "No". */
-    label: string;
-    /** Current implied probability [0, 1]. */
-    price?: number;
-    best_bid?: number;
-    best_ask?: number;
-}
-/** Tradeable prediction outcome within an Event. */
-interface V2Market {
-    id?: number;
-    event_id?: number;
-    slug: string;
-    event_slug: string;
-    question: string;
-    description?: string;
-    /** Resolution/settlement rules in order. */
-    rules?: string[];
-    status: V2MarketStatus;
-    result?: V2MarketResult;
-    start_at?: string;
-    end_at?: string;
-    expires_at?: string;
-    created_at?: string;
-    updated_at?: string;
-    /** Always present; binary markets have exactly 2 outcomes (YES at [0], NO at [1]). */
-    outcomes: V2Outcome[];
-    volume?: number;
-    volume_24h?: number;
-    liquidity?: number;
-    open_interest?: number;
-    source: V2ProviderSource;
-    provider_meta?: V2ProviderMeta;
-}
-/** Generic paginated result set returned by the prediction-server list endpoints. */
-interface V2Page<T> {
-    items: T[];
-    next_cursor?: string;
-    has_more?: boolean;
-    limit?: number;
-    /** Not all backends support total count. */
-    total?: number;
-}
-/** Valid sort fields accepted by `GET /api/v1/events`. */
-type V2EventSortField = "volume" | "volume_24h" | "liquidity" | "open_interest" | "end_at" | "start_at" | "created_at";
-/** Query parameters for `listEvents`. All fields are optional. */
-interface V2ListEventsParams {
-    /** Page size. Server default: 20. */
-    limit?: number;
-    /** Opaque pagination cursor returned by the previous page's `next_cursor`. */
-    cursor?: string;
-    /** Filter by event lifecycle status. */
-    status?: V2EventStatus;
-    /** Filter by upstream provider. */
-    source?: V2ProviderSource;
-    /** Unified navigation tag slug (e.g. "politics", "sports"). */
-    tag_slug?: string;
-    /** Full-text search query. */
-    search?: string;
-    /** Field to sort by. */
-    sort_by?: V2EventSortField;
-    /** When `true`, sort ascending. Defaults to descending. */
-    sort_asc?: boolean;
-    /**
-     * When `false`, markets are omitted from each event for lighter payloads.
-     * Defaults to `true` on the server.
-     */
-    with_markets?: boolean;
-}
-
-/**
- * HTTP client for the prediction-server REST API (v2 / prediction-server backend).
- *
- * Covers `GET /api/v1/events` (listEvents), `GET /api/v1/events/:slug` (getEvent),
- * and `GET /api/v1/markets/:slug` (getMarket).
- *
- * This client is intentionally decoupled from the legacy `DflowPredictClient` so
- * that both can be used in parallel during the incremental migration from the old
- * DFlow-direct integration to the unified prediction-server backend.
- *
- * @example
- * ```ts
- * const client = new PredictClientV2("https://api.example.com");
- * const page = await client.listEvents({ status: "open", limit: 20 });
- * const event = await client.getEvent("will-trump-win-2024");
- * const market = await client.getMarket("will-trump-win-2024-yes");
- * ```
- */
-declare class PredictClientV2 {
-    private readonly endpoint;
-    constructor(endpoint: string);
-    /**
-     * List prediction events with optional filtering, sorting, and pagination.
-     *
-     * Maps to `GET /api/v1/events`.
-     *
-     * @param params - Optional query parameters (filter, sort, pagination).
-     * @returns A paginated page of events.
-     */
-    listEvents(params?: V2ListEventsParams): Promise<V2Page<V2Event>>;
-    /**
-     * Fetch a single prediction event by its slug.
-     *
-     * Maps to `GET /api/v1/events/:slug?source=...`.
-     *
-     * @param slug - Canonical event slug (e.g. "will-trump-win-2024" for Polymarket
-     *               or "KXBTCD-25FEB-T68000" for DFlow).
-     * @param source - Upstream provider (`"dflow"` or `"polymarket"`).
-     * @returns The matching event.
-     * @throws When the server responds with 404 or any other non-2xx status.
-     */
-    getEvent(slug: string, source?: V2ProviderSource): Promise<V2Event>;
-    /**
-     * Fetch a single prediction market by its slug.
-     *
-     * Maps to `GET /api/v1/markets/:slug?source=...`.
-     *
-     * @param slug - Canonical market slug.
-     * @param source - Upstream provider (`"dflow"` or `"polymarket"`).
-     * @returns The matching market.
-     * @throws When the server responds with 404 or any other non-2xx status.
-     */
-    getMarket(slug: string, source?: V2ProviderSource): Promise<V2Market>;
-}
-/**
- * Factory function for `PredictClientV2`.
- *
- * @param endpoint - Base URL of the prediction-server, without a trailing slash.
- */
-declare function createPredictClientV2(endpoint: string): PredictClientV2;
-
-export { PredictClientV2 as P, type V2EventSortField as V, type V2ProviderSource as a, type V2Event as b, type V2Market as c, type V2EventStatus as d, type V2Page as e, type V2ListEventsParams as f, createPredictClientV2 as g, type V2MarketResult as h, type V2MarketStatus as i, type V2Outcome as j, type V2ProviderMeta as k, type V2SettlementSource as l, type V2Tag as m };