react-native-cloud-storage 0.6.0 → 1.0.0

package/src/google-drive/index.ts

@@ -123,7 +123,21 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
     return currentDirectoryId;
   }
 
-  private async listFiles(scope: NativeRNCloudCloudStorageScope): Promise<GoogleDriveFile[]> {
+  /**
+   * Gets the Google Drive ID of the root directory for the given scope.
+   * @param scope The scope to get the root directory for.
+   * @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);
+    for (const file of files) {
+      if (!files.find((f) => f.id === file.parents![0])) return file.parents![0] ?? null;
+    }
+
+    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)',
@@ -163,7 +177,18 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
     throwIfDirectory = true
   ): Promise<string> {
     try {
-      const files = await this.listFiles(scope);
+      const files = await this.listInternalFiles(scope);
+
+      if (path === '' || path === '/') {
+        const rootDirectoryId = await this.getRootDirectoryId(scope);
+        if (!rootDirectoryId)
+          throw new CloudStorageError(
+            `Root directory in scope ${scope} not found`,
+            CloudStorageErrorCode.DIRECTORY_NOT_FOUND
+          );
+        return rootDirectoryId;
+      }
+
       const { directories, filename } = this.resolvePathToDirectories(path);
       const parentDirectoryId = this.findParentDirectoryId(files, directories);
       let file: GoogleDriveFile | undefined;
@@ -238,7 +263,7 @@ 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.listFiles(scope);
+      const files = await this.listInternalFiles(scope);
       const { directories, filename } = this.resolvePathToDirectories(path);
       const parentDirectoryId = this.findParentDirectoryId(files, directories);
       uploader.setRequestBody({
@@ -253,6 +278,19 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
     await uploader.execute();
   }
 
+  async listFiles(path: string, scope: NativeRNCloudCloudStorageScope): Promise<string[]> {
+    const allFiles = await this.listInternalFiles(scope);
+    if (path !== '') {
+      const fileId = await this.getFileId(path, scope, false);
+      const files = allFiles.filter((f) => (f.parents ?? [])[0] === fileId);
+
+      return Array.from(new Set(files.map((f) => f.name)));
+    } else {
+      const rootDirectoryId = await this.getRootDirectoryId(scope);
+      return Array.from(new Set(allFiles.filter((f) => (f.parents ?? [])[0] === rootDirectoryId).map((f) => f.name)));
+    }
+  }
+
   async createDirectory(path: string, scope: NativeRNCloudCloudStorageScope): Promise<void> {
     try {
       await this.getFileId(path, scope);
@@ -268,7 +306,7 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
     }
 
     const uploader = GoogleDriveApiClient.drive.files.newMetadataOnlyUploader();
-    const files = await this.listFiles(scope);
+    const files = await this.listInternalFiles(scope);
     const { directories, filename } = this.resolvePathToDirectories(path);
     const parentDirectoryId = this.findParentDirectoryId(files, directories);
     uploader.setRequestBody({

package/src/hooks/useCloudFile.ts

@@ -2,7 +2,13 @@ import type { CloudStorageScope } from '../types/main';
 import RNCloudStorage from '../RNCloudStorage';
 import { useCallback, useEffect, useState } from 'react';
 
-export const useCloudFile = (path: string, scope: CloudStorageScope) => {
+/**
+ * A utility hook for reading and writing to a single file in the cloud.
+ * @param path The path to the file.
+ * @param scope The directory scope the path is in. If not provided, defaults to the default scope set in the library.
+ * @returns An object containing the file's contents and functions for reading, writing, and removing the file.
+ */
+export const useCloudFile = (path: string, scope?: CloudStorageScope) => {
   const [content, setContent] = useState<string | null>(null);
 
   const read = useCallback(async () => {
@@ -18,7 +24,7 @@ export const useCloudFile = (path: string, scope: CloudStorageScope) => {
     read();
   }, [read]);
 
-  const update = useCallback(
+  const write = useCallback(
     async (newContent: string) => {
       await RNCloudStorage.writeFile(path, newContent, scope);
       read();
@@ -34,7 +40,12 @@ export const useCloudFile = (path: string, scope: CloudStorageScope) => {
   return {
     content,
     read,
-    update,
+    write,
     remove,
+    /**
+     * @deprecated Use `write` instead.
+     * @alias write
+     */
+    update: write,
   };
 };

package/src/hooks/useIsCloudAvailable.ts

@@ -11,14 +11,12 @@ export const useIsCloudAvailable = (iCloudTimeout = 10) => {
       const newIsAvailable = await RNCloudStorage.isCloudAvailable();
       setIsAvailable(newIsAvailable);
       if (Platform.OS === 'ios' && newIsAvailable) {
-        console.log('Stopped because iCloud became available');
         clearInterval(interval);
       }
     }, 500);
 
     if (Platform.OS === 'ios') {
       setTimeout(() => {
-        console.log('Stopped because of timeout');
         clearInterval(interval);
       }, iCloudTimeout * 1000);
     }

package/src/index.ts

@@ -5,5 +5,9 @@ export * from './hooks/useCloudFile';
 export * from './hooks/useIsCloudAvailable';
 import CloudStorageError from './utils/CloudStorageError';
 
-export { CloudStorageError, CloudStorageErrorCode };
+export { RNCloudStorage as CloudStorage, CloudStorageError, CloudStorageErrorCode };
+
+/**
+ * @deprecated Use the named export `CloudStorage` instead.
+ */
 export default RNCloudStorage;

package/src/types/native.ts

@@ -11,7 +11,7 @@ export interface NativeRNCloudCloudStorageFileStat {
 export enum CloudStorageErrorCode {
   FILE_NOT_FOUND = 'ERR_FILE_NOT_FOUND',
   PATH_IS_DIRECTORY = 'ERR_PATH_IS_DIRECTORY',
-  DIRECTORY_NOT_FOUND = 'ERR_NO_DIRECTORY_FOUND',
+  DIRECTORY_NOT_FOUND = 'ERR_DIRECTORY_NOT_FOUND',
   FILE_ALREADY_EXISTS = 'ERR_FILE_EXISTS',
   MULTIPLE_FILES_SAME_NAME = 'ERR_MULTIPLE_FILES_SAME_NAME',
   AUTHENTICATION_FAILED = 'ERR_AUTHENTICATION_FAILED',
@@ -27,6 +27,7 @@ export default interface NativeRNCloudStorage {
   fileExists: (path: string, scope: NativeRNCloudCloudStorageScope) => Promise<boolean>;
   createFile: (path: string, data: string, scope: NativeRNCloudCloudStorageScope, overwrite: boolean) => Promise<void>;
   createDirectory: (path: string, scope: NativeRNCloudCloudStorageScope) => Promise<void>;
+  listFiles: (path: string, scope: NativeRNCloudCloudStorageScope) => Promise<string[]>;
   readFile: (path: string, scope: NativeRNCloudCloudStorageScope) => Promise<string>;
   deleteFile: (path: string, scope: NativeRNCloudCloudStorageScope) => Promise<void>;
   statFile: (path: string, scope: NativeRNCloudCloudStorageScope) => Promise<NativeRNCloudCloudStorageFileStat>;

package/src/utils/helpers.ts

@@ -0,0 +1,17 @@
+/**
+ * Checks if the path starts with a leading slash and adds one if it doesn't to maintain backwards compatibility.
+ * Will log a warning to the console if it had to add a leading slash. Will throw an error in the future.
+ *
+ * @param path The path to check.
+ * @returns The path with a leading slash, if it didn't have one already.
+ * @private
+ */
+export const verifyLeadingSlash = (path: string) => {
+  if (!path.startsWith('/')) {
+    console.warn(
+      `[react-native-cloud-storage] Path "${path}" did not start with a leading slash. This is deprecated and will be an error in the future.`
+    );
+    return `/${path}`;
+  }
+  return path;
+};