@scaleway/sdk-function 1.7.0 → 2.2.0

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

@@ -451,8 +451,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
    */

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.7.0",
+  "version": "2.2.0",
   "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.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.Functionv1beta1 = index_gen;