@scaleway/sdk-container 1.8.0 → 2.1.1

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-container
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-container.svg)](https://www.npmjs.com/package/@scaleway/sdk-container)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-container.svg)](https://www.npmjs.com/package/@scaleway/sdk-container)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-container.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for Container API.
+
+> **Note**  
+> This is an automatically generated package that is part of the [Scaleway SDK for JavaScript](https://github.com/scaleway/scaleway-sdk-js).
+
+## Installation
+
+```bash
+npm install @scaleway/sdk-container @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-container @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-container @scaleway/sdk-client
+```
+
+## Getting Started
+
+You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) on how to retrieve them.
+
+### Basic Usage
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { Container } from '@scaleway/sdk-container'
+
+const client = createClient({
+  accessKey: 'SCWXXXXXXXXXXXXXXXXX',
+  secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultRegion: 'fr-par',
+  defaultZone: 'fr-par-1',
+})
+
+const api = new Container.v1.API(client)
+
+// Use the API
+// Example: await api.listServers()
+```
+
+### Using Configuration Loader
+
+For a simpler setup, you can load credentials from the configuration file or environment variables:
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
+import { Container } from '@scaleway/sdk-container'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new Container.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway Container API Documentation](https://www.scaleway.com/en/developers/api/container/)
+- 📖 [Main Repository](https://github.com/scaleway/scaleway-sdk-js)
+- 💡 [Example Projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
+
+## Features
+
+- ✅ Full TypeScript support with complete type definitions
+- ✅ Promise-based API
+- ✅ Automatic pagination helpers
+- ✅ Built-in error handling
+- ✅ Compatible with Node.js ≥ 20
+
+## Support
+
+We love feedback! Feel free to reach us on:
+- [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
+- [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
+
+## Contributing
+
+This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read [CONTRIBUTING.md](https://github.com/scaleway/scaleway-sdk-js/blob/master/CONTRIBUTING.md).
+
+## License
+
+This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.
+

package/dist/v1beta1/api.gen.d.ts

@@ -1,5 +1,5 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
+import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { Container, CreateContainerRequest, CreateCronRequest, CreateDomainRequest, CreateNamespaceRequest, CreateTokenRequest, CreateTriggerRequest, Cron, DeleteContainerRequest, DeleteCronRequest, DeleteDomainRequest, DeleteNamespaceRequest, DeleteTokenRequest, DeleteTriggerRequest, DeployContainerRequest, Domain, GetContainerRequest, GetCronRequest, GetDomainRequest, GetNamespaceRequest, GetTokenRequest, GetTriggerRequest, ListContainersRequest, ListContainersResponse, ListCronsRequest, ListCronsResponse, ListDomainsRequest, ListDomainsResponse, ListNamespacesRequest, ListNamespacesResponse, ListTokensRequest, ListTokensResponse, ListTriggersRequest, ListTriggersResponse, Namespace, Token, Trigger, UpdateContainerRequest, UpdateCronRequest, UpdateNamespaceRequest, UpdateTriggerRequest } from './types.gen.js';
 /**
  * Serverless Containers API.
@@ -204,8 +204,9 @@ export declare class API extends ParentAPI {
      */
     deleteDomain: (request: Readonly<DeleteDomainRequest>) => Promise<Domain>;
     /**
-     * Create a new revocable token.
+     * Create a new revocable token. Deprecated in favor of IAM authentication.
      *
+     * @deprecated
      * @param request - The request {@link CreateTokenRequest}
      * @returns A Promise of Token
      */

package/dist/v1beta1/api.gen.js

@@ -10,7 +10,11 @@ class API extends API$1 {
    * type ∈ {'zone','region','global','unspecified'}
    */
   static LOCALITY = toApiLocality({
-    regions: ["fr-par", "nl-ams", "pl-waw"]
+    regions: [
+      "fr-par",
+      "nl-ams",
+      "pl-waw"
+    ]
   });
   pageOfListNamespaces = (request = {}) => this.client.fetch(
     {
@@ -21,10 +25,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId]
       )
     },
@@ -58,9 +59,7 @@ class API extends API$1 {
    * @returns A Promise of Namespace
    */
   waitForNamespace = (request, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !NAMESPACE_TRANSIENT_STATUSES.includes(res.status)
-    )),
+    options?.stop ?? ((res) => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES.includes(res.status))),
     this.getNamespace,
     request,
     options
@@ -122,10 +121,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId]
       )
     },
@@ -159,9 +155,7 @@ class API extends API$1 {
    * @returns A Promise of Container
    */
   waitForContainer = (request, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !CONTAINER_TRANSIENT_STATUSES.includes(res.status)
-    )),
+    options?.stop ?? ((res) => Promise.resolve(!CONTAINER_TRANSIENT_STATUSES.includes(res.status))),
     this.getContainer,
     request,
     options
@@ -239,10 +233,7 @@ class API extends API$1 {
         ["container_id", request.containerId],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
       )
     },
     unmarshalListCronsResponse
@@ -275,9 +266,7 @@ class API extends API$1 {
    * @returns A Promise of Cron
    */
   waitForCron = (request, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !CRON_TRANSIENT_STATUSES.includes(res.status)
-    )),
+    options?.stop ?? ((res) => Promise.resolve(!CRON_TRANSIENT_STATUSES.includes(res.status))),
     this.getCron,
     request,
     options
@@ -337,10 +326,7 @@ class API extends API$1 {
         ["container_id", request.containerId],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
       )
     },
     unmarshalListDomainsResponse
@@ -373,9 +359,7 @@ class API extends API$1 {
    * @returns A Promise of Domain
    */
   waitForDomain = (request, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !DOMAIN_TRANSIENT_STATUSES.includes(res.status)
-    )),
+    options?.stop ?? ((res) => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES.includes(res.status))),
     this.getDomain,
     request,
     options
@@ -411,8 +395,9 @@ class API extends API$1 {
     unmarshalDomain
   );
   /**
-   * Create a new revocable token.
+   * Create a new revocable token. Deprecated in favor of IAM authentication.
    *
+   * @deprecated
    * @param request - The request {@link CreateTokenRequest}
    * @returns A Promise of Token
    */
@@ -448,9 +433,7 @@ class API extends API$1 {
    * @returns A Promise of Token
    */
   waitForToken = (request, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !TOKEN_TRANSIENT_STATUSES.includes(res.status)
-    )),
+    options?.stop ?? ((res) => Promise.resolve(!TOKEN_TRANSIENT_STATUSES.includes(res.status))),
     this.getToken,
     request,
     options
@@ -464,10 +447,7 @@ class API extends API$1 {
         ["namespace_id", request.namespaceId],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
       )
     },
     unmarshalListTokensResponse
@@ -530,9 +510,7 @@ class API extends API$1 {
    * @returns A Promise of Trigger
    */
   waitForTrigger = (request, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !TRIGGER_TRANSIENT_STATUSES.includes(res.status)
-    )),
+    options?.stop ?? ((res) => Promise.resolve(!TRIGGER_TRANSIENT_STATUSES.includes(res.status))),
     this.getTrigger,
     request,
     options
@@ -544,21 +522,22 @@ class API extends API$1 {
       urlParams: urlParams(
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ...Object.entries(
-          resolveOneOf([
-            { param: "container_id", value: request.containerId },
-            { param: "namespace_id", value: request.namespaceId },
-            {
-              default: this.client.settings.defaultProjectId,
-              param: "project_id",
-              value: request.projectId
-            }
-          ])
-        )
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
+        ...Object.entries(resolveOneOf([
+          {
+            param: "container_id",
+            value: request.containerId
+          },
+          {
+            param: "namespace_id",
+            value: request.namespaceId
+          },
+          {
+            default: this.client.settings.defaultProjectId,
+            param: "project_id",
+            value: request.projectId
+          }
+        ]))
       )
     },
     unmarshalListTriggersResponse

package/dist/v1beta1/content.gen.js

@@ -18,7 +18,10 @@ const NAMESPACE_TRANSIENT_STATUSES = [
   "creating",
   "pending"
 ];
-const TOKEN_TRANSIENT_STATUSES = ["deleting", "creating"];
+const TOKEN_TRANSIENT_STATUSES = [
+  "deleting",
+  "creating"
+];
 const TRIGGER_TRANSIENT_STATUSES = [
   "deleting",
   "creating",

package/dist/v1beta1/index.gen.d.ts

@@ -1,4 +1,4 @@
-export { API } from './api.gen.js';
+export { API, } from './api.gen.js';
 export * from './content.gen.js';
 export * from './marshalling.gen.js';
 export type { Container, ContainerHealthCheckSpec, ContainerHealthCheckSpecHTTPProbe, ContainerHealthCheckSpecTCPProbe, ContainerHttpOption, ContainerPrivacy, ContainerProtocol, ContainerSandbox, ContainerScalingOption, ContainerStatus, CreateContainerRequest, CreateCronRequest, CreateDomainRequest, CreateNamespaceRequest, CreateTokenRequest, CreateTriggerRequest, CreateTriggerRequestMnqNatsClientConfig, CreateTriggerRequestMnqSqsClientConfig, CreateTriggerRequestSqsClientConfig, Cron, CronStatus, DeleteContainerRequest, DeleteCronRequest, DeleteDomainRequest, DeleteNamespaceRequest, DeleteTokenRequest, DeleteTriggerRequest, DeployContainerRequest, Domain, DomainStatus, GetContainerRequest, GetCronRequest, GetDomainRequest, GetNamespaceRequest, GetTokenRequest, GetTriggerRequest, ListContainersRequest, ListContainersRequestOrderBy, ListContainersResponse, ListCronsRequest, ListCronsRequestOrderBy, ListCronsResponse, ListDomainsRequest, ListDomainsRequestOrderBy, ListDomainsResponse, ListNamespacesRequest, ListNamespacesRequestOrderBy, ListNamespacesResponse, ListTokensRequest, ListTokensRequestOrderBy, ListTokensResponse, ListTriggersRequest, ListTriggersRequestOrderBy, ListTriggersResponse, Namespace, NamespaceStatus, Secret, SecretHashedValue, Token, TokenStatus, Trigger, TriggerInputType, TriggerMnqNatsClientConfig, TriggerMnqSqsClientConfig, TriggerSqsClientConfig, TriggerStatus, UpdateContainerRequest, UpdateCronRequest, UpdateNamespaceRequest, UpdateTriggerRequest, UpdateTriggerRequestSqsClientConfig, } from './types.gen.js';

package/dist/v1beta1/marshalling.gen.js

@@ -88,10 +88,7 @@ const unmarshalContainer = (data) => {
     registryImage: data.registry_image,
     sandbox: data.sandbox,
     scalingOption: data.scaling_option ? unmarshalContainerScalingOption(data.scaling_option) : void 0,
-    secretEnvironmentVariables: unmarshalArrayOfObject(
-      data.secret_environment_variables,
-      unmarshalSecretHashedValue
-    ),
+    secretEnvironmentVariables: unmarshalArrayOfObject(data.secret_environment_variables, unmarshalSecretHashedValue),
     status: data.status,
     tags: data.tags,
     timeout: data.timeout,
@@ -146,10 +143,7 @@ const unmarshalNamespace = (data) => {
     region: data.region,
     registryEndpoint: data.registry_endpoint,
     registryNamespaceId: data.registry_namespace_id,
-    secretEnvironmentVariables: unmarshalArrayOfObject(
-      data.secret_environment_variables,
-      unmarshalSecretHashedValue
-    ),
+    secretEnvironmentVariables: unmarshalArrayOfObject(data.secret_environment_variables, unmarshalSecretHashedValue),
     status: data.status,
     tags: data.tags,
     updatedAt: unmarshalDate(data.updated_at),
@@ -322,8 +316,14 @@ const marshalContainerScalingOption = (request, defaults) => ({
       param: "concurrent_requests_threshold",
       value: request.concurrentRequestsThreshold
     },
-    { param: "cpu_usage_threshold", value: request.cpuUsageThreshold },
-    { param: "memory_usage_threshold", value: request.memoryUsageThreshold }
+    {
+      param: "cpu_usage_threshold",
+      value: request.cpuUsageThreshold
+    },
+    {
+      param: "memory_usage_threshold",
+      value: request.memoryUsageThreshold
+    }
   ])
 });
 const marshalSecret = (request, defaults) => ({
@@ -352,9 +352,7 @@ const marshalCreateContainerRequest = (request, defaults) => ({
   registry_image: request.registryImage,
   sandbox: request.sandbox,
   scaling_option: request.scalingOption !== void 0 ? marshalContainerScalingOption(request.scalingOption) : void 0,
-  secret_environment_variables: request.secretEnvironmentVariables !== void 0 ? request.secretEnvironmentVariables.map(
-    (elt) => marshalSecret(elt)
-  ) : void 0,
+  secret_environment_variables: request.secretEnvironmentVariables !== void 0 ? request.secretEnvironmentVariables.map((elt) => marshalSecret(elt)) : void 0,
   tags: request.tags,
   timeout: request.timeout
 });
@@ -374,17 +372,21 @@ const marshalCreateNamespaceRequest = (request, defaults) => ({
   environment_variables: request.environmentVariables,
   name: request.name || randomName("cns"),
   project_id: request.projectId ?? defaults.defaultProjectId,
-  secret_environment_variables: request.secretEnvironmentVariables !== void 0 ? request.secretEnvironmentVariables.map(
-    (elt) => marshalSecret(elt)
-  ) : void 0,
+  secret_environment_variables: request.secretEnvironmentVariables !== void 0 ? request.secretEnvironmentVariables.map((elt) => marshalSecret(elt)) : void 0,
   tags: request.tags
 });
 const marshalCreateTokenRequest = (request, defaults) => ({
   description: request.description,
   expires_at: request.expiresAt,
   ...resolveOneOf([
-    { param: "container_id", value: request.containerId },
-    { param: "namespace_id", value: request.namespaceId }
+    {
+      param: "container_id",
+      value: request.containerId
+    },
+    {
+      param: "namespace_id",
+      value: request.namespaceId
+    }
   ])
 });
 const marshalCreateTriggerRequestMnqNatsClientConfig = (request, defaults) => ({
@@ -411,21 +413,15 @@ const marshalCreateTriggerRequest = (request, defaults) => ({
   ...resolveOneOf([
     {
       param: "scw_sqs_config",
-      value: request.scwSqsConfig !== void 0 ? marshalCreateTriggerRequestMnqSqsClientConfig(
-        request.scwSqsConfig
-      ) : void 0
+      value: request.scwSqsConfig !== void 0 ? marshalCreateTriggerRequestMnqSqsClientConfig(request.scwSqsConfig) : void 0
     },
     {
       param: "scw_nats_config",
-      value: request.scwNatsConfig !== void 0 ? marshalCreateTriggerRequestMnqNatsClientConfig(
-        request.scwNatsConfig
-      ) : void 0
+      value: request.scwNatsConfig !== void 0 ? marshalCreateTriggerRequestMnqNatsClientConfig(request.scwNatsConfig) : void 0
     },
     {
       param: "sqs_config",
-      value: request.sqsConfig !== void 0 ? marshalCreateTriggerRequestSqsClientConfig(
-        request.sqsConfig
-      ) : void 0
+      value: request.sqsConfig !== void 0 ? marshalCreateTriggerRequestSqsClientConfig(request.sqsConfig) : void 0
     }
   ])
 });
@@ -450,9 +446,7 @@ const marshalUpdateContainerRequest = (request, defaults) => ({
   registry_image: request.registryImage,
   sandbox: request.sandbox,
   scaling_option: request.scalingOption !== void 0 ? marshalContainerScalingOption(request.scalingOption) : void 0,
-  secret_environment_variables: request.secretEnvironmentVariables !== void 0 ? request.secretEnvironmentVariables.map(
-    (elt) => marshalSecret(elt)
-  ) : void 0,
+  secret_environment_variables: request.secretEnvironmentVariables !== void 0 ? request.secretEnvironmentVariables.map((elt) => marshalSecret(elt)) : void 0,
   tags: request.tags,
   timeout: request.timeout
 });
@@ -465,9 +459,7 @@ const marshalUpdateCronRequest = (request, defaults) => ({
 const marshalUpdateNamespaceRequest = (request, defaults) => ({
   description: request.description,
   environment_variables: request.environmentVariables,
-  secret_environment_variables: request.secretEnvironmentVariables !== void 0 ? request.secretEnvironmentVariables.map(
-    (elt) => marshalSecret(elt)
-  ) : void 0,
+  secret_environment_variables: request.secretEnvironmentVariables !== void 0 ? request.secretEnvironmentVariables.map((elt) => marshalSecret(elt)) : void 0,
   tags: request.tags
 });
 const marshalUpdateTriggerRequestSqsClientConfig = (request, defaults) => ({
@@ -480,9 +472,7 @@ const marshalUpdateTriggerRequest = (request, defaults) => ({
   ...resolveOneOf([
     {
       param: "sqs_config",
-      value: request.sqsConfig !== void 0 ? marshalUpdateTriggerRequestSqsClientConfig(
-        request.sqsConfig
-      ) : void 0
+      value: request.sqsConfig !== void 0 ? marshalUpdateTriggerRequestSqsClientConfig(request.sqsConfig) : void 0
     }
   ])
 });

package/dist/v1beta1/types.gen.d.ts

@@ -301,7 +301,7 @@ export interface Cron {
      */
     containerId: string;
     /**
-     * UNIX cron shedule.
+     * UNIX cron schedule.
      */
     schedule: string;
     /**
@@ -616,7 +616,7 @@ export type CreateCronRequest = {
      */
     containerId: string;
     /**
-     * UNIX cron shedule.
+     * UNIX cron schedule.
      */
     schedule: string;
     /**

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@scaleway/sdk-container",
-  "version": "1.8.0",
+  "version": "2.1.1",
   "description": "Scaleway SDK container",
   "license": "Apache-2.0",
   "files": [
+    "README.md",
     "dist"
   ],
   "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.gen.d.ts",
-      "import": "./dist/index.gen.js",
-      "require": "./dist/index.gen.cjs",
       "default": "./dist/index.gen.js"
     },
     "./*": {
       "types": "./dist/*/index.gen.d.ts",
-      "import": "./dist/*/index.gen.js",
-      "require": "./dist/*/index.gen.cjs",
       "default": "./dist/*/index.gen.js"
     }
   },
@@ -26,17 +23,17 @@
     "directory": "packages_generated/container"
   },
   "engines": {
-    "node": ">=20.19.4"
+    "node": ">=20.19.6"
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.2",
-    "@scaleway/sdk-std": "1.2.0"
+    "@scaleway/sdk-std": "2.1.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.3"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.3"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "scripts": {
     "package:check": "pnpm publint",

package/dist/index.gen.cjs

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const index_gen = require("./v1beta1/index.gen.cjs");
-exports.Containerv1beta1 = index_gen;