react-native-cloud-storage 0.7.0 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-cloud-storage",
-  "version": "0.7.0",
+  "version": "1.0.1",
   "description": "Save to & read from iCloud and Google Drive using React Native",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -29,34 +29,35 @@
   ],
   "scripts": {
     "test": "jest",
+    "example": "yarn workspace react-native-cloud-storage-example",
+    "docs": "yarn workspace react-native-cloud-storage-docs",
     "typecheck": "tsc --noEmit",
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
-    "prepack": "bob build",
-    "release": "release-it",
-    "example": "yarn --cwd example",
-    "docs": "yarn --cwd docs",
-    "bootstrap": "yarn example && yarn docs && yarn install && yarn example pods",
-    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build"
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
+    "release": "release-it"
   },
   "keywords": [
     "react-native",
     "ios",
     "android"
   ],
-  "repository": "https://github.com/kuatsu/react-native-cloud-storage",
-  "author": "Kuatsu Digital Agency <hello@kuatsu.de> (https://github.com/kuatsu)",
+  "repository": "https://github.com/Kuatsu/react-native-cloud-storage",
+  "author": "Kuatsu App Agency <hello@kuatsu.de> (https://github.com/Kuatsu)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/kuatsu/react-native-cloud-storage/issues"
+    "url": "https://github.com/Kuatsu/react-native-cloud-storage/issues"
   },
-  "homepage": "https://github.com/kuatsu/react-native-cloud-storage#readme",
+  "homepage": "https://github.com/Kuatsu/react-native-cloud-storage#readme",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^17.0.2",
-    "@evilmartians/lefthook": "^1.2.2",
-    "@react-native-community/eslint-config": "^3.0.2",
+    "@evilmartians/lefthook": "^1.5.0",
+    "@expo/config-plugins": "^7.2.5",
+    "@react-native-community/eslint-config": "^3.2.0",
+    "@react-native/eslint-config": "^0.72.2",
     "@release-it/conventional-changelog": "^5.0.0",
     "@types/jest": "^28.1.2",
     "@types/react": "~17.0.21",
@@ -66,21 +67,20 @@
     "eslint": "^8.4.1",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "expo": "^47.0.0",
     "jest": "^28.1.1",
     "pod-install": "^0.1.0",
     "prettier": "^2.0.5",
     "react": "18.2.0",
-    "react-native": "0.71.6",
-    "react-native-builder-bob": "^0.20.4",
+    "react-native": "0.72.5",
+    "react-native-builder-bob": "^0.20.0",
     "release-it": "^15.0.0",
-    "typescript": "^4.5.2"
+    "typescript": "^5.0.2"
   },
   "resolutions": {
     "@types/react": "17.0.21"
   },
   "peerDependencies": {
-    "expo": ">=47.0.0",
+    "expo": ">=48.0.0",
     "react": "*",
     "react-native": "*"
   },
@@ -89,10 +89,14 @@
       "optional": true
     }
   },
+  "workspaces": [
+    "example",
+    "docs"
+  ],
   "engines": {
-    "node": ">= 16.0.0"
+    "node": ">= 18.0.0"
   },
-  "packageManager": "^yarn@1.22.15",
+  "packageManager": "yarn@3.6.1",
   "jest": {
     "preset": "react-native",
     "modulePathIgnorePatterns": [

package/react-native-cloud-storage.podspec

@@ -12,10 +12,15 @@ Pod::Spec.new do |s|
   s.authors      = package["author"]
 
   s.platforms    = { :ios => "11.0" }
-  s.source       = { :git => "https://github.com/kuatsu/react-native-cloud-storage.git", :tag => "#{s.version}" }
+  s.source       = { :git => "https://github.com/Kuatsu/react-native-cloud-storage.git", :tag => "#{s.version}" }
 
   s.source_files = "ios/**/*.{h,m,mm,swift}"
 
+  # Use install_modules_dependencies helper to install the dependencies if React Native version >=0.71.0.
+  # See https://github.com/facebook/react-native/blob/febf6b7f33fdb4904669f99d795eba4c0f95d7bf/scripts/cocoapods/new_architecture.rb#L79.
+  if respond_to?(:install_modules_dependencies, true)
+    install_modules_dependencies(s)
+  else
   s.dependency "React-Core"
 
   # Don't install the dependencies when we run `pod install` in the old architecture.
@@ -31,5 +36,6 @@ Pod::Spec.new do |s|
     s.dependency "RCTRequired"
     s.dependency "RCTTypeSafety"
     s.dependency "ReactCommon/turbomodule/core"
+   end
   end
 end

package/src/RNCloudStorage.ts

@@ -1,11 +1,15 @@
 import createRNCloudStorage from './createRNCloudStorage';
 import GoogleDriveApiClient from './google-drive';
-import type { CloudStorageFileStat, CloudStorageScope } from './types/main';
+import { type CloudStorageFileStat, CloudStorageScope } from './types/main';
 import { Platform } from 'react-native';
+import { verifyLeadingSlash } from './utils/helpers';
 
 const nativeInstance = createRNCloudStorage();
+let defaultScope = CloudStorageScope.AppData;
 
 const RNCloudStorage = {
+  getDefaultScope: () => defaultScope,
+  setDefaultScope: (scope: CloudStorageScope) => (defaultScope = scope),
   getGoogleDriveAccessToken: () => GoogleDriveApiClient.accessToken,
   setGoogleDriveAccessToken: (accessToken: string) => (GoogleDriveApiClient.accessToken = accessToken),
   setThrowOnFilesWithSameName: (enable: boolean) => (GoogleDriveApiClient.throwOnFilesWithSameName = enable),
@@ -29,72 +33,72 @@ const RNCloudStorage = {
   /**
    * Tests whether or not the file at the given path exists.
    * @param path The path to test.
-   * @param scope The directory scope the path is in.
+   * @param scope The directory scope the path is in. Defaults to the set default scope.
    * @returns A promise that resolves to true if the path exists, false otherwise.
    */
-  exists: (path: string, scope: CloudStorageScope): Promise<boolean> => {
-    return nativeInstance.fileExists(path, scope);
+  exists: (path: string, scope?: CloudStorageScope): Promise<boolean> => {
+    return nativeInstance.fileExists(verifyLeadingSlash(path), scope ?? defaultScope);
   },
 
   /**
    * Writes to the file at the given path, creating it if it doesn't exist or overwriting it if it does.
    * @param path The file to write to.
    * @param data The data to write.
-   * @param scope The directory scope the path is in.
+   * @param scope The directory scope the path is in. Defaults to the set default scope.
    * @returns A promise that resolves when the file has been written.
    */
-  writeFile: (path: string, data: string, scope: CloudStorageScope): Promise<void> => {
-    return nativeInstance.createFile(path, data, scope, true);
+  writeFile: (path: string, data: string, scope?: CloudStorageScope): Promise<void> => {
+    return nativeInstance.createFile(verifyLeadingSlash(path), data, scope ?? defaultScope, true);
   },
 
   /**
    * Creates a new directory at the given path.
    * @param path The directory to create.
-   * @param scope The directory scope the path is in.
+   * @param scope The directory scope the path is in. Defaults to the set default scope.
    * @returns A promise that resolves when the directory has been created.
    */
-  mkdir: (path: string, scope: CloudStorageScope): Promise<void> => {
-    return nativeInstance.createDirectory(path, scope);
+  mkdir: (path: string, scope?: CloudStorageScope): Promise<void> => {
+    return nativeInstance.createDirectory(verifyLeadingSlash(path), scope ?? defaultScope);
   },
 
   /**
    * Lists the contents of the directory at the given path.
    * @param path The directory to list.
-   * @param scope The directory scope the path is in.
+   * @param scope The directory scope the path is in. Defaults to the set default scope.
    * @returns A promise that resolves to an array of file names, excluding '.' and '..'.
    */
-  readdir: (path: string, scope: CloudStorageScope): Promise<string[]> => {
-    return nativeInstance.listFiles(path, scope);
+  readdir: (path: string, scope?: CloudStorageScope): Promise<string[]> => {
+    return nativeInstance.listFiles(verifyLeadingSlash(path), scope ?? defaultScope);
   },
 
   /**
    * Reads the contents of the file at the given path.
    * @param path The file to read.
-   * @param scope The directory scope the path is in.
+   * @param scope The directory scope the path is in. Defaults to the set default scope.
    * @returns A promise that resolves to the contents of the file.
    */
-  readFile: (path: string, scope: CloudStorageScope): Promise<string> => {
-    return nativeInstance.readFile(path, scope);
+  readFile: (path: string, scope?: CloudStorageScope): Promise<string> => {
+    return nativeInstance.readFile(verifyLeadingSlash(path), scope ?? defaultScope);
   },
 
   /**
    * Deletes the file at the given path.
    * @param path The file to delete.
-   * @param scope The directory scope the path is in.
+   * @param scope The directory scope the path is in. Defaults to the set default scope.
    * @returns A promise that resolves when the file has been deleted.
    */
-  unlink: (path: string, scope: CloudStorageScope): Promise<void> => {
-    return nativeInstance.deleteFile(path, scope);
+  unlink: (path: string, scope?: CloudStorageScope): Promise<void> => {
+    return nativeInstance.deleteFile(verifyLeadingSlash(path), scope ?? defaultScope);
   },
 
   /**
    * Gets the size, creation time, and modification time of the file at the given path.
    * @param path The file to stat.
-   * @param scope The directory scope the path is in.
+   * @param scope The directory scope the path is in. Defaults to the set default scope.
    * @returns A promise that resolves to the CloudStorageFileStat object.
    */
-  stat: async (path: string, scope: CloudStorageScope): Promise<CloudStorageFileStat> => {
-    const native = await nativeInstance.statFile(path, scope);
+  stat: async (path: string, scope?: CloudStorageScope): Promise<CloudStorageFileStat> => {
+    const native = await nativeInstance.statFile(verifyLeadingSlash(path), scope ?? defaultScope);
 
     return {
       ...native,

package/src/expo-plugin/types/index.ts

@@ -0,0 +1,6 @@
+export interface RNCloudStorageConfigPluginOptions {
+  /**
+   * The iCloud container environment to use. Defaults to 'Production'.
+   */
+  iCloudContainerEnvironment?: 'Production' | 'Development';
+}

package/src/expo-plugin/withRNCloudStorage.ts

@@ -1,15 +1,10 @@
+import type { RNCloudStorageConfigPluginOptions } from './types';
 import withRNCloudStorageIos from './withRNCloudStorageIos';
 import type { ConfigPlugin } from '@expo/config-plugins';
 
 // Android config plugin not needed as there's no native code to configure.
 
-interface RNCloudStorageConfigPluginOptions {
-  /**
-   * The iCloud container environment to use. Defaults to 'Production'.
-   */
-  iCloudContainerEnvironment?: 'Production' | 'Development';
-}
 const withRNCloudStorage: ConfigPlugin<RNCloudStorageConfigPluginOptions> = (config, options) =>
-  withRNCloudStorageIos(config, options?.iCloudContainerEnvironment ?? 'Production');
+  withRNCloudStorageIos(config, options);
 
 export default withRNCloudStorage;

package/src/expo-plugin/withRNCloudStorageIos.ts

@@ -1,7 +1,7 @@
-import { withEntitlementsPlist, withInfoPlist, withPlugins } from '@expo/config-plugins';
-import type { ExpoConfig } from 'expo/config';
+import { withEntitlementsPlist, withInfoPlist, withPlugins, type ConfigPlugin } from '@expo/config-plugins';
+import type { RNCloudStorageConfigPluginOptions } from './types';
 
-const withRNCloudStorageInfoPlist = (config: ExpoConfig) =>
+const withRNCloudStorageInfoPlist: ConfigPlugin = (config) =>
   withInfoPlist(config, async (newConfig) => {
     if (!config.ios?.bundleIdentifier) {
       throw new Error('Missing iOS bundle identifier');
@@ -18,10 +18,7 @@ const withRNCloudStorageInfoPlist = (config: ExpoConfig) =>
     return newConfig;
   });
 
-const withRNCloudStorageEntitlementsPlist = (
-  config: ExpoConfig,
-  iCloudContainerEnvironment: 'Production' | 'Development'
-) =>
+const withRNCloudStorageEntitlementsPlist: ConfigPlugin<RNCloudStorageConfigPluginOptions> = (config, options) =>
   withEntitlementsPlist(config, async (newConfig) => {
     if (!config.ios?.bundleIdentifier) {
       throw new Error('Missing iOS bundle identifier');
@@ -29,7 +26,8 @@ const withRNCloudStorageEntitlementsPlist = (
     const entitlementsPlist = newConfig.modResults;
     entitlementsPlist['com.apple.developer.icloud-container-identifiers'] = [`iCloud.${config.ios.bundleIdentifier}`];
     entitlementsPlist['com.apple.developer.icloud-services'] = ['CloudDocuments'];
-    entitlementsPlist['com.apple.developer.icloud-container-environment'] = iCloudContainerEnvironment;
+    entitlementsPlist['com.apple.developer.icloud-container-environment'] =
+      options?.iCloudContainerEnvironment ?? 'Production';
     entitlementsPlist['com.apple.developer.ubiquity-container-identifiers'] = [`iCloud.${config.ios.bundleIdentifier}`];
     entitlementsPlist[
       'com.apple.developer.ubiquity-kvstore-identifier'
@@ -38,7 +36,7 @@ const withRNCloudStorageEntitlementsPlist = (
     return newConfig;
   });
 
-const withRNCloudStorageIos = (config: ExpoConfig, iCloudContainerEnvironment: 'Production' | 'Development') =>
-  withPlugins(config, [withRNCloudStorageInfoPlist, [withRNCloudStorageEntitlementsPlist, iCloudContainerEnvironment]]);
+const withRNCloudStorageIos: ConfigPlugin<RNCloudStorageConfigPluginOptions> = (config, options) =>
+  withPlugins(config, [withRNCloudStorageInfoPlist, [withRNCloudStorageEntitlementsPlist, options]]);
 
 export default withRNCloudStorageIos;

package/src/google-drive/index.ts

@@ -178,6 +178,17 @@ export default class GoogleDriveApiClient implements NativeRNCloudStorage {
   ): Promise<string> {
     try {
       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;

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/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',

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;
+};