@coinlist-co/react 0.2.0 → 0.4.0

package/dist/coinlist-client-20v7fJSW.d.ts

@@ -1,394 +0,0 @@
-import { A as AuthorizationCode, c as CodeVerifier, f as Config, O as OAuthAccessToken } from './oauth-session-DnKDI5ou.js';
-import { N as Newtype } from './newtype-yKTvFdg_.js';
-import { a as OfferId, b as OfferSlug, O as Offer } from './offer-DnFEFJw9.js';
-
-type AuthState = 'unknown' | 'logged-in' | 'logged-out';
-/** Discriminated error reasons from {@link CoinListClient.completeOAuth}. */
-type OauthClientErrorReason = 'user_canceled' | 'missing_state' | 'invalid_state' | 'missing_code' | 'missing_code_verifier';
-type OauthClientResult = {
-    type: 'ok';
-    code: AuthorizationCode;
-    codeVerifier: CodeVerifier;
-} | {
-    type: 'error';
-    reason: OauthClientErrorReason;
-};
-
-type QueryParamValue = string | number | boolean | null | undefined;
-
-type Cursor = Newtype<string, 'Cursor'>;
-declare const Cursor: (value: string) => Cursor;
-interface PaginatedResponseDto<T> {
-    data: T[];
-    starting_after?: string;
-    starting_before?: string;
-}
-declare function fetchAllPages<A>(fetchPage: (params: PaginationParams) => Promise<PaginatedResponse<A>>): Promise<A[]>;
-interface PaginatedResponse<T> {
-    data: T[];
-    startingAfter: Cursor | null;
-    startingBefore: Cursor | null;
-}
-declare const PaginatedResponse: {
-    fromDto: <A, B>(dto: PaginatedResponseDto<A>, itemMapper: (item: A) => B) => PaginatedResponse<B>;
-};
-/**
- * Cursor-based pagination input used when requesting paginated API resources.
- * Set `after` or `before` to navigate relative to a known cursor, and `limit`
- * to control the maximum number of returned items.
- */
-interface PaginationParams {
-    before?: Cursor;
-    after?: Cursor;
-    limit?: number;
-}
-declare const PaginationParams: {
-    toQueryParams: (params: PaginationParams) => Record<string, QueryParamValue>;
-};
-
-type AssetDto = {
-    code: string;
-    fractional_digits: number;
-    id: string;
-    name: string;
-};
-
-type AssetId = Newtype<string, 'AssetId'>;
-declare const AssetId: (value: string) => AssetId;
-type AssetCode = Newtype<string, 'AssetCode'>;
-declare const AssetCode: (value: string) => AssetCode;
-type Asset = {
-    id: AssetId;
-    code: AssetCode;
-    name: string;
-    fractionalDigits: number;
-};
-declare const Asset: {
-    fromDto: (dto: AssetDto) => Asset;
-};
-
-type OfferDetailDto = {
-    asset: AssetDto;
-    faqs: OfferDetailFaqDto[];
-    funding_assets: AssetDto[];
-    id: string;
-    links: OfferDetailLinkDto[];
-    milestones: OfferDetailMilestoneDto[];
-    name: string;
-    object: 'offer_details';
-    options: OfferDetailOptionDto[];
-    slug: string;
-    terms: OfferDetailTermDto[];
-    about: string | null | undefined;
-    banner_url: string | null | undefined;
-    category: string | null | undefined;
-    ends_at: string;
-    logo_url: string | null | undefined;
-    starts_at: string;
-    tagline: string | null | undefined;
-};
-type OfferDetailFaqDto = {
-    answer: string | null;
-    question: string | null;
-};
-type OfferDetailLinkDto = {
-    label: string | null;
-    url: string | null;
-};
-type OfferDetailMilestoneDto = {
-    name: string | null;
-    schedule: string | null;
-    status: 'completed' | 'active' | 'upcoming';
-};
-type OfferDetailOptionDto = {
-    bid_increment: number | null;
-    floor_price_usd: number | null;
-    id: string;
-    minimum_purchase_usd: number | null;
-    price_usd: number | null;
-    sale_agreement_url: string | null;
-    slug: string;
-    total_token_supply: number | null;
-};
-type OfferDetailTermDto = {
-    key: string | null;
-    value: string | null;
-};
-
-type OfferOptionId = Newtype<string, 'OfferOptionId'>;
-declare const OfferOptionId: (value: string) => OfferOptionId;
-type OfferOptionSlug = Newtype<string, 'OfferOptionSlug'>;
-declare const OfferOptionSlug: (value: string) => OfferOptionSlug;
-type OfferDetail = {
-    id: OfferId;
-    slug: OfferSlug;
-    name: string;
-    asset: Asset;
-    fundingAssets: Asset[];
-    about: string | null;
-    tagline: string | null;
-    bannerUrl: string | null;
-    logoUrl: string | null;
-    category: string | null;
-    startsAt: Date;
-    endsAt: Date;
-    faqs: FaqItem[];
-    links: Link[];
-    milestones: Milestone[];
-    options: OfferOption[];
-    terms: TermItem[];
-};
-declare const OfferDetail: {
-    fromDto: (dto: OfferDetailDto) => OfferDetail;
-};
-type OfferOption = {
-    id: OfferOptionId;
-    slug: OfferOptionSlug;
-    bidIncrement: number | null;
-    floorPriceUsd: number | null;
-    minimumPurchaseUsd: number | null;
-    priceUsd: number | null;
-    saleAgreementUrl: string | null;
-    totalTokenSupply: number | null;
-};
-declare const OfferOption: {
-    fromDto: (dto: OfferDetailOptionDto) => OfferOption;
-};
-type FaqItem = {
-    question: string | null;
-    answer: string | null;
-};
-declare const FaqItem: {
-    fromDto: (dto: OfferDetailFaqDto) => FaqItem;
-};
-type Link = {
-    label: string | null;
-    url: string | null;
-};
-declare const Link: {
-    fromDto: (dto: OfferDetailLinkDto) => Link;
-};
-type TermItem = {
-    key: string | null;
-    value: string | null;
-};
-declare const TermItem: {
-    fromDto: (dto: OfferDetailTermDto) => TermItem;
-};
-type Milestone = {
-    name: string | null;
-    schedule: string | null;
-    status: 'completed' | 'active' | 'upcoming';
-};
-declare const Milestone: {
-    fromDto: (dto: OfferDetailMilestoneDto) => Milestone;
-};
-
-type ParticipationStatusDto = 'prepared' | 'pending' | 'submitted' | 'completed' | 'failed' | 'remit_submitted' | 'remitted' | 'remit_failed';
-type ParticipationDto = {
-    object: 'participation';
-    id: string;
-    offer_id: string;
-    offer_option_id: string;
-    status: ParticipationStatusDto;
-    amount: string;
-    amount_string: string;
-    asset: AssetDto;
-    chain: string;
-    inserted_at: string | null | undefined;
-    updated_at: string | null | undefined;
-    wallet_address: string | null | undefined;
-};
-type CreateParticipationDto = {
-    offer_id: string;
-    offer_option_id: string;
-    chain: string;
-    wallet_address: string;
-    amount: string;
-    asset_id: string;
-    approval_transaction_hash: string | null | undefined;
-};
-
-/** Unique identifier for a participation. */
-type ParticipationId = Newtype<string, 'ParticipationId'>;
-/** Casts a string into a typed {@link ParticipationId}. */
-declare const ParticipationId: (value: string) => ParticipationId;
-/** Blockchain identifier for where a participation is funded. */
-type Blockchain = Newtype<string, 'Blockchain'>;
-/** Casts a string into a typed {@link Blockchain}. */
-declare const Blockchain: (value: string) => Blockchain;
-/** Wallet address used for a participation. */
-type WalletAddress = Newtype<string, 'WalletAddress'>;
-/** Casts a string into a typed {@link WalletAddress}. */
-declare const WalletAddress: (value: string) => WalletAddress;
-/** Possible participation lifecycle states returned by the API. */
-type ParticipationStatus = ParticipationStatusDto;
-/** Domain model for a participation returned by CoinList APIs. */
-type Participation = {
-    /** Unique participation id. */
-    id: ParticipationId;
-    /** Parent offer id. */
-    offerId: OfferId;
-    /** Selected offer option id. */
-    offerOptionId: OfferOptionId;
-    /** Current processing status. */
-    status: ParticipationStatus;
-    /** Raw participation amount from API. */
-    amount: string;
-    /** Human-readable formatted amount from API. */
-    displayAmount: string;
-    /** Asset metadata for the participation amount. */
-    asset: Asset;
-    /** Funding chain identifier. */
-    chain: Blockchain;
-    /** Creation timestamp, if returned by API. */
-    insertedAt: Date | null;
-    /** Last update timestamp, if returned by API. */
-    updatedAt: Date | null;
-    /** Wallet used for participation, blank values normalized to null. */
-    walletAddress: WalletAddress | null;
-};
-declare const Participation: {
-    /** Maps API DTO shape into the SDK participation domain model. */
-    fromDto: (dto: ParticipationDto) => Participation;
-};
-/** Parameters required to create a new participation. */
-type CreateParticipationParams = {
-    /** Offer to participate in. */
-    offerId: OfferId;
-    /** Offer option selected for participation. */
-    offerOptionId: OfferOptionId;
-    /** Blockchain for funding. */
-    chain: Blockchain;
-    /** Wallet address that funds the participation. */
-    walletAddress: WalletAddress;
-    /** Raw amount to participate with. */
-    amount: string;
-    /** Funding asset id. */
-    assetId: AssetId;
-    /** Optional approval transaction hash, if applicable. */
-    approvalTransactionHash?: string | null;
-};
-declare const CreateParticipationParams: {
-    /** Maps participation creation params into API DTO payload. */
-    toDto: (params: CreateParticipationParams) => CreateParticipationDto;
-};
-
-interface ClientConfig extends Config {
-    /**
-     * The SDK user must provide this function. It is responsible for fetching a
-     * valid {@link OAuthAccessToken}, or **null** for logged-out users. If your
-     * backend is in TypeScript, it is recommended to use
-     * {@link CoinListServer#accessToken} from `@/server/coinlist.server`.
-     */
-    getAccessToken: () => Promise<OAuthAccessToken | null>;
-    /**
-     * Recommended to leave undefined. Used to change the CoinList environment;
-     * default is production.
-     */
-    authorizationPageUrl?: string;
-}
-interface CoinListClient {
-    /**
-     * Calls the provided {@link ClientConfig.getAccessToken} lambda to determine
-     * the user's {@link AuthState}. This is called automatically by {@link CoinListProvider};
-     * you typically do not need to call it yourself unless you are using the client
-     * outside of the provider.
-     */
-    init(): Promise<AuthState>;
-    /**
-     * Returns the current auth state: `'logged-in'`, `'logged-out'`, or `'unknown'`.
-     * Returns **unknown** until {@link CoinListClient.init} has completed. It is
-     * recommended to use the `const { isReady, coinlist } = useCoinList()` hook to know when
-     * the SDK has initialized, or to manually await {@link CoinListClient.init}
-     * before relying on this value.
-     */
-    getAuthState(): AuthState;
-    /**
-     * Starts the OAuth flow with PKCE. Generates a random `state` and `code_verifier`,
-     * stores them in sessionStorage (for validation in {@link CoinListClient.completeOAuth}
-     * on redirect), then redirects the user to the CoinList authorization page. After
-     * the user authorizes, they are sent back to your application's redirect URI; call
-     * {@link CoinListClient.completeOAuth} on that page to finish the flow.
-     */
-    startOAuth(): Promise<void>;
-    /**
-     * Completes the OAuth flow on the FE with PKCE and state validation. Parses the
-     * redirect URL (state, code) and validates them against sessionStorage
-     * (state, code_verifier). The state check protects against CSRF (cross-site
-     * request forgery). Call this on the frontend page the user is redirected
-     * to after authorizing.
-     *
-     * On `ok`: Call your backend to exchange the short-lived `authorizationCode`
-     * (and the returned `codeVerifier`) for a long-lived session. If your backend
-     * is in TypeScript, you can use {@link CoinListServer#completeOAuth} from
-     * `@/server/coinlist.server` (CoinListServer) to perform that exchange.
-     *
-     * On `error`: `reason` is an {@link OauthClientErrorReason} (e.g. `'missing_state'`, `'invalid_state'`) so you can switch on it and surface a message to the user.
-     */
-    completeOAuth(): OauthClientResult;
-    /**
-     * Clears the in-memory access token. Note: you need to manually
-     * also logout on the backend via CoinListServer#logout to clear the session cookie.
-     */
-    logout(): void;
-    /**
-     * Fetches all offers by iterating through every paginated response.
-     *
-     * This method must be called only when the user's {@link AuthState} is
-     * `'logged-in'`. If the user is not authenticated, it throws
-     * {@link NotAuthenticatedError}.
-     */
-    fetchAllOffers(): Promise<Offer[]>;
-    /**
-     * Fetches a single page of offers.
-     *
-     * This method must be called only when the user's {@link AuthState} is
-     * `'logged-in'`. If the user is not authenticated, it throws
-     * {@link NotAuthenticatedError}.
-     */
-    fetchOffersPage(params: PaginationParams): Promise<PaginatedResponse<Offer>>;
-    /**
-     * Fetches details for a given offer by its id.
-     *
-     * This method must be called only when the user's {@link AuthState} is
-     * `'logged-in'`. If the user is not authenticated, it throws
-     * {@link NotAuthenticatedError}.
-     */
-    fetchOfferDetails(id: OfferId): Promise<OfferDetail>;
-    /**
-     * Fetches all participations by iterating through every paginated response.
-     *
-     * This method must be called only when the user's {@link AuthState} is
-     * `'logged-in'`. If the user is not authenticated, it throws
-     * {@link NotAuthenticatedError}.
-     */
-    fetchAllParticipations(): Promise<Participation[]>;
-    /**
-     * Fetches a single page of participations.
-     *
-     * This method must be called only when the user's {@link AuthState} is
-     * `'logged-in'`. If the user is not authenticated, it throws
-     * {@link NotAuthenticatedError}.
-     */
-    fetchParticipationsPage(params: PaginationParams): Promise<PaginatedResponse<Participation>>;
-    /**
-     * Fetches a participation by id.
-     *
-     * This method must be called only when the user's {@link AuthState} is
-     * `'logged-in'`. If the user is not authenticated, it throws
-     * {@link NotAuthenticatedError}.
-     */
-    fetchParticipation(id: ParticipationId): Promise<Participation>;
-    /**
-     * Creates a participation.
-     *
-     * This method must be called only when the user's {@link AuthState} is
-     * `'logged-in'`. If the user is not authenticated, it throws
-     * {@link NotAuthenticatedError}.
-     */
-    createParticipation(params: CreateParticipationParams): Promise<Participation>;
-}
-declare function createCoinListClient(config: ClientConfig): CoinListClient;
-
-export { type AuthState as A, Blockchain as B, type ClientConfig as C, FaqItem as F, Link as L, Milestone as M, type OauthClientErrorReason as O, PaginatedResponse as P, TermItem as T, WalletAddress as W, type CoinListClient as a, CreateParticipationParams as b, Cursor as c, type OauthClientResult as d, OfferDetail as e, OfferOption as f, OfferOptionId as g, OfferOptionSlug as h, type PaginatedResponseDto as i, PaginationParams as j, Participation as k, ParticipationId as l, type ParticipationStatus as m, createCoinListClient as n, fetchAllPages as o };