azirid-react 0.7.0 → 0.8.0

package/dist/index.d.cts

@@ -3,6 +3,7 @@ import { ReactNode, CSSProperties, FormEvent } from 'react';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseMutationResult, UseQueryResult } from '@tanstack/react-query';
 import { z } from 'zod';
+import { TenantRole, Environment } from '@azirid/shared';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ClassValue } from 'clsx';
 
@@ -15,9 +16,9 @@ interface AuthUser {
     mfaEnabled?: boolean;
     appId?: string;
     tenantId: string;
-    tenantRole: string;
+    tenantRole: TenantRole | string;
     workspaceId?: string;
-    environment?: 'development' | 'production';
+    environment?: Environment;
     mustChangePassword?: boolean;
     publicMetadata?: Record<string, unknown> | null;
     unsafeMetadata?: Record<string, unknown> | null;
@@ -510,12 +511,12 @@ interface TenantWithRole {
     slug: string;
     description?: string | null;
     enabled: boolean;
-    role: 'OWNER' | 'MEMBER';
+    role: TenantRole;
     joinedAt: string;
 }
 interface TenantMemberInfo {
     id: string;
-    role: 'OWNER' | 'MEMBER';
+    role: TenantRole;
     joinedAt: string;
     user: {
         id: string;
@@ -1442,6 +1443,52 @@ declare function useSwitchTenant(): {
     switchTenant: (tenantId: string) => Promise<void>;
 };
 
+/**
+ * Options common to all simple mutation hooks created via `createMutationHook`.
+ */
+interface SimpleMutationOptions<TData> {
+    onSuccess?: (data: TData) => void;
+    onError?: (error: Error) => void;
+}
+/**
+ * Configuration for `createMutationHook`.
+ *
+ * @template TData  The response type from the API
+ * @template TInput The input/variables type for the mutation
+ */
+interface MutationHookConfig<TData, TInput> {
+    /** Static mutation key for deduplication / devtools */
+    mutationKey: string[];
+    /**
+     * Derive the mutation function from the AccessClient and input.
+     * Most hooks simply call `client.post<TData>(client.paths.someEndpoint, data)`.
+     */
+    mutationFn: (client: AccessClient, input: TInput) => Promise<TData>;
+}
+/**
+ * Factory that creates a simple `useMutation`-based hook.
+ *
+ * Eliminates the boilerplate of:
+ *   1. Calling `useAccessClient()`
+ *   2. Creating a `useMutation` with `mutationKey`, `mutationFn`, `onSuccess`, `onError`
+ *
+ * The resulting hook has the same return type as `useMutation` (`UseMutationResult`),
+ * preserving full compatibility with TanStack Query.
+ *
+ * @example
+ * ```ts
+ * export const useChangePassword = createMutationHook<
+ *   { updated: boolean },
+ *   ChangePasswordData
+ * >({
+ *   mutationKey: ['azirid-access', 'change-password'],
+ *   mutationFn: (client, data) =>
+ *     client.post<{ updated: boolean }>(client.paths.changePassword, data),
+ * })
+ * ```
+ */
+declare function createMutationHook<TData, TInput = void>(config: MutationHookConfig<TData, TInput>): (options?: SimpleMutationOptions<TData>) => UseMutationResult<TData, Error, TInput>;
+
 declare function useFormState<T extends Record<string, unknown>>(initialValues: T, schema: z.ZodType<unknown, z.ZodTypeDef, unknown>, onSubmit: (values: T) => void | Promise<void>): UseFormReturn<T>;
 
 declare function usePasswordToggle(): {
@@ -1580,6 +1627,30 @@ declare function cn(...inputs: ClassValue[]): string;
 /** Remove injected styles from the DOM (useful when embedding in host apps). */
 declare function removeStyles(): void;
 
+interface PricingCardProps {
+    plan: BillingPlan;
+    isCurrentPlan: boolean;
+    isCheckoutPending: boolean;
+    onSelect: (plan: BillingPlan) => void;
+}
+
+interface PricingFeatureListProps {
+    features: string[];
+}
+
+interface ProviderModalProps {
+    providers: AvailableProvider[];
+    isPending: boolean;
+    onSelect: (provider: PaymentProviderType) => void;
+    onClose: () => void;
+    labels?: Record<string, string>;
+}
+interface TransferModalProps {
+    data: CheckoutResponse;
+    onClose: () => void;
+    labels?: Record<string, string>;
+}
+
 declare global {
     interface Window {
         PPaymentButtonBox: new (config: Record<string, unknown>) => {
@@ -1604,4 +1675,4 @@ interface SessionSyncOptions {
 
 declare const SDK_VERSION: string;
 
-export { type AccessClient, type AccessClientConfig, type AccessMessages, type ApiError, type AppBranding, type AuthPaths, type AuthState, type AuthSuccessResponse, type AuthUser, type AvailableProvider, type AziridContextValue, AziridProvider, type AziridProviderProps, BASE_PATHS, type BillingInvoice, type BillingPlan, type BootstrapResponse, type ChangePasswordData, type ChangePasswordInput, CheckoutButton, type CheckoutButtonProps, type CheckoutParams, type CheckoutResponse, type CreateTenantData, type FieldError, InvoiceList, type InvoiceListProps, type LoginData, LoginForm, type LoginFormProps, type LoginInput, type MagicLinkRequestData, type MagicLinkRequestInput, type MagicLinkVerifyData, type MagicLinkVerifyInput, PATHS, type PasskeyItem, type PasskeyLoginData, type PasskeyLoginStartData, type PasskeyLoginStartResponse, type PasskeyLoginVerifyData, type PasskeyRegisterStartData, type PasskeyRegisterStartInput, type PasskeyRegisterStartResponse, type PasskeyRegisterVerifyData, PayButton, type PayButtonProps, type PaymentIntent, type PaymentProviderType, PayphoneCallback, type PayphoneCallbackProps, type PayphoneConfirmParams, type PayphoneConfirmResult, type PayphoneModalProps, type PayphoneWidgetConfig, PricingTable, type PricingTableProps, ReferralCard, type ReferralCardProps, type ReferralInfo, type ReferralItem, ReferralStats, type ReferralStatsData, type ReferralStatsProps, type RegisterPasskeyData, SDK_VERSION, type SessionSyncOptions, type SignupData, SignupForm, type SignupFormProps, type SignupInput, type SocialLoginData, type SocialLoginInput, type SubmitTransferProofData, SubscriptionBadge, type SubscriptionBadgeProps, type SupportedLocale, type TenantMemberInfo, type TenantWithRole, type TransferProof, type UseBootstrapOptions, type UseBootstrapReturn, type UseChangePasswordOptions, type UseChangePasswordReturn, type UseCheckoutOptions, type UseFormReturn, type UseLoginOptions, type UseLoginReturn, type UseLogoutOptions, type UseLogoutReturn, type UseMagicLinkOptions, type UseMagicLinkReturn, type UsePasskeysOptions, type UsePasskeysReturn, type UsePayphoneConfirmOptions, type UseRefreshOptions, type UseRefreshReturn, type UseSessionOptions, type UseSessionReturn, type UseSignupOptions, type UseSignupReturn, type UseSocialLoginOptions, type UseSocialLoginReturn, type UserSubscription, buildPaths, changePasswordSchema, cn, createAccessClient, createLoginSchema, createSignupSchema, en, es, isAuthError, loginSchema, magicLinkRequestSchema, magicLinkVerifySchema, passkeyRegisterStartSchema, removeStyles, resolveMessages, signupSchema, socialLoginSchema, useAccessClient, useAzirid, useBootstrap, useBranding, useChangePassword, useCheckout, useFormState, useInvoices, useLogin, useLogout, useMagicLink, useMessages, usePasskeys, usePasswordToggle, usePaymentProviders, usePayphoneConfirm, usePlans, useReferral, useReferralStats, useRefresh, useSession, useSignup, useSocialLogin, useSubmitTransferProof, useSubscription, useSwitchTenant, useTenantMembers, useTenants, useTransferProofs };
+export { type AccessClient, type AccessClientConfig, type AccessMessages, type ApiError, type AppBranding, type AuthPaths, type AuthState, type AuthSuccessResponse, type AuthUser, type AvailableProvider, type AziridContextValue, AziridProvider, type AziridProviderProps, BASE_PATHS, type BillingInvoice, type BillingPlan, type BootstrapResponse, type ChangePasswordData, type ChangePasswordInput, CheckoutButton, type CheckoutButtonProps, type CheckoutParams, type CheckoutResponse, type CreateTenantData, type FieldError, InvoiceList, type InvoiceListProps, type LoginData, LoginForm, type LoginFormProps, type LoginInput, type MagicLinkRequestData, type MagicLinkRequestInput, type MagicLinkVerifyData, type MagicLinkVerifyInput, type MutationHookConfig, PATHS, type PasskeyItem, type PasskeyLoginData, type PasskeyLoginStartData, type PasskeyLoginStartResponse, type PasskeyLoginVerifyData, type PasskeyRegisterStartData, type PasskeyRegisterStartInput, type PasskeyRegisterStartResponse, type PasskeyRegisterVerifyData, PayButton, type PayButtonProps, type PaymentIntent, type PaymentProviderType, PayphoneCallback, type PayphoneCallbackProps, type PayphoneConfirmParams, type PayphoneConfirmResult, type PayphoneModalProps, type PayphoneWidgetConfig, type PricingCardProps, type PricingFeatureListProps, PricingTable, type PricingTableProps, type ProviderModalProps, ReferralCard, type ReferralCardProps, type ReferralInfo, type ReferralItem, ReferralStats, type ReferralStatsData, type ReferralStatsProps, type RegisterPasskeyData, SDK_VERSION, type SessionSyncOptions, type SignupData, SignupForm, type SignupFormProps, type SignupInput, type SimpleMutationOptions, type SocialLoginData, type SocialLoginInput, type SubmitTransferProofData, SubscriptionBadge, type SubscriptionBadgeProps, type SupportedLocale, type TenantMemberInfo, type TenantWithRole, type TransferModalProps, type TransferProof, type UseBootstrapOptions, type UseBootstrapReturn, type UseChangePasswordOptions, type UseChangePasswordReturn, type UseCheckoutOptions, type UseFormReturn, type UseLoginOptions, type UseLoginReturn, type UseLogoutOptions, type UseLogoutReturn, type UseMagicLinkOptions, type UseMagicLinkReturn, type UsePasskeysOptions, type UsePasskeysReturn, type UsePayphoneConfirmOptions, type UseRefreshOptions, type UseRefreshReturn, type UseSessionOptions, type UseSessionReturn, type UseSignupOptions, type UseSignupReturn, type UseSocialLoginOptions, type UseSocialLoginReturn, type UserSubscription, buildPaths, changePasswordSchema, cn, createAccessClient, createLoginSchema, createMutationHook, createSignupSchema, en, es, isAuthError, loginSchema, magicLinkRequestSchema, magicLinkVerifySchema, passkeyRegisterStartSchema, removeStyles, resolveMessages, signupSchema, socialLoginSchema, useAccessClient, useAzirid, useBootstrap, useBranding, useChangePassword, useCheckout, useFormState, useInvoices, useLogin, useLogout, useMagicLink, useMessages, usePasskeys, usePasswordToggle, usePaymentProviders, usePayphoneConfirm, usePlans, useReferral, useReferralStats, useRefresh, useSession, useSignup, useSocialLogin, useSubmitTransferProof, useSubscription, useSwitchTenant, useTenantMembers, useTenants, useTransferProofs };

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import { ReactNode, CSSProperties, FormEvent } from 'react';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseMutationResult, UseQueryResult } from '@tanstack/react-query';
 import { z } from 'zod';
+import { TenantRole, Environment } from '@azirid/shared';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ClassValue } from 'clsx';
 
@@ -15,9 +16,9 @@ interface AuthUser {
     mfaEnabled?: boolean;
     appId?: string;
     tenantId: string;
-    tenantRole: string;
+    tenantRole: TenantRole | string;
     workspaceId?: string;
-    environment?: 'development' | 'production';
+    environment?: Environment;
     mustChangePassword?: boolean;
     publicMetadata?: Record<string, unknown> | null;
     unsafeMetadata?: Record<string, unknown> | null;
@@ -510,12 +511,12 @@ interface TenantWithRole {
     slug: string;
     description?: string | null;
     enabled: boolean;
-    role: 'OWNER' | 'MEMBER';
+    role: TenantRole;
     joinedAt: string;
 }
 interface TenantMemberInfo {
     id: string;
-    role: 'OWNER' | 'MEMBER';
+    role: TenantRole;
     joinedAt: string;
     user: {
         id: string;
@@ -1442,6 +1443,52 @@ declare function useSwitchTenant(): {
     switchTenant: (tenantId: string) => Promise<void>;
 };
 
+/**
+ * Options common to all simple mutation hooks created via `createMutationHook`.
+ */
+interface SimpleMutationOptions<TData> {
+    onSuccess?: (data: TData) => void;
+    onError?: (error: Error) => void;
+}
+/**
+ * Configuration for `createMutationHook`.
+ *
+ * @template TData  The response type from the API
+ * @template TInput The input/variables type for the mutation
+ */
+interface MutationHookConfig<TData, TInput> {
+    /** Static mutation key for deduplication / devtools */
+    mutationKey: string[];
+    /**
+     * Derive the mutation function from the AccessClient and input.
+     * Most hooks simply call `client.post<TData>(client.paths.someEndpoint, data)`.
+     */
+    mutationFn: (client: AccessClient, input: TInput) => Promise<TData>;
+}
+/**
+ * Factory that creates a simple `useMutation`-based hook.
+ *
+ * Eliminates the boilerplate of:
+ *   1. Calling `useAccessClient()`
+ *   2. Creating a `useMutation` with `mutationKey`, `mutationFn`, `onSuccess`, `onError`
+ *
+ * The resulting hook has the same return type as `useMutation` (`UseMutationResult`),
+ * preserving full compatibility with TanStack Query.
+ *
+ * @example
+ * ```ts
+ * export const useChangePassword = createMutationHook<
+ *   { updated: boolean },
+ *   ChangePasswordData
+ * >({
+ *   mutationKey: ['azirid-access', 'change-password'],
+ *   mutationFn: (client, data) =>
+ *     client.post<{ updated: boolean }>(client.paths.changePassword, data),
+ * })
+ * ```
+ */
+declare function createMutationHook<TData, TInput = void>(config: MutationHookConfig<TData, TInput>): (options?: SimpleMutationOptions<TData>) => UseMutationResult<TData, Error, TInput>;
+
 declare function useFormState<T extends Record<string, unknown>>(initialValues: T, schema: z.ZodType<unknown, z.ZodTypeDef, unknown>, onSubmit: (values: T) => void | Promise<void>): UseFormReturn<T>;
 
 declare function usePasswordToggle(): {
@@ -1580,6 +1627,30 @@ declare function cn(...inputs: ClassValue[]): string;
 /** Remove injected styles from the DOM (useful when embedding in host apps). */
 declare function removeStyles(): void;
 
+interface PricingCardProps {
+    plan: BillingPlan;
+    isCurrentPlan: boolean;
+    isCheckoutPending: boolean;
+    onSelect: (plan: BillingPlan) => void;
+}
+
+interface PricingFeatureListProps {
+    features: string[];
+}
+
+interface ProviderModalProps {
+    providers: AvailableProvider[];
+    isPending: boolean;
+    onSelect: (provider: PaymentProviderType) => void;
+    onClose: () => void;
+    labels?: Record<string, string>;
+}
+interface TransferModalProps {
+    data: CheckoutResponse;
+    onClose: () => void;
+    labels?: Record<string, string>;
+}
+
 declare global {
     interface Window {
         PPaymentButtonBox: new (config: Record<string, unknown>) => {
@@ -1604,4 +1675,4 @@ interface SessionSyncOptions {
 
 declare const SDK_VERSION: string;
 
-export { type AccessClient, type AccessClientConfig, type AccessMessages, type ApiError, type AppBranding, type AuthPaths, type AuthState, type AuthSuccessResponse, type AuthUser, type AvailableProvider, type AziridContextValue, AziridProvider, type AziridProviderProps, BASE_PATHS, type BillingInvoice, type BillingPlan, type BootstrapResponse, type ChangePasswordData, type ChangePasswordInput, CheckoutButton, type CheckoutButtonProps, type CheckoutParams, type CheckoutResponse, type CreateTenantData, type FieldError, InvoiceList, type InvoiceListProps, type LoginData, LoginForm, type LoginFormProps, type LoginInput, type MagicLinkRequestData, type MagicLinkRequestInput, type MagicLinkVerifyData, type MagicLinkVerifyInput, PATHS, type PasskeyItem, type PasskeyLoginData, type PasskeyLoginStartData, type PasskeyLoginStartResponse, type PasskeyLoginVerifyData, type PasskeyRegisterStartData, type PasskeyRegisterStartInput, type PasskeyRegisterStartResponse, type PasskeyRegisterVerifyData, PayButton, type PayButtonProps, type PaymentIntent, type PaymentProviderType, PayphoneCallback, type PayphoneCallbackProps, type PayphoneConfirmParams, type PayphoneConfirmResult, type PayphoneModalProps, type PayphoneWidgetConfig, PricingTable, type PricingTableProps, ReferralCard, type ReferralCardProps, type ReferralInfo, type ReferralItem, ReferralStats, type ReferralStatsData, type ReferralStatsProps, type RegisterPasskeyData, SDK_VERSION, type SessionSyncOptions, type SignupData, SignupForm, type SignupFormProps, type SignupInput, type SocialLoginData, type SocialLoginInput, type SubmitTransferProofData, SubscriptionBadge, type SubscriptionBadgeProps, type SupportedLocale, type TenantMemberInfo, type TenantWithRole, type TransferProof, type UseBootstrapOptions, type UseBootstrapReturn, type UseChangePasswordOptions, type UseChangePasswordReturn, type UseCheckoutOptions, type UseFormReturn, type UseLoginOptions, type UseLoginReturn, type UseLogoutOptions, type UseLogoutReturn, type UseMagicLinkOptions, type UseMagicLinkReturn, type UsePasskeysOptions, type UsePasskeysReturn, type UsePayphoneConfirmOptions, type UseRefreshOptions, type UseRefreshReturn, type UseSessionOptions, type UseSessionReturn, type UseSignupOptions, type UseSignupReturn, type UseSocialLoginOptions, type UseSocialLoginReturn, type UserSubscription, buildPaths, changePasswordSchema, cn, createAccessClient, createLoginSchema, createSignupSchema, en, es, isAuthError, loginSchema, magicLinkRequestSchema, magicLinkVerifySchema, passkeyRegisterStartSchema, removeStyles, resolveMessages, signupSchema, socialLoginSchema, useAccessClient, useAzirid, useBootstrap, useBranding, useChangePassword, useCheckout, useFormState, useInvoices, useLogin, useLogout, useMagicLink, useMessages, usePasskeys, usePasswordToggle, usePaymentProviders, usePayphoneConfirm, usePlans, useReferral, useReferralStats, useRefresh, useSession, useSignup, useSocialLogin, useSubmitTransferProof, useSubscription, useSwitchTenant, useTenantMembers, useTenants, useTransferProofs };
+export { type AccessClient, type AccessClientConfig, type AccessMessages, type ApiError, type AppBranding, type AuthPaths, type AuthState, type AuthSuccessResponse, type AuthUser, type AvailableProvider, type AziridContextValue, AziridProvider, type AziridProviderProps, BASE_PATHS, type BillingInvoice, type BillingPlan, type BootstrapResponse, type ChangePasswordData, type ChangePasswordInput, CheckoutButton, type CheckoutButtonProps, type CheckoutParams, type CheckoutResponse, type CreateTenantData, type FieldError, InvoiceList, type InvoiceListProps, type LoginData, LoginForm, type LoginFormProps, type LoginInput, type MagicLinkRequestData, type MagicLinkRequestInput, type MagicLinkVerifyData, type MagicLinkVerifyInput, type MutationHookConfig, PATHS, type PasskeyItem, type PasskeyLoginData, type PasskeyLoginStartData, type PasskeyLoginStartResponse, type PasskeyLoginVerifyData, type PasskeyRegisterStartData, type PasskeyRegisterStartInput, type PasskeyRegisterStartResponse, type PasskeyRegisterVerifyData, PayButton, type PayButtonProps, type PaymentIntent, type PaymentProviderType, PayphoneCallback, type PayphoneCallbackProps, type PayphoneConfirmParams, type PayphoneConfirmResult, type PayphoneModalProps, type PayphoneWidgetConfig, type PricingCardProps, type PricingFeatureListProps, PricingTable, type PricingTableProps, type ProviderModalProps, ReferralCard, type ReferralCardProps, type ReferralInfo, type ReferralItem, ReferralStats, type ReferralStatsData, type ReferralStatsProps, type RegisterPasskeyData, SDK_VERSION, type SessionSyncOptions, type SignupData, SignupForm, type SignupFormProps, type SignupInput, type SimpleMutationOptions, type SocialLoginData, type SocialLoginInput, type SubmitTransferProofData, SubscriptionBadge, type SubscriptionBadgeProps, type SupportedLocale, type TenantMemberInfo, type TenantWithRole, type TransferModalProps, type TransferProof, type UseBootstrapOptions, type UseBootstrapReturn, type UseChangePasswordOptions, type UseChangePasswordReturn, type UseCheckoutOptions, type UseFormReturn, type UseLoginOptions, type UseLoginReturn, type UseLogoutOptions, type UseLogoutReturn, type UseMagicLinkOptions, type UseMagicLinkReturn, type UsePasskeysOptions, type UsePasskeysReturn, type UsePayphoneConfirmOptions, type UseRefreshOptions, type UseRefreshReturn, type UseSessionOptions, type UseSessionReturn, type UseSignupOptions, type UseSignupReturn, type UseSocialLoginOptions, type UseSocialLoginReturn, type UserSubscription, buildPaths, changePasswordSchema, cn, createAccessClient, createLoginSchema, createMutationHook, createSignupSchema, en, es, isAuthError, loginSchema, magicLinkRequestSchema, magicLinkVerifySchema, passkeyRegisterStartSchema, removeStyles, resolveMessages, signupSchema, socialLoginSchema, useAccessClient, useAzirid, useBootstrap, useBranding, useChangePassword, useCheckout, useFormState, useInvoices, useLogin, useLogout, useMagicLink, useMessages, usePasskeys, usePasswordToggle, usePaymentProviders, usePayphoneConfirm, usePlans, useReferral, useReferralStats, useRefresh, useSession, useSignup, useSocialLogin, useSubmitTransferProof, useSubscription, useSwitchTenant, useTenantMembers, useTenants, useTransferProofs };