@manifoldxyz/dropkit 0.2.1 → 0.4.0

package/dist/cart.d.ts

@@ -0,0 +1,216 @@
+import { ReactNode, ReactElement } from 'react';
+import { Address, Hex } from 'viem';
+import { R as ReasonCode, M as ManifoldClaimConfig, D as DropInfo, a as Money, b as RpcUrls } from './types-BjKGb6c7.js';
+
+declare const CART_REASONS: readonly ["CART_ERC20_UNSUPPORTED", "PERSISTENCE_UNAVAILABLE", "REQUEST_NOT_SENT"];
+type CartOnlyReason = (typeof CART_REASONS)[number];
+type CartReasonCode = ReasonCode | CartOnlyReason;
+declare class CartError extends Error {
+    readonly reason: CartReasonCode;
+    constructor(reason: CartReasonCode, message: string, opts?: {
+        cause?: unknown;
+    });
+}
+
+/** A token the mint delivered, from the receipt (or the 1155 tokenId when the receipt was lost). */
+type CollectedToken = {
+    contract: Address;
+    tokenId: string;
+};
+type CollectedLinks = {
+    /** The transaction on the chain's block explorer. null without a hash or a known explorer. */
+    tx: string | null;
+    /**
+     * The collector's OpenSea profile. Filtered to the collection when CartProvider has an OpenSea slug for the
+     * contract; the plain profile when there is no slug and no token is known; otherwise null.
+     */
+    profile: string | null;
+    /** One OpenSea item page per minted token. */
+    tokens: {
+        tokenId: string;
+        url: string;
+    }[];
+};
+declare const openseaChain: (chainId: number) => string | null;
+
+/** config.extension is required (D20). */
+type CartItem = {
+    key: string;
+    config: ManifoldClaimConfig;
+    quantity: number;
+};
+type CartProviderProps = {
+    /** The one chain every item is on and every mint is paid on. */
+    chainId: number;
+    /** Optional, same as MintButton. Without it the cart warns (R21). */
+    rpcUrls?: RpcUrls;
+    /** Default 'dropkit-cart:<chainId>'. One CartProvider per key per tab (R17). */
+    storageKey?: string;
+    connect?: {
+        walletConnectProjectId?: string;
+    };
+    /**
+     * OpenSea collection slug per creator contract, e.g. { '0xabc…': 'cities-paris' }. With a slug, a collected item's
+     * profile link opens the collector's OpenSea holdings filtered to that collection (D32).
+     */
+    openseaCollections?: Readonly<Record<string, string>>;
+    children: ReactNode;
+};
+type CartLineState = 'loading' | 'locked' | 'upcoming' | 'live' | 'sold-out' | 'ended' | 'ineligible' | 'unsupported' | 'error';
+type CartLine = CartItem & {
+    /** locked: a mint for this line is pending (R16). */
+    state: CartLineState;
+    reason: CartReasonCode | null;
+    drop: DropInfo | null;
+    /** Copies left, capped by the wallet limit when a wallet is connected. null = no limit. */
+    maxQuantity: number | null;
+    /** (unitPrice + unitFee) x quantity, in the native token. */
+    total: Money | null;
+};
+/**
+ * Hash lost and holdings did not prove the mint (D15). `wallet` is the wallet that sent it; `message` names it:
+ * "We couldn't confirm this. Check wallet 0x1234…abcd. If it didn't go through, add it again."
+ */
+type UnconfirmedItem = {
+    id: string;
+    key: string;
+    config: ManifoldClaimConfig;
+    quantity: number;
+    at: number;
+    wallet: Address;
+    message: string;
+};
+type CollectedItem = {
+    id: string;
+    key: string;
+    quantity: number;
+    at: number;
+    txHash: Hex | null;
+    wallet: Address;
+    /** The minted tokens, from the receipt. Empty when the receipt was lost and the token id is unknown. */
+    tokens: CollectedToken[];
+    /** Explorer transaction, OpenSea profile (filtered with a slug) and OpenSea token pages (D32). */
+    links: CollectedLinks;
+};
+type AddResult = 'added' | 'looks-collected' | 'check-unavailable';
+type CartState = {
+    lines: CartLine[];
+    unconfirmed: UnconfirmedItem[];
+    collected: CollectedItem[];
+    /** Native total of every line that is not unsupported or locked. */
+    total: Money | null;
+    /** Number of lines in the cart. */
+    count: number;
+    /**
+     * Rejects with INVALID_CONFIG when extension is missing, the chain differs, or the type is 'contract'.
+     * For an item with an Unconfirmed result, runs the R20 check first.
+     */
+    add(config: ManifoldClaimConfig, quantity?: number, opts?: {
+        force?: boolean;
+    }): Promise<AddResult>;
+    setQuantity(key: string, quantity: number): void;
+    remove(key: string): void;
+    /** Removes items only. Pending mints and results stay. */
+    clear(): void;
+    /** Synchronous. The key needs no lookup because extension is required. */
+    has(config: ManifoldClaimConfig): boolean;
+    /** Deletes the result (D19). */
+    dismissUnconfirmed(id: string): void;
+    /** Runs the Step 5b algorithm once for every pending mint. For a "Check again" button on locked lines. */
+    checkPending(): Promise<void>;
+};
+type CheckoutStepStatus = 'pending' | 'active' | 'unknown' | 'success' | 'unconfirmed' | 'skipped' | 'failed';
+type CheckoutStep = {
+    key: string;
+    /** unknown: waiting for a receipt. unconfirmed: hash lost, counted as gone through (D15). */
+    status: CheckoutStepStatus;
+    reason: CartReasonCode | null;
+    message: string | null;
+    txHash: Hex | null;
+};
+/** The wallet request the next confirm() sends. */
+type CheckoutAction = {
+    kind: 'add-chain';
+    chainId: number;
+} | {
+    kind: 'switch-chain';
+    chainId: number;
+} | {
+    kind: 'mint';
+    key: string;
+    amount: Money;
+};
+type CheckoutStateName = 'idle' | 'preparing' | 'blocked' | 'ready' | 'sending' | 'checking' | 'paused' | 'done';
+type CheckoutState = {
+    state: CheckoutStateName;
+    action: CheckoutAction | null;
+    reason: CartReasonCode | null;
+    message: string | null;
+    steps: CheckoutStep[];
+    /** 1-based index of the active step among the steps that are not skipped, for "Step 2 of 3". */
+    current: number | null;
+    checkout(): void;
+    /** Sends action. Call it only from a click handler. Does nothing outside ready. */
+    confirm(): void;
+    /** In checking: look for the receipt once more. */
+    check(): void;
+    retry(): void;
+    skip(): void;
+    stop(): void;
+    reset(): void;
+};
+
+declare function useCart(): CartState;
+declare function CartProvider(props: CartProviderProps): ReactElement;
+
+declare function useCheckout(): CheckoutState;
+
+type Holding = {
+    /**
+     * owned: tokens of this drop the wallet holds now (ERC-1155).
+     * minted: how many it minted from this drop (ERC-721 with a wallet limit).
+     * owned-in-contract: tokens it holds on the drop's contract, any drop (other ERC-721). Equals "owned" when the
+     * contract has only this drop.
+     */
+    kind: 'owned' | 'minted' | 'owned-in-contract';
+    count: number;
+};
+type HoldingsState = {
+    /** The wallet read: opts.wallet, else the connected account. null = no wallet, nothing read. */
+    wallet: Address | null;
+    /** Keyed like cart lines (itemKey). A drop is missing until its first read finishes; null when it failed. */
+    byKey: Record<string, Holding | null>;
+    /** Read for one config. undefined while loading or without a wallet. */
+    get(config: ManifoldClaimConfig): Holding | null | undefined;
+    loading: boolean;
+    /** Reads every drop again. */
+    refresh(): void;
+};
+/**
+ * Reads on mount, when the wallet changes, when the config list changes, after each collected mint, and on refresh().
+ * No timer. Configs need extension, like cart configs.
+ */
+declare function useHoldings(configs: readonly ManifoldClaimConfig[], opts?: {
+    wallet?: Address;
+}): HoldingsState;
+
+type AddToCartState = 'add' | 'adding' | 'in-cart' | 'locked' | 'unconfirmed' | 'sold-out' | 'upcoming' | 'unsupported';
+type AddToCartButtonProps = {
+    config: ManifoldClaimConfig;
+    quantity?: number;
+    className?: string;
+    /** A function child replaces the default markup. It gets the state, the last AddResult and add(opts). */
+    children?: ReactNode | ((b: AddToCartRender) => ReactNode);
+};
+type AddToCartRender = {
+    state: AddToCartState;
+    /** The last AddResult of this button, or null. 'looks-collected' and 'check-unavailable' ask the site to confirm. */
+    result: AddResult | null;
+    line: CartLine | null;
+    add(opts?: {
+        force?: boolean;
+    }): void;
+};
+declare function AddToCartButton(props: AddToCartButtonProps): ReactNode;
+
+export { type AddResult, AddToCartButton, type AddToCartButtonProps, type AddToCartRender, type AddToCartState, CartError, type CartItem, type CartLine, type CartLineState, type CartOnlyReason, CartProvider, type CartProviderProps, type CartReasonCode, type CartState, type CheckoutAction, type CheckoutState, type CheckoutStateName, type CheckoutStep, type CheckoutStepStatus, type CollectedItem, type CollectedLinks, type CollectedToken, type Holding, type HoldingsState, type UnconfirmedItem, openseaChain, useCart, useCheckout, useHoldings };