@javascriptcommon/react-native-xz 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Aspect Apps
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+# react-native-xz
+
+Native XZ/LZMA2 decompression for React Native. Provides fast, efficient decompression of `.xz` files using native libraries on both iOS and Android.
+
+## Features
+
+- Native XZ/LZMA2 decompression
+- Decompress files to disk or directly to string
+- iOS: Uses [SWCompression](https://github.com/tsolomko/SWCompression)
+- Android: Uses [XZ for Java](https://tukaani.org/xz/java.html)
+- Supports React Native 0.72+
+
+## Installation
+
+```bash
+npm install @javascriptcommon/react-native-xz
+# or
+yarn add @javascriptcommon/react-native-xz
+```
+
+### iOS
+
+```bash
+cd ios && pod install
+```
+
+### Android
+
+No additional setup required.
+
+## Usage
+
+```typescript
+import { decompressFile, decompressToString } from '@javascriptcommon/react-native-xz';
+
+// Decompress a file to another file
+const outputPath = await decompressFile('/path/to/file.xz', '/path/to/output');
+
+// Decompress a file directly to a string
+const content = await decompressToString('/path/to/file.xz');
+```
+
+## API
+
+### `decompressFile(inputPath: string, outputPath: string): Promise<string>`
+
+Decompresses an XZ file to a destination path.
+
+- `inputPath`: Path to the `.xz` compressed file
+- `outputPath`: Path where decompressed file will be written
+- Returns: Promise resolving to the output path
+
+### `decompressToString(inputPath: string): Promise<string>`
+
+Decompresses an XZ file and returns the contents as a UTF-8 string.
+
+- `inputPath`: Path to the `.xz` compressed file
+- Returns: Promise resolving to the decompressed string content
+
+## Requirements
+
+- React Native >= 0.72.0
+- iOS >= 13.0
+- Android minSdk >= 21
+
+## License
+
+MIT

package/android/build.gradle

@@ -0,0 +1,48 @@
+buildscript {
+  repositories {
+    google()
+    mavenCentral()
+  }
+  dependencies {
+    classpath "com.android.tools.build:gradle:7.4.2"
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.8.10"
+  }
+}
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+
+android {
+  namespace "com.xz"
+  compileSdkVersion 34
+
+  defaultConfig {
+    minSdkVersion 21
+    targetSdkVersion 34
+  }
+
+  sourceSets {
+    main {
+      java.srcDirs = ['src/main/java']
+    }
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_11
+    targetCompatibility JavaVersion.VERSION_11
+  }
+
+  kotlinOptions {
+    jvmTarget = "11"
+  }
+}
+
+repositories {
+  google()
+  mavenCentral()
+}
+
+dependencies {
+  implementation "com.facebook.react:react-android"
+  implementation "org.tukaani:xz:1.9"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.xz">
+</manifest>

package/android/src/main/java/com/xz/XzModule.kt

@@ -0,0 +1,89 @@
+package com.xz
+
+import android.util.Log
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.ReactContextBaseJavaModule
+import com.facebook.react.bridge.ReactMethod
+import com.facebook.react.bridge.Promise
+import org.tukaani.xz.XZInputStream
+import java.io.File
+import java.io.FileInputStream
+import java.io.FileOutputStream
+import java.io.ByteArrayOutputStream
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.launch
+
+class XzModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaModule(reactContext) {
+
+    companion object {
+        private const val TAG = "XzNative"
+    }
+
+    override fun getName(): String = "Xz"
+
+    @ReactMethod
+    fun decompressFile(inputPath: String, outputPath: String, promise: Promise) {
+        Log.d(TAG, "decompressFile called, input: $inputPath, output: $outputPath")
+        CoroutineScope(Dispatchers.IO).launch {
+            try {
+                val inputFile = File(inputPath)
+                val outputFile = File(outputPath)
+
+                Log.d(TAG, "Reading compressed file, size: ${inputFile.length()} bytes")
+
+                FileInputStream(inputFile).use { fis ->
+                    XZInputStream(fis).use { xzis ->
+                        FileOutputStream(outputFile).use { fos ->
+                            val buffer = ByteArray(8192)
+                            var bytesRead: Int
+                            var totalBytes = 0L
+                            while (xzis.read(buffer).also { bytesRead = it } != -1) {
+                                fos.write(buffer, 0, bytesRead)
+                                totalBytes += bytesRead
+                            }
+                            Log.d(TAG, "Decompressed size: $totalBytes bytes")
+                        }
+                    }
+                }
+
+                Log.d(TAG, "Written to output file")
+                promise.resolve(outputPath)
+            } catch (e: Exception) {
+                Log.e(TAG, "Error: ${e.message}", e)
+                promise.reject("XZ_ERROR", "Failed to decompress XZ file: ${e.message}", e)
+            }
+        }
+    }
+
+    @ReactMethod
+    fun decompressToString(inputPath: String, promise: Promise) {
+        Log.d(TAG, "decompressToString called, input: $inputPath")
+        CoroutineScope(Dispatchers.IO).launch {
+            try {
+                val inputFile = File(inputPath)
+                Log.d(TAG, "Reading compressed file, size: ${inputFile.length()} bytes")
+
+                val result = FileInputStream(inputFile).use { fis ->
+                    XZInputStream(fis).use { xzis ->
+                        ByteArrayOutputStream().use { baos ->
+                            val buffer = ByteArray(8192)
+                            var bytesRead: Int
+                            while (xzis.read(buffer).also { bytesRead = it } != -1) {
+                                baos.write(buffer, 0, bytesRead)
+                            }
+                            Log.d(TAG, "Decompressed size: ${baos.size()} bytes")
+                            baos.toString("UTF-8")
+                        }
+                    }
+                }
+
+                Log.d(TAG, "String length: ${result.length} characters")
+                promise.resolve(result)
+            } catch (e: Exception) {
+                Log.e(TAG, "Error: ${e.message}", e)
+                promise.reject("XZ_ERROR", "Failed to decompress XZ file: ${e.message}", e)
+            }
+        }
+    }
+}

package/android/src/main/java/com/xz/XzPackage.kt

@@ -0,0 +1,16 @@
+package com.xz
+
+import com.facebook.react.ReactPackage
+import com.facebook.react.bridge.NativeModule
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.uimanager.ViewManager
+
+class XzPackage : ReactPackage {
+    override fun createNativeModules(reactContext: ReactApplicationContext): List<NativeModule> {
+        return listOf(XzModule(reactContext))
+    }
+
+    override fun createViewManagers(reactContext: ReactApplicationContext): List<ViewManager<*, *>> {
+        return emptyList()
+    }
+}

package/ios/Xz-Bridging-Header.h

@@ -0,0 +1 @@
+#import <React/RCTBridgeModule.h>

package/ios/Xz.h

@@ -0,0 +1,11 @@
+#ifdef RCT_NEW_ARCH_ENABLED
+#import "RNXzSpec/RNXzSpec.h"
+
+@interface Xz : NSObject <NativeXzSpec>
+#else
+#import <React/RCTBridgeModule.h>
+
+@interface Xz : NSObject <RCTBridgeModule>
+#endif
+
+@end

package/ios/Xz.mm

@@ -0,0 +1,14 @@
+#import <React/RCTBridgeModule.h>
+
+@interface RCT_EXTERN_MODULE(Xz, NSObject)
+
+RCT_EXTERN_METHOD(decompressFile:(NSString *)inputPath
+                  outputPath:(NSString *)outputPath
+                  resolve:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
+
+RCT_EXTERN_METHOD(decompressToString:(NSString *)inputPath
+                  resolve:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
+
+@end

package/ios/Xz.swift

@@ -0,0 +1,67 @@
+import Foundation
+import SWCompression
+
+@objc(Xz)
+class Xz: NSObject {
+
+  @objc
+  static func requiresMainQueueSetup() -> Bool {
+    return false
+  }
+
+  @objc
+  func decompressFile(_ inputPath: String, outputPath: String, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+    print("[Xz Native] decompressFile called, input: \(inputPath), output: \(outputPath)")
+    DispatchQueue.global(qos: .userInitiated).async {
+      do {
+        let inputURL = URL(fileURLWithPath: inputPath)
+        let outputURL = URL(fileURLWithPath: outputPath)
+
+        print("[Xz Native] Reading compressed file...")
+        let compressedData = try Data(contentsOf: inputURL)
+        print("[Xz Native] Compressed size: \(compressedData.count) bytes")
+
+        print("[Xz Native] Decompressing...")
+        let decompressedData = try XZArchive.unarchive(archive: compressedData)
+        print("[Xz Native] Decompressed size: \(decompressedData.count) bytes")
+
+        try decompressedData.write(to: outputURL)
+        print("[Xz Native] Written to output file")
+        resolve(outputPath)
+      } catch {
+        print("[Xz Native] Error: \(error.localizedDescription)")
+        reject("XZ_ERROR", "Failed to decompress XZ file: \(error.localizedDescription)", error)
+      }
+    }
+  }
+
+  @objc
+  func decompressToString(_ inputPath: String, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+    print("[Xz Native] decompressToString called, input: \(inputPath)")
+    DispatchQueue.global(qos: .userInitiated).async {
+      do {
+        let inputURL = URL(fileURLWithPath: inputPath)
+
+        print("[Xz Native] Reading compressed file...")
+        let compressedData = try Data(contentsOf: inputURL)
+        print("[Xz Native] Compressed size: \(compressedData.count) bytes")
+
+        print("[Xz Native] Decompressing...")
+        let decompressedData = try XZArchive.unarchive(archive: compressedData)
+        print("[Xz Native] Decompressed size: \(decompressedData.count) bytes")
+
+        guard let string = String(data: decompressedData, encoding: .utf8) else {
+          print("[Xz Native] Error: Failed to decode as UTF-8")
+          reject("XZ_ERROR", "Failed to decode decompressed data as UTF-8 string", nil)
+          return
+        }
+
+        print("[Xz Native] String length: \(string.count) characters")
+        resolve(string)
+      } catch {
+        print("[Xz Native] Error: \(error.localizedDescription)")
+        reject("XZ_ERROR", "Failed to decompress XZ file: \(error.localizedDescription)", error)
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@javascriptcommon/react-native-xz",
+  "version": "1.0.0",
+  "description": "Native XZ/LZMA2 decompression for React Native",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "source": "src/index.ts",
+  "react-native": "src/index.ts",
+  "files": [
+    "src",
+    "ios",
+    "android",
+    "react-native-xz.podspec",
+    "README.md",
+    "!**/__tests__"
+  ],
+  "scripts": {
+    "typescript": "tsc --noEmit"
+  },
+  "keywords": [
+    "react-native",
+    "xz",
+    "lzma",
+    "lzma2",
+    "compression",
+    "decompression"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Spicy-Sparks/react-native-xz"
+  },
+  "author": "Aspect Apps",
+  "license": "MIT",
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "devDependencies": {
+    "@types/react": "^18.0.0",
+    "@types/react-native": "^0.72.0",
+    "react": "^18.0.0",
+    "react-native": "^0.72.0",
+    "typescript": "^5.0.0"
+  },
+  "codegenConfig": {
+    "name": "RNXzSpec",
+    "type": "modules",
+    "jsSrcsDir": "src",
+    "android": {
+      "javaPackageName": "com.xz"
+    }
+  }
+}

package/react-native-xz.podspec

@@ -0,0 +1,43 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
+
+Pod::Spec.new do |s|
+  s.name         = "react-native-xz"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = "https://github.com/Spicy-Sparks/react-native-xz"
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => min_ios_version_supported }
+  s.source       = { :git => "https://github.com/Spicy-Sparks/react-native-xz.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm,swift}"
+  s.swift_version = "5.0"
+
+  s.dependency "SWCompression", "~> 4.8"
+
+  # Use install_modules_dependencies helper to install the dependencies if React Native version >=0.71.0.
+  if respond_to?(:install_modules_dependencies, true)
+    install_modules_dependencies(s)
+  else
+    s.dependency "React-Core"
+
+    # Don't install the dependencies when we run `pod install` in the old architecture.
+    if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then
+      s.compiler_flags = folly_compiler_flags + " -DRCT_NEW_ARCH_ENABLED=1"
+      s.pod_target_xcconfig    = {
+          "HEADER_SEARCH_PATHS" => "\"$(PODS_ROOT)/boost\"",
+          "OTHER_CPLUSPLUSFLAGS" => "-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1",
+          "CLANG_CXX_LANGUAGE_STANDARD" => "c++17"
+      }
+      s.dependency "React-Codegen"
+      s.dependency "RCT-Folly"
+      s.dependency "RCTRequired"
+      s.dependency "RCTTypeSafety"
+      s.dependency "ReactCommon/turbomodule/core"
+    end
+  end
+end

package/src/index.ts

@@ -0,0 +1,47 @@
+import { NativeModules, Platform } from 'react-native'
+
+const LINKING_ERROR =
+  `The package 'react-native-xz' doesn't seem to be linked. Make sure: \n\n` +
+  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+  '- You rebuilt the app after installing the package\n' +
+  '- You are not using Expo Go\n'
+
+interface XzModule {
+  decompressFile(inputPath: string, outputPath: string): Promise<string>
+  decompressToString(inputPath: string): Promise<string>
+}
+
+const Xz: XzModule = NativeModules.Xz
+  ? NativeModules.Xz
+  : new Proxy(
+      {},
+      {
+        get() {
+          throw new Error(LINKING_ERROR)
+        },
+      }
+    )
+
+/**
+ * Decompress an XZ file to a destination path
+ * @param inputPath Path to the .xz compressed file
+ * @param outputPath Path where decompressed file will be written
+ * @returns Promise resolving to the output path
+ */
+export function decompressFile(inputPath: string, outputPath: string): Promise<string> {
+  return Xz.decompressFile(inputPath, outputPath)
+}
+
+/**
+ * Decompress an XZ file and return contents as string
+ * @param inputPath Path to the .xz compressed file
+ * @returns Promise resolving to the decompressed string content
+ */
+export function decompressToString(inputPath: string): Promise<string> {
+  return Xz.decompressToString(inputPath)
+}
+
+export default {
+  decompressFile,
+  decompressToString,
+}