README.md

react-native-cloud-fs

A react-native library for reading and writing files to iCloud Drive (iOS) and Google Drive (Android).

Getting started

Usage

import RNCloudFs from 'react-native-cloud-fs';

fileExists (options)

Returns a promise which when resolved returns a boolean value indicating if the specified path already exists.

const destinationPath = "foo-bar/docs/info.pdf";
const scope = 'visible';

RNCloudFs.fileExists({
  targetPath: destinationPath, 
  scope: scope
})
  .then((exists) => {
    console.log(exists ? "this file exists" : "this file does not exist");
  })
  .catch((err) => {
    console.warn("it failed", err);
  })

targetPath: a path

scope: determines if the user-visible documents (visible) or the app-visible documents (hidden) are searched for the specified path

copyToCloud (options)

Copies the content of a file (or uri) to the target file system. The files will appear in a either a user visible directory, or a dectory that only the app can see. The directory is named after destinationPath. The directory hierarchy for the destination path will be created if it doesn't already exist. If the target file already exists it a new filename is chosen and returned when the promise is resolved.

const sourceUri = {uri: 'https://foo.com/bar.pdf'};
const destinationPath = "foo-bar/docs/info.pdf";
const mimeType = null;
const scope = 'visible';

RNCloudFs.copyToCloud({
  sourcePath: sourceUri, 
  targetPath: destinationPath, 
  mimeType: mimeType, 
  scope: scope
})
  .then((path) => {
    console.log("it worked", path);
  })
  .catch((err) => {
    console.warn("it failed", err);
  })

sourceUri: object with any uri or an absolute file path and optional http headers, e.g:

• {path: '/foo/bar/file.txt'}
• {uri: 'file://foo/bar/file.txt'}
• {uri: 'http://www.files.com/foo/bar/file.txt', 'http-headers': {user: 'foo', password: 'bar'}} (http-headers are android only)
• {uri: 'content://media/external/images/media/296'} (android only)
• {uri: 'assets-library://asset/asset.JPG?id=106E99A1-4F6A-45A2-B320-B0AD4A8E8473&ext=JPG'} (iOS only)

targetPath: a relative path including a filename under which the file will be placed, e.g:

• my-cloud-text-file.txt
• foo/bar/my-cloud-text-file.txt

mimeType: a mime type to store the file with or null (android only) , e.g:

• text/plain
• application/json
• image/jpeg

scope: a string to specify if the user can access the document (visible) or not (hidden)

listFiles (options)

Lists files in a directory along with some file metadata. The scope determines if the file listing takes place in the app folder or the public user documents folder.

const path = "dirA/dirB";
const scope = 'hidden';

RNCloudFs.listFiles({targetPath: path, scope: scope})
  .then((res) => {
    console.log("it worked", res);
  })
  .catch((err) => {
    console.warn("it failed", err);
  })

targetPath: a path representing a folder to list files from

scope: a string to specify if the files are the user-visible documents (visible) or the app-visible documents (hidden)

Android

After following the instructions in Getting started I recommend using react-native-google-signin to authenticate the user, especially if you need additional scopes besides auth/drive.file which is the only scope this package requests, and let that package handle auth.

Example of usage on Android:

import { Platform } from 'react-native';
import { GoogleSignin, statusCodes } from '@react-native-community/google-signin';
import RNCloudFS from 'react-native-cloud-fs';

if (Platform.OS === 'android') {
  GoogleSignin.configure({
    scopes: [
      'https://www.googleapis.com/auth/userinfo.profile',
      'https://www.googleapis.com/auth/userinfo.email',
      'https://www.googleapis.com/auth/drive.file',
      // other scopes your app needs
    ],
    webClientId: '...' // you may not need this depending on scopes,
    offlineAccess: true,
    forceConsentPrompt: true,
  });

  // Ensure play services exist. Cannot sign in otherwise. If unavailable, this
  // will show a modal asking the user to get play services before continuing.
  await GoogleSignin.hasPlayServices({
    showPlayServicesUpdateDialog: true
  });

  // If user is already signed in, don't need to call signIn again
  const isSignedIn = await GoogleSignin.isSignedIn();
  if (!isSignedIn) {
    await GoogleSignin.signIn();
  }

  // Syncs signed in state to RNCloudFS
  await RNCloudFS.loginIfNeeded();
  
  // Now you can copy to cloud
  await RNCloudFS.copyToCloud({
    sourcePath: { path: 'some/path.txt' },
    targetPath: `some/path.txt`,
    scope: 'visible'
  });
}