React Native Version 1.0+

​

Overview

1. Enhanced speed and stability in loading merchant flows.
2. More streamlined initialization of the SDK.
3. Simplified event handling, more informative event messaging, and uniform naming conventions for easier debugging.
4. Improved maintainability and foundations for new feature compatibility.

​

Breaking Changes

​

Session Initialization

• openCardOnFileSwitcher, addCardSwitcherListener, and eventNames from “react-native-knotapi” are replaced with Knot and addKnotListener.
• The product type is now defined by Product enum values .card_switcher, .transaction_link, and .link.
• The new interface allows configuration of additional properties such as useCategories, useSearch, and merchantIds .
• The open action now requires configuration values that are required to initialize with a session.

import { openCardOnFileSwitcher, addCardSwitcherListener, eventNames } from "react-native-knotapi";

openCardOnFileSwitcher({
  sessionId: SESSION_ID,
  clientId: CLIENT_ID,
  environment: "development",
})

import {
  Knot,
  addKnotListener,
 } from "react-native-knotapi";

 Knot.open({
      sessionId: 'session_12345', // Current session ID
      clientId: 'client_67890', // Your client ID
      environment: 'development', // 'development' | 'production'
      entryPoint: 'onboarding', // Defined by you
      useCategories: true, // Recommend true
      useSearch: true, // Recommend true
      merchantIds: [52], // It is not recommended that you provide a long list of merchants
      domainUrls: ["https://domain1.com", "https://domain2.com"], // Only applicable for Android. 
      customerConfig: { cardName: 'Card Name', customerName: 'Customer Name', logoId: 'LogoId' },
    });

​

Event Handling

• Event handling is now managed through addKnotListener instead of closures.
• Events like onSuccess, onError, and onExit are now product agnostic.
• The onEvent method introduces the KnotEvent object to better handle Knot emitted events.
• The KnotError type provides improved error descriptions.
• The sendCard parameter is deprecated and its functionality incorporated into the metaData dictionary within KnotEvent when KnotEvent.event equals AUTHENTICATED.

let listener = addCardSwitcherListener(eventNames.onSuccess, merchant => {
  console.log(merchant);
});

let listener = addCardSwitcherListener(eventNames.onError, (errorCode, errorMessage) => {
  console.log(`Error ${errorCode}: ${errorMessage}`);
});

let listener = addCardSwitcherListener(eventNames.onExit, () => {
  console.log("onExit");
});

let listener = addCardSwitcherListener(eventNames.onEvent, (e) => {
  console.log('Event: ', e.event);
  console.log('taskId: ', e.taskId);
  console.log('merchant:', e.merchant);
});

const onKnotSuccess = addKnotListener('onSuccess', (event) => {
  console.log('onSuccess', 'event', event);
});

const onKnotEvent = addKnotListener('onEvent', (event) => {
  console.log('onEvent', 'event', event);
});

const onKnotError = addKnotListener('onError', (event) => {
  console.log('onError', 'event', event);
});

const onKnotExit = addKnotListener('onExit', (event) => {
  console.log('onExit', 'event', event);
});

...
const onKnotEvent = addKnotListener('onEvent', (event: KnotEvent) => {
  console.log('onEvent', 'sendCard', event.metaData.sendCard);
});

​

Error Handling

• Errors are now encapsulated in the KnotError enum.
• Each error has a human-readable description (errorDescription) and a unique error code (errorCode).
• Improved clarity and consistency across error messages.

let listener = addCardSwitcherListener(eventNames.onError, (errorCode, errorMessage) => {
  console.log(`Error ${errorCode}: ${errorMessage}`);
});

const onError = (error) => {
    switch (error) {
        case "invalidSession":
            console.warn("Error: Session is invalid. Please check your session ID.");
            break;
        case "expiredSession":
            console.warn("Error: Session has expired. Please start a new session.");
            break;
        case "invalidClientId":
            console.warn("Error: Invalid client ID. Ensure your credentials are correct.");
            break;
        case "internalError":
            console.warn("Error: An internal error occurred. Try again later.");
            break;
        default:
            console.warn("Error: An unknown error occurred.");
    }
};

​

Closing the SDK

• Closing the SDK is now statically accessed via Knot.close() as opposed to being bound to the session object.

import { closeKnotSDK } from "react-native-knotapi";

closeKnotSDK();

Knot.close()