feat: Add aws-s3 driver (http)

.gitignore

@@ -9,4 +9,6 @@ tmp
 /test.*
 __*
 .vercel
-.netlify
+.netlify
+playground
+.env

docs/content/6.drivers/s3.md

@@ -0,0 +1,37 @@
+# S3
+
+This driver allows data storage to Amazon S3 compatible providers. The data can be KV for document storage or Binary for file storage. It implements a direct HTTP client for a lightweight bundle size and compatibility with edge environments such as Cloudflare Workers and Netlify Edge Functions.
+
+#### Setup
+
+To start please make sure to create a Bucket and an access key with permissions for Object Read & Write. This key will be used for the following object-level operations [HeadObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html), [ListObjectsV2](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html), [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html), [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html), [DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html), [DeleteObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html).
+
+Then please make sure to set the driver's options.
+
+```ts
+import { createStorage } from "unstorage";
+import s3Driver from "unstorage/drivers/s3";
+
+const storage = createStorage({
+ driver: s3Driver({
+ accessKeyId: "", // The client id or access key id
+ secretAccessKey: "", // The client secret or access key secret
+ accountId: "", // The account ID (optional)
+ bucket: "", // The bucket name
+ endpoint: "", // The bucket endpoint
+ region: "", // The bucket region
+ }),
+});
+```
+
+#### Usage
+
+This driver supports the following methods
+
+- `getItem`/`getItemRaw` To retreive KV or Binary data respectively. Note that the internal response headers can be retreived from `headers` option.
+- `setItem`/`setItemRaw` To upload KV or Binary data respectively. Note that the internal request headers can be extended by `headers` option. On `setItemRaw` it's recommended to set `Content-Length` and `Content-Type` headers as they may not be automatically resolved by the provider.
+- `removeItem` To delete a single Object.
+- `clear` To delete multiple Objects. Note that if `accountId` config option is provided then **DeleteObjects** operation is performed. Otherwise multiple **DeleteObject** operations are performed. This is because **DeleteObjects** operation may not be supported by the provider.
+- `getMeta` To retreive the user-defined metadata. Note that `setMeta` is not supported because metadata can only be set on upload (`setItem`/`setItemRaw`) via `meta` option.
+- `getKeys` Gets the keys of objects in a specific folder.
+- `hasItem` Checks if Object exists.

package.json

@@ -44,16 +44,19 @@
  },
  "dependencies": {
  "anymatch": "^3.1.3",
+ "aws4fetch": "^1.0.17",
  "chokidar": "^3.5.3",
  "destr": "^2.0.2",
  "h3": "^1.9.0",
  "ioredis": "^5.3.2",
+ "jstoxml": "^3.2.10",
  "listhen": "^1.5.5",
  "lru-cache": "^10.1.0",
  "mri": "^1.2.0",
  "node-fetch-native": "^1.4.1",
  "ofetch": "^1.3.3",
- "ufo": "^1.3.2"
+ "ufo": "^1.3.2",
+ "xml2js": "^0.6.2"
  },
  "devDependencies": {
  "@azure/app-configuration": "^1.5.0",
@@ -68,8 +71,10 @@
  "@planetscale/database": "^1.13.0",
  "@types/ioredis-mock": "^8.2.5",
  "@types/jsdom": "^21.1.6",
+ "@types/jstoxml": "^2.0.4",
  "@types/mri": "^1.1.5",
  "@types/node": "^20.10.5",
+ "@types/xml2js": "^0.4.14",
  "@upstash/redis": "^1.25.2",
  "@vercel/kv": "^0.2.4",
  "@vitejs/plugin-vue": "^4.5.2",