react-native-cloud-storage 2.3.0 → 3.0.1

package/src/cloud-storage.ts

@@ -3,13 +3,14 @@ import {
   CloudStorageScope,
   type CloudStorageFileStat,
   type CloudStorageProviderOptions,
+  type CloudStorageProviderOptionsValue,
   type DeepRequired,
 } from './types/main';
-import { NativeCloudStorageErrorCode, type NativeStorage } from './types/native';
+import { NativeCloudStorageErrorCode, type NativeStorage, type NativeStorageScope } from './types/native';
 import { isProviderSupported } from './utils/helpers';
-import { NativeEventEmitter, NativeModules, Platform } from 'react-native';
+import { Platform, type EventSubscription } from 'react-native';
 import GoogleDrive from './storages/google-drive';
-import { NativeCloudKit } from './storages/cloudkit';
+import { NativeCloudKit, NativeCloudKitModule, type NativeCloudStorageCloudKitTurboModule } from './storages/cloudkit';
 import { DEFAULT_PROVIDER_OPTIONS, LINKING_ERROR } from './utils/constants';
 import CloudStorageError from './utils/cloud-storage-error';
 
@@ -20,16 +21,14 @@ export default class RNCloudStorage {
     options: (typeof DEFAULT_PROVIDER_OPTIONS)[keyof typeof DEFAULT_PROVIDER_OPTIONS];
   };
   private cloudAvailabilityListeners: ((available: boolean) => void)[] = [];
+  private cloudAvailabilitySubscription: EventSubscription | null = null;
 
   //#region Constructor and configuration
   /**
    * Creates a new RNCloudStorage instance for the given provider.
    * @param provider The provider to create the instance for. Defaults to the default provider for the current platform.
    */
-  constructor(
-    provider?: CloudStorageProvider,
-    options?: CloudStorageProviderOptions[keyof CloudStorageProviderOptions]
-  ) {
+  constructor(provider?: CloudStorageProvider, options?: CloudStorageProviderOptionsValue) {
     if (provider && !isProviderSupported(provider)) {
       throw new Error(`Provider ${provider} is not supported on the current platform.`);
     }
@@ -97,6 +96,49 @@ export default class RNCloudStorage {
     return this.provider.provider;
   }
 
+  private notifyCloudAvailabilityListeners(available: boolean): void {
+    for (const listener of this.cloudAvailabilityListeners) {
+      listener(available);
+    }
+  }
+
+  private refreshCloudAvailability(): void {
+    this.nativeStorage
+      .isCloudAvailable()
+      .then((available) => {
+        this.notifyCloudAvailabilityListeners(available);
+      })
+      .catch(() => {
+        // ignore errors when refreshing availability after provider changes
+      });
+  }
+
+  private getNativeCloudKitModule(): NativeCloudStorageCloudKitTurboModule | null {
+    return this.provider.provider === CloudStorageProvider.ICloud ? NativeCloudKitModule : null;
+  }
+
+  private removeCloudAvailabilitySubscription(): void {
+    this.cloudAvailabilitySubscription?.remove();
+    this.cloudAvailabilitySubscription = null;
+  }
+
+  private configureCloudAvailabilitySubscription(): void {
+    this.removeCloudAvailabilitySubscription();
+
+    if (this.cloudAvailabilityListeners.length === 0) {
+      return;
+    }
+
+    const nativeCloudKitModule = this.getNativeCloudKitModule();
+    if (!nativeCloudKitModule) {
+      return;
+    }
+
+    this.cloudAvailabilitySubscription = nativeCloudKitModule.onCloudAvailabilityChanged((event) => {
+      this.notifyCloudAvailabilityListeners(event.available);
+    });
+  }
+
   /**
    * Sets the current CloudStorageProvider.
    * @param provider The provider to set.
@@ -111,29 +153,15 @@ export default class RNCloudStorage {
       options: DEFAULT_PROVIDER_OPTIONS[provider],
     };
 
-    // Emit an event to notify useIsCloudAvailable() hook consumers of the new cloud availability status
-    this.nativeStorage.isCloudAvailable().then((available) => {
-      for (const listener of this.cloudAvailabilityListeners) {
-        listener(available);
-      }
-    });
-
-    if (provider === CloudStorageProvider.ICloud) {
-      // Listen to native cloud availability change events
-      const eventEmitter = new NativeEventEmitter(NativeModules.CloudStorageEventEmitter);
-      eventEmitter.addListener('RNCloudStorage.cloud.availability-changed', (event: { available: boolean }) => {
-        for (const listener of this.cloudAvailabilityListeners) {
-          listener(event.available);
-        }
-      });
-    }
+    this.refreshCloudAvailability();
+    this.configureCloudAvailabilitySubscription();
   }
 
   /**
    * Gets the current options for the current provider.
    * @returns The current options for the current provider.
    */
-  getProviderOptions(): CloudStorageProviderOptions[keyof CloudStorageProviderOptions] {
+  getProviderOptions(): CloudStorageProviderOptionsValue {
     return this.provider.options;
   }
 
@@ -141,7 +169,7 @@ export default class RNCloudStorage {
    * Sets the options for the current provider.
    * @param options The options to set for the provider.
    */
-  setProviderOptions(options: CloudStorageProviderOptions[keyof CloudStorageProviderOptions]): void {
+  setProviderOptions(options: CloudStorageProviderOptionsValue): void {
     const newOptions = Object.fromEntries(Object.entries(options).filter(([_, v]) => v !== undefined));
     this.provider.options = {
       ...this.provider.options,
@@ -150,20 +178,44 @@ export default class RNCloudStorage {
 
     if (this.provider.provider === CloudStorageProvider.GoogleDrive && 'accessToken' in newOptions) {
       // Emit an event to notify useIsCloudAvailable() hook consumers of the new cloud availability status
-      for (const listener of this.cloudAvailabilityListeners) {
-        listener(
-          !!(newOptions as Required<CloudStorageProviderOptions[CloudStorageProvider.GoogleDrive]>).accessToken?.length
-        );
-      }
+      this.notifyCloudAvailabilityListeners(
+        !!(newOptions as Required<CloudStorageProviderOptions[CloudStorageProvider.GoogleDrive]>).accessToken?.length
+      );
     }
   }
 
   subscribeToCloudAvailability(listener: (available: boolean) => void): void {
     this.cloudAvailabilityListeners.push(listener);
+
+    if (this.cloudAvailabilityListeners.length === 1) {
+      this.configureCloudAvailabilitySubscription();
+      this.refreshCloudAvailability();
+    }
   }
 
   unsubscribeFromCloudAvailability(listener: (available: boolean) => void): void {
     this.cloudAvailabilityListeners = this.cloudAvailabilityListeners.filter((l) => l !== listener);
+
+    if (this.cloudAvailabilityListeners.length === 0) {
+      this.removeCloudAvailabilitySubscription();
+    }
+  }
+
+  private resolveNativeScope(scope?: CloudStorageScope): NativeStorageScope {
+    const resolvedScope = scope ?? this.provider.options.scope;
+
+    if (this.provider.provider !== CloudStorageProvider.ICloud || resolvedScope !== CloudStorageScope.Documents) {
+      return resolvedScope;
+    }
+
+    const iCloudOptions = this.provider.options as DeepRequired<
+      CloudStorageProviderOptions[CloudStorageProvider.ICloud]
+    >;
+    if (iCloudOptions.documentsMode === 'legacy_sandbox') {
+      return 'documents_legacy';
+    }
+
+    return resolvedScope;
   }
   //#endregion
 
@@ -185,7 +237,7 @@ export default class RNCloudStorage {
    * @returns A promise that resolves when the data has been appended.
    */
   appendFile(path: string, data: string, scope?: CloudStorageScope): Promise<void> {
-    return this.nativeStorage.appendToFile(path, data, scope ?? this.provider.options.scope);
+    return this.nativeStorage.appendToFile(path, data, this.resolveNativeScope(scope));
   }
 
   /**
@@ -195,7 +247,7 @@ export default class RNCloudStorage {
    * @returns A promise that resolves to true if the path exists, false otherwise.
    */
   exists(path: string, scope?: CloudStorageScope): Promise<boolean> {
-    return this.nativeStorage.fileExists(path, scope ?? this.provider.options.scope);
+    return this.nativeStorage.fileExists(path, this.resolveNativeScope(scope));
   }
 
   /**
@@ -206,7 +258,7 @@ export default class RNCloudStorage {
    * @returns A promise that resolves when the file has been written.
    */
   writeFile(path: string, data: string, scope?: CloudStorageScope): Promise<void> {
-    return this.nativeStorage.createFile(path, data, scope ?? this.provider.options.scope, true);
+    return this.nativeStorage.createFile(path, data, this.resolveNativeScope(scope), true);
   }
 
   /**
@@ -216,7 +268,7 @@ export default class RNCloudStorage {
    * @returns A promise that resolves when the directory has been created.
    */
   mkdir(path: string, scope?: CloudStorageScope): Promise<void> {
-    return this.nativeStorage.createDirectory(path, scope ?? this.provider.options.scope);
+    return this.nativeStorage.createDirectory(path, this.resolveNativeScope(scope));
   }
 
   /**
@@ -226,7 +278,7 @@ export default class RNCloudStorage {
    * @returns A promise that resolves to an array of file names, excluding '.' and '..'.
    */
   readdir(path: string, scope?: CloudStorageScope): Promise<string[]> {
-    return this.nativeStorage.listFiles(path, scope ?? this.provider.options.scope);
+    return this.nativeStorage.listFiles(path, this.resolveNativeScope(scope));
   }
 
   /**
@@ -236,7 +288,7 @@ export default class RNCloudStorage {
    * @returns A promise that resolves to the contents of the file.
    */
   readFile(path: string, scope?: CloudStorageScope): Promise<string> {
-    return this.nativeStorage.readFile(path, scope ?? this.provider.options.scope);
+    return this.nativeStorage.readFile(path, this.resolveNativeScope(scope));
   }
 
   /**
@@ -244,9 +296,10 @@ export default class RNCloudStorage {
    * @param path The file to trigger synchronization for.
    * @param scope The directory scope the path is in. Defaults to set default scope set for the current provider.
    * @returns A promise that resolves once the synchronization has been triggered.
+   * @provider icloud
    */
   triggerSync(path: string, scope?: CloudStorageScope): Promise<void> {
-    return this.nativeStorage.triggerSync(path, scope ?? this.provider.options.scope);
+    return this.nativeStorage.triggerSync(path, this.resolveNativeScope(scope));
   }
 
   /**
@@ -263,13 +316,7 @@ export default class RNCloudStorage {
     options: { mimeType: string },
     scope?: CloudStorageScope
   ): Promise<void> {
-    return this.nativeStorage.uploadFile(
-      remotePath,
-      localPath,
-      options.mimeType,
-      scope ?? this.provider.options.scope,
-      true
-    );
+    return this.nativeStorage.uploadFile(remotePath, localPath, options.mimeType, this.resolveNativeScope(scope), true);
   }
 
   /**
@@ -301,7 +348,7 @@ export default class RNCloudStorage {
     if (!localPathOrScope) {
       throw new CloudStorageError('Invalid arguments provided to downloadFile', NativeCloudStorageErrorCode.UNKNOWN);
     }
-    return this.nativeStorage.downloadFile(remotePathOrPath, localPathOrScope, scope ?? this.provider.options.scope);
+    return this.nativeStorage.downloadFile(remotePathOrPath, localPathOrScope, this.resolveNativeScope(scope));
   }
 
   /**
@@ -311,7 +358,7 @@ export default class RNCloudStorage {
    * @returns A promise that resolves when the file has been deleted.
    */
   unlink(path: string, scope?: CloudStorageScope): Promise<void> {
-    return this.nativeStorage.deleteFile(path, scope ?? this.provider.options.scope);
+    return this.nativeStorage.deleteFile(path, this.resolveNativeScope(scope));
   }
 
   /**
@@ -322,7 +369,7 @@ export default class RNCloudStorage {
    * @returns A promise that resolves when the directory has been deleted.
    */
   rmdir(path: string, options?: { recursive?: boolean }, scope?: CloudStorageScope): Promise<void> {
-    return this.nativeStorage.deleteDirectory(path, options?.recursive ?? false, scope ?? this.provider.options.scope);
+    return this.nativeStorage.deleteDirectory(path, options?.recursive ?? false, this.resolveNativeScope(scope));
   }
 
   /**
@@ -332,7 +379,7 @@ export default class RNCloudStorage {
    * @returns A promise that resolves to the CloudStorageFileStat object.
    */
   async stat(path: string, scope?: CloudStorageScope): Promise<CloudStorageFileStat> {
-    const native = await this.nativeStorage.statFile(path, scope ?? this.provider.options.scope);
+    const native = await this.nativeStorage.statFile(path, this.resolveNativeScope(scope));
 
     return {
       ...native,
@@ -372,7 +419,7 @@ export default class RNCloudStorage {
    * Gets the current options for the provider of the default static instance.
    * @returns The current options for the provider of the default static instance.
    */
-  static getProviderOptions(): CloudStorageProviderOptions[keyof CloudStorageProviderOptions] {
+  static getProviderOptions(): CloudStorageProviderOptionsValue {
     return RNCloudStorage.getDefaultInstance().getProviderOptions();
   }
 
@@ -380,7 +427,7 @@ export default class RNCloudStorage {
    * Sets the options for the provider of the default static instance.
    * @param options The options to set for the provider of the default static instance.
    */
-  static setProviderOptions(options: CloudStorageProviderOptions[keyof CloudStorageProviderOptions]): void {
+  static setProviderOptions(options: CloudStorageProviderOptionsValue): void {
     RNCloudStorage.getDefaultInstance().setProviderOptions(options);
   }
 
@@ -460,6 +507,7 @@ export default class RNCloudStorage {
    * @param path The file to trigger synchronization for.
    * @param scope The directory scope the path is in. Defaults to the default scope set for the default static instance.
    * @returns A promise that resolves once the synchronization has been triggered.
+   * @provider icloud
    */
   static triggerSync(path: string, scope?: CloudStorageScope): Promise<void> {
     return RNCloudStorage.getDefaultInstance().triggerSync(path, scope);

package/src/specs/NativeCloudStorageCloudKitIOS.ts

@@ -0,0 +1,33 @@
+import type { CodegenTypes, TurboModule } from 'react-native';
+import { TurboModuleRegistry } from 'react-native';
+
+export type CloudStorageFileStat = {
+  size: number;
+  birthtimeMs: number;
+  mtimeMs: number;
+  isDirectory: boolean;
+  isFile: boolean;
+};
+
+export type CloudAvailabilityChangedEvent = {
+  available: boolean;
+};
+
+export interface Spec extends TurboModule {
+  fileExists(path: string, scope: string): Promise<boolean>;
+  appendToFile(path: string, data: string, scope: string): Promise<void>;
+  createFile(path: string, data: string, scope: string, overwrite: boolean): Promise<void>;
+  createDirectory(path: string, scope: string): Promise<void>;
+  listFiles(path: string, scope: string): Promise<Array<string>>;
+  readFile(path: string, scope: string): Promise<string>;
+  triggerSync(path: string, scope: string): Promise<void>;
+  deleteFile(path: string, scope: string): Promise<void>;
+  deleteDirectory(path: string, recursive: boolean, scope: string): Promise<void>;
+  statFile(path: string, scope: string): Promise<CloudStorageFileStat>;
+  downloadFile(remotePath: string, localPath: string, scope: string): Promise<void>;
+  uploadFile(remotePath: string, localPath: string, mimeType: string, scope: string, overwrite: boolean): Promise<void>;
+  isCloudAvailable(): Promise<boolean>;
+  readonly onCloudAvailabilityChanged: CodegenTypes.EventEmitter<CloudAvailabilityChangedEvent>;
+}
+
+export default TurboModuleRegistry.get<Spec>('CloudStorageCloudKit');

package/src/specs/NativeCloudStorageLocalFileSystem.ts

@@ -0,0 +1,28 @@
+import type { CodegenTypes, TurboModule } from 'react-native';
+import { TurboModuleRegistry } from 'react-native';
+
+export type LocalFileSystemConstants = {
+  temporaryDirectory: string;
+};
+
+export type LocalFileSystemDownloadOptions = {
+  headers?: CodegenTypes.UnsafeObject;
+};
+
+export type LocalFileSystemUploadOptions = {
+  headers?: CodegenTypes.UnsafeObject;
+  method?: string;
+  uploadType?: string;
+  fieldName?: string;
+  parameters?: CodegenTypes.UnsafeObject;
+};
+
+export interface Spec extends TurboModule {
+  getConstants(): LocalFileSystemConstants;
+  createFile(path: string, data: string): Promise<string>;
+  readFile(path: string): Promise<string>;
+  downloadFile(remoteUri: string, localPath: string, options?: LocalFileSystemDownloadOptions): Promise<void>;
+  uploadFile(localPath: string, remoteUri: string, options: LocalFileSystemUploadOptions): Promise<void>;
+}
+
+export default TurboModuleRegistry.get<Spec>('CloudStorageLocalFileSystem');

package/src/storages/cloudkit.ts

@@ -1,5 +1,13 @@
-import { NativeModules } from 'react-native';
+import NativeCloudStorageCloudKitIOS, {
+  type Spec as NativeCloudStorageCloudKitTurboModule,
+} from '../specs/NativeCloudStorageCloudKitIOS';
 import { NativeStorage } from '../types/native';
 import { createProxiedNativeModule } from '../utils/native';
 
-export const NativeCloudKit = createProxiedNativeModule<NativeStorage>(NativeModules.CloudStorageCloudKit);
+export const NativeCloudKitModule = NativeCloudStorageCloudKitIOS;
+
+export const NativeCloudKit = createProxiedNativeModule<NativeStorage>(
+  NativeCloudStorageCloudKitIOS as unknown as NativeStorage | null
+);
+
+export type { NativeCloudStorageCloudKitTurboModule };

package/src/storages/google-drive/client.ts

@@ -116,7 +116,7 @@ export default class GoogleDriveApiClient {
     return body.join('');
   }
 
-  public async listFiles(space: GoogleDriveFileSpace): Promise<GoogleDriveFile[]> {
+  public async listFiles(space: GoogleDriveFileSpace, query?: string): Promise<GoogleDriveFile[]> {
     const files: GoogleDriveFile[] = [];
     let pageToken: string | undefined;
     const fields = ['id', 'kind', 'mimeType', 'name', 'parents', 'spaces', 'size', 'createdTime', 'modifiedTime'];
@@ -125,6 +125,7 @@ export default class GoogleDriveApiClient {
         fields: `files(${fields.join(',')}),nextPageToken`,
         spaces: space,
         pageToken,
+        q: query,
       };
       const response = await this.request<GoogleDriveListOperationResponse>(`/files`, {
         queryParameters,