@onekeyfe/react-native-range-downloader 3.0.39

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

@@ -0,0 +1,86 @@
+///
+/// RangeDownloadResult.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2026 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
+
+// Forward declaration of `RangeDownloadOutcome` to properly resolve imports.
+namespace margelo::nitro::reactnativerangedownloader { enum class RangeDownloadOutcome; }
+
+#include "RangeDownloadOutcome.hpp"
+#include <string>
+#include <optional>
+
+namespace margelo::nitro::reactnativerangedownloader {
+
+  /**
+   * A struct which can be represented as a JavaScript object (RangeDownloadResult).
+   */
+  struct RangeDownloadResult {
+  public:
+    RangeDownloadOutcome outcome     SWIFT_PRIVATE;
+    std::string filePath     SWIFT_PRIVATE;
+    std::optional<std::string> fallbackReason     SWIFT_PRIVATE;
+
+  public:
+    RangeDownloadResult() = default;
+    explicit RangeDownloadResult(RangeDownloadOutcome outcome, std::string filePath, std::optional<std::string> fallbackReason): outcome(outcome), filePath(filePath), fallbackReason(fallbackReason) {}
+  };
+
+} // namespace margelo::nitro::reactnativerangedownloader
+
+namespace margelo::nitro {
+
+  // C++ RangeDownloadResult <> JS RangeDownloadResult (object)
+  template <>
+  struct JSIConverter<margelo::nitro::reactnativerangedownloader::RangeDownloadResult> final {
+    static inline margelo::nitro::reactnativerangedownloader::RangeDownloadResult fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::reactnativerangedownloader::RangeDownloadResult(
+        JSIConverter<margelo::nitro::reactnativerangedownloader::RangeDownloadOutcome>::fromJSI(runtime, obj.getProperty(runtime, "outcome")),
+        JSIConverter<std::string>::fromJSI(runtime, obj.getProperty(runtime, "filePath")),
+        JSIConverter<std::optional<std::string>>::fromJSI(runtime, obj.getProperty(runtime, "fallbackReason"))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::reactnativerangedownloader::RangeDownloadResult& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, "outcome", JSIConverter<margelo::nitro::reactnativerangedownloader::RangeDownloadOutcome>::toJSI(runtime, arg.outcome));
+      obj.setProperty(runtime, "filePath", JSIConverter<std::string>::toJSI(runtime, arg.filePath));
+      obj.setProperty(runtime, "fallbackReason", JSIConverter<std::optional<std::string>>::toJSI(runtime, arg.fallbackReason));
+      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<margelo::nitro::reactnativerangedownloader::RangeDownloadOutcome>::canConvert(runtime, obj.getProperty(runtime, "outcome"))) return false;
+      if (!JSIConverter<std::string>::canConvert(runtime, obj.getProperty(runtime, "filePath"))) return false;
+      if (!JSIConverter<std::optional<std::string>>::canConvert(runtime, obj.getProperty(runtime, "fallbackReason"))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

package/package.json

@@ -0,0 +1,169 @@
+{
+  "name": "@onekeyfe/react-native-range-downloader",
+  "version": "3.0.39",
+  "description": "react-native-range-downloader",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.tsx",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "nitrogen",
+    "nitro.json",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
+    "nitrogen": "nitrogen",
+    "typecheck": "tsc",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "test": "jest",
+    "release": "yarn prepare && npm whoami && npm publish --access public"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OneKeyHQ/app-modules/react-native-range-downloader.git"
+  },
+  "author": "onekeyfe <huanming@onekey.so> (https://github.com/OneKeyHQ/app-modules)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/OneKeyHQ/app-modules/react-native-range-downloader/issues"
+  },
+  "homepage": "https://github.com/OneKeyHQ/app-modules/react-native-range-downloader#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^19.8.1",
+    "@eslint/compat": "^1.3.2",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.35.0",
+    "@react-native/babel-preset": "0.83.0",
+    "@react-native/eslint-config": "0.83.0",
+    "@release-it/conventional-changelog": "^10.0.1",
+    "@types/jest": "^29.5.14",
+    "@types/react": "^19.2.0",
+    "commitlint": "^19.8.1",
+    "del-cli": "^6.0.0",
+    "eslint": "^9.35.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "jest": "^29.7.0",
+    "lefthook": "^2.0.3",
+    "nitrogen": "0.31.10",
+    "prettier": "^2.8.8",
+    "react": "19.2.0",
+    "react-native": "patch:react-native@npm%3A0.83.0#~/.yarn/patches/react-native-npm-0.83.0-577d0f2d83.patch",
+    "react-native-builder-bob": "^0.40.13",
+    "react-native-nitro-modules": "0.33.2",
+    "release-it": "^19.0.4",
+    "turbo": "^2.5.6",
+    "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*",
+    "react-native-nitro-modules": "0.33.2"
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "custom",
+        {
+          "script": "nitrogen",
+          "clean": "nitrogen/"
+        }
+      ],
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "create-react-native-library": {
+    "type": "nitro-module",
+    "languages": "kotlin-swift",
+    "tools": [
+      "eslint",
+      "jest",
+      "lefthook",
+      "release-it"
+    ],
+    "version": "0.56.0"
+  }
+}

package/src/ReactNativeRangeDownloader.nitro.ts

@@ -0,0 +1,60 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+
+// A channel = one logical consumer (bundle update / apk update / chart webview).
+// The channel decides the iOS background URLSession identifier suffix and the
+// event-routing key, so different consumers never cross-talk. Closed set per
+// design decision 10.1 (constant enum, not a bare string).
+export type DownloadChannel = 'bundle' | 'apk' | 'chart';
+
+export interface RangeDownloadParams {
+  channel: DownloadChannel;
+  taskId: string; // caller-generated unique id (dedupe / resume locating within a channel)
+  url: string; // must be HTTPS (enforced inside the module, mirrors current behavior)
+  destFilePath: string; // final absolute path on disk (module does not own directory layout)
+  expectedSha256?: string; // optional: in-module post-download self-check; else caller verifies later
+  segmentCount?: number; // default 8 (mirrors current behavior)
+  minConcurrentBytes?: number; // default 2MB (below this falls straight back to single stream)
+}
+
+export type RangeDownloadOutcome =
+  | 'completed' // destFilePath fully on disk (and expectedSha256, if passed, has passed)
+  | 'fallback'; // concurrent unavailable, caller should run its own single-stream path
+
+export interface RangeDownloadResult {
+  outcome: RangeDownloadOutcome;
+  filePath: string;
+  fallbackReason?: string; // filled when outcome=fallback (range unsupported / 200 / too small ...)
+}
+
+export interface RangeDownloadEvent {
+  channel: DownloadChannel; // callers filter their own events by channel
+  taskId: string;
+  type: string; // 'start' | 'progress' | 'complete' | 'error' | 'fallback'
+  progress: number; // 0-100
+  message: string;
+}
+
+export interface ReactNativeRangeDownloader
+  extends HybridObject<{ ios: 'swift'; android: 'kotlin' }> {
+  // Main entry: concurrent ranged download (iOS background session / Android thread pool).
+  // The promise resolves once the outcome is decided; on fallback the module has already
+  // cleaned up its own segment artifacts.
+  download(params: RangeDownloadParams): Promise<RangeDownloadResult>;
+
+  // Clean the concurrent artifacts (.segN / .partial / .progress) for one task.
+  // Caller invokes before falling back to its own single-stream path.
+  discardArtifacts(
+    channel: DownloadChannel,
+    taskId: string,
+    destFilePath: string
+  ): Promise<void>;
+
+  // Event listening: all consumers share one listener registry and filter by channel.
+  addDownloadListener(callback: (event: RangeDownloadEvent) => void): number;
+  removeDownloadListener(id: number): void;
+
+  // App-owned writable directory (caches) for scratch downloads. The module does
+  // not own directory layout for real consumers, but exposes this so demos/simple
+  // callers have a valid absolute destination without hardcoding sandbox paths.
+  getDownloadsDir(): string;
+}

package/src/index.tsx

@@ -0,0 +1,20 @@
+import { NitroModules } from 'react-native-nitro-modules';
+import type { ReactNativeRangeDownloader as ReactNativeRangeDownloaderType } from './ReactNativeRangeDownloader.nitro';
+
+const ReactNativeRangeDownloaderHybridObject =
+  NitroModules.createHybridObject<ReactNativeRangeDownloaderType>(
+    'ReactNativeRangeDownloader'
+  );
+
+export const ReactNativeRangeDownloader = ReactNativeRangeDownloaderHybridObject;
+
+// Closed set of download channels (design decision 10.1). The native side builds the
+// background session identifier as `so.onekey.rangedownloader.bg.<channel>`. New channels
+// must be added here (review-visible), preventing consumers from passing typo'd strings.
+export const RangeDownloadChannel = {
+  Bundle: 'bundle',
+  Apk: 'apk',
+  Chart: 'chart',
+} as const;
+
+export type * from './ReactNativeRangeDownloader.nitro';