@djangocfg/ext-payments 1.0.1 → 1.0.3

package/dist/hooks.d.cts

@@ -0,0 +1,187 @@
+import { API, PaymentList as PaymentList$1 } from './index.cjs';
+export { APIClient, APIError, APILogger, APIOptions, Balance, BalanceSchema, CookieStorageAdapter, Currency, CurrencySchema, DEFAULT_RETRY_CONFIG, Enums, ErrorLog, ExtPaymentsPaymentsTypes, FailedAttemptInfo, FetchAdapter, Fetchers, HttpClientAdapter, HttpRequest, HttpResponse, LocalStorageAdapter, LoggerConfig, MemoryStorageAdapter, NetworkError, PAYMENT_EVENTS, PaginatedPaymentListList, PaginatedPaymentListListSchema, PaymentDetail, PaymentDetailSchema, PaymentEvent, PaymentListSchema, PaymentTab, PaymentsLayout, PaymentsLayoutProps, REFRESH_TOKEN_KEY, RequestLog, ResponseLog, RetryConfig, Schemas, StorageAdapter, TOKEN_KEY, Transaction, TransactionSchema, ValidationErrorDetail, ValidationErrorEvent, apiPayments, clearAPITokens, closePaymentsDialog, configureAPI, createPaymentsPaymentsConfirmCreate, createPaymentsPaymentsCreateCreate, dispatchValidationError, extensionConfig, formatZodError, getAPIInstance, getPaymentsBalanceRetrieve, getPaymentsCurrenciesList, getPaymentsPaymentsList, getPaymentsPaymentsRetrieve, getPaymentsPaymentsStatusRetrieve, getPaymentsTransactionsList, isAPIConfigured, onValidationError, openCreatePaymentDialog, openPaymentDetailsDialog, reconfigureAPI, resetAPI, shouldRetry, withRetry } from './index.cjs';
+import useSWR from 'swr';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React, { ReactNode } from 'react';
+import 'consola';
+import 'zod';
+import '@djangocfg/ext-base';
+
+/**
+ * SWR Hooks for Payments
+ *
+ * React hooks powered by SWR for data fetching with automatic caching,
+ * revalidation, and optimistic updates.
+ *
+ * Usage:
+ * ```typescript
+ * // Query hooks (GET)
+ * const { data, error, isLoading } = useUsers({ page: 1 })
+ *
+ * // Mutation hooks (POST/PUT/PATCH/DELETE)
+ * const createUser = useCreateUser()
+ * await createUser({ name: 'John', email: 'john@example.com' })
+ * ```
+ */
+
+/**
+ * Get user balance
+ *
+ * @method GET
+ * @path /cfg/payments/balance/
+ */
+declare function usePaymentsBalanceRetrieve(client?: API): ReturnType<typeof useSWR<Balance>>;
+/**
+ * Get available currencies
+ *
+ * @method GET
+ * @path /cfg/payments/currencies/
+ */
+declare function usePaymentsCurrenciesList(client?: API): ReturnType<typeof useSWR<any>>;
+/**
+ * API operation
+ *
+ * @method GET
+ * @path /cfg/payments/payments/
+ */
+declare function usePaymentsPaymentsList(params?: {
+    page?: number;
+    page_size?: number;
+}, client?: API): ReturnType<typeof useSWR<PaginatedPaymentListList>>;
+/**
+ * API operation
+ *
+ * @method GET
+ * @path /cfg/payments/payments/{id}/
+ */
+declare function usePaymentsPaymentsRetrieve(id: string, client?: API): ReturnType<typeof useSWR<PaymentDetail>>;
+/**
+ * API operation
+ *
+ * @method POST
+ * @path /cfg/payments/payments/{id}/confirm/
+ */
+declare function useCreatePaymentsPaymentsConfirmCreate(): (id: string, client?: API) => Promise<PaymentList$1>;
+/**
+ * API operation
+ *
+ * @method GET
+ * @path /cfg/payments/payments/{id}/status/
+ */
+declare function usePaymentsPaymentsStatusRetrieve(id: string, client?: API): ReturnType<typeof useSWR<PaymentList>>;
+/**
+ * API operation
+ *
+ * @method POST
+ * @path /cfg/payments/payments/create/
+ */
+declare function useCreatePaymentsPaymentsCreateCreate(): (client?: API) => Promise<PaymentList$1>;
+/**
+ * Get user transactions
+ *
+ * @method GET
+ * @path /cfg/payments/transactions/
+ */
+declare function usePaymentsTransactionsList(params?: {
+    limit?: number;
+    offset?: number;
+    type?: string;
+}, client?: API): ReturnType<typeof useSWR<any>>;
+
+/**
+ * Payments Types
+ * Centralized type definitions for payments contexts
+ */
+
+type PaginatedPaymentListList = NonNullable<Awaited<ReturnType<typeof usePaymentsPaymentsList>>['data']>;
+type PaymentDetail = NonNullable<Awaited<ReturnType<typeof usePaymentsPaymentsRetrieve>>['data']>;
+type PaymentList = NonNullable<Awaited<ReturnType<typeof usePaymentsPaymentsList>>['data']> extends {
+    results: infer T;
+} ? T extends Array<infer U> ? U : never : never;
+
+interface PaymentsContextValue {
+    payments: PaginatedPaymentListList | undefined;
+    isLoadingPayments: boolean;
+    paymentsError: Error | undefined;
+    refreshPayments: () => Promise<void>;
+    getPayment: (id: string) => Promise<PaymentDetail | undefined>;
+    createPayment: () => Promise<PaymentList>;
+    confirmPayment: (id: string) => Promise<PaymentList>;
+    checkPaymentStatus: (id: string) => Promise<PaymentList | undefined>;
+}
+declare function PaymentsProvider({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function usePaymentsContext(): PaymentsContextValue;
+
+interface BalancesContextValue {
+    balance: any | undefined;
+    isLoadingBalance: boolean;
+    balanceError: Error | undefined;
+    refreshBalance: () => Promise<void>;
+}
+declare function BalancesProvider({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function useBalancesContext(): BalancesContextValue;
+
+interface CurrenciesContextValue {
+    currencies: any | undefined;
+    isLoadingCurrencies: boolean;
+    currenciesError: Error | undefined;
+    refreshCurrencies: () => Promise<void>;
+}
+declare function CurrenciesProvider({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function useCurrenciesContext(): CurrenciesContextValue;
+
+interface OverviewContextValue {
+    balance: any | undefined;
+    isLoadingBalance: boolean;
+    balanceError: Error | undefined;
+    refreshBalance: () => Promise<void>;
+    payments: PaginatedPaymentListList | undefined;
+    isLoadingPayments: boolean;
+    paymentsError: Error | undefined;
+    refreshPayments: () => Promise<void>;
+    transactions: any | undefined;
+    isLoadingTransactions: boolean;
+    transactionsError: Error | undefined;
+    refreshTransactions: () => Promise<void>;
+    createPayment: () => Promise<PaymentList>;
+    isLoadingOverview: boolean;
+    overviewError: Error | undefined;
+    refreshOverview: () => Promise<void>;
+}
+declare function OverviewProvider({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function useOverviewContext(): OverviewContextValue;
+
+interface RootPaymentsContextValue {
+    currencies: any | undefined;
+    isLoadingCurrencies: boolean;
+    currenciesError: Error | undefined;
+    refreshCurrencies: () => Promise<void>;
+}
+declare function RootPaymentsProvider({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function useRootPaymentsContext(): RootPaymentsContextValue;
+
+/**
+ * Create Payment Dialog (v2.0 - Simplified)
+ * Dialog for creating new payments
+ */
+
+declare const CreatePaymentDialog: React.FC;
+
+/**
+ * Payment Details Dialog (v2.0 - Simplified)
+ * Shows payment details with QR code, address, and status
+ */
+
+declare const PaymentDetailsDialog: React.FC;
+
+export { API, type BalancesContextValue, BalancesProvider, CreatePaymentDialog, type CurrenciesContextValue, CurrenciesProvider, type OverviewContextValue, OverviewProvider, PaymentDetailsDialog, PaymentList$1 as PaymentList, type PaymentsContextValue, PaymentsProvider, type RootPaymentsContextValue, RootPaymentsProvider, useBalancesContext, useCreatePaymentsPaymentsConfirmCreate, useCreatePaymentsPaymentsCreateCreate, useCurrenciesContext, useOverviewContext, usePaymentsBalanceRetrieve, usePaymentsContext, usePaymentsCurrenciesList, usePaymentsPaymentsList, usePaymentsPaymentsRetrieve, usePaymentsPaymentsStatusRetrieve, usePaymentsTransactionsList, useRootPaymentsContext };

package/dist/hooks.d.ts

@@ -0,0 +1,187 @@
+import { API, PaymentList as PaymentList$1 } from './index.js';
+export { APIClient, APIError, APILogger, APIOptions, Balance, BalanceSchema, CookieStorageAdapter, Currency, CurrencySchema, DEFAULT_RETRY_CONFIG, Enums, ErrorLog, ExtPaymentsPaymentsTypes, FailedAttemptInfo, FetchAdapter, Fetchers, HttpClientAdapter, HttpRequest, HttpResponse, LocalStorageAdapter, LoggerConfig, MemoryStorageAdapter, NetworkError, PAYMENT_EVENTS, PaginatedPaymentListList, PaginatedPaymentListListSchema, PaymentDetail, PaymentDetailSchema, PaymentEvent, PaymentListSchema, PaymentTab, PaymentsLayout, PaymentsLayoutProps, REFRESH_TOKEN_KEY, RequestLog, ResponseLog, RetryConfig, Schemas, StorageAdapter, TOKEN_KEY, Transaction, TransactionSchema, ValidationErrorDetail, ValidationErrorEvent, apiPayments, clearAPITokens, closePaymentsDialog, configureAPI, createPaymentsPaymentsConfirmCreate, createPaymentsPaymentsCreateCreate, dispatchValidationError, extensionConfig, formatZodError, getAPIInstance, getPaymentsBalanceRetrieve, getPaymentsCurrenciesList, getPaymentsPaymentsList, getPaymentsPaymentsRetrieve, getPaymentsPaymentsStatusRetrieve, getPaymentsTransactionsList, isAPIConfigured, onValidationError, openCreatePaymentDialog, openPaymentDetailsDialog, reconfigureAPI, resetAPI, shouldRetry, withRetry } from './index.js';
+import useSWR from 'swr';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React, { ReactNode } from 'react';
+import 'consola';
+import 'zod';
+import '@djangocfg/ext-base';
+
+/**
+ * SWR Hooks for Payments
+ *
+ * React hooks powered by SWR for data fetching with automatic caching,
+ * revalidation, and optimistic updates.
+ *
+ * Usage:
+ * ```typescript
+ * // Query hooks (GET)
+ * const { data, error, isLoading } = useUsers({ page: 1 })
+ *
+ * // Mutation hooks (POST/PUT/PATCH/DELETE)
+ * const createUser = useCreateUser()
+ * await createUser({ name: 'John', email: 'john@example.com' })
+ * ```
+ */
+
+/**
+ * Get user balance
+ *
+ * @method GET
+ * @path /cfg/payments/balance/
+ */
+declare function usePaymentsBalanceRetrieve(client?: API): ReturnType<typeof useSWR<Balance>>;
+/**
+ * Get available currencies
+ *
+ * @method GET
+ * @path /cfg/payments/currencies/
+ */
+declare function usePaymentsCurrenciesList(client?: API): ReturnType<typeof useSWR<any>>;
+/**
+ * API operation
+ *
+ * @method GET
+ * @path /cfg/payments/payments/
+ */
+declare function usePaymentsPaymentsList(params?: {
+    page?: number;
+    page_size?: number;
+}, client?: API): ReturnType<typeof useSWR<PaginatedPaymentListList>>;
+/**
+ * API operation
+ *
+ * @method GET
+ * @path /cfg/payments/payments/{id}/
+ */
+declare function usePaymentsPaymentsRetrieve(id: string, client?: API): ReturnType<typeof useSWR<PaymentDetail>>;
+/**
+ * API operation
+ *
+ * @method POST
+ * @path /cfg/payments/payments/{id}/confirm/
+ */
+declare function useCreatePaymentsPaymentsConfirmCreate(): (id: string, client?: API) => Promise<PaymentList$1>;
+/**
+ * API operation
+ *
+ * @method GET
+ * @path /cfg/payments/payments/{id}/status/
+ */
+declare function usePaymentsPaymentsStatusRetrieve(id: string, client?: API): ReturnType<typeof useSWR<PaymentList>>;
+/**
+ * API operation
+ *
+ * @method POST
+ * @path /cfg/payments/payments/create/
+ */
+declare function useCreatePaymentsPaymentsCreateCreate(): (client?: API) => Promise<PaymentList$1>;
+/**
+ * Get user transactions
+ *
+ * @method GET
+ * @path /cfg/payments/transactions/
+ */
+declare function usePaymentsTransactionsList(params?: {
+    limit?: number;
+    offset?: number;
+    type?: string;
+}, client?: API): ReturnType<typeof useSWR<any>>;
+
+/**
+ * Payments Types
+ * Centralized type definitions for payments contexts
+ */
+
+type PaginatedPaymentListList = NonNullable<Awaited<ReturnType<typeof usePaymentsPaymentsList>>['data']>;
+type PaymentDetail = NonNullable<Awaited<ReturnType<typeof usePaymentsPaymentsRetrieve>>['data']>;
+type PaymentList = NonNullable<Awaited<ReturnType<typeof usePaymentsPaymentsList>>['data']> extends {
+    results: infer T;
+} ? T extends Array<infer U> ? U : never : never;
+
+interface PaymentsContextValue {
+    payments: PaginatedPaymentListList | undefined;
+    isLoadingPayments: boolean;
+    paymentsError: Error | undefined;
+    refreshPayments: () => Promise<void>;
+    getPayment: (id: string) => Promise<PaymentDetail | undefined>;
+    createPayment: () => Promise<PaymentList>;
+    confirmPayment: (id: string) => Promise<PaymentList>;
+    checkPaymentStatus: (id: string) => Promise<PaymentList | undefined>;
+}
+declare function PaymentsProvider({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function usePaymentsContext(): PaymentsContextValue;
+
+interface BalancesContextValue {
+    balance: any | undefined;
+    isLoadingBalance: boolean;
+    balanceError: Error | undefined;
+    refreshBalance: () => Promise<void>;
+}
+declare function BalancesProvider({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function useBalancesContext(): BalancesContextValue;
+
+interface CurrenciesContextValue {
+    currencies: any | undefined;
+    isLoadingCurrencies: boolean;
+    currenciesError: Error | undefined;
+    refreshCurrencies: () => Promise<void>;
+}
+declare function CurrenciesProvider({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function useCurrenciesContext(): CurrenciesContextValue;
+
+interface OverviewContextValue {
+    balance: any | undefined;
+    isLoadingBalance: boolean;
+    balanceError: Error | undefined;
+    refreshBalance: () => Promise<void>;
+    payments: PaginatedPaymentListList | undefined;
+    isLoadingPayments: boolean;
+    paymentsError: Error | undefined;
+    refreshPayments: () => Promise<void>;
+    transactions: any | undefined;
+    isLoadingTransactions: boolean;
+    transactionsError: Error | undefined;
+    refreshTransactions: () => Promise<void>;
+    createPayment: () => Promise<PaymentList>;
+    isLoadingOverview: boolean;
+    overviewError: Error | undefined;
+    refreshOverview: () => Promise<void>;
+}
+declare function OverviewProvider({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function useOverviewContext(): OverviewContextValue;
+
+interface RootPaymentsContextValue {
+    currencies: any | undefined;
+    isLoadingCurrencies: boolean;
+    currenciesError: Error | undefined;
+    refreshCurrencies: () => Promise<void>;
+}
+declare function RootPaymentsProvider({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function useRootPaymentsContext(): RootPaymentsContextValue;
+
+/**
+ * Create Payment Dialog (v2.0 - Simplified)
+ * Dialog for creating new payments
+ */
+
+declare const CreatePaymentDialog: React.FC;
+
+/**
+ * Payment Details Dialog (v2.0 - Simplified)
+ * Shows payment details with QR code, address, and status
+ */
+
+declare const PaymentDetailsDialog: React.FC;
+
+export { API, type BalancesContextValue, BalancesProvider, CreatePaymentDialog, type CurrenciesContextValue, CurrenciesProvider, type OverviewContextValue, OverviewProvider, PaymentDetailsDialog, PaymentList$1 as PaymentList, type PaymentsContextValue, PaymentsProvider, type RootPaymentsContextValue, RootPaymentsProvider, useBalancesContext, useCreatePaymentsPaymentsConfirmCreate, useCreatePaymentsPaymentsCreateCreate, useCurrenciesContext, useOverviewContext, usePaymentsBalanceRetrieve, usePaymentsContext, usePaymentsCurrenciesList, usePaymentsPaymentsList, usePaymentsPaymentsRetrieve, usePaymentsPaymentsStatusRetrieve, usePaymentsTransactionsList, useRootPaymentsContext };