This repo distributes the Aiuta Digital Try On library via Swift Package Manager.

Add AiutaSdk as a dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/aiuta-com/aiuta-ios-sdk.git", from: "1.1.7")
]

Add dependency to your target

    .product(name: "AiutaSdk", package: "aiuta-ios-sdk")

• NSCameraUsageDescription: Required Please provide NSCameraUsageDescription in your Info.plist so that Aiuta can request permission to use the camera from the user.
• NSPhotoLibraryAddUsageDescription: Please provide NSPhotoLibraryAddUsageDescription in your Info.plist so that Aiuta can request permission to save the generated image to the Photo Gallery from the user.

This function configures the Aiuta SDK with the necessary API key and sets up the required services.

See Getting Started for instructions to obtain your API KEY. See Digital Try On Api Reference.

• apiKey: String: The API key provided by Aiuta for accessing its services.
• configuration: Aiuta.Configuration: Custom SDK configurations.

This function presents a UI component that allows users to virtually try on a SKU or related SKUs.

• sku: SkuInfo: The primary SKU that users will try on.
• withMoreToTryOn relatedSkus: [SkuInfo]: Related SKUs that the user can try on, defaulting to an empty array.
• in viewController: UIViewController: The view controller from which the Aiuta UI will be presented.
• delegate: AiutaSdkDelegate: The delegate that will receive callbacks from the Aiuta SDK.

This structure provides customizable configurations for the Aiuta SDK, allowing you to tailor the SDK to your needs. All parameters are optional.

• Appearance: Customizes the look and feel of the SDK's UI components.
• Behavior: Adjusts the SDK's behavior, such as the photo selection limit and debug log output.

• brandColor: UIColor?: Your brand's primary color, used for significant interface elements like the main action button and progress bars.
• accentColor: UIColor?: An extra special attention color for elements like discounted price labels and discount percentage backgrounds.
• backgroundTint: UIColor?: The background tint color for all screens, which will be diluted by an extraLight UIBlurEffect.
• language: Language?: The language in which the SDK interface will be displayed.
• legalDisclaimerUrl: URL?: If set, will add a legal disclaimer on the onboarding screen, opening the specified URL on the user's tap.

• logoImage: UIImage?: A small image of your logo to display in the navigation bar.
• foregroundColor: UIColor?: The color of navigation bar elements where the logo isn't displayed, such as back and action buttons or screen headers.

• photoSelectionLimit: Int: The maximum number of photos a user can select for virtual try-on, defaulting to 10.
• isHistoryAvailable: Bool: Controls the availability of generation history to the user.
• isWishlistAvailable: Bool: Controls the availability of the add to wishlist button when viewing SKU information.
• watermark.image: UIImage?: Optional watermark image that will be applied to share generated image.
• isDebugLogsEnabled: Bool: Controls the output of SDK debug logs, defaulting to false.

This structure represents the information about a SKU in the Aiuta platform.

• skuId: String: A unique identifier for the SKU.
• skuCatalog: String: The catalog identifier the SKU belongs to. It is recommended not to specify a skuCatalog unless it is explicitly necessary.
• imageUrls: [String]: A list of URLs pointing to the images of the SKU.
• localizedTitle: String: The title of the SKU.
• localizedBrand: String: The brand of the SKU.
• localizedPrice: String: The price of the SKU. Should be formatted with a currency symbol.
• localizedOldPrice: String?: The old price of the SKU, if available. Should be formatted with a currency symbol.
• localizedDiscount: String?: The discount on the SKU, if available.
• additionalShareInfo: String? Additional information that will be passed to the share along with the generated image.

This enumeration contains the supported languages of the SDK interface.

This enumeration contains a significant events occurring in the SDK that an host application can send to its own analytics. See AiutaSdkDelegate.aiuta(eventOccurred event: Aiuta.SdkEvent).

This protocol defines the delegate methods for receiving callbacks from the Aiuta SDK.

• aiuta(addToWishlist skuId: String): Called when a user adds an SKU to their wishlist.
• aiuta(addToCart skuId: String): Called when a user adds an SKU to their cart.
• aiuta(showSku skuId: String): Called when a user selects to view more details about an SKU.
• aiuta(eventOccurred event: Aiuta.SdkEvent): Called when significant event occurred in SDK.

Use Configuration.appearance.language to set one of available language in which the SDK interface will be displayed. If not specified, the first preferred system language will be used if it is supported, otherwise English will be used.

import AiutaSdk

// Setup the Aiuta SDK with your API key and custom configuration
if #available(iOS 13.0.0, *) {
    var configuration = Aiuta.Configuration()
    configuration.appearance.brandColor = .red
    configuration.appearance.accentColor = .green
    configuration.appearance.navigationBar.logoImage = UIImage(named: "your_logo")
    configuration.appearance.language = .English
    configuration.appearance.legalDisclaimerUrl = URL(string: "https://aiuta.com/legal/terms-of-service.html")
    
    configuration.behavior.photoSelectionLimit = 4
    configuration.behavior.watermark.image = UIImage(named: "your_watermark")
    
    Aiuta.setup(apiKey: "your_api_key", configuration: configuration)
}

// Define a delegate for handling Aiuta SDK callbacks
class MyAiutaDelegate: AiutaSdkDelegate {
    func aiuta(addToWishlist skuId: String) {
        print("Add to wishlist: \(skuId)")
    }

    func aiuta(addToCart skuId: String) {
        print("Add to cart: \(skuId)")
    }

    func aiuta(showSku skuId: String) {
        print("Show SKU details: \(skuId)")
    }
    
    func aiuta(eventOccurred event: Aiuta.SdkEvent) {
        print("SDK event: \(skuId)")
    }
}

// Use Aiuta's try-on feature in your view controller
class MyViewController: UIViewController {
    let delegate = MyAiutaDelegate()

    func tryOnFeature() {
        let sku = Aiuta.SkuInfo(skuId: "123", skuCatalog: "catalog1", imageUrls: ["url1", "url2"], 
                                localizedTitle: "Title", localizedBrand: "Brand", localizedPrice: "$12.99"
                                additionalShareInfo: "Love this look? Get more on aiuta.com!")
        if #available(iOS 13.0.0, *) {
            Aiuta.tryOn(sku: sku, in: self, delegate: delegate)
        }
    }
}

This documentation provides a concise overview of the Aiuta Swift SDK's core functionalities, allowing developers to integrate Aiuta's features into their iOS applications effectively.