@airxpay/sdk-ui 1.0.1 → 1.0.2

package/README.md

@@ -211,7 +211,7 @@ export default MySellerOnboarding;
 import { 
   useAirXPay,           // Access config (throws if no provider)
   useAirXPaySafe,       // Safe access (returns null if no provider)
-  useIsAirXPayReady,    // Hook: checks if provider is ready
+  useProviderReady,    // Hook: checks if provider is ready
   useAirXPayConfig,     // Access specific config value
   AirXPayConsumer       // Context consumer for advanced use
 } from '@airxpay/sdk-ui';
@@ -219,7 +219,7 @@ import {
 // Example usage
 const { baseUrl, publicKey } = useAirXPay();
 const config = useAirXPaySafe();
-const isReady = useIsAirXPayReady();
+const isReady = useProviderReady();
 const baseUrl = useAirXPayConfig('baseUrl');
 ```
 
@@ -333,7 +333,7 @@ Step 4: Completion
 ```tsx
 // Main exports from index.ts
 export { useIsAirXPayReady } from "./sdk/airxpay";           // Class for async init
-export { AirXPayProvider } from "./contexts/AirXPayProvider";
+export { AirXPayProvider, useProviderReady, useAirXPayConfig, useAirXPaySafe, useAirXPay } from "./contexts/AirXPayProvider";
 export { default as useAirXPaySheet } from "./hooks/SellerOnboarding";
 export { __DEV__ } from './types/dev';
 
@@ -391,6 +391,126 @@ The `__DEV__` flag helps you conditionally run code only in development environm
 | Images not uploading | Check Expo ImagePicker permissions |
 | TypeScript errors | Update to latest version |
 
+---
+
+# 🎣 Available Hooks
+
+The **@airxpay/sdk-ui** package provides several utility hooks for accessing configuration, managing initialization state, **and safely interacting with the AirXPayProvider.**
+
+```
+import { 
+  useAirXPay, 
+  useAirXPaySafe, 
+  useProviderReady, 
+  useAirXPayConfig 
+} from '@airxpay/sdk-ui';
+
+1️⃣ useAirXPay()
+const { baseUrl, publicKey } = useAirXPay();
+```
+
+**Provides direct access to the full AirXPay configuration.**
+
+**Behavior**
+
+Must be used inside AirXPayProvider.
+
+Throws an error if the provider is not found.
+
+Ensures strict enforcement of provider usage.
+
+When to Use
+
+Use this hook when you require guaranteed access to configuration values such as baseUrl or publicKey for:
+
+API requests
+
+Dynamic endpoint handling
+
+**Advanced integrations**
+
+# Recommended for: Production components where the provider is always present.
+
+```
+2️⃣ useAirXPaySafe()
+const safeConfig = useAirXPaySafe();
+```
+
+A safe alternative to ```useAirXPay().```
+
+Behavior
+
+Returns null if the provider is not available.
+
+Does not throw an error.
+
+When to Use
+
+Component testing in isolation
+
+Optional integrations
+
+Shared UI components that may or may not be wrapped in the provider
+
+Recommended for: Flexible usage scenarios where provider presence is not guaranteed.
+
+```
+3️⃣ useProviderReady()
+const isReady = useProviderReady();
+```
+
+Checks whether the SDK has been fully initialized.
+
+Behavior
+
+Returns a boolean indicating initialization state.
+
+Useful for asynchronous setup workflows.
+
+When to Use
+
+Conditional rendering
+
+Showing loaders before initialization
+
+Delaying onboarding UI until SDK is ready
+
+Recommended for: Applications using async initialization or class-based setup.
+
+```
+4️⃣ useAirXPayConfig(key)
+const apiUrl = useAirXPayConfig('baseUrl');
+```
+
+Retrieves a specific configuration value from the provider.
+
+Behavior
+
+Accepts a configuration key ```(e.g., 'baseUrl', 'publicKey').```
+
+Returns only the requested value.
+
+When to Use
+
+Accessing a single configuration property
+
+Avoiding full object destructuring
+
+Cleaner and more focused component logic
+
+Recommended for: Minimal, targeted configuration access.
+
+```📌 Hook Comparison```
+**Hook	Throws Error	Safe Fallback	Primary Purpose**
+
+```
+useAirXPay	✅ Yes	❌ No	Direct access to full configuration
+useAirXPaySafe	❌ No	✅ Yes	Optional/safe configuration access
+useProviderReady	❌ No	✅ Yes	Initialization state check
+useAirXPayConfig	❌ No	✅ Yes	Access a single configuration value
+```
+
+
 ---
 
 ## 📝 Changelog

package/dist/contexts/AirXPayProvider.d.ts

@@ -9,6 +9,6 @@ export declare const AirXPayProvider: React.FC<AirXPayProviderProps>;
 export declare const useAirXPay: () => AirXPayConfig;
 export declare const useAirXPaySafe: () => AirXPayConfig | null;
 export declare const useAirXPayConfig: <K extends keyof AirXPayConfig>(key: K) => AirXPayConfig[K] | undefined;
-export declare const useIsAirXPayReady: () => boolean;
+export declare const useProviderReady: () => boolean;
 export declare const AirXPayConsumer: React.Consumer<AirXPayConfig | null>;
 export default AirXPayProvider;

package/dist/contexts/AirXPayProvider.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AirXPayConsumer = exports.useIsAirXPayReady = exports.useAirXPayConfig = exports.useAirXPaySafe = exports.useAirXPay = exports.AirXPayProvider = void 0;
+exports.AirXPayConsumer = exports.useProviderReady = exports.useAirXPayConfig = exports.useAirXPaySafe = exports.useAirXPay = exports.AirXPayProvider = void 0;
 const react_1 = __importStar(require("react"));
 // Context with professional error handling
 const AirXPayContext = (0, react_1.createContext)(null);
@@ -145,11 +145,11 @@ const useAirXPayConfig = (key) => {
 };
 exports.useAirXPayConfig = useAirXPayConfig;
 // Helper: Check if provider is properly configured
-const useIsAirXPayReady = () => {
+const useProviderReady = () => {
     const config = (0, exports.useAirXPaySafe)();
     return !!((config === null || config === void 0 ? void 0 : config.baseUrl) && (config === null || config === void 0 ? void 0 : config.publicKey));
 };
-exports.useIsAirXPayReady = useIsAirXPayReady;
+exports.useProviderReady = useProviderReady;
 // Export context consumer for advanced use cases
 exports.AirXPayConsumer = AirXPayContext.Consumer;
 exports.default = exports.AirXPayProvider;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { useIsAirXPayReady } from "./sdk/airxpay";
-export { AirXPayProvider } from "./contexts/AirXPayProvider";
+export { AirXPayProvider, useProviderReady, useAirXPayConfig, useAirXPaySafe, useAirXPay } from "./contexts/AirXPayProvider";
 export { default as useAirXPaySheet } from "./hooks/SellerOnboarding";
 export { __DEV__ } from './types/dev';

package/dist/index.js

@@ -3,11 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.__DEV__ = exports.useAirXPaySheet = exports.AirXPayProvider = exports.useIsAirXPayReady = void 0;
+exports.__DEV__ = exports.useAirXPaySheet = exports.useAirXPay = exports.useAirXPaySafe = exports.useAirXPayConfig = exports.useProviderReady = exports.AirXPayProvider = exports.useIsAirXPayReady = void 0;
 var airxpay_1 = require("./sdk/airxpay");
 Object.defineProperty(exports, "useIsAirXPayReady", { enumerable: true, get: function () { return airxpay_1.useIsAirXPayReady; } });
 var AirXPayProvider_1 = require("./contexts/AirXPayProvider");
 Object.defineProperty(exports, "AirXPayProvider", { enumerable: true, get: function () { return AirXPayProvider_1.AirXPayProvider; } });
+Object.defineProperty(exports, "useProviderReady", { enumerable: true, get: function () { return AirXPayProvider_1.useProviderReady; } });
+Object.defineProperty(exports, "useAirXPayConfig", { enumerable: true, get: function () { return AirXPayProvider_1.useAirXPayConfig; } });
+Object.defineProperty(exports, "useAirXPaySafe", { enumerable: true, get: function () { return AirXPayProvider_1.useAirXPaySafe; } });
+Object.defineProperty(exports, "useAirXPay", { enumerable: true, get: function () { return AirXPayProvider_1.useAirXPay; } });
 var SellerOnboarding_1 = require("./hooks/SellerOnboarding");
 Object.defineProperty(exports, "useAirXPaySheet", { enumerable: true, get: function () { return __importDefault(SellerOnboarding_1).default; } });
 var dev_1 = require("./types/dev");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@airxpay/sdk-ui",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "AirXPay Initialization UI Components for React & React Native",
   "author": "Tafseel Khan",
   "license": "MIT",