react-native-cloud-storage 0.4.0 → 0.4.2

package/src/google-drive/index.ts

@@ -1,12 +1,12 @@
 import { GDrive, MimeTypes } from 'react-native-google-drive-api-wrapper-js';
 import type NativeRNCloudStorage from '../types/native';
 import {
-  NativeStorageErrorCode,
-  type NativeRNCloudStorageFileStat,
-  type NativeRNCloudStorageScope,
+  CloudStorageErrorCode,
+  type NativeRNCloudCloudStorageFileStat,
+  type NativeRNCloudCloudStorageScope,
 } from '../types/native';
 import type { GoogleDriveDetailedFile, GoogleDriveFile, GoogleDriveListOperationResponse } from './types';
-import NativeStorageError from '../utils/NativeStorageError';
+import CloudStorageError from '../utils/CloudStorageError';
 
 class GoogleDriveApiClient implements NativeRNCloudStorage {
   private static drive: GDrive = new GDrive();
@@ -16,11 +16,11 @@ class GoogleDriveApiClient implements NativeRNCloudStorage {
     return new Proxy(this, {
       // before calling any function, check if the access token is set
       get(target: GoogleDriveApiClient, prop: keyof GoogleDriveApiClient) {
-        if (typeof target[prop] === 'function') {
+        if (typeof target[prop] === 'function' && prop !== 'isCloudAvailable') {
           if (!GoogleDriveApiClient.drive.accessToken) {
-            throw new NativeStorageError(
+            throw new CloudStorageError(
               `Google Drive access token is not set, cannot call function ${prop.toString()}`,
-              NativeStorageErrorCode.GOOGLE_DRIVE_ACCESS_TOKEN_MISSING
+              CloudStorageErrorCode.GOOGLE_DRIVE_ACCESS_TOKEN_MISSING
             );
           }
         }
@@ -31,17 +31,17 @@ class GoogleDriveApiClient implements NativeRNCloudStorage {
   }
 
   // when setting accessToken, set it on the GDrive instance
-  public static set accessToken(accessToken: string) {
+  public static set accessToken(accessToken: string | undefined) {
     GoogleDriveApiClient.drive.accessToken = accessToken;
   }
 
-  public static get accessToken(): string {
+  public static get accessToken(): string | undefined {
     return GoogleDriveApiClient.drive.accessToken;
   }
 
-  public isCloudAvailable: () => Promise<boolean> = async () => true;
+  public isCloudAvailable: () => Promise<boolean> = async () => !!GoogleDriveApiClient.accessToken?.length;
 
-  private getRootDirectory(scope: NativeRNCloudStorageScope): 'drive' | 'appDataFolder' {
+  private getRootDirectory(scope: NativeRNCloudCloudStorageScope): 'drive' | 'appDataFolder' {
     switch (scope) {
       case 'documents':
         return 'drive';
@@ -80,9 +80,9 @@ class GoogleDriveApiClient implements NativeRNCloudStorage {
     }
 
     if (!topDirectoryId) {
-      throw new NativeStorageError(
+      throw new CloudStorageError(
         `Could not find top directory with name ${directoryTree[0]}`,
-        NativeStorageErrorCode.DIRECTORY_NOT_FOUND
+        CloudStorageErrorCode.DIRECTORY_NOT_FOUND
       );
     }
 
@@ -91,15 +91,15 @@ class GoogleDriveApiClient implements NativeRNCloudStorage {
     for (let i = 1; i < directoryTree.length; i++) {
       const currentDirectory = files.find((f) => f.id === currentDirectoryId);
       if (!currentDirectory)
-        throw new NativeStorageError(
+        throw new CloudStorageError(
           `Could not find directory with id ${currentDirectoryId}`,
-          NativeStorageErrorCode.DIRECTORY_NOT_FOUND
+          CloudStorageErrorCode.DIRECTORY_NOT_FOUND
         );
       const nextDirectory = files.find((f) => f.name === directoryTree[i] && f.parents![0] === currentDirectoryId);
       if (!nextDirectory)
-        throw new NativeStorageError(
+        throw new CloudStorageError(
           `Could not find directory with name ${directoryTree[i]}`,
-          NativeStorageErrorCode.DIRECTORY_NOT_FOUND
+          CloudStorageErrorCode.DIRECTORY_NOT_FOUND
         );
       currentDirectoryId = nextDirectory.id;
     }
@@ -107,7 +107,7 @@ class GoogleDriveApiClient implements NativeRNCloudStorage {
     return currentDirectoryId;
   }
 
-  private async listFiles(scope: NativeRNCloudStorageScope): Promise<GoogleDriveFile[]> {
+  private async listFiles(scope: NativeRNCloudCloudStorageScope): Promise<GoogleDriveFile[]> {
     const files: GoogleDriveListOperationResponse = await GoogleDriveApiClient.drive.files.list({
       spaces: [this.getRootDirectory(scope)],
       fields: 'files(id,kind,mimeType,name,parents,spaces)',
@@ -116,7 +116,7 @@ class GoogleDriveApiClient implements NativeRNCloudStorage {
     return files.files;
   }
 
-  private async getFileId(path: string, scope: NativeRNCloudStorageScope): Promise<string> {
+  private async getFileId(path: string, scope: NativeRNCloudCloudStorageScope): Promise<string> {
     const files = await this.listFiles(scope);
     const { directories, filename } = this.resolvePathToDirectories(path);
     const parentDirectoryId = this.findParentDirectoryId(files, directories);
@@ -128,21 +128,26 @@ class GoogleDriveApiClient implements NativeRNCloudStorage {
     } else {
       file = files.find((f) => f.name === filename && f.parents![0] === parentDirectoryId);
     }
-    if (!file) throw new NativeStorageError(`File not found`, NativeStorageErrorCode.FILE_NOT_FOUND);
+    if (!file) throw new CloudStorageError(`File not found`, CloudStorageErrorCode.FILE_NOT_FOUND);
     return file.id;
   }
 
-  async fileExists(path: string, scope: NativeRNCloudStorageScope): Promise<boolean> {
+  async fileExists(path: string, scope: NativeRNCloudCloudStorageScope): Promise<boolean> {
     try {
       await this.getFileId(path, scope);
       return true;
     } catch (e: any) {
-      if (e instanceof NativeStorageError && e.code === NativeStorageErrorCode.FILE_NOT_FOUND) return false;
+      if (e instanceof CloudStorageError && e.code === CloudStorageErrorCode.FILE_NOT_FOUND) return false;
       else throw e;
     }
   }
 
-  async createFile(path: string, data: string, scope: NativeRNCloudStorageScope, overwrite: boolean): Promise<void> {
+  async createFile(
+    path: string,
+    data: string,
+    scope: NativeRNCloudCloudStorageScope,
+    overwrite: boolean
+  ): Promise<void> {
     let fileId: string | undefined;
     if (overwrite) {
       try {
@@ -169,18 +174,18 @@ class GoogleDriveApiClient implements NativeRNCloudStorage {
     await uploader.execute();
   }
 
-  async readFile(path: string, scope: NativeRNCloudStorageScope): Promise<string> {
+  async readFile(path: string, scope: NativeRNCloudCloudStorageScope): Promise<string> {
     const fileId = await this.getFileId(path, scope);
     const content = await GoogleDriveApiClient.drive.files.getText(fileId);
     return content;
   }
 
-  async deleteFile(path: string, scope: NativeRNCloudStorageScope): Promise<void> {
+  async deleteFile(path: string, scope: NativeRNCloudCloudStorageScope): Promise<void> {
     const fileId = await this.getFileId(path, scope);
     await GoogleDriveApiClient.drive.files.delete(fileId);
   }
 
-  async statFile(path: string, scope: NativeRNCloudStorageScope): Promise<NativeRNCloudStorageFileStat> {
+  async statFile(path: string, scope: NativeRNCloudCloudStorageScope): Promise<NativeRNCloudCloudStorageFileStat> {
     const fileId = await this.getFileId(path, scope);
     const file: GoogleDriveDetailedFile = await GoogleDriveApiClient.drive.files.get(fileId, {
       fields: 'id,kind,mimeType,name,parents,spaces,size,createdTime,modifiedTime',

package/src/hooks/useCloudFile.ts

@@ -1,8 +1,8 @@
-import type { StorageScope } from '../types/main';
+import type { CloudStorageScope } from '../types/main';
 import RNCloudStorage from '../RNCloudStorage';
 import { useCallback, useEffect, useState } from 'react';
 
-export const useCloudFile = (path: string, scope: StorageScope) => {
+export const useCloudFile = (path: string, scope: CloudStorageScope) => {
   const [content, setContent] = useState<string | null>(null);
 
   const read = useCallback(async () => {

package/src/hooks/useIsCloudAvailable.ts

@@ -3,23 +3,28 @@ import { Platform } from 'react-native';
 import RNCloudStorage from '../RNCloudStorage';
 
 // TODO: there must be a better way to do this without a timeout?
-export const useIsCloudAvailable = (timeout = 10) => {
-  const [isCloudAvailable, setIsCloudAvailable] = useState(Platform.OS !== 'ios');
-  const [firstCheck] = useState(new Date());
+export const useIsCloudAvailable = (iCloudTimeout = 10) => {
+  const [isAvailable, setIsAvailable] = useState(false);
 
   useEffect(() => {
-    const checkCloudAvailability = async () => {
-      const isAvailable = await RNCloudStorage.isCloudAvailable();
-      if (isAvailable) {
-        setIsCloudAvailable(true);
-      } else if (new Date().getTime() - firstCheck.getTime() < timeout * 1000) {
-        setTimeout(checkCloudAvailability, 500);
-      } else {
-        console.log('Cloud storage is not available.');
+    const interval = setInterval(async () => {
+      const newIsAvailable = await RNCloudStorage.isCloudAvailable();
+      setIsAvailable(newIsAvailable);
+      if (Platform.OS === 'ios' && newIsAvailable) {
+        console.log('Stopped because iCloud became available');
+        clearInterval(interval);
       }
-    };
-    checkCloudAvailability();
-  }, [firstCheck, timeout]);
+    }, 500);
 
-  return isCloudAvailable;
+    if (Platform.OS === 'ios') {
+      setTimeout(() => {
+        console.log('Stopped because of timeout');
+        clearInterval(interval);
+      }, iCloudTimeout * 1000);
+    }
+
+    return () => clearInterval(interval);
+  }, [iCloudTimeout]);
+
+  return isAvailable;
 };

package/src/index.ts

@@ -1,10 +1,10 @@
 import RNCloudStorage from './RNCloudStorage';
-import { NativeStorageErrorCode } from './types/native';
+import { CloudStorageErrorCode } from './types/native';
 export * from './types/main';
 export * from './hooks/useCloudFile';
 export * from './hooks/useIsCloudAvailable';
-import NativeStorageError from './utils/NativeStorageError';
+import CloudStorageError from './utils/CloudStorageError';
 
-export { NativeStorageError };
-export { NativeStorageErrorCode };
+export { CloudStorageError };
+export { CloudStorageErrorCode };
 export default RNCloudStorage;

package/src/types/main.ts

@@ -1,9 +1,9 @@
-export enum StorageScope {
+export enum CloudStorageScope {
   Documents = 'documents',
   AppData = 'app_data',
 }
 
-export interface StorageFileStat {
+export interface CloudStorageFileStat {
   size: number;
   birthtimeMs: number;
   mtimeMs: number;

package/src/types/native.ts

@@ -1,6 +1,6 @@
-export type NativeRNCloudStorageScope = 'documents' | 'app_data';
+export type NativeRNCloudCloudStorageScope = 'documents' | 'app_data';
 
-export interface NativeRNCloudStorageFileStat {
+export interface NativeRNCloudCloudStorageFileStat {
   size: number;
   birthtimeMs: number;
   mtimeMs: number;
@@ -8,7 +8,7 @@ export interface NativeRNCloudStorageFileStat {
   isFile: boolean;
 }
 
-export enum NativeStorageErrorCode {
+export enum CloudStorageErrorCode {
   FILE_NOT_FOUND = 'ERR_FILE_NOT_FOUND',
   DIRECTORY_NOT_FOUND = 'ERR_NO_DIRECTORY_FOUND',
   FILE_ALREADY_EXISTS = 'ERR_FILE_EXISTS',
@@ -21,10 +21,10 @@ export enum NativeStorageErrorCode {
 }
 
 export default interface NativeRNCloudStorage {
-  fileExists: (path: string, scope: NativeRNCloudStorageScope) => Promise<boolean>;
-  createFile: (path: string, data: string, scope: NativeRNCloudStorageScope, overwrite: boolean) => Promise<void>;
-  readFile: (path: string, scope: NativeRNCloudStorageScope) => Promise<string>;
-  deleteFile: (path: string, scope: NativeRNCloudStorageScope) => Promise<void>;
-  statFile: (path: string, scope: NativeRNCloudStorageScope) => Promise<NativeRNCloudStorageFileStat>;
+  fileExists: (path: string, scope: NativeRNCloudCloudStorageScope) => Promise<boolean>;
+  createFile: (path: string, data: string, scope: NativeRNCloudCloudStorageScope, overwrite: boolean) => Promise<void>;
+  readFile: (path: string, scope: NativeRNCloudCloudStorageScope) => Promise<string>;
+  deleteFile: (path: string, scope: NativeRNCloudCloudStorageScope) => Promise<void>;
+  statFile: (path: string, scope: NativeRNCloudCloudStorageScope) => Promise<NativeRNCloudCloudStorageFileStat>;
   isCloudAvailable: () => Promise<boolean>;
 }

package/src/utils/CloudStorageError.ts

@@ -0,0 +1,14 @@
+import type { CloudStorageErrorCode } from '../types/native';
+
+class CloudStorageError extends Error {
+  code: CloudStorageErrorCode;
+  details?: any;
+
+  constructor(message: string, code: CloudStorageErrorCode, details?: any) {
+    super(message);
+    this.code = code;
+    this.details = details;
+  }
+}
+
+export default CloudStorageError;

package/lib/commonjs/utils/NativeStorageError.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["NativeStorageError","Error","constructor","message","code","details","_default","exports","default"],"sourceRoot":"../../../src","sources":["utils/NativeStorageError.ts"],"mappings":";;;;;;AAEA,MAAMA,kBAAkB,SAASC,KAAK,CAAC;EAIrCC,WAAWA,CAACC,OAAe,EAAEC,IAA4B,EAAEC,OAAa,EAAE;IACxE,KAAK,CAACF,OAAO,CAAC;IACd,IAAI,CAACC,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,OAAO,GAAGA,OAAO;EACxB;AACF;AAAC,IAAAC,QAAA,GAEcN,kBAAkB;AAAAO,OAAA,CAAAC,OAAA,GAAAF,QAAA"}

package/lib/module/utils/NativeStorageError.js

@@ -1,9 +0,0 @@
-class NativeStorageError extends Error {
-  constructor(message, code, details) {
-    super(message);
-    this.code = code;
-    this.details = details;
-  }
-}
-export default NativeStorageError;
-//# sourceMappingURL=NativeStorageError.js.map

package/lib/module/utils/NativeStorageError.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["NativeStorageError","Error","constructor","message","code","details"],"sourceRoot":"../../../src","sources":["utils/NativeStorageError.ts"],"mappings":"AAEA,MAAMA,kBAAkB,SAASC,KAAK,CAAC;EAIrCC,WAAWA,CAACC,OAAe,EAAEC,IAA4B,EAAEC,OAAa,EAAE;IACxE,KAAK,CAACF,OAAO,CAAC;IACd,IAAI,CAACC,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,OAAO,GAAGA,OAAO;EACxB;AACF;AAEA,eAAeL,kBAAkB"}

package/lib/typescript/utils/NativeStorageError.d.ts

@@ -1,8 +0,0 @@
-import type { NativeStorageErrorCode } from '../types/native';
-declare class NativeStorageError extends Error {
-    code: NativeStorageErrorCode;
-    details?: any;
-    constructor(message: string, code: NativeStorageErrorCode, details?: any);
-}
-export default NativeStorageError;
-//# sourceMappingURL=NativeStorageError.d.ts.map

package/lib/typescript/utils/NativeStorageError.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NativeStorageError.d.ts","sourceRoot":"","sources":["../../../src/utils/NativeStorageError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAE9D,cAAM,kBAAmB,SAAQ,KAAK;IACpC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,OAAO,CAAC,EAAE,GAAG,CAAC;gBAEF,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,GAAG;CAKzE;AAED,eAAe,kBAAkB,CAAC"}

package/src/utils/NativeStorageError.ts

@@ -1,14 +0,0 @@
-import type { NativeStorageErrorCode } from '../types/native';
-
-class NativeStorageError extends Error {
-  code: NativeStorageErrorCode;
-  details?: any;
-
-  constructor(message: string, code: NativeStorageErrorCode, details?: any) {
-    super(message);
-    this.code = code;
-    this.details = details;
-  }
-}
-
-export default NativeStorageError;