@openmarketsai/order-sheet 0.1.0

package/dist/wire.d.ts

@@ -0,0 +1,382 @@
+/**
+ * Wire shapes — what the OpenMarkets Flow API actually sends and receives, in the
+ * API's own snake_case. Mirrors src/types/api-contracts/flow-v1.ts on the server;
+ * the repo's src/__tests__/sdk/order-sheet-contract.test.ts pins these to it at
+ * compile time so they cannot drift. Everything the SDK derives (camelCase
+ * `VenueOption`, `Quote`, `Issue`) lives in ./types.ts.
+ */
+import type { IssueCode, IssueFix } from './generated/contract.js';
+export type { IssueCode, IssueFix };
+export type MoneyMode = 'paper' | 'real';
+export type OrderType = 'market' | 'limit';
+export type StakeUnit = 'amount' | 'shares';
+export type PriceFormat = 'decimal_probability' | 'american' | 'cents';
+export type ZeroFillMarketStatus = 'failed' | 'pending' | 'resting';
+export type FeeDirection = 'on_top' | 'from_payout';
+export type Environment = 'live' | 'test';
+export type IssueSeverity = 'block' | 'warn' | 'info';
+export type IssueScope = 'account' | 'venue' | 'leg' | 'request';
+export interface SuccessEnvelope<T> {
+    data: T;
+    meta?: {
+        timestamp: string;
+        api_version: 'v1';
+    };
+    pagination?: {
+        next_cursor: string | null;
+        has_more: boolean;
+        limit: number;
+    };
+}
+export interface ErrorEnvelope {
+    error: {
+        code: string;
+        message: string;
+        details?: Record<string, unknown>;
+    };
+}
+/** One reason, as the server authors it (constraints reasons, preflight warnings, buy/preflight rejections). */
+export interface OrderIssue {
+    code: IssueCode;
+    severity: IssueSeverity;
+    message: string;
+    detail: string | null;
+    fix: IssueFix;
+    scope: IssueScope;
+}
+export interface OrderEligibility {
+    ok: boolean;
+    issues: OrderIssue[];
+}
+export interface VenueSizeConstraints {
+    min_usd: number;
+    max_usd: number | null;
+    increment_usd: number | null;
+    whole_contracts: boolean;
+    min_contracts: number;
+    full_fill_bypasses_min: boolean;
+}
+export interface VenuePriceConstraints {
+    submitted: boolean;
+    format: PriceFormat;
+    /** Probability tick; null = the server snaps (non-linear ladder) and the client must not. */
+    tick: number | null;
+    min: number;
+    max: number;
+    native: {
+        tick: number;
+        min: number | null;
+        max: number | null;
+    };
+}
+export interface VenueFeeConstraints {
+    direction: FeeDirection | null;
+    sample: {
+        stake_usd: number;
+        price: number;
+        taker_fee: number;
+        maker_fee: number;
+        taker_price: number;
+        maker_price: number;
+    } | null;
+}
+export interface VenueAccountState {
+    connected: boolean;
+    status: 'active' | 'inactive' | null;
+    credential_status: 'pending' | 'failed' | 'connected' | null;
+    currency: string | null;
+    balance: number | null;
+    expected_balance: number | null;
+    pending: number | null;
+    is_stale: boolean;
+    balance_version: number | null;
+    scope_trade_execute: boolean;
+}
+export interface VenueConstraints {
+    partner_id: string;
+    name: string;
+    logo_url: string | null;
+    orders_allowed: boolean;
+    connectable: boolean;
+    cancel_supported: boolean;
+    order_types: OrderType[];
+    fill_semantics: {
+        zero_fill_market: ZeroFillMarketStatus;
+    };
+    account: VenueAccountState;
+    eligibility: {
+        paper: OrderEligibility;
+        real: OrderEligibility;
+    };
+    size: VenueSizeConstraints;
+    price: VenuePriceConstraints;
+    fees: VenueFeeConstraints;
+}
+export interface AccountConstraints {
+    router_account_id: string;
+    environment: Environment;
+    is_fiduciary: boolean;
+    can_execute: boolean;
+    can_practice: boolean;
+    money_modes: MoneyMode[];
+    issues: OrderIssue[];
+    practice_wallet: {
+        partner_id: string | null;
+        currency: string;
+        balance: number | null;
+    };
+    policy: {
+        practice_only: boolean;
+        max_stake_per_order: number | null;
+        venue_allowlist: string[] | null;
+    };
+}
+export interface OrderConstraints {
+    constraints_version: string;
+    account: AccountConstraints;
+    venues: VenueConstraints[];
+}
+export interface Me {
+    auth_method: 'api_key' | 'jwt';
+    router_account_id: string | null;
+    can_execute: boolean;
+    can_practice: boolean;
+    environment: Environment | null;
+    money_modes: MoneyMode[];
+    entitlements: string[];
+}
+export interface FeePacket {
+    taker_price: number;
+    maker_price: number;
+    /** Absolute fee on a canonical $100 stake. */
+    taker_fee: number;
+    maker_fee: number;
+}
+export interface PartnerLiquidity {
+    partner_id: string;
+    partner_name?: string;
+    /** Probability 0–1, before fees. 0 when not actionable. */
+    price: number;
+    american_odds: string | null;
+    /** USD buyable at `price`. */
+    available: number;
+    actionable: boolean;
+    /** Model edges keyed by distribution (always present upstream); the sheet does not read them. */
+    edges: Record<string, number>;
+    fee_packet?: FeePacket;
+    liquidity_hash?: string;
+    buy_id?: string;
+}
+export interface Position {
+    position_hash: string;
+    contest_id: string;
+    title: string;
+    market_key?: string;
+    market_label?: string;
+    variable?: number;
+    side_key?: string;
+    participant_id?: string;
+    participant_name?: string;
+    participant_image_url?: string | null;
+    consensus_price?: number;
+    partner_liquidities: PartnerLiquidity[];
+    paper_bettable: boolean;
+}
+export interface BuyLeg {
+    position_hash?: string;
+    liquidity_hash?: string;
+    amount?: number;
+    shares?: number;
+    max_price: number;
+    partner_id?: string;
+    /** The SDK ALWAYS sends it. The API's own default is 'real'. */
+    mode: MoneyMode;
+    order_type?: OrderType;
+}
+export interface BuyRequest {
+    orders: BuyLeg[];
+    verify_liquidity?: boolean;
+    on_leg_failure?: 'continue' | 'halt';
+    check_all_first?: boolean;
+    placement?: 'sequential' | 'parallel';
+    opportunity_id?: string;
+    model_id?: string;
+}
+export interface BuyLegVenue {
+    partner_id: string;
+    success: boolean;
+    router_order_id: string | null;
+    error: string | null;
+}
+export type BuyLegStatus = 'completed' | 'resting' | 'pending' | 'failed' | 'rejected';
+export interface BuyLegResult {
+    index: number;
+    status: BuyLegStatus;
+    sor_decision_id: string | null;
+    requested_partner_id: string | null;
+    filled_notional: number;
+    filled_shares: number;
+    unfilled_notional: number;
+    avg_price: number | null;
+    rejected_reason: string | null;
+    rejected_code: IssueCode | null;
+    message_user: string | null;
+    fix: IssueFix | null;
+    venues: BuyLegVenue[];
+}
+export interface BuyResponse {
+    results: BuyLegResult[];
+    halted_at_index: number | null;
+    opportunity_id: string | null;
+    model_id: string | null;
+}
+export interface PreflightVenue {
+    partner_id: string;
+    expected_price: number;
+    allocated_amount: number;
+    fee_packet: FeePacket | null;
+    verified: boolean;
+    live_available: number | null;
+    live_price: number | null;
+}
+export interface PreflightLegResult {
+    index: number;
+    requested_partner_id: string | null;
+    accepted: boolean;
+    rejected_reason: string | null;
+    rejected_code: IssueCode | null;
+    message_user: string | null;
+    fix: IssueFix | null;
+    warnings: OrderIssue[];
+    normalized: {
+        max_price: number;
+        amount: number;
+        contracts: number;
+        price_basis: number;
+    };
+    would_rest: boolean;
+    expected_fill_price: number;
+    total_allocated: number;
+    unfilled_amount: number;
+    total_taker_fee: number;
+    total_maker_fee: number;
+    total_cost_taker: number;
+    venues: PreflightVenue[];
+}
+export interface PreflightResponse {
+    results: PreflightLegResult[];
+    halted_at_index: number | null;
+}
+export interface RestingOrder {
+    router_order_id: string;
+    title: string;
+    partner_id: string;
+    partner_name: string;
+    amount: number;
+    price: number;
+    fill_status: 'unfilled' | 'partially_filled' | 'filled';
+    filled_amt: number;
+    unfilled_amt: number;
+    placed_at: string;
+    seconds_since_placed: number;
+}
+export interface RestingOrdersResponse {
+    orders: RestingOrder[];
+    count: number;
+}
+export interface CancelRequest {
+    router_order_ids: string[];
+}
+export interface CancelResponse {
+    message: string;
+    /** The cancelled orders (full order rows upstream; the sheet reads the id). */
+    cancelled: Array<{
+        router_order_id: string;
+    }>;
+    skipped: {
+        router_order_id: string;
+        reason: string;
+    }[];
+    errors: {
+        router_order_id: string;
+        error: string;
+    }[];
+}
+/** The fields of GET /flow/v1/auth/orders rows the sheet's poll fallback reads. */
+export interface OrderRow {
+    router_order_id: string;
+    partner_id: string;
+    contest_id: string;
+    status: string;
+    fill_status: 'unfilled' | 'partially_filled' | 'filled' | null;
+    filled_amt: number | null;
+    unfilled_amt: number | null;
+    price: number;
+    amount: number;
+    result?: 'win' | 'lose' | 'push' | null;
+    net_winnings?: number | null;
+    winnings?: number | null;
+    [k: string]: unknown;
+}
+export interface StreamConnected {
+    type: 'connected';
+    organization_id: string;
+    api_key_id: string;
+    server_time: string;
+}
+export interface StreamSubscribed {
+    type: 'subscribed';
+    channel: string;
+    contest_ids: string[];
+    account_ids?: string[];
+    all?: boolean;
+}
+export interface StreamOrderUpdate {
+    type: 'order.update';
+    router_order_id: string;
+    partner_id: string;
+    router_contest_id: string | null;
+    status: string;
+    fill_status: string;
+    filled_amt: number;
+    unfilled_amt: number;
+    avg_price: number | null;
+    timestamp: string;
+}
+export interface StreamOrderSettled {
+    type: 'order.settled';
+    router_order_id: string;
+    partner_id: string;
+    router_contest_id: string | null;
+    result: 'win' | 'lose' | 'push';
+    winnings: number;
+    net_winnings: number;
+    timestamp: string;
+}
+export interface StreamBalanceUpdate {
+    type: 'balance.update';
+    account_partner_id: string;
+    partner_id: string;
+    currency: string;
+    balance: number;
+    venue_balance?: number;
+    pending: number;
+    balance_version: number;
+    balance_as_of: string | null;
+    cause?: string;
+    router_order_id: string | null;
+    timestamp: string;
+}
+export interface StreamError {
+    type: 'error';
+    code: string;
+    message: string;
+}
+export interface StreamPong {
+    type: 'pong';
+    server_time: string;
+}
+export type StreamServerMessage = StreamConnected | StreamSubscribed | StreamOrderUpdate | StreamOrderSettled | StreamBalanceUpdate | StreamError | StreamPong | {
+    type: string;
+    [k: string]: unknown;
+};

package/dist/wire.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=wire.js.map

package/dist/wire.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wire.js","sourceRoot":"","sources":["../src/wire.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@openmarketsai/order-sheet",
+  "version": "0.1.0",
+  "description": "The bet slip, solved: every venue's rules, fees and balances checked before the tap \u2014 headless core, React hooks, and a themeable styled sheet for apps built on the OpenMarkets API.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "sideEffects": [
+    "./dist/ui/styles.css"
+  ],
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "import": "./dist/react.js",
+      "require": "./dist/react.cjs"
+    },
+    "./ui": {
+      "types": "./dist/ui.d.ts",
+      "import": "./dist/ui.js",
+      "require": "./dist/ui.cjs"
+    },
+    "./ui/styles.css": "./dist/ui/styles.css"
+  },
+  "scripts": {
+    "build": "node ./scripts/build.mjs",
+    "test": "vitest run",
+    "type-check": "tsc --noEmit",
+    "prepublishOnly": "npm run type-check && npm run test && npm run build",
+    "example": "esbuild example/demo.tsx --bundle --jsx=automatic --outfile=example/dist/demo.js --servedir=example --serve=8000"
+  },
+  "keywords": [
+    "openmarkets",
+    "bet-slip",
+    "order-sheet",
+    "prediction-markets",
+    "sports-betting",
+    "sdk",
+    "react"
+  ],
+  "peerDependencies": {
+    "react": ">=18"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/react": "^19",
+    "esbuild": "^0.27",
+    "react": "^19",
+    "react-dom": "^19",
+    "typescript": "^5",
+    "vitest": "^4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://app.openmarkets.ai/developers",
+  "bugs": {
+    "url": "https://app.openmarkets.ai/developers",
+    "email": "james@openmarkets.ai"
+  },
+  "author": "OpenMarkets"
+}