@scaleway/sdk-container 2.5.0 → 2.6.0

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.
File without changes
@@ -0,0 +1,263 @@
1
+ export declare const ContainerProbe: {
2
+ failureThreshold: {
3
+ greaterThanOrEqual: number;
4
+ lessThanOrEqual: number;
5
+ };
6
+ };
7
+ export declare const ContainerProbeHTTPProbe: {
8
+ path: {
9
+ maxLength: number;
10
+ minLength: number;
11
+ };
12
+ };
13
+ export declare const ContainerScalingOption: {};
14
+ export declare const CreateContainerRequest: {
15
+ description: {
16
+ maxLength: number;
17
+ };
18
+ image: {
19
+ maxLength: number;
20
+ };
21
+ localStorageLimitBytes: {
22
+ greaterThanOrEqual: number;
23
+ lessThanOrEqual: number;
24
+ };
25
+ maxScale: {
26
+ greaterThanOrEqual: number;
27
+ lessThanOrEqual: number;
28
+ };
29
+ memoryLimitBytes: {
30
+ greaterThanOrEqual: number;
31
+ lessThanOrEqual: number;
32
+ };
33
+ minScale: {
34
+ lessThanOrEqual: number;
35
+ };
36
+ mvcpuLimit: {
37
+ greaterThanOrEqual: number;
38
+ lessThanOrEqual: number;
39
+ };
40
+ name: {
41
+ maxLength: number;
42
+ minLength: number;
43
+ pattern: RegExp;
44
+ };
45
+ port: {
46
+ lessThanOrEqual: number;
47
+ };
48
+ privateNetworkId: {
49
+ ignoreEmpty: boolean;
50
+ };
51
+ };
52
+ export declare const CreateDomainRequest: {
53
+ hostname: {
54
+ maxLength: number;
55
+ minLength: number;
56
+ };
57
+ };
58
+ export declare const CreateNamespaceRequest: {
59
+ description: {
60
+ maxLength: number;
61
+ };
62
+ name: {
63
+ maxLength: number;
64
+ minLength: number;
65
+ pattern: RegExp;
66
+ };
67
+ };
68
+ export declare const CreateTriggerRequest: {
69
+ description: {
70
+ maxLength: number;
71
+ };
72
+ name: {
73
+ maxLength: number;
74
+ minLength: number;
75
+ };
76
+ };
77
+ export declare const CreateTriggerRequestCronConfig: {
78
+ body: {
79
+ maxLength: number;
80
+ };
81
+ schedule: {
82
+ maxLength: number;
83
+ minLength: number;
84
+ };
85
+ timezone: {
86
+ maxLength: number;
87
+ minLength: number;
88
+ };
89
+ };
90
+ export declare const CreateTriggerRequestDestinationConfig: {
91
+ httpPath: {
92
+ maxLength: number;
93
+ minLength: number;
94
+ prefix: string;
95
+ };
96
+ };
97
+ export declare const CreateTriggerRequestNATSConfig: {
98
+ credentialsFileContent: {
99
+ minLength: number;
100
+ };
101
+ subject: {
102
+ maxLength: number;
103
+ minLength: number;
104
+ pattern: RegExp;
105
+ };
106
+ };
107
+ export declare const CreateTriggerRequestSQSConfig: {
108
+ accessKeyId: {
109
+ minLength: number;
110
+ };
111
+ region: {
112
+ maxLength: number;
113
+ minLength: number;
114
+ };
115
+ secretAccessKey: {
116
+ minLength: number;
117
+ };
118
+ };
119
+ export declare const ListContainersRequest: {
120
+ name: {
121
+ maxLength: number;
122
+ minLength: number;
123
+ };
124
+ page: {
125
+ greaterThanOrEqual: number;
126
+ };
127
+ pageSize: {
128
+ greaterThanOrEqual: number;
129
+ lessThanOrEqual: number;
130
+ };
131
+ };
132
+ export declare const ListDomainsRequest: {
133
+ page: {
134
+ greaterThanOrEqual: number;
135
+ };
136
+ pageSize: {
137
+ greaterThanOrEqual: number;
138
+ lessThanOrEqual: number;
139
+ };
140
+ };
141
+ export declare const ListNamespacesRequest: {
142
+ name: {
143
+ maxLength: number;
144
+ minLength: number;
145
+ };
146
+ page: {
147
+ greaterThanOrEqual: number;
148
+ };
149
+ pageSize: {
150
+ greaterThanOrEqual: number;
151
+ lessThanOrEqual: number;
152
+ };
153
+ };
154
+ export declare const ListTriggersRequest: {
155
+ page: {
156
+ greaterThanOrEqual: number;
157
+ };
158
+ pageSize: {
159
+ greaterThanOrEqual: number;
160
+ lessThanOrEqual: number;
161
+ };
162
+ };
163
+ export declare const UpdateContainerRequest: {
164
+ description: {
165
+ maxLength: number;
166
+ };
167
+ image: {
168
+ maxLength: number;
169
+ };
170
+ localStorageLimitBytes: {
171
+ greaterThanOrEqual: number;
172
+ lessThanOrEqual: number;
173
+ };
174
+ maxScale: {
175
+ greaterThanOrEqual: number;
176
+ lessThanOrEqual: number;
177
+ };
178
+ memoryLimitBytes: {
179
+ greaterThanOrEqual: number;
180
+ lessThanOrEqual: number;
181
+ };
182
+ minScale: {
183
+ lessThanOrEqual: number;
184
+ };
185
+ mvcpuLimit: {
186
+ greaterThanOrEqual: number;
187
+ lessThanOrEqual: number;
188
+ };
189
+ port: {
190
+ lessThanOrEqual: number;
191
+ };
192
+ privateNetworkId: {
193
+ ignoreEmpty: boolean;
194
+ };
195
+ };
196
+ export declare const UpdateContainerRequestProbe: {
197
+ failureThreshold: {
198
+ greaterThanOrEqual: number;
199
+ lessThanOrEqual: number;
200
+ };
201
+ };
202
+ export declare const UpdateContainerRequestProbeHTTPProbe: {
203
+ path: {
204
+ maxLength: number;
205
+ minLength: number;
206
+ };
207
+ };
208
+ export declare const UpdateNamespaceRequest: {
209
+ description: {
210
+ maxLength: number;
211
+ };
212
+ };
213
+ export declare const UpdateTriggerRequest: {
214
+ description: {
215
+ maxLength: number;
216
+ };
217
+ name: {
218
+ maxLength: number;
219
+ minLength: number;
220
+ };
221
+ };
222
+ export declare const UpdateTriggerRequestCronConfig: {
223
+ body: {
224
+ maxLength: number;
225
+ };
226
+ schedule: {
227
+ maxLength: number;
228
+ minLength: number;
229
+ };
230
+ timezone: {
231
+ maxLength: number;
232
+ minLength: number;
233
+ };
234
+ };
235
+ export declare const UpdateTriggerRequestDestinationConfig: {
236
+ httpPath: {
237
+ maxLength: number;
238
+ minLength: number;
239
+ prefix: string;
240
+ };
241
+ };
242
+ export declare const UpdateTriggerRequestNATSConfig: {
243
+ credentialsFileContent: {
244
+ minLength: number;
245
+ };
246
+ subject: {
247
+ maxLength: number;
248
+ minLength: number;
249
+ pattern: RegExp;
250
+ };
251
+ };
252
+ export declare const UpdateTriggerRequestSQSConfig: {
253
+ accessKeyId: {
254
+ minLength: number;
255
+ };
256
+ region: {
257
+ maxLength: number;
258
+ minLength: number;
259
+ };
260
+ secretAccessKey: {
261
+ minLength: number;
262
+ };
263
+ };
@@ -0,0 +1,225 @@
1
+ import { __exportAll } from "../_virtual/_rolldown/runtime.js";
2
+ //#region src/v1/validation-rules.gen.ts
3
+ var validation_rules_gen_exports = /* @__PURE__ */ __exportAll({
4
+ ContainerProbe: () => ContainerProbe,
5
+ ContainerProbeHTTPProbe: () => ContainerProbeHTTPProbe,
6
+ ContainerScalingOption: () => ContainerScalingOption,
7
+ CreateContainerRequest: () => CreateContainerRequest,
8
+ CreateDomainRequest: () => CreateDomainRequest,
9
+ CreateNamespaceRequest: () => CreateNamespaceRequest,
10
+ CreateTriggerRequest: () => CreateTriggerRequest,
11
+ CreateTriggerRequestCronConfig: () => CreateTriggerRequestCronConfig,
12
+ CreateTriggerRequestDestinationConfig: () => CreateTriggerRequestDestinationConfig,
13
+ CreateTriggerRequestNATSConfig: () => CreateTriggerRequestNATSConfig,
14
+ CreateTriggerRequestSQSConfig: () => CreateTriggerRequestSQSConfig,
15
+ ListContainersRequest: () => ListContainersRequest,
16
+ ListDomainsRequest: () => ListDomainsRequest,
17
+ ListNamespacesRequest: () => ListNamespacesRequest,
18
+ ListTriggersRequest: () => ListTriggersRequest,
19
+ UpdateContainerRequest: () => UpdateContainerRequest,
20
+ UpdateContainerRequestProbe: () => UpdateContainerRequestProbe,
21
+ UpdateContainerRequestProbeHTTPProbe: () => UpdateContainerRequestProbeHTTPProbe,
22
+ UpdateNamespaceRequest: () => UpdateNamespaceRequest,
23
+ UpdateTriggerRequest: () => UpdateTriggerRequest,
24
+ UpdateTriggerRequestCronConfig: () => UpdateTriggerRequestCronConfig,
25
+ UpdateTriggerRequestDestinationConfig: () => UpdateTriggerRequestDestinationConfig,
26
+ UpdateTriggerRequestNATSConfig: () => UpdateTriggerRequestNATSConfig,
27
+ UpdateTriggerRequestSQSConfig: () => UpdateTriggerRequestSQSConfig
28
+ });
29
+ var ContainerProbe = { failureThreshold: {
30
+ greaterThanOrEqual: 3,
31
+ lessThanOrEqual: 50
32
+ } };
33
+ var ContainerProbeHTTPProbe = { path: {
34
+ maxLength: 100,
35
+ minLength: 1
36
+ } };
37
+ var ContainerScalingOption = {};
38
+ var CreateContainerRequest = {
39
+ description: { maxLength: 255 },
40
+ image: { maxLength: 255 },
41
+ localStorageLimitBytes: {
42
+ greaterThanOrEqual: 1e9,
43
+ lessThanOrEqual: 24456e6
44
+ },
45
+ maxScale: {
46
+ greaterThanOrEqual: 1,
47
+ lessThanOrEqual: 50
48
+ },
49
+ memoryLimitBytes: {
50
+ greaterThanOrEqual: 128e6,
51
+ lessThanOrEqual: 12288e6
52
+ },
53
+ minScale: { lessThanOrEqual: 10 },
54
+ mvcpuLimit: {
55
+ greaterThanOrEqual: 70,
56
+ lessThanOrEqual: 6e3
57
+ },
58
+ name: {
59
+ maxLength: 34,
60
+ minLength: 2,
61
+ pattern: /^[a-z0-9]([-a-z0-9]*[a-z0-9])?$/
62
+ },
63
+ port: { lessThanOrEqual: 65535 },
64
+ privateNetworkId: { ignoreEmpty: true }
65
+ };
66
+ var CreateDomainRequest = { hostname: {
67
+ maxLength: 63,
68
+ minLength: 3
69
+ } };
70
+ var CreateNamespaceRequest = {
71
+ description: { maxLength: 255 },
72
+ name: {
73
+ maxLength: 50,
74
+ minLength: 1,
75
+ pattern: /^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])$/
76
+ }
77
+ };
78
+ var CreateTriggerRequest = {
79
+ description: { maxLength: 255 },
80
+ name: {
81
+ maxLength: 50,
82
+ minLength: 1
83
+ }
84
+ };
85
+ var CreateTriggerRequestCronConfig = {
86
+ body: { maxLength: 1e4 },
87
+ schedule: {
88
+ maxLength: 255,
89
+ minLength: 1
90
+ },
91
+ timezone: {
92
+ maxLength: 255,
93
+ minLength: 1
94
+ }
95
+ };
96
+ var CreateTriggerRequestDestinationConfig = { httpPath: {
97
+ maxLength: 255,
98
+ minLength: 1,
99
+ prefix: "/"
100
+ } };
101
+ var CreateTriggerRequestNATSConfig = {
102
+ credentialsFileContent: { minLength: 1 },
103
+ subject: {
104
+ maxLength: 100,
105
+ minLength: 1,
106
+ pattern: /^[^\s]+$/
107
+ }
108
+ };
109
+ var CreateTriggerRequestSQSConfig = {
110
+ accessKeyId: { minLength: 1 },
111
+ region: {
112
+ maxLength: 20,
113
+ minLength: 1
114
+ },
115
+ secretAccessKey: { minLength: 1 }
116
+ };
117
+ var ListContainersRequest = {
118
+ name: {
119
+ maxLength: 34,
120
+ minLength: 4
121
+ },
122
+ page: { greaterThanOrEqual: 1 },
123
+ pageSize: {
124
+ greaterThanOrEqual: 1,
125
+ lessThanOrEqual: 1e3
126
+ }
127
+ };
128
+ var ListDomainsRequest = {
129
+ page: { greaterThanOrEqual: 1 },
130
+ pageSize: {
131
+ greaterThanOrEqual: 1,
132
+ lessThanOrEqual: 1e3
133
+ }
134
+ };
135
+ var ListNamespacesRequest = {
136
+ name: {
137
+ maxLength: 50,
138
+ minLength: 1
139
+ },
140
+ page: { greaterThanOrEqual: 1 },
141
+ pageSize: {
142
+ greaterThanOrEqual: 1,
143
+ lessThanOrEqual: 1e3
144
+ }
145
+ };
146
+ var ListTriggersRequest = {
147
+ page: { greaterThanOrEqual: 1 },
148
+ pageSize: {
149
+ greaterThanOrEqual: 1,
150
+ lessThanOrEqual: 1e3
151
+ }
152
+ };
153
+ var UpdateContainerRequest = {
154
+ description: { maxLength: 255 },
155
+ image: { maxLength: 255 },
156
+ localStorageLimitBytes: {
157
+ greaterThanOrEqual: 1e9,
158
+ lessThanOrEqual: 24456e6
159
+ },
160
+ maxScale: {
161
+ greaterThanOrEqual: 1,
162
+ lessThanOrEqual: 50
163
+ },
164
+ memoryLimitBytes: {
165
+ greaterThanOrEqual: 128e6,
166
+ lessThanOrEqual: 12288e6
167
+ },
168
+ minScale: { lessThanOrEqual: 10 },
169
+ mvcpuLimit: {
170
+ greaterThanOrEqual: 70,
171
+ lessThanOrEqual: 6e3
172
+ },
173
+ port: { lessThanOrEqual: 65535 },
174
+ privateNetworkId: { ignoreEmpty: true }
175
+ };
176
+ var UpdateContainerRequestProbe = { failureThreshold: {
177
+ greaterThanOrEqual: 3,
178
+ lessThanOrEqual: 50
179
+ } };
180
+ var UpdateContainerRequestProbeHTTPProbe = { path: {
181
+ maxLength: 100,
182
+ minLength: 1
183
+ } };
184
+ var UpdateNamespaceRequest = { description: { maxLength: 255 } };
185
+ var UpdateTriggerRequest = {
186
+ description: { maxLength: 255 },
187
+ name: {
188
+ maxLength: 50,
189
+ minLength: 1
190
+ }
191
+ };
192
+ var UpdateTriggerRequestCronConfig = {
193
+ body: { maxLength: 1e4 },
194
+ schedule: {
195
+ maxLength: 255,
196
+ minLength: 1
197
+ },
198
+ timezone: {
199
+ maxLength: 255,
200
+ minLength: 1
201
+ }
202
+ };
203
+ var UpdateTriggerRequestDestinationConfig = { httpPath: {
204
+ maxLength: 255,
205
+ minLength: 1,
206
+ prefix: "/"
207
+ } };
208
+ var UpdateTriggerRequestNATSConfig = {
209
+ credentialsFileContent: { minLength: 1 },
210
+ subject: {
211
+ maxLength: 100,
212
+ minLength: 1,
213
+ pattern: /^[^\s]+$/
214
+ }
215
+ };
216
+ var UpdateTriggerRequestSQSConfig = {
217
+ accessKeyId: { minLength: 1 },
218
+ region: {
219
+ maxLength: 20,
220
+ minLength: 1
221
+ },
222
+ secretAccessKey: { minLength: 1 }
223
+ };
224
+ //#endregion
225
+ export { ContainerProbe, ContainerProbeHTTPProbe, ContainerScalingOption, CreateContainerRequest, CreateDomainRequest, CreateNamespaceRequest, CreateTriggerRequest, CreateTriggerRequestCronConfig, CreateTriggerRequestDestinationConfig, CreateTriggerRequestNATSConfig, CreateTriggerRequestSQSConfig, ListContainersRequest, ListDomainsRequest, ListNamespacesRequest, ListTriggersRequest, UpdateContainerRequest, UpdateContainerRequestProbe, UpdateContainerRequestProbeHTTPProbe, UpdateNamespaceRequest, UpdateTriggerRequest, UpdateTriggerRequestCronConfig, UpdateTriggerRequestDestinationConfig, UpdateTriggerRequestNATSConfig, UpdateTriggerRequestSQSConfig, validation_rules_gen_exports };
@@ -87,6 +87,9 @@ export declare class API extends ParentAPI {
87
87
  waitForContainer: (request: Readonly<GetContainerRequest>, options?: Readonly<WaitForOptions<Container>>) => Promise<Container>;
88
88
  /**
89
89
  * Create a new container. Create a new container in the specified region.
90
+
91
+ When creating a container, the `created` status is no longer used. The deployment process is started
92
+ and the status is set to `pending` accordingly.
90
93
  *
91
94
  * @param request - The request {@link CreateContainerRequest}
92
95
  * @returns A Promise of Container
@@ -96,7 +99,8 @@ export declare class API extends ParentAPI {
96
99
  * Update an existing container. Update the container associated with the specified ID.
97
100
 
98
101
  When updating a container, the container is automatically redeployed to apply the changes.
99
- This behavior can be changed by setting the `redeploy` field to `false` in the request.
102
+
103
+ Warning: The `redeploy` field has been deprecated. An update now always redeploys the container.
100
104
  *
101
105
  * @param request - The request {@link UpdateContainerRequest}
102
106
  * @returns A Promise of Container
@@ -111,6 +115,10 @@ export declare class API extends ParentAPI {
111
115
  deleteContainer: (request: Readonly<DeleteContainerRequest>) => Promise<Container>;
112
116
  /**
113
117
  * Deploy a container. Deploy a container associated with the specified ID.
118
+
119
+ Since updating a container now always deploys it (and passes its status to `pending`), this call becomes superfluous.
120
+
121
+ Moreover, calling `DeployContainer` immediately after `UpdateContainer` can cause `409 - resource is in a transient state` errors, so it is better to not use it when updating a container.
114
122
  *
115
123
  * @param request - The request {@link DeployContainerRequest}
116
124
  * @returns A Promise of Container
@@ -114,6 +114,9 @@ var API = class extends API$1 {
114
114
  waitForContainer = (request, options) => waitForResource(options?.stop ?? ((res) => Promise.resolve(!CONTAINER_TRANSIENT_STATUSES.includes(res.status))), this.getContainer, request, options);
115
115
  /**
116
116
  * Create a new container. Create a new container in the specified region.
117
+
118
+ When creating a container, the `created` status is no longer used. The deployment process is started
119
+ and the status is set to `pending` accordingly.
117
120
  *
118
121
  * @param request - The request {@link CreateContainerRequest}
119
122
  * @returns A Promise of Container
@@ -128,7 +131,8 @@ var API = class extends API$1 {
128
131
  * Update an existing container. Update the container associated with the specified ID.
129
132
 
130
133
  When updating a container, the container is automatically redeployed to apply the changes.
131
- This behavior can be changed by setting the `redeploy` field to `false` in the request.
134
+
135
+ Warning: The `redeploy` field has been deprecated. An update now always redeploys the container.
132
136
  *
133
137
  * @param request - The request {@link UpdateContainerRequest}
134
138
  * @returns A Promise of Container
@@ -151,6 +155,10 @@ var API = class extends API$1 {
151
155
  }, unmarshalContainer);
152
156
  /**
153
157
  * Deploy a container. Deploy a container associated with the specified ID.
158
+
159
+ Since updating a container now always deploys it (and passes its status to `pending`), this call becomes superfluous.
160
+
161
+ Moreover, calling `DeployContainer` immediately after `UpdateContainer` can cause `409 - resource is in a transient state` errors, so it is better to not use it when updating a container.
154
162
  *
155
163
  * @param request - The request {@link DeployContainerRequest}
156
164
  * @returns A Promise of Container
@@ -218,7 +218,7 @@ export interface Container {
218
218
  */
219
219
  maxConcurrency: number;
220
220
  /**
221
- * Domain name attributed to the contaioner.
221
+ * Domain name attributed to the container.
222
222
  */
223
223
  domainName: string;
224
224
  /**
@@ -373,7 +373,7 @@ export interface Namespace {
373
373
  */
374
374
  registryNamespaceId: string;
375
375
  /**
376
- * Last error message of the namesace.
376
+ * Last error message of the namespace.
377
377
  */
378
378
  errorMessage?: string;
379
379
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scaleway/sdk-container",
3
- "version": "2.5.0",
3
+ "version": "2.6.0",
4
4
  "description": "Scaleway SDK container",
5
5
  "license": "Apache-2.0",
6
6
  "files": [
@@ -16,6 +16,14 @@
16
16
  "./*": {
17
17
  "types": "./dist/*/index.gen.d.ts",
18
18
  "default": "./dist/*/index.gen.js"
19
+ },
20
+ "./metadata": {
21
+ "types": "./dist/metadata.gen.d.ts",
22
+ "default": "./dist/metadata.gen.js"
23
+ },
24
+ "./*/metadata": {
25
+ "types": "./dist/*/metadata.gen.d.ts",
26
+ "default": "./dist/*/metadata.gen.js"
19
27
  }
20
28
  },
21
29
  "repository": {
@@ -27,7 +35,7 @@
27
35
  },
28
36
  "dependencies": {
29
37
  "@scaleway/random-name": "5.1.4",
30
- "@scaleway/sdk-std": "2.2.2"
38
+ "@scaleway/sdk-std": "2.3.0"
31
39
  },
32
40
  "peerDependencies": {
33
41
  "@scaleway/sdk-client": "^2.2.2"