Premium iOS SDK

• Version: 1.0.0

• Minimum supported iOS version: 15 (this is what we test)

• Minimum compiling iOS version: 14 (this is where it compiles but not actually working and we block it by warning message on SDK initial screen)

• UI framework: SwiftUI

• Appearance: Light/Dark

• Supported orientations: Portrait

• Supported languages: English/Ukrainian/Russian/Kazakh

How to setup the SDK

To get the dependency, you first need to configure access to our repository.

1. Install AWS CLI using this guide.

2. Configure AWS CLI using the credentials provided by us. To do this, run the following command in your terminal.

> aws configure

# After executing the command, you will be prompted to enter the following information
AWS Access Key ID [None]: <YOUR_ACCESS_KEY>
AWS Secret Access Key [None]: <YOUR_SECRET_KEY>
Default region name [None]: eu-central-1
Default output format [None]: json

1. Initialise your app

swift package init --type executable

1. Configure your swift client using this AWS CLI CodeArtifact command

aws codeartifact login --tool swift --repository premium-sdk --domain infocus --domain-owner 346627266603 --region eu-central-1

1. Modify the Package.swift file within your application project directory to adjust the package dependencies utilized by your project. If the Package.swift file does not have a dependencies section, include one. Within the targets section, add the targets requiring the dependency. It should look similar to code snippet below:

import PackageDescription

let package = Package(
    name: "premium-sdk-test",
    dependencies: [
        .package(id: "ios-premium.premium-ios-sdk", from: "1.0.0")
    ],
    targets: [
        // Targets are the basic building blocks of a package, defining a module or a test suite.
        // Targets can depend on other targets in this package and products from dependencies.
        .executableTarget(
            name: "premium-sdk-test",
            dependencies: ["premium_sdk"]
        ),
    ]
)

Use the resolve command to download the package dependencies from CodeArtifact.

swift package resolve

Alternatively, you can add packages by navigating to App > package dependencies on Xcode. “Click” on the + icon, Enter ios.premium-ios-sdk. Once the package is found, choose the package and “Click” on Add Package. After a second or two, the package name appears on the list. On the top right side, you can verify the source repository (next to the Registry label).

1. Import the framework

import premium_sdk

1. Add strings to Info.plist to avoid crashes

1. There are 2 convenience initialisers for SDK: by client token and by customer ID (like shown in code sample below). To init the SDK by client token you will need to set a client token and in which way the token was retrieved (by list of phone hashes or by customer id). To obtain this token, your backend must have the appropriate API. You need to implement the logic for retrieving this token from your backend and passing it to the SDK. Init ConciergeSDK with your client token

let sdk = PremiumSDK(
    clientToken: "<<YOUR CLIENT TOKEN>>"
)

• If you don't have client ID at the moment then the only option left is to ask SDK to authenticate him/her via SMS/OTP. In order to do this you need to use another initialiser (like shown in code snippet below). You need to provide your username/password + your internal customer ID. If SDK does not have any information about customer with your internal ID it will navigate user to authentication flow. Otherwise SDK will let user pass through.

let sdk = PremiumSDK(
    withAccessToken: "<<ACCESS TOKEN>>", // Retrieved via curl 'https://api.infocus.company/sdk/auth/getToken' --data '{"grant_type": "password", "username": "<USER_NAME>","password": "<PASSWORD>"}'
    customerId: "<<YOUR INTERNAL CUSTOMER ID>>",
    cardProductId: "<<CARD PRODUCT ID>>" // 1  - Visa Gold, 2  - Visa Platinum, 3  - Visa Signature...
)

1. [Optionally] Set language:

sdk.setLanguage(.en)

1. [Optionally] Set colors:

sdk.setColors(
    SharedColors(
        mainColor: Color(hex: "#C28BFC"),
        mainColorTinted: Color(hex: "#E3DEFC"),
        defaultShadowColor: Color.dynamicColor(
            light: Color(red: 0.525, green: 0.442, blue: 0.613, opacity: 0.13),
            dark: Color(red: 0.035, green: 0.031, blue: 0.157, opacity: 0.5)
        ),
        mainBlack: Color.dynamicColor(
            light: Color(hex: "#090828"),
            dark: Color(hex: "#E3DEFC")
        ),
        mainGray: Color.gray,
        mainWhite: Color(hex: "#FFFFFF"),
        background: Color.dynamicColor(
            light: Color(hex: "#F6F6FA"),
            dark: Color(hex: "#090828")
        ),
        intermediateBackgroundColor: Color.dynamicColor(
            light: Color(hex: "#FFFFFF"),
            dark: Color(hex: "#1E1240")
        ),
        searchIconColor: Color.gray,
        searchPlaceholderColor: Color.gray,
        hyperlinkColor: Color.blue
    )
)

1. [Optionally] Set images Now there is an ability to set different sets of images for different sub-systems of the SDK. At the moment of writing this documentation there are 2 main subsystems: Concierge and Benefits. Concierge subsystem allows specifying images while Benefits does not allow any customisation at the moment. So in order to specify images you need to invoke code similar to what is shown below:

sdk.setConciergeImages(
    ConciergeImages(
        conciergeAvatarImage: Image(systemName: "person"),
        infoLogoImage: Image(systemName: "apple.logo")
    )
)

1. [Optionally] Set fonts: This customisation is common for Concierge and Benefits sub-systems and will be applied in both of them

sdk.setFonts(
    SharedFonts(customFontName: "Rubik-Medium")
)

1. [Optionally] Set custom texts if needed: This customisation is only for Concierge sub-system

sdk.setConciergeTexts( 
    ConciergeTexts(
        chatInfoAdditionalText: "For questions about Premium cards and transactions, please contact the XXXX toll-free line."
    )
)

1. [Optionally] Set other UI settings if needed: This customisation is only for Concierge sub-system

sdk.setConciergeUISettings(
    ConciergeUISettings(
        chatStyle: .messenger,
        chatFilePickerEnabled: true,
        shouldShowVisaLogoInInfo: false
    )
)

1. Set delegate and implement delegate methods

sdk.setDelegate(self)

1. Call start() function

sdk.start()

1. Instantiate SwiftUI view: Depending on which sub-system of SDK you want to use (Concierge/Benefits) you should invoke corresponding function

sdk.createBenefitsView() // or 'sdk.createConciergeView()'

Due to the tab bar and navigation bars, It should be presented as a full screen cover or as separate window Full example:

import SwiftUI
import premium_sdk

struct InputView: View {

    var body: some View {
        NavigationView {
            VStack(spacing: 24) {
                Spacer()

                Text("Authentication")
                    .font(.title2)
                    .fontWeight(.semibold)

                TextField("User token", text: $viewModel.authToken)
                    .textFieldStyle(RoundedBorderTextFieldStyle())
                    .autocapitalization(.none)
                    .disableAutocorrection(true)

                Text("Customer ID + product ID to use auth by customer ID flow")
                    .font(.system(size: 12))
                    .foregroundColor(Color.black.opacity(0.3))

                TextField("Customer ID (may be random numbers)", text: $viewModel.customerId)
                    .textFieldStyle(RoundedBorderTextFieldStyle())
                    .autocapitalization(.none)
                    .disableAutocorrection(true)

                TextField("Card product ID", text: $viewModel.cardProductId)
                    .textFieldStyle(RoundedBorderTextFieldStyle())
                    .autocapitalization(.none)
                    .disableAutocorrection(true)

                Text("1 - Visa Gold, 2 - Visa Platinum, 3 - Visa Signature, 4 - Visa Infinite, 5 - Visa Platinum Business, 6 - Visa Business, 7 - Visa Signature Business, 8 - Visa Infinite Business, 15 - Non-Visa card")
                    .font(.system(size: 10))
                    .foregroundColor(Color.black.opacity(0.3))

                Spacer().frame(height: 1)
                    .background(Color.gray.opacity(0.2))

                if case .authFailed(let message) = viewModel.state {
                    Text(message)
                        .foregroundColor(.red)
                        .padding(.horizontal)
                }

                if viewModel.state == .authenticating {
                    ProgressView("Authenticating…")
                }

                HStack(spacing: 16) {
                    Button("Benefits") {
                        viewModel.handleBenefitsButtonPressed()
                    }
                    .padding()
                    .background(Color.gray.opacity(0.2))
                    .cornerRadius(8)

                    Button("Concierge") {
                        viewModel.handleConciergeButtonPressed()
                    }
                    .padding()
                    .background(Color.gray.opacity(0.2))
                    .cornerRadius(8)
                }

                Spacer()

                // MARK: - Hidden navigation links

                NavigationLink(
                    tag: .benefits,
                    selection: $targetRoute,
                    destination: {
                        if let sdk = viewModel.sdk {
                            AnyView(sdk.createBenefitsView())
                        } else {
                            AnyView(EmptyView())
                        }
                    },
                    label: {
                        EmptyView()
                    }
                )

                NavigationLink(
                    tag: .concierge,
                    selection: $targetRoute,
                    destination: {
                        if let sdk = viewModel.sdk {
                            AnyView(sdk.createConciergeView())
                        } else {
                            AnyView(EmptyView())
                        }
                    },
                    label: {
                        EmptyView()
                    }
                )

                Spacer()
            }
            .padding()
        }
        .onAppear {
            // VM tells us WHEN and WHERE to navigate
            viewModel.onAuthenticated = { target in
                print("onAuthenticated:", target)  // you already see this firing

                switch target {
                    case .benefits:
                        targetRoute = .benefits

                    case .concierge:
                        targetRoute = .concierge

                    case .none:
                        break
                }
            }
        }
    }

    // MARK: - Internal fields

    @StateObject private var viewModel = InputViewModel()

    private enum Route: Hashable {
        case benefits
        case concierge
    }

    @State private var targetRoute: Route?
}


@MainActor
class InputViewModel: ObservableObject {

    enum State: Equatable {
        case idle
        case authenticating
        case authFailed(String)
    }

    enum TargetScreen {
        case none
        case concierge
        case benefits
    }

    // Observed by the view
    @Published var state: State = .idle
    @Published var authToken: String = ""
    @Published var customerId: String = ""
    @Published var cardProductId: String = ""

    // SDK instance used to build views
    private(set) var sdk: PremiumSDK?
    private(set) var targetScreen: TargetScreen = .none

    /// The view sets this closure; VM calls it when auth is OK
    var onAuthenticated: ((TargetScreen) -> Void)?

    // MARK: - Public actions

    func handleBenefitsButtonPressed() {
        targetScreen = .benefits
        authenticate()
    }

    func handleConciergeButtonPressed() {
        targetScreen = .concierge
        authenticate()
    }

    // MARK: - Internal logic

    private func authenticate() {
        guard !authToken.isEmpty else {
            state = .authFailed("Auth info is not provided")
            return
        }

        state = .authenticating

        self.sdk = customerId.isEmpty || cardProductId.isEmpty
            ? PremiumSDK(
                clientToken: authToken,
              )
            : PremiumSDK(
                withAccessToken: authToken,
                customerId: customerId,
                cardProductId: cardProductId
              )

        self.sdk?.setLanguage(.en)
        self.sdk?.setConciergeUISettings(
            ConciergeUISettings(
                chatStyle: .messenger,
                chatFilePickerEnabled: true,
                shouldShowVisaLogoInInfo: false
            )
        )
        self.sdk?.setConciergeTexts(
            ConciergeTexts(
                chatInfoAdditionalText: "For questions about Premium cards and transactions, please contact the XXXX toll-free line."
            )
        )

        self.sdk?.setDelegate(self)
        self.sdk?.start()
    }
}

// MARK: - ConciergeSDK.Delegate

extension InputViewModel: PremiumSDK.Delegate {

    func conciergeSDKDidStart(isSubscribed: Bool) {
        state = .idle
        onAuthenticated?(targetScreen)
    }

    func conciergeSDKDidSubscribe() {
        state = .idle
        onAuthenticated?(targetScreen)
    }

    func conciergeSDKDidStartWithError(_ error: any Error) {
        state = .authFailed(error.localizedDescription)
    }

    func conciergeSDKCantAuthorize() {
        state = .authFailed("Failed to authorize")
    }
}