@bluxcc/core 0.3.0 → 0.3.2

package/README.md

@@ -6,27 +6,27 @@ Blux Core is a JavaScript/TypeScript SDK for adding authentication, Stellar wall
 
 ## Useful Links
 
-* **Website:** [blux.cc](https://blux.cc/)
-* **Documentation:** [docs.blux.cc](https://docs.blux.cc/)
-* **Live Demo:** [demo.blux.cc](https://demo.blux.cc/)
-* **Dashboard:** [dashboard.blux.cc](https://dashboard.blux.cc/)
+- **Website:** [blux.cc](https://blux.cc/)
+- **Documentation:** [docs.blux.cc](https://docs.blux.cc/)
+- **Live Demo:** [demo.blux.cc](https://demo.blux.cc/)
+- **Dashboard:** [dashboard.blux.cc](https://dashboard.blux.cc/)
 
 ## Features
 
-* **Framework-Agnostic**: Use Blux Core with vanilla JavaScript, TypeScript, or any frontend framework.
-* **Multi-Wallet Support**: Integrate Stellar wallets such as **Rabet, xBull, LOBSTR, Freighter, Albedo, HOT Wallet, Hana, and more**.
-* **Email, Passkey & Social Authentication**: Onboard users without requiring them to install or manage a traditional wallet.
-* **Transaction Signing**: Connect wallets and request transaction signatures through a consistent interface.
-* **Soroban Support**: Add Stellar smart contract interactions to your application.
-* **Customizable UI**: Adjust themes, fonts, backgrounds, logos, border radius, text colors, and other interface elements.
-* **Wallet Configuration**: Include or exclude individual wallets and control their display order.
-* **Configurable Networks**: Choose the Stellar networks supported by your application and set a default network.
-* **Custom Explorer**: Configure the block explorer used for account and transaction links.
-* **Localization**: Provide the authentication experience in multiple supported languages.
-* **User Management & Analytics**: Review authentication methods, login activity, timestamps, and associated wallet addresses through the Blux dashboard.
-* **Testing Tools**: Use predefined test accounts and reusable OTP credentials in configured testing environments.
-* **Multiple Projects**: Create and manage multiple applications from a single Blux account.
-* **Future-Proof**: More wallets and authentication methods will be added based on community feedback.
+- **Framework-Agnostic**: Use Blux Core with vanilla JavaScript, TypeScript, or any frontend framework.
+- **Multi-Wallet Support**: Integrate Stellar wallets such as **Rabet, xBull, LOBSTR, Freighter, Albedo, HOT Wallet, Hana, and more**.
+- **Email, Passkey & Social Authentication**: Onboard users without requiring them to install or manage a traditional wallet.
+- **Transaction Signing**: Connect wallets and request transaction signatures through a consistent interface.
+- **Soroban Support**: Add Stellar smart contract interactions to your application.
+- **Customizable UI**: Adjust themes, fonts, backgrounds, logos, border radius, text colors, and other interface elements.
+- **Wallet Configuration**: Include or exclude individual wallets and control their display order.
+- **Configurable Networks**: Choose the Stellar networks supported by your application and set a default network.
+- **Custom Explorer**: Configure the block explorer used for account and transaction links.
+- **Localization**: Provide the authentication experience in multiple supported languages.
+- **User Management & Analytics**: Review authentication methods, login activity, timestamps, and associated wallet addresses through the Blux dashboard.
+- **Testing Tools**: Use predefined test accounts and reusable OTP credentials in configured testing environments.
+- **Multiple Projects**: Create and manage multiple applications from a single Blux account.
+- **Future-Proof**: More wallets and authentication methods will be added based on community feedback.
 
 ## Installation
 
@@ -77,24 +77,73 @@ document.getElementById('loginBtn').onclick = async () => {
 
 Create a project through the [Blux Dashboard](https://dashboard.blux.cc/) to obtain your application ID. You can create and manage multiple projects from the same account.
 
+### Social Login
+
+Add any supported provider to `loginMethods`. The first enabled social is
+shown on the login screen; the rest appear on **Other socials**.
+
+```tsx
+createConfig({
+  appName: 'My App',
+  appId: 'GET_FROM_BLUX_DASHBOARD',
+  networks: [core.networks.mainnet],
+  loginMethods: [
+    'wallet',
+    'google',
+    'apple',
+    'discord',
+    'telegram',
+    'meta',
+    'github',
+    'farcaster',
+    'tiktok',
+    'linkedin',
+    'twitch',
+    'kick',
+    'spotify',
+    'instagram',
+    'microsoft',
+    'gitlab',
+    'twitter',
+    'steam',
+    'email',
+    'passkey',
+  ],
+});
+```
+
+Each provider is shown only when requested in `loginMethods` and returned in
+the app's enabled `socials` by `/auth/validate`. Most providers open
+`/auth/social/{provider}/start` on the Blux API (for example,
+`/auth/social/meta/start` or `/auth/social/github/start`) and use the
+shared social-login success, retry, and cancellation flow. Telegram uses
+the on-page [Login Widget](https://core.telegram.org/widgets/login) instead
+of a popup, because the bot is bound to the site's domain; Mini Apps can
+complete login via WebApp init data when that is enabled for the project.
+
+The backend must support each provider and have the project's credentials
+and callbacks configured. Private keys, client secrets, and bot tokens never
+belong in this browser configuration. Token verification is the backend's
+responsibility; the SDK accepts only the resulting Blux session.
+
 ## Customization
 
 Developers can customize various UI elements:
 
-* **Themes & Fonts**
-* **Backgrounds, Logos**
-* **Border Radius & Text Colors**
-* **Authentication Limits** (Free tier supports 500-1000 accounts per auth method)
+- **Themes & Fonts**
+- **Backgrounds, Logos**
+- **Border Radius & Text Colors**
+- **Authentication Limits** (Free tier supports 500-1000 accounts per auth method)
 
 Developers can also configure:
 
-* Enabled authentication methods
-* Included and excluded wallets
-* Wallet display order
-* Supported networks
-* Default network
-* Block explorer
-* Interface language
+- Enabled authentication methods
+- Included and excluded wallets
+- Wallet display order
+- Supported networks
+- Default network
+- Block explorer
+- Interface language
 
 Configuration options can be set via the `BluxProvider` config or environment variables.
 
@@ -104,11 +153,11 @@ The Blux dashboard provides information about the users who have connected to yo
 
 Available information includes:
 
-* Authentication method
-* Login and connection timestamps
-* Associated wallet addresses, when available
-* Recent authentication activity
-* Individual user information
+- Authentication method
+- Login and connection timestamps
+- Associated wallet addresses, when available
+- Recent authentication activity
+- Individual user information
 
 This information can help developers understand how their applications are being used and troubleshoot authentication or wallet connection issues.
 
@@ -124,57 +173,60 @@ These credentials are intended only for the configured testing environment. Refe
 
 Currently supported connection methods:
 
-* [x] **Freighter**
-* [x] **Rabet**
-* [x] **WalletConnect**
-* [x] **HOT Wallet**
-* [x] **Hana**
-* [x] **xBull**
-* [x] **LOBSTR**
-* [x] **Ledger**
-* [x] **Albedo**
-* [x] **Klever Wallet**
-* [x] **Bitget Wallet**
-* [x] **OneKey**
-* [x] **CactusLink**
-* [x] **Fordefi**
-* [x] **Trezor**
-* [x] **Email**
-* [x] **Google**
-* [x] **Passkey**
+- [x] **Freighter**
+- [x] **Rabet**
+- [x] **WalletConnect**
+- [x] **HOT Wallet**
+- [x] **Hana**
+- [x] **xBull**
+- [x] **LOBSTR**
+- [x] **Ledger**
+- [x] **Albedo**
+- [x] **Klever Wallet**
+- [x] **Bitget Wallet**
+- [x] **OneKey**
+- [x] **CactusLink**
+- [x] **Fordefi**
+- [x] **Trezor**
+- [x] **Email**
+- [x] **Google**
+- [x] **Apple**
+- [x] **Discord**
+- [x] **Telegram**
+- [x] **Passkey**
 
 ## Supported Languages
 
 Currently supported languages:
 
-* [x] **English**
-* [x] **Spanish**
-* [x] **Portuguese**
-* [x] **French**
-* [x] **German**
-* [x] **Russian**
-* [x] **Chinese**
-* [x] **Japanese**
-* [x] **Korean**
+- [x] **English**
+- [x] **Spanish**
+- [x] **Portuguese**
+- [x] **French**
+- [x] **German**
+- [x] **Russian**
+- [x] **Chinese**
+- [x] **Japanese**
+- [x] **Korean**
 
 ## License & Usage Restrictions
 
-* **No Forking or Unauthorized Modifications**: Removing references to **Blux Team** or forking without attribution is strictly prohibited.
-* **Custom Licensing Available**: Contact us at [support@blux.cc](mailto:support@blux.cc) to discuss licensing options.
+- **No Forking or Unauthorized Modifications**: Removing references to **Blux Team** or forking without attribution is strictly prohibited.
+- **Custom Licensing Available**: Contact us at [support@blux.cc](mailto:support@blux.cc) to discuss licensing options.
 
 ## Support & Contact
 
 For support, licensing, custom SMS authentication, or other inquiries, reach out via:
 
-* **Email**: [support@blux.cc](mailto:support@blux.cc)
-* **X**: [@BluxOfficial](https://x.com/bluxofficial)
+- **Email**: [support@blux.cc](mailto:support@blux.cc)
+- **X**: [@BluxOfficial](https://x.com/bluxofficial)
 
 ## Roadmap & Future Plans
 
 Blux is evolving. Follow our updates on [X](https://x.com/BluxOfficial) for:
 
-* **Additional OAuth and Social Authentication Methods**
-* **More Wallet Integrations**
-* **Enhanced Developer Hooks**
-* **Expanded Soroban Support**
-* **Enhanced Customization, Analytics, and Security Features**
+- **Additional OAuth and Social Authentication Methods**
+- **More Wallet Integrations**
+- **Enhanced Developer Hooks**
+- **Expanded Soroban Support**
+- **Enhanced Customization, Analytics, and Security Features**

package/dist/assets/AdditionalSocialLogos.d.ts

@@ -0,0 +1,15 @@
+export declare const FarcasterLogo: () => import("react/jsx-runtime").JSX.Element;
+export declare const TikTokLogo: () => import("react/jsx-runtime").JSX.Element;
+export declare const LinkedInLogo: () => import("react/jsx-runtime").JSX.Element;
+export declare const TwitchLogo: () => import("react/jsx-runtime").JSX.Element;
+export declare const KickLogo: () => import("react/jsx-runtime").JSX.Element;
+export declare const SpotifyLogo: () => import("react/jsx-runtime").JSX.Element;
+export declare const InstagramLogo: () => import("react/jsx-runtime").JSX.Element;
+export declare const MicrosoftLogo: () => import("react/jsx-runtime").JSX.Element;
+export declare const GitLabLogo: () => import("react/jsx-runtime").JSX.Element;
+export declare const XLogo: ({ fill }: {
+    fill?: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const SteamLogo: ({ fill }: {
+    fill?: string;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/assets/AppleLogo.d.ts

@@ -0,0 +1,3 @@
+export declare const AppleLogo: ({ fill }: {
+    fill?: string;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/assets/DiscordLogo.d.ts

@@ -0,0 +1 @@
+export declare const DiscordLogo: () => import("react/jsx-runtime").JSX.Element;

package/dist/assets/GitHubLogo.d.ts

@@ -0,0 +1,3 @@
+export declare const GitHubLogo: ({ fill }: {
+    fill?: string;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/assets/MetaLogo.d.ts

@@ -0,0 +1 @@
+export declare const MetaLogo: () => import("react/jsx-runtime").JSX.Element;

package/dist/assets/TelegramLogo.d.ts

@@ -0,0 +1 @@
+export declare const TelegramLogo: () => import("react/jsx-runtime").JSX.Element;

package/dist/assets/index.d.ts

@@ -1,3 +1,12 @@
+export declare const CurrencyExchange: ({ fill }: {
+    fill?: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const BuyIcon: ({ fill }: {
+    fill?: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const SellIcon: ({ fill }: {
+    fill?: string;
+}) => import("react/jsx-runtime").JSX.Element;
 export declare const ArrowOutward: ({ fill }: {
     fill?: string;
 }) => import("react/jsx-runtime").JSX.Element;
@@ -15,5 +24,9 @@ export declare const FordefiLogo: () => import("react/jsx-runtime").JSX.Element;
 export declare const TrezorLogo: ({ fill }: {
     fill?: string;
 }) => import("react/jsx-runtime").JSX.Element;
+export declare const MoneyGramLogo: () => import("react/jsx-runtime").JSX.Element;
 export declare const MoonPayLogo: () => import("react/jsx-runtime").JSX.Element;
 export declare const PasskeyFingerLogo: () => import("react/jsx-runtime").JSX.Element;
+export declare const PhoneIcon: ({ fill }: {
+    fill?: string;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/components/CardItem/index.d.ts

@@ -10,7 +10,8 @@ type CardItemProps = {
     onChange?: (value: string) => void;
     onEnter?: (value: string) => void;
     onSubmit?: (value: string) => void;
-    inputType?: 'text' | 'password' | 'number' | 'email' | string;
+    inputType?: 'text' | 'password' | 'number' | 'email' | 'tel' | string;
+    placeholder?: string;
 };
-declare const CardItem: ({ variant, size, startIcon, endArrow, isRecent, label, onClick, onChange, onEnter, onSubmit, inputType, }: CardItemProps) => import("react/jsx-runtime").JSX.Element;
+declare const CardItem: ({ variant, size, startIcon, endArrow, isRecent, label, onClick, onChange, onEnter, onSubmit, inputType, placeholder, }: CardItemProps) => import("react/jsx-runtime").JSX.Element;
 export default CardItem;

package/dist/components/CardItem/variants/input.d.ts

@@ -4,7 +4,8 @@ type InputCardProps = {
     onChange?: (value: string) => void;
     onEnter?: (value: string) => void;
     onSubmit?: (value: string) => void;
-    inputType?: 'text' | 'password' | 'number' | 'email' | string;
+    inputType?: 'text' | 'password' | 'number' | 'email' | 'tel' | string;
+    placeholder?: string;
 };
-declare const InputCard: ({ startIcon, onChange, onEnter, onSubmit, inputType, }: InputCardProps) => import("react/jsx-runtime").JSX.Element;
+declare const InputCard: ({ startIcon, onChange, onEnter, onSubmit, inputType, placeholder, }: InputCardProps) => import("react/jsx-runtime").JSX.Element;
 export default InputCard;

package/dist/components/SocialProviderIcon.d.ts

@@ -0,0 +1,5 @@
+declare const SocialProviderIcon: ({ provider, fill, }: {
+    provider: string;
+    fill?: string;
+}) => import("react/jsx-runtime").JSX.Element | null;
+export default SocialProviderIcon;

package/dist/enums.d.ts

@@ -26,7 +26,8 @@ export declare enum StellarNetwork {
 export declare enum Route {
     ONBOARDING = "ONBOARDING",// View for selecting a wallet
     PASSKEY_ONBOARDING = "PASSKEY_ONBOARDING",
-    SOCIALS_ONBOARDING = "SOCIALS_ONBOARDING",// Social (OAuth) login popup flow
+    SOCIALS_ONBOARDING = "SOCIALS_ONBOARDING",// Social login waiting / widget / popup flow
+    OTHER_SOCIALS = "OTHER_SOCIALS",// Remaining social providers after the primary one
     WRONG_NETWORK = "WRONG_NETWORK",// View for selecting a wallet
     WAITING = "WAITING",// View for connection process
     SUCCESSFUL = "SUCCESSFUL",// View for connection success process

package/dist/exports/core/helpers/account.d.ts

@@ -1,12 +1,4 @@
 import { Asset, Horizon } from '@stellar/stellar-sdk';
-/**
- * Loads an account from Horizon, returning `null` instead of throwing when the
- * account does not exist on the network yet.
- *
- * @param horizon - The Horizon server to query.
- * @param address - The account id (`G...`) to load.
- * @returns The account, or `null` if it is not found.
- */
 export declare const loadAccount: (horizon: Horizon.Server, address: string) => Promise<Horizon.AccountResponse | null>;
 /**
  * Reports whether `account` can receive `asset` directly: always true for the

package/dist/exports/core/swap.d.ts

@@ -38,6 +38,15 @@ export type SwapOptions = {
     /** Network passphrase to swap on. Defaults to the active network. */
     network?: string;
 };
+/**
+ * Builds the unsigned swap transaction XDR. {@link swap} signs and submits this
+ * envelope; the profile Swap page uses it so it can close the modal before
+ * opening the signing flow.
+ *
+ * @param options - What to swap and how — see {@link SwapOptions}.
+ * @returns The unsigned transaction envelope as XDR.
+ */
+export declare const buildSwapTransaction: (options: SwapOptions) => Promise<string>;
 /**
  * Swaps one asset for another through the Stellar DEX / liquidity pools using a
  * path payment, picking the best available path automatically. Routes of at

package/dist/exports/createConfig.d.ts

@@ -7,7 +7,7 @@ export type { IAppearance, IConfig, IExplorer, ILoginMethods, IServers, ITrezorM
  *
  * Wallet availability is always scanned in the background. `isReady` waits on
  * that scan only when `loginMethods` includes `'wallet'`; apps that omit
- * wallet login (email/social/passkey only) become ready as soon as the config
+ * wallet login (email/SMS/social/passkey only) become ready as soon as the config
  * is applied, so they are not blocked by extension detection or `window.load`.
  *
  * @param config - The app configuration — see {@link IConfig}.

package/dist/exports/index.d.ts

@@ -5,6 +5,7 @@ export type { IExportedStore } from './exportedStore';
 export { Asset } from '@stellar/stellar-sdk';
 export * as StellarSdk from '@stellar/stellar-sdk';
 export * from './core';
+export * as core from './core';
 export { blux } from './blux';
 export { BluxEvent } from '../utils/events';
 export { getState, subscribe, getInitialState, useExportedStore, } from './exportedStore';

package/dist/hooks/useTransactions.d.ts

@@ -7,5 +7,10 @@ export type UseTransactionsResult = {
     error: Error | null;
     transactions: TransactionRecordWithOperations[];
 };
+/**
+ * Horizon activity for the signed-in account. Mount this only from the
+ * Activity page — listing txs and then fetching each one's operations is
+ * expensive and should not run in the background.
+ */
 declare const useTransactions: () => UseTransactionsResult;
 export default useTransactions;