@networkinternational/ni-card-management-sdk 1.0.2

package/src/hooks/useChangePin.ts

@@ -0,0 +1,39 @@
+import { useState } from 'react';
+
+import NICardManagementSDKModule from '../nativeComponents/NICardManagementSDKModule';
+import type { NiInputInterface } from '../interfaces/NiInputInterfaces';
+import formatInput from '../utils/formatInput';
+import type { NIErrorResponse } from '../interfaces/NiCardManagementInterfaces';
+
+export const useChangePin = () => {
+  const [result, setResult] = useState<string | null>();
+  const [error, setError] = useState<NIErrorResponse | null>();
+  const [isLoading, setIsLoading] = useState<boolean>(false);
+
+  const onChangePin = (
+    oldPin: string,
+    newPin: string,
+    input: NiInputInterface,
+    callback: (error: NIErrorResponse | null, result: string | null) => void
+  ): void => {
+    setIsLoading(true);
+    NICardManagementSDKModule.changePin(
+      oldPin,
+      newPin,
+      formatInput(input),
+      (err: NIErrorResponse | null, res: string | null | undefined) => {
+        setIsLoading(false);
+        if (err) {
+          setError(err);
+          callback && callback(err, null);
+        } else if (res) {
+          setResult(res);
+          setError(null);
+          callback && callback(null, res);
+        }
+      }
+    );
+  };
+
+  return { result, error, isLoading, onChangePin };
+};

package/src/hooks/useGetCardDetails.ts

@@ -0,0 +1,38 @@
+import { useState } from 'react';
+
+import NICardManagementSDKModule from '../nativeComponents/NICardManagementSDKModule';
+import type { NiInputInterface } from '../interfaces/NiInputInterfaces';
+import formatInput from '../utils/formatInput';
+import type {
+  NIErrorResponse,
+  NIGetCardSuccessResponse,
+} from '../interfaces/NiCardManagementInterfaces';
+
+export const useGetCardDetails = () => {
+  const [result, setResult] = useState<NIGetCardSuccessResponse>();
+  const [error, setError] = useState<NIErrorResponse | null>();
+  const [isLoading, setIsLoading] = useState<boolean>(false);
+
+  const onGetCardDetails = (
+    input: NiInputInterface,
+    callback: (error: NIErrorResponse | null, result: string | null) => void
+  ): void => {
+    setIsLoading(true);
+    NICardManagementSDKModule.getCardDetails(
+      formatInput(input),
+      (err: NIErrorResponse | null, res: NIGetCardSuccessResponse | null) => {
+        setIsLoading(false);
+        if (err) {
+          setError(err);
+          callback && callback(err, null);
+        } else if (res) {
+          setResult(res);
+          setError(null);
+          callback && callback(null, 'Card details retrieved with success!');
+        }
+      }
+    );
+  };
+
+  return { result, error, isLoading, onGetCardDetails };
+};

package/src/hooks/useSetPin.ts

@@ -0,0 +1,37 @@
+import { useState } from 'react';
+
+import NICardManagementSDKModule from '../nativeComponents/NICardManagementSDKModule';
+import type { NiInputInterface } from '../interfaces/NiInputInterfaces';
+import formatInput from '../utils/formatInput';
+import type { NIErrorResponse } from '../interfaces/NiCardManagementInterfaces';
+
+export const useSetPin = () => {
+  const [result, setResult] = useState<string | null>();
+  const [error, setError] = useState<NIErrorResponse | null>();
+  const [isLoading, setIsLoading] = useState<boolean>(false);
+
+  const onSetPin = (
+    pin: string,
+    input: NiInputInterface,
+    callback: (error: NIErrorResponse | null, result: string | null) => void
+  ): void => {
+    setIsLoading(true);
+    NICardManagementSDKModule.setPin(
+      pin,
+      formatInput(input),
+      (err: NIErrorResponse | null, res: string | null | undefined) => {
+        setIsLoading(false);
+        if (err) {
+          setError(err);
+          callback && callback(err, null);
+        } else if (res) {
+          setError(null);
+          setResult(res);
+          callback && callback(null, res);
+        }
+      }
+    );
+  };
+
+  return { result, error, isLoading, onSetPin };
+};

package/src/hooks/useVerifyPin.ts

@@ -0,0 +1,37 @@
+import { useState } from 'react';
+
+import NICardManagementSDKModule from '../nativeComponents/NICardManagementSDKModule';
+import type { NiInputInterface } from '../interfaces/NiInputInterfaces';
+import formatInput from '../utils/formatInput';
+import type { NIErrorResponse } from '../interfaces/NiCardManagementInterfaces';
+
+export const useVerifyPin = () => {
+  const [result, setResult] = useState<string | null>();
+  const [error, setError] = useState<NIErrorResponse | null>();
+  const [isLoading, setIsLoading] = useState<boolean>(false);
+
+  const onVerifyPin = (
+    pin: string,
+    input: NiInputInterface,
+    callback: (error: NIErrorResponse | null, result: string | null) => void
+  ): void => {
+    setIsLoading(true);
+    NICardManagementSDKModule.verifyPin(
+      pin,
+      formatInput(input),
+      (err: NIErrorResponse | null, res: string) => {
+        setIsLoading(false);
+        if (err) {
+          setError(err);
+          callback && callback(err, null);
+        } else if (res) {
+          setResult(res);
+          setError(null);
+          callback && callback(null, res);
+        }
+      }
+    );
+  };
+
+  return { result, error, isLoading, onVerifyPin };
+};

package/src/hooks/useViewPin.ts

@@ -0,0 +1,35 @@
+import { useState } from 'react';
+
+import NICardManagementSDKModule from '../nativeComponents/NICardManagementSDKModule';
+import type { NiInputInterface } from '../interfaces/NiInputInterfaces';
+import formatInput from '../utils/formatInput';
+import type { NIErrorResponse } from '../interfaces/NiCardManagementInterfaces';
+
+export const useViewPin = () => {
+  const [result, setResult] = useState<string | null>();
+  const [error, setError] = useState<NIErrorResponse | null>();
+  const [isLoading, setIsLoading] = useState<boolean>(false);
+
+  const onViewPin = (
+    input: NiInputInterface,
+    callback?: (error: NIErrorResponse | null, result: string | null) => void
+  ) => {
+    setIsLoading(true);
+    NICardManagementSDKModule.getPin(
+      formatInput(input),
+      (err: NIErrorResponse | null, res: string | null) => {
+        setIsLoading(false);
+        if (err) {
+          setError(err);
+          callback && callback(err, null);
+        } else if (res) {
+          setResult(res);
+          setError(null);
+          callback && callback(null, res);
+        }
+      }
+    );
+  };
+
+  return { result, error, isLoading, onViewPin };
+};

package/src/index.tsx

@@ -0,0 +1,6 @@
+export * from './NICardManagementComponents/CardDetailsComponent';
+export * from './NICardManagementComponents/SetPinView';
+export * from './NICardManagementComponents/VerifyPinView';
+export * from './NICardManagementComponents/ChangePinView';
+export * from './NICardManagementComponents/ViewPinComponent';
+export * from './NICardManagementComponents/NiInputInterfaces';

package/src/interfaces/NiCardManagementInterfaces.ts

@@ -0,0 +1,61 @@
+export interface NIConnectionProperties {
+  rootUrl: string;
+  token: string;
+}
+
+export interface NIInputInterface {
+  bankCode: string;
+  cardIdentifierId: string;
+  cardIdentifierType: string;
+  connectionProperties: NIConnectionProperties;
+}
+
+export interface NIErrorResponse {
+  domain: string;
+  code: string;
+  message: string;
+}
+
+export interface NIGetCardSuccessResponse {
+  clearPan: string;
+  maskedPan: string;
+  expiry: string;
+  clearCVV2: string;
+  cardholderName: string;
+}
+
+interface NICardDetailsCallback {
+  (error: NIErrorResponse | null, res: NIGetCardSuccessResponse | null): void;
+}
+
+interface NIGenericCallback {
+  (error: NIErrorResponse | null, res: string): void;
+}
+
+export interface NICardManagementInterface {
+  getCardDetails(
+    input: NIInputInterface | string,
+    callback: NICardDetailsCallback
+  ): void;
+
+  setPin(
+    pin: string,
+    input: NIInputInterface | string,
+    callback: NIGenericCallback
+  ): void;
+
+  verifyPin(
+    pin: string,
+    input: NIInputInterface | string,
+    callback: NIGenericCallback
+  ): void;
+
+  changePin(
+    oldPin: string,
+    newPin: string,
+    input: NIInputInterface | string,
+    callback: NIGenericCallback
+  ): void;
+
+  getPin(input: NIInputInterface | string, callback: NIGenericCallback): void;
+}

package/src/interfaces/NiInputInterfaces.ts

@@ -0,0 +1,78 @@
+import type { ImageURISource } from 'react-native';
+
+import type { NIInputInterface } from './NiCardManagementInterfaces';
+
+export interface NICardDetailsTextPositioning {
+  leftAlignment?: number;
+  cardNumberGroupTopAlignment?: number;
+  dateCvvGroupTopAlignment?: number;
+  cardHolderNameGroupTopAlignment?: number;
+}
+
+export interface UIFont {
+  name: string;
+  size: number;
+}
+export interface NIFontLabelPair {
+  font: UIFont;
+  label: NILabels;
+}
+
+export enum NILabels {
+  /// Card Details
+  cardNumberLabel = 0,
+  cardNumberValueLabel = 1,
+  expiryDateLabel = 2,
+  expiryDateValueLabel = 3,
+  cvvLabel = 4,
+  cvvValueLabel = 5,
+  cardholderNameLabel = 6,
+
+  /// Set PIN
+  setPinDescriptionLabel = 7,
+
+  /// Change PIN
+  changePinDescriptionLabel = 8,
+
+  /// View PIN
+  viewPinDescriptionLabel = 9,
+  viewPinCountDownDescription = 110,
+  pinDigitLabel = 11,
+}
+
+export interface NICardAttributes {
+  shouldHide: boolean;
+  backgroundImage?: ImageURISource;
+  textPositioning?: NICardDetailsTextPositioning;
+}
+
+export enum NIThemeEnum {
+  light = 'light',
+  dark = 'dark',
+}
+
+export enum NILanguageEnum {
+  english = 'english',
+  arabic = 'arabic',
+}
+
+export enum NIPinTypeEnum {
+  fourDigits = 4,
+  fiveDigits = 5,
+  sixDigits = 6,
+  dynamicFourToSix = 0,
+}
+
+export type themeType = 'dark' | 'light';
+export type languageType = 'english' | 'arabic';
+export interface NIDisplayAttributes {
+  theme?: themeType;
+  language?: languageType;
+  fonts?: Array<NIFontLabelPair>;
+  cardAttributes?: NICardAttributes;
+}
+
+export interface NiInputInterface extends NIInputInterface {
+  timer?: number;
+  displayAttributes?: NIDisplayAttributes;
+}

package/src/interfaces/NiInterfaces.ts

@@ -0,0 +1,259 @@
+import type {
+  NiInputInterface,
+  NIPinTypeEnum,
+  NIDisplayAttributes,
+  NILabels,
+} from './NiInputInterfaces';
+import type {
+  NIErrorResponse,
+  NIGetCardSuccessResponse,
+} from './NiCardManagementInterfaces';
+
+export enum NIStepEnum {
+  currentPinStep = 0,
+  setupPinStep = 1,
+  reEnterPinStep = 2,
+  verifyStep = 3,
+}
+
+export interface NICardDetailsComponent {
+  input: NiInputInterface | null;
+  callback: (error: NIErrorResponse | null, result: string | null) => void;
+}
+
+export interface NISetPinView {
+  input: NiInputInterface | null;
+  type?: NIPinTypeEnum;
+  callback: (error: NIErrorResponse | null, result: string | null) => void;
+}
+export interface NIVerifyPinView {
+  input: NiInputInterface | null;
+  type?: NIPinTypeEnum;
+  callback: (error: NIErrorResponse | null, result: string | null) => void;
+}
+export interface NIViewPinComponent {
+  input: NiInputInterface | null;
+  type?: NIPinTypeEnum;
+  callback: (error: NIErrorResponse | null, result: string | null) => void;
+}
+export interface NIChangePinView {
+  input: NiInputInterface | null;
+  type: NIPinTypeEnum;
+  callback: (error: NIErrorResponse | null, result: string | null) => void;
+}
+export interface NICardDetails {
+  displayAttributes: NIDisplayAttributes | undefined;
+  getCardDetailsResult: NIGetCardSuccessResponse | undefined;
+  isError: boolean;
+}
+export interface NICardDetailsImage {
+  displayAttributes: NIDisplayAttributes | undefined;
+  getCardDetailsResult: NIGetCardSuccessResponse | undefined;
+  isError: boolean;
+}
+export interface NICardDetailsGroups {
+  displayAttributes: NIDisplayAttributes | undefined;
+  getCardDetailsResult: NIGetCardSuccessResponse | undefined;
+  isError: boolean;
+}
+export interface NICardDetailsCardNumberGroup {
+  clearPan: string;
+  maskedPan: string;
+  pinContentIndex: NILabels;
+  cardDetailsVisible: boolean;
+  setIsVisibleCopiedButton: (isVisibleCopiedButton: boolean) => void;
+  setTimeOut: () => void;
+  displayAttributes: NIDisplayAttributes | undefined;
+}
+export interface NICardDetailsDateCVVGroupOneRow {
+  expiry: string;
+  clearCVV2: string;
+  pinLabelIndex: NILabels;
+  pinContentIndex: NILabels;
+  pinLabel1Index: NILabels;
+  pinContent1Index: NILabels;
+  cardDetailsVisible: {
+    cardDetailsVisible: boolean;
+    setCardDetailsVisible: (visibleCardDetail: boolean) => void;
+  };
+  shouldHide: boolean;
+  displayAttributes: NIDisplayAttributes | undefined;
+  isError: boolean;
+}
+export interface NICardDetailsCardHolderNameGroups {
+  cardholderName: string;
+  pinContentIndex: NILabels;
+  cardDetailsVisible: boolean;
+  setIsVisibleCopiedButton: (isVisibleCopiedButton: boolean) => void;
+  displayAttributes?: NIDisplayAttributes | undefined;
+  setTimeOut: () => void;
+}
+export interface NIVerifyPin {
+  pinType: NIPinTypeEnum;
+  input: NiInputInterface | null;
+  result: string | null | undefined;
+  isLoading: boolean;
+  onVerifyPin: NIOnVerifyPin;
+  callback: (error: NIErrorResponse | null, result: string | null) => void;
+}
+export interface NISetupPin {
+  pinType: NIPinTypeEnum;
+  input: NiInputInterface | null;
+  result: string | null | undefined;
+  isLoading: boolean;
+  onSetPin: NIOnSetPin;
+  callback: (error: NIErrorResponse | null, result: string | null) => void;
+}
+export interface NIChangePin {
+  pinType: NIPinTypeEnum;
+  input: NiInputInterface | null;
+  result: string | null | undefined;
+  isLoading: boolean;
+  onChangePin: NIOnChangePin;
+  callback: (error: NIErrorResponse | null, result: string | null) => void;
+}
+export interface NIConfirmPin {
+  language: string;
+  theme: string;
+  disabled: boolean;
+  onConfirmPin: () => void;
+}
+
+interface NIOnVerifyPin {
+  (
+    pin: string,
+    input: NiInputInterface,
+    callback: (error: NIErrorResponse | null, result: string | null) => void
+  ): void;
+}
+interface NIOnSetPin {
+  (
+    pin: string,
+    input: NiInputInterface,
+    callback: (error: NIErrorResponse | null, result: string | null) => void
+  ): void;
+}
+interface NIOnChangePin {
+  (
+    currentPin: string,
+    pin: string,
+    input: NiInputInterface,
+    callback: (error: NIErrorResponse | null, result: string | null) => void
+  ): void;
+}
+
+export interface NICapturePin {
+  setPin: {
+    pin: string;
+    setPin: (pin: string) => void;
+    initialPin?: string;
+    pinEditable: boolean;
+  };
+  setNextStep: {
+    step: NIStepEnum;
+    setNextStep?: (step: NIStepEnum) => void;
+    onConfirmPin?: () => void;
+  };
+  pinType: NIPinTypeEnum;
+  title: string;
+  pinLabel: string;
+  wrongPinLabel?: string;
+  pinLabelIndex: NILabels;
+  showHideLabels: {
+    show: string;
+    hide: string;
+  };
+  theme: string;
+  input: NiInputInterface | null;
+  showPin?: boolean | null;
+}
+
+export interface NINextButton {
+  setNextStep: {
+    step: NIStepEnum;
+    setNextStep?: (step: NIStepEnum) => void;
+  };
+  disabled: boolean;
+  theme: string;
+}
+
+export interface NIShowHideButton {
+  setShowHide: {
+    isShowHide: boolean;
+    setIsShowHide: (isShowHide: boolean) => void;
+  };
+  showHideLabels: {
+    show: string;
+    hide: string;
+  };
+  theme: string;
+}
+
+export interface NICaptureVerifyPin {
+  setPin: {
+    pin: string;
+    setPin: (pin: string) => void;
+    pinEditable: boolean;
+  };
+  setNextStep: {
+    step: NIStepEnum;
+    setNextStep: (step: NIStepEnum) => void;
+    onConfirmPin: () => void;
+  };
+  pinType: NIPinTypeEnum;
+  language: string;
+  theme: string;
+  input: NiInputInterface | null;
+}
+export interface NIViewPin {
+  pinType: NIPinTypeEnum;
+  input: NiInputInterface | null;
+  result: string;
+  countdownTime: number;
+}
+export interface NISetUpNewCardPin {
+  setPin: {
+    pin: string;
+    setPin: (pin: string) => void;
+    pinEditable: boolean;
+  };
+  setNextStep: {
+    step: NIStepEnum;
+    setNextStep: (step: NIStepEnum) => void;
+  };
+  pinType: NIPinTypeEnum;
+  language: string;
+  theme: string;
+  input: NiInputInterface | null;
+}
+export interface NICurrentCardPin {
+  setPin: {
+    currentPin: string;
+    setCurrentPin: (currentPin: string) => void;
+    pinEditable: boolean;
+  };
+  setNextStep: {
+    step: NIStepEnum;
+    setNextStep: (step: NIStepEnum) => void;
+  };
+  pinType: NIPinTypeEnum;
+  language: string;
+  theme: string;
+  input: NiInputInterface | null;
+}
+export interface NIReenterCardPin {
+  setPin: {
+    confirmationPin: string;
+    setConfirmationPin: (confirmationPin: string) => void;
+    pin: string;
+    pinEditable: boolean;
+  };
+  setNextStep: {
+    step: NIStepEnum;
+    onConfirmPin: () => void;
+  };
+  pinType: NIPinTypeEnum;
+  language: string;
+  theme: string;
+  input: NiInputInterface | null;
+}

package/src/nativeComponents/NICardManagementSDKModule.ts

@@ -0,0 +1,5 @@
+import { NativeModules } from 'react-native';
+
+import type { NICardManagementInterface } from '../interfaces/NiCardManagementInterfaces';
+
+export default NativeModules.NiCardManagement as NICardManagementInterface;

package/src/utils/formatInput.ts

@@ -0,0 +1,8 @@
+import { Platform } from 'react-native';
+
+import type { NiInputInterface } from '../interfaces/NiInputInterfaces';
+
+const formatInput = (input: NiInputInterface) =>
+  Platform.OS === 'ios' ? input : JSON.stringify(input);
+
+export default formatInput;

package/src/utils/localization.ts

@@ -0,0 +1,10 @@
+import { NILanguageEnum } from '../interfaces/NiInputInterfaces';
+import { localization } from '../config/localization';
+
+function localLabels(language: string) {
+  return language === NILanguageEnum.arabic
+    ? localization.arabic
+    : localization.english;
+}
+
+export default localLabels;