@mastra/files-sdk 0.3.1-alpha.0 → 0.3.1-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -66
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -5,26 +5,7 @@ Unified storage filesystem provider for Mastra workspaces, powered by [FilesSDK]
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install @mastra/files-sdk
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
Then install the FilesSDK adapter for your storage backend:
|
|
12
|
-
|
|
13
|
-
```bash
|
|
14
|
-
# AWS S3 / R2 / MinIO / DigitalOcean Spaces
|
|
15
|
-
npm install @aws-sdk/client-s3 @aws-sdk/s3-presigned-post @aws-sdk/s3-request-presigner
|
|
16
|
-
|
|
17
|
-
# Google Cloud Storage
|
|
18
|
-
npm install @google-cloud/storage google-auth-library
|
|
19
|
-
|
|
20
|
-
# Azure Blob Storage
|
|
21
|
-
npm install @azure/storage-blob @azure/core-auth @azure/identity
|
|
22
|
-
|
|
23
|
-
# Vercel Blob
|
|
24
|
-
npm install @vercel/blob
|
|
25
|
-
|
|
26
|
-
# Local filesystem (dev/test)
|
|
27
|
-
# No extra dependencies needed
|
|
8
|
+
npm install @mastra/files-sdk
|
|
28
9
|
```
|
|
29
10
|
|
|
30
11
|
## Usage
|
|
@@ -54,54 +35,15 @@ const agent = new Agent({
|
|
|
54
35
|
});
|
|
55
36
|
```
|
|
56
37
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
The power of FilesSDK is that you can swap storage backends by changing only the adapter import:
|
|
60
|
-
|
|
61
|
-
```typescript
|
|
62
|
-
import { Files } from 'files-sdk';
|
|
63
|
-
import { r2 } from 'files-sdk/r2';
|
|
64
|
-
|
|
65
|
-
const files = new Files({
|
|
66
|
-
adapter: r2({
|
|
67
|
-
accountId: process.env.R2_ACCOUNT_ID!,
|
|
68
|
-
accessKeyId: process.env.R2_ACCESS_KEY_ID!,
|
|
69
|
-
secretAccessKey: process.env.R2_SECRET_ACCESS_KEY!,
|
|
70
|
-
bucket: 'my-bucket',
|
|
71
|
-
}),
|
|
72
|
-
});
|
|
38
|
+
## Documentation
|
|
73
39
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
});
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
### Local filesystem for development
|
|
80
|
-
|
|
81
|
-
```typescript
|
|
82
|
-
import { Files } from 'files-sdk';
|
|
83
|
-
import { fs } from 'files-sdk/fs';
|
|
84
|
-
|
|
85
|
-
const files = new Files({
|
|
86
|
-
adapter: fs({ root: './.uploads' }),
|
|
87
|
-
});
|
|
88
|
-
|
|
89
|
-
const workspace = new Workspace({
|
|
90
|
-
filesystem: new FilesSDKFilesystem({ files }),
|
|
91
|
-
});
|
|
92
|
-
```
|
|
40
|
+
- [Vercel Files integration guide](https://mastra.ai/integrations/file-storage/vercel-files)
|
|
41
|
+
- [Workspace documentation](https://mastra.ai/docs/mastra-platform/workspaces)
|
|
93
42
|
|
|
94
|
-
##
|
|
43
|
+
## Changelog
|
|
95
44
|
|
|
96
|
-
|
|
97
|
-
| ------------- | --------- | -------- | ------------------------------------- |
|
|
98
|
-
| `files` | `Files` | Yes | Pre-configured FilesSDK instance |
|
|
99
|
-
| `id` | `string` | No | Unique filesystem ID (auto-generated) |
|
|
100
|
-
| `displayName` | `string` | No | Human-friendly name for UI |
|
|
101
|
-
| `icon` | `string` | No | Icon identifier |
|
|
102
|
-
| `description` | `string` | No | Description for UI |
|
|
103
|
-
| `readOnly` | `boolean` | No | Mount as read-only |
|
|
45
|
+
See the [package changelog](https://github.com/mastra-ai/mastra/blob/main/workspaces/files-sdk/CHANGELOG.md) for version history and release notes.
|
|
104
46
|
|
|
105
|
-
##
|
|
47
|
+
## Support
|
|
106
48
|
|
|
107
|
-
|
|
49
|
+
We have an [open community Discord](https://discord.gg/mastra-ai). Come and say hello and let us know if you have any questions or need any help getting things running.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mastra/files-sdk",
|
|
3
|
-
"version": "0.3.1-alpha.
|
|
3
|
+
"version": "0.3.1-alpha.1",
|
|
4
4
|
"description": "FilesSDK filesystem provider for Mastra workspaces — unified storage across S3, R2, GCS, Azure, Vercel Blob, and more",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -28,10 +28,10 @@
|
|
|
28
28
|
"tsdown": "0.22.9",
|
|
29
29
|
"typescript": "^7.0.2",
|
|
30
30
|
"vitest": "4.1.10",
|
|
31
|
-
"@internal/lint": "0.0.129",
|
|
32
|
-
"@internal/types-builder": "0.0.104",
|
|
33
31
|
"@internal/workspace-test-utils": "0.0.73",
|
|
34
|
-
"@
|
|
32
|
+
"@internal/types-builder": "0.0.104",
|
|
33
|
+
"@internal/lint": "0.0.129",
|
|
34
|
+
"@mastra/core": "1.64.0-alpha.7"
|
|
35
35
|
},
|
|
36
36
|
"peerDependencies": {
|
|
37
37
|
"@mastra/core": ">=1.4.0-0 <2.0.0-0"
|