react-native-cloud-storage 1.2.3 → 1.3.0

package/src/google-drive/index.ts

@@ -1,4 +1,3 @@
-import { GDrive, HttpError, MimeTypes } from 'react-native-google-drive-api-wrapper-js';
 import type NativeRNCloudStorage from '../types/native';
 import {
   CloudStorageErrorCode,
@@ -6,23 +5,26 @@ import {
   type NativeRNCloudCloudStorageScope,
 } from '../types/native';
 import CloudStorageError from '../utils/CloudStorageError';
-import type { GoogleDriveDetailedFile, GoogleDriveFile, GoogleDriveListOperationResponse } from './types';
+import { MimeTypes, type GoogleDriveFile, type GoogleDriveFileSpace } from './types';
 import { DeviceEventEmitter } from 'react-native';
+import GoogleDriveApiClient, { GoogleDriveHttpError } from './client';
 
-export default class GoogleDriveApiClient implements NativeRNCloudStorage {
-  private static drive: GDrive = new GDrive();
+/**
+ * A proxy class that wraps the Google Drive API client implementation to match the native iOS interface.
+ */
+export default class GoogleDrive implements NativeRNCloudStorage {
+  private static drive: GoogleDriveApiClient = new GoogleDriveApiClient();
   public static throwOnFilesWithSameName = false;
   public filesWithSameNameSubscribers: (({ path, fileIds }: { path: string; fileIds: string[] }) => void)[];
 
   constructor() {
     this.filesWithSameNameSubscribers = [];
-    GoogleDriveApiClient.drive.fetchTimeout = 3000;
     return new Proxy(this, {
       // before calling any function, check if the access token is set
-      get(target: GoogleDriveApiClient, prop: keyof GoogleDriveApiClient) {
+      get(target: GoogleDrive, prop: keyof GoogleDrive) {
         const allowedFunctions = ['isCloudAvailable', 'subscribeToFilesWithSameName'];
         if (typeof target[prop] === 'function' && !allowedFunctions.includes(prop.toString())) {
-          if (!GoogleDriveApiClient.drive.accessToken) {
+          if (!GoogleDrive.drive.accessToken.length) {
             throw new CloudStorageError(
               `Google Drive access token is not set, cannot call function ${prop.toString()}`,
               CloudStorageErrorCode.GOOGLE_DRIVE_ACCESS_TOKEN_MISSING
@@ -36,8 +38,8 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
   }
 
   // when setting accessToken, set it on the GDrive instance
-  public static set accessToken(accessToken: string | undefined) {
-    GoogleDriveApiClient.drive.accessToken = accessToken;
+  public static set accessToken(accessToken: string | null) {
+    GoogleDrive.drive.accessToken = accessToken ?? '';
 
     // emit an event for the useIsCloudAvailable hook
     DeviceEventEmitter.emit('RNCloudStorage.cloud.availability-changed', {
@@ -45,8 +47,8 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
     });
   }
 
-  public static get accessToken(): string | undefined {
-    return GoogleDriveApiClient.drive.accessToken;
+  public static get accessToken(): string | null {
+    return GoogleDrive.drive.accessToken.length ? GoogleDrive.drive.accessToken : null;
   }
 
   public subscribeToFilesWithSameName(subscriber: ({ path, fileIds }: { path: string; fileIds: string[] }) => void): {
@@ -61,9 +63,9 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
     };
   }
 
-  public isCloudAvailable: () => Promise<boolean> = async () => !!GoogleDriveApiClient.accessToken?.length;
+  public isCloudAvailable: () => Promise<boolean> = async () => !!GoogleDrive.drive.accessToken.length;
 
-  private getRootDirectory(scope: NativeRNCloudCloudStorageScope): 'drive' | 'appDataFolder' {
+  private getRootDirectory(scope: NativeRNCloudCloudStorageScope): GoogleDriveFileSpace {
     switch (scope) {
       case 'documents':
         return 'drive';
@@ -135,7 +137,7 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
    * @returns A promise that resolves to the ID of the root directory or null if it could not be found.
    */
   private async getRootDirectoryId(scope: NativeRNCloudCloudStorageScope): Promise<string | null> {
-    const files = await this.listInternalFiles(scope);
+    const files = await GoogleDrive.drive.listFiles(this.getRootDirectory(scope));
     for (const file of files) {
       if (!files.find((f) => f.id === file.parents![0])) return file.parents![0] ?? null;
     }
@@ -143,15 +145,6 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
     return null;
   }
 
-  private async listInternalFiles(scope: NativeRNCloudCloudStorageScope): Promise<GoogleDriveFile[]> {
-    const files: GoogleDriveListOperationResponse = await GoogleDriveApiClient.drive.files.list({
-      spaces: [this.getRootDirectory(scope)],
-      fields: 'files(id,kind,mimeType,name,parents,spaces)',
-    });
-
-    return files.files;
-  }
-
   private checkIfMultipleFilesWithSameName(
     path: string,
     files: GoogleDriveFile[],
@@ -167,7 +160,7 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
 
     if (possibleFiles.length <= 1) return;
 
-    if (GoogleDriveApiClient.throwOnFilesWithSameName) {
+    if (GoogleDrive.throwOnFilesWithSameName) {
       throw new CloudStorageError(
         `Multiple files with the same name found at path ${path}: ${possibleFiles.map((f) => f.id).join(', ')}`,
         CloudStorageErrorCode.MULTIPLE_FILES_SAME_NAME
@@ -180,10 +173,10 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
   private async getFileId(
     path: string,
     scope: NativeRNCloudCloudStorageScope,
-    throwIfDirectory = true
+    throwIf: 'directory' | 'file' | false = false
   ): Promise<string> {
     try {
-      const files = await this.listInternalFiles(scope);
+      const files = await GoogleDrive.drive.listFiles(this.getRootDirectory(scope));
 
       if (path === '' || path === '/') {
         const rootDirectoryId = await this.getRootDirectoryId(scope);
@@ -208,12 +201,14 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
         file = files.find((f) => f.name === filename && f.parents![0] === parentDirectoryId);
       }
       if (!file) throw new CloudStorageError(`File not found`, CloudStorageErrorCode.FILE_NOT_FOUND);
-      if (file.mimeType === MimeTypes.FOLDER && throwIfDirectory) {
+      if (file.mimeType === MimeTypes.FOLDER && throwIf === 'directory') {
         throw new CloudStorageError(`Path ${path} is a directory`, CloudStorageErrorCode.PATH_IS_DIRECTORY);
+      } else if (file.mimeType !== MimeTypes.FOLDER && throwIf === 'file') {
+        throw new CloudStorageError(`Path ${path} is a file`, CloudStorageErrorCode.FILE_NOT_FOUND);
       }
       return file.id;
     } catch (e: unknown) {
-      if (e instanceof HttpError && e.json?.error?.status === 'UNAUTHENTICATED') {
+      if (e instanceof GoogleDriveHttpError && e.json?.error?.status === 'UNAUTHENTICATED') {
         throw new CloudStorageError(
           `Could not authenticate with Google Drive`,
           CloudStorageErrorCode.AUTHENTICATION_FAILED,
@@ -228,7 +223,7 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
 
   async fileExists(path: string, scope: NativeRNCloudCloudStorageScope): Promise<boolean> {
     try {
-      await this.getFileId(path, scope, false);
+      await this.getFileId(path, scope);
       return true;
     } catch (e: any) {
       if (e instanceof CloudStorageError && e.code === CloudStorageErrorCode.FILE_NOT_FOUND) return false;
@@ -241,7 +236,7 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
     let prevContent = '';
     try {
       fileId = await this.getFileId(path, scope);
-      prevContent = await GoogleDriveApiClient.drive.files.getText(fileId);
+      prevContent = await GoogleDrive.drive.getFileText(fileId);
     } catch (e: any) {
       if (e instanceof CloudStorageError && e.code === CloudStorageErrorCode.FILE_NOT_FOUND) {
         /* do nothing, simply create the file */
@@ -250,24 +245,30 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
       }
     }
 
-    const uploader = GoogleDriveApiClient.drive.files
-      .newMultipartUploader()
-      .setData(prevContent + data, MimeTypes.TEXT);
-    if (fileId) uploader.setIdOfFileToUpdate(fileId);
-    else {
-      const files = await this.listInternalFiles(scope);
+    if (fileId) {
+      await GoogleDrive.drive.updateFile(fileId, {
+        body: prevContent + data,
+        mimeType: MimeTypes.TEXT,
+      });
+    } else {
+      const files = await GoogleDrive.drive.listFiles(this.getRootDirectory(scope));
       const { directories, filename } = this.resolvePathToDirectories(path);
       const parentDirectoryId = this.findParentDirectoryId(files, directories);
-      uploader.setRequestBody({
-        name: filename,
-        parents: parentDirectoryId
-          ? [parentDirectoryId]
-          : scope === 'app_data'
-          ? [this.getRootDirectory(scope)]
-          : undefined,
-      });
+      await GoogleDrive.drive.createFile(
+        {
+          name: filename,
+          parents: parentDirectoryId
+            ? [parentDirectoryId]
+            : scope === 'app_data'
+            ? [this.getRootDirectory(scope)]
+            : undefined,
+        },
+        {
+          body: data,
+          mimeType: MimeTypes.TEXT,
+        }
+      );
     }
-    await uploader.execute();
   }
 
   async createFile(
@@ -300,28 +301,36 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
       }
     }
 
-    const uploader = GoogleDriveApiClient.drive.files.newMultipartUploader().setData(data, MimeTypes.TEXT);
-    if (fileId) uploader.setIdOfFileToUpdate(fileId);
-    else {
-      const files = await this.listInternalFiles(scope);
+    if (fileId) {
+      await GoogleDrive.drive.updateFile(fileId, {
+        body: data,
+        mimeType: MimeTypes.TEXT,
+      });
+    } else {
+      const files = await GoogleDrive.drive.listFiles(this.getRootDirectory(scope));
       const { directories, filename } = this.resolvePathToDirectories(path);
       const parentDirectoryId = this.findParentDirectoryId(files, directories);
-      uploader.setRequestBody({
-        name: filename,
-        parents: parentDirectoryId
-          ? [parentDirectoryId]
-          : scope === 'app_data'
-          ? [this.getRootDirectory(scope)]
-          : undefined,
-      });
+      await GoogleDrive.drive.createFile(
+        {
+          name: filename,
+          parents: parentDirectoryId
+            ? [parentDirectoryId]
+            : scope === 'app_data'
+            ? [this.getRootDirectory(scope)]
+            : undefined,
+        },
+        {
+          body: data,
+          mimeType: MimeTypes.TEXT,
+        }
+      );
     }
-    await uploader.execute();
   }
 
   async listFiles(path: string, scope: NativeRNCloudCloudStorageScope): Promise<string[]> {
-    const allFiles = await this.listInternalFiles(scope);
+    const allFiles = await GoogleDrive.drive.listFiles(this.getRootDirectory(scope));
     if (path !== '') {
-      const fileId = await this.getFileId(path, scope, false);
+      const fileId = await this.getFileId(path, scope);
       const files = allFiles.filter((f) => (f.parents ?? [])[0] === fileId);
 
       return Array.from(new Set(files.map((f) => f.name)));
@@ -345,25 +354,23 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
       }
     }
 
-    const uploader = GoogleDriveApiClient.drive.files.newMetadataOnlyUploader();
-    const files = await this.listInternalFiles(scope);
+    const files = await GoogleDrive.drive.listFiles(this.getRootDirectory(scope));
     const { directories, filename } = this.resolvePathToDirectories(path);
     const parentDirectoryId = this.findParentDirectoryId(files, directories);
-    uploader.setRequestBody({
+
+    await GoogleDrive.drive.createDirectory({
       name: filename,
-      mimeType: MimeTypes.FOLDER,
       parents: parentDirectoryId
         ? [parentDirectoryId]
         : scope === 'app_data'
         ? [this.getRootDirectory(scope)]
         : undefined,
     });
-    await uploader.execute();
   }
 
   async readFile(path: string, scope: NativeRNCloudCloudStorageScope): Promise<string> {
     const fileId = await this.getFileId(path, scope);
-    const content = await GoogleDriveApiClient.drive.files.getText(fileId);
+    const content = await GoogleDrive.drive.getFileText(fileId);
     return content;
   }
 
@@ -373,17 +380,34 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
   }
 
   async deleteFile(path: string, scope: NativeRNCloudCloudStorageScope): Promise<void> {
-    const fileId = await this.getFileId(path, scope);
-    await GoogleDriveApiClient.drive.files.delete(fileId);
+    // if trying to pass a directory, throw an error
+    const fileId = await this.getFileId(path, scope, 'directory');
+    await GoogleDrive.drive.deleteFile(fileId);
+  }
+
+  async deleteDirectory(path: string, recursive: boolean, scope: NativeRNCloudCloudStorageScope): Promise<void> {
+    // if trying to pass a file, throw an error
+    const fileId = await this.getFileId(path, scope, 'file');
+
+    if (!recursive) {
+      // check if the directory is empty
+      const files = await GoogleDrive.drive.listFiles(this.getRootDirectory(scope));
+      const filesInDirectory = files.filter((f) => (f.parents ?? [])[0] === fileId);
+      if (filesInDirectory.length > 0) {
+        throw new CloudStorageError(
+          `Directory ${path} is not empty`,
+          CloudStorageErrorCode.DELETE_ERROR,
+          filesInDirectory
+        );
+      }
+    }
+
+    await GoogleDrive.drive.deleteFile(fileId);
   }
 
   async statFile(path: string, scope: NativeRNCloudCloudStorageScope): Promise<NativeRNCloudCloudStorageFileStat> {
     const fileId = await this.getFileId(path, scope, false);
-    const file: GoogleDriveDetailedFile = await (
-      await GoogleDriveApiClient.drive.files.get(fileId!, {
-        fields: 'id,kind,mimeType,name,parents,spaces,size,createdTime,modifiedTime',
-      })
-    ).json();
+    const file = await GoogleDrive.drive.getFile(fileId!);
 
     return {
       size: file.size ?? 0,

package/src/google-drive/types.ts

@@ -1,13 +1,21 @@
+export type GoogleDriveFileSpace = 'appDataFolder' | 'drive';
+
+export enum MimeTypes {
+  BINARY = 'application/octet-stream',
+  CSV = 'text/csv',
+  FOLDER = 'application/vnd.google-apps.folder',
+  JSON = 'application/json',
+  PDF = 'application/pdf',
+  TEXT = 'text/plain',
+}
+
 export interface GoogleDriveFile {
   id: string;
   kind: 'drive#file';
   mimeType: string;
   name: string;
   parents: string[];
-  spaces: ('appDataFolder' | 'drive')[];
-}
-
-export interface GoogleDriveDetailedFile extends GoogleDriveFile {
+  spaces: GoogleDriveFileSpace[];
   createdTime: string;
   modifiedTime: string;
   size?: number;

package/src/types/native.ts

@@ -10,8 +10,10 @@ export interface NativeRNCloudCloudStorageFileStat {
 
 export enum CloudStorageErrorCode {
   FILE_NOT_FOUND = 'ERR_FILE_NOT_FOUND',
+  PATH_IS_FILE = 'ERR_PATH_IS_FILE',
   PATH_IS_DIRECTORY = 'ERR_PATH_IS_DIRECTORY',
   DIRECTORY_NOT_FOUND = 'ERR_DIRECTORY_NOT_FOUND',
+  DIRECTORY_NOT_EMPTY = 'ERR_DIRECTORY_NOT_EMPTY',
   FILE_ALREADY_EXISTS = 'ERR_FILE_EXISTS',
   MULTIPLE_FILES_SAME_NAME = 'ERR_MULTIPLE_FILES_SAME_NAME',
   AUTHENTICATION_FAILED = 'ERR_AUTHENTICATION_FAILED',
@@ -33,6 +35,7 @@ export default interface NativeRNCloudStorage {
   readFile: (path: string, scope: NativeRNCloudCloudStorageScope) => Promise<string>;
   downloadFile: (path: string, scope: NativeRNCloudCloudStorageScope) => Promise<void>;
   deleteFile: (path: string, scope: NativeRNCloudCloudStorageScope) => Promise<void>;
+  deleteDirectory: (path: string, recursively: boolean, scope: NativeRNCloudCloudStorageScope) => Promise<void>;
   statFile: (path: string, scope: NativeRNCloudCloudStorageScope) => Promise<NativeRNCloudCloudStorageFileStat>;
   isCloudAvailable: () => Promise<boolean>;
 }