@calm-xyz/stripe 0.0.0-stage → 0.16.0

package/README.md

@@ -1,3 +1,3 @@
-# Temporary Holding Version
+# `@calm-xyz/stripe`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**[docs.calmtreasury.xyz](https://docs.calmtreasury.xyz)**

package/dist/index.d.ts

@@ -0,0 +1,85 @@
+import * as React from "react";
+import { ApiError } from "@calm-xyz/core";
+import "@tanstack/react-query";
+import { Address } from "viem";
+declare const CHAIN_IDS: readonly [1, 8453, 999, 1337, 4326, 143, 137, 42161, 4663, 3586256];
+type Chain = (typeof CHAIN_IDS)[number];
+declare const CURRENCIES: readonly ["USD", "GBP", "EUR"];
+type Currency = (typeof CURRENCIES)[number];
+declare const DESTINATION_TOKENS: readonly ["USDC", "USDm", "AUSD", "USDC.e", "USDG"];
+type DestinationToken = (typeof DESTINATION_TOKENS)[number];
+type CalmStripeDialogProps = {
+  children: React.ReactElement;
+};
+/**
+ * Calm's Stripe card payments in a modal dialog. Each open starts afresh.
+ */
+declare function CalmStripeDialog({ children }: CalmStripeDialogProps): React.JSX.Element;
+type CalmToken = "--calm-popover" | "--calm-popover-foreground" | "--calm-primary" | "--calm-primary-foreground" | "--calm-secondary" | "--calm-secondary-foreground" | "--calm-muted" | "--calm-muted-foreground" | "--calm-accent" | "--calm-accent-foreground" | "--calm-destructive" | "--calm-destructive-foreground" | "--calm-success" | "--calm-success-foreground" | "--calm-border" | "--calm-input" | "--calm-ring" | "--calm-overlay" | "--calm-radius" | "--calm-spacing" | "--calm-text-base" | "--calm-font-sans" | "--calm-shadow-edge" | "--calm-shadow-modal";
+type CalmTheme = Partial<Record<CalmToken, string>>;
+type TokenStorage = {
+  kind: "sync";
+  getItem(key: string): string | null;
+  setItem(key: string, value: string): void;
+  removeItem(key: string): void;
+} | {
+  kind: "async";
+  getItem(key: string): Promise<string | null>;
+  setItem(key: string, value: string): Promise<void>;
+  removeItem(key: string): Promise<void>;
+};
+type CalmRequest = {
+  apiUrl: string;
+  headers: Record<string, string>;
+};
+type CalmConfig = CalmRequest & {
+  publishableKey: string;
+  assetUrl: string;
+  name: string;
+};
+type CalmWallet = {
+  address: Address;
+};
+type CalmDestination = {
+  chain: Chain;
+  setChain: (next: Chain) => void;
+  destinationToken: DestinationToken;
+};
+type CalmRegion = {
+  country: string | undefined;
+  currency: Currency | undefined;
+  setCountry: (next: string) => void;
+  locale: string;
+};
+type CalmSession = {
+  sessionToken: string | null;
+  restoring: boolean;
+  setSessionToken: (token: string | null) => void;
+  forgetSessionToken: (token: string) => void;
+  signOut: () => Promise<void>;
+};
+type CalmStripeProviderProps = {
+  address: Address;
+  apiUrl?: string;
+  name: string;
+  chain: Chain;
+  destinationToken: DestinationToken;
+  country?: string;
+  locale?: string;
+  assetUrl?: string;
+  children: React.ReactNode;
+  publishableKey: string;
+  tokenStorage: TokenStorage;
+};
+type CalmContext = Pick<CalmConfig, "apiUrl" | "name" | "assetUrl"> & Pick<CalmWallet, "address"> & CalmDestination & CalmRegion & Pick<CalmSession, "signOut">;
+/**
+ * Reads the Calm context from the nearest `<CalmProvider>`.
+ *
+ * @see https://docs.calmtreasury.xyz/sdk/react/useCalm
+ */
+declare function useCalm(): CalmContext;
+type CalmProviderProps = Omit<CalmStripeProviderProps, "tokenStorage"> & {
+  theme?: CalmTheme;
+};
+declare function CalmProvider({ locale, theme, children, ...props }: CalmProviderProps): React.JSX.Element;
+export { type CalmContext, CalmProvider, type CalmProviderProps, CalmStripeDialog, type CalmStripeDialogProps, type CalmTheme, type CalmToken, type Chain, type Currency, type DestinationToken, useCalm };