@breadstone/archipel-mcp 0.0.40 → 0.0.41
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/data/guides/blob-storage.md +20 -16
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobStorageStrategy.md +197 -0
- package/data/packages/platform-blob-storage/api/Class.AzureBlobStorageStrategy.md +197 -0
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +20 -10
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +8 -8
- package/data/packages/platform-blob-storage/api/Class.BlobStorageStrategyBase.md +158 -0
- package/data/packages/platform-blob-storage/api/Class.LocalBlobStorageStrategy.md +197 -0
- package/data/packages/platform-blob-storage/api/Class.VercelBlobStorageStrategy.md +198 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +4 -4
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +5 -5
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +6 -6
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +20 -10
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +14 -14
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +5 -5
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +10 -10
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +3 -3
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +1 -1
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +1 -1
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_ACCESS_KEY_ID.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_BUCKET.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_ENDPOINT.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_REGION.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_SECRET_ACCESS_KEY.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_CONNECTION_STRING.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_CONTAINER_NAME.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.AZURE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-blob-storage/api/{Variable.BLOB_PROVIDER.md → Variable.BLOB_STORAGE_STRATEGY_TOKEN.md} +3 -3
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +5 -5
- package/data/packages/platform-blob-storage/api/Variable.LOCAL_BLOB_BASE_PATH.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.LOCAL_BLOB_BUCKET.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.LOCAL_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.PLATFORM_BLOB_STORAGE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_BUCKET.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PUBLIC_URL.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_READ_WRITE_TOKEN.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_REGION.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_URL.md +14 -0
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-blob-storage/api/index.md +26 -18
- package/data/packages/platform-blob-storage/index.md +104 -68
- package/package.json +1 -1
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +0 -196
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +0 -196
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +0 -197
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +0 -28
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +0 -68
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +0 -48
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +0 -28
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +0 -114
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +0 -28
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +0 -80
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +0 -28
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +0 -16
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +0 -12
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +0 -12
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +0 -26
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +0 -12
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Abstract Class: BlobStorageStrategyBase'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Abstract Class: BlobStorageStrategyBase
|
|
7
|
+
|
|
8
|
+
Defined in: [strategies/abstracts/BlobStorageStrategyBase.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/abstracts/BlobStorageStrategyBase.ts#L21)
|
|
9
|
+
|
|
10
|
+
Abstract base class for blob storage strategies.
|
|
11
|
+
Every concrete provider (AWS S3, Azure, Vercel, Local, etc.) must extend this class.
|
|
12
|
+
Serves as both the type contract and the NestJS DI token type reference.
|
|
13
|
+
|
|
14
|
+
## Extended by
|
|
15
|
+
|
|
16
|
+
- [`VercelBlobStorageStrategy`](Class.VercelBlobStorageStrategy)
|
|
17
|
+
- [`AzureBlobStorageStrategy`](Class.AzureBlobStorageStrategy)
|
|
18
|
+
- [`AwsS3BlobStorageStrategy`](Class.AwsS3BlobStorageStrategy)
|
|
19
|
+
- [`LocalBlobStorageStrategy`](Class.LocalBlobStorageStrategy)
|
|
20
|
+
|
|
21
|
+
## Constructors
|
|
22
|
+
|
|
23
|
+
### Constructor
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
protected new BlobStorageStrategyBase(): BlobStorageStrategyBase;
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Defined in: [strategies/abstracts/BlobStorageStrategyBase.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/abstracts/BlobStorageStrategyBase.ts#L25)
|
|
30
|
+
|
|
31
|
+
#### Returns
|
|
32
|
+
|
|
33
|
+
`BlobStorageStrategyBase`
|
|
34
|
+
|
|
35
|
+
## Properties
|
|
36
|
+
|
|
37
|
+
### defaultBucket?
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
abstract readonly optional defaultBucket?: string;
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Defined in: [strategies/abstracts/BlobStorageStrategyBase.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/abstracts/BlobStorageStrategyBase.ts#L39)
|
|
44
|
+
|
|
45
|
+
Gets the default bucket (container/directory) configured for the provider.
|
|
46
|
+
|
|
47
|
+
***
|
|
48
|
+
|
|
49
|
+
### providerId
|
|
50
|
+
|
|
51
|
+
```ts
|
|
52
|
+
abstract readonly providerId: string;
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Defined in: [strategies/abstracts/BlobStorageStrategyBase.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/abstracts/BlobStorageStrategyBase.ts#L34)
|
|
56
|
+
|
|
57
|
+
Gets the unique identifier for this storage provider.
|
|
58
|
+
|
|
59
|
+
## Methods
|
|
60
|
+
|
|
61
|
+
### createSignedUrl()?
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
optional createSignedUrl(request): Promise<string>;
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Defined in: [strategies/abstracts/BlobStorageStrategyBase.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/abstracts/BlobStorageStrategyBase.ts#L79)
|
|
68
|
+
|
|
69
|
+
Creates a signed URL for the specified blob object.
|
|
70
|
+
Not all providers support this operation.
|
|
71
|
+
|
|
72
|
+
#### Parameters
|
|
73
|
+
|
|
74
|
+
| Parameter | Type | Description |
|
|
75
|
+
| ------ | ------ | ------ |
|
|
76
|
+
| `request` | [`IBlobSignedUrlRequest`](Interface.IBlobSignedUrlRequest) | The request describing the object to link. |
|
|
77
|
+
|
|
78
|
+
#### Returns
|
|
79
|
+
|
|
80
|
+
`Promise`\<`string`\>
|
|
81
|
+
|
|
82
|
+
The generated signed URL.
|
|
83
|
+
|
|
84
|
+
***
|
|
85
|
+
|
|
86
|
+
### deleteObject()
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
abstract deleteObject(request): Promise<void>;
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Defined in: [strategies/abstracts/BlobStorageStrategyBase.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/abstracts/BlobStorageStrategyBase.ts#L69)
|
|
93
|
+
|
|
94
|
+
Deletes a blob object from the storage backend.
|
|
95
|
+
|
|
96
|
+
#### Parameters
|
|
97
|
+
|
|
98
|
+
| Parameter | Type | Description |
|
|
99
|
+
| ------ | ------ | ------ |
|
|
100
|
+
| `request` | [`IBlobDeleteRequest`](Interface.IBlobDeleteRequest) | The delete request describing the object to remove. |
|
|
101
|
+
|
|
102
|
+
#### Returns
|
|
103
|
+
|
|
104
|
+
`Promise`\<`void`\>
|
|
105
|
+
|
|
106
|
+
***
|
|
107
|
+
|
|
108
|
+
### downloadObject()
|
|
109
|
+
|
|
110
|
+
```ts
|
|
111
|
+
abstract downloadObject<TData>(request): Promise<IBlobDownloadResult<TData>>;
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Defined in: [strategies/abstracts/BlobStorageStrategyBase.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/abstracts/BlobStorageStrategyBase.ts#L61)
|
|
115
|
+
|
|
116
|
+
Downloads a blob object from the storage backend.
|
|
117
|
+
|
|
118
|
+
#### Type Parameters
|
|
119
|
+
|
|
120
|
+
| Type Parameter |
|
|
121
|
+
| ------ |
|
|
122
|
+
| `TData` |
|
|
123
|
+
|
|
124
|
+
#### Parameters
|
|
125
|
+
|
|
126
|
+
| Parameter | Type | Description |
|
|
127
|
+
| ------ | ------ | ------ |
|
|
128
|
+
| `request` | [`IBlobDownloadRequest`](Interface.IBlobDownloadRequest) | The download request describing the object to download. |
|
|
129
|
+
|
|
130
|
+
#### Returns
|
|
131
|
+
|
|
132
|
+
`Promise`\<[`IBlobDownloadResult`](Interface.IBlobDownloadResult)\<`TData`\>\>
|
|
133
|
+
|
|
134
|
+
The download result including payload and metadata.
|
|
135
|
+
|
|
136
|
+
***
|
|
137
|
+
|
|
138
|
+
### uploadObject()
|
|
139
|
+
|
|
140
|
+
```ts
|
|
141
|
+
abstract uploadObject(request): Promise<IBlobUploadResult>;
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
Defined in: [strategies/abstracts/BlobStorageStrategyBase.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/abstracts/BlobStorageStrategyBase.ts#L52)
|
|
145
|
+
|
|
146
|
+
Uploads a blob object to the storage backend.
|
|
147
|
+
|
|
148
|
+
#### Parameters
|
|
149
|
+
|
|
150
|
+
| Parameter | Type | Description |
|
|
151
|
+
| ------ | ------ | ------ |
|
|
152
|
+
| `request` | [`IBlobUploadRequest`](Interface.IBlobUploadRequest) | The upload request describing the object to upload. |
|
|
153
|
+
|
|
154
|
+
#### Returns
|
|
155
|
+
|
|
156
|
+
`Promise`\<[`IBlobUploadResult`](Interface.IBlobUploadResult)\>
|
|
157
|
+
|
|
158
|
+
The resulting upload metadata.
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: LocalBlobStorageStrategy'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: LocalBlobStorageStrategy
|
|
7
|
+
|
|
8
|
+
Defined in: [strategies/local/LocalBlobStorageStrategy.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/local/LocalBlobStorageStrategy.ts#L30)
|
|
9
|
+
|
|
10
|
+
Provides a blob storage strategy backed by the local filesystem.
|
|
11
|
+
|
|
12
|
+
## Extends
|
|
13
|
+
|
|
14
|
+
- [`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase)
|
|
15
|
+
|
|
16
|
+
## Constructors
|
|
17
|
+
|
|
18
|
+
### Constructor
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
new LocalBlobStorageStrategy(configService): LocalBlobStorageStrategy;
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Defined in: [strategies/local/LocalBlobStorageStrategy.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/local/LocalBlobStorageStrategy.ts#L48)
|
|
25
|
+
|
|
26
|
+
Initializes a new instance of the LocalBlobStorageStrategy class.
|
|
27
|
+
|
|
28
|
+
#### Parameters
|
|
29
|
+
|
|
30
|
+
| Parameter | Type | Description |
|
|
31
|
+
| ------ | ------ | ------ |
|
|
32
|
+
| `configService` | `ConfigService` | The configuration service providing environment values. |
|
|
33
|
+
|
|
34
|
+
#### Returns
|
|
35
|
+
|
|
36
|
+
`LocalBlobStorageStrategy`
|
|
37
|
+
|
|
38
|
+
#### Overrides
|
|
39
|
+
|
|
40
|
+
[`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase).[`constructor`](Class.BlobStorageStrategyBase#constructor)
|
|
41
|
+
|
|
42
|
+
## Properties
|
|
43
|
+
|
|
44
|
+
### providerId
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
readonly providerId: string = 'local';
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Defined in: [strategies/local/LocalBlobStorageStrategy.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/local/LocalBlobStorageStrategy.ts#L67)
|
|
51
|
+
|
|
52
|
+
Gets the unique identifier for this storage provider.
|
|
53
|
+
|
|
54
|
+
#### Overrides
|
|
55
|
+
|
|
56
|
+
[`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase).[`providerId`](Class.BlobStorageStrategyBase#providerid)
|
|
57
|
+
|
|
58
|
+
## Accessors
|
|
59
|
+
|
|
60
|
+
### defaultBucket
|
|
61
|
+
|
|
62
|
+
#### Get Signature
|
|
63
|
+
|
|
64
|
+
```ts
|
|
65
|
+
get defaultBucket(): string | undefined;
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Defined in: [strategies/local/LocalBlobStorageStrategy.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/local/LocalBlobStorageStrategy.ts#L70)
|
|
69
|
+
|
|
70
|
+
Gets the default bucket (container/directory) configured for the provider.
|
|
71
|
+
|
|
72
|
+
##### Returns
|
|
73
|
+
|
|
74
|
+
`string` \| `undefined`
|
|
75
|
+
|
|
76
|
+
Gets the default bucket (container/directory) configured for the provider.
|
|
77
|
+
|
|
78
|
+
#### Overrides
|
|
79
|
+
|
|
80
|
+
[`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase).[`defaultBucket`](Class.BlobStorageStrategyBase#defaultbucket)
|
|
81
|
+
|
|
82
|
+
## Methods
|
|
83
|
+
|
|
84
|
+
### createSignedUrl()?
|
|
85
|
+
|
|
86
|
+
```ts
|
|
87
|
+
optional createSignedUrl(request): Promise<string>;
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Defined in: [strategies/abstracts/BlobStorageStrategyBase.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/abstracts/BlobStorageStrategyBase.ts#L79)
|
|
91
|
+
|
|
92
|
+
Creates a signed URL for the specified blob object.
|
|
93
|
+
Not all providers support this operation.
|
|
94
|
+
|
|
95
|
+
#### Parameters
|
|
96
|
+
|
|
97
|
+
| Parameter | Type | Description |
|
|
98
|
+
| ------ | ------ | ------ |
|
|
99
|
+
| `request` | [`IBlobSignedUrlRequest`](Interface.IBlobSignedUrlRequest) | The request describing the object to link. |
|
|
100
|
+
|
|
101
|
+
#### Returns
|
|
102
|
+
|
|
103
|
+
`Promise`\<`string`\>
|
|
104
|
+
|
|
105
|
+
The generated signed URL.
|
|
106
|
+
|
|
107
|
+
#### Inherited from
|
|
108
|
+
|
|
109
|
+
[`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase).[`createSignedUrl`](Class.BlobStorageStrategyBase#createsignedurl)
|
|
110
|
+
|
|
111
|
+
***
|
|
112
|
+
|
|
113
|
+
### deleteObject()
|
|
114
|
+
|
|
115
|
+
```ts
|
|
116
|
+
deleteObject(request): Promise<void>;
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
Defined in: [strategies/local/LocalBlobStorageStrategy.ts:150](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/local/LocalBlobStorageStrategy.ts#L150)
|
|
120
|
+
|
|
121
|
+
Deletes a blob object from the storage backend.
|
|
122
|
+
|
|
123
|
+
#### Parameters
|
|
124
|
+
|
|
125
|
+
| Parameter | Type | Description |
|
|
126
|
+
| ------ | ------ | ------ |
|
|
127
|
+
| `request` | [`IBlobDeleteRequest`](Interface.IBlobDeleteRequest) | The delete request describing the object to remove. |
|
|
128
|
+
|
|
129
|
+
#### Returns
|
|
130
|
+
|
|
131
|
+
`Promise`\<`void`\>
|
|
132
|
+
|
|
133
|
+
#### Overrides
|
|
134
|
+
|
|
135
|
+
[`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase).[`deleteObject`](Class.BlobStorageStrategyBase#deleteobject)
|
|
136
|
+
|
|
137
|
+
***
|
|
138
|
+
|
|
139
|
+
### downloadObject()
|
|
140
|
+
|
|
141
|
+
```ts
|
|
142
|
+
downloadObject<TData>(request): Promise<IBlobDownloadResult<TData>>;
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Defined in: [strategies/local/LocalBlobStorageStrategy.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/local/LocalBlobStorageStrategy.ts#L112)
|
|
146
|
+
|
|
147
|
+
Downloads a blob object from the storage backend.
|
|
148
|
+
|
|
149
|
+
#### Type Parameters
|
|
150
|
+
|
|
151
|
+
| Type Parameter |
|
|
152
|
+
| ------ |
|
|
153
|
+
| `TData` |
|
|
154
|
+
|
|
155
|
+
#### Parameters
|
|
156
|
+
|
|
157
|
+
| Parameter | Type | Description |
|
|
158
|
+
| ------ | ------ | ------ |
|
|
159
|
+
| `request` | [`IBlobDownloadRequest`](Interface.IBlobDownloadRequest) | The download request describing the object to download. |
|
|
160
|
+
|
|
161
|
+
#### Returns
|
|
162
|
+
|
|
163
|
+
`Promise`\<[`IBlobDownloadResult`](Interface.IBlobDownloadResult)\<`TData`\>\>
|
|
164
|
+
|
|
165
|
+
The download result including payload and metadata.
|
|
166
|
+
|
|
167
|
+
#### Overrides
|
|
168
|
+
|
|
169
|
+
[`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase).[`downloadObject`](Class.BlobStorageStrategyBase#downloadobject)
|
|
170
|
+
|
|
171
|
+
***
|
|
172
|
+
|
|
173
|
+
### uploadObject()
|
|
174
|
+
|
|
175
|
+
```ts
|
|
176
|
+
uploadObject(request): Promise<IBlobUploadResult>;
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
Defined in: [strategies/local/LocalBlobStorageStrategy.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/local/LocalBlobStorageStrategy.ts#L79)
|
|
180
|
+
|
|
181
|
+
Uploads a blob object to the storage backend.
|
|
182
|
+
|
|
183
|
+
#### Parameters
|
|
184
|
+
|
|
185
|
+
| Parameter | Type | Description |
|
|
186
|
+
| ------ | ------ | ------ |
|
|
187
|
+
| `request` | [`IBlobUploadRequest`](Interface.IBlobUploadRequest) | The upload request describing the object to upload. |
|
|
188
|
+
|
|
189
|
+
#### Returns
|
|
190
|
+
|
|
191
|
+
`Promise`\<[`IBlobUploadResult`](Interface.IBlobUploadResult)\>
|
|
192
|
+
|
|
193
|
+
The resulting upload metadata.
|
|
194
|
+
|
|
195
|
+
#### Overrides
|
|
196
|
+
|
|
197
|
+
[`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase).[`uploadObject`](Class.BlobStorageStrategyBase#uploadobject)
|
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: VercelBlobStorageStrategy'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: VercelBlobStorageStrategy
|
|
7
|
+
|
|
8
|
+
Defined in: [strategies/vercel/VercelBlobStorageStrategy.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/vercel/VercelBlobStorageStrategy.ts#L30)
|
|
9
|
+
|
|
10
|
+
Provides a blob storage strategy backed by the Vercel Blob API.
|
|
11
|
+
|
|
12
|
+
## Extends
|
|
13
|
+
|
|
14
|
+
- [`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase)
|
|
15
|
+
|
|
16
|
+
## Constructors
|
|
17
|
+
|
|
18
|
+
### Constructor
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
new VercelBlobStorageStrategy(httpService, configService): VercelBlobStorageStrategy;
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Defined in: [strategies/vercel/VercelBlobStorageStrategy.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/vercel/VercelBlobStorageStrategy.ts#L53)
|
|
25
|
+
|
|
26
|
+
Initializes a new instance of the VercelBlobStorageStrategy class.
|
|
27
|
+
|
|
28
|
+
#### Parameters
|
|
29
|
+
|
|
30
|
+
| Parameter | Type | Description |
|
|
31
|
+
| ------ | ------ | ------ |
|
|
32
|
+
| `httpService` | `HttpService` | The HTTP service used to communicate with the Vercel Blob API. |
|
|
33
|
+
| `configService` | `ConfigService` | The configuration service providing environment values. |
|
|
34
|
+
|
|
35
|
+
#### Returns
|
|
36
|
+
|
|
37
|
+
`VercelBlobStorageStrategy`
|
|
38
|
+
|
|
39
|
+
#### Overrides
|
|
40
|
+
|
|
41
|
+
[`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase).[`constructor`](Class.BlobStorageStrategyBase#constructor)
|
|
42
|
+
|
|
43
|
+
## Properties
|
|
44
|
+
|
|
45
|
+
### providerId
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
readonly providerId: string = 'vercel';
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Defined in: [strategies/vercel/VercelBlobStorageStrategy.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/vercel/VercelBlobStorageStrategy.ts#L80)
|
|
52
|
+
|
|
53
|
+
Gets the unique identifier for this storage provider.
|
|
54
|
+
|
|
55
|
+
#### Overrides
|
|
56
|
+
|
|
57
|
+
[`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase).[`providerId`](Class.BlobStorageStrategyBase#providerid)
|
|
58
|
+
|
|
59
|
+
## Accessors
|
|
60
|
+
|
|
61
|
+
### defaultBucket
|
|
62
|
+
|
|
63
|
+
#### Get Signature
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
get defaultBucket(): string | undefined;
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Defined in: [strategies/vercel/VercelBlobStorageStrategy.ts:83](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/vercel/VercelBlobStorageStrategy.ts#L83)
|
|
70
|
+
|
|
71
|
+
Gets the default bucket (container/directory) configured for the provider.
|
|
72
|
+
|
|
73
|
+
##### Returns
|
|
74
|
+
|
|
75
|
+
`string` \| `undefined`
|
|
76
|
+
|
|
77
|
+
Gets the default bucket (container/directory) configured for the provider.
|
|
78
|
+
|
|
79
|
+
#### Overrides
|
|
80
|
+
|
|
81
|
+
[`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase).[`defaultBucket`](Class.BlobStorageStrategyBase#defaultbucket)
|
|
82
|
+
|
|
83
|
+
## Methods
|
|
84
|
+
|
|
85
|
+
### createSignedUrl()
|
|
86
|
+
|
|
87
|
+
```ts
|
|
88
|
+
createSignedUrl(request): Promise<string>;
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Defined in: [strategies/vercel/VercelBlobStorageStrategy.ts:155](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/vercel/VercelBlobStorageStrategy.ts#L155)
|
|
92
|
+
|
|
93
|
+
Creates a signed URL for the specified blob object.
|
|
94
|
+
Not all providers support this operation.
|
|
95
|
+
|
|
96
|
+
#### Parameters
|
|
97
|
+
|
|
98
|
+
| Parameter | Type | Description |
|
|
99
|
+
| ------ | ------ | ------ |
|
|
100
|
+
| `request` | [`IBlobSignedUrlRequest`](Interface.IBlobSignedUrlRequest) | The request describing the object to link. |
|
|
101
|
+
|
|
102
|
+
#### Returns
|
|
103
|
+
|
|
104
|
+
`Promise`\<`string`\>
|
|
105
|
+
|
|
106
|
+
The generated signed URL.
|
|
107
|
+
|
|
108
|
+
#### Overrides
|
|
109
|
+
|
|
110
|
+
[`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase).[`createSignedUrl`](Class.BlobStorageStrategyBase#createsignedurl)
|
|
111
|
+
|
|
112
|
+
***
|
|
113
|
+
|
|
114
|
+
### deleteObject()
|
|
115
|
+
|
|
116
|
+
```ts
|
|
117
|
+
deleteObject(request): Promise<void>;
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Defined in: [strategies/vercel/VercelBlobStorageStrategy.ts:142](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/vercel/VercelBlobStorageStrategy.ts#L142)
|
|
121
|
+
|
|
122
|
+
Deletes a blob object from the storage backend.
|
|
123
|
+
|
|
124
|
+
#### Parameters
|
|
125
|
+
|
|
126
|
+
| Parameter | Type | Description |
|
|
127
|
+
| ------ | ------ | ------ |
|
|
128
|
+
| `request` | [`IBlobDeleteRequest`](Interface.IBlobDeleteRequest) | The delete request describing the object to remove. |
|
|
129
|
+
|
|
130
|
+
#### Returns
|
|
131
|
+
|
|
132
|
+
`Promise`\<`void`\>
|
|
133
|
+
|
|
134
|
+
#### Overrides
|
|
135
|
+
|
|
136
|
+
[`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase).[`deleteObject`](Class.BlobStorageStrategyBase#deleteobject)
|
|
137
|
+
|
|
138
|
+
***
|
|
139
|
+
|
|
140
|
+
### downloadObject()
|
|
141
|
+
|
|
142
|
+
```ts
|
|
143
|
+
downloadObject<TData>(request): Promise<IBlobDownloadResult<TData>>;
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
Defined in: [strategies/vercel/VercelBlobStorageStrategy.ts:120](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/vercel/VercelBlobStorageStrategy.ts#L120)
|
|
147
|
+
|
|
148
|
+
Downloads a blob object from the storage backend.
|
|
149
|
+
|
|
150
|
+
#### Type Parameters
|
|
151
|
+
|
|
152
|
+
| Type Parameter |
|
|
153
|
+
| ------ |
|
|
154
|
+
| `TData` |
|
|
155
|
+
|
|
156
|
+
#### Parameters
|
|
157
|
+
|
|
158
|
+
| Parameter | Type | Description |
|
|
159
|
+
| ------ | ------ | ------ |
|
|
160
|
+
| `request` | [`IBlobDownloadRequest`](Interface.IBlobDownloadRequest) | The download request describing the object to download. |
|
|
161
|
+
|
|
162
|
+
#### Returns
|
|
163
|
+
|
|
164
|
+
`Promise`\<[`IBlobDownloadResult`](Interface.IBlobDownloadResult)\<`TData`\>\>
|
|
165
|
+
|
|
166
|
+
The download result including payload and metadata.
|
|
167
|
+
|
|
168
|
+
#### Overrides
|
|
169
|
+
|
|
170
|
+
[`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase).[`downloadObject`](Class.BlobStorageStrategyBase#downloadobject)
|
|
171
|
+
|
|
172
|
+
***
|
|
173
|
+
|
|
174
|
+
### uploadObject()
|
|
175
|
+
|
|
176
|
+
```ts
|
|
177
|
+
uploadObject(request): Promise<IBlobUploadResult>;
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
Defined in: [strategies/vercel/VercelBlobStorageStrategy.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/vercel/VercelBlobStorageStrategy.ts#L92)
|
|
181
|
+
|
|
182
|
+
Uploads a blob object to the storage backend.
|
|
183
|
+
|
|
184
|
+
#### Parameters
|
|
185
|
+
|
|
186
|
+
| Parameter | Type | Description |
|
|
187
|
+
| ------ | ------ | ------ |
|
|
188
|
+
| `request` | [`IBlobUploadRequest`](Interface.IBlobUploadRequest) | The upload request describing the object to upload. |
|
|
189
|
+
|
|
190
|
+
#### Returns
|
|
191
|
+
|
|
192
|
+
`Promise`\<[`IBlobUploadResult`](Interface.IBlobUploadResult)\>
|
|
193
|
+
|
|
194
|
+
The resulting upload metadata.
|
|
195
|
+
|
|
196
|
+
#### Overrides
|
|
197
|
+
|
|
198
|
+
[`BlobStorageStrategyBase`](Class.BlobStorageStrategyBase).[`uploadObject`](Class.BlobStorageStrategyBase#uploadobject)
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IBlobDeleteRequest
|
|
7
7
|
|
|
8
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
8
|
+
Defined in: [interfaces/IBlobProvider.ts:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L72)
|
|
9
9
|
|
|
10
10
|
## Properties
|
|
11
11
|
|
|
@@ -15,7 +15,7 @@ Defined in: [interfaces/IBlobProvider.ts:81](https://github.com/RueDeRennes/arch
|
|
|
15
15
|
optional bucket?: string;
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
18
|
+
Defined in: [interfaces/IBlobProvider.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L75)
|
|
19
19
|
|
|
20
20
|
***
|
|
21
21
|
|
|
@@ -25,7 +25,7 @@ Defined in: [interfaces/IBlobProvider.ts:84](https://github.com/RueDeRennes/arch
|
|
|
25
25
|
key: string;
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
28
|
+
Defined in: [interfaces/IBlobProvider.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L73)
|
|
29
29
|
|
|
30
30
|
***
|
|
31
31
|
|
|
@@ -35,4 +35,4 @@ Defined in: [interfaces/IBlobProvider.ts:82](https://github.com/RueDeRennes/arch
|
|
|
35
35
|
optional versionId?: string;
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
38
|
+
Defined in: [interfaces/IBlobProvider.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L74)
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IBlobDownloadRequest
|
|
7
7
|
|
|
8
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
8
|
+
Defined in: [interfaces/IBlobProvider.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L57)
|
|
9
9
|
|
|
10
10
|
## Properties
|
|
11
11
|
|
|
@@ -15,7 +15,7 @@ Defined in: [interfaces/IBlobProvider.ts:66](https://github.com/RueDeRennes/arch
|
|
|
15
15
|
optional bucket?: string;
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
18
|
+
Defined in: [interfaces/IBlobProvider.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L61)
|
|
19
19
|
|
|
20
20
|
***
|
|
21
21
|
|
|
@@ -25,7 +25,7 @@ Defined in: [interfaces/IBlobProvider.ts:70](https://github.com/RueDeRennes/arch
|
|
|
25
25
|
key: string;
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
28
|
+
Defined in: [interfaces/IBlobProvider.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L58)
|
|
29
29
|
|
|
30
30
|
***
|
|
31
31
|
|
|
@@ -35,7 +35,7 @@ Defined in: [interfaces/IBlobProvider.ts:67](https://github.com/RueDeRennes/arch
|
|
|
35
35
|
optional responseType?: BlobDownloadResponseType;
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
38
|
+
Defined in: [interfaces/IBlobProvider.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L60)
|
|
39
39
|
|
|
40
40
|
***
|
|
41
41
|
|
|
@@ -45,4 +45,4 @@ Defined in: [interfaces/IBlobProvider.ts:69](https://github.com/RueDeRennes/arch
|
|
|
45
45
|
optional versionId?: string;
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
48
|
+
Defined in: [interfaces/IBlobProvider.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L59)
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IBlobDownloadResult\<TData\>
|
|
7
7
|
|
|
8
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
8
|
+
Defined in: [interfaces/IBlobProvider.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L64)
|
|
9
9
|
|
|
10
10
|
## Type Parameters
|
|
11
11
|
|
|
@@ -21,7 +21,7 @@ Defined in: [interfaces/IBlobProvider.ts:73](https://github.com/RueDeRennes/arch
|
|
|
21
21
|
optional contentLength?: number;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
24
|
+
Defined in: [interfaces/IBlobProvider.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L67)
|
|
25
25
|
|
|
26
26
|
***
|
|
27
27
|
|
|
@@ -31,7 +31,7 @@ Defined in: [interfaces/IBlobProvider.ts:76](https://github.com/RueDeRennes/arch
|
|
|
31
31
|
optional contentType?: string;
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
34
|
+
Defined in: [interfaces/IBlobProvider.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L66)
|
|
35
35
|
|
|
36
36
|
***
|
|
37
37
|
|
|
@@ -41,7 +41,7 @@ Defined in: [interfaces/IBlobProvider.ts:75](https://github.com/RueDeRennes/arch
|
|
|
41
41
|
data: TData;
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
44
|
+
Defined in: [interfaces/IBlobProvider.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L65)
|
|
45
45
|
|
|
46
46
|
***
|
|
47
47
|
|
|
@@ -51,7 +51,7 @@ Defined in: [interfaces/IBlobProvider.ts:74](https://github.com/RueDeRennes/arch
|
|
|
51
51
|
optional metadata?: Record<string, string>;
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
54
|
+
Defined in: [interfaces/IBlobProvider.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L68)
|
|
55
55
|
|
|
56
56
|
***
|
|
57
57
|
|
|
@@ -61,4 +61,4 @@ Defined in: [interfaces/IBlobProvider.ts:77](https://github.com/RueDeRennes/arch
|
|
|
61
61
|
optional rawResponse?: unknown;
|
|
62
62
|
```
|
|
63
63
|
|
|
64
|
-
Defined in: [interfaces/IBlobProvider.ts:
|
|
64
|
+
Defined in: [interfaces/IBlobProvider.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L69)
|