@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
@@ -1,48 +0,0 @@
1
- ---
2
- title: 'Interface: IAzureBlobProviderOptions'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IAzureBlobProviderOptions
7
-
8
- Defined in: [providers/AzureBlobProvider.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L20)
9
-
10
- ## Properties
11
-
12
- ### accountName?
13
-
14
- ```ts
15
- optional accountName?: string;
16
- ```
17
-
18
- Defined in: [providers/AzureBlobProvider.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L22)
19
-
20
- ***
21
-
22
- ### connectionString?
23
-
24
- ```ts
25
- optional connectionString?: string;
26
- ```
27
-
28
- Defined in: [providers/AzureBlobProvider.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L21)
29
-
30
- ***
31
-
32
- ### containerName
33
-
34
- ```ts
35
- containerName: string;
36
- ```
37
-
38
- Defined in: [providers/AzureBlobProvider.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L23)
39
-
40
- ***
41
-
42
- ### providerId?
43
-
44
- ```ts
45
- optional providerId?: string;
46
- ```
47
-
48
- Defined in: [providers/AzureBlobProvider.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/AzureBlobProvider.ts#L24)
@@ -1,28 +0,0 @@
1
- ---
2
- title: 'Interface: IAzureBlobProviderRegistration'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IAzureBlobProviderRegistration
7
-
8
- Defined in: [BlobModule.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L46)
9
-
10
- ## Properties
11
-
12
- ### kind
13
-
14
- ```ts
15
- kind: "azure";
16
- ```
17
-
18
- Defined in: [BlobModule.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L47)
19
-
20
- ***
21
-
22
- ### options?
23
-
24
- ```ts
25
- optional options?: Partial<IAzureBlobProviderOptions>;
26
- ```
27
-
28
- Defined in: [BlobModule.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L48)
@@ -1,114 +0,0 @@
1
- ---
2
- title: 'Interface: IBlobProvider'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IBlobProvider
7
-
8
- Defined in: [interfaces/IBlobProvider.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L94)
9
-
10
- ## Properties
11
-
12
- ### defaultBucket?
13
-
14
- ```ts
15
- readonly optional defaultBucket?: string;
16
- ```
17
-
18
- Defined in: [interfaces/IBlobProvider.ts:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L96)
19
-
20
- ***
21
-
22
- ### providerId
23
-
24
- ```ts
25
- readonly providerId: string;
26
- ```
27
-
28
- Defined in: [interfaces/IBlobProvider.ts:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L95)
29
-
30
- ## Methods
31
-
32
- ### createSignedUrl()?
33
-
34
- ```ts
35
- optional createSignedUrl(request): Promise<string>;
36
- ```
37
-
38
- Defined in: [interfaces/IBlobProvider.ts:100](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L100)
39
-
40
- #### Parameters
41
-
42
- | Parameter | Type |
43
- | ------ | ------ |
44
- | `request` | [`IBlobSignedUrlRequest`](Interface.IBlobSignedUrlRequest) |
45
-
46
- #### Returns
47
-
48
- `Promise`\<`string`\>
49
-
50
- ***
51
-
52
- ### deleteObject()
53
-
54
- ```ts
55
- deleteObject(request): Promise<void>;
56
- ```
57
-
58
- Defined in: [interfaces/IBlobProvider.ts:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L99)
59
-
60
- #### Parameters
61
-
62
- | Parameter | Type |
63
- | ------ | ------ |
64
- | `request` | [`IBlobDeleteRequest`](Interface.IBlobDeleteRequest) |
65
-
66
- #### Returns
67
-
68
- `Promise`\<`void`\>
69
-
70
- ***
71
-
72
- ### downloadObject()
73
-
74
- ```ts
75
- downloadObject<TData>(request): Promise<IBlobDownloadResult<TData>>;
76
- ```
77
-
78
- Defined in: [interfaces/IBlobProvider.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L98)
79
-
80
- #### Type Parameters
81
-
82
- | Type Parameter |
83
- | ------ |
84
- | `TData` |
85
-
86
- #### Parameters
87
-
88
- | Parameter | Type |
89
- | ------ | ------ |
90
- | `request` | [`IBlobDownloadRequest`](Interface.IBlobDownloadRequest) |
91
-
92
- #### Returns
93
-
94
- `Promise`\<[`IBlobDownloadResult`](Interface.IBlobDownloadResult)\<`TData`\>\>
95
-
96
- ***
97
-
98
- ### uploadObject()
99
-
100
- ```ts
101
- uploadObject(request): Promise<IBlobUploadResult>;
102
- ```
103
-
104
- Defined in: [interfaces/IBlobProvider.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L97)
105
-
106
- #### Parameters
107
-
108
- | Parameter | Type |
109
- | ------ | ------ |
110
- | `request` | [`IBlobUploadRequest`](Interface.IBlobUploadRequest) |
111
-
112
- #### Returns
113
-
114
- `Promise`\<[`IBlobUploadResult`](Interface.IBlobUploadResult)\>
@@ -1,28 +0,0 @@
1
- ---
2
- title: 'Interface: ICustomBlobProviderRegistration'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: ICustomBlobProviderRegistration
7
-
8
- Defined in: [BlobModule.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L56)
9
-
10
- ## Properties
11
-
12
- ### kind
13
-
14
- ```ts
15
- kind: "custom";
16
- ```
17
-
18
- Defined in: [BlobModule.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L57)
19
-
20
- ***
21
-
22
- ### useClass
23
-
24
- ```ts
25
- useClass: Type<IBlobProvider>;
26
- ```
27
-
28
- Defined in: [BlobModule.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L58)
@@ -1,80 +0,0 @@
1
- ---
2
- title: 'Interface: IVercelBlobProviderOptions'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IVercelBlobProviderOptions
7
-
8
- Defined in: [providers/VercelBlobProvider.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L25)
9
-
10
- ## Properties
11
-
12
- ### accessToken
13
-
14
- ```ts
15
- accessToken: string;
16
- ```
17
-
18
- Defined in: [providers/VercelBlobProvider.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L27)
19
-
20
- ***
21
-
22
- ### apiUrl
23
-
24
- ```ts
25
- apiUrl: string;
26
- ```
27
-
28
- Defined in: [providers/VercelBlobProvider.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L26)
29
-
30
- ***
31
-
32
- ### bucket?
33
-
34
- ```ts
35
- optional bucket?: string;
36
- ```
37
-
38
- Defined in: [providers/VercelBlobProvider.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L28)
39
-
40
- ***
41
-
42
- ### providerId?
43
-
44
- ```ts
45
- optional providerId?: string;
46
- ```
47
-
48
- Defined in: [providers/VercelBlobProvider.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L31)
49
-
50
- ***
51
-
52
- ### publicUrl?
53
-
54
- ```ts
55
- optional publicUrl?: string;
56
- ```
57
-
58
- Defined in: [providers/VercelBlobProvider.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L30)
59
-
60
- ***
61
-
62
- ### region?
63
-
64
- ```ts
65
- optional region?: string;
66
- ```
67
-
68
- Defined in: [providers/VercelBlobProvider.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L29)
69
-
70
- ***
71
-
72
- ### timeoutMs?
73
-
74
- ```ts
75
- optional timeoutMs?: number;
76
- ```
77
-
78
- Defined in: [providers/VercelBlobProvider.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/providers/VercelBlobProvider.ts#L33)
79
-
80
- HTTP request timeout in milliseconds. Defaults to 30000.
@@ -1,28 +0,0 @@
1
- ---
2
- title: 'Interface: IVercelBlobProviderRegistration'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IVercelBlobProviderRegistration
7
-
8
- Defined in: [BlobModule.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L41)
9
-
10
- ## Properties
11
-
12
- ### kind
13
-
14
- ```ts
15
- kind: "vercel";
16
- ```
17
-
18
- Defined in: [BlobModule.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L42)
19
-
20
- ***
21
-
22
- ### options?
23
-
24
- ```ts
25
- optional options?: Partial<IVercelBlobProviderOptions>;
26
- ```
27
-
28
- Defined in: [BlobModule.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L43)
@@ -1,16 +0,0 @@
1
- ---
2
- title: 'Type Alias: IBlobProviderRegistration'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Type Alias: IBlobProviderRegistration
7
-
8
- ```ts
9
- type IBlobProviderRegistration =
10
- | IVercelBlobProviderRegistration
11
- | IAzureBlobProviderRegistration
12
- | IAwsS3BlobProviderRegistration
13
- | ICustomBlobProviderRegistration;
14
- ```
15
-
16
- Defined in: [BlobModule.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L61)
@@ -1,12 +0,0 @@
1
- ---
2
- title: 'Variable: AWS\_S3\_PROVIDER\_OPTIONS'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Variable: AWS\_S3\_PROVIDER\_OPTIONS
7
-
8
- ```ts
9
- const AWS_S3_PROVIDER_OPTIONS: typeof AWS_S3_PROVIDER_OPTIONS;
10
- ```
11
-
12
- Defined in: [tokens/BlobStorageTokens.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens/BlobStorageTokens.ts#L6)
@@ -1,12 +0,0 @@
1
- ---
2
- title: 'Variable: AZURE\_BLOB\_PROVIDER\_OPTIONS'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Variable: AZURE\_BLOB\_PROVIDER\_OPTIONS
7
-
8
- ```ts
9
- const AZURE_BLOB_PROVIDER_OPTIONS: typeof AZURE_BLOB_PROVIDER_OPTIONS;
10
- ```
11
-
12
- Defined in: [tokens/BlobStorageTokens.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens/BlobStorageTokens.ts#L5)
@@ -1,26 +0,0 @@
1
- ---
2
- title: 'Variable: BlobProviderKinds'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Variable: BlobProviderKinds
7
-
8
- ```ts
9
- const BlobProviderKinds: {
10
- AwsS3: "aws-s3";
11
- Azure: "azure";
12
- Custom: "custom";
13
- Vercel: "vercel";
14
- };
15
- ```
16
-
17
- Defined in: [interfaces/IBlobProvider.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L9)
18
-
19
- ## Type Declaration
20
-
21
- | Name | Type | Default value | Defined in |
22
- | ------ | ------ | ------ | ------ |
23
- | <a id="property-awss3"></a> `AwsS3` | `"aws-s3"` | `'aws-s3'` | [interfaces/IBlobProvider.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L13) |
24
- | <a id="property-azure"></a> `Azure` | `"azure"` | `'azure'` | [interfaces/IBlobProvider.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L12) |
25
- | <a id="property-custom"></a> `Custom` | `"custom"` | `'custom'` | [interfaces/IBlobProvider.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L10) |
26
- | <a id="property-vercel"></a> `Vercel` | `"vercel"` | `'vercel'` | [interfaces/IBlobProvider.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/interfaces/IBlobProvider.ts#L11) |
@@ -1,12 +0,0 @@
1
- ---
2
- title: 'Variable: VERCEL\_BLOB\_PROVIDER\_OPTIONS'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Variable: VERCEL\_BLOB\_PROVIDER\_OPTIONS
7
-
8
- ```ts
9
- const VERCEL_BLOB_PROVIDER_OPTIONS: typeof VERCEL_BLOB_PROVIDER_OPTIONS;
10
- ```
11
-
12
- Defined in: [tokens/BlobStorageTokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/tokens/BlobStorageTokens.ts#L4)