@visulima/storage 1.0.9 → 1.0.11

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 (174) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/dist/adapter/nuxt/module.d.ts +9 -8
  3. package/dist/ai/ai-sdk/index.d.ts +52 -59
  4. package/dist/ai/claude/index.d.ts +105 -119
  5. package/dist/ai/openai/index.d.ts +87 -99
  6. package/dist/ai/tanstack/index.d.ts +54 -61
  7. package/dist/handler/http/fetch/index.d.ts +202 -201
  8. package/dist/handler/http/fetch/index.js +1 -1
  9. package/dist/handler/http/hono/index.d.ts +60 -59
  10. package/dist/handler/http/hono/index.js +1 -1
  11. package/dist/handler/http/nextjs/index.d.ts +55 -54
  12. package/dist/handler/http/nextjs/index.js +1 -1
  13. package/dist/handler/http/node/index.d.ts +234 -246
  14. package/dist/handler/http/node/index.js +1 -1
  15. package/dist/handler/http/solid-start/index.d.ts +55 -54
  16. package/dist/handler/http/solid-start/index.js +1 -1
  17. package/dist/index.d.ts +71 -70
  18. package/dist/index.js +1 -1
  19. package/dist/packem_shared/{AbstractBaseStorage-CiPEMcuo.js → AbstractBaseStorage-CLsYmMZg.js} +1 -1
  20. package/dist/packem_shared/AwsLightStorage-DGSPFUqr.js +1 -0
  21. package/dist/packem_shared/AzureStorage-DvKk_hhz.js +1 -0
  22. package/dist/packem_shared/BoxMetaStorage-CJsyeQ63.js +1 -0
  23. package/dist/packem_shared/{BoxStorage-DbGqBLux.js → BoxStorage-CmM95wi2.js} +1 -1
  24. package/dist/packem_shared/BunS3MetaStorage-CJsyeQ63.js +1 -0
  25. package/dist/packem_shared/{BunS3Storage-DNvimm9e.js → BunS3Storage-B_roVJ29.js} +1 -1
  26. package/dist/packem_shared/BunnyMetaStorage-CJsyeQ63.js +1 -0
  27. package/dist/packem_shared/{BunnyStorage-C7d0opLL.js → BunnyStorage-eZ1QDVaY.js} +1 -1
  28. package/dist/packem_shared/CloudinaryMetaStorage-Bv_YCZ0Q.js +1 -0
  29. package/dist/packem_shared/{CloudinaryStorage-Dc3XA2lP.js → CloudinaryStorage-CpH2f0Fv.js} +1 -1
  30. package/dist/packem_shared/DiskStorage-DzjjqCzo.js +1 -0
  31. package/dist/packem_shared/{DiskStorageWithChecksum-vFCubS6K.js → DiskStorageWithChecksum-MZkDEyts.js} +1 -1
  32. package/dist/packem_shared/DropboxMetaStorage-CJsyeQ63.js +1 -0
  33. package/dist/packem_shared/{DropboxStorage-CY9Ggu3m.js → DropboxStorage-BB9NoWK2.js} +1 -1
  34. package/dist/packem_shared/{Files-CpIcMjP0.js → Files-DyMJ9FPN.js} +1 -1
  35. package/dist/packem_shared/FirebaseMetaStorage-Bv_YCZ0Q.js +1 -0
  36. package/dist/packem_shared/{FirebaseStorage-D6O9CJXN.js → FirebaseStorage-BgbxzYNC.js} +1 -1
  37. package/dist/packem_shared/FtpMetaStorage-CJsyeQ63.js +1 -0
  38. package/dist/packem_shared/{FtpStorage-DbEjbq8z.js → FtpStorage-CNqXDz7P.js} +1 -1
  39. package/dist/packem_shared/{GCSMetaStorage-DT8K6zdm.js → GCSMetaStorage-gEhWlpfS.js} +1 -1
  40. package/dist/packem_shared/{GCStorage-6BHkFlEs.js → GCStorage-CRd5vjok.js} +1 -1
  41. package/dist/packem_shared/GoogleDriveMetaStorage-B0gLF7Io.js +1 -0
  42. package/dist/packem_shared/{GoogleDriveStorage-Bklsz7Bh.js → GoogleDriveStorage-Du7uBhSm.js} +1 -1
  43. package/dist/packem_shared/{LocalMetaStorage-BhicZnNl.js → LocalMetaStorage-CcGfFG39.js} +1 -1
  44. package/dist/packem_shared/{MemoryStorage-9gbWd09l.js → MemoryStorage-ChKyI6OY.js} +1 -1
  45. package/dist/packem_shared/{Multipart-D0ok6BBy.js → Multipart-C35TR2qL.js} +1 -1
  46. package/dist/packem_shared/{Multipart-CQjYqU--.js → Multipart-V64Bg5dt.js} +1 -1
  47. package/dist/packem_shared/NetlifyBlobMetaStorage-Bv_YCZ0Q.js +1 -0
  48. package/dist/packem_shared/NetlifyBlobStorage-CZsr_0DF.js +1 -0
  49. package/dist/packem_shared/OneDriveMetaStorage-B0gLF7Io.js +1 -0
  50. package/dist/packem_shared/{OneDriveStorage-CP6MvGAa.js → OneDriveStorage-B8qFgMq1.js} +1 -1
  51. package/dist/packem_shared/PocketBaseMetaStorage-Cm3v8g1-.js +1 -0
  52. package/dist/packem_shared/{PocketBaseStorage-2qhbI2PW.js → PocketBaseStorage-D2vMN-oY.js} +1 -1
  53. package/dist/packem_shared/{Rest-CI_BiZPv.js → Rest-B7g1sgkq.js} +1 -1
  54. package/dist/packem_shared/{Rest-DvfN4-kf.js → Rest-BrEMYgxZ.js} +1 -1
  55. package/dist/packem_shared/{S3Storage-YGeNk3Tt.js → S3Storage-CTe_BMDl.js} +1 -1
  56. package/dist/packem_shared/SftpMetaStorage-CJsyeQ63.js +1 -0
  57. package/dist/packem_shared/{SftpStorage-2Hz396Xr.js → SftpStorage-BKeAzuej.js} +1 -1
  58. package/dist/packem_shared/SharePointMetaStorage-CJsyeQ63.js +1 -0
  59. package/dist/packem_shared/{SharePointStorage-CrX2Pk6C.js → SharePointStorage-Dtnt5-wk.js} +1 -1
  60. package/dist/packem_shared/SupabaseMetaStorage-B0gLF7Io.js +1 -0
  61. package/dist/packem_shared/{SupabaseStorage-Dc_DBX29.js → SupabaseStorage-CmGQjqXf.js} +1 -1
  62. package/dist/packem_shared/{Tus-BlBZykIL.js → Tus-CJBgnJrn.js} +1 -1
  63. package/dist/packem_shared/{Tus-BBVt2ky3.js → Tus-D9c7KDnl.js} +1 -1
  64. package/dist/packem_shared/UploadThingMetaStorage-Bv_YCZ0Q.js +1 -0
  65. package/dist/packem_shared/{UploadThingStorage-BChykYSe.js → UploadThingStorage-DZ4zNvDH.js} +1 -1
  66. package/dist/packem_shared/VercelBlobMetaStorage-CJsyeQ63.js +1 -0
  67. package/dist/packem_shared/{VercelBlobStorage-CsRyPfw3.js → VercelBlobStorage-DDNEofR3.js} +1 -1
  68. package/dist/packem_shared/{approval.d-CMAYH9GF.d.ts → approval.d-C-d-t94D.d.ts} +6 -6
  69. package/dist/packem_shared/{base-handler-core-D-9Ku1h-.js → base-handler-core-BJP9jHCE.js} +1 -1
  70. package/dist/packem_shared/{base-handler-fetch-CfkNakv8.js → base-handler-fetch-yrYrukwL.js} +1 -1
  71. package/dist/packem_shared/base-handler-node-C8P9rkaH.js +1 -0
  72. package/dist/packem_shared/{createRetryWrapper-CxgiV_hH.js → createRetryWrapper-DgmeHPNF.js} +1 -1
  73. package/dist/packem_shared/disk-storage-DqnnFQAQ.js +1 -0
  74. package/dist/packem_shared/disk-storage-with-checksum.d-Dgwyza8a.d.ts +146 -0
  75. package/dist/packem_shared/{executors.d-BZP2rWo3.d.ts → executors.d-B9dIy3NT.d.ts} +3 -2
  76. package/dist/packem_shared/files.d-CmSZi3M0.d.ts +655 -0
  77. package/dist/packem_shared/gcs-meta-storage-C9F78Sqq.js +1 -0
  78. package/dist/packem_shared/local-meta-storage-BELb1YwO.js +11 -0
  79. package/dist/packem_shared/{local-meta-storage.d-D9PBfkn6.d.ts → local-meta-storage.d-cRTXr1kb.d.ts} +7 -7
  80. package/dist/packem_shared/media-transformer.d-C8tn4J2Z.d.ts +331 -0
  81. package/dist/packem_shared/{memory-storage.d-4EU1cMt1.d.ts → memory-storage.d-BNZvDG1b.d.ts} +32 -40
  82. package/dist/packem_shared/path-C-OWflAo-_mqb5p5d.js +1 -0
  83. package/dist/packem_shared/{rest-base-e0reNDE_.js → rest-base-BQ_dhWyV.js} +1 -1
  84. package/dist/packem_shared/s3-base-storage-CX94H-Za.js +1 -0
  85. package/dist/packem_shared/{s3-base-storage.d-BQgP5B-t.d.ts → s3-base-storage.d-ks99NSs-.d.ts} +64 -70
  86. package/dist/packem_shared/storage-DR7qdwBN.js +1 -0
  87. package/dist/packem_shared/storage.d-DwdJrArF.d.ts +1186 -0
  88. package/dist/packem_shared/tus-base.d-BKBoJVy0.d.ts +103 -0
  89. package/dist/packem_shared/types.d-B1_xZIhu.d.ts +104 -0
  90. package/dist/packem_shared/{types.d-CrUWY4On.d.ts → types.d-BEUv414z.d.ts} +134 -134
  91. package/dist/packem_shared/{types.d-CggTCgXr.d.ts → types.d-D7Zlz5RE.d.ts} +3 -3
  92. package/dist/storage/aws/clients/index.d.ts +388 -388
  93. package/dist/storage/aws/index.d.ts +110 -113
  94. package/dist/storage/aws/index.js +1 -1
  95. package/dist/storage/aws-light/index.d.ts +64 -67
  96. package/dist/storage/aws-light/index.js +1 -1
  97. package/dist/storage/azure/index.d.ts +134 -139
  98. package/dist/storage/azure/index.js +1 -1
  99. package/dist/storage/box/index.d.ts +89 -92
  100. package/dist/storage/box/index.js +1 -1
  101. package/dist/storage/bun-s3/index.d.ts +71 -76
  102. package/dist/storage/bun-s3/index.js +1 -1
  103. package/dist/storage/bunny/index.d.ts +52 -55
  104. package/dist/storage/bunny/index.js +1 -1
  105. package/dist/storage/cloudinary/index.d.ts +54 -59
  106. package/dist/storage/cloudinary/index.js +1 -1
  107. package/dist/storage/dropbox/index.d.ts +59 -62
  108. package/dist/storage/dropbox/index.js +1 -1
  109. package/dist/storage/firebase/index.d.ts +74 -79
  110. package/dist/storage/firebase/index.js +1 -1
  111. package/dist/storage/ftp/index.d.ts +38 -43
  112. package/dist/storage/ftp/index.js +1 -1
  113. package/dist/storage/gcs/index.d.ts +90 -95
  114. package/dist/storage/gcs/index.js +1 -1
  115. package/dist/storage/google-drive/index.d.ts +69 -72
  116. package/dist/storage/google-drive/index.js +1 -1
  117. package/dist/storage/local/index.d.ts +4 -3
  118. package/dist/storage/local/index.js +1 -1
  119. package/dist/storage/memory/index.d.ts +3 -2
  120. package/dist/storage/memory/index.js +1 -1
  121. package/dist/storage/netlify-blob/index.d.ts +86 -93
  122. package/dist/storage/netlify-blob/index.js +1 -1
  123. package/dist/storage/onedrive/index.d.ts +44 -53
  124. package/dist/storage/onedrive/index.js +1 -1
  125. package/dist/storage/pocketbase/index.d.ts +67 -72
  126. package/dist/storage/pocketbase/index.js +1 -1
  127. package/dist/storage/sftp/index.d.ts +40 -45
  128. package/dist/storage/sftp/index.js +1 -1
  129. package/dist/storage/sharepoint/index.d.ts +96 -95
  130. package/dist/storage/sharepoint/index.js +1 -1
  131. package/dist/storage/supabase/index.d.ts +50 -55
  132. package/dist/storage/supabase/index.js +1 -1
  133. package/dist/storage/uploadthing/index.d.ts +34 -37
  134. package/dist/storage/uploadthing/index.js +1 -1
  135. package/dist/storage/vercel-blob/index.d.ts +110 -115
  136. package/dist/storage/vercel-blob/index.js +1 -1
  137. package/dist/transformer/audio-transformer.d.ts +97 -96
  138. package/dist/transformer/image-transformer.d.ts +423 -422
  139. package/dist/transformer/index.d.ts +35 -34
  140. package/dist/transformer/video-transformer.d.ts +112 -111
  141. package/package.json +2 -2
  142. package/dist/packem_shared/AwsLightStorage-BK-WPL0h.js +0 -1
  143. package/dist/packem_shared/AzureStorage-1UvDIQZd.js +0 -1
  144. package/dist/packem_shared/BoxMetaStorage-BSn6Qfnf.js +0 -1
  145. package/dist/packem_shared/BunS3MetaStorage-BSn6Qfnf.js +0 -1
  146. package/dist/packem_shared/BunnyMetaStorage-BSn6Qfnf.js +0 -1
  147. package/dist/packem_shared/CloudinaryMetaStorage-DPVnmNe5.js +0 -1
  148. package/dist/packem_shared/DiskStorage-CI07TVNu.js +0 -1
  149. package/dist/packem_shared/DropboxMetaStorage-BSn6Qfnf.js +0 -1
  150. package/dist/packem_shared/FirebaseMetaStorage-DPVnmNe5.js +0 -1
  151. package/dist/packem_shared/FtpMetaStorage-BSn6Qfnf.js +0 -1
  152. package/dist/packem_shared/GoogleDriveMetaStorage-Cbwa1CHV.js +0 -1
  153. package/dist/packem_shared/NetlifyBlobMetaStorage-DPVnmNe5.js +0 -1
  154. package/dist/packem_shared/NetlifyBlobStorage-CkpCCoN1.js +0 -1
  155. package/dist/packem_shared/OneDriveMetaStorage-Cbwa1CHV.js +0 -1
  156. package/dist/packem_shared/PocketBaseMetaStorage-DOTLwVE7.js +0 -1
  157. package/dist/packem_shared/SftpMetaStorage-BSn6Qfnf.js +0 -1
  158. package/dist/packem_shared/SharePointMetaStorage-BSn6Qfnf.js +0 -1
  159. package/dist/packem_shared/SupabaseMetaStorage-Cbwa1CHV.js +0 -1
  160. package/dist/packem_shared/UploadThingMetaStorage-DPVnmNe5.js +0 -1
  161. package/dist/packem_shared/VercelBlobMetaStorage-BSn6Qfnf.js +0 -1
  162. package/dist/packem_shared/base-handler-node-BF1v1qDa.js +0 -1
  163. package/dist/packem_shared/disk-storage-CsQcYW3s.js +0 -1
  164. package/dist/packem_shared/disk-storage-with-checksum.d-B-VGEsfl.d.ts +0 -156
  165. package/dist/packem_shared/files.d-CH0iLBNC.d.ts +0 -655
  166. package/dist/packem_shared/gcs-meta-storage-B7BnctnV.js +0 -1
  167. package/dist/packem_shared/local-meta-storage-iuJnu90B.js +0 -11
  168. package/dist/packem_shared/media-transformer.d-Quf4ai47.d.ts +0 -331
  169. package/dist/packem_shared/path-0oTTdkvl-DvWvbDbh.js +0 -1
  170. package/dist/packem_shared/s3-base-storage-BoTyhuzO.js +0 -1
  171. package/dist/packem_shared/storage-0j5nCAUp.js +0 -1
  172. package/dist/packem_shared/storage.d-CEM1upWM.d.ts +0 -1176
  173. package/dist/packem_shared/tus-base.d-DLzKE54M.d.ts +0 -106
  174. package/dist/packem_shared/types.d-Bon9GVVe.d.ts +0 -104
@@ -1,612 +1,612 @@
1
1
  import { S3ClientConfig } from '@aws-sdk/client-s3';
2
2
  type CreateCloudflareClientParameters = {
3
3
  /**
4
- * Cloudflare R2 access key ID.
5
- */
4
+ * Cloudflare R2 access key ID.
5
+ */
6
6
  accessKeyId: string;
7
7
  /**
8
- * Cloudflare account ID.
9
- */
8
+ * Cloudflare account ID.
9
+ */
10
10
  accountId: string;
11
11
  /**
12
- * The jurisdiction where the data is stored.
13
- *
14
- * Only use this if you created your R2 bucket using a jurisdiction.
15
- */
12
+ * The jurisdiction where the data is stored.
13
+ *
14
+ * Only use this if you created your R2 bucket using a jurisdiction.
15
+ */
16
16
  jurisdiction?: "eu" | "fedramp";
17
17
  /**
18
- * Cloudflare R2 secret access key.
19
- */
18
+ * Cloudflare R2 secret access key.
19
+ */
20
20
  secretAccessKey: string;
21
21
  };
22
22
  type CreateMinioClientParameters = {
23
23
  /**
24
- * Minio access key ID.
25
- */
24
+ * Minio access key ID.
25
+ */
26
26
  accessKeyId: string;
27
27
  /**
28
- * Minio endpoint.
29
- */
28
+ * Minio endpoint.
29
+ */
30
30
  endpoint: string;
31
31
  /**
32
- * Minio region.
33
- */
32
+ * Minio region.
33
+ */
34
34
  region: string;
35
35
  /**
36
- * Minio secret access key.
37
- */
36
+ * Minio secret access key.
37
+ */
38
38
  secretAccessKey: string;
39
39
  };
40
40
  type CreateBackblazeClientParameters = {
41
41
  /**
42
- * Backblaze B2 application key.
43
- */
42
+ * Backblaze B2 application key.
43
+ */
44
44
  applicationKey: string;
45
45
  /**
46
- * Backblaze B2 application key ID.
47
- */
46
+ * Backblaze B2 application key ID.
47
+ */
48
48
  applicationKeyId: string;
49
49
  /**
50
- * Backblaze B2 region.
51
- */
50
+ * Backblaze B2 region.
51
+ */
52
52
  region: string;
53
53
  };
54
54
  type CreateWasabiClientParameters = {
55
55
  /**
56
- * Wasabi access key ID.
57
- */
56
+ * Wasabi access key ID.
57
+ */
58
58
  accessKeyId: string;
59
59
  /**
60
- * Wasabi region.
61
- */
60
+ * Wasabi region.
61
+ */
62
62
  region: string;
63
63
  /**
64
- * Wasabi secret access key.
65
- */
64
+ * Wasabi secret access key.
65
+ */
66
66
  secretAccessKey: string;
67
67
  };
68
68
  type CreateDigitalOceanClientParameters = {
69
69
  /**
70
- * DigitalOcean Spaces key.
71
- */
70
+ * DigitalOcean Spaces key.
71
+ */
72
72
  key: string;
73
73
  /**
74
- * DigitalOcean Spaces region.
75
- */
74
+ * DigitalOcean Spaces region.
75
+ */
76
76
  region: string;
77
77
  /**
78
- * DigitalOcean Spaces secret.
79
- */
78
+ * DigitalOcean Spaces secret.
79
+ */
80
80
  secret: string;
81
81
  };
82
82
  type CreateTigrisClientParameters = {
83
83
  /**
84
- * Tigris access key ID.
85
- */
84
+ * Tigris access key ID.
85
+ */
86
86
  accessKeyId: string;
87
87
  /**
88
- * Tigris endpoint.
89
- * @default `https://t3.storage.dev`
90
- */
88
+ * Tigris endpoint.
89
+ * @default `https://t3.storage.dev`
90
+ */
91
91
  endpoint?: string;
92
92
  /**
93
- * Tigris secret access key.
94
- */
93
+ * Tigris secret access key.
94
+ */
95
95
  secretAccessKey: string;
96
96
  };
97
97
  type CreateHetznerClientParameters = {
98
98
  /**
99
- * Hetzner Object Storage access key ID.
100
- */
99
+ * Hetzner Object Storage access key ID.
100
+ */
101
101
  accessKeyId: string;
102
102
  /**
103
- * Hetzner Object Storage location. Used as both the region and the
104
- * subdomain of the endpoint (`https://{location}.your-objectstorage.com`).
105
- */
103
+ * Hetzner Object Storage location. Used as both the region and the
104
+ * subdomain of the endpoint (`https://{location}.your-objectstorage.com`).
105
+ */
106
106
  location: "fsn1" | "hel1" | "nbg1";
107
107
  /**
108
- * Hetzner Object Storage secret access key.
109
- */
108
+ * Hetzner Object Storage secret access key.
109
+ */
110
110
  secretAccessKey: string;
111
111
  };
112
112
  type CreateAkamaiClientParameters = {
113
113
  /**
114
- * Akamai Cloud Object Storage access key ID.
115
- */
114
+ * Akamai Cloud Object Storage access key ID.
115
+ */
116
116
  accessKeyId: string;
117
117
  /**
118
- * Override the endpoint. When unset, defaults to
119
- * `https://${region}.linodeobjects.com`. The `linodeobjects.com` domain
120
- * is unchanged from the Linode era — only the product branding moved
121
- * to Akamai.
122
- */
118
+ * Override the endpoint. When unset, defaults to
119
+ * `https://${region}.linodeobjects.com`. The `linodeobjects.com` domain
120
+ * is unchanged from the Linode era — only the product branding moved
121
+ * to Akamai.
122
+ */
123
123
  endpoint?: string;
124
124
  /**
125
- * Akamai Cloud Object Storage region/cluster code (formerly Linode Object
126
- * Storage). Examples: `"us-iad-1"`, `"us-mia-1"`, `"us-ord-1"`,
127
- * `"nl-ams-1"`, `"fr-par-1"`, `"gb-lon-1"`, `"jp-osa-1"`, plus the older
128
- * `"us-east-1"` / `"eu-central-1"` / `"ap-south-1"` clusters.
129
- */
125
+ * Akamai Cloud Object Storage region/cluster code (formerly Linode Object
126
+ * Storage). Examples: `"us-iad-1"`, `"us-mia-1"`, `"us-ord-1"`,
127
+ * `"nl-ams-1"`, `"fr-par-1"`, `"gb-lon-1"`, `"jp-osa-1"`, plus the older
128
+ * `"us-east-1"` / `"eu-central-1"` / `"ap-south-1"` clusters.
129
+ */
130
130
  region: string;
131
131
  /**
132
- * Akamai Cloud Object Storage secret access key.
133
- */
132
+ * Akamai Cloud Object Storage secret access key.
133
+ */
134
134
  secretAccessKey: string;
135
135
  };
136
136
  type CreateStorjClientParameters = {
137
137
  /**
138
- * Storj S3 Gateway access key (derived from a Storj access grant).
139
- */
138
+ * Storj S3 Gateway access key (derived from a Storj access grant).
139
+ */
140
140
  accessKeyId: string;
141
141
  /**
142
- * Override the Storj S3 Gateway endpoint.
143
- * @default `https://gateway.storjshare.io`
144
- */
142
+ * Override the Storj S3 Gateway endpoint.
143
+ * @default `https://gateway.storjshare.io`
144
+ */
145
145
  endpoint?: string;
146
146
  /**
147
- * Storj S3 Gateway secret key (derived from a Storj access grant).
148
- */
147
+ * Storj S3 Gateway secret key (derived from a Storj access grant).
148
+ */
149
149
  secretAccessKey: string;
150
150
  };
151
151
  type CreateScalewayClientParameters = {
152
152
  /**
153
- * Scaleway Object Storage access key ID.
154
- */
153
+ * Scaleway Object Storage access key ID.
154
+ */
155
155
  accessKeyId: string;
156
156
  /**
157
- * Override the endpoint. When unset, defaults to
158
- * `https://s3.${region}.scw.cloud`.
159
- */
157
+ * Override the endpoint. When unset, defaults to
158
+ * `https://s3.${region}.scw.cloud`.
159
+ */
160
160
  endpoint?: string;
161
161
  /**
162
- * Scaleway region. Used as both the S3 region and the endpoint subdomain.
163
- */
162
+ * Scaleway region. Used as both the S3 region and the endpoint subdomain.
163
+ */
164
164
  region: "fr-par" | "nl-ams" | "pl-waw";
165
165
  /**
166
- * Scaleway Object Storage secret access key.
167
- */
166
+ * Scaleway Object Storage secret access key.
167
+ */
168
168
  secretAccessKey: string;
169
169
  };
170
170
  type CreateVultrClientParameters = {
171
171
  /**
172
- * Vultr Object Storage access key.
173
- */
172
+ * Vultr Object Storage access key.
173
+ */
174
174
  accessKeyId: string;
175
175
  /**
176
- * Vultr Object Storage cluster/location code. Used as both the S3 region
177
- * and the endpoint subdomain (`https://{location}.vultrobjects.com`).
178
- * Examples: `"ewr1"`, `"sjc1"`, `"ams1"`, `"sgp1"`, `"del1"`, `"blr1"`.
179
- */
176
+ * Vultr Object Storage cluster/location code. Used as both the S3 region
177
+ * and the endpoint subdomain (`https://{location}.vultrobjects.com`).
178
+ * Examples: `"ewr1"`, `"sjc1"`, `"ams1"`, `"sgp1"`, `"del1"`, `"blr1"`.
179
+ */
180
180
  location: string;
181
181
  /**
182
- * Vultr Object Storage secret key.
183
- */
182
+ * Vultr Object Storage secret key.
183
+ */
184
184
  secretAccessKey: string;
185
185
  };
186
186
  type CreateExoscaleClientParameters = {
187
187
  /**
188
- * Exoscale SOS API key.
189
- */
188
+ * Exoscale SOS API key.
189
+ */
190
190
  accessKeyId: string;
191
191
  /**
192
- * Exoscale SOS API secret.
193
- */
192
+ * Exoscale SOS API secret.
193
+ */
194
194
  secretAccessKey: string;
195
195
  /**
196
- * Exoscale zone. Used as both the S3 region and the endpoint subdomain
197
- * (`https://sos-{zone}.exo.io`). Examples: `"ch-gva-2"`, `"ch-dk-2"`,
198
- * `"de-fra-1"`, `"de-muc-1"`, `"at-vie-1"`, `"at-vie-2"`, `"bg-sof-1"`.
199
- */
196
+ * Exoscale zone. Used as both the S3 region and the endpoint subdomain
197
+ * (`https://sos-{zone}.exo.io`). Examples: `"ch-gva-2"`, `"ch-dk-2"`,
198
+ * `"de-fra-1"`, `"de-muc-1"`, `"at-vie-1"`, `"at-vie-2"`, `"bg-sof-1"`.
199
+ */
200
200
  zone: string;
201
201
  };
202
202
  type CreateFilebaseClientParameters = {
203
203
  /**
204
- * Filebase access key.
205
- */
204
+ * Filebase access key.
205
+ */
206
206
  accessKeyId: string;
207
207
  /**
208
- * Override the Filebase endpoint.
209
- * @default `https://s3.filebase.com`
210
- */
208
+ * Override the Filebase endpoint.
209
+ * @default `https://s3.filebase.com`
210
+ */
211
211
  endpoint?: string;
212
212
  /**
213
- * Filebase secret key.
214
- */
213
+ * Filebase secret key.
214
+ */
215
215
  secretAccessKey: string;
216
216
  };
217
217
  type CreateIDriveE2ClientParameters = {
218
218
  /**
219
- * iDrive e2 access key ID.
220
- */
219
+ * iDrive e2 access key ID.
220
+ */
221
221
  accessKeyId: string;
222
222
  /**
223
- * iDrive e2 endpoint. Account/region specific (assigned by iDrive), e.g.
224
- * `https://x9y8.va.idrivee2-12.com` — there is no deterministic default,
225
- * so the endpoint must be supplied.
226
- */
223
+ * iDrive e2 endpoint. Account/region specific (assigned by iDrive), e.g.
224
+ * `https://x9y8.va.idrivee2-12.com` — there is no deterministic default,
225
+ * so the endpoint must be supplied.
226
+ */
227
227
  endpoint: string;
228
228
  /**
229
- * iDrive e2 region.
230
- * @default `us-east-1`
231
- */
229
+ * iDrive e2 region.
230
+ * @default `us-east-1`
231
+ */
232
232
  region?: string;
233
233
  /**
234
- * iDrive e2 secret access key.
235
- */
234
+ * iDrive e2 secret access key.
235
+ */
236
236
  secretAccessKey: string;
237
237
  };
238
238
  type CreateIbmCosClientParameters = {
239
239
  /**
240
- * IBM Cloud Object Storage HMAC access key ID.
241
- */
240
+ * IBM Cloud Object Storage HMAC access key ID.
241
+ */
242
242
  accessKeyId: string;
243
243
  /**
244
- * Override the endpoint. When unset, defaults to
245
- * `https://s3.${region}.cloud-object-storage.appdomain.cloud`.
246
- */
244
+ * Override the endpoint. When unset, defaults to
245
+ * `https://s3.${region}.cloud-object-storage.appdomain.cloud`.
246
+ */
247
247
  endpoint?: string;
248
248
  /**
249
- * IBM COS region. Used as both the S3 region and the endpoint subdomain.
250
- * Examples: `"us-south"`, `"us-east"`, `"eu-gb"`, `"eu-de"`, `"jp-tok"`,
251
- * `"au-syd"`, `"ca-tor"`, `"br-sao"`.
252
- */
249
+ * IBM COS region. Used as both the S3 region and the endpoint subdomain.
250
+ * Examples: `"us-south"`, `"us-east"`, `"eu-gb"`, `"eu-de"`, `"jp-tok"`,
251
+ * `"au-syd"`, `"ca-tor"`, `"br-sao"`.
252
+ */
253
253
  region: string;
254
254
  /**
255
- * IBM Cloud Object Storage HMAC secret access key.
256
- */
255
+ * IBM Cloud Object Storage HMAC secret access key.
256
+ */
257
257
  secretAccessKey: string;
258
258
  };
259
259
  type CreateOracleCloudClientParameters = {
260
260
  /**
261
- * OCI Object Storage Customer Secret Key access key ID.
262
- */
261
+ * OCI Object Storage Customer Secret Key access key ID.
262
+ */
263
263
  accessKeyId: string;
264
264
  /**
265
- * Object Storage namespace (tenancy-specific). Forms part of the endpoint
266
- * host: `https://{namespace}.compat.objectstorage.{region}.oraclecloud.com`.
267
- */
265
+ * Object Storage namespace (tenancy-specific). Forms part of the endpoint
266
+ * host: `https://{namespace}.compat.objectstorage.{region}.oraclecloud.com`.
267
+ */
268
268
  namespace: string;
269
269
  /**
270
- * OCI region. Examples: `"us-ashburn-1"`, `"us-phoenix-1"`,
271
- * `"eu-frankfurt-1"`, `"uk-london-1"`, `"ap-tokyo-1"`.
272
- */
270
+ * OCI region. Examples: `"us-ashburn-1"`, `"us-phoenix-1"`,
271
+ * `"eu-frankfurt-1"`, `"uk-london-1"`, `"ap-tokyo-1"`.
272
+ */
273
273
  region: string;
274
274
  /**
275
- * OCI Object Storage Customer Secret Key.
276
- */
275
+ * OCI Object Storage Customer Secret Key.
276
+ */
277
277
  secretAccessKey: string;
278
278
  };
279
279
  type CreateOvhCloudClientParameters = {
280
280
  /**
281
- * OVHcloud Object Storage access key.
282
- */
281
+ * OVHcloud Object Storage access key.
282
+ */
283
283
  accessKeyId: string;
284
284
  /**
285
- * Override the endpoint. When unset, defaults to the High Performance
286
- * (S3) endpoint `https://s3.${region}.io.cloud.ovh.net`. For the
287
- * Standard (Swift) offering pass `https://s3.${region}.cloud.ovh.net`.
288
- */
285
+ * Override the endpoint. When unset, defaults to the High Performance
286
+ * (S3) endpoint `https://s3.${region}.io.cloud.ovh.net`. For the
287
+ * Standard (Swift) offering pass `https://s3.${region}.cloud.ovh.net`.
288
+ */
289
289
  endpoint?: string;
290
290
  /**
291
- * OVHcloud region. Used as both the S3 region and the endpoint subdomain.
292
- * Examples: `"gra"`, `"sbg"`, `"de"`, `"uk"`, `"waw"`, `"bhs"`, `"rbx"`.
293
- */
291
+ * OVHcloud region. Used as both the S3 region and the endpoint subdomain.
292
+ * Examples: `"gra"`, `"sbg"`, `"de"`, `"uk"`, `"waw"`, `"bhs"`, `"rbx"`.
293
+ */
294
294
  region: string;
295
295
  /**
296
- * OVHcloud Object Storage secret key.
297
- */
296
+ * OVHcloud Object Storage secret key.
297
+ */
298
298
  secretAccessKey: string;
299
299
  };
300
300
  type CreateAlibabaClientParameters = {
301
301
  /**
302
- * Alibaba Cloud OSS access key ID.
303
- */
302
+ * Alibaba Cloud OSS access key ID.
303
+ */
304
304
  accessKeyId: string;
305
305
  /**
306
- * Override the endpoint. When unset, defaults to
307
- * `https://oss-${region}.aliyuncs.com`.
308
- */
306
+ * Override the endpoint. When unset, defaults to
307
+ * `https://oss-${region}.aliyuncs.com`.
308
+ */
309
309
  endpoint?: string;
310
310
  /**
311
- * Alibaba Cloud OSS region. Used as both the S3 region and the endpoint
312
- * subdomain. Examples: `"cn-hangzhou"`, `"cn-shanghai"`, `"cn-beijing"`,
313
- * `"ap-southeast-1"`, `"us-east-1"`, `"eu-central-1"`.
314
- */
311
+ * Alibaba Cloud OSS region. Used as both the S3 region and the endpoint
312
+ * subdomain. Examples: `"cn-hangzhou"`, `"cn-shanghai"`, `"cn-beijing"`,
313
+ * `"ap-southeast-1"`, `"us-east-1"`, `"eu-central-1"`.
314
+ */
315
315
  region: string;
316
316
  /**
317
- * Alibaba Cloud OSS access key secret.
318
- */
317
+ * Alibaba Cloud OSS access key secret.
318
+ */
319
319
  secretAccessKey: string;
320
320
  };
321
321
  type CreateTencentClientParameters = {
322
322
  /**
323
- * Tencent COS secret ID.
324
- */
323
+ * Tencent COS secret ID.
324
+ */
325
325
  accessKeyId: string;
326
326
  /**
327
- * Override the endpoint. When unset, defaults to
328
- * `https://cos.${region}.myqcloud.com`.
329
- */
327
+ * Override the endpoint. When unset, defaults to
328
+ * `https://cos.${region}.myqcloud.com`.
329
+ */
330
330
  endpoint?: string;
331
331
  /**
332
- * Tencent COS region. Used as both the S3 region and the endpoint
333
- * subdomain. Examples: `"ap-guangzhou"`, `"ap-shanghai"`, `"ap-beijing"`,
334
- * `"ap-singapore"`, `"na-siliconvalley"`, `"eu-frankfurt"`.
335
- */
332
+ * Tencent COS region. Used as both the S3 region and the endpoint
333
+ * subdomain. Examples: `"ap-guangzhou"`, `"ap-shanghai"`, `"ap-beijing"`,
334
+ * `"ap-singapore"`, `"na-siliconvalley"`, `"eu-frankfurt"`.
335
+ */
336
336
  region: string;
337
337
  /**
338
- * Tencent COS secret key.
339
- */
338
+ * Tencent COS secret key.
339
+ */
340
340
  secretAccessKey: string;
341
341
  };
342
342
  type CreateYandexClientParameters = {
343
343
  /**
344
- * Yandex Object Storage access key ID.
345
- */
344
+ * Yandex Object Storage access key ID.
345
+ */
346
346
  accessKeyId: string;
347
347
  /**
348
- * Override the Yandex Object Storage endpoint.
349
- * @default `https://storage.yandexcloud.net`
350
- */
348
+ * Override the Yandex Object Storage endpoint.
349
+ * @default `https://storage.yandexcloud.net`
350
+ */
351
351
  endpoint?: string;
352
352
  /**
353
- * SigV4 signing region. Yandex serves a single global endpoint, so this
354
- * does not drive routing.
355
- * @default `ru-central1`
356
- */
353
+ * SigV4 signing region. Yandex serves a single global endpoint, so this
354
+ * does not drive routing.
355
+ * @default `ru-central1`
356
+ */
357
357
  region?: string;
358
358
  /**
359
- * Yandex Object Storage secret access key.
360
- */
359
+ * Yandex Object Storage secret access key.
360
+ */
361
361
  secretAccessKey: string;
362
362
  };
363
363
  /**
364
- * Create an Akamai Cloud Object Storage client, compatible with the S3 API.
365
- *
366
- * Akamai Cloud Object Storage is the rebranded Linode Object Storage; the
367
- * underlying `linodeobjects.com` domain is unchanged.
368
- *
369
- * Optionally, you can omit the parameters and use the following environment variables:
370
- * - `AWS_ACCESS_KEY_ID` / `AKAMAI_ACCESS_KEY_ID`
371
- * - `AWS_SECRET_ACCESS_KEY` / `AKAMAI_SECRET_ACCESS_KEY`
372
- * - `AKAMAI_REGION` (e.g. `us-iad-1`)
373
- */
364
+ * Create an Akamai Cloud Object Storage client, compatible with the S3 API.
365
+ *
366
+ * Akamai Cloud Object Storage is the rebranded Linode Object Storage; the
367
+ * underlying `linodeobjects.com` domain is unchanged.
368
+ *
369
+ * Optionally, you can omit the parameters and use the following environment variables:
370
+ * - `AWS_ACCESS_KEY_ID` / `AKAMAI_ACCESS_KEY_ID`
371
+ * - `AWS_SECRET_ACCESS_KEY` / `AKAMAI_SECRET_ACCESS_KEY`
372
+ * - `AKAMAI_REGION` (e.g. `us-iad-1`)
373
+ */
374
374
  declare const akamai: (parameters?: Partial<CreateAkamaiClientParameters>) => S3ClientConfig;
375
375
  /**
376
- * Create an Alibaba Cloud OSS client, compatible with the S3 API.
377
- *
378
- * The region is part of the default endpoint hostname, so it is not read
379
- * from `AWS_REGION` (which is commonly set to an AWS region in dev/CI and
380
- * would silently produce a broken endpoint).
381
- *
382
- * Optionally, you can omit the parameters and use the following environment variables:
383
- * - `AWS_ACCESS_KEY_ID` / `ALIBABA_ACCESS_KEY_ID`
384
- * - `AWS_SECRET_ACCESS_KEY` / `ALIBABA_ACCESS_KEY_SECRET`
385
- * - `ALIBABA_REGION` (e.g. `cn-hangzhou`, `ap-southeast-1`, `eu-central-1`)
386
- * - `ALIBABA_ENDPOINT`
387
- */
376
+ * Create an Alibaba Cloud OSS client, compatible with the S3 API.
377
+ *
378
+ * The region is part of the default endpoint hostname, so it is not read
379
+ * from `AWS_REGION` (which is commonly set to an AWS region in dev/CI and
380
+ * would silently produce a broken endpoint).
381
+ *
382
+ * Optionally, you can omit the parameters and use the following environment variables:
383
+ * - `AWS_ACCESS_KEY_ID` / `ALIBABA_ACCESS_KEY_ID`
384
+ * - `AWS_SECRET_ACCESS_KEY` / `ALIBABA_ACCESS_KEY_SECRET`
385
+ * - `ALIBABA_REGION` (e.g. `cn-hangzhou`, `ap-southeast-1`, `eu-central-1`)
386
+ * - `ALIBABA_ENDPOINT`
387
+ */
388
388
  declare const alibaba: (parameters?: CreateAlibabaClientParameters) => S3ClientConfig;
389
389
  /**
390
- * Create a Backblaze B2 client, compatible with the S3 API.
391
- *
392
- * Optionally, you can omit the parameters and use the following environment variables:
393
- * - `B2_REGION`
394
- * - `B2_APP_KEY_ID`
395
- * - `B2_APP_KEY`
396
- */
390
+ * Create a Backblaze B2 client, compatible with the S3 API.
391
+ *
392
+ * Optionally, you can omit the parameters and use the following environment variables:
393
+ * - `B2_REGION`
394
+ * - `B2_APP_KEY_ID`
395
+ * - `B2_APP_KEY`
396
+ */
397
397
  declare const backblaze: (parameters?: CreateBackblazeClientParameters) => S3ClientConfig;
398
398
  /**
399
- * Create a Cloudflare R2 client, compatible with the S3 API.
400
- *
401
- * Optionally, you can omit the parameters and use the following environment variables:
402
- * - `CLOUDFLARE_ACCOUNT_ID`
403
- * - `AWS_ACCESS_KEY_ID`
404
- * - `AWS_SECRET_ACCESS_KEY`
405
- * - `CLOUDFLARE_JURISDICTION`
406
- */
399
+ * Create a Cloudflare R2 client, compatible with the S3 API.
400
+ *
401
+ * Optionally, you can omit the parameters and use the following environment variables:
402
+ * - `CLOUDFLARE_ACCOUNT_ID`
403
+ * - `AWS_ACCESS_KEY_ID`
404
+ * - `AWS_SECRET_ACCESS_KEY`
405
+ * - `CLOUDFLARE_JURISDICTION`
406
+ */
407
407
  declare const cloudflare: (parameters?: CreateCloudflareClientParameters) => S3ClientConfig;
408
408
  /**
409
- * Create a DigitalOcean Spaces client, compatible with the S3 API.
410
- *
411
- * Optionally, you can omit the parameters and use the following environment variables:
412
- * - `SPACES_REGION`
413
- * - `SPACES_KEY`
414
- * - `SPACES_SECRET`
415
- */
409
+ * Create a DigitalOcean Spaces client, compatible with the S3 API.
410
+ *
411
+ * Optionally, you can omit the parameters and use the following environment variables:
412
+ * - `SPACES_REGION`
413
+ * - `SPACES_KEY`
414
+ * - `SPACES_SECRET`
415
+ */
416
416
  declare const digitalOcean: (parameters?: CreateDigitalOceanClientParameters) => S3ClientConfig;
417
417
  /**
418
- * Create an Exoscale SOS client, compatible with the S3 API.
419
- *
420
- * The zone is part of the endpoint hostname, so it is not read from
421
- * `AWS_REGION` (which is commonly set to an AWS region in dev/CI and would
422
- * silently produce a broken endpoint).
423
- *
424
- * Optionally, you can omit the parameters and use the following environment variables:
425
- * - `AWS_ACCESS_KEY_ID` / `EXOSCALE_ACCESS_KEY_ID`
426
- * - `AWS_SECRET_ACCESS_KEY` / `EXOSCALE_SECRET_ACCESS_KEY`
427
- * - `EXOSCALE_ZONE` (e.g. `ch-gva-2`, `de-fra-1`, `at-vie-1`)
428
- */
418
+ * Create an Exoscale SOS client, compatible with the S3 API.
419
+ *
420
+ * The zone is part of the endpoint hostname, so it is not read from
421
+ * `AWS_REGION` (which is commonly set to an AWS region in dev/CI and would
422
+ * silently produce a broken endpoint).
423
+ *
424
+ * Optionally, you can omit the parameters and use the following environment variables:
425
+ * - `AWS_ACCESS_KEY_ID` / `EXOSCALE_ACCESS_KEY_ID`
426
+ * - `AWS_SECRET_ACCESS_KEY` / `EXOSCALE_SECRET_ACCESS_KEY`
427
+ * - `EXOSCALE_ZONE` (e.g. `ch-gva-2`, `de-fra-1`, `at-vie-1`)
428
+ */
429
429
  declare const exoscale: (parameters?: CreateExoscaleClientParameters) => S3ClientConfig;
430
430
  /**
431
- * Create a Filebase client, compatible with the S3 API.
432
- *
433
- * Filebase exposes a single global endpoint and ignores the region, so only
434
- * credentials are required.
435
- *
436
- * Optionally, you can omit the parameters and use the following environment variables:
437
- * - `AWS_ACCESS_KEY_ID` / `FILEBASE_ACCESS_KEY_ID`
438
- * - `AWS_SECRET_ACCESS_KEY` / `FILEBASE_SECRET_ACCESS_KEY`
439
- * - `FILEBASE_ENDPOINT` (defaults to `https://s3.filebase.com`)
440
- */
431
+ * Create a Filebase client, compatible with the S3 API.
432
+ *
433
+ * Filebase exposes a single global endpoint and ignores the region, so only
434
+ * credentials are required.
435
+ *
436
+ * Optionally, you can omit the parameters and use the following environment variables:
437
+ * - `AWS_ACCESS_KEY_ID` / `FILEBASE_ACCESS_KEY_ID`
438
+ * - `AWS_SECRET_ACCESS_KEY` / `FILEBASE_SECRET_ACCESS_KEY`
439
+ * - `FILEBASE_ENDPOINT` (defaults to `https://s3.filebase.com`)
440
+ */
441
441
  declare const filebase: (parameters?: CreateFilebaseClientParameters) => S3ClientConfig;
442
442
  /**
443
- * Create a Hetzner Object Storage client, compatible with the S3 API.
444
- *
445
- * Optionally, you can omit the parameters and use the following environment variables:
446
- * - `AWS_ACCESS_KEY_ID` / `HETZNER_ACCESS_KEY_ID`
447
- * - `AWS_SECRET_ACCESS_KEY` / `HETZNER_SECRET_ACCESS_KEY`
448
- * - `HETZNER_LOCATION` (one of `fsn1`, `nbg1`, `hel1`)
449
- */
443
+ * Create a Hetzner Object Storage client, compatible with the S3 API.
444
+ *
445
+ * Optionally, you can omit the parameters and use the following environment variables:
446
+ * - `AWS_ACCESS_KEY_ID` / `HETZNER_ACCESS_KEY_ID`
447
+ * - `AWS_SECRET_ACCESS_KEY` / `HETZNER_SECRET_ACCESS_KEY`
448
+ * - `HETZNER_LOCATION` (one of `fsn1`, `nbg1`, `hel1`)
449
+ */
450
450
  declare const hetzner: (parameters?: CreateHetznerClientParameters) => S3ClientConfig;
451
451
  /**
452
- * Create an IBM Cloud Object Storage client, compatible with the S3 API.
453
- *
454
- * Requires HMAC credentials (a Customer Secret Key, not an IAM API key).
455
- *
456
- * The region is part of the default endpoint hostname, so it is not read
457
- * from `AWS_REGION` (which is commonly set to an AWS region in dev/CI and
458
- * would silently produce a broken endpoint).
459
- *
460
- * Optionally, you can omit the parameters and use the following environment variables:
461
- * - `AWS_ACCESS_KEY_ID` / `IBM_COS_ACCESS_KEY_ID`
462
- * - `AWS_SECRET_ACCESS_KEY` / `IBM_COS_SECRET_ACCESS_KEY`
463
- * - `IBM_COS_REGION` (e.g. `us-south`, `eu-de`, `jp-tok`)
464
- * - `IBM_COS_ENDPOINT`
465
- */
452
+ * Create an IBM Cloud Object Storage client, compatible with the S3 API.
453
+ *
454
+ * Requires HMAC credentials (a Customer Secret Key, not an IAM API key).
455
+ *
456
+ * The region is part of the default endpoint hostname, so it is not read
457
+ * from `AWS_REGION` (which is commonly set to an AWS region in dev/CI and
458
+ * would silently produce a broken endpoint).
459
+ *
460
+ * Optionally, you can omit the parameters and use the following environment variables:
461
+ * - `AWS_ACCESS_KEY_ID` / `IBM_COS_ACCESS_KEY_ID`
462
+ * - `AWS_SECRET_ACCESS_KEY` / `IBM_COS_SECRET_ACCESS_KEY`
463
+ * - `IBM_COS_REGION` (e.g. `us-south`, `eu-de`, `jp-tok`)
464
+ * - `IBM_COS_ENDPOINT`
465
+ */
466
466
  declare const ibmCos: (parameters?: CreateIbmCosClientParameters) => S3ClientConfig;
467
467
  /**
468
- * Create an iDrive e2 client, compatible with the S3 API.
469
- *
470
- * iDrive e2 endpoints are account/region specific and assigned by iDrive
471
- * (e.g. `https://x9y8.va.idrivee2-12.com`), so the endpoint must be supplied.
472
- *
473
- * Optionally, you can omit the parameters and use the following environment variables:
474
- * - `AWS_ACCESS_KEY_ID` / `IDRIVE_E2_ACCESS_KEY_ID`
475
- * - `AWS_SECRET_ACCESS_KEY` / `IDRIVE_E2_SECRET_ACCESS_KEY`
476
- * - `IDRIVE_E2_ENDPOINT`
477
- * - `IDRIVE_E2_REGION` (defaults to `us-east-1`)
478
- */
468
+ * Create an iDrive e2 client, compatible with the S3 API.
469
+ *
470
+ * iDrive e2 endpoints are account/region specific and assigned by iDrive
471
+ * (e.g. `https://x9y8.va.idrivee2-12.com`), so the endpoint must be supplied.
472
+ *
473
+ * Optionally, you can omit the parameters and use the following environment variables:
474
+ * - `AWS_ACCESS_KEY_ID` / `IDRIVE_E2_ACCESS_KEY_ID`
475
+ * - `AWS_SECRET_ACCESS_KEY` / `IDRIVE_E2_SECRET_ACCESS_KEY`
476
+ * - `IDRIVE_E2_ENDPOINT`
477
+ * - `IDRIVE_E2_REGION` (defaults to `us-east-1`)
478
+ */
479
479
  declare const idriveE2: (parameters?: CreateIDriveE2ClientParameters) => S3ClientConfig;
480
480
  /**
481
- * Create a Minio client, compatible with the S3 API.
482
- *
483
- * Optionally, you can omit the parameters and use the following environment variables:
484
- * - `AWS_REGION`
485
- * - `AWS_ACCESS_KEY_ID`
486
- * - `AWS_SECRET_ACCESS_KEY`
487
- * - `MINIO_ENDPOINT`
488
- */
481
+ * Create a Minio client, compatible with the S3 API.
482
+ *
483
+ * Optionally, you can omit the parameters and use the following environment variables:
484
+ * - `AWS_REGION`
485
+ * - `AWS_ACCESS_KEY_ID`
486
+ * - `AWS_SECRET_ACCESS_KEY`
487
+ * - `MINIO_ENDPOINT`
488
+ */
489
489
  declare const minio: (parameters?: CreateMinioClientParameters) => S3ClientConfig;
490
490
  /**
491
- * Create an Oracle Cloud Infrastructure (OCI) Object Storage client, using
492
- * the S3 Compatibility API.
493
- *
494
- * Requires a Customer Secret Key (generated under the user's API keys) and
495
- * the tenancy's Object Storage namespace.
496
- *
497
- * The region is part of the endpoint hostname, so it is not read from
498
- * `AWS_REGION` (commonly set to an AWS region in dev/CI, which would
499
- * silently produce a broken endpoint).
500
- *
501
- * Optionally, you can omit the parameters and use the following environment variables:
502
- * - `AWS_ACCESS_KEY_ID` / `ORACLE_CLOUD_ACCESS_KEY_ID`
503
- * - `AWS_SECRET_ACCESS_KEY` / `ORACLE_CLOUD_SECRET_ACCESS_KEY`
504
- * - `ORACLE_CLOUD_NAMESPACE`
505
- * - `ORACLE_CLOUD_REGION` (e.g. `us-ashburn-1`, `eu-frankfurt-1`)
506
- */
491
+ * Create an Oracle Cloud Infrastructure (OCI) Object Storage client, using
492
+ * the S3 Compatibility API.
493
+ *
494
+ * Requires a Customer Secret Key (generated under the user's API keys) and
495
+ * the tenancy's Object Storage namespace.
496
+ *
497
+ * The region is part of the endpoint hostname, so it is not read from
498
+ * `AWS_REGION` (commonly set to an AWS region in dev/CI, which would
499
+ * silently produce a broken endpoint).
500
+ *
501
+ * Optionally, you can omit the parameters and use the following environment variables:
502
+ * - `AWS_ACCESS_KEY_ID` / `ORACLE_CLOUD_ACCESS_KEY_ID`
503
+ * - `AWS_SECRET_ACCESS_KEY` / `ORACLE_CLOUD_SECRET_ACCESS_KEY`
504
+ * - `ORACLE_CLOUD_NAMESPACE`
505
+ * - `ORACLE_CLOUD_REGION` (e.g. `us-ashburn-1`, `eu-frankfurt-1`)
506
+ */
507
507
  declare const oracleCloud: (parameters?: CreateOracleCloudClientParameters) => S3ClientConfig;
508
508
  /**
509
- * Create an OVHcloud Object Storage client, compatible with the S3 API.
510
- *
511
- * Defaults to the High Performance (S3) endpoint. For the Standard (Swift)
512
- * offering pass `endpoint: https://s3.{region}.cloud.ovh.net`.
513
- *
514
- * The region is part of the default endpoint hostname and the SigV4 signing
515
- * scope, both of which require lowercase, so the region is lowercased (the
516
- * OVH console displays it uppercase, e.g. `GRA`). It is not read from
517
- * `AWS_REGION` (commonly set to an AWS region in dev/CI, which would
518
- * silently produce a broken endpoint).
519
- *
520
- * Optionally, you can omit the parameters and use the following environment variables:
521
- * - `AWS_ACCESS_KEY_ID` / `OVHCLOUD_ACCESS_KEY_ID`
522
- * - `AWS_SECRET_ACCESS_KEY` / `OVHCLOUD_SECRET_ACCESS_KEY`
523
- * - `OVHCLOUD_REGION` (e.g. `gra`, `sbg`, `de`, `uk`, `waw`, `bhs`)
524
- * - `OVHCLOUD_ENDPOINT`
525
- */
509
+ * Create an OVHcloud Object Storage client, compatible with the S3 API.
510
+ *
511
+ * Defaults to the High Performance (S3) endpoint. For the Standard (Swift)
512
+ * offering pass `endpoint: https://s3.{region}.cloud.ovh.net`.
513
+ *
514
+ * The region is part of the default endpoint hostname and the SigV4 signing
515
+ * scope, both of which require lowercase, so the region is lowercased (the
516
+ * OVH console displays it uppercase, e.g. `GRA`). It is not read from
517
+ * `AWS_REGION` (commonly set to an AWS region in dev/CI, which would
518
+ * silently produce a broken endpoint).
519
+ *
520
+ * Optionally, you can omit the parameters and use the following environment variables:
521
+ * - `AWS_ACCESS_KEY_ID` / `OVHCLOUD_ACCESS_KEY_ID`
522
+ * - `AWS_SECRET_ACCESS_KEY` / `OVHCLOUD_SECRET_ACCESS_KEY`
523
+ * - `OVHCLOUD_REGION` (e.g. `gra`, `sbg`, `de`, `uk`, `waw`, `bhs`)
524
+ * - `OVHCLOUD_ENDPOINT`
525
+ */
526
526
  declare const ovhCloud: (parameters?: CreateOvhCloudClientParameters) => S3ClientConfig;
527
527
  /**
528
- * Create a Scaleway Object Storage client, compatible with the S3 API.
529
- *
530
- * The region is part of the endpoint hostname, so it is not read from
531
- * `AWS_REGION` (which is commonly set to an AWS region in dev/CI and would
532
- * silently produce a broken endpoint).
533
- *
534
- * Optionally, you can omit the parameters and use the following environment variables:
535
- * - `AWS_ACCESS_KEY_ID` / `SCALEWAY_ACCESS_KEY_ID`
536
- * - `AWS_SECRET_ACCESS_KEY` / `SCALEWAY_SECRET_ACCESS_KEY`
537
- * - `SCALEWAY_REGION` (one of `fr-par`, `nl-ams`, `pl-waw`)
538
- */
528
+ * Create a Scaleway Object Storage client, compatible with the S3 API.
529
+ *
530
+ * The region is part of the endpoint hostname, so it is not read from
531
+ * `AWS_REGION` (which is commonly set to an AWS region in dev/CI and would
532
+ * silently produce a broken endpoint).
533
+ *
534
+ * Optionally, you can omit the parameters and use the following environment variables:
535
+ * - `AWS_ACCESS_KEY_ID` / `SCALEWAY_ACCESS_KEY_ID`
536
+ * - `AWS_SECRET_ACCESS_KEY` / `SCALEWAY_SECRET_ACCESS_KEY`
537
+ * - `SCALEWAY_REGION` (one of `fr-par`, `nl-ams`, `pl-waw`)
538
+ */
539
539
  declare const scaleway: (parameters?: CreateScalewayClientParameters) => S3ClientConfig;
540
540
  /**
541
- * Create a Storj S3 Gateway client, compatible with the S3 API.
542
- *
543
- * Credentials are derived from a Storj access grant via the
544
- * `storj.io/uplink` CLI or web console. The default endpoint targets the
545
- * global Storj S3 Gateway; self-hosted gateways can override via `endpoint`.
546
- *
547
- * Optionally, you can omit the parameters and use the following environment variables:
548
- * - `AWS_ACCESS_KEY_ID` / `STORJ_ACCESS_KEY_ID`
549
- * - `AWS_SECRET_ACCESS_KEY` / `STORJ_SECRET_ACCESS_KEY`
550
- * - `STORJ_ENDPOINT` (defaults to `https://gateway.storjshare.io`)
551
- */
541
+ * Create a Storj S3 Gateway client, compatible with the S3 API.
542
+ *
543
+ * Credentials are derived from a Storj access grant via the
544
+ * `storj.io/uplink` CLI or web console. The default endpoint targets the
545
+ * global Storj S3 Gateway; self-hosted gateways can override via `endpoint`.
546
+ *
547
+ * Optionally, you can omit the parameters and use the following environment variables:
548
+ * - `AWS_ACCESS_KEY_ID` / `STORJ_ACCESS_KEY_ID`
549
+ * - `AWS_SECRET_ACCESS_KEY` / `STORJ_SECRET_ACCESS_KEY`
550
+ * - `STORJ_ENDPOINT` (defaults to `https://gateway.storjshare.io`)
551
+ */
552
552
  declare const storj: (parameters?: CreateStorjClientParameters) => S3ClientConfig;
553
553
  /**
554
- * Create a Tencent Cloud COS client, compatible with the S3 API.
555
- *
556
- * The bucket name must include the APPID suffix (e.g.
557
- * `uploads-1250000000`); the S3-compatible API expects the full form.
558
- *
559
- * The region is part of the default endpoint hostname, so it is not read
560
- * from `AWS_REGION` (which is commonly set to an AWS region in dev/CI and
561
- * would silently produce a broken endpoint).
562
- *
563
- * Optionally, you can omit the parameters and use the following environment variables:
564
- * - `AWS_ACCESS_KEY_ID` / `TENCENT_SECRET_ID`
565
- * - `AWS_SECRET_ACCESS_KEY` / `TENCENT_SECRET_KEY`
566
- * - `TENCENT_REGION` (e.g. `ap-guangzhou`, `ap-singapore`, `eu-frankfurt`)
567
- * - `TENCENT_ENDPOINT`
568
- */
554
+ * Create a Tencent Cloud COS client, compatible with the S3 API.
555
+ *
556
+ * The bucket name must include the APPID suffix (e.g.
557
+ * `uploads-1250000000`); the S3-compatible API expects the full form.
558
+ *
559
+ * The region is part of the default endpoint hostname, so it is not read
560
+ * from `AWS_REGION` (which is commonly set to an AWS region in dev/CI and
561
+ * would silently produce a broken endpoint).
562
+ *
563
+ * Optionally, you can omit the parameters and use the following environment variables:
564
+ * - `AWS_ACCESS_KEY_ID` / `TENCENT_SECRET_ID`
565
+ * - `AWS_SECRET_ACCESS_KEY` / `TENCENT_SECRET_KEY`
566
+ * - `TENCENT_REGION` (e.g. `ap-guangzhou`, `ap-singapore`, `eu-frankfurt`)
567
+ * - `TENCENT_ENDPOINT`
568
+ */
569
569
  declare const tencent: (parameters?: CreateTencentClientParameters) => S3ClientConfig;
570
570
  /**
571
- * Create a Tigris client, compatible with the S3 API.
572
- *
573
- * Optionally, you can omit the parameters and use the following environment variables:
574
- * - `AWS_ACCESS_KEY_ID`
575
- * - `AWS_SECRET_ACCESS_KEY`
576
- * - `TIGRIS_ENDPOINT`
577
- */
571
+ * Create a Tigris client, compatible with the S3 API.
572
+ *
573
+ * Optionally, you can omit the parameters and use the following environment variables:
574
+ * - `AWS_ACCESS_KEY_ID`
575
+ * - `AWS_SECRET_ACCESS_KEY`
576
+ * - `TIGRIS_ENDPOINT`
577
+ */
578
578
  declare const tigris: (parameters?: CreateTigrisClientParameters) => S3ClientConfig;
579
579
  /**
580
- * Create a Vultr Object Storage client, compatible with the S3 API.
581
- *
582
- * Optionally, you can omit the parameters and use the following environment variables:
583
- * - `AWS_ACCESS_KEY_ID` / `VULTR_ACCESS_KEY_ID`
584
- * - `AWS_SECRET_ACCESS_KEY` / `VULTR_SECRET_ACCESS_KEY`
585
- * - `VULTR_LOCATION` (cluster code, e.g. `ewr1`, `sjc1`, `ams1`, `sgp1`)
586
- */
580
+ * Create a Vultr Object Storage client, compatible with the S3 API.
581
+ *
582
+ * Optionally, you can omit the parameters and use the following environment variables:
583
+ * - `AWS_ACCESS_KEY_ID` / `VULTR_ACCESS_KEY_ID`
584
+ * - `AWS_SECRET_ACCESS_KEY` / `VULTR_SECRET_ACCESS_KEY`
585
+ * - `VULTR_LOCATION` (cluster code, e.g. `ewr1`, `sjc1`, `ams1`, `sgp1`)
586
+ */
587
587
  declare const vultr: (parameters?: CreateVultrClientParameters) => S3ClientConfig;
588
588
  /**
589
- * Create a Wasabi client, compatible with the S3 API.
590
- *
591
- * Optionally, you can omit the parameters and use the following environment variables:
592
- * - `WASABI_REGION`
593
- * - `AWS_ACCESS_KEY_ID`
594
- * - `AWS_SECRET_ACCESS_KEY`
595
- */
589
+ * Create a Wasabi client, compatible with the S3 API.
590
+ *
591
+ * Optionally, you can omit the parameters and use the following environment variables:
592
+ * - `WASABI_REGION`
593
+ * - `AWS_ACCESS_KEY_ID`
594
+ * - `AWS_SECRET_ACCESS_KEY`
595
+ */
596
596
  declare const wasabi: (parameters?: CreateWasabiClientParameters) => S3ClientConfig;
597
597
  /**
598
- * Create a Yandex Object Storage client, compatible with the S3 API.
599
- *
600
- * Yandex serves a single global endpoint (`https://storage.yandexcloud.net`)
601
- * and routes internally, so the region is only the SigV4 signing scope and
602
- * defaults to `ru-central1`. It does not drive the endpoint, so falling back
603
- * to `AWS_REGION` is safe here.
604
- *
605
- * Optionally, you can omit the parameters and use the following environment variables:
606
- * - `AWS_ACCESS_KEY_ID` / `YANDEX_ACCESS_KEY_ID`
607
- * - `AWS_SECRET_ACCESS_KEY` / `YANDEX_SECRET_ACCESS_KEY`
608
- * - `AWS_REGION` / `YANDEX_REGION` (defaults to `ru-central1`)
609
- * - `YANDEX_ENDPOINT`
610
- */
598
+ * Create a Yandex Object Storage client, compatible with the S3 API.
599
+ *
600
+ * Yandex serves a single global endpoint (`https://storage.yandexcloud.net`)
601
+ * and routes internally, so the region is only the SigV4 signing scope and
602
+ * defaults to `ru-central1`. It does not drive the endpoint, so falling back
603
+ * to `AWS_REGION` is safe here.
604
+ *
605
+ * Optionally, you can omit the parameters and use the following environment variables:
606
+ * - `AWS_ACCESS_KEY_ID` / `YANDEX_ACCESS_KEY_ID`
607
+ * - `AWS_SECRET_ACCESS_KEY` / `YANDEX_SECRET_ACCESS_KEY`
608
+ * - `AWS_REGION` / `YANDEX_REGION` (defaults to `ru-central1`)
609
+ * - `YANDEX_ENDPOINT`
610
+ */
611
611
  declare const yandex: (parameters?: CreateYandexClientParameters) => S3ClientConfig;
612
612
  export { akamai, alibaba, backblaze, cloudflare, digitalOcean, exoscale, filebase, hetzner, ibmCos, idriveE2, minio, oracleCloud, ovhCloud, scaleway, storj, tencent, tigris, vultr, wasabi, yandex };