@mastra/files-sdk 0.3.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.
Files changed (9) hide show
  1. package/LICENSE.md +6 -4
  2. package/README.md +8 -66
  3. package/dist/filesystem/index.d.ts.map +1 -1
  4. package/dist/index.cjs +435 -405
  5. package/dist/index.cjs.map +1 -1
  6. package/dist/index.js +433 -402
  7. package/dist/index.js.map +1 -1
  8. package/package.json +15 -15
  9. package/CHANGELOG.md +0 -91
package/LICENSE.md CHANGED
@@ -1,10 +1,12 @@
1
1
  Portions of this software are licensed as follows:
2
2
 
3
- - All content that resides under any directory named "ee/" within this
3
+ - All content that resides under any directory named `ee/` within this
4
4
  repository, including but not limited to:
5
- - `packages/core/src/auth/ee/`
6
- - `packages/server/src/server/auth/ee/`
7
- is licensed under the license defined in `ee/LICENSE`.
5
+ - `@mastra/core/auth/ee`
6
+ - `@mastra/core/agent-builder/ee`
7
+ - `@mastra/editor/ee`
8
+
9
+ is licensed under the license defined in [`ee/LICENSE`](https://github.com/mastra-ai/mastra/blob/main/ee/LICENSE).
8
10
 
9
11
  - All third-party components incorporated into the Mastra Software are
10
12
  licensed under the original license provided by the owner of the
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 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
- ### Switching adapters
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
- const workspace = new Workspace({
75
- filesystem: new FilesSDKFilesystem({ files }),
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
- ## Options
43
+ ## Changelog
95
44
 
96
- | Option | Type | Required | Description |
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
- ## License
47
+ ## Support
106
48
 
107
- Apache-2.0
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/dist/filesystem/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/filesystem/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,QAAQ,EACR,SAAS,EACT,WAAW,EACX,YAAY,EACZ,WAAW,EACX,aAAa,EACb,WAAW,EACX,cAAc,EACd,cAAc,EACd,cAAc,EACd,uBAAuB,EACxB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,gBAAgB,EAKjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,KAAK,EAA+B,MAAM,WAAW,CAAC;AAMpE,MAAM,WAAW,yBAA0B,SAAQ,uBAAuB;IACxE,gDAAgD;IAChD,KAAK,EAAE,KAAK,CAAC;IACb,6DAA6D;IAC7D,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAmHD;;;;;;;;;;;GAWG;AACH,qBAAa,kBAAmB,SAAQ,gBAAgB;IACtD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,wBAAwB;IACrC,QAAQ,CAAC,QAAQ,eAAe;IAChC,MAAM,EAAE,cAAc,CAAa;IAEnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC;IAC/B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;gBAEnB,OAAO,EAAE,yBAAyB;IAW9C,iEAAiE;IACjE,IAAI,KAAK,IAAI,KAAK,CAEjB;IAMc,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAcpC,OAAO,IAAI,cAAc;IAezB,eAAe,IAAI,MAAM;IAYnB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;IAevE,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB1F;;;;;;;;;OASG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB7D,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IA8BhE,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBzE,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAWzE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAMvE,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IA6B3D,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAgGlE,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAuBtC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IA6C3C,OAAO,CAAC,cAAc;IAMtB,2EAA2E;YAC7D,WAAW;IAOzB;;;;OAIG;YACW,MAAM;IAMpB,0DAA0D;IAC1D,OAAO,CAAC,gBAAgB;CAWzB"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/filesystem/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,QAAQ,EACR,SAAS,EACT,WAAW,EACX,YAAY,EACZ,WAAW,EACX,aAAa,EACb,WAAW,EACX,cAAc,EACd,cAAc,EACd,cAAc,EACd,uBAAuB,EACxB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,gBAAgB,EAKjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,KAAK,EAA+B,MAAM,WAAW,CAAC;AAMpE,MAAM,WAAW,yBAA0B,SAAQ,uBAAuB;IACxE,gDAAgD;IAChD,KAAK,EAAE,KAAK,CAAC;IACb,6DAA6D;IAC7D,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAmHD;;;;;;;;;;;GAWG;AACH,qBAAa,kBAAmB,SAAQ,gBAAgB;IACtD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,wBAAwB;IACrC,QAAQ,CAAC,QAAQ,eAAe;IAChC,MAAM,EAAE,cAAc,CAAa;IAEnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC;IAC/B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAE/B,YAAY,OAAO,EAAE,yBAAyB,EAS7C;IAED,iEAAiE;IACjE,IAAI,KAAK,IAAI,KAAK,CAEjB;IAMc,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAUnC;IAID,OAAO,IAAI,cAAc,CAaxB;IAED,eAAe,IAAI,MAAM,CAMxB;IAMK,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAa5E;IAEK,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAgBzF;IAED;;;;;;;;;OASG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAqBlE;IAEK,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CA4BrE;IAEK,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAgB9E;IAEK,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAK9E;IAMK,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAI5E;IAEK,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CA2BhE;IAEK,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CA0FvE;IAMK,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAqB3C;IAEK,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAuC1C;IAMD,OAAO,CAAC,cAAc;IAMtB,2EAA2E;YAC7D,WAAW;IAOzB;;;;OAIG;YACW,MAAM;IAMpB,0DAA0D;IAC1D,OAAO,CAAC,gBAAgB;CAWzB"}