@breadstone/archipel-mcp 0.0.39 → 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.
Files changed (61) hide show
  1. package/data/guides/blob-storage.md +20 -16
  2. package/data/packages/platform-blob-storage/api/Class.AwsS3BlobStorageStrategy.md +197 -0
  3. package/data/packages/platform-blob-storage/api/Class.AzureBlobStorageStrategy.md +197 -0
  4. package/data/packages/platform-blob-storage/api/Class.BlobModule.md +20 -10
  5. package/data/packages/platform-blob-storage/api/Class.BlobService.md +8 -8
  6. package/data/packages/platform-blob-storage/api/Class.BlobStorageStrategyBase.md +158 -0
  7. package/data/packages/platform-blob-storage/api/Class.LocalBlobStorageStrategy.md +197 -0
  8. package/data/packages/platform-blob-storage/api/Class.VercelBlobStorageStrategy.md +198 -0
  9. package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +4 -4
  10. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +5 -5
  11. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +6 -6
  12. package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +20 -10
  13. package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +14 -14
  14. package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +5 -5
  15. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +10 -10
  16. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +3 -3
  17. package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +1 -1
  18. package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +1 -1
  19. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_ACCESS_KEY_ID.md +14 -0
  20. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_BUCKET.md +14 -0
  21. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_CONFIG_ENTRIES.md +14 -0
  22. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_ENDPOINT.md +14 -0
  23. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_REGION.md +14 -0
  24. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_SECRET_ACCESS_KEY.md +14 -0
  25. package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_CONNECTION_STRING.md +14 -0
  26. package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_CONTAINER_NAME.md +14 -0
  27. package/data/packages/platform-blob-storage/api/Variable.AZURE_CONFIG_ENTRIES.md +14 -0
  28. package/data/packages/platform-blob-storage/api/{Variable.BLOB_PROVIDER.md → Variable.BLOB_STORAGE_STRATEGY_TOKEN.md} +3 -3
  29. package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +5 -5
  30. package/data/packages/platform-blob-storage/api/Variable.LOCAL_BLOB_BASE_PATH.md +14 -0
  31. package/data/packages/platform-blob-storage/api/Variable.LOCAL_BLOB_BUCKET.md +14 -0
  32. package/data/packages/platform-blob-storage/api/Variable.LOCAL_CONFIG_ENTRIES.md +14 -0
  33. package/data/packages/platform-blob-storage/api/Variable.PLATFORM_BLOB_STORAGE_CONFIG_ENTRIES.md +14 -0
  34. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_BUCKET.md +14 -0
  35. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PUBLIC_URL.md +14 -0
  36. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_READ_WRITE_TOKEN.md +14 -0
  37. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_REGION.md +14 -0
  38. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_URL.md +14 -0
  39. package/data/packages/platform-blob-storage/api/Variable.VERCEL_CONFIG_ENTRIES.md +14 -0
  40. package/data/packages/platform-blob-storage/api/index.md +26 -18
  41. package/data/packages/platform-blob-storage/index.md +104 -68
  42. package/data/packages/platform-core/api/Class.ProblemDetailResponse.md +115 -0
  43. package/data/packages/platform-core/api/index.md +1 -0
  44. package/data/packages/platform-openapi/api/Function.Api.md +1 -1
  45. package/package.json +1 -1
  46. package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +0 -196
  47. package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +0 -196
  48. package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +0 -197
  49. package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +0 -28
  50. package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +0 -68
  51. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +0 -48
  52. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +0 -28
  53. package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +0 -114
  54. package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +0 -28
  55. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +0 -80
  56. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +0 -28
  57. package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +0 -16
  58. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +0 -12
  59. package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +0 -12
  60. package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +0 -26
  61. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +0 -12
package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md CHANGED
@@ -5,44 +5,54 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IBlobModuleOptions
7
7
 
8
- Defined in: [BlobModule.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L34)
8
+ Defined in: [BlobModule.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L19)
9
9
 
10
10
  ## Properties
11
11
 
12
+ ### configEntries?
13
+
14
+ ```ts
15
+ readonly optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
16
+ ```
17
+
18
+ Defined in: [BlobModule.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L22)
19
+
20
+ ***
21
+
12
22
  ### isGlobal?
13
23
 
14
24
  ```ts
15
- optional isGlobal?: boolean;
25
+ readonly optional isGlobal?: boolean;
16
26
  ```
17
27
 
18
- Defined in: [BlobModule.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L38)
28
+ Defined in: [BlobModule.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L21)
19
29
 
20
30
  ***
21
31
 
22
32
  ### objectPersistence?
23
33
 
24
34
  ```ts
25
- optional objectPersistence?: Type<BlobObjectPersistencePort>;
35
+ readonly optional objectPersistence?: Type<BlobObjectPersistencePort>;
26
36
  ```
27
37
 
28
- Defined in: [BlobModule.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L36)
38
+ Defined in: [BlobModule.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L23)
29
39
 
30
40
  ***
31
41
 
32
- ### provider?
42
+ ### storageStrategy
33
43
 
34
44
  ```ts
35
- optional provider?: IBlobProviderRegistration;
45
+ readonly storageStrategy: Type<BlobStorageStrategyBase>;
36
46
  ```
37
47
 
38
- Defined in: [BlobModule.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L35)
48
+ Defined in: [BlobModule.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L20)
39
49
 
40
50
  ***
41
51
 
42
52
  ### variantPersistence?
43
53
 
44
54
  ```ts
45
- optional variantPersistence?: Type<BlobVariantPersistencePort>;
55
+ readonly optional variantPersistence?: Type<BlobVariantPersistencePort>;
46
56
  ```
47
57
 
48
- Defined in: [BlobModule.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L37)
58
+ Defined in: [BlobModule.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L24)
package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md CHANGED
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IBlobObjectMetadata
7
7
 
8
- Defined in: [interfaces/IBlobProvider.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L33)
8
+ Defined in: [interfaces/IBlobProvider.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L24)
9
9
 
10
10
  ## Properties
11
11
 
@@ -15,7 +15,7 @@ Defined in: [interfaces/IBlobProvider.ts:33](https://github.com/RueDeRennes/arch
15
15
  bucket: string;
16
16
  ```
17
17
 
18
- Defined in: [interfaces/IBlobProvider.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L35)
18
+ Defined in: [interfaces/IBlobProvider.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L26)
19
19
 
20
20
  ***
21
21
 
@@ -25,7 +25,7 @@ Defined in: [interfaces/IBlobProvider.ts:35](https://github.com/RueDeRennes/arch
25
25
  optional checksumSha256?: string;
26
26
  ```
27
27
 
28
- Defined in: [interfaces/IBlobProvider.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L42)
28
+ Defined in: [interfaces/IBlobProvider.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L33)
29
29
 
30
30
  ***
31
31
 
@@ -35,7 +35,7 @@ Defined in: [interfaces/IBlobProvider.ts:42](https://github.com/RueDeRennes/arch
35
35
  contentType: string;
36
36
  ```
37
37
 
38
- Defined in: [interfaces/IBlobProvider.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L40)
38
+ Defined in: [interfaces/IBlobProvider.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L31)
39
39
 
40
40
  ***
41
41
 
@@ -45,7 +45,7 @@ Defined in: [interfaces/IBlobProvider.ts:40](https://github.com/RueDeRennes/arch
45
45
  optional etag?: string;
46
46
  ```
47
47
 
48
- Defined in: [interfaces/IBlobProvider.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L41)
48
+ Defined in: [interfaces/IBlobProvider.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L32)
49
49
 
50
50
  ***
51
51
 
@@ -55,7 +55,7 @@ Defined in: [interfaces/IBlobProvider.ts:41](https://github.com/RueDeRennes/arch
55
55
  isLatest: boolean;
56
56
  ```
57
57
 
58
- Defined in: [interfaces/IBlobProvider.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L45)
58
+ Defined in: [interfaces/IBlobProvider.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L36)
59
59
 
60
60
  ***
61
61
 
@@ -65,7 +65,7 @@ Defined in: [interfaces/IBlobProvider.ts:45](https://github.com/RueDeRennes/arch
65
65
  key: string;
66
66
  ```
67
67
 
68
- Defined in: [interfaces/IBlobProvider.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L37)
68
+ Defined in: [interfaces/IBlobProvider.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L28)
69
69
 
70
70
  ***
71
71
 
@@ -75,7 +75,7 @@ Defined in: [interfaces/IBlobProvider.ts:37](https://github.com/RueDeRennes/arch
75
75
  optional metadata?: Record<string, string>;
76
76
  ```
77
77
 
78
- Defined in: [interfaces/IBlobProvider.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L44)
78
+ Defined in: [interfaces/IBlobProvider.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L35)
79
79
 
80
80
  ***
81
81
 
@@ -85,7 +85,7 @@ Defined in: [interfaces/IBlobProvider.ts:44](https://github.com/RueDeRennes/arch
85
85
  optional ownerUserId?: string;
86
86
  ```
87
87
 
88
- Defined in: [interfaces/IBlobProvider.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L46)
88
+ Defined in: [interfaces/IBlobProvider.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L37)
89
89
 
90
90
  ***
91
91
 
@@ -95,7 +95,7 @@ Defined in: [interfaces/IBlobProvider.ts:46](https://github.com/RueDeRennes/arch
95
95
  provider: string;
96
96
  ```
97
97
 
98
- Defined in: [interfaces/IBlobProvider.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L34)
98
+ Defined in: [interfaces/IBlobProvider.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L25)
99
99
 
100
100
  ***
101
101
 
@@ -105,7 +105,7 @@ Defined in: [interfaces/IBlobProvider.ts:34](https://github.com/RueDeRennes/arch
105
105
  optional region?: string;
106
106
  ```
107
107
 
108
- Defined in: [interfaces/IBlobProvider.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L36)
108
+ Defined in: [interfaces/IBlobProvider.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L27)
109
109
 
110
110
  ***
111
111
 
@@ -115,7 +115,7 @@ Defined in: [interfaces/IBlobProvider.ts:36](https://github.com/RueDeRennes/arch
115
115
  size: number;
116
116
  ```
117
117
 
118
- Defined in: [interfaces/IBlobProvider.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L39)
118
+ Defined in: [interfaces/IBlobProvider.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L30)
119
119
 
120
120
  ***
121
121
 
@@ -125,7 +125,7 @@ Defined in: [interfaces/IBlobProvider.ts:39](https://github.com/RueDeRennes/arch
125
125
  optional storageClass?: string;
126
126
  ```
127
127
 
128
- Defined in: [interfaces/IBlobProvider.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L43)
128
+ Defined in: [interfaces/IBlobProvider.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L34)
129
129
 
130
130
  ***
131
131
 
@@ -135,4 +135,4 @@ Defined in: [interfaces/IBlobProvider.ts:43](https://github.com/RueDeRennes/arch
135
135
  optional versionId?: string;
136
136
  ```
137
137
 
138
- Defined in: [interfaces/IBlobProvider.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L38)
138
+ Defined in: [interfaces/IBlobProvider.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L29)
package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md CHANGED
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IBlobSignedUrlRequest
7
7
 
8
- Defined in: [interfaces/IBlobProvider.ts:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L87)
8
+ Defined in: [interfaces/IBlobProvider.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L78)
9
9
 
10
10
  ## Properties
11
11
 
@@ -15,7 +15,7 @@ Defined in: [interfaces/IBlobProvider.ts:87](https://github.com/RueDeRennes/arch
15
15
  optional bucket?: string;
16
16
  ```
17
17
 
18
- Defined in: [interfaces/IBlobProvider.ts:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L90)
18
+ Defined in: [interfaces/IBlobProvider.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L81)
19
19
 
20
20
  ***
21
21
 
@@ -25,7 +25,7 @@ Defined in: [interfaces/IBlobProvider.ts:90](https://github.com/RueDeRennes/arch
25
25
  optional expiresInSeconds?: number;
26
26
  ```
27
27
 
28
- Defined in: [interfaces/IBlobProvider.ts:89](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L89)
28
+ Defined in: [interfaces/IBlobProvider.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L80)
29
29
 
30
30
  ***
31
31
 
@@ -35,7 +35,7 @@ Defined in: [interfaces/IBlobProvider.ts:89](https://github.com/RueDeRennes/arch
35
35
  key: string;
36
36
  ```
37
37
 
38
- Defined in: [interfaces/IBlobProvider.ts:88](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L88)
38
+ Defined in: [interfaces/IBlobProvider.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L79)
39
39
 
40
40
  ***
41
41
 
@@ -45,4 +45,4 @@ Defined in: [interfaces/IBlobProvider.ts:88](https://github.com/RueDeRennes/arch
45
45
  optional versionId?: string;
46
46
  ```
47
47
 
48
- Defined in: [interfaces/IBlobProvider.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L91)
48
+ Defined in: [interfaces/IBlobProvider.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L82)
package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md CHANGED
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IBlobUploadRequest
7
7
 
8
- Defined in: [interfaces/IBlobProvider.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L49)
8
+ Defined in: [interfaces/IBlobProvider.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L40)
9
9
 
10
10
  ## Properties
11
11
 
@@ -15,7 +15,7 @@ Defined in: [interfaces/IBlobProvider.ts:49](https://github.com/RueDeRennes/arch
15
15
  body: BlobUploadBody;
16
16
  ```
17
17
 
18
- Defined in: [interfaces/IBlobProvider.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L51)
18
+ Defined in: [interfaces/IBlobProvider.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L42)
19
19
 
20
20
  ***
21
21
 
@@ -25,7 +25,7 @@ Defined in: [interfaces/IBlobProvider.ts:51](https://github.com/RueDeRennes/arch
25
25
  optional bucket?: string;
26
26
  ```
27
27
 
28
- Defined in: [interfaces/IBlobProvider.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L57)
28
+ Defined in: [interfaces/IBlobProvider.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L48)
29
29
 
30
30
  ***
31
31
 
@@ -35,7 +35,7 @@ Defined in: [interfaces/IBlobProvider.ts:57](https://github.com/RueDeRennes/arch
35
35
  optional checksumSha256?: string;
36
36
  ```
37
37
 
38
- Defined in: [interfaces/IBlobProvider.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L55)
38
+ Defined in: [interfaces/IBlobProvider.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L46)
39
39
 
40
40
  ***
41
41
 
@@ -45,7 +45,7 @@ Defined in: [interfaces/IBlobProvider.ts:55](https://github.com/RueDeRennes/arch
45
45
  optional contentLength?: number;
46
46
  ```
47
47
 
48
- Defined in: [interfaces/IBlobProvider.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L53)
48
+ Defined in: [interfaces/IBlobProvider.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L44)
49
49
 
50
50
  ***
51
51
 
@@ -55,7 +55,7 @@ Defined in: [interfaces/IBlobProvider.ts:53](https://github.com/RueDeRennes/arch
55
55
  optional contentType?: string;
56
56
  ```
57
57
 
58
- Defined in: [interfaces/IBlobProvider.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L52)
58
+ Defined in: [interfaces/IBlobProvider.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L43)
59
59
 
60
60
  ***
61
61
 
@@ -65,7 +65,7 @@ Defined in: [interfaces/IBlobProvider.ts:52](https://github.com/RueDeRennes/arch
65
65
  key: string;
66
66
  ```
67
67
 
68
- Defined in: [interfaces/IBlobProvider.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L50)
68
+ Defined in: [interfaces/IBlobProvider.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L41)
69
69
 
70
70
  ***
71
71
 
@@ -75,7 +75,7 @@ Defined in: [interfaces/IBlobProvider.ts:50](https://github.com/RueDeRennes/arch
75
75
  optional metadata?: Record<string, string>;
76
76
  ```
77
77
 
78
- Defined in: [interfaces/IBlobProvider.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L54)
78
+ Defined in: [interfaces/IBlobProvider.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L45)
79
79
 
80
80
  ***
81
81
 
@@ -85,7 +85,7 @@ Defined in: [interfaces/IBlobProvider.ts:54](https://github.com/RueDeRennes/arch
85
85
  optional ownerUserId?: string;
86
86
  ```
87
87
 
88
- Defined in: [interfaces/IBlobProvider.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L56)
88
+ Defined in: [interfaces/IBlobProvider.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L47)
89
89
 
90
90
  ***
91
91
 
@@ -95,4 +95,4 @@ Defined in: [interfaces/IBlobProvider.ts:56](https://github.com/RueDeRennes/arch
95
95
  optional region?: string;
96
96
  ```
97
97
 
98
- Defined in: [interfaces/IBlobProvider.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L58)
98
+ Defined in: [interfaces/IBlobProvider.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L49)
package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md CHANGED
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IBlobUploadResult
7
7
 
8
- Defined in: [interfaces/IBlobProvider.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L61)
8
+ Defined in: [interfaces/IBlobProvider.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L52)
9
9
 
10
10
  ## Properties
11
11
 
@@ -15,7 +15,7 @@ Defined in: [interfaces/IBlobProvider.ts:61](https://github.com/RueDeRennes/arch
15
15
  metadata: IBlobObjectMetadata;
16
16
  ```
17
17
 
18
- Defined in: [interfaces/IBlobProvider.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L62)
18
+ Defined in: [interfaces/IBlobProvider.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L53)
19
19
 
20
20
  ***
21
21
 
@@ -25,4 +25,4 @@ Defined in: [interfaces/IBlobProvider.ts:62](https://github.com/RueDeRennes/arch
25
25
  optional rawResponse?: unknown;
26
26
  ```
27
27
 
28
- Defined in: [interfaces/IBlobProvider.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L63)
28
+ Defined in: [interfaces/IBlobProvider.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L54)
package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md CHANGED
@@ -9,4 +9,4 @@ editUrl: false
9
9
  type BlobDownloadResponseType = typeof BlobDownloadResponseTypes[keyof typeof BlobDownloadResponseTypes];
10
10
  ```
11
11
 
12
- Defined in: [interfaces/IBlobProvider.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L25)
12
+ Defined in: [interfaces/IBlobProvider.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L16)
package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md CHANGED
@@ -9,4 +9,4 @@ editUrl: false
9
9
  type BlobUploadBody = Buffer | Readable;
10
10
  ```
11
11
 
12
- Defined in: [interfaces/IBlobProvider.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L27)
12
+ Defined in: [interfaces/IBlobProvider.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L18)
package/data/packages/platform-blob-storage/api/Variable.AWS_S3_ACCESS_KEY_ID.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: AWS\_S3\_ACCESS\_KEY\_ID'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: AWS\_S3\_ACCESS\_KEY\_ID
7
+
8
+ ```ts
9
+ const AWS_S3_ACCESS_KEY_ID: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [strategies/aws-s3/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/aws-s3/env.ts#L16)
13
+
14
+ AWS S3 access key ID.
package/data/packages/platform-blob-storage/api/Variable.AWS_S3_BUCKET.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: AWS\_S3\_BUCKET'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: AWS\_S3\_BUCKET
7
+
8
+ ```ts
9
+ const AWS_S3_BUCKET: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [strategies/aws-s3/env.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/aws-s3/env.ts#L13)
13
+
14
+ AWS S3 bucket name.
package/data/packages/platform-blob-storage/api/Variable.AWS_S3_CONFIG_ENTRIES.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: AWS\_S3\_CONFIG\_ENTRIES'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: AWS\_S3\_CONFIG\_ENTRIES
7
+
8
+ ```ts
9
+ const AWS_S3_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
+ ```
11
+
12
+ Defined in: [strategies/aws-s3/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/aws-s3/env.ts#L25)
13
+
14
+ Configuration entries required by the AWS S3 blob storage strategy.
package/data/packages/platform-blob-storage/api/Variable.AWS_S3_ENDPOINT.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: AWS\_S3\_ENDPOINT'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: AWS\_S3\_ENDPOINT
7
+
8
+ ```ts
9
+ const AWS_S3_ENDPOINT: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [strategies/aws-s3/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/aws-s3/env.ts#L22)
13
+
14
+ AWS S3 custom endpoint (for S3-compatible providers).
package/data/packages/platform-blob-storage/api/Variable.AWS_S3_REGION.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: AWS\_S3\_REGION'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: AWS\_S3\_REGION
7
+
8
+ ```ts
9
+ const AWS_S3_REGION: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [strategies/aws-s3/env.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/aws-s3/env.ts#L10)
13
+
14
+ AWS S3 region.
package/data/packages/platform-blob-storage/api/Variable.AWS_S3_SECRET_ACCESS_KEY.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: AWS\_S3\_SECRET\_ACCESS\_KEY'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: AWS\_S3\_SECRET\_ACCESS\_KEY
7
+
8
+ ```ts
9
+ const AWS_S3_SECRET_ACCESS_KEY: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [strategies/aws-s3/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/aws-s3/env.ts#L19)
13
+
14
+ AWS S3 secret access key.
package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_CONNECTION_STRING.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: AZURE\_BLOB\_CONNECTION\_STRING'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: AZURE\_BLOB\_CONNECTION\_STRING
7
+
8
+ ```ts
9
+ const AZURE_BLOB_CONNECTION_STRING: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [strategies/azure/env.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/azure/env.ts#L10)
13
+
14
+ Azure Blob Storage connection string.
package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_CONTAINER_NAME.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: AZURE\_BLOB\_CONTAINER\_NAME'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: AZURE\_BLOB\_CONTAINER\_NAME
7
+
8
+ ```ts
9
+ const AZURE_BLOB_CONTAINER_NAME: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [strategies/azure/env.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/azure/env.ts#L13)
13
+
14
+ Azure Blob Storage container name.
package/data/packages/platform-blob-storage/api/Variable.AZURE_CONFIG_ENTRIES.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: AZURE\_CONFIG\_ENTRIES'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: AZURE\_CONFIG\_ENTRIES
7
+
8
+ ```ts
9
+ const AZURE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
+ ```
11
+
12
+ Defined in: [strategies/azure/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/azure/env.ts#L16)
13
+
14
+ Configuration entries required by the Azure blob storage strategy.
package/data/packages/platform-blob-storage/api/{Variable.BLOB_PROVIDER.md → Variable.BLOB_STORAGE_STRATEGY_TOKEN.md} RENAMED
@@ -1,12 +1,12 @@
1
1
  ---
2
- title: 'Variable: BLOB\_PROVIDER'
2
+ title: 'Variable: BLOB\_STORAGE\_STRATEGY\_TOKEN'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
- # Variable: BLOB\_PROVIDER
6
+ # Variable: BLOB\_STORAGE\_STRATEGY\_TOKEN
7
7
 
8
8
  ```ts
9
- const BLOB_PROVIDER: typeof BLOB_PROVIDER;
9
+ const BLOB_STORAGE_STRATEGY_TOKEN: typeof BLOB_STORAGE_STRATEGY_TOKEN;
10
10
  ```
11
11
 
12
12
  Defined in: [tokens/BlobStorageTokens.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens/BlobStorageTokens.ts#L3)
package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md CHANGED
@@ -14,13 +14,13 @@ const BlobDownloadResponseTypes: {
14
14
  };
15
15
  ```
16
16
 
17
- Defined in: [interfaces/IBlobProvider.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L18)
17
+ Defined in: [interfaces/IBlobProvider.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L9)
18
18
 
19
19
  ## Type Declaration
20
20
 
21
21
  | Name | Type | Default value | Defined in |
22
22
  | ------ | ------ | ------ | ------ |
23
- | <a id="property-arraybuffer"></a> `ArrayBuffer` | `"arraybuffer"` | `'arraybuffer'` | [interfaces/IBlobProvider.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L19) |
24
- | <a id="property-json"></a> `Json` | `"json"` | `'json'` | [interfaces/IBlobProvider.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L20) |
25
- | <a id="property-stream"></a> `Stream` | `"stream"` | `'stream'` | [interfaces/IBlobProvider.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L21) |
26
- | <a id="property-text"></a> `Text` | `"text"` | `'text'` | [interfaces/IBlobProvider.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L22) |
23
+ | <a id="property-arraybuffer"></a> `ArrayBuffer` | `"arraybuffer"` | `'arraybuffer'` | [interfaces/IBlobProvider.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L10) |
24
+ | <a id="property-json"></a> `Json` | `"json"` | `'json'` | [interfaces/IBlobProvider.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L11) |
25
+ | <a id="property-stream"></a> `Stream` | `"stream"` | `'stream'` | [interfaces/IBlobProvider.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L12) |
26
+ | <a id="property-text"></a> `Text` | `"text"` | `'text'` | [interfaces/IBlobProvider.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L13) |
package/data/packages/platform-blob-storage/api/Variable.LOCAL_BLOB_BASE_PATH.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: LOCAL\_BLOB\_BASE\_PATH'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: LOCAL\_BLOB\_BASE\_PATH
7
+
8
+ ```ts
9
+ const LOCAL_BLOB_BASE_PATH: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [strategies/local/env.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/local/env.ts#L10)
13
+
14
+ Local blob storage base path.
package/data/packages/platform-blob-storage/api/Variable.LOCAL_BLOB_BUCKET.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: LOCAL\_BLOB\_BUCKET'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: LOCAL\_BLOB\_BUCKET
7
+
8
+ ```ts
9
+ const LOCAL_BLOB_BUCKET: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [strategies/local/env.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/local/env.ts#L13)
13
+
14
+ Local blob storage bucket (subdirectory).
package/data/packages/platform-blob-storage/api/Variable.LOCAL_CONFIG_ENTRIES.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: LOCAL\_CONFIG\_ENTRIES'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: LOCAL\_CONFIG\_ENTRIES
7
+
8
+ ```ts
9
+ const LOCAL_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
+ ```
11
+
12
+ Defined in: [strategies/local/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/local/env.ts#L16)
13
+
14
+ Configuration entries required by the local blob storage strategy.
package/data/packages/platform-blob-storage/api/Variable.PLATFORM_BLOB_STORAGE_CONFIG_ENTRIES.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: PLATFORM\_BLOB\_STORAGE\_CONFIG\_ENTRIES'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: PLATFORM\_BLOB\_STORAGE\_CONFIG\_ENTRIES
7
+
8
+ ```ts
9
+ const PLATFORM_BLOB_STORAGE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
+ ```
11
+
12
+ Defined in: [env.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/env.ts#L26)
13
+
14
+ All configuration entries for `platform-blob-storage`. All keys are optional at the aggregate level.
package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_BUCKET.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: VERCEL\_BLOB\_BUCKET'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: VERCEL\_BLOB\_BUCKET
7
+
8
+ ```ts
9
+ const VERCEL_BLOB_BUCKET: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [strategies/vercel/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/vercel/env.ts#L16)
13
+
14
+ Vercel Blob bucket name.
package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PUBLIC_URL.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: VERCEL\_BLOB\_PUBLIC\_URL'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: VERCEL\_BLOB\_PUBLIC\_URL
7
+
8
+ ```ts
9
+ const VERCEL_BLOB_PUBLIC_URL: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [strategies/vercel/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/strategies/vercel/env.ts#L22)
13
+
14
+ Vercel Blob public URL.