react-native-cloud-storage 1.4.2 → 1.5.0

package/ios/Utils/CloudStorageError.swift

@@ -0,0 +1,78 @@
+//
+//  CloudStorageError.swift
+//  CloudStorage
+//
+//  Created by Maximilian Krause on 27.09.24.
+//  Copyright © 2024 Kuatsu App Agency. All rights reserved.
+//
+
+import Foundation
+
+enum CloudStorageError: Error {
+  case invalidScope(scope: String)
+  case fileNotFound(path: String)
+  case pathIsDirectory(path: String)
+  case pathIsFile(path: String)
+  case directoryNotFound(path: String)
+  case directoryNotEmpty(path: String)
+  case fileAlreadyExists(path: String)
+  case authenticationFailed
+  case writeError(path: String)
+  case readError(path: String)
+  case deleteError(path: String)
+  case statError(path: String)
+  case unknown(message: String = "An unknown error occurred")
+  case fileNotDownloadable(path: String)
+
+  var code: String {
+    switch self {
+    case .invalidScope: "ERR_INVALID_SCOPE"
+    case .fileNotFound: "ERR_FILE_NOT_FOUND"
+    case .pathIsDirectory: "ERR_PATH_IS_DIRECTORY"
+    case .pathIsFile: "ERR_PATH_IS_FILE"
+    case .directoryNotFound: "ERR_DIRECTORY_NOT_FOUND"
+    case .directoryNotEmpty: "ERR_DIRECTORY_NOT_EMPTY"
+    case .fileAlreadyExists: "ERR_FILE_EXISTS"
+    case .authenticationFailed: "ERR_AUTHENTICATION_FAILED"
+    case .writeError: "ERR_WRITE_ERROR"
+    case .readError: "ERR_READ_ERROR"
+    case .deleteError: "ERR_DELETE_ERROR"
+    case .statError: "ERR_STAT_ERROR"
+    case .unknown: "ERR_UNKNOWN"
+    case .fileNotDownloadable: "ERR_FILE_NOT_DOWNLOADABLE"
+    }
+  }
+
+  var message: String {
+    switch self {
+    case let .invalidScope(scope):
+      "Invalid scope \(scope) provided"
+    case let .fileNotFound(path):
+      "File not found at path \(path)"
+    case let .pathIsDirectory(path):
+      "Path is a directory at path \(path)"
+    case let .pathIsFile(path):
+      "Path is a file at path \(path)"
+    case let .directoryNotFound(path):
+      "Directory not found at path \(path)"
+    case let .directoryNotEmpty(path):
+      "Directory not empty at path \(path)"
+    case let .fileAlreadyExists(path):
+      "File already exists at path \(path)"
+    case .authenticationFailed:
+      "Authentication failed"
+    case let .writeError(path):
+      "Write error for path \(path)"
+    case let .readError(path):
+      "Read error for path \(path)"
+    case let .deleteError(path):
+      "Delete error for path \(path)"
+    case let .statError(path):
+      "Stat error for path \(path)"
+    case let .unknown(message):
+      message
+    case let .fileNotDownloadable(path):
+      "File not downloadable at path \(path)"
+    }
+  }
+}

package/ios/Utils/FileUtils.swift

@@ -0,0 +1,132 @@
+//
+//  FileUtils.swift
+//  CloudStorage
+//
+//  Created by Maximilian Krause on 27.09.24.
+//  Copyright © 2024 Kuatsu App Agency. All rights reserved.
+//
+
+import Foundation
+
+enum FileUtils {
+  private static let fileManager = FileManager.default
+
+  static func checkFileExists(fileUrl: URL) throws -> Bool {
+    fileManager.fileExists(atPath: fileUrl.path)
+  }
+
+  /**
+     Reads a file and returns its content as a string.
+
+     - Parameter fileUrl: The URL of the file to read.
+     - Returns: The content of the file as a string.
+     - Throws: An NSError if the file couldn't be read.
+   */
+  static func readFile(fileUrl: URL) throws -> String {
+    if try !checkFileExists(fileUrl: fileUrl) {
+      throw CloudStorageError.fileNotFound(path: fileUrl.path)
+    }
+
+    do {
+      let fileContents = try String(contentsOf: fileUrl, encoding: .utf8)
+      return fileContents
+    } catch {
+      throw CloudStorageError.readError(path: fileUrl.path)
+    }
+  }
+
+  /**
+     Writes a string to a file. If the file already exists, it will be overwritten.
+
+     - Parameter fileUrl: The URL of the file to write to.
+     - Parameter content: The string to write to the file.
+     - Throws: An NSError if the file couldn't be written to.
+   */
+  static func writeFile(fileUrl: URL, content: String) throws {
+    do {
+      try content.write(to: fileUrl, atomically: true, encoding: .utf8)
+    } catch {
+      throw CloudStorageError.writeError(path: fileUrl.path)
+    }
+  }
+
+  /**
+     Creates a directory.
+
+     - Parameter directoryUrl: The URL of the directory to create.
+     - Throws: An NSError if the directory couldn't be created.
+   */
+  static func createDirectory(directoryUrl: URL) throws {
+    do {
+      try fileManager.createDirectory(at: directoryUrl, withIntermediateDirectories: true, attributes: nil)
+    } catch {
+      throw CloudStorageError.writeError(path: directoryUrl.path)
+    }
+  }
+
+  /**
+     Lists the files in a directory.
+
+     - Parameter directoryUrl: The URL of the directory to list the files of.
+     - Returns: An array of Strings representing the file names.
+     - Throws: An NSError if the directory couldn't be read.
+   */
+  static func listFiles(directoryUrl: URL) throws -> [String] {
+    do {
+      let fileUrls = try fileManager.contentsOfDirectory(atPath: directoryUrl.path)
+      return fileUrls
+    } catch {
+      throw CloudStorageError.readError(path: directoryUrl.path)
+    }
+  }
+
+  /**
+     Deletes a file or directory.
+
+     - Parameter fileUrl: The URL of the file or directory to delete.
+     - Throws: An NSError if the file / directory couldn't be deleted.
+   */
+  static func deleteFileOrDirectory(fileUrl: URL) throws {
+    do {
+      try fileManager.removeItem(at: fileUrl)
+    } catch {
+      throw CloudStorageError.deleteError(path: fileUrl.path)
+    }
+  }
+
+  /**
+     Gets the stats of a file.
+
+     - Parameter fileUrl: The URL of the file to get the stats of.
+     - Returns: The stats of the file.
+     - Throws: An NSError if the stats couldn't be retrieved.
+   */
+  static func statFile(fileUrl: URL) throws -> FileStat {
+    if try !checkFileExists(fileUrl: fileUrl) {
+      throw CloudStorageError.fileNotFound(path: fileUrl.path)
+    }
+
+    do {
+      let attributes = try fileManager.attributesOfItem(atPath: fileUrl.path)
+      let size = attributes[FileAttributeKey.size] as! UInt64
+      let birthtime = attributes[FileAttributeKey.creationDate] as! Date
+      let mtime = attributes[FileAttributeKey.modificationDate] as! Date
+      let isDirectory = attributes[FileAttributeKey.type] as! FileAttributeType == FileAttributeType.typeDirectory
+      let isFile = attributes[FileAttributeKey.type] as! FileAttributeType == FileAttributeType.typeRegular
+
+      return FileStat(
+        size: size,
+        birthtimeMs: birthtime.timeIntervalSince1970 * 1000,
+        mtimeMs: mtime.timeIntervalSince1970 * 1000,
+        isDirectory: isDirectory,
+        isFile: isFile
+      )
+    } catch {
+      throw CloudStorageError.statError(path: fileUrl.path)
+    }
+  }
+
+  static func sanitizePath(path: String) -> String {
+    path.replacingOccurrences(of: "^/+", with: "", options: .regularExpression)
+  }
+}

package/ios/Utils/Promise.swift

@@ -0,0 +1,58 @@
+//
+//  Promise.swift
+//  CloudStorage
+//
+//  Created by Maximilian Krause on 27.09.24.
+//  Copyright © 2024 Kuatsu App Agency. All rights reserved.
+//
+
+import Foundation
+
+// MARK: - Promise
+
+class Promise {
+  private let resolver: RCTPromiseResolveBlock
+  private let rejecter: RCTPromiseRejectBlock
+
+  init(resolver: @escaping RCTPromiseResolveBlock, rejecter: @escaping RCTPromiseRejectBlock) {
+    self.resolver = resolver
+    self.rejecter = rejecter
+  }
+
+  func reject(error: CloudStorageError, cause: NSError? = nil) {
+    rejecter(error.code, error.message, cause)
+  }
+
+  func resolve(_ value: Any? = nil) {
+    resolver(value)
+  }
+}
+
+/**
+ * Wrap a code block with automatic promise resolution and rejection handling, simplifying error handling.
+ *
+ * The `block` should return a value that can be serialized by the React Native bridge (or `nil`).
+ * Any error thrown within the `block` should be of type `CloudStorageError`, otherwise it will be treated as
+ * `CloudStorageError.unknown`.
+ */
+func withPromise(_ promise: Promise, _ block: () throws -> Any?) {
+  do {
+    let result = try block()
+    promise.resolve(result)
+  } catch let error as CloudStorageError {
+    promise.reject(error: error)
+  } catch let error as NSError {
+    promise.reject(error: CloudStorageError.unknown(message: error.description), cause: error)
+  }
+}
+
+/**
+ * Wrap a code block with automatic promise resolution and rejection handling, simplifying error handling.
+ *
+ * The `block` should return a value that can be serialized by the React Native bridge (or `nil`).
+ * Any error thrown within the `block` should be of type `CloudStorageError`, otherwise it will be treated as
+ * `CloudStorageError.unknown`.
+ */
+func withPromise(resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock, _ block: () throws -> Any?) {
+  withPromise(Promise(resolver: resolve, rejecter: reject), block)
+}

package/ios/Utils/Types.swift

@@ -0,0 +1,36 @@
+//
+//  Types.swift
+//  CloudStorage
+//
+//  Created by Maximilian Krause on 27.09.24.
+//  Copyright © 2024 Kuatsu App Agency. All rights reserved.
+//
+
+import Foundation
+
+// MARK: - DirectoryScope
+
+@frozen
+enum DirectoryScope: String {
+  case appData = "app_data"
+  case documents
+}
+
+// MARK: - FileStat
+
+struct FileStat: Encodable {
+  let size: UInt64
+  let birthtimeMs: Double
+  let mtimeMs: Double
+  let isDirectory: Bool
+  let isFile: Bool
+
+  func toDictionary() -> [String: Any] {
+    guard let data = try? JSONEncoder().encode(self),
+          let dictionary = try? JSONSerialization.jsonObject(with: data, options: .allowFragments) as? [String: Any]
+    else {
+      return [:]
+    }
+    return dictionary
+  }
+}