/sign/s3

Signs requests to S3. Provides functions for get, list, delete and put to S3.

For public buckets you do not need to use the s3 sign in order to get or list from the bucket. See bellow for examples of how public interactions

The module requires AWS_S3_CLIENT credentials in the xyzEnv and will export as null if the credentials are not provided. The credentials consist of two parts: an access key ID and a secret access key eg: AWS_S3_CLIENT="accessKeyId=AKIAIOSFODNN7EXAMPLE&secretAccessKey=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY". Both the access key ID and secret access key together are required to authenticate your requests.

Sample requests for common S3 SDK commands. Please refer to the S3 SDK documentation for detailed information in regards to the Command methods.

let url; // URL to be signed.

// List S3 Bucket
url = `${host}/api/sign/s3?` + mapp.utils.paramString({
  command: 'ListObjectsV2Command',
  Bucket,
  Region})

// Get object from S3 Bucket
url = `${host}/api/sign/s3?` + mapp.utils.paramString({
  command: 'GetObjectCommand',
  Key, //file name
  Bucket,
  Region})

// Get object from S3 Bucket
url = `${host}/api/sign/s3?` + mapp.utils.paramString({
  command: 'PutObjectCommand',
  Key, //file name
  Bucket,
  Region})
  
// Get object from S3 Bucket
url = `${host}/api/sign/s3?` + mapp.utils.paramString({
  command: 'DeleteObjectCommand',
  Key, //file name
  Bucket,
  Region})  

// Sign URL
const signedURL = await mapp.utils.xhr({
  url,
  responseType: 'text'
})

// Public Bucket Operations (No credentials needed)
// List bucket contents
url = `https://${Bucket}.s3.${Region}.amazonaws.com?list-type=2`

// Get object
url = `https://${Bucket}.s3.${Region}.amazonaws.com/${Key}`

Note: Write operations (PUT, DELETE) are not available for public buckets.

The aws-sdk/client-s3 and aws-sdk/s3-request-presigner are optional dependencies. The require will fail and the module will export as null if these optional dependencies are not installed.