@justgold/sdk-bridge
v1.0.0
Published
Shared bridge types and helpers for JustGold embeddable SDKs (web, React Native, Flutter)
Downloads
157
Readme
@justgold/sdk-bridge
TypeScript helpers and types for custom JustGold SDK host integrations.
Most partners should use the platform packages instead:
| Platform | Package |
| ------------ | ---------------------------------------------------------------------- |
| React Native | @justgold/rn-sdk |
| Web | @justgold/web-sdk |
| Flutter | justgold_sdk |
Install @justgold/sdk-bridge only if you are building your own host shell (non-React web wrapper, custom native container, etc.).
Documentation: SDK overview
Installation
yarn add @justgold/sdk-bridgeUsage
import { buildInitSessionMessage, parseBridgeMessage, type SdkSessionConfig } from '@justgold/sdk-bridge';
const session: SdkSessionConfig = {
token: sessionToken,
sandbox: false,
locale: 'en',
};
iframe.contentWindow?.postMessage(buildInitSessionMessage(session), '*');
window.addEventListener('message', event => {
const msg = parseBridgeMessage(event.data);
if (msg?.type === 'CLOSE') onClose();
});Main exports
| Export | Purpose |
| ------------------------------------ | --------------------------------- |
| SdkSessionConfig | Host → SDK session payload |
| SdkOutboundEvent | SDK → host event types |
| buildInitSessionMessage() | Build INIT_SESSION message |
| parseBridgeMessage() | Parse incoming postMessage data |
| resolveJustGoldApiBaseUrl(sandbox) | Sandbox vs production API URL |
Support
Contact your JustGold onboarding team for integration support and sandbox credentials.
