@coinlist-co/react 0.2.0 → 0.4.0

package/dist/participation-DMMEDxON.d.cts

@@ -0,0 +1,185 @@
+import { N as Newtype, A as AssetDto, b as OfferId, d as OfferOptionId, k as Asset, l as AssetId } from './requirement-XWT0T_zO.cjs';
+
+type AuthorizationCode = Newtype<string, 'AuthorizationCode'>;
+declare const AuthorizationCode: (value: string) => AuthorizationCode;
+type CodeVerifier = Newtype<string, 'CodeVerifier'>;
+declare const CodeVerifier: (value: string) => CodeVerifier;
+type CodeChallenge = Newtype<string, 'CodeChallenge'>;
+declare const CodeChallenge: (value: string) => CodeChallenge;
+type RedirectUri = Newtype<string, 'RedirectUri'>;
+declare const RedirectUri: (value: string) => RedirectUri;
+type ClientId = Newtype<string, 'ClientId'>;
+declare const ClientId: (value: string) => ClientId;
+type ClientSecret = Newtype<string, 'ClientSecret'>;
+declare const ClientSecret: (value: string) => ClientSecret;
+
+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, P extends PaginationParams = PaginationParams>(fetchPage: (params: P) => Promise<PaginatedResponse<A>>, baseParams?: Omit<P, keyof PaginationParams>): 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>;
+};
+
+interface Config {
+    /** OAuth2 public identifier. */
+    readonly clientId: ClientId;
+    /**
+     * OAuth2 redirect URI. Recommended to point to a frontend page where
+     * {@link CoinListClient#completeOauth} can be called to complete the PKCE
+     * flow on the client side.
+     */
+    readonly redirectUri: RedirectUri;
+    /**
+     * Recommended to leave undefined. Used to change the CoinList environment;
+     * default is production.
+     */
+    readonly baseUrl?: string;
+}
+
+/**
+ * OAuth 2.0 token response (RFC 6749 §5.1).
+ * Maps to OpenAPI schema OauthToken.
+ */
+type OAuthSessionDto = {
+    access_token: string;
+    expires_in: number;
+    refresh_token?: string;
+};
+
+type OAuthAccessToken = {
+    value: string;
+    expiresAt: Date;
+};
+type OAuthRefreshToken = Newtype<string, 'OAuthRefreshToken'>;
+declare const OAuthRefreshToken: (value: string) => OAuthRefreshToken;
+type OAuthSession = {
+    accessToken: OAuthAccessToken;
+    refreshToken?: OAuthRefreshToken;
+};
+declare const OAuthSession: {
+    fromDto: (dto: OAuthSessionDto) => OAuthSession;
+};
+
+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;
+/** Pagination params for listing participations, with an optional offer filter. */
+interface ParticipationsPaginationParams extends PaginationParams {
+    offerId?: OfferId;
+}
+declare const ParticipationsPaginationParams: {
+    toQueryParams: (params: ParticipationsPaginationParams) => Record<string, QueryParamValue>;
+};
+/** 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;
+};
+
+export { AuthorizationCode as A, Blockchain as B, ClientId as C, type OAuthAccessToken as O, PaginatedResponse as P, RedirectUri as R, WalletAddress as W, ClientSecret as a, CodeChallenge as b, CodeVerifier as c, CreateParticipationParams as d, Cursor as e, OAuthRefreshToken as f, OAuthSession as g, type PaginatedResponseDto as h, PaginationParams as i, Participation as j, ParticipationId as k, type ParticipationStatus as l, ParticipationsPaginationParams as m, fetchAllPages as n, type Config as o };

package/dist/participation-E-bT-GXJ.d.ts

@@ -0,0 +1,185 @@
+import { N as Newtype, A as AssetDto, b as OfferId, d as OfferOptionId, k as Asset, l as AssetId } from './requirement-XWT0T_zO.js';
+
+type AuthorizationCode = Newtype<string, 'AuthorizationCode'>;
+declare const AuthorizationCode: (value: string) => AuthorizationCode;
+type CodeVerifier = Newtype<string, 'CodeVerifier'>;
+declare const CodeVerifier: (value: string) => CodeVerifier;
+type CodeChallenge = Newtype<string, 'CodeChallenge'>;
+declare const CodeChallenge: (value: string) => CodeChallenge;
+type RedirectUri = Newtype<string, 'RedirectUri'>;
+declare const RedirectUri: (value: string) => RedirectUri;
+type ClientId = Newtype<string, 'ClientId'>;
+declare const ClientId: (value: string) => ClientId;
+type ClientSecret = Newtype<string, 'ClientSecret'>;
+declare const ClientSecret: (value: string) => ClientSecret;
+
+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, P extends PaginationParams = PaginationParams>(fetchPage: (params: P) => Promise<PaginatedResponse<A>>, baseParams?: Omit<P, keyof PaginationParams>): 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>;
+};
+
+interface Config {
+    /** OAuth2 public identifier. */
+    readonly clientId: ClientId;
+    /**
+     * OAuth2 redirect URI. Recommended to point to a frontend page where
+     * {@link CoinListClient#completeOauth} can be called to complete the PKCE
+     * flow on the client side.
+     */
+    readonly redirectUri: RedirectUri;
+    /**
+     * Recommended to leave undefined. Used to change the CoinList environment;
+     * default is production.
+     */
+    readonly baseUrl?: string;
+}
+
+/**
+ * OAuth 2.0 token response (RFC 6749 §5.1).
+ * Maps to OpenAPI schema OauthToken.
+ */
+type OAuthSessionDto = {
+    access_token: string;
+    expires_in: number;
+    refresh_token?: string;
+};
+
+type OAuthAccessToken = {
+    value: string;
+    expiresAt: Date;
+};
+type OAuthRefreshToken = Newtype<string, 'OAuthRefreshToken'>;
+declare const OAuthRefreshToken: (value: string) => OAuthRefreshToken;
+type OAuthSession = {
+    accessToken: OAuthAccessToken;
+    refreshToken?: OAuthRefreshToken;
+};
+declare const OAuthSession: {
+    fromDto: (dto: OAuthSessionDto) => OAuthSession;
+};
+
+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;
+/** Pagination params for listing participations, with an optional offer filter. */
+interface ParticipationsPaginationParams extends PaginationParams {
+    offerId?: OfferId;
+}
+declare const ParticipationsPaginationParams: {
+    toQueryParams: (params: ParticipationsPaginationParams) => Record<string, QueryParamValue>;
+};
+/** 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;
+};
+
+export { AuthorizationCode as A, Blockchain as B, ClientId as C, type OAuthAccessToken as O, PaginatedResponse as P, RedirectUri as R, WalletAddress as W, ClientSecret as a, CodeChallenge as b, CodeVerifier as c, CreateParticipationParams as d, Cursor as e, OAuthRefreshToken as f, OAuthSession as g, type PaginatedResponseDto as h, PaginationParams as i, Participation as j, ParticipationId as k, type ParticipationStatus as l, ParticipationsPaginationParams as m, fetchAllPages as n, type Config as o };

package/dist/requirement-XWT0T_zO.d.cts

@@ -0,0 +1,205 @@
+declare const __brand: unique symbol;
+type Newtype<Base, Branding> = Base & {
+    readonly [__brand]: Branding;
+};
+
+type OfferDto = {
+    id: string;
+    slug: string;
+    tagline: string | null | undefined;
+    banner_url: string | null | undefined;
+    logo_url: string | null | undefined;
+    starts_at: string;
+    ends_at: string;
+};
+
+type OfferId = Newtype<string, 'OfferId'>;
+declare const OfferId: (value: string) => OfferId;
+type OfferSlug = Newtype<string, 'OfferSlug'>;
+declare const OfferSlug: (value: string) => OfferSlug;
+type Offer = {
+    id: OfferId;
+    slug: OfferSlug;
+    tagline: string | null;
+    bannerUrl: string | null;
+    logoUrl: string | null;
+    startsAt: Date;
+    endsAt: Date;
+};
+declare const Offer: {
+    fromDto: (dto: OfferDto) => Offer;
+};
+
+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: string | 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: string | 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 RequirementTypeDto = 'kyc_approved' | 'identity_verified' | 'proof_of_address' | 'source_of_funds' | 'external_wallet' | 'whitelisted_wallet' | 'jurisdiction' | 'accreditation';
+type RequirementDto = {
+    object: 'requirement';
+    id: string;
+    type: RequirementTypeDto;
+    details: Record<string, unknown> | null;
+};
+type RequirementStatusValueDto = 'not_started' | 'in_progress' | 'action_needed' | 'completed' | 'rejected';
+type RequirementStatusesDto = {
+    object: 'requirement_statuses';
+    offer_id: string;
+    statuses: Record<string, RequirementStatusValueDto>;
+};
+
+type RequirementId = Newtype<string, 'RequirementId'>;
+declare const RequirementId: (value: string) => RequirementId;
+type RequirementType = RequirementTypeDto;
+type RequirementStatusValue = RequirementStatusValueDto;
+type Requirement = {
+    id: RequirementId;
+    type: RequirementType;
+    details: Record<string, unknown> | null;
+};
+declare const Requirement: {
+    fromDto: (dto: RequirementDto) => Requirement;
+};
+type RequirementStatusInfo = {
+    id: RequirementId;
+    status: RequirementStatusValue;
+};
+declare const RequirementStatusInfo: {
+    fromStatusesDto: (dto: RequirementStatusesDto) => RequirementStatusInfo[];
+};
+
+export { type AssetDto as A, FaqItem as F, Link as L, Milestone as M, type Newtype as N, Offer as O, Requirement as R, TermItem as T, OfferDetail as a, OfferId as b, OfferOption as c, OfferOptionId as d, OfferOptionSlug as e, OfferSlug as f, RequirementId as g, RequirementStatusInfo as h, type RequirementStatusValue as i, type RequirementType as j, Asset as k, AssetId as l };