s3-klient

Seamlessly uploads files to AWS S3 using a unified API. Features efficient uploads with AWS S3 Transfer Utility and easy coroutine-based operations with suspend functions.

#service-sdk
#kotlin-coroutines
#gradle
#client
#apple

Suggest an edit

Android JVMKotlin/Native

GitHub stars2

Authorsmohaberabi

Open issues0

Creation dateabout 1 year ago

Last activityabout 1 year ago

Latest release0.0.1 (about 1 year ago)

GitHub repository Wiki page

S3Klient - AWS S3 File Upload for Kotlin Multiplatform

S3Klient is a Kotlin Multiplatform (KMP) library that allows seamless file uploads to AWS S3 on * Android* and iOS. It utilizes the AWS SDK for both platforms, ensuring a unified API for file uploads. using each platform native sdk from Amazon

🚀 Features

Kotlin Multiplatform (KMP) support
Uses AWS S3 Transfer Utility for efficient uploads
Supports Android (AWS SDK) and iOS (CocoaPods AWS SDK)
Provides suspend functions for easy coroutine-based uploads

📦 Installation

1️⃣ Add Dependency to KMP Project

Gradle (common `build.gradle.kts`)

commonMain.dependencies {
   implementation("io.github.mohaberabi:s3-klient:0.0.1")
}

2️⃣ iOS Client App Setup

Since S3Klient uses CocoaPods AWS SDK, the client must also include AWS dependencies.

Initialize CocoaPods in iOS Project

Run in the iosApp directory:

pod init

Modify `iosApp/Podfile`

Add AWS SDK dependencies to the Podfile:

target 'iosApp' do
  use_frameworks!
  
  pod 'AWSS3', '2.31.0'  # ✅ Add AWS S3 SDK
  pod 'AWSCore', '2.31.0'  # ✅ Add AWS Core SDK
end

Install Dependencies

cd iosApp
pod install --repo-update

3️⃣ Link AWS Frameworks in Xcode

Open iosApp.xcworkspace in Xcode
Navigate to Build Phases → Link Binary With Libraries
Add:
- AWSCore.framework
- AWSS3.framework

🚀 Usage

1️⃣ Create `S3Klient` Instance

Android Implementation

val s3Klient: S3Klient = AndroidS3KlientFactory(
    context, S3KlientCredentials(
        cognitoIdentityId = "YOUR_COGNITO_IDENTITY_ID",
        cognitoRegion = CognitoRegion.US_EAST_1
    )
).create()

iOS Implementation

val s3Klient: S3Klient = IosS3KlientFactory(
    S3KlientCredentials(
        cognitoIdentityId = "YOUR_COGNITO_IDENTITY_ID",
        cognitoRegion = CognitoRegion.US_EAST_1
    )
).create()

2️⃣ Upload a File

val result: UploadFileResult = s3Klient.uploadFile(
    AwsFileUploadRequest(
        filePath = "/path/to/your/file",
        bucket = "your-bucket-name",
        contentType = "image/png"
    )
)

3️⃣ Handle Upload Result

when (result) {
    is UploadFileResult.Uploaded -> println("✅ File uploaded: ${result.path}")
    is UploadFileResult.Canceled -> println("⚠ Upload canceled: ${result.message}")
    is UploadFileResult.DidNotComplete -> println("Upload failed: ${result.message}")
    is UploadFileResult.Error -> println("Error: ${result.message}")
    UploadFileResult.Unknown -> println("Unknown status")
}

🎯 Architecture

`S3Klient` Interface

interface S3Klient {
    suspend fun uploadFile(request: AwsFileUploadRequest): UploadFileResult
}

Android Implementation (`AndroidS3Klient`)

class AndroidS3Klient(
    private val context: Context,
    private val credentials: S3KlientCredentials
) : S3Klient {
    override suspend fun uploadFile(request: AwsFileUploadRequest): UploadFileResult {
    }
}

iOS Implementation (`IosS3Klient`)

class IosS3Klient(
    private val credentials: S3KlientCredentials
) : S3Klient {
    override suspend fun uploadFile(request: AwsFileUploadRequest): UploadFileResult {
    }
}

Android JVMKotlin/Native

GitHub stars2

Authorsmohaberabi

Open issues0

Creation dateabout 1 year ago

Last activityabout 1 year ago

Latest release0.0.1 (about 1 year ago)

GitHub repository Wiki page

S3Klient - AWS S3 File Upload for Kotlin Multiplatform

🚀 Features

Kotlin Multiplatform (KMP) support
Uses AWS S3 Transfer Utility for efficient uploads
Supports Android (AWS SDK) and iOS (CocoaPods AWS SDK)
Provides suspend functions for easy coroutine-based uploads

📦 Installation

1️⃣ Add Dependency to KMP Project

Gradle (common `build.gradle.kts`)

commonMain.dependencies {
   implementation("io.github.mohaberabi:s3-klient:0.0.1")
}

2️⃣ iOS Client App Setup

Since S3Klient uses CocoaPods AWS SDK, the client must also include AWS dependencies.

Initialize CocoaPods in iOS Project

Run in the iosApp directory:

pod init

Modify `iosApp/Podfile`

Add AWS SDK dependencies to the Podfile:

target 'iosApp' do
  use_frameworks!
  
  pod 'AWSS3', '2.31.0'  # ✅ Add AWS S3 SDK
  pod 'AWSCore', '2.31.0'  # ✅ Add AWS Core SDK
end

Install Dependencies

cd iosApp
pod install --repo-update

3️⃣ Link AWS Frameworks in Xcode

Open iosApp.xcworkspace in Xcode
Navigate to Build Phases → Link Binary With Libraries
Add:
- AWSCore.framework
- AWSS3.framework

🚀 Usage

1️⃣ Create `S3Klient` Instance

Android Implementation

val s3Klient: S3Klient = AndroidS3KlientFactory(
    context, S3KlientCredentials(
        cognitoIdentityId = "YOUR_COGNITO_IDENTITY_ID",
        cognitoRegion = CognitoRegion.US_EAST_1
    )
).create()

iOS Implementation

val s3Klient: S3Klient = IosS3KlientFactory(
    S3KlientCredentials(
        cognitoIdentityId = "YOUR_COGNITO_IDENTITY_ID",
        cognitoRegion = CognitoRegion.US_EAST_1
    )
).create()

2️⃣ Upload a File

val result: UploadFileResult = s3Klient.uploadFile(
    AwsFileUploadRequest(
        filePath = "/path/to/your/file",
        bucket = "your-bucket-name",
        contentType = "image/png"
    )
)

3️⃣ Handle Upload Result

when (result) {
    is UploadFileResult.Uploaded -> println("✅ File uploaded: ${result.path}")
    is UploadFileResult.Canceled -> println("⚠ Upload canceled: ${result.message}")
    is UploadFileResult.DidNotComplete -> println("Upload failed: ${result.message}")
    is UploadFileResult.Error -> println("Error: ${result.message}")
    UploadFileResult.Unknown -> println("Unknown status")
}

🎯 Architecture

`S3Klient` Interface

interface S3Klient {
    suspend fun uploadFile(request: AwsFileUploadRequest): UploadFileResult
}

Android Implementation (`AndroidS3Klient`)

class AndroidS3Klient(
    private val context: Context,
    private val credentials: S3KlientCredentials
) : S3Klient {
    override suspend fun uploadFile(request: AwsFileUploadRequest): UploadFileResult {
    }
}

iOS Implementation (`IosS3Klient`)

class IosS3Klient(
    private val credentials: S3KlientCredentials
) : S3Klient {
    override suspend fun uploadFile(request: AwsFileUploadRequest): UploadFileResult {
    }
}

s3-klient

S3Klient - AWS S3 File Upload for Kotlin Multiplatform

🚀 Features

📦 Installation

1️⃣ Add Dependency to KMP Project

Gradle (common build.gradle.kts)

2️⃣ iOS Client App Setup

Initialize CocoaPods in iOS Project

Modify iosApp/Podfile

Install Dependencies

3️⃣ Link AWS Frameworks in Xcode

🚀 Usage

1️⃣ Create S3Klient Instance

Android Implementation

iOS Implementation

2️⃣ Upload a File

3️⃣ Handle Upload Result

🎯 Architecture

S3Klient Interface

Android Implementation (AndroidS3Klient)

iOS Implementation (IosS3Klient)

S3Klient - AWS S3 File Upload for Kotlin Multiplatform

🚀 Features

📦 Installation

1️⃣ Add Dependency to KMP Project

Gradle (common build.gradle.kts)

2️⃣ iOS Client App Setup

Initialize CocoaPods in iOS Project

Modify iosApp/Podfile

Install Dependencies

3️⃣ Link AWS Frameworks in Xcode

🚀 Usage

1️⃣ Create S3Klient Instance

Android Implementation

iOS Implementation

2️⃣ Upload a File

3️⃣ Handle Upload Result

🎯 Architecture

S3Klient Interface

Android Implementation (AndroidS3Klient)

iOS Implementation (IosS3Klient)

Gradle (common `build.gradle.kts`)

Modify `iosApp/Podfile`

1️⃣ Create `S3Klient` Instance

`S3Klient` Interface

Android Implementation (`AndroidS3Klient`)

iOS Implementation (`IosS3Klient`)

Gradle (common `build.gradle.kts`)

Modify `iosApp/Podfile`

1️⃣ Create `S3Klient` Instance

`S3Klient` Interface

Android Implementation (`AndroidS3Klient`)

iOS Implementation (`IosS3Klient`)