@scaleway/sdk-function 1.6.0 → 2.1.1

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-function
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-function.svg)](https://www.npmjs.com/package/@scaleway/sdk-function)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-function.svg)](https://www.npmjs.com/package/@scaleway/sdk-function)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-function.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for Function 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-function @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-function @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-function @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 { Function } from '@scaleway/sdk-function'
+
+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 Function.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 { Function } from '@scaleway/sdk-function'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new Function.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway Function API Documentation](https://www.scaleway.com/en/developers/api/function/)
+- 📖 [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 { CreateCronRequest, CreateDomainRequest, CreateFunctionRequest, CreateNamespaceRequest, CreateTokenRequest, CreateTriggerRequest, Cron, DeleteCronRequest, DeleteDomainRequest, DeleteFunctionRequest, DeleteNamespaceRequest, DeleteTokenRequest, DeleteTriggerRequest, DeployFunctionRequest, Domain, DownloadURL, Function, GetCronRequest, GetDomainRequest, GetFunctionDownloadURLRequest, GetFunctionRequest, GetFunctionUploadURLRequest, GetNamespaceRequest, GetTokenRequest, GetTriggerRequest, ListCronsRequest, ListCronsResponse, ListDomainsRequest, ListDomainsResponse, ListFunctionRuntimesRequest, ListFunctionRuntimesResponse, ListFunctionsRequest, ListFunctionsResponse, ListNamespacesRequest, ListNamespacesResponse, ListTokensRequest, ListTokensResponse, ListTriggersRequest, ListTriggersResponse, Namespace, Token, Trigger, UpdateCronRequest, UpdateFunctionRequest, UpdateNamespaceRequest, UpdateTriggerRequest, UploadURL } from './types.gen.js';
 /**
  * Serverless Functions API.
@@ -225,8 +225,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 Function
    */
   waitForFunction = (request, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !FUNCTION_TRANSIENT_STATUSES.includes(res.status)
-    )),
+    options?.stop ?? ((res) => Promise.resolve(!FUNCTION_TRANSIENT_STATUSES.includes(res.status))),
     this.getFunction,
     request,
     options
@@ -254,7 +248,9 @@ class API extends API$1 {
     {
       method: "GET",
       path: `/functions/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/functions/${validatePathParam("functionId", request.functionId)}/upload-url`,
-      urlParams: urlParams(["content_length", request.contentLength])
+      urlParams: urlParams(
+        ["content_length", request.contentLength]
+      )
     },
     unmarshalUploadURL
   );
@@ -279,10 +275,7 @@ class API extends API$1 {
         ["function_id", request.functionId],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
       )
     },
     unmarshalListCronsResponse
@@ -315,9 +308,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
@@ -377,10 +368,7 @@ class API extends API$1 {
         ["function_id", request.functionId],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
       )
     },
     unmarshalListDomainsResponse
@@ -413,9 +401,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
@@ -451,8 +437,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
    */
@@ -488,9 +475,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
@@ -504,10 +489,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
@@ -570,9 +552,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
@@ -584,21 +564,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: "function_id", value: request.functionId },
-            { 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: "function_id",
+            value: request.functionId
+          },
+          {
+            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 { CreateCronRequest, CreateDomainRequest, CreateFunctionRequest, CreateNamespaceRequest, CreateTokenRequest, CreateTriggerRequest, CreateTriggerRequestMnqNatsClientConfig, CreateTriggerRequestMnqSqsClientConfig, CreateTriggerRequestSqsClientConfig, Cron, CronStatus, DeleteCronRequest, DeleteDomainRequest, DeleteFunctionRequest, DeleteNamespaceRequest, DeleteTokenRequest, DeleteTriggerRequest, DeployFunctionRequest, Domain, DomainStatus, DownloadURL, Function, FunctionHttpOption, FunctionPrivacy, FunctionRuntime, FunctionSandbox, FunctionStatus, GetCronRequest, GetDomainRequest, GetFunctionDownloadURLRequest, GetFunctionRequest, GetFunctionUploadURLRequest, GetNamespaceRequest, GetTokenRequest, GetTriggerRequest, ListCronsRequest, ListCronsRequestOrderBy, ListCronsResponse, ListDomainsRequest, ListDomainsRequestOrderBy, ListDomainsResponse, ListFunctionRuntimesRequest, ListFunctionRuntimesResponse, ListFunctionsRequest, ListFunctionsRequestOrderBy, ListFunctionsResponse, ListNamespacesRequest, ListNamespacesRequestOrderBy, ListNamespacesResponse, ListTokensRequest, ListTokensRequestOrderBy, ListTokensResponse, ListTriggersRequest, ListTriggersRequestOrderBy, ListTriggersResponse, Namespace, NamespaceStatus, Runtime, RuntimeStatus, Secret, SecretHashedValue, Token, TokenStatus, Trigger, TriggerInputType, TriggerMnqNatsClientConfig, TriggerMnqSqsClientConfig, TriggerSqsClientConfig, TriggerStatus, UpdateCronRequest, UpdateFunctionRequest, UpdateNamespaceRequest, UpdateTriggerRequest, UpdateTriggerRequestSqsClientConfig, UploadURL, } from './types.gen.js';

package/dist/v1beta1/marshalling.gen.js

@@ -70,10 +70,7 @@ const unmarshalFunction = (data) => {
     runtime: data.runtime,
     runtimeMessage: data.runtime_message,
     sandbox: data.sandbox,
-    secretEnvironmentVariables: unmarshalArrayOfObject(
-      data.secret_environment_variables,
-      unmarshalSecretHashedValue
-    ),
+    secretEnvironmentVariables: unmarshalArrayOfObject(data.secret_environment_variables, unmarshalSecretHashedValue),
     status: data.status,
     tags: data.tags,
     timeout: data.timeout,
@@ -98,10 +95,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),
@@ -330,9 +324,7 @@ const marshalCreateFunctionRequest = (request, defaults) => ({
   private_network_id: request.privateNetworkId,
   runtime: request.runtime,
   sandbox: request.sandbox,
-  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
 });
@@ -342,17 +334,21 @@ const marshalCreateNamespaceRequest = (request, defaults) => ({
   environment_variables: request.environmentVariables,
   name: request.name || randomName("ns"),
   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: "function_id", value: request.functionId },
-    { param: "namespace_id", value: request.namespaceId }
+    {
+      param: "function_id",
+      value: request.functionId
+    },
+    {
+      param: "namespace_id",
+      value: request.namespaceId
+    }
   ])
 });
 const marshalCreateTriggerRequestMnqNatsClientConfig = (request, defaults) => ({
@@ -379,21 +375,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
     }
   ])
 });
@@ -416,18 +406,14 @@ const marshalUpdateFunctionRequest = (request, defaults) => ({
   redeploy: request.redeploy,
   runtime: request.runtime,
   sandbox: request.sandbox,
-  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
 });
 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) => ({
@@ -440,9 +426,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

@@ -153,7 +153,7 @@ export interface Domain {
      */
     url: string;
     /**
-     * State of the doamin.
+     * State of the domain.
      */
     status: DomainStatus;
     /**
@@ -466,7 +466,7 @@ export type CreateDomainRequest = {
      */
     region?: ScwRegion;
     /**
-     * Hostame to create.
+     * Hostname to create.
      */
     hostname: string;
     /**

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@scaleway/sdk-function",
-  "version": "1.6.0",
+  "version": "2.1.1",
   "description": "Scaleway SDK function",
   "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/function"
   },
   "engines": {
-    "node": ">=20.19.4"
+    "node": ">=20.19.6"
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.2",
-    "@scaleway/sdk-std": "1.1.0"
+    "@scaleway/sdk-std": "2.1.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.2"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.2"
+    "@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.Functionv1beta1 = index_gen;