• Home
• io.github.jan-tennert.supabase
• storage-kt-jvm
• 3.0.0-dev-1
• source code
• FlowExtension.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

commonMain.io.github.jan.supabase.storage.FlowExtension.kt Maven / Gradle / Ivy

package io.github.jan.supabase.storage

import io.github.jan.supabase.exceptions.HttpRequestException
import io.github.jan.supabase.exceptions.RestException
import io.github.jan.supabase.network.HttpRequestOverride
import io.ktor.client.plugins.HttpRequestTimeoutException
import io.ktor.client.plugins.onDownload
import io.ktor.client.plugins.onUpload
import io.ktor.utils.io.ByteReadChannel
import io.ktor.utils.io.ByteWriteChannel
import kotlinx.coroutines.channels.ProducerScope
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.callbackFlow

private fun downloadOverride(flowProducer: ProducerScope): HttpRequestOverride = {
    onDownload { bytesSentTotal, contentLength ->
        flowProducer.trySend(DownloadStatus.Progress(bytesSentTotal, contentLength ?: 0))
    }
}

private fun uploadOverride(flowProducer: ProducerScope): HttpRequestOverride = {
    onUpload { bytesSentTotal, contentLength ->
        flowProducer.trySend(UploadStatus.Progress(bytesSentTotal, contentLength ?: 0))
    }
}

/**
 * Uploads a file in [BucketApi.bucketId] under [path]
 * @param path The path to upload the file to
 * @param options Additional options for the upload
 * @param data The data to upload
 * @return A flow that emits the upload progress and at last the key to the uploaded file
 * @throws RestException or one of its subclasses if receiving an error response
 * @throws HttpRequestTimeoutException if the request timed out
 * @throws HttpRequestException on network related issues
 */
fun BucketApi.updateAsFlow(
    path: String,
    data: UploadData,
    options: UploadOptionBuilder.() -> Unit = {}
): Flow = uploadAsFlowRequest {
    update(path, data) {
        options()
        httpOverride(it)
    }
}

/**
 * Uploads a file in [BucketApi.bucketId] under [path]
 * @param path The path to upload the file to
 * @param options Additional options for the upload
 * @param data The data to upload
 * @return A flow that emits the upload progress and at last the key to the uploaded file
 * @throws RestException or one of its subclasses if receiving an error response
 * @throws HttpRequestTimeoutException if the request timed out
 * @throws HttpRequestException on network related issues
 */
fun BucketApi.uploadAsFlow(path: String, data: ByteArray, options: UploadOptionBuilder.() -> Unit = {}): Flow = uploadAsFlow(path, UploadData(
    ByteReadChannel(data), data.size.toLong()), options)

/**
 * Uploads a file in [BucketApi.bucketId] under [path] using a presigned url
 * @param path The path to upload the file to
 * @param token The presigned url token
 * @param data The data to upload
 * @param options Additional options for the upload
 * @return A flow that emits the upload progress and at last the key to the uploaded file
 * @throws RestException or one of its subclasses if receiving an error response
 * @throws HttpRequestTimeoutException if the request timed out
 * @throws HttpRequestException on network related issues
 */
fun BucketApi.uploadToSignedUrlAsFlow(
    path: String,
    token: String,
    data: UploadData,
    options: UploadOptionBuilder.() -> Unit = {}
): Flow = uploadAsFlowRequest {
    uploadToSignedUrl(path, token, data) {
        options()
        httpOverride(it)
    }
}

/**
 * Uploads a file in [BucketApi.bucketId] under [path] using a presigned url
 * @param path The path to upload the file to
 * @param token The presigned url token
 * @param data The data to upload
 * @param options Additional options for the upload
 * @return A flow that emits the upload progress and at last the key to the uploaded file
 */
fun BucketApi.uploadToSignedUrlAsFlow(path: String, token: String, data: ByteArray, options: UploadOptionBuilder.() -> Unit = {}): Flow = uploadToSignedUrlAsFlow(path, token, UploadData(ByteReadChannel(data), data.size.toLong()), options)

/**
 * Updates a file in [BucketApi.bucketId] under [path]
 * @param path The path to update the file to
 * @param data The new data
 * @param options Additional options for the upload
 * @return A flow that emits the upload progress and at last the key to the uploaded file
 * @throws RestException or one of its subclasses if receiving an error response
 * @throws HttpRequestTimeoutException if the request timed out
 * @throws HttpRequestException on network related issues
 */
fun BucketApi.uploadAsFlow(
    path: String,
    data: UploadData,
    options: UploadOptionBuilder.() -> Unit = {}
): Flow = uploadAsFlowRequest {
    upload(path, data) {
        options()
        httpOverride(it)
    }
}

/**
 * Updates a file in [BucketApi.bucketId] under [path]
 * @param path The path to update the file to
 * @param data The new data
 * @param options Additional options for the upload
 * @return A flow that emits the upload progress and at last the key to the uploaded file
 * @throws RestException or one of its subclasses if receiving an error response
 * @throws HttpRequestTimeoutException if the request timed out
 * @throws HttpRequestException on network related issues
 */
fun BucketApi.updateAsFlow(path: String, data: ByteArray, options: UploadOptionBuilder.() -> Unit = {}): Flow = updateAsFlow(path, UploadData(ByteReadChannel(data), data.size.toLong()), options)

private fun BucketApi.uploadAsFlowRequest(
    producer: suspend (HttpRequestOverride) -> FileUploadResponse
) = callbackFlow {
    val key = producer(uploadOverride(this@callbackFlow))
    trySend(UploadStatus.Success(key))
    close()
}

/**
 * Downloads a file from [BucketApi.bucketId] under [path]
 * @param path The path to download
 * @param options Additional options for the download
 * @return A flow that emits the download progress and at last the data as a byte array
 * @throws RestException or one of its subclasses if receiving an error response
 * @throws HttpRequestTimeoutException if the request timed out
 * @throws HttpRequestException on network related issues
 */
fun BucketApi.downloadAuthenticatedAsFlow(
    path: String,
    options: DownloadOptionBuilder.() -> Unit = {}
): Flow = downloadAsFlowRequest {
    downloadAuthenticated(path) {
        options()
        httpOverride(it)
    }
}

/**
 * Downloads a file from [BucketApi.bucketId] under [path] using the public url
 * @param path The path to download
 * @param options Additional options for the download
 * @return A flow that emits the download progress and at last the data as a byte array
 * @throws RestException or one of its subclasses if receiving an error response
 * @throws HttpRequestTimeoutException if the request timed out
 * @throws HttpRequestException on network related issues
 */
fun BucketApi.downloadPublicAsFlow(
    path: String,
    options: DownloadOptionBuilder.() -> Unit = {}
): Flow =
    downloadAsFlowRequest {
        downloadPublic(path) {
            options()
            httpOverride(it)
        }
    }


/**
 * Downloads a file from [BucketApi.bucketId] under [path]
 * @param path The path to download
 * @param channel The channel to write the data to
 * @param options Additional options for the download
 * @return A flow that emits the download progress and at last the data as a byte array
 * @throws RestException or one of its subclasses if receiving an error response
 * @throws HttpRequestTimeoutException if the request timed out
 * @throws HttpRequestException on network related issues
 */
fun BucketApi.downloadAuthenticatedAsFlow(
    path: String,
    channel: ByteWriteChannel,
    options: DownloadOptionBuilder.() -> Unit = {}
): Flow = downloadAsFlowRequest {
    downloadAuthenticated(path, channel) {
        options()
        httpOverride(it)
    }
    null
}

/**
 * Downloads a file from [BucketApi.bucketId] under [path] using the public url
 * @param path The path to download
 * @param channel The channel to write the data to
 * @param options Additional options for the download
 * @return A flow that emits the download progress and at last the data as a byte array
 * @throws RestException or one of its subclasses if receiving an error response
 * @throws HttpRequestTimeoutException if the request timed out
 * @throws HttpRequestException on network related issues
 */
fun BucketApi.downloadPublicAsFlow(
    path: String,
    channel: ByteWriteChannel,
    options: DownloadOptionBuilder.() -> Unit = {}
): Flow = downloadAsFlowRequest {
    downloadPublic(path, channel) {
        options()
        httpOverride(it)
    }
    null
}

private fun BucketApi.downloadAsFlowRequest(
    producer: suspend (HttpRequestOverride) -> ByteArray?
) = callbackFlow {
    //If null, the data gets streamed to a channel, so we don't need to emit it later
    val data = producer(downloadOverride(this@callbackFlow))
    trySend(DownloadStatus.Success)
    if (data != null) {
        trySend(DownloadStatus.ByteData(data))
    }
    close()
}