React-native-presigned-s3 NPM

react-native-presigned-s3

Handles S3 PreSigned Upload/Download for folders and single files provides hooks, needs backend to deliver PreSigned post and get payloads can be mimicked in app as well but not recommended for access control. To check out expected server responses please see example/server and for simple demo app example/app

Sample

Setup

1. yarn add react-native-presigned-s3 react-native-background-upload react-native-fs @react-native-async-storage/async-storage
This Lib has peer-dependency on these 2 libs:
appGroup setup for Uploader and corresponding Apple doc
RNFS setup for background downloads RNFS Doc

Usage

First need to define S3Client and Wrap your tree with PS3Provider

const s3Client = new S3Client(handlers, {
  appGroup: 'com.example.ps3.test', // appGroup of app for background upload support https://developer.apple.com/documentation/foundation/nsfilemanager/1412643-containerurlforsecurityapplicati
  directory: 'ps3_test', // folder under RNFS.CachesDirectoryPath for local storage
  immediateDownload: true,      
  shouldPersist: false,
  persistKey: '@example_ps3_storage_key', // async storage key for presistency
  retries: 5,
});

<PS3Provider S3Client={s3Client}>
      <QueryClientProvider client={queryClient}>
        <SafeAreaProvider>
          <NavigationContainer>
            <Stack.Navigator>
              <Stack.Screen
                name="List"
                component={ListScreen}
                initialParams={{
                  path: 'home/',
                }}
                options={{
                  headerRight: listRightButton,
                }}
              />
              <Stack.Screen name="Upload" component={UploadScreen} />
            </Stack.Navigator>
          </NavigationContainer>
        </SafeAreaProvider>
      </QueryClientProvider>
    </PS3Provider>

To list files under prefix

const {files, loading, reload} = useList(prefix);

To monitor single file and manipulate it
```
const {removeFile, files, addDownload} = useList(key, {
progress: true,
});
```
Here we will get single file (assuming key provided is exact and not prefix) and will be updated if its downloaded or uploaded
To upload single file under given folder (prefix)
```
 const {addUpload} = useList(current_path); 
```
```
 addUpload(key, img.path, {
     payload: {a: 'b'}, // meta data stored in s3
     type: img.mime,
   }); 
```
as seen in example/app this will trigger usseList(prefix) and will also be monitored in seList(key) and we get realtime upload progress