react-native-nitro-unzip 0.1.0

package/nitrogen/generated/shared/c++/ZipProgress.hpp

@@ -0,0 +1,95 @@
+///
+/// ZipProgress.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/JSIConverter.hpp>)
+#include <NitroModules/JSIConverter.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/NitroDefines.hpp>)
+#include <NitroModules/NitroDefines.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/JSIHelpers.hpp>)
+#include <NitroModules/JSIHelpers.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/PropNameIDCache.hpp>)
+#include <NitroModules/PropNameIDCache.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+
+
+
+
+namespace margelo::nitro::unzip {
+
+  /**
+   * A struct which can be represented as a JavaScript object (ZipProgress).
+   */
+  struct ZipProgress final {
+  public:
+    double compressedFiles     SWIFT_PRIVATE;
+    double totalFiles     SWIFT_PRIVATE;
+    double progress     SWIFT_PRIVATE;
+    double speed     SWIFT_PRIVATE;
+
+  public:
+    ZipProgress() = default;
+    explicit ZipProgress(double compressedFiles, double totalFiles, double progress, double speed): compressedFiles(compressedFiles), totalFiles(totalFiles), progress(progress), speed(speed) {}
+
+  public:
+    friend bool operator==(const ZipProgress& lhs, const ZipProgress& rhs) = default;
+  };
+
+} // namespace margelo::nitro::unzip
+
+namespace margelo::nitro {
+
+  // C++ ZipProgress <> JS ZipProgress (object)
+  template <>
+  struct JSIConverter<margelo::nitro::unzip::ZipProgress> final {
+    static inline margelo::nitro::unzip::ZipProgress fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::unzip::ZipProgress(
+        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "compressedFiles"))),
+        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "totalFiles"))),
+        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "progress"))),
+        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "speed")))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::unzip::ZipProgress& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "compressedFiles"), JSIConverter<double>::toJSI(runtime, arg.compressedFiles));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "totalFiles"), JSIConverter<double>::toJSI(runtime, arg.totalFiles));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "progress"), JSIConverter<double>::toJSI(runtime, arg.progress));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "speed"), JSIConverter<double>::toJSI(runtime, arg.speed));
+      return obj;
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isObject()) {
+        return false;
+      }
+      jsi::Object obj = value.getObject(runtime);
+      if (!nitro::isPlainObject(runtime, obj)) {
+        return false;
+      }
+      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "compressedFiles")))) return false;
+      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "totalFiles")))) return false;
+      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "progress")))) return false;
+      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "speed")))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

package/nitrogen/generated/shared/c++/ZipResult.hpp

@@ -0,0 +1,99 @@
+///
+/// ZipResult.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/JSIConverter.hpp>)
+#include <NitroModules/JSIConverter.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/NitroDefines.hpp>)
+#include <NitroModules/NitroDefines.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/JSIHelpers.hpp>)
+#include <NitroModules/JSIHelpers.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/PropNameIDCache.hpp>)
+#include <NitroModules/PropNameIDCache.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+
+
+
+
+namespace margelo::nitro::unzip {
+
+  /**
+   * A struct which can be represented as a JavaScript object (ZipResult).
+   */
+  struct ZipResult final {
+  public:
+    bool success     SWIFT_PRIVATE;
+    double compressedFiles     SWIFT_PRIVATE;
+    double duration     SWIFT_PRIVATE;
+    double averageSpeed     SWIFT_PRIVATE;
+    double totalBytes     SWIFT_PRIVATE;
+
+  public:
+    ZipResult() = default;
+    explicit ZipResult(bool success, double compressedFiles, double duration, double averageSpeed, double totalBytes): success(success), compressedFiles(compressedFiles), duration(duration), averageSpeed(averageSpeed), totalBytes(totalBytes) {}
+
+  public:
+    friend bool operator==(const ZipResult& lhs, const ZipResult& rhs) = default;
+  };
+
+} // namespace margelo::nitro::unzip
+
+namespace margelo::nitro {
+
+  // C++ ZipResult <> JS ZipResult (object)
+  template <>
+  struct JSIConverter<margelo::nitro::unzip::ZipResult> final {
+    static inline margelo::nitro::unzip::ZipResult fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::unzip::ZipResult(
+        JSIConverter<bool>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "success"))),
+        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "compressedFiles"))),
+        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "duration"))),
+        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "averageSpeed"))),
+        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "totalBytes")))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::unzip::ZipResult& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "success"), JSIConverter<bool>::toJSI(runtime, arg.success));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "compressedFiles"), JSIConverter<double>::toJSI(runtime, arg.compressedFiles));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "duration"), JSIConverter<double>::toJSI(runtime, arg.duration));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "averageSpeed"), JSIConverter<double>::toJSI(runtime, arg.averageSpeed));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "totalBytes"), JSIConverter<double>::toJSI(runtime, arg.totalBytes));
+      return obj;
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isObject()) {
+        return false;
+      }
+      jsi::Object obj = value.getObject(runtime);
+      if (!nitro::isPlainObject(runtime, obj)) {
+        return false;
+      }
+      if (!JSIConverter<bool>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "success")))) return false;
+      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "compressedFiles")))) return false;
+      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "duration")))) return false;
+      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "averageSpeed")))) return false;
+      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "totalBytes")))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

package/package.json

@@ -0,0 +1,165 @@
+{
+  "name": "react-native-nitro-unzip",
+  "version": "0.1.0",
+  "description": "High-performance ZIP extraction for React Native, powered by Nitro Modules",
+  "main": "lib/commonjs/index.js",
+  "module": "lib/module/index.js",
+  "react-native": "src/index",
+  "types": "lib/typescript/index.d.ts",
+  "source": "src/index.ts",
+  "exports": {
+    ".": {
+      "import": "./lib/module/index.js",
+      "require": "./lib/commonjs/index.js",
+      "react-native": "./src/index.ts",
+      "types": "./lib/typescript/index.d.ts"
+    }
+  },
+  "files": [
+    "src",
+    "lib",
+    "ios",
+    "android",
+    "nitrogen",
+    "react-native-nitro-unzip.podspec",
+    "nitro.json",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!ios/build",
+    "!android/build"
+  ],
+  "scripts": {
+    "nitrogen": "nitrogen",
+    "typescript": "tsc --noEmit",
+    "lint": "eslint \"src/**/*.{ts,tsx}\"",
+    "lint-ci": "eslint \"src/**/*.{ts,tsx}\" --max-warnings 0",
+    "test": "jest",
+    "release": "release-it",
+    "clean": "rm -rf lib node_modules",
+    "prepare": "bob build",
+    "prepack": "bob build",
+    "prepublishOnly": "bob build"
+  },
+  "keywords": [
+    "react-native",
+    "nitro",
+    "nitro-modules",
+    "unzip",
+    "zip",
+    "archive",
+    "extraction",
+    "decompress",
+    "ios",
+    "android"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/isaacrowntree/react-native-nitro-unzip.git"
+  },
+  "author": "Isaac Rowntree",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/isaacrowntree/react-native-nitro-unzip/issues"
+  },
+  "homepage": "https://github.com/isaacrowntree/react-native-nitro-unzip#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*",
+    "react-native-nitro-modules": ">=0.34.0"
+  },
+  "devDependencies": {
+    "@babel/preset-env": "^7.29.0",
+    "@babel/preset-typescript": "^7.28.5",
+    "@react-native/eslint-config": "^0.75.0",
+    "@release-it/conventional-changelog": "^10.0.0",
+    "@types/jest": "^29.5.0",
+    "babel-jest": "^30.2.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^10.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.7.0",
+    "nitrogen": "^0.34.0",
+    "prettier": "^3.0.0",
+    "react-native-builder-bob": "^0.35.0",
+    "react-native-nitro-modules": "^0.34.0",
+    "release-it": "^18.0.0",
+    "typescript": "^5.0.0"
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@react-native",
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": "warn"
+    }
+  },
+  "prettier": {
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "all",
+    "bracketSpacing": true,
+    "tabWidth": 2,
+    "useTabs": false
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.tsx?$": [
+        "babel-jest",
+        {
+          "presets": [
+            [
+              "@babel/preset-env",
+              {
+                "targets": {
+                  "node": "current"
+                }
+              }
+            ],
+            "@babel/preset-typescript"
+          ]
+        }
+      ]
+    },
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/",
+      "<rootDir>/lib/"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": "angular"
+      }
+    }
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "commonjs",
+        {
+          "esm": true
+        }
+      ],
+      "module",
+      "typescript"
+    ]
+  }
+}

package/react-native-nitro-unzip.podspec

@@ -0,0 +1,24 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name         = 'react-native-nitro-unzip'
+  s.version      = package['version']
+  s.summary      = package['description']
+  s.homepage     = package['homepage']
+  s.license      = package['license']
+  s.authors      = package['author']
+  s.source       = { git: package['repository']['url'], tag: s.version.to_s }
+  s.platforms    = { ios: '13.0' }
+  s.swift_version = '5.9'
+
+  s.source_files = 'ios/**/*.{h,m,mm,swift,hpp,cpp}'
+
+  # SSZipArchive — C-based libz decompression for maximum performance
+  s.dependency 'SSZipArchive', '~> 2.5'
+
+  # Add Nitrogen generated files + NitroModules dependency
+  load 'nitrogen/generated/ios/NitroUnzip+autolinking.rb'
+  add_nitrogen_files(s)
+end

package/src/index.ts

@@ -0,0 +1,36 @@
+import { NitroModules } from "react-native-nitro-modules";
+import type { Unzip } from "./specs/Unzip.nitro";
+
+export type {
+  UnzipProgress,
+  UnzipResult,
+  UnzipTask,
+  ZipProgress,
+  ZipResult,
+  ZipTask,
+  Unzip,
+} from "./specs/Unzip.nitro";
+
+/**
+ * Create an `Unzip` instance. Each instance is a factory for
+ * extraction and compression tasks.
+ *
+ * @example
+ * ```typescript
+ * import { getUnzip } from 'react-native-nitro-unzip'
+ *
+ * const unzip = getUnzip()
+ *
+ * // Extract
+ * const task = unzip.extract('/path/to/archive.zip', '/output')
+ * task.onProgress((p) => console.log(`${(p.progress * 100).toFixed(0)}%`))
+ * const result = await task.await()
+ *
+ * // Zip
+ * const zipTask = unzip.zip('/path/to/folder', '/output.zip')
+ * const zipResult = await zipTask.await()
+ * ```
+ */
+export function getUnzip(): Unzip {
+  return NitroModules.createHybridObject<Unzip>("Unzip");
+}

package/src/specs/Unzip.nitro.ts

@@ -0,0 +1,193 @@
+import type { HybridObject } from "react-native-nitro-modules";
+
+// ─── Extraction types ────────────────────────────────────────────────
+
+/**
+ * Progress information for an active extraction.
+ */
+export interface UnzipProgress {
+  /** Number of files extracted so far */
+  extractedFiles: number;
+  /** Total number of files in the archive */
+  totalFiles: number;
+  /** Extraction progress from 0.0 to 1.0 */
+  progress: number;
+  /** Current extraction speed in files per second */
+  speed: number;
+  /** Number of bytes processed so far */
+  processedBytes: number;
+}
+
+/**
+ * Result returned when an extraction completes successfully.
+ */
+export interface UnzipResult {
+  /** Whether extraction completed successfully */
+  success: boolean;
+  /** Total number of files extracted */
+  extractedFiles: number;
+  /** Total extraction duration in milliseconds */
+  duration: number;
+  /** Average extraction speed in files per second */
+  averageSpeed: number;
+  /** Total bytes extracted */
+  totalBytes: number;
+}
+
+/**
+ * A single extraction operation. Each call to `Unzip.extract()` returns
+ * an `UnzipTask` instance that can be observed and cancelled independently.
+ *
+ * This is a proper HybridObject — a native instance you interact with
+ * directly, not an opaque task ID.
+ */
+export interface UnzipTask
+  extends HybridObject<{ ios: "swift"; android: "kotlin" }> {
+  /** Unique identifier for this extraction task */
+  readonly taskId: string;
+
+  /**
+   * Register a callback to receive progress updates.
+   * Progress is throttled to ~1 update per second to avoid bridge overhead.
+   * The first file and final file always trigger a callback.
+   */
+  onProgress(callback: (progress: UnzipProgress) => void): void;
+
+  /** Cancel this extraction. Safe to call multiple times. */
+  cancel(): void;
+
+  /**
+   * Await the extraction result. Resolves when extraction completes,
+   * rejects if cancelled or an error occurs.
+   */
+  await(): Promise<UnzipResult>;
+}
+
+// ─── Compression types ───────────────────────────────────────────────
+
+/**
+ * Progress information for an active zip creation.
+ */
+export interface ZipProgress {
+  /** Number of files compressed so far */
+  compressedFiles: number;
+  /** Total number of files to compress */
+  totalFiles: number;
+  /** Compression progress from 0.0 to 1.0 */
+  progress: number;
+  /** Current compression speed in files per second */
+  speed: number;
+}
+
+/**
+ * Result returned when zip creation completes successfully.
+ */
+export interface ZipResult {
+  /** Whether compression completed successfully */
+  success: boolean;
+  /** Total number of files compressed */
+  compressedFiles: number;
+  /** Total compression duration in milliseconds */
+  duration: number;
+  /** Average compression speed in files per second */
+  averageSpeed: number;
+  /** Total bytes written to the zip file */
+  totalBytes: number;
+}
+
+/**
+ * A single zip creation operation. Each call to `Unzip.zip()` returns
+ * a `ZipTask` instance that can be observed and cancelled independently.
+ */
+export interface ZipTask
+  extends HybridObject<{ ios: "swift"; android: "kotlin" }> {
+  /** Unique identifier for this zip task */
+  readonly taskId: string;
+
+  /**
+   * Register a callback to receive progress updates.
+   * Progress is throttled to ~1 update per second.
+   */
+  onProgress(callback: (progress: ZipProgress) => void): void;
+
+  /** Cancel this zip creation. Safe to call multiple times. */
+  cancel(): void;
+
+  /**
+   * Await the zip result. Resolves when zip creation completes,
+   * rejects if cancelled or an error occurs.
+   */
+  await(): Promise<ZipResult>;
+}
+
+// ─── Factory ─────────────────────────────────────────────────────────
+
+/**
+ * Factory for creating extraction and compression tasks.
+ *
+ * @example
+ * ```typescript
+ * import { getUnzip } from 'react-native-nitro-unzip'
+ *
+ * const unzip = getUnzip()
+ *
+ * // Extract
+ * const task = unzip.extract('/path/to/archive.zip', '/path/to/output')
+ * task.onProgress((p) => console.log(`${(p.progress * 100).toFixed(0)}%`))
+ * const result = await task.await()
+ *
+ * // Extract with password
+ * const pwTask = unzip.extractWithPassword('/path/to/encrypted.zip', '/output', 'secret')
+ * const pwResult = await pwTask.await()
+ *
+ * // Create zip
+ * const zipTask = unzip.zip('/path/to/folder', '/path/to/output.zip')
+ * const zipResult = await zipTask.await()
+ * ```
+ */
+export interface Unzip
+  extends HybridObject<{ ios: "swift"; android: "kotlin" }> {
+  /**
+   * Start extracting a ZIP archive to the given destination directory.
+   * Returns an `UnzipTask` instance for progress tracking and cancellation.
+   *
+   * @param zipPath - Absolute path to the ZIP file (file:// URIs accepted)
+   * @param destinationPath - Absolute path to extract into (created if missing)
+   */
+  extract(zipPath: string, destinationPath: string): UnzipTask;
+
+  /**
+   * Extract a password-protected ZIP archive.
+   *
+   * @param zipPath - Absolute path to the ZIP file
+   * @param destinationPath - Absolute path to extract into
+   * @param password - Password for the encrypted archive
+   */
+  extractWithPassword(
+    zipPath: string,
+    destinationPath: string,
+    password: string,
+  ): UnzipTask;
+
+  /**
+   * Create a ZIP archive from a directory.
+   *
+   * @param sourcePath - Absolute path to the directory to compress
+   * @param destinationZipPath - Absolute path for the output ZIP file
+   */
+  zip(sourcePath: string, destinationZipPath: string): ZipTask;
+
+  /**
+   * Create a password-protected ZIP archive from a directory.
+   * Uses AES-256 encryption on Android, standard zip encryption on iOS.
+   *
+   * @param sourcePath - Absolute path to the directory to compress
+   * @param destinationZipPath - Absolute path for the output ZIP file
+   * @param password - Password to protect the archive
+   */
+  zipWithPassword(
+    sourcePath: string,
+    destinationZipPath: string,
+    password: string,
+  ): ZipTask;
+}