@hxa-rn/rn-fetch-blob 0.12.0

package/harmony/fetch_blob/src/main/ets/RNFetchBlobTurboModule.ts

@@ -0,0 +1,192 @@
+/*
+ * Copyright (c) 2026. All rights reserved.
+ * HarmonyOS adaptation of rn-fetch-blob (RNFetchBlob TurboModule).
+ *
+ * ETS TurboModule entry. Delegates all calls to RNFetchBlobImpl. The generated
+ * codegen spec (TM.RNFetchBlob.Spec) drives the C++ methodMap_; this class does
+ * not `implements` it because callback signatures are multi-arg on the native
+ * side while the codegen spec describes a single-array callback.
+ */
+
+import { UITurboModule, UITurboModuleContext } from '@rnoh/react-native-openharmony/ts';
+import common from '@ohos.app.ability.common';
+import RNFetchBlobImpl, {
+  SimpleCallback,
+  DataCallback,
+  ExistsCallback,
+  WriteStreamCallback,
+  CancelCallback,
+} from './RNFetchBlobImpl';
+import { RNFetchBlobConfig } from './RNFetchBlobConfig';
+import { FormData, ReqCallback } from './RNFetchBlobReq';
+
+export class RNFetchBlobTurboModule extends UITurboModule {
+  private context: common.UIAbilityContext = this.ctx.uiAbilityContext;
+  private impl: RNFetchBlobImpl = new RNFetchBlobImpl(this.context, this.ctx);
+
+  constructor(ctx: UITurboModuleContext) {
+    super(ctx);
+  }
+
+  getConstants(): Object {
+    return this.impl.getSystemFolders();
+  }
+
+  fetchBlob(options: RNFetchBlobConfig, taskId: string, method: string, url: string, headers: Object,
+    body: string, callback: ReqCallback): void {
+    this.impl.fetchBlob(options, taskId, method, url, headers, body, callback);
+  }
+
+  fetchBlobForm(options: RNFetchBlobConfig, taskId: string, method: string, url: string, headers: Object,
+    form: FormData, callback: ReqCallback): void {
+    this.impl.fetchBlobForm(options, taskId, method, url, headers, form, callback);
+  }
+
+  cancelRequest(taskId: string, callback: CancelCallback): void {
+    this.impl.cancelRequest(taskId, callback);
+  }
+
+  enableProgressReport(taskId: string, interval: number, count: number): void {
+    this.impl.enableProgressReport(taskId, interval, count);
+  }
+
+  enableUploadProgressReport(taskId: string, interval: number, count: number): void {
+    this.impl.enableUploadProgressReport(taskId, interval, count);
+  }
+
+  createFile(path: string, content: string, encode: string): Promise<string> {
+    return this.impl.createFile(path, content, encode);
+  }
+
+  createFileASCII(path: string, dataArray: number[]): Promise<void> {
+    return this.impl.createFileASCII(path, dataArray);
+  }
+
+  writeFile(path: string, encoding: string, data: string, append: boolean): Promise<number> {
+    return this.impl.writeFile(path, encoding, data, append);
+  }
+
+  writeFileArray(path: string, data: number[], append: boolean): Promise<number> {
+    return this.impl.writeFileArray(path, data, append);
+  }
+
+  readFile(path: string, encoding: string): Promise<Object> {
+    return this.impl.readFile(path, encoding);
+  }
+
+  unlink(path: string, callback: SimpleCallback): void {
+    this.impl.unlink(path, callback);
+  }
+
+  mkdir(path: string): Promise<void> {
+    return this.impl.mkdir(path);
+  }
+
+  exists(path: string, callback: ExistsCallback): void {
+    this.impl.exists(path, callback);
+  }
+
+  cp(path: string, dest: string, callback: DataCallback): void {
+    this.impl.cp(path, dest, callback);
+  }
+
+  mv(path: string, dest: string, callback: DataCallback): void {
+    this.impl.mv(path, dest, callback);
+  }
+
+  ls(path: string): Promise<string[]> {
+    return this.impl.ls(path);
+  }
+
+  stat(path: string, callback: DataCallback): void {
+    this.impl.stat(path, callback);
+  }
+
+  lstat(path: string, callback: DataCallback): void {
+    this.impl.lstat(path, callback);
+  }
+
+  hash(path: string, algorithm: string): Promise<string> {
+    return this.impl.hash(path, algorithm);
+  }
+
+  slice(src: string, dest: string, start: number, end: number): Promise<string> {
+    return this.impl.slice(src, dest, start, end);
+  }
+
+  df(callback: DataCallback): void {
+    this.impl.df(callback);
+  }
+
+  removeSession(paths: string[], callback: SimpleCallback): void {
+    this.impl.removeSession(paths, callback);
+  }
+
+  writeStream(path: string, encoding: string, append: boolean, callback: WriteStreamCallback): void {
+    this.impl.writeStream(path, encoding, append, callback);
+  }
+
+  writeChunk(streamId: string, data: string, callback: SimpleCallback): void {
+    this.impl.writeChunk(streamId, data, callback);
+  }
+
+  writeArrayChunk(streamId: string, dataArray: number[], callback: SimpleCallback): void {
+    this.impl.writeArrayChunk(streamId, dataArray, callback);
+  }
+
+  closeStream(streamId: string, callback: SimpleCallback): void {
+    this.impl.closeStream(streamId, callback);
+  }
+
+  readStream(path: string, encoding: string, bufferSize: number, tick: number, streamId: string): void {
+    this.impl.readStream(path, encoding, bufferSize, tick, streamId);
+  }
+
+  scanFile(pairs: Object[], callback: SimpleCallback): void {
+    this.impl.scanFile(pairs, callback);
+  }
+
+  actionViewIntent(path: string, mime: string): Promise<void> {
+    return this.impl.actionViewIntent(path, mime);
+  }
+
+  getContentIntent(mime: string): Promise<string> {
+    return this.impl.getContentIntent(mime);
+  }
+
+  addCompleteDownload(config: Object): Promise<void> {
+    return this.impl.addCompleteDownload(config);
+  }
+
+  getSDCardDir(): Promise<string> {
+    return this.impl.getSDCardDir();
+  }
+
+  getSDCardApplicationDir(): Promise<string> {
+    return this.impl.getSDCardApplicationDir();
+  }
+
+  pathForAppGroup(groupName: string): Promise<string> {
+    return this.impl.pathForAppGroup(groupName);
+  }
+
+  syncPathAppGroup(groupName: string): string {
+    return this.impl.syncPathAppGroup(groupName);
+  }
+
+  previewDocument(uri: string, scheme: string): Promise<void> {
+    return this.impl.previewDocument(uri, scheme);
+  }
+
+  openDocument(uri: string, scheme: string): Promise<void> {
+    return this.impl.openDocument(uri, scheme);
+  }
+
+  excludeFromBackupKey(url: string): Promise<void> {
+    return this.impl.excludeFromBackupKey(url);
+  }
+
+  emitExpiredEvent(callback: () => void): void {
+    this.impl.emitExpiredEvent(callback);
+  }
+}

package/harmony/fetch_blob/src/main/ets/generated/index.ets

@@ -0,0 +1,5 @@
+/**
+ * This code was generated by "react-native codegen-lib-harmony"
+ */
+
+export * from './ts'

package/harmony/fetch_blob/src/main/ets/generated/ts.ts

@@ -0,0 +1,5 @@
+/**
+ * This code was generated by "react-native codegen-lib-harmony"
+ */
+
+export * as TM from "./turboModules/ts"

package/harmony/fetch_blob/src/main/ets/generated/turboModules/RNFetchBlob.ts

@@ -0,0 +1,92 @@
+/**
+ * This code was generated by "react-native codegen-lib-harmony"
+ */
+
+import { Tag } from "@rnoh/react-native-openharmony/ts"
+
+export namespace RNFetchBlob {
+  export const NAME = 'RNFetchBlob' as const
+
+  export interface Spec {
+    getConstants(): {DocumentDir: string, CacheDir: string, PictureDir: string, MusicDir: string, MovieDir: string, DownloadDir: string, DCIMDir: string, SDCardDir: string, SDCardApplicationDir: string, MainBundleDir: string, LibraryDir: string};
+  
+    fetchBlob(options: Object, taskId: string, method: string, url: string, headers: Object, body: string, callback: (value: Object[]) => void): void;
+  
+    fetchBlobForm(options: Object, taskId: string, method: string, url: string, headers: Object, form: Object[], callback: (value: Object[]) => void): void;
+  
+    cancelRequest(taskId: string, callback: (value: Object[]) => void): void;
+  
+    enableProgressReport(taskId: string, interval: number, count: number): void;
+  
+    enableUploadProgressReport(taskId: string, interval: number, count: number): void;
+  
+    createFile(path: string, content: string, encode: string): Promise<string>;
+  
+    createFileASCII(path: string, dataArray: number[]): Promise<void>;
+  
+    writeFile(path: string, encoding: string, data: string, append: boolean): Promise<number>;
+  
+    writeFileArray(path: string, data: number[], append: boolean): Promise<number>;
+  
+    readFile(path: string, encoding: string): Promise<Object>;
+  
+    unlink(path: string, callback: (value: Object[]) => void): void;
+  
+    mkdir(path: string): Promise<void>;
+  
+    exists(path: string, callback: (value: boolean, isDir: boolean) => void): void;
+  
+    cp(path: string, dest: string, callback: (value: Object[]) => void): void;
+  
+    mv(path: string, dest: string, callback: (value: Object[]) => void): void;
+  
+    ls(path: string): Promise<string[]>;
+  
+    stat(path: string, callback: (value: Object[]) => void): void;
+  
+    lstat(path: string, callback: (value: Object[]) => void): void;
+  
+    hash(path: string, algorithm: string): Promise<string>;
+  
+    slice(src: string, dest: string, start: number, end: number): Promise<string>;
+  
+    df(callback: (value: Object[]) => void): void;
+  
+    removeSession(paths: string[], callback: (value: Object[]) => void): void;
+  
+    writeStream(path: string, encoding: string, append: boolean, callback: (value: Object[]) => void): void;
+  
+    writeChunk(streamId: string, data: string, callback: (value: Object[]) => void): void;
+  
+    writeArrayChunk(streamId: string, dataArray: number[], callback: (value: Object[]) => void): void;
+  
+    closeStream(streamId: string, callback: (value: Object[]) => void): void;
+  
+    readStream(path: string, encoding: string, bufferSize: number, tick: number, streamId: string): void;
+  
+    scanFile(pairs: Object[], callback: (value: Object[]) => void): void;
+  
+    actionViewIntent(path: string, mime: string): Promise<void>;
+  
+    getContentIntent(mime: string): Promise<string>;
+  
+    addCompleteDownload(config: Object): Promise<void>;
+  
+    getSDCardDir(): Promise<string>;
+  
+    getSDCardApplicationDir(): Promise<string>;
+  
+    pathForAppGroup(groupName: string): Promise<string>;
+  
+    syncPathAppGroup(groupName: string): string;
+  
+    previewDocument(uri: string, scheme: string): Promise<void>;
+  
+    openDocument(uri: string, scheme: string): Promise<void>;
+  
+    excludeFromBackupKey(url: string): Promise<void>;
+  
+    emitExpiredEvent(callback: () => void): void;
+  
+  }
+}

package/harmony/fetch_blob/src/main/ets/generated/turboModules/ts.ts

@@ -0,0 +1,5 @@
+/**
+ * This code was generated by "react-native codegen-lib-harmony"
+ */
+
+export * from "./RNFetchBlob"

package/harmony/fetch_blob/src/main/module.json5

@@ -0,0 +1,22 @@
+{
+  "module": {
+    "name": "fetch_blob",
+    "type": "har",
+    "deviceTypes": [
+      "default",
+      "tablet",
+      "2in1"
+    ],
+    "requestPermissions": [
+      {
+        "name": "ohos.permission.INTERNET"
+      },
+      {
+        "name": "ohos.permission.GET_WIFI_INFO"
+      },
+      {
+        "name": "ohos.permission.GET_NETWORK_INFO"
+      }
+    ]
+  }
+}

package/harmony/fetch_blob/src/main/resources/base/element/string.json

@@ -0,0 +1,8 @@
+{
+  "string": [
+    {
+      "name": "page_show",
+      "value": "page from npm package"
+    }
+  ]
+}

package/harmony/fetch_blob/src/main/resources/en_US/element/string.json

@@ -0,0 +1,8 @@
+{
+  "string": [
+    {
+      "name": "page_show",
+      "value": "page from npm package"
+    }
+  ]
+}

package/harmony/fetch_blob/src/main/resources/zh_CN/element/string.json

@@ -0,0 +1,8 @@
+{
+  "string": [
+    {
+      "name": "page_show",
+      "value": "page from npm package"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@hxa-rn/rn-fetch-blob",
+  "displayName": "@hxa-rn/rn-fetch-blob",
+  "version": "0.12.0",
+  "description": "A module provides upload, download, and files access API. Supports file stream read/write for process large files.",
+  "main": "./src/index.js",
+  "module": "./src/index.js",
+  "react-native": "./src/index.js",
+  "license": "MIT",
+  "private": false,
+  "repository": {
+    "url": "https://github.com/joltup/rn-fetch-blob.git"
+  },
+  "keywords": [
+    "react-native",
+    "harmony",
+    "harmonyos"
+  ],
+  "homepage": "https://github.com/joltup/rn-fetch-blob",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "files": [
+    "src/",
+    "README.md",
+    "LICENSE",
+    "harmony/"
+  ],
+  "scripts": {
+    "codegen-lib": "react-native codegen-lib-harmony --no-safety-check --npm-package-name fetch_blob --cpp-output-path ./harmony/fetch_blob/src/main/cpp/generated --ets-output-path ./harmony/fetch_blob/src/main/ets/generated --turbo-modules-spec-paths ./src/specs/v1/NativeRNFetchBlob.ts"
+  },
+  "peerDependencies": {
+    "react-native": ">=0.72"
+  },
+  "devDependencies": {
+    "react": "18.2.0",
+    "@types/react": "18.2.79",
+    "react-native": "0.72.5",
+    "jest": "^29.6.3",
+    "@react-native-oh/react-native-harmony-cli": "^0.77.50",
+    "metro": "^0.81.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "harmony": {
+    "alias": "rn-fetch-blob",
+    "autolinking": {
+      "cmakeLibraryTargetName": "fetch_blob",
+      "ohPackageName": "@hxa-rn/rn-fetch-blob",
+      "etsPackageClassName": "FetchBlobPackage",
+      "cppPackageClassName": "FetchBlobPackage"
+    }
+  },
+  "dependencies": {
+    "base-64": "0.1.0",
+    "glob": "7.0.6"
+  }
+}

package/src/android.js

@@ -0,0 +1,62 @@
+// Copyright 2016 wkh237@github. All rights reserved.
+// Use of this source code is governed by a MIT-style license that can be
+// found in the LICENSE file.
+
+import {
+  DeviceEventEmitter,
+  Platform,
+  NativeAppEventEmitter,
+} from 'react-native'
+import NativeRNFetchBlob from './specs/v1/NativeRNFetchBlob'
+
+const RNFetchBlob:RNFetchBlobNative = NativeRNFetchBlob
+
+/**
+ * Send an intent to open the file.
+ * @param  {string} path Path of the file to be open.
+ * @param  {string} mime MIME type string
+ * @return {Promise}
+ */
+function actionViewIntent(path:string, mime:string = 'text/plain') {
+  if(Platform.OS === 'android' || Platform.OS === 'harmony')
+    return NativeRNFetchBlob.actionViewIntent(path, mime)
+  else
+    return Promise.reject('RNFetchBlob.actionViewIntent only supports Android / HarmonyOS.')
+}
+
+function getContentIntent(mime:string) {
+  if(Platform.OS === 'android' || Platform.OS === 'harmony')
+    return NativeRNFetchBlob.getContentIntent(mime)
+  else
+    return Promise.reject('RNFetchBlob.getContentIntent only supports Android / HarmonyOS.')
+}
+
+function addCompleteDownload(config) {
+  if(Platform.OS === 'android' || Platform.OS === 'harmony')
+    return NativeRNFetchBlob.addCompleteDownload(config)
+  else
+    return Promise.reject('RNFetchBlob.addCompleteDownload only supports Android / HarmonyOS.')
+}
+
+function getSDCardDir() {
+  if(Platform.OS === 'android' || Platform.OS === 'harmony')
+    return NativeRNFetchBlob.getSDCardDir()
+  else
+    return Promise.reject('RNFetchBlob.getSDCardDir only supports Android / HarmonyOS.')
+}
+
+function getSDCardApplicationDir() {
+  if(Platform.OS === 'android' || Platform.OS === 'harmony')
+    return NativeRNFetchBlob.getSDCardApplicationDir()
+  else
+    return Promise.reject('RNFetchBlob.getSDCardApplicationDir only supports Android / HarmonyOS.')
+}
+
+
+export default {
+  actionViewIntent,
+  getContentIntent,
+  addCompleteDownload,
+  getSDCardDir,
+  getSDCardApplicationDir,
+}

package/src/class/RNFetchBlobFile.js

@@ -0,0 +1,17 @@
+// Copyright 2016 wkh237@github. All rights reserved.
+// Use of this source code is governed by a MIT-style license that can be
+// found in the LICENSE file.
+
+
+import {
+  DeviceEventEmitter,
+  NativeAppEventEmitter,
+} from 'react-native'
+import NativeRNFetchBlob from '../specs/v1/NativeRNFetchBlob'
+
+const RNFetchBlob = NativeRNFetchBlob
+const emitter = DeviceEventEmitter
+
+export default class RNFetchBlobFile {
+
+}

package/src/class/RNFetchBlobReadStream.js

@@ -0,0 +1,82 @@
+// Copyright 2016 wkh237@github. All rights reserved.
+// Use of this source code is governed by a MIT-style license that can be
+// found in the LICENSE file.
+
+import {
+  DeviceEventEmitter,
+  NativeAppEventEmitter,
+} from 'react-native'
+import NativeRNFetchBlob from '../specs/v1/NativeRNFetchBlob'
+import UUID from '../utils/uuid'
+
+const RNFetchBlob = NativeRNFetchBlob
+const emitter = DeviceEventEmitter
+
+export default class RNFetchBlobReadStream {
+
+  path : string;
+  encoding : 'utf8' | 'ascii' | 'base64';
+  bufferSize : ?number;
+  closed : boolean;
+  tick : number = 10;
+
+  constructor(path:string, encoding:string, bufferSize?:?number, tick:number) {
+    if(!path)
+      throw Error('RNFetchBlob could not open file stream with empty `path`')
+    this.encoding = encoding || 'utf8'
+    this.bufferSize = bufferSize
+    this.path = path
+    this.closed = false
+    this.tick = tick
+    this._onData = () => {}
+    this._onEnd = () => {}
+    this._onError = () => {}
+    this.streamId = 'RNFBRS'+ UUID()
+
+    // register for file stream event
+    let subscription = emitter.addListener(this.streamId, (e) => {
+      let {event, code, detail} = e
+      if(this._onData && event === 'data') {
+        this._onData(detail)
+        return
+      }
+      else if (this._onEnd && event === 'end') {
+        this._onEnd(detail)
+      }
+      else {
+        const err = new Error(detail)
+        err.code = code || 'EUNSPECIFIED'
+        if(this._onError)
+          this._onError(err)
+        else
+          throw err
+      }
+      // when stream closed or error, remove event handler
+      if (event === 'error' || event === 'end') {
+        subscription.remove()
+        this.closed = true
+      }
+    })
+
+  }
+
+  open() {
+    if(!this.closed)
+      NativeRNFetchBlob.readStream(this.path, this.encoding, this.bufferSize || 10240 , this.tick || -1, this.streamId)
+    else
+      throw new Error('Stream closed')
+  }
+
+  onData(fn:() => void) {
+    this._onData = fn
+  }
+
+  onError(fn) {
+    this._onError = fn
+  }
+
+  onEnd (fn) {
+    this._onEnd = fn
+  }
+
+}

package/src/class/RNFetchBlobSession.js

@@ -0,0 +1,74 @@
+// Copyright 2016 wkh237@github. All rights reserved.
+// Use of this source code is governed by a MIT-style license that can be
+// found in the LICENSE file.
+
+import {
+ DeviceEventEmitter,
+ NativeAppEventEmitter,
+} from 'react-native'
+import NativeRNFetchBlob from '../specs/v1/NativeRNFetchBlob'
+
+const RNFetchBlob = NativeRNFetchBlob
+
+let sessions = {}
+
+export default class RNFetchBlobSession {
+
+  name : string;
+
+  static getSession(name:string):any {
+    return sessions[name]
+  }
+
+  static setSession(name:string, val:any) {
+    sessions[name] = val
+  }
+
+  static removeSession(name:string) {
+    delete sessions[name]
+  }
+
+  constructor(name:string, list:Array<string>) {
+    this.name = name
+    if(!sessions[name]) {
+      if(Array.isArray(list))
+      sessions[name] = list
+      else
+      sessions[name] = []
+    }
+  }
+
+  add(path:string):RNFetchBlobSession {
+    sessions[this.name].push(path)
+    return this
+  }
+
+  remove(path:string):RNFetchBlobSession {
+    let list = sessions[this.name]
+    for(let i of list) {
+      if(list[i] === path) {
+        sessions[this.name].splice(i, 1)
+        break;
+      }
+    }
+    return this
+  }
+
+  list():Array<string> {
+    return sessions[this.name]
+  }
+
+  dispose():Promise {
+    return new Promise((resolve, reject) => {
+      NativeRNFetchBlob.removeSession(sessions[this.name], (err) => {
+        if(err)
+          reject(new Error(err))
+        else {
+          delete sessions[this.name]
+          resolve()
+        }
+      })
+    })
+  }
+
+}